Synced with the latest branch.
[MacVim/jjgod.git] / src / ex_cmds.c
blob5ca3dfd07de7788d470b7b0806aa634ee7c8773c
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * ex_cmds.c: some functions for command line commands
14 #include "vim.h"
15 #ifdef HAVE_FCNTL_H
16 # include <fcntl.h>
17 #endif
18 #include "version.h"
20 #ifdef FEAT_EX_EXTRA
21 static int linelen __ARGS((int *has_tab));
22 #endif
23 static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
24 #ifdef FEAT_VIMINFO
25 static char_u *viminfo_filename __ARGS((char_u *));
26 static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int want_info, int want_marks, int force_read));
27 static int viminfo_encoding __ARGS((vir_T *virp));
28 static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
29 #endif
31 static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
32 static int check_readonly __ARGS((int *forceit, buf_T *buf));
33 #ifdef FEAT_AUTOCMD
34 static void delbuf_msg __ARGS((char_u *name));
35 #endif
36 static int
37 #ifdef __BORLANDC__
38 _RTLENTRYF
39 #endif
40 help_compare __ARGS((const void *s1, const void *s2));
43 * ":ascii" and "ga".
45 /*ARGSUSED*/
46 void
47 do_ascii(eap)
48 exarg_T *eap;
50 int c;
51 char buf1[20];
52 char buf2[20];
53 char_u buf3[7];
54 #ifdef FEAT_MBYTE
55 int cc[MAX_MCO];
56 int ci = 0;
57 int len;
59 if (enc_utf8)
60 c = utfc_ptr2char(ml_get_cursor(), cc);
61 else
62 #endif
63 c = gchar_cursor();
64 if (c == NUL)
66 MSG("NUL");
67 return;
70 #ifdef FEAT_MBYTE
71 IObuff[0] = NUL;
72 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
73 #endif
75 if (c == NL) /* NUL is stored as NL */
76 c = NUL;
77 if (vim_isprintc_strict(c) && (c < ' '
78 #ifndef EBCDIC
79 || c > '~'
80 #endif
83 transchar_nonprint(buf3, c);
84 sprintf(buf1, " <%s>", (char *)buf3);
86 else
87 buf1[0] = NUL;
88 #ifndef EBCDIC
89 if (c >= 0x80)
90 sprintf(buf2, " <M-%s>", transchar(c & 0x7f));
91 else
92 #endif
93 buf2[0] = NUL;
94 vim_snprintf((char *)IObuff, IOSIZE,
95 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
96 transchar(c), buf1, buf2, c, c, c);
97 #ifdef FEAT_MBYTE
98 if (enc_utf8)
99 c = cc[ci++];
100 else
101 c = 0;
102 #endif
105 #ifdef FEAT_MBYTE
106 /* Repeat for combining characters. */
107 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
109 len = (int)STRLEN(IObuff);
110 /* This assumes every multi-byte char is printable... */
111 if (len > 0)
112 IObuff[len++] = ' ';
113 IObuff[len++] = '<';
114 if (enc_utf8 && utf_iscomposing(c)
115 # ifdef USE_GUI
116 && !gui.in_use
117 # endif
119 IObuff[len++] = ' '; /* draw composing char on top of a space */
120 len += (*mb_char2bytes)(c, IObuff + len);
121 vim_snprintf((char *)IObuff + len, IOSIZE - len,
122 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
123 : _("> %d, Hex %08x, Octal %o"), c, c, c);
124 if (ci == MAX_MCO)
125 break;
126 if (enc_utf8)
127 c = cc[ci++];
128 else
129 c = 0;
131 #endif
133 msg(IObuff);
136 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
138 * ":left", ":center" and ":right": align text.
140 void
141 ex_align(eap)
142 exarg_T *eap;
144 pos_T save_curpos;
145 int len;
146 int indent = 0;
147 int new_indent;
148 int has_tab;
149 int width;
151 #ifdef FEAT_RIGHTLEFT
152 if (curwin->w_p_rl)
154 /* switch left and right aligning */
155 if (eap->cmdidx == CMD_right)
156 eap->cmdidx = CMD_left;
157 else if (eap->cmdidx == CMD_left)
158 eap->cmdidx = CMD_right;
160 #endif
162 width = atoi((char *)eap->arg);
163 save_curpos = curwin->w_cursor;
164 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 if (width >= 0)
167 indent = width;
169 else
172 * if 'textwidth' set, use it
173 * else if 'wrapmargin' set, use it
174 * if invalid value, use 80
176 if (width <= 0)
177 width = curbuf->b_p_tw;
178 if (width == 0 && curbuf->b_p_wm > 0)
179 width = W_WIDTH(curwin) - curbuf->b_p_wm;
180 if (width <= 0)
181 width = 80;
184 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
185 return;
187 for (curwin->w_cursor.lnum = eap->line1;
188 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 if (eap->cmdidx == CMD_left) /* left align */
191 new_indent = indent;
192 else
194 has_tab = FALSE; /* avoid uninit warnings */
195 len = linelen(eap->cmdidx == CMD_right ? &has_tab
196 : NULL) - get_indent();
198 if (len <= 0) /* skip blank lines */
199 continue;
201 if (eap->cmdidx == CMD_center)
202 new_indent = (width - len) / 2;
203 else
205 new_indent = width - len; /* right align */
208 * Make sure that embedded TABs don't make the text go too far
209 * to the right.
211 if (has_tab)
212 while (new_indent > 0)
214 (void)set_indent(new_indent, 0);
215 if (linelen(NULL) <= width)
218 * Now try to move the line as much as possible to
219 * the right. Stop when it moves too far.
222 (void)set_indent(++new_indent, 0);
223 while (linelen(NULL) <= width);
224 --new_indent;
225 break;
227 --new_indent;
231 if (new_indent < 0)
232 new_indent = 0;
233 (void)set_indent(new_indent, 0); /* set indent */
235 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
236 curwin->w_cursor = save_curpos;
237 beginline(BL_WHITE | BL_FIX);
241 * Get the length of the current line, excluding trailing white space.
243 static int
244 linelen(has_tab)
245 int *has_tab;
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
259 last > first && vim_iswhite(last[-1]); --last)
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
268 return len;
271 /* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273 static char_u *sortbuf1;
274 static char_u *sortbuf2;
276 static int sort_ic; /* ignore case */
277 static int sort_nr; /* sort on number */
278 static int sort_rx; /* sort on regex instead of skipping it */
280 static int sort_abort; /* flag to indicate if sorting has been interrupted */
282 /* Struct to store info to be sorted. */
283 typedef struct
285 linenr_T lnum; /* line number */
286 long start_col_nr; /* starting column number or number */
287 long end_col_nr; /* ending column number */
288 } sorti_T;
290 static int
291 #ifdef __BORLANDC__
292 _RTLENTRYF
293 #endif
294 sort_compare __ARGS((const void *s1, const void *s2));
296 static int
297 #ifdef __BORLANDC__
298 _RTLENTRYF
299 #endif
300 sort_compare(s1, s2)
301 const void *s1;
302 const void *s2;
304 sorti_T l1 = *(sorti_T *)s1;
305 sorti_T l2 = *(sorti_T *)s2;
306 int result = 0;
308 /* If the user interrupts, there's no way to stop qsort() immediately, but
309 * if we return 0 every time, qsort will assume it's done sorting and
310 * exit. */
311 if (sort_abort)
312 return 0;
313 fast_breakcheck();
314 if (got_int)
315 sort_abort = TRUE;
317 /* When sorting numbers "start_col_nr" is the number, not the column
318 * number. */
319 if (sort_nr)
320 result = l1.start_col_nr - l2.start_col_nr;
321 else
323 /* We need to copy one line into "sortbuf1", because there is no
324 * guarantee that the first pointer becomes invalid when obtaining the
325 * second one. */
326 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
327 l1.end_col_nr - l1.start_col_nr + 1);
328 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
329 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
330 l2.end_col_nr - l2.start_col_nr + 1);
331 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
333 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
334 : STRCMP(sortbuf1, sortbuf2);
337 /* If two lines have the same value, preserve the original line order. */
338 if (result == 0)
339 return (int)(l1.lnum - l2.lnum);
340 return result;
344 * ":sort".
346 void
347 ex_sort(eap)
348 exarg_T *eap;
350 regmatch_T regmatch;
351 int len;
352 linenr_T lnum;
353 long maxlen = 0;
354 sorti_T *nrs;
355 size_t count = eap->line2 - eap->line1 + 1;
356 size_t i;
357 char_u *p;
358 char_u *s;
359 char_u *s2;
360 char_u c; /* temporary character storage */
361 int unique = FALSE;
362 long deleted;
363 colnr_T start_col;
364 colnr_T end_col;
365 int sort_oct; /* sort on octal number */
366 int sort_hex; /* sort on hex number */
368 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
369 return;
370 sortbuf1 = NULL;
371 sortbuf2 = NULL;
372 regmatch.regprog = NULL;
373 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
374 if (nrs == NULL)
375 goto sortend;
377 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
379 for (p = eap->arg; *p != NUL; ++p)
381 if (vim_iswhite(*p))
383 else if (*p == 'i')
384 sort_ic = TRUE;
385 else if (*p == 'r')
386 sort_rx = TRUE;
387 else if (*p == 'n')
388 sort_nr = 2;
389 else if (*p == 'o')
390 sort_oct = 2;
391 else if (*p == 'x')
392 sort_hex = 2;
393 else if (*p == 'u')
394 unique = TRUE;
395 else if (*p == '"') /* comment start */
396 break;
397 else if (check_nextcmd(p) != NULL)
399 eap->nextcmd = check_nextcmd(p);
400 break;
402 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
404 s = skip_regexp(p + 1, *p, TRUE, NULL);
405 if (*s != *p)
407 EMSG(_(e_invalpat));
408 goto sortend;
410 *s = NUL;
411 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
412 if (regmatch.regprog == NULL)
413 goto sortend;
414 p = s; /* continue after the regexp */
415 regmatch.rm_ic = p_ic;
417 else
419 EMSG2(_(e_invarg2), p);
420 goto sortend;
424 /* Can only have one of 'n', 'o' and 'x'. */
425 if (sort_nr + sort_oct + sort_hex > 2)
427 EMSG(_(e_invarg));
428 goto sortend;
431 /* From here on "sort_nr" is used as a flag for any number sorting. */
432 sort_nr += sort_oct + sort_hex;
435 * Make an array with all line numbers. This avoids having to copy all
436 * the lines into allocated memory.
437 * When sorting on strings "start_col_nr" is the offset in the line, for
438 * numbers sorting it's the number to sort on. This means the pattern
439 * matching and number conversion only has to be done once per line.
440 * Also get the longest line length for allocating "sortbuf".
442 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
444 s = ml_get(lnum);
445 len = (int)STRLEN(s);
446 if (maxlen < len)
447 maxlen = len;
449 start_col = 0;
450 end_col = len;
451 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
453 if (sort_rx)
455 start_col = (colnr_T)(regmatch.startp[0] - s);
456 end_col = (colnr_T)(regmatch.endp[0] - s);
458 else
459 start_col = (colnr_T)(regmatch.endp[0] - s);
461 else
462 if (regmatch.regprog != NULL)
463 end_col = 0;
465 if (sort_nr)
467 /* Make sure vim_str2nr doesn't read any digits past the end
468 * of the match, by temporarily terminating the string there */
469 s2 = s + end_col;
470 c = *s2;
471 (*s2) = 0;
472 /* Sorting on number: Store the number itself. */
473 if (sort_hex)
474 s = skiptohex(s + start_col);
475 else
476 s = skiptodigit(s + start_col);
477 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
478 &nrs[lnum - eap->line1].start_col_nr, NULL);
479 (*s2) = c;
481 else
483 /* Store the column to sort at. */
484 nrs[lnum - eap->line1].start_col_nr = start_col;
485 nrs[lnum - eap->line1].end_col_nr = end_col;
488 nrs[lnum - eap->line1].lnum = lnum;
490 if (regmatch.regprog != NULL)
491 fast_breakcheck();
492 if (got_int)
493 goto sortend;
496 /* Allocate a buffer that can hold the longest line. */
497 sortbuf1 = alloc((unsigned)maxlen + 1);
498 if (sortbuf1 == NULL)
499 goto sortend;
500 sortbuf2 = alloc((unsigned)maxlen + 1);
501 if (sortbuf2 == NULL)
502 goto sortend;
504 /* Sort the array of line numbers. Note: can't be interrupted! */
505 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
507 if (sort_abort)
508 goto sortend;
510 /* Insert the lines in the sorted order below the last one. */
511 lnum = eap->line2;
512 for (i = 0; i < count; ++i)
514 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
515 if (!unique || i == 0
516 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
518 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
519 break;
520 if (unique)
521 STRCPY(sortbuf1, s);
523 fast_breakcheck();
524 if (got_int)
525 goto sortend;
528 /* delete the original lines if appending worked */
529 if (i == count)
530 for (i = 0; i < count; ++i)
531 ml_delete(eap->line1, FALSE);
532 else
533 count = 0;
535 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
536 deleted = (long)(count - (lnum - eap->line2));
537 if (deleted > 0)
538 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
539 else if (deleted < 0)
540 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
541 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
543 curwin->w_cursor.lnum = eap->line1;
544 beginline(BL_WHITE | BL_FIX);
546 sortend:
547 vim_free(nrs);
548 vim_free(sortbuf1);
549 vim_free(sortbuf2);
550 vim_free(regmatch.regprog);
551 if (got_int)
552 EMSG(_(e_interr));
556 * ":retab".
558 void
559 ex_retab(eap)
560 exarg_T *eap;
562 linenr_T lnum;
563 int got_tab = FALSE;
564 long num_spaces = 0;
565 long num_tabs;
566 long len;
567 long col;
568 long vcol;
569 long start_col = 0; /* For start of white-space string */
570 long start_vcol = 0; /* For start of white-space string */
571 int temp;
572 long old_len;
573 char_u *ptr;
574 char_u *new_line = (char_u *)1; /* init to non-NULL */
575 int did_undo; /* called u_save for current line */
576 int new_ts;
577 int save_list;
578 linenr_T first_line = 0; /* first changed line */
579 linenr_T last_line = 0; /* last changed line */
581 save_list = curwin->w_p_list;
582 curwin->w_p_list = 0; /* don't want list mode here */
584 new_ts = getdigits(&(eap->arg));
585 if (new_ts < 0)
587 EMSG(_(e_positive));
588 return;
590 if (new_ts == 0)
591 new_ts = curbuf->b_p_ts;
592 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
594 ptr = ml_get(lnum);
595 col = 0;
596 vcol = 0;
597 did_undo = FALSE;
598 for (;;)
600 if (vim_iswhite(ptr[col]))
602 if (!got_tab && num_spaces == 0)
604 /* First consecutive white-space */
605 start_vcol = vcol;
606 start_col = col;
608 if (ptr[col] == ' ')
609 num_spaces++;
610 else
611 got_tab = TRUE;
613 else
615 if (got_tab || (eap->forceit && num_spaces > 1))
617 /* Retabulate this string of white-space */
619 /* len is virtual length of white string */
620 len = num_spaces = vcol - start_vcol;
621 num_tabs = 0;
622 if (!curbuf->b_p_et)
624 temp = new_ts - (start_vcol % new_ts);
625 if (num_spaces >= temp)
627 num_spaces -= temp;
628 num_tabs++;
630 num_tabs += num_spaces / new_ts;
631 num_spaces -= (num_spaces / new_ts) * new_ts;
633 if (curbuf->b_p_et || got_tab ||
634 (num_spaces + num_tabs < len))
636 if (did_undo == FALSE)
638 did_undo = TRUE;
639 if (u_save((linenr_T)(lnum - 1),
640 (linenr_T)(lnum + 1)) == FAIL)
642 new_line = NULL; /* flag out-of-memory */
643 break;
647 /* len is actual number of white characters used */
648 len = num_spaces + num_tabs;
649 old_len = (long)STRLEN(ptr);
650 new_line = lalloc(old_len - col + start_col + len + 1,
651 TRUE);
652 if (new_line == NULL)
653 break;
654 if (start_col > 0)
655 mch_memmove(new_line, ptr, (size_t)start_col);
656 mch_memmove(new_line + start_col + len,
657 ptr + col, (size_t)(old_len - col + 1));
658 ptr = new_line + start_col;
659 for (col = 0; col < len; col++)
660 ptr[col] = (col < num_tabs) ? '\t' : ' ';
661 ml_replace(lnum, new_line, FALSE);
662 if (first_line == 0)
663 first_line = lnum;
664 last_line = lnum;
665 ptr = new_line;
666 col = start_col + len;
669 got_tab = FALSE;
670 num_spaces = 0;
672 if (ptr[col] == NUL)
673 break;
674 vcol += chartabsize(ptr + col, (colnr_T)vcol);
675 #ifdef FEAT_MBYTE
676 if (has_mbyte)
677 col += (*mb_ptr2len)(ptr + col);
678 else
679 #endif
680 ++col;
682 if (new_line == NULL) /* out of memory */
683 break;
684 line_breakcheck();
686 if (got_int)
687 EMSG(_(e_interr));
689 if (curbuf->b_p_ts != new_ts)
690 redraw_curbuf_later(NOT_VALID);
691 if (first_line != 0)
692 changed_lines(first_line, 0, last_line + 1, 0L);
694 curwin->w_p_list = save_list; /* restore 'list' */
696 curbuf->b_p_ts = new_ts;
697 coladvance(curwin->w_curswant);
699 u_clearline();
701 #endif
704 * :move command - move lines line1-line2 to line dest
706 * return FAIL for failure, OK otherwise
709 do_move(line1, line2, dest)
710 linenr_T line1;
711 linenr_T line2;
712 linenr_T dest;
714 char_u *str;
715 linenr_T l;
716 linenr_T extra; /* Num lines added before line1 */
717 linenr_T num_lines; /* Num lines moved */
718 linenr_T last_line; /* Last line in file after adding new text */
720 if (dest >= line1 && dest < line2)
722 EMSG(_("E134: Move lines into themselves"));
723 return FAIL;
726 num_lines = line2 - line1 + 1;
729 * First we copy the old text to its new location -- webb
730 * Also copy the flag that ":global" command uses.
732 if (u_save(dest, dest + 1) == FAIL)
733 return FAIL;
734 for (extra = 0, l = line1; l <= line2; l++)
736 str = vim_strsave(ml_get(l + extra));
737 if (str != NULL)
739 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
740 vim_free(str);
741 if (dest < line1)
742 extra++;
747 * Now we must be careful adjusting our marks so that we don't overlap our
748 * mark_adjust() calls.
750 * We adjust the marks within the old text so that they refer to the
751 * last lines of the file (temporarily), because we know no other marks
752 * will be set there since these line numbers did not exist until we added
753 * our new lines.
755 * Then we adjust the marks on lines between the old and new text positions
756 * (either forwards or backwards).
758 * And Finally we adjust the marks we put at the end of the file back to
759 * their final destination at the new text position -- webb
761 last_line = curbuf->b_ml.ml_line_count;
762 mark_adjust(line1, line2, last_line - line2, 0L);
763 if (dest >= line2)
765 mark_adjust(line2 + 1, dest, -num_lines, 0L);
766 curbuf->b_op_start.lnum = dest - num_lines + 1;
767 curbuf->b_op_end.lnum = dest;
769 else
771 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
772 curbuf->b_op_start.lnum = dest + 1;
773 curbuf->b_op_end.lnum = dest + num_lines;
775 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
776 mark_adjust(last_line - num_lines + 1, last_line,
777 -(last_line - dest - extra), 0L);
780 * Now we delete the original text -- webb
782 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
783 return FAIL;
785 for (l = line1; l <= line2; l++)
786 ml_delete(line1 + extra, TRUE);
788 if (!global_busy && num_lines > p_report)
790 if (num_lines == 1)
791 MSG(_("1 line moved"));
792 else
793 smsg((char_u *)_("%ld lines moved"), num_lines);
797 * Leave the cursor on the last of the moved lines.
799 if (dest >= line1)
800 curwin->w_cursor.lnum = dest;
801 else
802 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
804 if (line1 < dest)
805 changed_lines(line1, 0, dest + num_lines + 1, 0L);
806 else
807 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
809 return OK;
813 * ":copy"
815 void
816 ex_copy(line1, line2, n)
817 linenr_T line1;
818 linenr_T line2;
819 linenr_T n;
821 linenr_T count;
822 char_u *p;
824 count = line2 - line1 + 1;
825 curbuf->b_op_start.lnum = n + 1;
826 curbuf->b_op_end.lnum = n + count;
827 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
830 * there are three situations:
831 * 1. destination is above line1
832 * 2. destination is between line1 and line2
833 * 3. destination is below line2
835 * n = destination (when starting)
836 * curwin->w_cursor.lnum = destination (while copying)
837 * line1 = start of source (while copying)
838 * line2 = end of source (while copying)
840 if (u_save(n, n + 1) == FAIL)
841 return;
843 curwin->w_cursor.lnum = n;
844 while (line1 <= line2)
846 /* need to use vim_strsave() because the line will be unlocked within
847 * ml_append() */
848 p = vim_strsave(ml_get(line1));
849 if (p != NULL)
851 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
852 vim_free(p);
854 /* situation 2: skip already copied lines */
855 if (line1 == n)
856 line1 = curwin->w_cursor.lnum;
857 ++line1;
858 if (curwin->w_cursor.lnum < line1)
859 ++line1;
860 if (curwin->w_cursor.lnum < line2)
861 ++line2;
862 ++curwin->w_cursor.lnum;
865 appended_lines_mark(n, count);
867 msgmore((long)count);
870 static char_u *prevcmd = NULL; /* the previous command */
872 #if defined(EXITFREE) || defined(PROTO)
873 void
874 free_prev_shellcmd()
876 vim_free(prevcmd);
878 #endif
881 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
882 * Bangs in the argument are replaced with the previously entered command.
883 * Remember the argument.
885 * RISCOS: Bangs only replaced when followed by a space, since many
886 * pathnames contain one.
888 void
889 do_bang(addr_count, eap, forceit, do_in, do_out)
890 int addr_count;
891 exarg_T *eap;
892 int forceit;
893 int do_in, do_out;
895 char_u *arg = eap->arg; /* command */
896 linenr_T line1 = eap->line1; /* start of range */
897 linenr_T line2 = eap->line2; /* end of range */
898 char_u *newcmd = NULL; /* the new command */
899 int free_newcmd = FALSE; /* need to free() newcmd */
900 int ins_prevcmd;
901 char_u *t;
902 char_u *p;
903 char_u *trailarg;
904 int len;
905 int scroll_save = msg_scroll;
908 * Disallow shell commands for "rvim".
909 * Disallow shell commands from .exrc and .vimrc in current directory for
910 * security reasons.
912 if (check_restricted() || check_secure())
913 return;
915 if (addr_count == 0) /* :! */
917 msg_scroll = FALSE; /* don't scroll here */
918 autowrite_all();
919 msg_scroll = scroll_save;
923 * Try to find an embedded bang, like in :!<cmd> ! [args]
924 * (:!! is indicated by the 'forceit' variable)
926 ins_prevcmd = forceit;
927 trailarg = arg;
930 len = (int)STRLEN(trailarg) + 1;
931 if (newcmd != NULL)
932 len += (int)STRLEN(newcmd);
933 if (ins_prevcmd)
935 if (prevcmd == NULL)
937 EMSG(_(e_noprev));
938 vim_free(newcmd);
939 return;
941 len += (int)STRLEN(prevcmd);
943 if ((t = alloc(len)) == NULL)
945 vim_free(newcmd);
946 return;
948 *t = NUL;
949 if (newcmd != NULL)
950 STRCAT(t, newcmd);
951 if (ins_prevcmd)
952 STRCAT(t, prevcmd);
953 p = t + STRLEN(t);
954 STRCAT(t, trailarg);
955 vim_free(newcmd);
956 newcmd = t;
959 * Scan the rest of the argument for '!', which is replaced by the
960 * previous command. "\!" is replaced by "!" (this is vi compatible).
962 trailarg = NULL;
963 while (*p)
965 if (*p == '!'
966 #ifdef RISCOS
967 && (p[1] == ' ' || p[1] == NUL)
968 #endif
971 if (p > newcmd && p[-1] == '\\')
972 mch_memmove(p - 1, p, (size_t)(STRLEN(p) + 1));
973 else
975 trailarg = p;
976 *trailarg++ = NUL;
977 ins_prevcmd = TRUE;
978 break;
981 ++p;
983 } while (trailarg != NULL);
985 vim_free(prevcmd);
986 prevcmd = newcmd;
988 if (bangredo) /* put cmd in redo buffer for ! command */
990 AppendToRedobuffLit(prevcmd, -1);
991 AppendToRedobuff((char_u *)"\n");
992 bangredo = FALSE;
995 * Add quotes around the command, for shells that need them.
997 if (*p_shq != NUL)
999 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1000 if (newcmd == NULL)
1001 return;
1002 STRCPY(newcmd, p_shq);
1003 STRCAT(newcmd, prevcmd);
1004 STRCAT(newcmd, p_shq);
1005 free_newcmd = TRUE;
1007 if (addr_count == 0) /* :! */
1009 /* echo the command */
1010 msg_start();
1011 msg_putchar(':');
1012 msg_putchar('!');
1013 msg_outtrans(newcmd);
1014 msg_clr_eos();
1015 windgoto(msg_row, msg_col);
1017 do_shell(newcmd, 0);
1019 else /* :range! */
1021 /* Careful: This may recursively call do_bang() again! (because of
1022 * autocommands) */
1023 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1024 #ifdef FEAT_AUTOCMD
1025 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1026 #endif
1028 if (free_newcmd)
1029 vim_free(newcmd);
1033 * do_filter: filter lines through a command given by the user
1035 * We mostly use temp files and the call_shell() routine here. This would
1036 * normally be done using pipes on a UNIX machine, but this is more portable
1037 * to non-unix machines. The call_shell() routine needs to be able
1038 * to deal with redirection somehow, and should handle things like looking
1039 * at the PATH env. variable, and adding reasonable extensions to the
1040 * command name given by the user. All reasonable versions of call_shell()
1041 * do this.
1042 * Alternatively, if on Unix and redirecting input or output, but not both,
1043 * and the 'shelltemp' option isn't set, use pipes.
1044 * We use input redirection if do_in is TRUE.
1045 * We use output redirection if do_out is TRUE.
1047 static void
1048 do_filter(line1, line2, eap, cmd, do_in, do_out)
1049 linenr_T line1, line2;
1050 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1051 char_u *cmd;
1052 int do_in, do_out;
1054 char_u *itmp = NULL;
1055 char_u *otmp = NULL;
1056 linenr_T linecount;
1057 linenr_T read_linecount;
1058 pos_T cursor_save;
1059 char_u *cmd_buf;
1060 #ifdef FEAT_AUTOCMD
1061 buf_T *old_curbuf = curbuf;
1062 #endif
1063 int shell_flags = 0;
1065 if (*cmd == NUL) /* no filter command */
1066 return;
1068 #ifdef WIN3264
1070 * Check if external commands are allowed now.
1072 if (can_end_termcap_mode(TRUE) == FALSE)
1073 return;
1074 #endif
1076 cursor_save = curwin->w_cursor;
1077 linecount = line2 - line1 + 1;
1078 curwin->w_cursor.lnum = line1;
1079 curwin->w_cursor.col = 0;
1080 changed_line_abv_curs();
1081 invalidate_botline();
1084 * When using temp files:
1085 * 1. * Form temp file names
1086 * 2. * Write the lines to a temp file
1087 * 3. Run the filter command on the temp file
1088 * 4. * Read the output of the command into the buffer
1089 * 5. * Delete the original lines to be filtered
1090 * 6. * Remove the temp files
1092 * When writing the input with a pipe or when catching the output with a
1093 * pipe only need to do 3.
1096 if (do_out)
1097 shell_flags |= SHELL_DOOUT;
1099 #if !defined(USE_SYSTEM) && defined(UNIX)
1100 if (!do_in && do_out && !p_stmp)
1102 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1103 shell_flags |= SHELL_READ;
1104 curwin->w_cursor.lnum = line2;
1106 else if (do_in && !do_out && !p_stmp)
1108 /* Use a pipe to write stdin of the command, do not use a temp file. */
1109 shell_flags |= SHELL_WRITE;
1110 curbuf->b_op_start.lnum = line1;
1111 curbuf->b_op_end.lnum = line2;
1113 else if (do_in && do_out && !p_stmp)
1115 /* Use a pipe to write stdin and fetch stdout of the command, do not
1116 * use a temp file. */
1117 shell_flags |= SHELL_READ|SHELL_WRITE;
1118 curbuf->b_op_start.lnum = line1;
1119 curbuf->b_op_end.lnum = line2;
1120 curwin->w_cursor.lnum = line2;
1122 else
1123 #endif
1124 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1125 || (do_out && (otmp = vim_tempname('o')) == NULL))
1127 EMSG(_(e_notmp));
1128 goto filterend;
1132 * The writing and reading of temp files will not be shown.
1133 * Vi also doesn't do this and the messages are not very informative.
1135 ++no_wait_return; /* don't call wait_return() while busy */
1136 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1137 FALSE, FALSE, FALSE, TRUE) == FAIL)
1139 msg_putchar('\n'); /* keep message from buf_write() */
1140 --no_wait_return;
1141 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1142 if (!aborting())
1143 #endif
1144 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1145 goto filterend;
1147 #ifdef FEAT_AUTOCMD
1148 if (curbuf != old_curbuf)
1149 goto filterend;
1150 #endif
1152 if (!do_out)
1153 msg_putchar('\n');
1155 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1156 if (cmd_buf == NULL)
1157 goto filterend;
1159 windgoto((int)Rows - 1, 0);
1160 cursor_on();
1163 * When not redirecting the output the command can write anything to the
1164 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1165 * stderr output of external command. Clear the screen later.
1166 * If do_in is FALSE, this could be something like ":r !cat", which may
1167 * also mess up the screen, clear it later.
1169 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1170 redraw_later_clear();
1172 if (do_out)
1174 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1175 goto error;
1176 redraw_curbuf_later(VALID);
1178 read_linecount = curbuf->b_ml.ml_line_count;
1181 * When call_shell() fails wait_return() is called to give the user a
1182 * chance to read the error messages. Otherwise errors are ignored, so you
1183 * can see the error messages from the command that appear on stdout; use
1184 * 'u' to fix the text
1185 * Switch to cooked mode when not redirecting stdin, avoids that something
1186 * like ":r !cat" hangs.
1187 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1189 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1191 redraw_later_clear();
1192 wait_return(FALSE);
1194 vim_free(cmd_buf);
1196 did_check_timestamps = FALSE;
1197 need_check_timestamps = TRUE;
1199 /* When interrupting the shell command, it may still have produced some
1200 * useful output. Reset got_int here, so that readfile() won't cancel
1201 * reading. */
1202 ui_breakcheck();
1203 got_int = FALSE;
1205 if (do_out)
1207 if (otmp != NULL)
1209 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1210 eap, READ_FILTER) == FAIL)
1212 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1213 if (!aborting())
1214 #endif
1216 msg_putchar('\n');
1217 EMSG2(_(e_notread), otmp);
1219 goto error;
1221 #ifdef FEAT_AUTOCMD
1222 if (curbuf != old_curbuf)
1223 goto filterend;
1224 #endif
1227 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1229 if (shell_flags & SHELL_READ)
1231 curbuf->b_op_start.lnum = line2 + 1;
1232 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1233 appended_lines_mark(line2, read_linecount);
1236 if (do_in)
1238 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1240 if (read_linecount >= linecount)
1241 /* move all marks from old lines to new lines */
1242 mark_adjust(line1, line2, linecount, 0L);
1243 else
1245 /* move marks from old lines to new lines, delete marks
1246 * that are in deleted lines */
1247 mark_adjust(line1, line1 + read_linecount - 1,
1248 linecount, 0L);
1249 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1254 * Put cursor on first filtered line for ":range!cmd".
1255 * Adjust '[ and '] (set by buf_write()).
1257 curwin->w_cursor.lnum = line1;
1258 del_lines(linecount, TRUE);
1259 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1260 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1261 write_lnum_adjust(-linecount); /* adjust last line
1262 for next write */
1263 #ifdef FEAT_FOLDING
1264 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1265 #endif
1267 else
1270 * Put cursor on last new line for ":r !cmd".
1272 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1273 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1276 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1277 --no_wait_return;
1279 if (linecount > p_report)
1281 if (do_in)
1283 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1284 _("%ld lines filtered"), (long)linecount);
1285 if (msg(msg_buf) && !msg_scroll)
1286 /* save message to display it after redraw */
1287 set_keep_msg(msg_buf, 0);
1289 else
1290 msgmore((long)linecount);
1293 else
1295 error:
1296 /* put cursor back in same position for ":w !cmd" */
1297 curwin->w_cursor = cursor_save;
1298 --no_wait_return;
1299 wait_return(FALSE);
1302 filterend:
1304 #ifdef FEAT_AUTOCMD
1305 if (curbuf != old_curbuf)
1307 --no_wait_return;
1308 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1310 #endif
1311 if (itmp != NULL)
1312 mch_remove(itmp);
1313 if (otmp != NULL)
1314 mch_remove(otmp);
1315 vim_free(itmp);
1316 vim_free(otmp);
1320 * Call a shell to execute a command.
1321 * When "cmd" is NULL start an interactive shell.
1323 void
1324 do_shell(cmd, flags)
1325 char_u *cmd;
1326 int flags; /* may be SHELL_DOOUT when output is redirected */
1328 buf_T *buf;
1329 #ifndef FEAT_GUI_MSWIN
1330 int save_nwr;
1331 #endif
1332 #ifdef MSWIN
1333 int winstart = FALSE;
1334 #endif
1337 * Disallow shell commands for "rvim".
1338 * Disallow shell commands from .exrc and .vimrc in current directory for
1339 * security reasons.
1341 if (check_restricted() || check_secure())
1343 msg_end();
1344 return;
1347 #ifdef MSWIN
1349 * Check if external commands are allowed now.
1351 if (can_end_termcap_mode(TRUE) == FALSE)
1352 return;
1355 * Check if ":!start" is used.
1357 if (cmd != NULL)
1358 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1359 #endif
1362 * For autocommands we want to get the output on the current screen, to
1363 * avoid having to type return below.
1365 msg_putchar('\r'); /* put cursor at start of line */
1366 #ifdef FEAT_AUTOCMD
1367 if (!autocmd_busy)
1368 #endif
1370 #ifdef MSWIN
1371 if (!winstart)
1372 #endif
1373 stoptermcap();
1375 #ifdef MSWIN
1376 if (!winstart)
1377 #endif
1378 msg_putchar('\n'); /* may shift screen one line up */
1380 /* warning message before calling the shell */
1381 if (p_warn
1382 #ifdef FEAT_AUTOCMD
1383 && !autocmd_busy
1384 #endif
1385 && msg_silent == 0)
1386 for (buf = firstbuf; buf; buf = buf->b_next)
1387 if (bufIsChanged(buf))
1389 #ifdef FEAT_GUI_MSWIN
1390 if (!winstart)
1391 starttermcap(); /* don't want a message box here */
1392 #endif
1393 MSG_PUTS(_("[No write since last change]\n"));
1394 #ifdef FEAT_GUI_MSWIN
1395 if (!winstart)
1396 stoptermcap();
1397 #endif
1398 break;
1401 /* This windgoto is required for when the '\n' resulted in a "delete line
1402 * 1" command to the terminal. */
1403 if (!swapping_screen())
1404 windgoto(msg_row, msg_col);
1405 cursor_on();
1406 (void)call_shell(cmd, SHELL_COOKED | flags);
1407 did_check_timestamps = FALSE;
1408 need_check_timestamps = TRUE;
1411 * put the message cursor at the end of the screen, avoids wait_return()
1412 * to overwrite the text that the external command showed
1414 if (!swapping_screen())
1416 msg_row = Rows - 1;
1417 msg_col = 0;
1420 #ifdef FEAT_AUTOCMD
1421 if (autocmd_busy)
1423 if (msg_silent == 0)
1424 redraw_later_clear();
1426 else
1427 #endif
1430 * For ":sh" there is no need to call wait_return(), just redraw.
1431 * Also for the Win32 GUI (the output is in a console window).
1432 * Otherwise there is probably text on the screen that the user wants
1433 * to read before redrawing, so call wait_return().
1435 #ifndef FEAT_GUI_MSWIN
1436 if (cmd == NULL
1437 # ifdef WIN3264
1438 || (winstart && !need_wait_return)
1439 # endif
1442 if (msg_silent == 0)
1443 redraw_later_clear();
1444 need_wait_return = FALSE;
1446 else
1449 * If we switch screens when starttermcap() is called, we really
1450 * want to wait for "hit return to continue".
1452 save_nwr = no_wait_return;
1453 if (swapping_screen())
1454 no_wait_return = FALSE;
1455 # ifdef AMIGA
1456 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1457 # else
1458 wait_return(msg_silent == 0);
1459 # endif
1460 no_wait_return = save_nwr;
1462 #endif /* FEAT_GUI_W32 */
1464 #ifdef MSWIN
1465 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1466 #endif
1467 starttermcap(); /* start termcap if not done by wait_return() */
1470 * In an Amiga window redrawing is caused by asking the window size.
1471 * If we got an interrupt this will not work. The chance that the
1472 * window size is wrong is very small, but we need to redraw the
1473 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1474 * but it saves an extra redraw.
1476 #ifdef AMIGA
1477 if (skip_redraw) /* ':' hit in wait_return() */
1479 if (msg_silent == 0)
1480 redraw_later_clear();
1482 else if (term_console)
1484 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1485 if (got_int && msg_silent == 0)
1486 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1487 else
1488 must_redraw = 0; /* no extra redraw needed */
1490 #endif
1493 /* display any error messages now */
1494 display_errors();
1496 #ifdef FEAT_AUTOCMD
1497 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1498 #endif
1502 * Create a shell command from a command string, input redirection file and
1503 * output redirection file.
1504 * Returns an allocated string with the shell command, or NULL for failure.
1506 char_u *
1507 make_filter_cmd(cmd, itmp, otmp)
1508 char_u *cmd; /* command */
1509 char_u *itmp; /* NULL or name of input file */
1510 char_u *otmp; /* NULL or name of output file */
1512 char_u *buf;
1513 long_u len;
1515 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1516 if (itmp != NULL)
1517 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1518 if (otmp != NULL)
1519 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1520 buf = lalloc(len, TRUE);
1521 if (buf == NULL)
1522 return NULL;
1524 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1526 * Put braces around the command (for concatenated commands) when
1527 * redirecting input and/or output.
1529 if (itmp != NULL || otmp != NULL)
1530 sprintf((char *)buf, "(%s)", (char *)cmd);
1531 else
1532 STRCPY(buf, cmd);
1533 if (itmp != NULL)
1535 STRCAT(buf, " < ");
1536 STRCAT(buf, itmp);
1538 #else
1540 * for shells that don't understand braces around commands, at least allow
1541 * the use of commands in a pipe.
1543 STRCPY(buf, cmd);
1544 if (itmp != NULL)
1546 char_u *p;
1549 * If there is a pipe, we have to put the '<' in front of it.
1550 * Don't do this when 'shellquote' is not empty, otherwise the
1551 * redirection would be inside the quotes.
1553 if (*p_shq == NUL)
1555 p = vim_strchr(buf, '|');
1556 if (p != NULL)
1557 *p = NUL;
1559 # ifdef RISCOS
1560 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1561 STRCAT(buf, itmp);
1562 STRCAT(buf, " } ");
1563 # else
1564 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1565 STRCAT(buf, itmp);
1566 # endif
1567 if (*p_shq == NUL)
1569 p = vim_strchr(cmd, '|');
1570 if (p != NULL)
1572 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1573 STRCAT(buf, p);
1577 #endif
1578 if (otmp != NULL)
1579 append_redir(buf, p_srr, otmp);
1581 return buf;
1585 * Append output redirection for file "fname" to the end of string buffer "buf"
1586 * Works with the 'shellredir' and 'shellpipe' options.
1587 * The caller should make sure that there is enough room:
1588 * STRLEN(opt) + STRLEN(fname) + 3
1590 void
1591 append_redir(buf, opt, fname)
1592 char_u *buf;
1593 char_u *opt;
1594 char_u *fname;
1596 char_u *p;
1598 buf += STRLEN(buf);
1599 /* find "%s", skipping "%%" */
1600 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1601 if (p[1] == 's')
1602 break;
1603 if (p != NULL)
1605 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1606 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1608 else
1609 sprintf((char *)buf,
1610 #ifdef FEAT_QUICKFIX
1611 # ifndef RISCOS
1612 opt != p_sp ? " %s%s" :
1613 # endif
1614 " %s %s",
1615 #else
1616 # ifndef RISCOS
1617 " %s%s", /* " > %s" causes problems on Amiga */
1618 # else
1619 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1620 # endif
1621 #endif
1622 (char *)opt, (char *)fname);
1625 #ifdef FEAT_VIMINFO
1627 static int no_viminfo __ARGS((void));
1628 static int viminfo_errcnt;
1630 static int
1631 no_viminfo()
1633 /* "vim -i NONE" does not read or write a viminfo file */
1634 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1638 * Report an error for reading a viminfo file.
1639 * Count the number of errors. When there are more than 10, return TRUE.
1642 viminfo_error(errnum, message, line)
1643 char *errnum;
1644 char *message;
1645 char_u *line;
1647 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1648 errnum, message);
1649 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff));
1650 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1651 IObuff[STRLEN(IObuff) - 1] = NUL;
1652 emsg(IObuff);
1653 if (++viminfo_errcnt >= 10)
1655 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1656 return TRUE;
1658 return FALSE;
1662 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1663 * set are not over-written unless force is TRUE. -- webb
1666 read_viminfo(file, want_info, want_marks, forceit)
1667 char_u *file;
1668 int want_info;
1669 int want_marks;
1670 int forceit;
1672 FILE *fp;
1673 char_u *fname;
1675 if (no_viminfo())
1676 return FAIL;
1678 fname = viminfo_filename(file); /* may set to default if NULL */
1679 if (fname == NULL)
1680 return FAIL;
1681 fp = mch_fopen((char *)fname, READBIN);
1683 if (p_verbose > 0)
1685 verbose_enter();
1686 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1687 fname,
1688 want_info ? _(" info") : "",
1689 want_marks ? _(" marks") : "",
1690 fp == NULL ? _(" FAILED") : "");
1691 verbose_leave();
1694 vim_free(fname);
1695 if (fp == NULL)
1696 return FAIL;
1698 viminfo_errcnt = 0;
1699 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1701 fclose(fp);
1703 return OK;
1707 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1708 * that effectively a merge of current info and old info is done. This allows
1709 * multiple vims to run simultaneously, without losing any marks etc. If
1710 * forceit is TRUE, then the old file is not read in, and only internal info is
1711 * written to the file. -- webb
1713 void
1714 write_viminfo(file, forceit)
1715 char_u *file;
1716 int forceit;
1718 char_u *fname;
1719 FILE *fp_in = NULL; /* input viminfo file, if any */
1720 FILE *fp_out = NULL; /* output viminfo file */
1721 char_u *tempname = NULL; /* name of temp viminfo file */
1722 struct stat st_new; /* mch_stat() of potential new file */
1723 char_u *wp;
1724 #if defined(UNIX) || defined(VMS)
1725 mode_t umask_save;
1726 #endif
1727 #ifdef UNIX
1728 int shortname = FALSE; /* use 8.3 file name */
1729 struct stat st_old; /* mch_stat() of existing viminfo file */
1730 #endif
1731 #ifdef WIN3264
1732 long perm = -1;
1733 #endif
1735 if (no_viminfo())
1736 return;
1738 fname = viminfo_filename(file); /* may set to default if NULL */
1739 if (fname == NULL)
1740 return;
1742 fp_in = mch_fopen((char *)fname, READBIN);
1743 if (fp_in == NULL)
1745 /* if it does exist, but we can't read it, don't try writing */
1746 if (mch_stat((char *)fname, &st_new) == 0)
1747 goto end;
1748 #if defined(UNIX) || defined(VMS)
1750 * For Unix we create the .viminfo non-accessible for others,
1751 * because it may contain text from non-accessible documents.
1753 umask_save = umask(077);
1754 #endif
1755 fp_out = mch_fopen((char *)fname, WRITEBIN);
1756 #if defined(UNIX) || defined(VMS)
1757 (void)umask(umask_save);
1758 #endif
1760 else
1763 * There is an existing viminfo file. Create a temporary file to
1764 * write the new viminfo into, in the same directory as the
1765 * existing viminfo file, which will be renamed later.
1767 #ifdef UNIX
1769 * For Unix we check the owner of the file. It's not very nice to
1770 * overwrite a user's viminfo file after a "su root", with a
1771 * viminfo file that the user can't read.
1773 st_old.st_dev = st_old.st_ino = 0;
1774 st_old.st_mode = 0600;
1775 if (mch_stat((char *)fname, &st_old) == 0
1776 && getuid() != ROOT_UID
1777 && !(st_old.st_uid == getuid()
1778 ? (st_old.st_mode & 0200)
1779 : (st_old.st_gid == getgid()
1780 ? (st_old.st_mode & 0020)
1781 : (st_old.st_mode & 0002))))
1783 int tt = msg_didany;
1785 /* avoid a wait_return for this message, it's annoying */
1786 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1787 msg_didany = tt;
1788 fclose(fp_in);
1789 goto end;
1791 #endif
1792 #ifdef WIN3264
1793 /* Get the file attributes of the existing viminfo file. */
1794 perm = mch_getperm(fname);
1795 #endif
1798 * Make tempname.
1799 * May try twice: Once normal and once with shortname set, just in
1800 * case somebody puts his viminfo file in an 8.3 filesystem.
1802 for (;;)
1804 tempname = buf_modname(
1805 #ifdef UNIX
1806 shortname,
1807 #else
1808 # ifdef SHORT_FNAME
1809 TRUE,
1810 # else
1811 # ifdef FEAT_GUI_W32
1812 gui_is_win32s(),
1813 # else
1814 FALSE,
1815 # endif
1816 # endif
1817 #endif
1818 fname,
1819 #ifdef VMS
1820 (char_u *)"-tmp",
1821 #else
1822 # ifdef RISCOS
1823 (char_u *)"/tmp",
1824 # else
1825 (char_u *)".tmp",
1826 # endif
1827 #endif
1828 FALSE);
1829 if (tempname == NULL) /* out of memory */
1830 break;
1833 * Check if tempfile already exists. Never overwrite an
1834 * existing file!
1836 if (mch_stat((char *)tempname, &st_new) == 0)
1838 #ifdef UNIX
1840 * Check if tempfile is same as original file. May happen
1841 * when modname() gave the same file back. E.g. silly
1842 * link, or file name-length reached. Try again with
1843 * shortname set.
1845 if (!shortname && st_new.st_dev == st_old.st_dev
1846 && st_new.st_ino == st_old.st_ino)
1848 vim_free(tempname);
1849 tempname = NULL;
1850 shortname = TRUE;
1851 continue;
1853 #endif
1855 * Try another name. Change one character, just before
1856 * the extension. This should also work for an 8.3
1857 * file name, when after adding the extension it still is
1858 * the same file as the original.
1860 wp = tempname + STRLEN(tempname) - 5;
1861 if (wp < gettail(tempname)) /* empty file name? */
1862 wp = gettail(tempname);
1863 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1864 --*wp)
1867 * They all exist? Must be something wrong! Don't
1868 * write the viminfo file then.
1870 if (*wp == 'a')
1872 vim_free(tempname);
1873 tempname = NULL;
1874 break;
1878 break;
1881 if (tempname != NULL)
1883 #ifdef VMS
1884 /* fdopen() fails for some reason */
1885 umask_save = umask(077);
1886 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1887 (void)umask(umask_save);
1888 #else
1889 int fd;
1891 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1892 * protection:
1893 * Unix: same as original file, but strip s-bit. Reset umask to
1894 * avoid it getting in the way.
1895 * Others: r&w for user only. */
1896 # ifdef UNIX
1897 umask_save = umask(0);
1898 fd = mch_open((char *)tempname,
1899 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1900 (int)((st_old.st_mode & 0777) | 0600));
1901 (void)umask(umask_save);
1902 # else
1903 fd = mch_open((char *)tempname,
1904 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1905 # endif
1906 if (fd < 0)
1907 fp_out = NULL;
1908 else
1909 fp_out = fdopen(fd, WRITEBIN);
1910 #endif /* VMS */
1913 * If we can't create in the same directory, try creating a
1914 * "normal" temp file.
1916 if (fp_out == NULL)
1918 vim_free(tempname);
1919 if ((tempname = vim_tempname('o')) != NULL)
1920 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1923 #if defined(UNIX) && defined(HAVE_FCHOWN)
1925 * Make sure the owner can read/write it. This only works for
1926 * root.
1928 if (fp_out != NULL)
1929 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1930 #endif
1935 * Check if the new viminfo file can be written to.
1937 if (fp_out == NULL)
1939 EMSG2(_("E138: Can't write viminfo file %s!"),
1940 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1941 if (fp_in != NULL)
1942 fclose(fp_in);
1943 goto end;
1946 if (p_verbose > 0)
1948 verbose_enter();
1949 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1950 verbose_leave();
1953 viminfo_errcnt = 0;
1954 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1956 fclose(fp_out); /* errors are ignored !? */
1957 if (fp_in != NULL)
1959 fclose(fp_in);
1962 * In case of an error keep the original viminfo file.
1963 * Otherwise rename the newly written file.
1965 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1966 mch_remove(tempname);
1968 #ifdef WIN3264
1969 /* If the viminfo file was hidden then also hide the new file. */
1970 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1971 mch_hide(fname);
1972 #endif
1975 end:
1976 vim_free(fname);
1977 vim_free(tempname);
1981 * Get the viminfo file name to use.
1982 * If "file" is given and not empty, use it (has already been expanded by
1983 * cmdline functions).
1984 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1985 * expand environment variables.
1986 * Returns an allocated string. NULL when out of memory.
1988 static char_u *
1989 viminfo_filename(file)
1990 char_u *file;
1992 if (file == NULL || *file == NUL)
1994 if (use_viminfo != NULL)
1995 file = use_viminfo;
1996 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
1998 #ifdef VIMINFO_FILE2
1999 /* don't use $HOME when not defined (turned into "c:/"!). */
2000 # ifdef VMS
2001 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2002 # else
2003 if (mch_getenv((char_u *)"HOME") == NULL)
2004 # endif
2006 /* don't use $VIM when not available. */
2007 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2008 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2009 file = (char_u *)VIMINFO_FILE2;
2010 else
2011 file = (char_u *)VIMINFO_FILE;
2013 else
2014 #endif
2015 file = (char_u *)VIMINFO_FILE;
2017 expand_env(file, NameBuff, MAXPATHL);
2018 file = NameBuff;
2020 return vim_strsave(file);
2024 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2026 static void
2027 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2028 FILE *fp_in;
2029 FILE *fp_out;
2030 int want_info;
2031 int want_marks;
2032 int force_read;
2034 int count = 0;
2035 int eof = FALSE;
2036 vir_T vir;
2038 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2039 return;
2040 vir.vir_fd = fp_in;
2041 #ifdef FEAT_MBYTE
2042 vir.vir_conv.vc_type = CONV_NONE;
2043 #endif
2045 if (fp_in != NULL)
2047 if (want_info)
2048 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2049 else
2050 /* Skip info, find start of marks */
2051 while (!(eof = viminfo_readline(&vir))
2052 && vir.vir_line[0] != '>')
2055 if (fp_out != NULL)
2057 /* Write the info: */
2058 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2059 VIM_VERSION_MEDIUM);
2060 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2061 #ifdef FEAT_MBYTE
2062 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2063 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2064 #endif
2065 write_viminfo_search_pattern(fp_out);
2066 write_viminfo_sub_string(fp_out);
2067 #ifdef FEAT_CMDHIST
2068 write_viminfo_history(fp_out);
2069 #endif
2070 write_viminfo_registers(fp_out);
2071 #ifdef FEAT_EVAL
2072 write_viminfo_varlist(fp_out);
2073 #endif
2074 write_viminfo_filemarks(fp_out);
2075 write_viminfo_bufferlist(fp_out);
2076 count = write_viminfo_marks(fp_out);
2078 if (fp_in != NULL && want_marks)
2079 copy_viminfo_marks(&vir, fp_out, count, eof);
2081 vim_free(vir.vir_line);
2082 #ifdef FEAT_MBYTE
2083 if (vir.vir_conv.vc_type != CONV_NONE)
2084 convert_setup(&vir.vir_conv, NULL, NULL);
2085 #endif
2089 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2090 * first part of the viminfo file which contains everything but the marks that
2091 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2093 static int
2094 read_viminfo_up_to_marks(virp, forceit, writing)
2095 vir_T *virp;
2096 int forceit;
2097 int writing;
2099 int eof;
2100 buf_T *buf;
2102 #ifdef FEAT_CMDHIST
2103 prepare_viminfo_history(forceit ? 9999 : 0);
2104 #endif
2105 eof = viminfo_readline(virp);
2106 while (!eof && virp->vir_line[0] != '>')
2108 switch (virp->vir_line[0])
2110 /* Characters reserved for future expansion, ignored now */
2111 case '+': /* "+40 /path/dir file", for running vim without args */
2112 case '|': /* to be defined */
2113 case '^': /* to be defined */
2114 case '<': /* long line - ignored */
2115 /* A comment or empty line. */
2116 case NUL:
2117 case '\r':
2118 case '\n':
2119 case '#':
2120 eof = viminfo_readline(virp);
2121 break;
2122 case '*': /* "*encoding=value" */
2123 eof = viminfo_encoding(virp);
2124 break;
2125 case '!': /* global variable */
2126 #ifdef FEAT_EVAL
2127 eof = read_viminfo_varlist(virp, writing);
2128 #else
2129 eof = viminfo_readline(virp);
2130 #endif
2131 break;
2132 case '%': /* entry for buffer list */
2133 eof = read_viminfo_bufferlist(virp, writing);
2134 break;
2135 case '"':
2136 eof = read_viminfo_register(virp, forceit);
2137 break;
2138 case '/': /* Search string */
2139 case '&': /* Substitute search string */
2140 case '~': /* Last search string, followed by '/' or '&' */
2141 eof = read_viminfo_search_pattern(virp, forceit);
2142 break;
2143 case '$':
2144 eof = read_viminfo_sub_string(virp, forceit);
2145 break;
2146 case ':':
2147 case '?':
2148 case '=':
2149 case '@':
2150 #ifdef FEAT_CMDHIST
2151 eof = read_viminfo_history(virp);
2152 #else
2153 eof = viminfo_readline(virp);
2154 #endif
2155 break;
2156 case '-':
2157 case '\'':
2158 eof = read_viminfo_filemark(virp, forceit);
2159 break;
2160 default:
2161 if (viminfo_error("E575: ", _("Illegal starting char"),
2162 virp->vir_line))
2163 eof = TRUE;
2164 else
2165 eof = viminfo_readline(virp);
2166 break;
2170 #ifdef FEAT_CMDHIST
2171 /* Finish reading history items. */
2172 finish_viminfo_history();
2173 #endif
2175 /* Change file names to buffer numbers for fmarks. */
2176 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2177 fmarks_check_names(buf);
2179 return eof;
2183 * Compare the 'encoding' value in the viminfo file with the current value of
2184 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2185 * conversion of text with iconv() in viminfo_readstring().
2187 static int
2188 viminfo_encoding(virp)
2189 vir_T *virp;
2191 #ifdef FEAT_MBYTE
2192 char_u *p;
2193 int i;
2195 if (get_viminfo_parameter('c') != 0)
2197 p = vim_strchr(virp->vir_line, '=');
2198 if (p != NULL)
2200 /* remove trailing newline */
2201 ++p;
2202 for (i = 0; vim_isprintc(p[i]); ++i)
2204 p[i] = NUL;
2206 convert_setup(&virp->vir_conv, p, p_enc);
2209 #endif
2210 return viminfo_readline(virp);
2214 * Read a line from the viminfo file.
2215 * Returns TRUE for end-of-file;
2218 viminfo_readline(virp)
2219 vir_T *virp;
2221 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2225 * check string read from viminfo file
2226 * remove '\n' at the end of the line
2227 * - replace CTRL-V CTRL-V with CTRL-V
2228 * - replace CTRL-V 'n' with '\n'
2230 * Check for a long line as written by viminfo_writestring().
2232 * Return the string in allocated memory (NULL when out of memory).
2234 /*ARGSUSED*/
2235 char_u *
2236 viminfo_readstring(virp, off, convert)
2237 vir_T *virp;
2238 int off; /* offset for virp->vir_line */
2239 int convert; /* convert the string */
2241 char_u *retval;
2242 char_u *s, *d;
2243 long len;
2245 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2247 len = atol((char *)virp->vir_line + off + 1);
2248 retval = lalloc(len, TRUE);
2249 if (retval == NULL)
2251 /* Line too long? File messed up? Skip next line. */
2252 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2253 return NULL;
2255 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2256 s = retval + 1; /* Skip the leading '<' */
2258 else
2260 retval = vim_strsave(virp->vir_line + off);
2261 if (retval == NULL)
2262 return NULL;
2263 s = retval;
2266 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2267 d = retval;
2268 while (*s != NUL && *s != '\n')
2270 if (s[0] == Ctrl_V && s[1] != NUL)
2272 if (s[1] == 'n')
2273 *d++ = '\n';
2274 else
2275 *d++ = Ctrl_V;
2276 s += 2;
2278 else
2279 *d++ = *s++;
2281 *d = NUL;
2283 #ifdef FEAT_MBYTE
2284 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2286 d = string_convert(&virp->vir_conv, retval, NULL);
2287 if (d != NULL)
2289 vim_free(retval);
2290 retval = d;
2293 #endif
2295 return retval;
2299 * write string to viminfo file
2300 * - replace CTRL-V with CTRL-V CTRL-V
2301 * - replace '\n' with CTRL-V 'n'
2302 * - add a '\n' at the end
2304 * For a long line:
2305 * - write " CTRL-V <length> \n " in first line
2306 * - write " < <string> \n " in second line
2308 void
2309 viminfo_writestring(fd, p)
2310 FILE *fd;
2311 char_u *p;
2313 int c;
2314 char_u *s;
2315 int len = 0;
2317 for (s = p; *s != NUL; ++s)
2319 if (*s == Ctrl_V || *s == '\n')
2320 ++len;
2321 ++len;
2324 /* If the string will be too long, write its length and put it in the next
2325 * line. Take into account that some room is needed for what comes before
2326 * the string (e.g., variable name). Add something to the length for the
2327 * '<', NL and trailing NUL. */
2328 if (len > LSIZE / 2)
2329 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2331 while ((c = *p++) != NUL)
2333 if (c == Ctrl_V || c == '\n')
2335 putc(Ctrl_V, fd);
2336 if (c == '\n')
2337 c = 'n';
2339 putc(c, fd);
2341 putc('\n', fd);
2343 #endif /* FEAT_VIMINFO */
2346 * Implementation of ":fixdel", also used by get_stty().
2347 * <BS> resulting <Del>
2348 * ^? ^H
2349 * not ^? ^?
2351 /*ARGSUSED*/
2352 void
2353 do_fixdel(eap)
2354 exarg_T *eap;
2356 char_u *p;
2358 p = find_termcode((char_u *)"kb");
2359 add_termcode((char_u *)"kD", p != NULL
2360 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2363 void
2364 print_line_no_prefix(lnum, use_number, list)
2365 linenr_T lnum;
2366 int use_number;
2367 int list;
2369 char_u numbuf[30];
2371 if (curwin->w_p_nu || use_number)
2373 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2374 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2376 msg_prt_line(ml_get(lnum), list);
2380 * Print a text line. Also in silent mode ("ex -s").
2382 void
2383 print_line(lnum, use_number, list)
2384 linenr_T lnum;
2385 int use_number;
2386 int list;
2388 int save_silent = silent_mode;
2390 msg_start();
2391 silent_mode = FALSE;
2392 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2393 print_line_no_prefix(lnum, use_number, list);
2394 if (save_silent)
2396 msg_putchar('\n');
2397 cursor_on(); /* msg_start() switches it off */
2398 out_flush();
2399 silent_mode = save_silent;
2400 info_message = FALSE;
2405 * ":file[!] [fname]".
2407 void
2408 ex_file(eap)
2409 exarg_T *eap;
2411 char_u *fname, *sfname, *xfname;
2412 buf_T *buf;
2414 /* ":0file" removes the file name. Check for illegal uses ":3file",
2415 * "0file name", etc. */
2416 if (eap->addr_count > 0
2417 && (*eap->arg != NUL
2418 || eap->line2 > 0
2419 || eap->addr_count > 1))
2421 EMSG(_(e_invarg));
2422 return;
2425 if (*eap->arg != NUL || eap->addr_count == 1)
2427 #ifdef FEAT_AUTOCMD
2428 buf = curbuf;
2429 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2430 /* buffer changed, don't change name now */
2431 if (buf != curbuf)
2432 return;
2433 # ifdef FEAT_EVAL
2434 if (aborting()) /* autocmds may abort script processing */
2435 return;
2436 # endif
2437 #endif
2439 * The name of the current buffer will be changed.
2440 * A new (unlisted) buffer entry needs to be made to hold the old file
2441 * name, which will become the alternate file name.
2442 * But don't set the alternate file name if the buffer didn't have a
2443 * name.
2445 fname = curbuf->b_ffname;
2446 sfname = curbuf->b_sfname;
2447 xfname = curbuf->b_fname;
2448 curbuf->b_ffname = NULL;
2449 curbuf->b_sfname = NULL;
2450 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2452 curbuf->b_ffname = fname;
2453 curbuf->b_sfname = sfname;
2454 return;
2456 curbuf->b_flags |= BF_NOTEDITED;
2457 if (xfname != NULL && *xfname != NUL)
2459 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2460 if (buf != NULL && !cmdmod.keepalt)
2461 curwin->w_alt_fnum = buf->b_fnum;
2463 vim_free(fname);
2464 vim_free(sfname);
2465 #ifdef FEAT_AUTOCMD
2466 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2467 #endif
2468 /* Change directories when the 'acd' option is set. */
2469 DO_AUTOCHDIR
2471 /* print full file name if :cd used */
2472 fileinfo(FALSE, FALSE, eap->forceit);
2476 * ":update".
2478 void
2479 ex_update(eap)
2480 exarg_T *eap;
2482 if (curbufIsChanged())
2483 (void)do_write(eap);
2487 * ":write" and ":saveas".
2489 void
2490 ex_write(eap)
2491 exarg_T *eap;
2493 if (eap->usefilter) /* input lines to shell command */
2494 do_bang(1, eap, FALSE, TRUE, FALSE);
2495 else
2496 (void)do_write(eap);
2500 * write current buffer to file 'eap->arg'
2501 * if 'eap->append' is TRUE, append to the file
2503 * if *eap->arg == NUL write to current file
2505 * return FAIL for failure, OK otherwise
2508 do_write(eap)
2509 exarg_T *eap;
2511 int other;
2512 char_u *fname = NULL; /* init to shut up gcc */
2513 char_u *ffname;
2514 int retval = FAIL;
2515 char_u *free_fname = NULL;
2516 #ifdef FEAT_BROWSE
2517 char_u *browse_file = NULL;
2518 #endif
2519 buf_T *alt_buf = NULL;
2521 if (not_writing()) /* check 'write' option */
2522 return FAIL;
2524 ffname = eap->arg;
2525 #ifdef FEAT_BROWSE
2526 if (cmdmod.browse)
2528 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2529 NULL, NULL, NULL, curbuf);
2530 if (browse_file == NULL)
2531 goto theend;
2532 ffname = browse_file;
2534 #endif
2535 if (*ffname == NUL)
2537 if (eap->cmdidx == CMD_saveas)
2539 EMSG(_(e_argreq));
2540 goto theend;
2542 other = FALSE;
2544 else
2546 fname = ffname;
2547 free_fname = fix_fname(ffname);
2549 * When out-of-memory, keep unexpanded file name, because we MUST be
2550 * able to write the file in this situation.
2552 if (free_fname != NULL)
2553 ffname = free_fname;
2554 other = otherfile(ffname);
2558 * If we have a new file, put its name in the list of alternate file names.
2560 if (other)
2562 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2563 || eap->cmdidx == CMD_saveas)
2564 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2565 else
2566 alt_buf = buflist_findname(ffname);
2567 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2569 /* Overwriting a file that is loaded in another buffer is not a
2570 * good idea. */
2571 EMSG(_(e_bufloaded));
2572 goto theend;
2577 * Writing to the current file is not allowed in readonly mode
2578 * and a file name is required.
2579 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2581 if (!other && (
2582 #ifdef FEAT_QUICKFIX
2583 bt_dontwrite_msg(curbuf) ||
2584 #endif
2585 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2586 goto theend;
2588 if (!other)
2590 ffname = curbuf->b_ffname;
2591 fname = curbuf->b_fname;
2593 * Not writing the whole file is only allowed with '!'.
2595 if ( (eap->line1 != 1
2596 || eap->line2 != curbuf->b_ml.ml_line_count)
2597 && !eap->forceit
2598 && !eap->append
2599 && !p_wa)
2601 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2602 if (p_confirm || cmdmod.confirm)
2604 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2605 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2606 goto theend;
2607 eap->forceit = TRUE;
2609 else
2610 #endif
2612 EMSG(_("E140: Use ! to write partial buffer"));
2613 goto theend;
2618 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2620 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2622 #ifdef FEAT_AUTOCMD
2623 buf_T *was_curbuf = curbuf;
2625 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2626 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2627 # ifdef FEAT_EVAL
2628 if (curbuf != was_curbuf || aborting())
2629 # else
2630 if (curbuf != was_curbuf)
2631 # endif
2633 /* buffer changed, don't change name now */
2634 retval = FAIL;
2635 goto theend;
2637 #endif
2638 /* Exchange the file names for the current and the alternate
2639 * buffer. This makes it look like we are now editing the buffer
2640 * under the new name. Must be done before buf_write(), because
2641 * if there is no file name and 'cpo' contains 'F', it will set
2642 * the file name. */
2643 fname = alt_buf->b_fname;
2644 alt_buf->b_fname = curbuf->b_fname;
2645 curbuf->b_fname = fname;
2646 fname = alt_buf->b_ffname;
2647 alt_buf->b_ffname = curbuf->b_ffname;
2648 curbuf->b_ffname = fname;
2649 fname = alt_buf->b_sfname;
2650 alt_buf->b_sfname = curbuf->b_sfname;
2651 curbuf->b_sfname = fname;
2652 buf_name_changed(curbuf);
2653 #ifdef FEAT_AUTOCMD
2654 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2655 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2656 if (!alt_buf->b_p_bl)
2658 alt_buf->b_p_bl = TRUE;
2659 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2661 # ifdef FEAT_EVAL
2662 if (curbuf != was_curbuf || aborting())
2663 # else
2664 if (curbuf != was_curbuf)
2665 # endif
2667 /* buffer changed, don't write the file */
2668 retval = FAIL;
2669 goto theend;
2672 /* If 'filetype' was empty try detecting it now. */
2673 if (*curbuf->b_p_ft == NUL)
2675 if (au_has_group((char_u *)"filetypedetect"))
2676 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2677 TRUE);
2678 do_modelines(0);
2680 #endif
2683 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2684 eap, eap->append, eap->forceit, TRUE, FALSE);
2686 /* After ":saveas fname" reset 'readonly'. */
2687 if (eap->cmdidx == CMD_saveas)
2689 if (retval == OK)
2690 curbuf->b_p_ro = FALSE;
2691 /* Change directories when the 'acd' option is set. */
2692 DO_AUTOCHDIR
2696 theend:
2697 #ifdef FEAT_BROWSE
2698 vim_free(browse_file);
2699 #endif
2700 vim_free(free_fname);
2701 return retval;
2705 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2706 * BF_NEW or BF_READERR, check for overwriting current file.
2707 * May set eap->forceit if a dialog says it's OK to overwrite.
2708 * Return OK if it's OK, FAIL if it is not.
2710 /*ARGSUSED*/
2711 static int
2712 check_overwrite(eap, buf, fname, ffname, other)
2713 exarg_T *eap;
2714 buf_T *buf;
2715 char_u *fname; /* file name to be used (can differ from
2716 buf->ffname) */
2717 char_u *ffname; /* full path version of fname */
2718 int other; /* writing under other name */
2721 * write to other file or b_flags set or not writing the whole file:
2722 * overwriting only allowed with '!'
2724 if ( (other
2725 || (buf->b_flags & BF_NOTEDITED)
2726 || ((buf->b_flags & BF_NEW)
2727 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2728 || (buf->b_flags & BF_READERR))
2729 && !p_wa
2730 && vim_fexists(ffname))
2732 if (!eap->forceit && !eap->append)
2734 #ifdef UNIX
2735 /* with UNIX it is possible to open a directory */
2736 if (mch_isdir(ffname))
2738 EMSG2(_(e_isadir2), ffname);
2739 return FAIL;
2741 #endif
2742 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2743 if (p_confirm || cmdmod.confirm)
2745 char_u buff[IOSIZE];
2747 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2748 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2749 return FAIL;
2750 eap->forceit = TRUE;
2752 else
2753 #endif
2755 EMSG(_(e_exists));
2756 return FAIL;
2760 /* For ":w! filename" check that no swap file exists for "filename". */
2761 if (other && !emsg_silent)
2763 char_u dir[MAXPATHL];
2764 char_u *p;
2765 int r;
2766 char_u *swapname;
2768 /* We only try the first entry in 'directory', without checking if
2769 * it's writable. If the "." directory is not writable the write
2770 * will probably fail anyway.
2771 * Use 'shortname' of the current buffer, since there is no buffer
2772 * for the written file. */
2773 if (*p_dir == NUL)
2774 STRCPY(dir, ".");
2775 else
2777 p = p_dir;
2778 copy_option_part(&p, dir, MAXPATHL, ",");
2780 swapname = makeswapname(fname, ffname, curbuf, dir);
2781 r = vim_fexists(swapname);
2782 if (r)
2784 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2785 if (p_confirm || cmdmod.confirm)
2787 char_u buff[IOSIZE];
2789 dialog_msg(buff,
2790 _("Swap file \"%s\" exists, overwrite anyway?"),
2791 swapname);
2792 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2793 != VIM_YES)
2795 vim_free(swapname);
2796 return FAIL;
2798 eap->forceit = TRUE;
2800 else
2801 #endif
2803 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2804 swapname);
2805 vim_free(swapname);
2806 return FAIL;
2809 vim_free(swapname);
2812 return OK;
2816 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2818 void
2819 ex_wnext(eap)
2820 exarg_T *eap;
2822 int i;
2824 if (eap->cmd[1] == 'n')
2825 i = curwin->w_arg_idx + (int)eap->line2;
2826 else
2827 i = curwin->w_arg_idx - (int)eap->line2;
2828 eap->line1 = 1;
2829 eap->line2 = curbuf->b_ml.ml_line_count;
2830 if (do_write(eap) != FAIL)
2831 do_argfile(eap, i);
2835 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2837 void
2838 do_wqall(eap)
2839 exarg_T *eap;
2841 buf_T *buf;
2842 int error = 0;
2843 int save_forceit = eap->forceit;
2845 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2846 exiting = TRUE;
2848 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2850 if (bufIsChanged(buf))
2853 * Check if there is a reason the buffer cannot be written:
2854 * 1. if the 'write' option is set
2855 * 2. if there is no file name (even after browsing)
2856 * 3. if the 'readonly' is set (even after a dialog)
2857 * 4. if overwriting is allowed (even after a dialog)
2859 if (not_writing())
2861 ++error;
2862 break;
2864 #ifdef FEAT_BROWSE
2865 /* ":browse wall": ask for file name if there isn't one */
2866 if (buf->b_ffname == NULL && cmdmod.browse)
2867 browse_save_fname(buf);
2868 #endif
2869 if (buf->b_ffname == NULL)
2871 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2872 ++error;
2874 else if (check_readonly(&eap->forceit, buf)
2875 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2876 FALSE) == FAIL)
2878 ++error;
2880 else
2882 if (buf_write_all(buf, eap->forceit) == FAIL)
2883 ++error;
2884 #ifdef FEAT_AUTOCMD
2885 /* an autocommand may have deleted the buffer */
2886 if (!buf_valid(buf))
2887 buf = firstbuf;
2888 #endif
2890 eap->forceit = save_forceit; /* check_overwrite() may set it */
2893 if (exiting)
2895 if (!error)
2896 getout(0); /* exit Vim */
2897 not_exiting();
2902 * Check the 'write' option.
2903 * Return TRUE and give a message when it's not st.
2906 not_writing()
2908 if (p_write)
2909 return FALSE;
2910 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2911 return TRUE;
2915 * Check if a buffer is read-only (either 'readonly' option is set or file is
2916 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2917 * message when the buffer is readonly.
2919 static int
2920 check_readonly(forceit, buf)
2921 int *forceit;
2922 buf_T *buf;
2924 struct stat st;
2926 /* Handle a file being readonly when the 'readonly' option is set or when
2927 * the file exists and permissions are read-only.
2928 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2929 * important for device checks but not here. */
2930 if (!*forceit && (buf->b_p_ro
2931 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2932 && check_file_readonly(buf->b_ffname, 0777))))
2934 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2935 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2937 char_u buff[IOSIZE];
2939 if (buf->b_p_ro)
2940 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2941 buf->b_fname);
2942 else
2943 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2944 buf->b_fname);
2946 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2948 /* Set forceit, to force the writing of a readonly file */
2949 *forceit = TRUE;
2950 return FALSE;
2952 else
2953 return TRUE;
2955 else
2956 #endif
2957 if (buf->b_p_ro)
2958 EMSG(_(e_readonly));
2959 else
2960 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2961 buf->b_fname);
2962 return TRUE;
2965 return FALSE;
2969 * Try to abandon current file and edit a new or existing file.
2970 * 'fnum' is the number of the file, if zero use ffname/sfname.
2972 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2973 * -1 for succesfully opening another file.
2974 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2977 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2978 int fnum;
2979 char_u *ffname;
2980 char_u *sfname;
2981 int setpm;
2982 linenr_T lnum;
2983 int forceit;
2985 int other;
2986 int retval;
2987 char_u *free_me = NULL;
2989 if (text_locked())
2990 return 1;
2991 #ifdef FEAT_AUTOCMD
2992 if (curbuf_locked())
2993 return 1;
2994 #endif
2996 if (fnum == 0)
2998 /* make ffname full path, set sfname */
2999 fname_expand(curbuf, &ffname, &sfname);
3000 other = otherfile(ffname);
3001 free_me = ffname; /* has been allocated, free() later */
3003 else
3004 other = (fnum != curbuf->b_fnum);
3006 if (other)
3007 ++no_wait_return; /* don't wait for autowrite message */
3008 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3009 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3011 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3012 if (p_confirm && p_write)
3013 dialog_changed(curbuf, FALSE);
3014 if (curbufIsChanged())
3015 #endif
3017 if (other)
3018 --no_wait_return;
3019 EMSG(_(e_nowrtmsg));
3020 retval = 2; /* file has been changed */
3021 goto theend;
3024 if (other)
3025 --no_wait_return;
3026 if (setpm)
3027 setpcmark();
3028 if (!other)
3030 if (lnum != 0)
3031 curwin->w_cursor.lnum = lnum;
3032 check_cursor_lnum();
3033 beginline(BL_SOL | BL_FIX);
3034 retval = 0; /* it's in the same file */
3036 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3037 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3038 retval = -1; /* opened another file */
3039 else
3040 retval = 1; /* error encountered */
3042 theend:
3043 vim_free(free_me);
3044 return retval;
3048 * start editing a new file
3050 * fnum: file number; if zero use ffname/sfname
3051 * ffname: the file name
3052 * - full path if sfname used,
3053 * - any file name if sfname is NULL
3054 * - empty string to re-edit with the same file name (but may be
3055 * in a different directory)
3056 * - NULL to start an empty buffer
3057 * sfname: the short file name (or NULL)
3058 * eap: contains the command to be executed after loading the file and
3059 * forced 'ff' and 'fenc'
3060 * newlnum: if > 0: put cursor on this line number (if possible)
3061 * if ECMD_LASTL: use last position in loaded file
3062 * if ECMD_LAST: use last position in all files
3063 * if ECMD_ONE: use first line
3064 * flags:
3065 * ECMD_HIDE: if TRUE don't free the current buffer
3066 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3067 * ECMD_OLDBUF: use existing buffer if it exists
3068 * ECMD_FORCEIT: ! used for Ex command
3069 * ECMD_ADDBUF: don't edit, just add to buffer list
3071 * return FAIL for failure, OK otherwise
3074 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3075 int fnum;
3076 char_u *ffname;
3077 char_u *sfname;
3078 exarg_T *eap; /* can be NULL! */
3079 linenr_T newlnum;
3080 int flags;
3082 int other_file; /* TRUE if editing another file */
3083 int oldbuf; /* TRUE if using existing buffer */
3084 #ifdef FEAT_AUTOCMD
3085 int auto_buf = FALSE; /* TRUE if autocommands brought us
3086 into the buffer unexpectedly */
3087 char_u *new_name = NULL;
3088 int did_set_swapcommand = FALSE;
3089 #endif
3090 buf_T *buf;
3091 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3092 buf_T *old_curbuf = curbuf;
3093 #endif
3094 char_u *free_fname = NULL;
3095 #ifdef FEAT_BROWSE
3096 char_u *browse_file = NULL;
3097 #endif
3098 int retval = FAIL;
3099 long n;
3100 linenr_T lnum;
3101 linenr_T topline = 0;
3102 int newcol = -1;
3103 int solcol = -1;
3104 pos_T *pos;
3105 #ifdef FEAT_SUN_WORKSHOP
3106 char_u *cp;
3107 #endif
3108 char_u *command = NULL;
3109 #ifdef FEAT_SPELL
3110 int did_get_winopts = FALSE;
3111 #endif
3113 if (eap != NULL)
3114 command = eap->do_ecmd_cmd;
3116 if (fnum != 0)
3118 if (fnum == curbuf->b_fnum) /* file is already being edited */
3119 return OK; /* nothing to do */
3120 other_file = TRUE;
3122 else
3124 #ifdef FEAT_BROWSE
3125 if (cmdmod.browse)
3127 if (
3128 # ifdef FEAT_GUI
3129 !gui.in_use &&
3130 # endif
3131 au_has_group((char_u *)"FileExplorer"))
3133 /* No browsing supported but we do have the file explorer:
3134 * Edit the directory. */
3135 if (ffname == NULL || !mch_isdir(ffname))
3136 ffname = (char_u *)".";
3138 else
3140 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3141 NULL, NULL, NULL, curbuf);
3142 if (browse_file == NULL)
3143 goto theend;
3144 ffname = browse_file;
3147 #endif
3148 /* if no short name given, use ffname for short name */
3149 if (sfname == NULL)
3150 sfname = ffname;
3151 #ifdef USE_FNAME_CASE
3152 # ifdef USE_LONG_FNAME
3153 if (USE_LONG_FNAME)
3154 # endif
3155 if (sfname != NULL)
3156 fname_case(sfname, 0); /* set correct case for sfname */
3157 #endif
3159 #ifdef FEAT_LISTCMDS
3160 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3161 goto theend;
3162 #endif
3164 if (ffname == NULL)
3165 other_file = TRUE;
3166 /* there is no file name */
3167 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3168 other_file = FALSE;
3169 else
3171 if (*ffname == NUL) /* re-edit with same file name */
3173 ffname = curbuf->b_ffname;
3174 sfname = curbuf->b_fname;
3176 free_fname = fix_fname(ffname); /* may expand to full path name */
3177 if (free_fname != NULL)
3178 ffname = free_fname;
3179 other_file = otherfile(ffname);
3180 #ifdef FEAT_SUN_WORKSHOP
3181 if (usingSunWorkShop && p_acd
3182 && (cp = vim_strrchr(sfname, '/')) != NULL)
3183 sfname = ++cp;
3184 #endif
3189 * if the file was changed we may not be allowed to abandon it
3190 * - if we are going to re-edit the same file
3191 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3193 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3194 || (curbuf->b_nwindows == 1
3195 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3196 && check_changed(curbuf, p_awa, !other_file,
3197 (flags & ECMD_FORCEIT), FALSE))
3199 if (fnum == 0 && other_file && ffname != NULL)
3200 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3201 goto theend;
3204 #ifdef FEAT_VISUAL
3206 * End Visual mode before switching to another buffer, so the text can be
3207 * copied into the GUI selection buffer.
3209 reset_VIsual();
3210 #endif
3212 #ifdef FEAT_AUTOCMD
3213 if ((command != NULL || newlnum > (linenr_T)0)
3214 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3216 int len;
3217 char_u *p;
3219 /* Set v:swapcommand for the SwapExists autocommands. */
3220 if (command != NULL)
3221 len = (int)STRLEN(command) + 3;
3222 else
3223 len = 30;
3224 p = alloc((unsigned)len);
3225 if (p != NULL)
3227 if (command != NULL)
3228 vim_snprintf((char *)p, len, ":%s\r", command);
3229 else
3230 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3231 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3232 did_set_swapcommand = TRUE;
3233 vim_free(p);
3236 #endif
3239 * If we are starting to edit another file, open a (new) buffer.
3240 * Otherwise we re-use the current buffer.
3242 if (other_file)
3244 #ifdef FEAT_LISTCMDS
3245 if (!(flags & ECMD_ADDBUF))
3246 #endif
3248 if (!cmdmod.keepalt)
3249 curwin->w_alt_fnum = curbuf->b_fnum;
3250 buflist_altfpos();
3253 if (fnum)
3254 buf = buflist_findnr(fnum);
3255 else
3257 #ifdef FEAT_LISTCMDS
3258 if (flags & ECMD_ADDBUF)
3260 linenr_T tlnum = 1L;
3262 if (command != NULL)
3264 tlnum = atol((char *)command);
3265 if (tlnum <= 0)
3266 tlnum = 1L;
3268 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3269 goto theend;
3271 #endif
3272 buf = buflist_new(ffname, sfname, 0L,
3273 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3275 if (buf == NULL)
3276 goto theend;
3277 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3279 oldbuf = FALSE;
3280 buf->b_nwindows = 0;
3282 else /* existing memfile */
3284 oldbuf = TRUE;
3285 (void)buf_check_timestamp(buf, FALSE);
3286 /* Check if autocommands made buffer invalid or changed the current
3287 * buffer. */
3288 if (!buf_valid(buf)
3289 #ifdef FEAT_AUTOCMD
3290 || curbuf != old_curbuf
3291 #endif
3293 goto theend;
3294 #ifdef FEAT_EVAL
3295 if (aborting()) /* autocmds may abort script processing */
3296 goto theend;
3297 #endif
3300 /* May jump to last used line number for a loaded buffer or when asked
3301 * for explicitly */
3302 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3304 pos = buflist_findfpos(buf);
3305 newlnum = pos->lnum;
3306 solcol = pos->col;
3310 * Make the (new) buffer the one used by the current window.
3311 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3312 * If the current buffer was empty and has no file name, curbuf
3313 * is returned by buflist_new().
3315 if (buf != curbuf)
3317 #ifdef FEAT_AUTOCMD
3319 * Be careful: The autocommands may delete any buffer and change
3320 * the current buffer.
3321 * - If the buffer we are going to edit is deleted, give up.
3322 * - If the current buffer is deleted, prefer to load the new
3323 * buffer when loading a buffer is required. This avoids
3324 * loading another buffer which then must be closed again.
3325 * - If we ended up in the new buffer already, need to skip a few
3326 * things, set auto_buf.
3328 if (buf->b_fname != NULL)
3329 new_name = vim_strsave(buf->b_fname);
3330 au_new_curbuf = buf;
3331 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3332 if (!buf_valid(buf)) /* new buffer has been deleted */
3334 delbuf_msg(new_name); /* frees new_name */
3335 goto theend;
3337 # ifdef FEAT_EVAL
3338 if (aborting()) /* autocmds may abort script processing */
3340 vim_free(new_name);
3341 goto theend;
3343 # endif
3344 if (buf == curbuf) /* already in new buffer */
3345 auto_buf = TRUE;
3346 else
3348 if (curbuf == old_curbuf)
3349 #endif
3350 buf_copy_options(buf, BCO_ENTER);
3352 /* close the link to the current buffer */
3353 u_sync(FALSE);
3354 close_buffer(curwin, curbuf,
3355 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3357 #ifdef FEAT_AUTOCMD
3358 # ifdef FEAT_EVAL
3359 if (aborting()) /* autocmds may abort script processing */
3361 vim_free(new_name);
3362 goto theend;
3364 # endif
3365 /* Be careful again, like above. */
3366 if (!buf_valid(buf)) /* new buffer has been deleted */
3368 delbuf_msg(new_name); /* frees new_name */
3369 goto theend;
3371 if (buf == curbuf) /* already in new buffer */
3372 auto_buf = TRUE;
3373 else
3374 #endif
3376 curwin->w_buffer = buf;
3377 curbuf = buf;
3378 ++curbuf->b_nwindows;
3379 /* set 'fileformat' */
3380 if (*p_ffs && !oldbuf)
3381 set_fileformat(default_fileformat(), OPT_LOCAL);
3384 /* May get the window options from the last time this buffer
3385 * was in this window (or another window). If not used
3386 * before, reset the local window options to the global
3387 * values. Also restores old folding stuff. */
3388 get_winopts(curbuf);
3389 #ifdef FEAT_SPELL
3390 did_get_winopts = TRUE;
3391 #endif
3393 #ifdef FEAT_AUTOCMD
3395 vim_free(new_name);
3396 au_new_curbuf = NULL;
3397 #endif
3399 else
3400 ++curbuf->b_nwindows;
3402 curwin->w_pcmark.lnum = 1;
3403 curwin->w_pcmark.col = 0;
3405 else /* !other_file */
3407 if (
3408 #ifdef FEAT_LISTCMDS
3409 (flags & ECMD_ADDBUF) ||
3410 #endif
3411 check_fname() == FAIL)
3412 goto theend;
3413 oldbuf = (flags & ECMD_OLDBUF);
3416 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3418 char_u *p;
3420 curbuf->b_help = TRUE;
3421 #ifdef FEAT_QUICKFIX
3422 set_string_option_direct((char_u *)"buftype", -1,
3423 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3424 #endif
3427 * Always set these options after jumping to a help tag, because the
3428 * user may have an autocommand that gets in the way.
3429 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3430 * latin1 word characters (for translated help files).
3431 * Only set it when needed, buf_init_chartab() is some work.
3434 #ifdef EBCDIC
3435 (char_u *)"65-255,^*,^|,^\"";
3436 #else
3437 (char_u *)"!-~,^*,^|,^\",192-255";
3438 #endif
3439 if (STRCMP(curbuf->b_p_isk, p) != 0)
3441 set_string_option_direct((char_u *)"isk", -1, p,
3442 OPT_FREE|OPT_LOCAL, 0);
3443 check_buf_options(curbuf);
3444 (void)buf_init_chartab(curbuf, FALSE);
3447 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3448 curwin->w_p_list = FALSE; /* no list mode */
3450 curbuf->b_p_ma = FALSE; /* not modifiable */
3451 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3452 curwin->w_p_nu = 0; /* no line numbers */
3453 #ifdef FEAT_SCROLLBIND
3454 curwin->w_p_scb = FALSE; /* no scroll binding */
3455 #endif
3456 #ifdef FEAT_ARABIC
3457 curwin->w_p_arab = FALSE; /* no arabic mode */
3458 #endif
3459 #ifdef FEAT_RIGHTLEFT
3460 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3461 #endif
3462 #ifdef FEAT_FOLDING
3463 curwin->w_p_fen = FALSE; /* No folding in the help window */
3464 #endif
3465 #ifdef FEAT_DIFF
3466 curwin->w_p_diff = FALSE; /* No 'diff' */
3467 #endif
3468 #ifdef FEAT_SPELL
3469 curwin->w_p_spell = FALSE; /* No spell checking */
3470 #endif
3472 #ifdef FEAT_AUTOCMD
3473 buf = curbuf;
3474 #endif
3475 set_buflisted(FALSE);
3477 else
3479 #ifdef FEAT_AUTOCMD
3480 buf = curbuf;
3481 #endif
3482 /* Don't make a buffer listed if it's a help buffer. Useful when
3483 * using CTRL-O to go back to a help file. */
3484 if (!curbuf->b_help)
3485 set_buflisted(TRUE);
3488 #ifdef FEAT_AUTOCMD
3489 /* If autocommands change buffers under our fingers, forget about
3490 * editing the file. */
3491 if (buf != curbuf)
3492 goto theend;
3493 # ifdef FEAT_EVAL
3494 if (aborting()) /* autocmds may abort script processing */
3495 goto theend;
3496 # endif
3498 /* Since we are starting to edit a file, consider the filetype to be
3499 * unset. Helps for when an autocommand changes files and expects syntax
3500 * highlighting to work in the other file. */
3501 did_filetype = FALSE;
3502 #endif
3505 * other_file oldbuf
3506 * FALSE FALSE re-edit same file, buffer is re-used
3507 * FALSE TRUE re-edit same file, nothing changes
3508 * TRUE FALSE start editing new file, new buffer
3509 * TRUE TRUE start editing in existing buffer (nothing to do)
3511 if (!other_file && !oldbuf) /* re-use the buffer */
3513 set_last_cursor(curwin); /* may set b_last_cursor */
3514 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3516 newlnum = curwin->w_cursor.lnum;
3517 solcol = curwin->w_cursor.col;
3519 #ifdef FEAT_AUTOCMD
3520 buf = curbuf;
3521 if (buf->b_fname != NULL)
3522 new_name = vim_strsave(buf->b_fname);
3523 else
3524 new_name = NULL;
3525 #endif
3526 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3527 #ifdef FEAT_AUTOCMD
3528 /* If autocommands deleted the buffer we were going to re-edit, give
3529 * up and jump to the end. */
3530 if (!buf_valid(buf))
3532 delbuf_msg(new_name); /* frees new_name */
3533 goto theend;
3535 vim_free(new_name);
3537 /* If autocommands change buffers under our fingers, forget about
3538 * re-editing the file. Should do the buf_clear_file(), but perhaps
3539 * the autocommands changed the buffer... */
3540 if (buf != curbuf)
3541 goto theend;
3542 # ifdef FEAT_EVAL
3543 if (aborting()) /* autocmds may abort script processing */
3544 goto theend;
3545 # endif
3546 #endif
3547 buf_clear_file(curbuf);
3548 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3549 curbuf->b_op_end.lnum = 0;
3553 * If we get here we are sure to start editing
3555 /* don't redraw until the cursor is in the right line */
3556 ++RedrawingDisabled;
3558 /* Assume success now */
3559 retval = OK;
3562 * Reset cursor position, could be used by autocommands.
3564 check_cursor();
3567 * Check if we are editing the w_arg_idx file in the argument list.
3569 check_arg_idx(curwin);
3571 #ifdef FEAT_AUTOCMD
3572 if (!auto_buf)
3573 #endif
3576 * Set cursor and init window before reading the file and executing
3577 * autocommands. This allows for the autocommands to position the
3578 * cursor.
3580 curwin_init();
3582 #ifdef FEAT_FOLDING
3583 /* It's like all lines in the buffer changed. Need to update
3584 * automatic folding. */
3585 foldUpdateAll(curwin);
3586 #endif
3588 /* Change directories when the 'acd' option is set. */
3589 DO_AUTOCHDIR
3592 * Careful: open_buffer() and apply_autocmds() may change the current
3593 * buffer and window.
3595 lnum = curwin->w_cursor.lnum;
3596 topline = curwin->w_topline;
3597 if (!oldbuf) /* need to read the file */
3599 #if defined(HAS_SWAP_EXISTS_ACTION)
3600 swap_exists_action = SEA_DIALOG;
3601 #endif
3602 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3605 * Open the buffer and read the file.
3607 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3608 if (should_abort(open_buffer(FALSE, eap)))
3609 retval = FAIL;
3610 #else
3611 (void)open_buffer(FALSE, eap);
3612 #endif
3614 #if defined(HAS_SWAP_EXISTS_ACTION)
3615 if (swap_exists_action == SEA_QUIT)
3616 retval = FAIL;
3617 handle_swap_exists(old_curbuf);
3618 #endif
3620 #ifdef FEAT_AUTOCMD
3621 else
3623 /* Read the modelines, but only to set window-local options. Any
3624 * buffer-local options have already been set and may have been
3625 * changed by the user. */
3626 do_modelines(OPT_WINONLY);
3628 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3629 &retval);
3630 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3631 &retval);
3633 check_arg_idx(curwin);
3634 #endif
3637 * If autocommands change the cursor position or topline, we should
3638 * keep it.
3640 if (curwin->w_cursor.lnum != lnum)
3642 newlnum = curwin->w_cursor.lnum;
3643 newcol = curwin->w_cursor.col;
3645 if (curwin->w_topline == topline)
3646 topline = 0;
3648 /* Even when cursor didn't move we need to recompute topline. */
3649 changed_line_abv_curs();
3651 #ifdef FEAT_TITLE
3652 maketitle();
3653 #endif
3656 #ifdef FEAT_DIFF
3657 /* Tell the diff stuff that this buffer is new and/or needs updating.
3658 * Also needed when re-editing the same buffer, because unloading will
3659 * have removed it as a diff buffer. */
3660 if (curwin->w_p_diff)
3662 diff_buf_add(curbuf);
3663 diff_invalidate(curbuf);
3665 #endif
3667 #ifdef FEAT_SPELL
3668 /* If the window options were changed may need to set the spell language.
3669 * Can only do this after the buffer has been properly setup. */
3670 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3671 did_set_spelllang(curbuf);
3672 #endif
3674 if (command == NULL)
3676 if (newcol >= 0) /* position set by autocommands */
3678 curwin->w_cursor.lnum = newlnum;
3679 curwin->w_cursor.col = newcol;
3680 check_cursor();
3682 else if (newlnum > 0) /* line number from caller or old position */
3684 curwin->w_cursor.lnum = newlnum;
3685 check_cursor_lnum();
3686 if (solcol >= 0 && !p_sol)
3688 /* 'sol' is off: Use last known column. */
3689 curwin->w_cursor.col = solcol;
3690 check_cursor_col();
3691 #ifdef FEAT_VIRTUALEDIT
3692 curwin->w_cursor.coladd = 0;
3693 #endif
3694 curwin->w_set_curswant = TRUE;
3696 else
3697 beginline(BL_SOL | BL_FIX);
3699 else /* no line number, go to last line in Ex mode */
3701 if (exmode_active)
3702 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3703 beginline(BL_WHITE | BL_FIX);
3707 #ifdef FEAT_WINDOWS
3708 /* Check if cursors in other windows on the same buffer are still valid */
3709 check_lnums(FALSE);
3710 #endif
3713 * Did not read the file, need to show some info about the file.
3714 * Do this after setting the cursor.
3716 if (oldbuf
3717 #ifdef FEAT_AUTOCMD
3718 && !auto_buf
3719 #endif
3722 int msg_scroll_save = msg_scroll;
3724 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3725 * message. */
3726 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3727 msg_scroll = FALSE;
3728 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3729 check_for_delay(FALSE);
3730 msg_start();
3731 msg_scroll = msg_scroll_save;
3732 msg_scrolled_ign = TRUE;
3734 fileinfo(FALSE, TRUE, FALSE);
3736 msg_scrolled_ign = FALSE;
3739 if (command != NULL)
3740 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3742 #ifdef FEAT_KEYMAP
3743 if (curbuf->b_kmap_state & KEYMAP_INIT)
3744 keymap_init();
3745 #endif
3747 --RedrawingDisabled;
3748 if (!skip_redraw)
3750 n = p_so;
3751 if (topline == 0 && command == NULL)
3752 p_so = 999; /* force cursor halfway the window */
3753 update_topline();
3754 #ifdef FEAT_SCROLLBIND
3755 curwin->w_scbind_pos = curwin->w_topline;
3756 #endif
3757 p_so = n;
3758 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3761 if (p_im)
3762 need_start_insertmode = TRUE;
3764 /* Change directories when the 'acd' option is set. */
3765 DO_AUTOCHDIR
3767 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3768 if (gui.in_use && curbuf->b_ffname != NULL)
3770 # ifdef FEAT_SUN_WORKSHOP
3771 if (usingSunWorkShop)
3772 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3773 # endif
3774 # ifdef FEAT_NETBEANS_INTG
3775 if (usingNetbeans & ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3776 netbeans_file_opened(curbuf);
3777 # endif
3779 #endif
3781 theend:
3782 #ifdef FEAT_AUTOCMD
3783 if (did_set_swapcommand)
3784 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3785 #endif
3786 #ifdef FEAT_BROWSE
3787 vim_free(browse_file);
3788 #endif
3789 vim_free(free_fname);
3790 return retval;
3793 #ifdef FEAT_AUTOCMD
3794 static void
3795 delbuf_msg(name)
3796 char_u *name;
3798 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3799 name == NULL ? (char_u *)"" : name);
3800 vim_free(name);
3801 au_new_curbuf = NULL;
3803 #endif
3805 static int append_indent = 0; /* autoindent for first line */
3808 * ":insert" and ":append", also used by ":change"
3810 void
3811 ex_append(eap)
3812 exarg_T *eap;
3814 char_u *theline;
3815 int did_undo = FALSE;
3816 linenr_T lnum = eap->line2;
3817 int indent = 0;
3818 char_u *p;
3819 int vcol;
3820 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3822 /* the ! flag toggles autoindent */
3823 if (eap->forceit)
3824 curbuf->b_p_ai = !curbuf->b_p_ai;
3826 /* First autoindent comes from the line we start on */
3827 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3828 append_indent = get_indent_lnum(lnum);
3830 if (eap->cmdidx != CMD_append)
3831 --lnum;
3833 /* when the buffer is empty append to line 0 and delete the dummy line */
3834 if (empty && lnum == 1)
3835 lnum = 0;
3837 State = INSERT; /* behave like in Insert mode */
3838 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3839 State |= LANGMAP;
3841 for (;;)
3843 msg_scroll = TRUE;
3844 need_wait_return = FALSE;
3845 if (curbuf->b_p_ai)
3847 if (append_indent >= 0)
3849 indent = append_indent;
3850 append_indent = -1;
3852 else if (lnum > 0)
3853 indent = get_indent_lnum(lnum);
3855 ex_keep_indent = FALSE;
3856 if (eap->getline == NULL)
3858 /* No getline() function, use the lines that follow. This ends
3859 * when there is no more. */
3860 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3861 break;
3862 p = vim_strchr(eap->nextcmd, NL);
3863 if (p == NULL)
3864 p = eap->nextcmd + STRLEN(eap->nextcmd);
3865 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3866 if (*p != NUL)
3867 ++p;
3868 eap->nextcmd = p;
3870 else
3871 theline = eap->getline(
3872 #ifdef FEAT_EVAL
3873 eap->cstack->cs_looplevel > 0 ? -1 :
3874 #endif
3875 NUL, eap->cookie, indent);
3876 lines_left = Rows - 1;
3877 if (theline == NULL)
3878 break;
3880 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3881 if (ex_keep_indent)
3882 append_indent = indent;
3884 /* Look for the "." after automatic indent. */
3885 vcol = 0;
3886 for (p = theline; indent > vcol; ++p)
3888 if (*p == ' ')
3889 ++vcol;
3890 else if (*p == TAB)
3891 vcol += 8 - vcol % 8;
3892 else
3893 break;
3895 if ((p[0] == '.' && p[1] == NUL)
3896 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3897 == FAIL))
3899 vim_free(theline);
3900 break;
3903 /* don't use autoindent if nothing was typed. */
3904 if (p[0] == NUL)
3905 theline[0] = NUL;
3907 did_undo = TRUE;
3908 ml_append(lnum, theline, (colnr_T)0, FALSE);
3909 appended_lines_mark(lnum, 1L);
3911 vim_free(theline);
3912 ++lnum;
3914 if (empty)
3916 ml_delete(2L, FALSE);
3917 empty = FALSE;
3920 State = NORMAL;
3922 if (eap->forceit)
3923 curbuf->b_p_ai = !curbuf->b_p_ai;
3925 /* "start" is set to eap->line2+1 unless that position is invalid (when
3926 * eap->line2 pointed to the end of the buffer and nothing was appended)
3927 * "end" is set to lnum when something has been appended, otherwise
3928 * it is the same than "start" -- Acevedo */
3929 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3930 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3931 if (eap->cmdidx != CMD_append)
3932 --curbuf->b_op_start.lnum;
3933 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3934 ? lnum : curbuf->b_op_start.lnum;
3935 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3936 curwin->w_cursor.lnum = lnum;
3937 check_cursor_lnum();
3938 beginline(BL_SOL | BL_FIX);
3940 need_wait_return = FALSE; /* don't use wait_return() now */
3941 ex_no_reprint = TRUE;
3945 * ":change"
3947 void
3948 ex_change(eap)
3949 exarg_T *eap;
3951 linenr_T lnum;
3953 if (eap->line2 >= eap->line1
3954 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3955 return;
3957 /* the ! flag toggles autoindent */
3958 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3959 append_indent = get_indent_lnum(eap->line1);
3961 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3963 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3964 break;
3965 ml_delete(eap->line1, FALSE);
3967 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3969 /* ":append" on the line above the deleted lines. */
3970 eap->line2 = eap->line1;
3971 ex_append(eap);
3974 void
3975 ex_z(eap)
3976 exarg_T *eap;
3978 char_u *x;
3979 int bigness;
3980 char_u *kind;
3981 int minus = 0;
3982 linenr_T start, end, curs, i;
3983 int j;
3984 linenr_T lnum = eap->line2;
3986 /* Vi compatible: ":z!" uses display height, without a count uses
3987 * 'scroll' */
3988 if (eap->forceit)
3989 bigness = curwin->w_height;
3990 else if (firstwin == lastwin)
3991 bigness = curwin->w_p_scr * 2;
3992 else
3993 bigness = curwin->w_height - 3;
3994 if (bigness < 1)
3995 bigness = 1;
3997 x = eap->arg;
3998 kind = x;
3999 if (*kind == '-' || *kind == '+' || *kind == '='
4000 || *kind == '^' || *kind == '.')
4001 ++x;
4002 while (*x == '-' || *x == '+')
4003 ++x;
4005 if (*x != 0)
4007 if (!VIM_ISDIGIT(*x))
4009 EMSG(_("E144: non-numeric argument to :z"));
4010 return;
4012 else
4014 bigness = atoi((char *)x);
4015 p_window = bigness;
4016 if (*kind == '=')
4017 bigness += 2;
4021 /* the number of '-' and '+' multiplies the distance */
4022 if (*kind == '-' || *kind == '+')
4023 for (x = kind + 1; *x == *kind; ++x)
4026 switch (*kind)
4028 case '-':
4029 start = lnum - bigness * (linenr_T)(x - kind);
4030 end = start + bigness;
4031 curs = end;
4032 break;
4034 case '=':
4035 start = lnum - (bigness + 1) / 2 + 1;
4036 end = lnum + (bigness + 1) / 2 - 1;
4037 curs = lnum;
4038 minus = 1;
4039 break;
4041 case '^':
4042 start = lnum - bigness * 2;
4043 end = lnum - bigness;
4044 curs = lnum - bigness;
4045 break;
4047 case '.':
4048 start = lnum - (bigness + 1) / 2 + 1;
4049 end = lnum + (bigness + 1) / 2 - 1;
4050 curs = end;
4051 break;
4053 default: /* '+' */
4054 start = lnum;
4055 if (*kind == '+')
4056 start += bigness * (linenr_T)(x - kind - 1) + 1;
4057 else if (eap->addr_count == 0)
4058 ++start;
4059 end = start + bigness - 1;
4060 curs = end;
4061 break;
4064 if (start < 1)
4065 start = 1;
4067 if (end > curbuf->b_ml.ml_line_count)
4068 end = curbuf->b_ml.ml_line_count;
4070 if (curs > curbuf->b_ml.ml_line_count)
4071 curs = curbuf->b_ml.ml_line_count;
4073 for (i = start; i <= end; i++)
4075 if (minus && i == lnum)
4077 msg_putchar('\n');
4079 for (j = 1; j < Columns; j++)
4080 msg_putchar('-');
4083 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4085 if (minus && i == lnum)
4087 msg_putchar('\n');
4089 for (j = 1; j < Columns; j++)
4090 msg_putchar('-');
4094 curwin->w_cursor.lnum = curs;
4095 ex_no_reprint = TRUE;
4099 * Check if the restricted flag is set.
4100 * If so, give an error message and return TRUE.
4101 * Otherwise, return FALSE.
4104 check_restricted()
4106 if (restricted)
4108 EMSG(_("E145: Shell commands not allowed in rvim"));
4109 return TRUE;
4111 return FALSE;
4115 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4116 * If so, give an error message and return TRUE.
4117 * Otherwise, return FALSE.
4120 check_secure()
4122 if (secure)
4124 secure = 2;
4125 EMSG(_(e_curdir));
4126 return TRUE;
4128 #ifdef HAVE_SANDBOX
4130 * In the sandbox more things are not allowed, including the things
4131 * disallowed in secure mode.
4133 if (sandbox != 0)
4135 EMSG(_(e_sandbox));
4136 return TRUE;
4138 #endif
4139 return FALSE;
4142 static char_u *old_sub = NULL; /* previous substitute pattern */
4143 static int global_need_beginline; /* call beginline() after ":g" */
4145 /* do_sub()
4147 * Perform a substitution from line eap->line1 to line eap->line2 using the
4148 * command pointed to by eap->arg which should be of the form:
4150 * /pattern/substitution/{flags}
4152 * The usual escapes are supported as described in the regexp docs.
4154 void
4155 do_sub(eap)
4156 exarg_T *eap;
4158 linenr_T lnum;
4159 long i = 0;
4160 regmmatch_T regmatch;
4161 static int do_all = FALSE; /* do multiple substitutions per line */
4162 static int do_ask = FALSE; /* ask for confirmation */
4163 static int do_count = FALSE; /* count only */
4164 static int do_error = TRUE; /* if false, ignore errors */
4165 static int do_print = FALSE; /* print last line with subs. */
4166 static int do_list = FALSE; /* list last line with subs. */
4167 static int do_number = FALSE; /* list last line with line nr*/
4168 static int do_ic = 0; /* ignore case flag */
4169 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4170 int delimiter;
4171 int sublen;
4172 int got_quit = FALSE;
4173 int got_match = FALSE;
4174 int temp;
4175 int which_pat;
4176 char_u *cmd;
4177 int save_State;
4178 linenr_T first_line = 0; /* first changed line */
4179 linenr_T last_line= 0; /* below last changed line AFTER the
4180 * change */
4181 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4182 linenr_T line2;
4183 long nmatch; /* number of lines in match */
4184 linenr_T sub_firstlnum; /* nr of first sub line */
4185 char_u *sub_firstline; /* allocated copy of first sub line */
4186 int endcolumn = FALSE; /* cursor in last column when done */
4187 pos_T old_cursor = curwin->w_cursor;
4189 cmd = eap->arg;
4190 if (!global_busy)
4192 sub_nsubs = 0;
4193 sub_nlines = 0;
4196 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4197 if (p_altkeymap && curwin->w_p_rl)
4198 lrF_sub(cmd);
4199 #endif
4201 if (eap->cmdidx == CMD_tilde)
4202 which_pat = RE_LAST; /* use last used regexp */
4203 else
4204 which_pat = RE_SUBST; /* use last substitute regexp */
4206 /* new pattern and substitution */
4207 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4208 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4210 /* don't accept alphanumeric for separator */
4211 if (isalpha(*cmd))
4213 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4214 return;
4217 * undocumented vi feature:
4218 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4219 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4221 if (*cmd == '\\')
4223 ++cmd;
4224 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4226 EMSG(_(e_backslash));
4227 return;
4229 if (*cmd != '&')
4230 which_pat = RE_SEARCH; /* use last '/' pattern */
4231 pat = (char_u *)""; /* empty search pattern */
4232 delimiter = *cmd++; /* remember delimiter character */
4234 else /* find the end of the regexp */
4236 which_pat = RE_LAST; /* use last used regexp */
4237 delimiter = *cmd++; /* remember delimiter character */
4238 pat = cmd; /* remember start of search pat */
4239 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4240 if (cmd[0] == delimiter) /* end delimiter found */
4241 *cmd++ = NUL; /* replace it with a NUL */
4245 * Small incompatibility: vi sees '\n' as end of the command, but in
4246 * Vim we want to use '\n' to find/substitute a NUL.
4248 sub = cmd; /* remember the start of the substitution */
4250 while (cmd[0])
4252 if (cmd[0] == delimiter) /* end delimiter found */
4254 *cmd++ = NUL; /* replace it with a NUL */
4255 break;
4257 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4258 ++cmd;
4259 mb_ptr_adv(cmd);
4262 if (!eap->skip)
4264 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4265 if (STRCMP(sub, "%") == 0
4266 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4268 if (old_sub == NULL) /* there is no previous command */
4270 EMSG(_(e_nopresub));
4271 return;
4273 sub = old_sub;
4275 else
4277 vim_free(old_sub);
4278 old_sub = vim_strsave(sub);
4282 else if (!eap->skip) /* use previous pattern and substitution */
4284 if (old_sub == NULL) /* there is no previous command */
4286 EMSG(_(e_nopresub));
4287 return;
4289 pat = NULL; /* search_regcomp() will use previous pattern */
4290 sub = old_sub;
4292 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4293 * last column after using "$". */
4294 endcolumn = (curwin->w_curswant == MAXCOL);
4298 * Find trailing options. When '&' is used, keep old options.
4300 if (*cmd == '&')
4301 ++cmd;
4302 else
4304 if (!p_ed)
4306 if (p_gd) /* default is global on */
4307 do_all = TRUE;
4308 else
4309 do_all = FALSE;
4310 do_ask = FALSE;
4312 do_error = TRUE;
4313 do_print = FALSE;
4314 do_count = FALSE;
4315 do_ic = 0;
4317 while (*cmd)
4320 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4321 * 'r' is never inverted.
4323 if (*cmd == 'g')
4324 do_all = !do_all;
4325 else if (*cmd == 'c')
4326 do_ask = !do_ask;
4327 else if (*cmd == 'n')
4328 do_count = TRUE;
4329 else if (*cmd == 'e')
4330 do_error = !do_error;
4331 else if (*cmd == 'r') /* use last used regexp */
4332 which_pat = RE_LAST;
4333 else if (*cmd == 'p')
4334 do_print = TRUE;
4335 else if (*cmd == '#')
4337 do_print = TRUE;
4338 do_number = TRUE;
4340 else if (*cmd == 'l')
4342 do_print = TRUE;
4343 do_list = TRUE;
4345 else if (*cmd == 'i') /* ignore case */
4346 do_ic = 'i';
4347 else if (*cmd == 'I') /* don't ignore case */
4348 do_ic = 'I';
4349 else
4350 break;
4351 ++cmd;
4353 if (do_count)
4354 do_ask = FALSE;
4357 * check for a trailing count
4359 cmd = skipwhite(cmd);
4360 if (VIM_ISDIGIT(*cmd))
4362 i = getdigits(&cmd);
4363 if (i <= 0 && !eap->skip && do_error)
4365 EMSG(_(e_zerocount));
4366 return;
4368 eap->line1 = eap->line2;
4369 eap->line2 += i - 1;
4370 if (eap->line2 > curbuf->b_ml.ml_line_count)
4371 eap->line2 = curbuf->b_ml.ml_line_count;
4375 * check for trailing command or garbage
4377 cmd = skipwhite(cmd);
4378 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4380 eap->nextcmd = check_nextcmd(cmd);
4381 if (eap->nextcmd == NULL)
4383 EMSG(_(e_trailing));
4384 return;
4388 if (eap->skip) /* not executing commands, only parsing */
4389 return;
4391 if (!do_count && !curbuf->b_p_ma)
4393 /* Substitution is not allowed in non-'modifiable' buffer */
4394 EMSG(_(e_modifiable));
4395 return;
4398 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4400 if (do_error)
4401 EMSG(_(e_invcmd));
4402 return;
4405 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4406 if (do_ic == 'i')
4407 regmatch.rmm_ic = TRUE;
4408 else if (do_ic == 'I')
4409 regmatch.rmm_ic = FALSE;
4411 sub_firstline = NULL;
4414 * ~ in the substitute pattern is replaced with the old pattern.
4415 * We do it here once to avoid it to be replaced over and over again.
4416 * But don't do it when it starts with "\=", then it's an expression.
4418 if (!(sub[0] == '\\' && sub[1] == '='))
4419 sub = regtilde(sub, p_magic);
4422 * Check for a match on each line.
4424 line2 = eap->line2;
4425 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4426 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4427 || aborting()
4428 #endif
4429 ); ++lnum)
4431 sub_firstlnum = lnum;
4432 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4433 if (nmatch)
4435 colnr_T copycol;
4436 colnr_T matchcol;
4437 colnr_T prev_matchcol = MAXCOL;
4438 char_u *new_end, *new_start = NULL;
4439 unsigned new_start_len = 0;
4440 char_u *p1;
4441 int did_sub = FALSE;
4442 int lastone;
4443 unsigned len, needed_len;
4444 long nmatch_tl = 0; /* nr of lines matched below lnum */
4445 int do_again; /* do it again after joining lines */
4446 int skip_match = FALSE;
4449 * The new text is build up step by step, to avoid too much
4450 * copying. There are these pieces:
4451 * sub_firstline The old text, unmodifed.
4452 * copycol Column in the old text where we started
4453 * looking for a match; from here old text still
4454 * needs to be copied to the new text.
4455 * matchcol Column number of the old text where to look
4456 * for the next match. It's just after the
4457 * previous match or one further.
4458 * prev_matchcol Column just after the previous match (if any).
4459 * Mostly equal to matchcol, except for the first
4460 * match and after skipping an empty match.
4461 * regmatch.*pos Where the pattern matched in the old text.
4462 * new_start The new text, all that has been produced so
4463 * far.
4464 * new_end The new text, where to append new text.
4466 * lnum The line number where we were looking for the
4467 * first match in the old line.
4468 * sub_firstlnum The line number in the buffer where to look
4469 * for a match. Can be different from "lnum"
4470 * when the pattern or substitute string contains
4471 * line breaks.
4473 * Special situations:
4474 * - When the substitute string contains a line break, the part up
4475 * to the line break is inserted in the text, but the copy of
4476 * the original line is kept. "sub_firstlnum" is adjusted for
4477 * the inserted lines.
4478 * - When the matched pattern contains a line break, the old line
4479 * is taken from the line at the end of the pattern. The lines
4480 * in the match are deleted later, "sub_firstlnum" is adjusted
4481 * accordingly.
4483 * The new text is built up in new_start[]. It has some extra
4484 * room to avoid using alloc()/free() too often. new_start_len is
4485 * the lenght of the allocated memory at new_start.
4487 * Make a copy of the old line, so it won't be taken away when
4488 * updating the screen or handling a multi-line match. The "old_"
4489 * pointers point into this copy.
4491 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4492 if (sub_firstline == NULL)
4494 vim_free(new_start);
4495 goto outofmem;
4497 copycol = 0;
4498 matchcol = 0;
4500 /* At first match, remember current cursor position. */
4501 if (!got_match)
4503 setpcmark();
4504 got_match = TRUE;
4508 * Loop until nothing more to replace in this line.
4509 * 1. Handle match with empty string.
4510 * 2. If do_ask is set, ask for confirmation.
4511 * 3. substitute the string.
4512 * 4. if do_all is set, find next match
4513 * 5. break if there isn't another match in this line
4515 for (;;)
4517 /* Save the line number of the last change for the final
4518 * cursor position (just like Vi). */
4519 curwin->w_cursor.lnum = lnum;
4520 do_again = FALSE;
4523 * 1. Match empty string does not count, except for first
4524 * match. This reproduces the strange vi behaviour.
4525 * This also catches endless loops.
4527 if (matchcol == prev_matchcol
4528 && regmatch.endpos[0].lnum == 0
4529 && matchcol == regmatch.endpos[0].col)
4531 if (sub_firstline[matchcol] == NUL)
4532 /* We already were at the end of the line. Don't look
4533 * for a match in this line again. */
4534 skip_match = TRUE;
4535 else
4536 ++matchcol; /* search for a match at next column */
4537 goto skip;
4540 /* Normally we continue searching for a match just after the
4541 * previous match. */
4542 matchcol = regmatch.endpos[0].col;
4543 prev_matchcol = matchcol;
4546 * 2. If do_count is set only increase the counter.
4547 * If do_ask is set, ask for confirmation.
4549 if (do_count)
4551 /* For a multi-line match, put matchcol at the NUL at
4552 * the end of the line and set nmatch to one, so that
4553 * we continue looking for a match on the next line.
4554 * Avoids that ":s/\nB\@=//gc" get stuck. */
4555 if (nmatch > 1)
4557 matchcol = (colnr_T)STRLEN(sub_firstline);
4558 nmatch = 1;
4560 sub_nsubs++;
4561 did_sub = TRUE;
4562 goto skip;
4565 if (do_ask)
4567 /* change State to CONFIRM, so that the mouse works
4568 * properly */
4569 save_State = State;
4570 State = CONFIRM;
4571 #ifdef FEAT_MOUSE
4572 setmouse(); /* disable mouse in xterm */
4573 #endif
4574 curwin->w_cursor.col = regmatch.startpos[0].col;
4576 /* When 'cpoptions' contains "u" don't sync undo when
4577 * asking for confirmation. */
4578 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4579 ++no_u_sync;
4582 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4584 while (do_ask)
4586 if (exmode_active)
4588 char_u *resp;
4589 colnr_T sc, ec;
4591 print_line_no_prefix(lnum, FALSE, FALSE);
4593 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4594 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4595 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4596 msg_start();
4597 for (i = 0; i < (long)sc; ++i)
4598 msg_putchar(' ');
4599 for ( ; i <= (long)ec; ++i)
4600 msg_putchar('^');
4602 resp = getexmodeline('?', NULL, 0);
4603 if (resp != NULL)
4605 i = *resp;
4606 vim_free(resp);
4609 else
4611 #ifdef FEAT_FOLDING
4612 int save_p_fen = curwin->w_p_fen;
4614 curwin->w_p_fen = FALSE;
4615 #endif
4616 /* Invert the matched string.
4617 * Remove the inversion afterwards. */
4618 temp = RedrawingDisabled;
4619 RedrawingDisabled = 0;
4621 search_match_lines = regmatch.endpos[0].lnum;
4622 search_match_endcol = regmatch.endpos[0].col;
4623 highlight_match = TRUE;
4625 update_topline();
4626 validate_cursor();
4627 update_screen(SOME_VALID);
4628 highlight_match = FALSE;
4629 redraw_later(SOME_VALID);
4631 #ifdef FEAT_FOLDING
4632 curwin->w_p_fen = save_p_fen;
4633 #endif
4634 if (msg_row == Rows - 1)
4635 msg_didout = FALSE; /* avoid a scroll-up */
4636 msg_starthere();
4637 i = msg_scroll;
4638 msg_scroll = 0; /* truncate msg when
4639 needed */
4640 msg_no_more = TRUE;
4641 /* write message same highlighting as for
4642 * wait_return */
4643 smsg_attr(hl_attr(HLF_R),
4644 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4645 msg_no_more = FALSE;
4646 msg_scroll = i;
4647 showruler(TRUE);
4648 windgoto(msg_row, msg_col);
4649 RedrawingDisabled = temp;
4651 #ifdef USE_ON_FLY_SCROLL
4652 dont_scroll = FALSE; /* allow scrolling here */
4653 #endif
4654 ++no_mapping; /* don't map this key */
4655 ++allow_keys; /* allow special keys */
4656 i = safe_vgetc();
4657 --allow_keys;
4658 --no_mapping;
4660 /* clear the question */
4661 msg_didout = FALSE; /* don't scroll up */
4662 msg_col = 0;
4663 gotocmdline(TRUE);
4666 need_wait_return = FALSE; /* no hit-return prompt */
4667 if (i == 'q' || i == ESC || i == Ctrl_C
4668 #ifdef UNIX
4669 || i == intr_char
4670 #endif
4673 got_quit = TRUE;
4674 break;
4676 if (i == 'n')
4677 break;
4678 if (i == 'y')
4679 break;
4680 if (i == 'l')
4682 /* last: replace and then stop */
4683 do_all = FALSE;
4684 line2 = lnum;
4685 break;
4687 if (i == 'a')
4689 do_ask = FALSE;
4690 break;
4692 #ifdef FEAT_INS_EXPAND
4693 if (i == Ctrl_E)
4694 scrollup_clamp();
4695 else if (i == Ctrl_Y)
4696 scrolldown_clamp();
4697 #endif
4699 State = save_State;
4700 #ifdef FEAT_MOUSE
4701 setmouse();
4702 #endif
4703 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4704 --no_u_sync;
4706 if (i == 'n')
4708 /* For a multi-line match, put matchcol at the NUL at
4709 * the end of the line and set nmatch to one, so that
4710 * we continue looking for a match on the next line.
4711 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4712 * get stuck when pressing 'n'. */
4713 if (nmatch > 1)
4715 matchcol = (colnr_T)STRLEN(sub_firstline);
4716 skip_match = TRUE;
4718 goto skip;
4720 if (got_quit)
4721 break;
4724 /* Move the cursor to the start of the match, so that we can
4725 * use "\=col("."). */
4726 curwin->w_cursor.col = regmatch.startpos[0].col;
4729 * 3. substitute the string.
4731 /* get length of substitution part */
4732 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4733 sub, sub_firstline, FALSE, p_magic, TRUE);
4735 /* When the match included the "$" of the last line it may
4736 * go beyond the last line of the buffer. */
4737 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4739 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4740 skip_match = TRUE;
4743 /* Need room for:
4744 * - result so far in new_start (not for first sub in line)
4745 * - original text up to match
4746 * - length of substituted part
4747 * - original text after match
4749 if (nmatch == 1)
4750 p1 = sub_firstline;
4751 else
4753 p1 = ml_get(sub_firstlnum + nmatch - 1);
4754 nmatch_tl += nmatch - 1;
4756 i = regmatch.startpos[0].col - copycol;
4757 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4758 + sublen + 1;
4759 if (new_start == NULL)
4762 * Get some space for a temporary buffer to do the
4763 * substitution into (and some extra space to avoid
4764 * too many calls to alloc()/free()).
4766 new_start_len = needed_len + 50;
4767 if ((new_start = alloc_check(new_start_len)) == NULL)
4768 goto outofmem;
4769 *new_start = NUL;
4770 new_end = new_start;
4772 else
4775 * Check if the temporary buffer is long enough to do the
4776 * substitution into. If not, make it larger (with a bit
4777 * extra to avoid too many calls to alloc()/free()).
4779 len = (unsigned)STRLEN(new_start);
4780 needed_len += len;
4781 if (needed_len > new_start_len)
4783 new_start_len = needed_len + 50;
4784 if ((p1 = alloc_check(new_start_len)) == NULL)
4786 vim_free(new_start);
4787 goto outofmem;
4789 mch_memmove(p1, new_start, (size_t)(len + 1));
4790 vim_free(new_start);
4791 new_start = p1;
4793 new_end = new_start + len;
4797 * copy the text up to the part that matched
4799 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4800 new_end += i;
4802 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4803 sub, new_end, TRUE, p_magic, TRUE);
4804 sub_nsubs++;
4805 did_sub = TRUE;
4807 /* Move the cursor to the start of the line, to avoid that it
4808 * is beyond the end of the line after the substitution. */
4809 curwin->w_cursor.col = 0;
4811 /* For a multi-line match, make a copy of the last matched
4812 * line and continue in that one. */
4813 if (nmatch > 1)
4815 sub_firstlnum += nmatch - 1;
4816 vim_free(sub_firstline);
4817 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4818 /* When going beyond the last line, stop substituting. */
4819 if (sub_firstlnum <= line2)
4820 do_again = TRUE;
4821 else
4822 do_all = FALSE;
4825 /* Remember next character to be copied. */
4826 copycol = regmatch.endpos[0].col;
4828 if (skip_match)
4830 /* Already hit end of the buffer, sub_firstlnum is one
4831 * less than what it ought to be. */
4832 vim_free(sub_firstline);
4833 sub_firstline = vim_strsave((char_u *)"");
4834 copycol = 0;
4838 * Now the trick is to replace CTRL-M chars with a real line
4839 * break. This would make it impossible to insert a CTRL-M in
4840 * the text. The line break can be avoided by preceding the
4841 * CTRL-M with a backslash. To be able to insert a backslash,
4842 * they must be doubled in the string and are halved here.
4843 * That is Vi compatible.
4845 for (p1 = new_end; *p1; ++p1)
4847 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4848 mch_memmove(p1, p1 + 1, STRLEN(p1));
4849 else if (*p1 == CAR)
4851 if (u_inssub(lnum) == OK) /* prepare for undo */
4853 *p1 = NUL; /* truncate up to the CR */
4854 ml_append(lnum - 1, new_start,
4855 (colnr_T)(p1 - new_start + 1), FALSE);
4856 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4857 if (do_ask)
4858 appended_lines(lnum - 1, 1L);
4859 else
4861 if (first_line == 0)
4862 first_line = lnum;
4863 last_line = lnum + 1;
4865 /* All line numbers increase. */
4866 ++sub_firstlnum;
4867 ++lnum;
4868 ++line2;
4869 /* move the cursor to the new line, like Vi */
4870 ++curwin->w_cursor.lnum;
4871 STRCPY(new_start, p1 + 1); /* copy the rest */
4872 p1 = new_start - 1;
4875 #ifdef FEAT_MBYTE
4876 else if (has_mbyte)
4877 p1 += (*mb_ptr2len)(p1) - 1;
4878 #endif
4882 * 4. If do_all is set, find next match.
4883 * Prevent endless loop with patterns that match empty
4884 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4885 * But ":s/\n/#/" is OK.
4887 skip:
4888 /* We already know that we did the last subst when we are at
4889 * the end of the line, except that a pattern like
4890 * "bar\|\nfoo" may match at the NUL. */
4891 lastone = (skip_match
4892 || got_int
4893 || got_quit
4894 || !(do_all || do_again)
4895 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4896 && !re_multiline(regmatch.regprog)));
4897 nmatch = -1;
4900 * Replace the line in the buffer when needed. This is
4901 * skipped when there are more matches.
4902 * The check for nmatch_tl is needed for when multi-line
4903 * matching must replace the lines before trying to do another
4904 * match, otherwise "\@<=" won't work.
4905 * When asking the user we like to show the already replaced
4906 * text, but don't do it when "\<@=" or "\<@!" is used, it
4907 * changes what matches.
4909 if (lastone
4910 || (do_ask && !re_lookbehind(regmatch.regprog))
4911 || nmatch_tl > 0
4912 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4913 curbuf, sub_firstlnum, matchcol)) == 0)
4915 if (new_start != NULL)
4918 * Copy the rest of the line, that didn't match.
4919 * "matchcol" has to be adjusted, we use the end of
4920 * the line as reference, because the substitute may
4921 * have changed the number of characters. Same for
4922 * "prev_matchcol".
4924 STRCAT(new_start, sub_firstline + copycol);
4925 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4926 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4927 - prev_matchcol;
4929 if (u_savesub(lnum) != OK)
4930 break;
4931 ml_replace(lnum, new_start, TRUE);
4933 if (nmatch_tl > 0)
4936 * Matched lines have now been substituted and are
4937 * useless, delete them. The part after the match
4938 * has been appended to new_start, we don't need
4939 * it in the buffer.
4941 ++lnum;
4942 if (u_savedel(lnum, nmatch_tl) != OK)
4943 break;
4944 for (i = 0; i < nmatch_tl; ++i)
4945 ml_delete(lnum, (int)FALSE);
4946 mark_adjust(lnum, lnum + nmatch_tl - 1,
4947 (long)MAXLNUM, -nmatch_tl);
4948 if (do_ask)
4949 deleted_lines(lnum, nmatch_tl);
4950 --lnum;
4951 line2 -= nmatch_tl; /* nr of lines decreases */
4952 nmatch_tl = 0;
4955 /* When asking, undo is saved each time, must also set
4956 * changed flag each time. */
4957 if (do_ask)
4958 changed_bytes(lnum, 0);
4959 else
4961 if (first_line == 0)
4962 first_line = lnum;
4963 last_line = lnum + 1;
4966 sub_firstlnum = lnum;
4967 vim_free(sub_firstline); /* free the temp buffer */
4968 sub_firstline = new_start;
4969 new_start = NULL;
4970 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4971 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4972 - prev_matchcol;
4973 copycol = 0;
4975 if (nmatch == -1 && !lastone)
4976 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4977 sub_firstlnum, matchcol);
4980 * 5. break if there isn't another match in this line
4982 if (nmatch <= 0)
4983 break;
4986 line_breakcheck();
4989 if (did_sub)
4990 ++sub_nlines;
4991 vim_free(sub_firstline); /* free the copy of the original line */
4992 sub_firstline = NULL;
4995 line_breakcheck();
4998 if (first_line != 0)
5000 /* Need to subtract the number of added lines from "last_line" to get
5001 * the line number before the change (same as adding the number of
5002 * deleted lines). */
5003 i = curbuf->b_ml.ml_line_count - old_line_count;
5004 changed_lines(first_line, 0, last_line - i, i);
5007 outofmem:
5008 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5010 /* ":s/pat//n" doesn't move the cursor */
5011 if (do_count)
5012 curwin->w_cursor = old_cursor;
5014 if (sub_nsubs)
5016 /* Set the '[ and '] marks. */
5017 curbuf->b_op_start.lnum = eap->line1;
5018 curbuf->b_op_end.lnum = line2;
5019 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5021 if (!global_busy)
5023 if (endcolumn)
5024 coladvance((colnr_T)MAXCOL);
5025 else
5026 beginline(BL_WHITE | BL_FIX);
5027 if (!do_sub_msg(do_count) && do_ask)
5028 MSG("");
5030 else
5031 global_need_beginline = TRUE;
5032 if (do_print)
5033 print_line(curwin->w_cursor.lnum, do_number, do_list);
5035 else if (!global_busy)
5037 if (got_int) /* interrupted */
5038 EMSG(_(e_interr));
5039 else if (got_match) /* did find something but nothing substituted */
5040 MSG("");
5041 else if (do_error) /* nothing found */
5042 EMSG2(_(e_patnotf2), get_search_pat());
5045 vim_free(regmatch.regprog);
5049 * Give message for number of substitutions.
5050 * Can also be used after a ":global" command.
5051 * Return TRUE if a message was given.
5054 do_sub_msg(count_only)
5055 int count_only; /* used 'n' flag for ":s" */
5057 int len = 0;
5060 * Only report substitutions when:
5061 * - more than 'report' substitutions
5062 * - command was typed by user, or number of changed lines > 'report'
5063 * - giving messages is not disabled by 'lazyredraw'
5065 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5066 || count_only)
5067 && messaging())
5069 if (got_int)
5071 STRCPY(msg_buf, _("(Interrupted) "));
5072 len = (int)STRLEN(msg_buf);
5074 if (sub_nsubs == 1)
5075 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5076 "%s", count_only ? _("1 match") : _("1 substitution"));
5077 else
5078 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5079 count_only ? _("%ld matches") : _("%ld substitutions"),
5080 sub_nsubs);
5081 len = (int)STRLEN(msg_buf);
5082 if (sub_nlines == 1)
5083 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5084 "%s", _(" on 1 line"));
5085 else
5086 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5087 _(" on %ld lines"), (long)sub_nlines);
5088 if (msg(msg_buf))
5089 /* save message to display it after redraw */
5090 set_keep_msg(msg_buf, 0);
5091 return TRUE;
5093 if (got_int)
5095 EMSG(_(e_interr));
5096 return TRUE;
5098 return FALSE;
5102 * Execute a global command of the form:
5104 * g/pattern/X : execute X on all lines where pattern matches
5105 * v/pattern/X : execute X on all lines where pattern does not match
5107 * where 'X' is an EX command
5109 * The command character (as well as the trailing slash) is optional, and
5110 * is assumed to be 'p' if missing.
5112 * This is implemented in two passes: first we scan the file for the pattern and
5113 * set a mark for each line that (not) matches. secondly we execute the command
5114 * for each line that has a mark. This is required because after deleting
5115 * lines we do not know where to search for the next match.
5117 void
5118 ex_global(eap)
5119 exarg_T *eap;
5121 linenr_T lnum; /* line number according to old situation */
5122 int ndone = 0;
5123 int type; /* first char of cmd: 'v' or 'g' */
5124 char_u *cmd; /* command argument */
5126 char_u delim; /* delimiter, normally '/' */
5127 char_u *pat;
5128 regmmatch_T regmatch;
5129 int match;
5130 int which_pat;
5132 if (global_busy)
5134 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5135 return;
5138 if (eap->forceit) /* ":global!" is like ":vglobal" */
5139 type = 'v';
5140 else
5141 type = *eap->cmd;
5142 cmd = eap->arg;
5143 which_pat = RE_LAST; /* default: use last used regexp */
5144 sub_nsubs = 0;
5145 sub_nlines = 0;
5148 * undocumented vi feature:
5149 * "\/" and "\?": use previous search pattern.
5150 * "\&": use previous substitute pattern.
5152 if (*cmd == '\\')
5154 ++cmd;
5155 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5157 EMSG(_(e_backslash));
5158 return;
5160 if (*cmd == '&')
5161 which_pat = RE_SUBST; /* use previous substitute pattern */
5162 else
5163 which_pat = RE_SEARCH; /* use previous search pattern */
5164 ++cmd;
5165 pat = (char_u *)"";
5167 else if (*cmd == NUL)
5169 EMSG(_("E148: Regular expression missing from global"));
5170 return;
5172 else
5174 delim = *cmd; /* get the delimiter */
5175 if (delim)
5176 ++cmd; /* skip delimiter if there is one */
5177 pat = cmd; /* remember start of pattern */
5178 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5179 if (cmd[0] == delim) /* end delimiter found */
5180 *cmd++ = NUL; /* replace it with a NUL */
5183 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5184 if (p_altkeymap && curwin->w_p_rl)
5185 lrFswap(pat,0);
5186 #endif
5188 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5190 EMSG(_(e_invcmd));
5191 return;
5195 * pass 1: set marks for each (not) matching line
5197 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5199 /* a match on this line? */
5200 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5201 if ((type == 'g' && match) || (type == 'v' && !match))
5203 ml_setmarked(lnum);
5204 ndone++;
5206 line_breakcheck();
5210 * pass 2: execute the command for each line that has been marked
5212 if (got_int)
5213 MSG(_(e_interr));
5214 else if (ndone == 0)
5216 if (type == 'v')
5217 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5218 else
5219 smsg((char_u *)_(e_patnotf2), pat);
5221 else
5222 global_exe(cmd);
5224 ml_clearmarked(); /* clear rest of the marks */
5225 vim_free(regmatch.regprog);
5229 * Execute "cmd" on lines marked with ml_setmarked().
5231 void
5232 global_exe(cmd)
5233 char_u *cmd;
5235 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5236 linenr_T lnum; /* line number according to old situation */
5239 * Set current position only once for a global command.
5240 * If global_busy is set, setpcmark() will not do anything.
5241 * If there is an error, global_busy will be incremented.
5243 setpcmark();
5245 /* When the command writes a message, don't overwrite the command. */
5246 msg_didout = TRUE;
5248 global_need_beginline = FALSE;
5249 global_busy = 1;
5250 old_lcount = curbuf->b_ml.ml_line_count;
5251 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5253 curwin->w_cursor.lnum = lnum;
5254 curwin->w_cursor.col = 0;
5255 if (*cmd == NUL || *cmd == '\n')
5256 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5257 else
5258 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5259 ui_breakcheck();
5262 global_busy = 0;
5263 if (global_need_beginline)
5264 beginline(BL_WHITE | BL_FIX);
5265 else
5266 check_cursor(); /* cursor may be beyond the end of the line */
5268 /* the cursor may not have moved in the text but a change in a previous
5269 * line may move it on the screen */
5270 changed_line_abv_curs();
5272 /* If it looks like no message was written, allow overwriting the
5273 * command with the report for number of changes. */
5274 if (msg_col == 0 && msg_scrolled == 0)
5275 msg_didout = FALSE;
5277 /* If substitutes done, report number of substitutes, otherwise report
5278 * number of extra or deleted lines. */
5279 if (!do_sub_msg(FALSE))
5280 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5283 #ifdef FEAT_VIMINFO
5285 read_viminfo_sub_string(virp, force)
5286 vir_T *virp;
5287 int force;
5289 if (old_sub != NULL && force)
5290 vim_free(old_sub);
5291 if (force || old_sub == NULL)
5292 old_sub = viminfo_readstring(virp, 1, TRUE);
5293 return viminfo_readline(virp);
5296 void
5297 write_viminfo_sub_string(fp)
5298 FILE *fp;
5300 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5302 fprintf(fp, _("\n# Last Substitute String:\n$"));
5303 viminfo_writestring(fp, old_sub);
5306 #endif /* FEAT_VIMINFO */
5308 #if defined(EXITFREE) || defined(PROTO)
5309 void
5310 free_old_sub()
5312 vim_free(old_sub);
5314 #endif
5316 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5318 * Set up for a tagpreview.
5319 * Return TRUE when it was created.
5322 prepare_tagpreview(undo_sync)
5323 int undo_sync; /* sync undo when leaving the window */
5325 win_T *wp;
5327 # ifdef FEAT_GUI
5328 need_mouse_correct = TRUE;
5329 # endif
5332 * If there is already a preview window open, use that one.
5334 if (!curwin->w_p_pvw)
5336 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5337 if (wp->w_p_pvw)
5338 break;
5339 if (wp != NULL)
5340 win_enter(wp, undo_sync);
5341 else
5344 * There is no preview window open yet. Create one.
5346 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5347 == FAIL)
5348 return FALSE;
5349 curwin->w_p_pvw = TRUE;
5350 curwin->w_p_wfh = TRUE;
5351 # ifdef FEAT_SCROLLBIND
5352 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5353 # endif
5354 # ifdef FEAT_DIFF
5355 curwin->w_p_diff = FALSE; /* no 'diff' */
5356 # endif
5357 # ifdef FEAT_FOLDING
5358 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5359 # endif
5360 return TRUE;
5363 return FALSE;
5366 #endif
5370 * ":help": open a read-only window on a help file
5372 void
5373 ex_help(eap)
5374 exarg_T *eap;
5376 char_u *arg;
5377 char_u *tag;
5378 FILE *helpfd; /* file descriptor of help file */
5379 int n;
5380 int i;
5381 #ifdef FEAT_WINDOWS
5382 win_T *wp;
5383 #endif
5384 int num_matches;
5385 char_u **matches;
5386 char_u *p;
5387 int empty_fnum = 0;
5388 int alt_fnum = 0;
5389 buf_T *buf;
5390 #ifdef FEAT_MULTI_LANG
5391 int len;
5392 char_u *lang;
5393 #endif
5395 if (eap != NULL)
5398 * A ":help" command ends at the first LF, or at a '|' that is
5399 * followed by some text. Set nextcmd to the following command.
5401 for (arg = eap->arg; *arg; ++arg)
5403 if (*arg == '\n' || *arg == '\r'
5404 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5406 *arg++ = NUL;
5407 eap->nextcmd = arg;
5408 break;
5411 arg = eap->arg;
5413 if (eap->forceit && *arg == NUL)
5415 EMSG(_("E478: Don't panic!"));
5416 return;
5419 if (eap->skip) /* not executing commands */
5420 return;
5422 else
5423 arg = (char_u *)"";
5425 /* remove trailing blanks */
5426 p = arg + STRLEN(arg) - 1;
5427 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5428 *p-- = NUL;
5430 #ifdef FEAT_MULTI_LANG
5431 /* Check for a specified language */
5432 lang = check_help_lang(arg);
5433 #endif
5435 /* When no argument given go to the index. */
5436 if (*arg == NUL)
5437 arg = (char_u *)"help.txt";
5440 * Check if there is a match for the argument.
5442 n = find_help_tags(arg, &num_matches, &matches,
5443 eap != NULL && eap->forceit);
5445 i = 0;
5446 #ifdef FEAT_MULTI_LANG
5447 if (n != FAIL && lang != NULL)
5448 /* Find first item with the requested language. */
5449 for (i = 0; i < num_matches; ++i)
5451 len = (int)STRLEN(matches[i]);
5452 if (len > 3 && matches[i][len - 3] == '@'
5453 && STRICMP(matches[i] + len - 2, lang) == 0)
5454 break;
5456 #endif
5457 if (i >= num_matches || n == FAIL)
5459 #ifdef FEAT_MULTI_LANG
5460 if (lang != NULL)
5461 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5462 else
5463 #endif
5464 EMSG2(_("E149: Sorry, no help for %s"), arg);
5465 if (n != FAIL)
5466 FreeWild(num_matches, matches);
5467 return;
5470 /* The first match (in the requested language) is the best match. */
5471 tag = vim_strsave(matches[i]);
5472 FreeWild(num_matches, matches);
5474 #ifdef FEAT_GUI
5475 need_mouse_correct = TRUE;
5476 #endif
5479 * Re-use an existing help window or open a new one.
5480 * Always open a new one for ":tab help".
5482 if (!curwin->w_buffer->b_help
5483 #ifdef FEAT_WINDOWS
5484 || cmdmod.tab != 0
5485 #endif
5488 #ifdef FEAT_WINDOWS
5489 if (cmdmod.tab != 0)
5490 wp = NULL;
5491 else
5492 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5493 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5494 break;
5495 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5496 win_enter(wp, TRUE);
5497 else
5498 #endif
5501 * There is no help window yet.
5502 * Try to open the file specified by the "helpfile" option.
5504 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5506 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5507 goto erret;
5509 fclose(helpfd);
5511 #ifdef FEAT_WINDOWS
5512 /* Split off help window; put it at far top if no position
5513 * specified, the current window is vertically split and
5514 * narrow. */
5515 n = WSP_HELP;
5516 # ifdef FEAT_VERTSPLIT
5517 if (cmdmod.split == 0 && curwin->w_width != Columns
5518 && curwin->w_width < 80)
5519 n |= WSP_TOP;
5520 # endif
5521 if (win_split(0, n) == FAIL)
5522 goto erret;
5523 #else
5524 /* use current window */
5525 if (!can_abandon(curbuf, FALSE))
5526 goto erret;
5527 #endif
5529 #ifdef FEAT_WINDOWS
5530 if (curwin->w_height < p_hh)
5531 win_setheight((int)p_hh);
5532 #endif
5535 * Open help file (do_ecmd() will set b_help flag, readfile() will
5536 * set b_p_ro flag).
5537 * Set the alternate file to the previously edited file.
5539 alt_fnum = curbuf->b_fnum;
5540 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5541 ECMD_HIDE + ECMD_SET_HELP);
5542 if (!cmdmod.keepalt)
5543 curwin->w_alt_fnum = alt_fnum;
5544 empty_fnum = curbuf->b_fnum;
5548 if (!p_im)
5549 restart_edit = 0; /* don't want insert mode in help file */
5551 if (tag != NULL)
5552 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5554 /* Delete the empty buffer if we're not using it. Careful: autocommands
5555 * may have jumped to another window, check that the buffer is not in a
5556 * window. */
5557 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5559 buf = buflist_findnr(empty_fnum);
5560 if (buf != NULL && buf->b_nwindows == 0)
5561 wipe_buffer(buf, TRUE);
5564 /* keep the previous alternate file */
5565 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5566 curwin->w_alt_fnum = alt_fnum;
5568 erret:
5569 vim_free(tag);
5573 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5575 * In an argument search for a language specifiers in the form "@xx".
5576 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5577 * Returns NULL if not found.
5579 char_u *
5580 check_help_lang(arg)
5581 char_u *arg;
5583 int len = (int)STRLEN(arg);
5585 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5586 && ASCII_ISALPHA(arg[len - 1]))
5588 arg[len - 3] = NUL; /* remove the '@' */
5589 return arg + len - 2;
5591 return NULL;
5593 #endif
5596 * Return a heuristic indicating how well the given string matches. The
5597 * smaller the number, the better the match. This is the order of priorities,
5598 * from best match to worst match:
5599 * - Match with least alpha-numeric characters is better.
5600 * - Match with least total characters is better.
5601 * - Match towards the start is better.
5602 * - Match starting with "+" is worse (feature instead of command)
5603 * Assumption is made that the matched_string passed has already been found to
5604 * match some string for which help is requested. webb.
5607 help_heuristic(matched_string, offset, wrong_case)
5608 char_u *matched_string;
5609 int offset; /* offset for match */
5610 int wrong_case; /* no matching case */
5612 int num_letters;
5613 char_u *p;
5615 num_letters = 0;
5616 for (p = matched_string; *p; p++)
5617 if (ASCII_ISALNUM(*p))
5618 num_letters++;
5621 * Multiply the number of letters by 100 to give it a much bigger
5622 * weighting than the number of characters.
5623 * If there only is a match while ignoring case, add 5000.
5624 * If the match starts in the middle of a word, add 10000 to put it
5625 * somewhere in the last half.
5626 * If the match is more than 2 chars from the start, multiply by 200 to
5627 * put it after matches at the start.
5629 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5630 && ASCII_ISALNUM(matched_string[offset - 1]))
5631 offset += 10000;
5632 else if (offset > 2)
5633 offset *= 200;
5634 if (wrong_case)
5635 offset += 5000;
5636 /* Features are less interesting than the subjects themselves, but "+"
5637 * alone is not a feature. */
5638 if (matched_string[0] == '+' && matched_string[1] != NUL)
5639 offset += 100;
5640 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5644 * Compare functions for qsort() below, that checks the help heuristics number
5645 * that has been put after the tagname by find_tags().
5647 static int
5648 #ifdef __BORLANDC__
5649 _RTLENTRYF
5650 #endif
5651 help_compare(s1, s2)
5652 const void *s1;
5653 const void *s2;
5655 char *p1;
5656 char *p2;
5658 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5659 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5660 return strcmp(p1, p2);
5664 * Find all help tags matching "arg", sort them and return in matches[], with
5665 * the number of matches in num_matches.
5666 * The matches will be sorted with a "best" match algorithm.
5667 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5670 find_help_tags(arg, num_matches, matches, keep_lang)
5671 char_u *arg;
5672 int *num_matches;
5673 char_u ***matches;
5674 int keep_lang;
5676 char_u *s, *d;
5677 int i;
5678 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5679 "/*", "/\\*", "\"*", "**",
5680 "/\\(\\)",
5681 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5682 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5683 "[count]", "[quotex]", "[range]",
5684 "[pattern]", "\\|", "\\%$"};
5685 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5686 "/star", "/\\\\star", "quotestar", "starstar",
5687 "/\\\\(\\\\)",
5688 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5689 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5690 "\\[count]", "\\[quotex]", "\\[range]",
5691 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5692 int flags;
5694 d = IObuff; /* assume IObuff is long enough! */
5697 * Recognize a few exceptions to the rule. Some strings that contain '*'
5698 * with "star". Otherwise '*' is recognized as a wildcard.
5700 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5701 if (STRCMP(arg, mtable[i]) == 0)
5703 STRCPY(d, rtable[i]);
5704 break;
5707 if (i < 0) /* no match in table */
5709 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5710 * Also replace "\%^" and "\%(", they match every tag too.
5711 * Also "\zs", "\z1", etc.
5712 * Also "\@<", "\@=", "\@<=", etc.
5713 * And also "\_$" and "\_^". */
5714 if (arg[0] == '\\'
5715 && ((arg[1] != NUL && arg[2] == NUL)
5716 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5717 && arg[2] != NUL)))
5719 STRCPY(d, "/\\\\");
5720 STRCPY(d + 3, arg + 1);
5721 /* Check for "/\\_$", should be "/\\_\$" */
5722 if (d[3] == '_' && d[4] == '$')
5723 STRCPY(d + 4, "\\$");
5725 else
5727 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5728 if (arg[0] == '[' && (arg[1] == ':'
5729 || (arg[1] == '+' && arg[2] == '+')))
5730 *d++ = '\\';
5732 for (s = arg; *s; ++s)
5735 * Replace "|" with "bar" and '"' with "quote" to match the name of
5736 * the tags for these commands.
5737 * Replace "*" with ".*" and "?" with "." to match command line
5738 * completion.
5739 * Insert a backslash before '~', '$' and '.' to avoid their
5740 * special meaning.
5742 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5743 break;
5744 switch (*s)
5746 case '|': STRCPY(d, "bar");
5747 d += 3;
5748 continue;
5749 case '"': STRCPY(d, "quote");
5750 d += 5;
5751 continue;
5752 case '*': *d++ = '.';
5753 break;
5754 case '?': *d++ = '.';
5755 continue;
5756 case '$':
5757 case '.':
5758 case '~': *d++ = '\\';
5759 break;
5763 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5764 * ":help i_^_CTRL-D" work.
5765 * Insert '-' before and after "CTRL-X" when applicable.
5767 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5768 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5770 if (d > IObuff && d[-1] != '_')
5771 *d++ = '_'; /* prepend a '_' */
5772 STRCPY(d, "CTRL-");
5773 d += 5;
5774 if (*s < ' ')
5776 #ifdef EBCDIC
5777 *d++ = CtrlChar(*s);
5778 #else
5779 *d++ = *s + '@';
5780 #endif
5781 if (d[-1] == '\\')
5782 *d++ = '\\'; /* double a backslash */
5784 else
5785 *d++ = *++s;
5786 if (s[1] != NUL && s[1] != '_')
5787 *d++ = '_'; /* append a '_' */
5788 continue;
5790 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5791 *d++ = '\\';
5794 * Insert a backslash before a backslash after a slash, for search
5795 * pattern tags: "/\|" --> "/\\|".
5797 else if (s[0] == '\\' && s[1] != '\\'
5798 && *arg == '/' && s == arg + 1)
5799 *d++ = '\\';
5801 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5802 * "CTRL-\_CTRL-N" */
5803 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5805 STRCPY(d, "CTRL-\\\\");
5806 d += 7;
5807 s += 6;
5810 *d++ = *s;
5813 * If tag starts with ', toss everything after a second '. Fixes
5814 * CTRL-] on 'option'. (would include the trailing '.').
5816 if (*s == '\'' && s > arg && *arg == '\'')
5817 break;
5819 *d = NUL;
5823 *matches = (char_u **)"";
5824 *num_matches = 0;
5825 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5826 if (keep_lang)
5827 flags |= TAG_KEEP_LANG;
5828 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5829 && *num_matches > 0)
5830 /* Sort the matches found on the heuristic number that is after the
5831 * tag name. */
5832 qsort((void *)*matches, (size_t)*num_matches,
5833 sizeof(char_u *), help_compare);
5834 return OK;
5838 * After reading a help file: May cleanup a help buffer when syntax
5839 * highlighting is not used.
5841 void
5842 fix_help_buffer()
5844 linenr_T lnum;
5845 char_u *line;
5846 int in_example = FALSE;
5847 int len;
5848 char_u *p;
5849 char_u *rt;
5850 int mustfree;
5852 /* set filetype to "help". */
5853 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5855 #ifdef FEAT_SYN_HL
5856 if (!syntax_present(curbuf))
5857 #endif
5859 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5861 line = ml_get_buf(curbuf, lnum, FALSE);
5862 len = (int)STRLEN(line);
5863 if (in_example && len > 0 && !vim_iswhite(line[0]))
5865 /* End of example: non-white or '<' in first column. */
5866 if (line[0] == '<')
5868 /* blank-out a '<' in the first column */
5869 line = ml_get_buf(curbuf, lnum, TRUE);
5870 line[0] = ' ';
5872 in_example = FALSE;
5874 if (!in_example && len > 0)
5876 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5878 /* blank-out a '>' in the last column (start of example) */
5879 line = ml_get_buf(curbuf, lnum, TRUE);
5880 line[len - 1] = ' ';
5881 in_example = TRUE;
5883 else if (line[len - 1] == '~')
5885 /* blank-out a '~' at the end of line (header marker) */
5886 line = ml_get_buf(curbuf, lnum, TRUE);
5887 line[len - 1] = ' ';
5894 * In the "help.txt" file, add the locally added help files.
5895 * This uses the very first line in the help file.
5897 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5899 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5901 line = ml_get_buf(curbuf, lnum, FALSE);
5902 if (strstr((char *)line, "*local-additions*") != NULL)
5904 /* Go through all directories in 'runtimepath', skipping
5905 * $VIMRUNTIME. */
5906 p = p_rtp;
5907 while (*p != NUL)
5909 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5910 mustfree = FALSE;
5911 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5912 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5914 int fcount;
5915 char_u **fnames;
5916 FILE *fd;
5917 char_u *s;
5918 int fi;
5919 #ifdef FEAT_MBYTE
5920 vimconv_T vc;
5921 char_u *cp;
5922 #endif
5924 /* Find all "doc/ *.txt" files in this directory. */
5925 add_pathsep(NameBuff);
5926 STRCAT(NameBuff, "doc/*.txt");
5927 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5928 &fnames, EW_FILE|EW_SILENT) == OK
5929 && fcount > 0)
5931 for (fi = 0; fi < fcount; ++fi)
5933 fd = mch_fopen((char *)fnames[fi], "r");
5934 if (fd != NULL)
5936 vim_fgets(IObuff, IOSIZE, fd);
5937 if (IObuff[0] == '*'
5938 && (s = vim_strchr(IObuff + 1, '*'))
5939 != NULL)
5941 #ifdef FEAT_MBYTE
5942 int this_utf = MAYBE;
5943 #endif
5944 /* Change tag definition to a
5945 * reference and remove <CR>/<NL>. */
5946 IObuff[0] = '|';
5947 *s = '|';
5948 while (*s != NUL)
5950 if (*s == '\r' || *s == '\n')
5951 *s = NUL;
5952 #ifdef FEAT_MBYTE
5953 /* The text is utf-8 when a byte
5954 * above 127 is found and no
5955 * illegal byte sequence is found.
5957 if (*s >= 0x80 && this_utf != FALSE)
5959 int l;
5961 this_utf = TRUE;
5962 l = utf_ptr2len(s);
5963 if (l == 1)
5964 this_utf = FALSE;
5965 s += l - 1;
5967 #endif
5968 ++s;
5970 #ifdef FEAT_MBYTE
5971 /* The help file is latin1 or utf-8;
5972 * conversion to the current
5973 * 'encoding' may be required. */
5974 vc.vc_type = CONV_NONE;
5975 convert_setup(&vc, (char_u *)(
5976 this_utf == TRUE ? "utf-8"
5977 : "latin1"), p_enc);
5978 if (vc.vc_type == CONV_NONE)
5979 /* No conversion needed. */
5980 cp = IObuff;
5981 else
5983 /* Do the conversion. If it fails
5984 * use the unconverted text. */
5985 cp = string_convert(&vc, IObuff,
5986 NULL);
5987 if (cp == NULL)
5988 cp = IObuff;
5990 convert_setup(&vc, NULL, NULL);
5992 ml_append(lnum, cp, (colnr_T)0, FALSE);
5993 if (cp != IObuff)
5994 vim_free(cp);
5995 #else
5996 ml_append(lnum, IObuff, (colnr_T)0,
5997 FALSE);
5998 #endif
5999 ++lnum;
6001 fclose(fd);
6004 FreeWild(fcount, fnames);
6007 if (mustfree)
6008 vim_free(rt);
6010 break;
6017 * ":exusage"
6019 /*ARGSUSED*/
6020 void
6021 ex_exusage(eap)
6022 exarg_T *eap;
6024 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6028 * ":viusage"
6030 /*ARGSUSED*/
6031 void
6032 ex_viusage(eap)
6033 exarg_T *eap;
6035 do_cmdline_cmd((char_u *)"help normal-index");
6038 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6039 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6042 * ":helptags"
6044 void
6045 ex_helptags(eap)
6046 exarg_T *eap;
6048 garray_T ga;
6049 int i, j;
6050 int len;
6051 #ifdef FEAT_MULTI_LANG
6052 char_u lang[2];
6053 #endif
6054 char_u ext[5];
6055 char_u fname[8];
6056 int filecount;
6057 char_u **files;
6059 if (!mch_isdir(eap->arg))
6061 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6062 return;
6065 #ifdef FEAT_MULTI_LANG
6066 /* Get a list of all files in the directory. */
6067 STRCPY(NameBuff, eap->arg);
6068 add_pathsep(NameBuff);
6069 STRCAT(NameBuff, "*");
6070 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6071 EW_FILE|EW_SILENT) == FAIL
6072 || filecount == 0)
6074 EMSG2("E151: No match: %s", NameBuff);
6075 return;
6078 /* Go over all files in the directory to find out what languages are
6079 * present. */
6080 ga_init2(&ga, 1, 10);
6081 for (i = 0; i < filecount; ++i)
6083 len = (int)STRLEN(files[i]);
6084 if (len > 4)
6086 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6088 /* ".txt" -> language "en" */
6089 lang[0] = 'e';
6090 lang[1] = 'n';
6092 else if (files[i][len - 4] == '.'
6093 && ASCII_ISALPHA(files[i][len - 3])
6094 && ASCII_ISALPHA(files[i][len - 2])
6095 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6097 /* ".abx" -> language "ab" */
6098 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6099 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6101 else
6102 continue;
6104 /* Did we find this language already? */
6105 for (j = 0; j < ga.ga_len; j += 2)
6106 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6107 break;
6108 if (j == ga.ga_len)
6110 /* New language, add it. */
6111 if (ga_grow(&ga, 2) == FAIL)
6112 break;
6113 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6114 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6120 * Loop over the found languages to generate a tags file for each one.
6122 for (j = 0; j < ga.ga_len; j += 2)
6124 STRCPY(fname, "tags-xx");
6125 fname[5] = ((char_u *)ga.ga_data)[j];
6126 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6127 if (fname[5] == 'e' && fname[6] == 'n')
6129 /* English is an exception: use ".txt" and "tags". */
6130 fname[4] = NUL;
6131 STRCPY(ext, ".txt");
6133 else
6135 /* Language "ab" uses ".abx" and "tags-ab". */
6136 STRCPY(ext, ".xxx");
6137 ext[1] = fname[5];
6138 ext[2] = fname[6];
6140 helptags_one(eap->arg, ext, fname);
6143 ga_clear(&ga);
6144 FreeWild(filecount, files);
6146 #else
6147 /* No language support, just use "*.txt" and "tags". */
6148 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6149 #endif
6152 static void
6153 helptags_one(dir, ext, tagfname)
6154 char_u *dir; /* doc directory */
6155 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6156 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6158 FILE *fd_tags;
6159 FILE *fd;
6160 garray_T ga;
6161 int filecount;
6162 char_u **files;
6163 char_u *p1, *p2;
6164 int fi;
6165 char_u *s;
6166 int i;
6167 char_u *fname;
6168 # ifdef FEAT_MBYTE
6169 int utf8 = MAYBE;
6170 int this_utf8;
6171 int firstline;
6172 int mix = FALSE; /* detected mixed encodings */
6173 # endif
6176 * Find all *.txt files.
6178 STRCPY(NameBuff, dir);
6179 add_pathsep(NameBuff);
6180 STRCAT(NameBuff, "*");
6181 STRCAT(NameBuff, ext);
6182 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6183 EW_FILE|EW_SILENT) == FAIL
6184 || filecount == 0)
6186 if (!got_int)
6187 EMSG2("E151: No match: %s", NameBuff);
6188 return;
6192 * Open the tags file for writing.
6193 * Do this before scanning through all the files.
6195 STRCPY(NameBuff, dir);
6196 add_pathsep(NameBuff);
6197 STRCAT(NameBuff, tagfname);
6198 fd_tags = mch_fopen((char *)NameBuff, "w");
6199 if (fd_tags == NULL)
6201 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6202 FreeWild(filecount, files);
6203 return;
6207 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6209 ga_init2(&ga, (int)sizeof(char_u *), 100);
6210 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6212 if (ga_grow(&ga, 1) == FAIL)
6213 got_int = TRUE;
6214 else
6216 s = alloc(18 + (unsigned)STRLEN(tagfname));
6217 if (s == NULL)
6218 got_int = TRUE;
6219 else
6221 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6222 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6223 ++ga.ga_len;
6229 * Go over all the files and extract the tags.
6231 for (fi = 0; fi < filecount && !got_int; ++fi)
6233 fd = mch_fopen((char *)files[fi], "r");
6234 if (fd == NULL)
6236 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6237 continue;
6239 fname = gettail(files[fi]);
6241 # ifdef FEAT_MBYTE
6242 firstline = TRUE;
6243 # endif
6244 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6246 # ifdef FEAT_MBYTE
6247 if (firstline)
6249 /* Detect utf-8 file by a non-ASCII char in the first line. */
6250 this_utf8 = MAYBE;
6251 for (s = IObuff; *s != NUL; ++s)
6252 if (*s >= 0x80)
6254 int l;
6256 this_utf8 = TRUE;
6257 l = utf_ptr2len(s);
6258 if (l == 1)
6260 /* Illegal UTF-8 byte sequence. */
6261 this_utf8 = FALSE;
6262 break;
6264 s += l - 1;
6266 if (this_utf8 == MAYBE) /* only ASCII characters found */
6267 this_utf8 = FALSE;
6268 if (utf8 == MAYBE) /* first file */
6269 utf8 = this_utf8;
6270 else if (utf8 != this_utf8)
6272 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6273 mix = !got_int;
6274 got_int = TRUE;
6276 firstline = FALSE;
6278 # endif
6279 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6280 while (p1 != NULL)
6282 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6283 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6285 for (s = p1 + 1; s < p2; ++s)
6286 if (*s == ' ' || *s == '\t' || *s == '|')
6287 break;
6290 * Only accept a *tag* when it consists of valid
6291 * characters, there is white space before it and is
6292 * followed by a white character or end-of-line.
6294 if (s == p2
6295 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6296 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6297 || s[1] == '\0'))
6299 *p2 = '\0';
6300 ++p1;
6301 if (ga_grow(&ga, 1) == FAIL)
6303 got_int = TRUE;
6304 break;
6306 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6307 if (s == NULL)
6309 got_int = TRUE;
6310 break;
6312 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6313 ++ga.ga_len;
6314 sprintf((char *)s, "%s\t%s", p1, fname);
6316 /* find next '*' */
6317 p2 = vim_strchr(p2 + 1, '*');
6320 p1 = p2;
6322 line_breakcheck();
6325 fclose(fd);
6328 FreeWild(filecount, files);
6330 if (!got_int)
6333 * Sort the tags.
6335 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6338 * Check for duplicates.
6340 for (i = 1; i < ga.ga_len; ++i)
6342 p1 = ((char_u **)ga.ga_data)[i - 1];
6343 p2 = ((char_u **)ga.ga_data)[i];
6344 while (*p1 == *p2)
6346 if (*p2 == '\t')
6348 *p2 = NUL;
6349 vim_snprintf((char *)NameBuff, MAXPATHL,
6350 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6351 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6352 EMSG(NameBuff);
6353 *p2 = '\t';
6354 break;
6356 ++p1;
6357 ++p2;
6361 # ifdef FEAT_MBYTE
6362 if (utf8 == TRUE)
6363 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6364 # endif
6367 * Write the tags into the file.
6369 for (i = 0; i < ga.ga_len; ++i)
6371 s = ((char_u **)ga.ga_data)[i];
6372 if (STRNCMP(s, "help-tags", 9) == 0)
6373 /* help-tags entry was added in formatted form */
6374 fprintf(fd_tags, (char *)s);
6375 else
6377 fprintf(fd_tags, "%s\t/*", s);
6378 for (p1 = s; *p1 != '\t'; ++p1)
6380 /* insert backslash before '\\' and '/' */
6381 if (*p1 == '\\' || *p1 == '/')
6382 putc('\\', fd_tags);
6383 putc(*p1, fd_tags);
6385 fprintf(fd_tags, "*\n");
6389 #ifdef FEAT_MBYTE
6390 if (mix)
6391 got_int = FALSE; /* continue with other languages */
6392 #endif
6394 for (i = 0; i < ga.ga_len; ++i)
6395 vim_free(((char_u **)ga.ga_data)[i]);
6396 ga_clear(&ga);
6397 fclose(fd_tags); /* there is no check for an error... */
6399 #endif
6401 #if defined(FEAT_SIGNS) || defined(PROTO)
6404 * Struct to hold the sign properties.
6406 typedef struct sign sign_T;
6408 struct sign
6410 sign_T *sn_next; /* next sign in list */
6411 int sn_typenr; /* type number of sign (negative if not equal
6412 to name) */
6413 char_u *sn_name; /* name of sign */
6414 char_u *sn_icon; /* name of pixmap */
6415 #ifdef FEAT_SIGN_ICONS
6416 void *sn_image; /* icon image */
6417 #endif
6418 char_u *sn_text; /* text used instead of pixmap */
6419 int sn_line_hl; /* highlight ID for line */
6420 int sn_text_hl; /* highlight ID for text */
6423 static sign_T *first_sign = NULL;
6424 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6426 static void sign_list_defined __ARGS((sign_T *sp));
6429 * ":sign" command
6431 void
6432 ex_sign(eap)
6433 exarg_T *eap;
6435 char_u *arg = eap->arg;
6436 char_u *p;
6437 int idx;
6438 sign_T *sp;
6439 sign_T *sp_prev;
6440 buf_T *buf;
6441 static char *cmds[] = {
6442 "define",
6443 #define SIGNCMD_DEFINE 0
6444 "undefine",
6445 #define SIGNCMD_UNDEFINE 1
6446 "list",
6447 #define SIGNCMD_LIST 2
6448 "place",
6449 #define SIGNCMD_PLACE 3
6450 "unplace",
6451 #define SIGNCMD_UNPLACE 4
6452 "jump",
6453 #define SIGNCMD_JUMP 5
6454 #define SIGNCMD_LAST 6
6457 /* Parse the subcommand. */
6458 p = skiptowhite(arg);
6459 if (*p != NUL)
6460 *p++ = NUL;
6461 for (idx = 0; ; ++idx)
6463 if (idx == SIGNCMD_LAST)
6465 EMSG2(_("E160: Unknown sign command: %s"), arg);
6466 return;
6468 if (STRCMP(arg, cmds[idx]) == 0)
6469 break;
6471 arg = skipwhite(p);
6473 if (idx <= SIGNCMD_LIST)
6476 * Define, undefine or list signs.
6478 if (idx == SIGNCMD_LIST && *arg == NUL)
6480 /* ":sign list": list all defined signs */
6481 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6482 sign_list_defined(sp);
6484 else if (*arg == NUL)
6485 EMSG(_("E156: Missing sign name"));
6486 else
6488 p = skiptowhite(arg);
6489 if (*p != NUL)
6490 *p++ = NUL;
6491 sp_prev = NULL;
6492 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6494 if (STRCMP(sp->sn_name, arg) == 0)
6495 break;
6496 sp_prev = sp;
6498 if (idx == SIGNCMD_DEFINE)
6500 /* ":sign define {name} ...": define a sign */
6501 if (sp == NULL)
6503 /* Allocate a new sign. */
6504 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6505 if (sp == NULL)
6506 return;
6507 if (sp_prev == NULL)
6508 first_sign = sp;
6509 else
6510 sp_prev->sn_next = sp;
6511 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6513 /* If the name is a number use that for the typenr,
6514 * otherwise use a negative number. */
6515 if (VIM_ISDIGIT(*arg))
6516 sp->sn_typenr = atoi((char *)arg);
6517 else
6519 sign_T *lp;
6520 int start = last_sign_typenr;
6522 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6524 if (lp->sn_typenr == last_sign_typenr)
6526 --last_sign_typenr;
6527 if (last_sign_typenr == 0)
6528 last_sign_typenr = MAX_TYPENR;
6529 if (last_sign_typenr == start)
6531 EMSG(_("E612: Too many signs defined"));
6532 return;
6534 lp = first_sign;
6535 continue;
6539 sp->sn_typenr = last_sign_typenr--;
6540 if (last_sign_typenr == 0)
6541 last_sign_typenr = MAX_TYPENR; /* wrap around */
6545 /* set values for a defined sign. */
6546 for (;;)
6548 arg = skipwhite(p);
6549 if (*arg == NUL)
6550 break;
6551 p = skiptowhite_esc(arg);
6552 if (STRNCMP(arg, "icon=", 5) == 0)
6554 arg += 5;
6555 vim_free(sp->sn_icon);
6556 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6557 backslash_halve(sp->sn_icon);
6558 #ifdef FEAT_SIGN_ICONS
6559 if (gui.in_use)
6561 out_flush();
6562 if (sp->sn_image != NULL)
6563 gui_mch_destroy_sign(sp->sn_image);
6564 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6566 #endif
6568 else if (STRNCMP(arg, "text=", 5) == 0)
6570 char_u *s;
6571 int cells;
6572 int len;
6574 arg += 5;
6575 #ifdef FEAT_MBYTE
6576 /* Count cells and check for non-printable chars */
6577 if (has_mbyte)
6579 cells = 0;
6580 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6582 if (!vim_isprintc((*mb_ptr2char)(s)))
6583 break;
6584 cells += (*mb_ptr2cells)(s);
6587 else
6588 #endif
6590 for (s = arg; s < p; ++s)
6591 if (!vim_isprintc(*s))
6592 break;
6593 cells = (int)(s - arg);
6595 /* Currently must be one or two display cells */
6596 if (s != p || cells < 1 || cells > 2)
6598 *p = NUL;
6599 EMSG2(_("E239: Invalid sign text: %s"), arg);
6600 return;
6603 vim_free(sp->sn_text);
6604 /* Allocate one byte more if we need to pad up
6605 * with a space. */
6606 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6607 sp->sn_text = vim_strnsave(arg, len);
6609 if (sp->sn_text != NULL && cells == 1)
6610 STRCPY(sp->sn_text + len - 1, " ");
6612 else if (STRNCMP(arg, "linehl=", 7) == 0)
6614 arg += 7;
6615 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6617 else if (STRNCMP(arg, "texthl=", 7) == 0)
6619 arg += 7;
6620 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6622 else
6624 EMSG2(_(e_invarg2), arg);
6625 return;
6629 else if (sp == NULL)
6630 EMSG2(_("E155: Unknown sign: %s"), arg);
6631 else if (idx == SIGNCMD_LIST)
6632 /* ":sign list {name}" */
6633 sign_list_defined(sp);
6634 else
6636 /* ":sign undefine {name}" */
6637 vim_free(sp->sn_name);
6638 vim_free(sp->sn_icon);
6639 #ifdef FEAT_SIGN_ICONS
6640 if (sp->sn_image != NULL)
6642 out_flush();
6643 gui_mch_destroy_sign(sp->sn_image);
6645 #endif
6646 vim_free(sp->sn_text);
6647 if (sp_prev == NULL)
6648 first_sign = sp->sn_next;
6649 else
6650 sp_prev->sn_next = sp->sn_next;
6651 vim_free(sp);
6655 else
6657 int id = -1;
6658 linenr_T lnum = -1;
6659 char_u *sign_name = NULL;
6660 char_u *arg1;
6662 if (*arg == NUL)
6664 if (idx == SIGNCMD_PLACE)
6666 /* ":sign place": list placed signs in all buffers */
6667 sign_list_placed(NULL);
6669 else if (idx == SIGNCMD_UNPLACE)
6671 /* ":sign unplace": remove placed sign at cursor */
6672 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6673 if (id > 0)
6675 buf_delsign(curwin->w_buffer, id);
6676 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6678 else
6679 EMSG(_("E159: Missing sign number"));
6681 else
6682 EMSG(_(e_argreq));
6683 return;
6686 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6688 /* ":sign unplace *": remove all placed signs */
6689 buf_delete_all_signs();
6690 return;
6693 /* first arg could be placed sign id */
6694 arg1 = arg;
6695 if (VIM_ISDIGIT(*arg))
6697 id = getdigits(&arg);
6698 if (!vim_iswhite(*arg) && *arg != NUL)
6700 id = -1;
6701 arg = arg1;
6703 else
6705 arg = skipwhite(arg);
6706 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6708 /* ":sign unplace {id}": remove placed sign by number */
6709 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6710 if ((lnum = buf_delsign(buf, id)) != 0)
6711 update_debug_sign(buf, lnum);
6712 return;
6718 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6719 * Leave "arg" pointing to {fname}.
6721 for (;;)
6723 if (STRNCMP(arg, "line=", 5) == 0)
6725 arg += 5;
6726 lnum = atoi((char *)arg);
6727 arg = skiptowhite(arg);
6729 else if (STRNCMP(arg, "name=", 5) == 0)
6731 arg += 5;
6732 sign_name = arg;
6733 arg = skiptowhite(arg);
6734 if (*arg != NUL)
6735 *arg++ = NUL;
6737 else if (STRNCMP(arg, "file=", 5) == 0)
6739 arg += 5;
6740 buf = buflist_findname(arg);
6741 break;
6743 else if (STRNCMP(arg, "buffer=", 7) == 0)
6745 arg += 7;
6746 buf = buflist_findnr((int)getdigits(&arg));
6747 if (*skipwhite(arg) != NUL)
6748 EMSG(_(e_trailing));
6749 break;
6751 else
6753 EMSG(_(e_invarg));
6754 return;
6756 arg = skipwhite(arg);
6759 if (buf == NULL)
6761 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6763 else if (id <= 0)
6765 if (lnum >= 0 || sign_name != NULL)
6766 EMSG(_(e_invarg));
6767 else
6768 /* ":sign place file={fname}": list placed signs in one file */
6769 sign_list_placed(buf);
6771 else if (idx == SIGNCMD_JUMP)
6773 /* ":sign jump {id} file={fname}" */
6774 if (lnum >= 0 || sign_name != NULL)
6775 EMSG(_(e_invarg));
6776 else if ((lnum = buf_findsign(buf, id)) > 0)
6777 { /* goto a sign ... */
6778 if (buf_jump_open_win(buf) != NULL)
6779 { /* ... in a current window */
6780 curwin->w_cursor.lnum = lnum;
6781 check_cursor_lnum();
6782 beginline(BL_WHITE);
6784 else
6785 { /* ... not currently in a window */
6786 char_u *cmd;
6788 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6789 if (cmd == NULL)
6790 return;
6791 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6792 do_cmdline_cmd(cmd);
6793 vim_free(cmd);
6795 #ifdef FEAT_FOLDING
6796 foldOpenCursor();
6797 #endif
6799 else
6800 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6802 else if (idx == SIGNCMD_UNPLACE)
6804 /* ":sign unplace {id} file={fname}" */
6805 if (lnum >= 0 || sign_name != NULL)
6806 EMSG(_(e_invarg));
6807 else
6809 lnum = buf_delsign(buf, id);
6810 update_debug_sign(buf, lnum);
6813 /* idx == SIGNCMD_PLACE */
6814 else if (sign_name != NULL)
6816 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6817 if (STRCMP(sp->sn_name, sign_name) == 0)
6818 break;
6819 if (sp == NULL)
6821 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6822 return;
6824 if (lnum > 0)
6825 /* ":sign place {id} line={lnum} name={name} file={fname}":
6826 * place a sign */
6827 buf_addsign(buf, id, lnum, sp->sn_typenr);
6828 else
6829 /* ":sign place {id} file={fname}": change sign type */
6830 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6831 update_debug_sign(buf, lnum);
6833 else
6834 EMSG(_(e_invarg));
6838 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6840 * Allocate the icons. Called when the GUI has started. Allows defining
6841 * signs before it starts.
6843 void
6844 sign_gui_started()
6846 sign_T *sp;
6848 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6849 if (sp->sn_icon != NULL)
6850 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6852 #endif
6855 * List one sign.
6857 static void
6858 sign_list_defined(sp)
6859 sign_T *sp;
6861 char_u *p;
6863 smsg((char_u *)"sign %s", sp->sn_name);
6864 if (sp->sn_icon != NULL)
6866 MSG_PUTS(" icon=");
6867 msg_outtrans(sp->sn_icon);
6868 #ifdef FEAT_SIGN_ICONS
6869 if (sp->sn_image == NULL)
6870 MSG_PUTS(_(" (NOT FOUND)"));
6871 #else
6872 MSG_PUTS(_(" (not supported)"));
6873 #endif
6875 if (sp->sn_text != NULL)
6877 MSG_PUTS(" text=");
6878 msg_outtrans(sp->sn_text);
6880 if (sp->sn_line_hl > 0)
6882 MSG_PUTS(" linehl=");
6883 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6884 if (p == NULL)
6885 MSG_PUTS("NONE");
6886 else
6887 msg_puts(p);
6889 if (sp->sn_text_hl > 0)
6891 MSG_PUTS(" texthl=");
6892 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6893 if (p == NULL)
6894 MSG_PUTS("NONE");
6895 else
6896 msg_puts(p);
6901 * Get highlighting attribute for sign "typenr".
6902 * If "line" is TRUE: line highl, if FALSE: text highl.
6905 sign_get_attr(typenr, line)
6906 int typenr;
6907 int line;
6909 sign_T *sp;
6911 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6912 if (sp->sn_typenr == typenr)
6914 if (line)
6916 if (sp->sn_line_hl > 0)
6917 return syn_id2attr(sp->sn_line_hl);
6919 else
6921 if (sp->sn_text_hl > 0)
6922 return syn_id2attr(sp->sn_text_hl);
6924 break;
6926 return 0;
6930 * Get text mark for sign "typenr".
6931 * Returns NULL if there isn't one.
6933 char_u *
6934 sign_get_text(typenr)
6935 int typenr;
6937 sign_T *sp;
6939 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6940 if (sp->sn_typenr == typenr)
6941 return sp->sn_text;
6942 return NULL;
6945 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6946 void *
6947 sign_get_image(typenr)
6948 int typenr; /* the attribute which may have a sign */
6950 sign_T *sp;
6952 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6953 if (sp->sn_typenr == typenr)
6954 return sp->sn_image;
6955 return NULL;
6957 #endif
6960 * Get the name of a sign by its typenr.
6962 char_u *
6963 sign_typenr2name(typenr)
6964 int typenr;
6966 sign_T *sp;
6968 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6969 if (sp->sn_typenr == typenr)
6970 return sp->sn_name;
6971 return (char_u *)_("[Deleted]");
6974 #endif
6976 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6978 * ":drop"
6979 * Opens the first argument in a window. When there are two or more arguments
6980 * the argument list is redefined.
6982 void
6983 ex_drop(eap)
6984 exarg_T *eap;
6986 int split = FALSE;
6987 win_T *wp;
6988 buf_T *buf;
6989 # ifdef FEAT_WINDOWS
6990 tabpage_T *tp;
6991 # endif
6994 * Check if the first argument is already being edited in a window. If
6995 * so, jump to that window.
6996 * We would actually need to check all arguments, but that's complicated
6997 * and mostly only one file is dropped.
6998 * This also ignores wildcards, since it is very unlikely the user is
6999 * editing a file name with a wildcard character.
7001 set_arglist(eap->arg);
7004 * Expanding wildcards may result in an empty argument list. E.g. when
7005 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7006 * already did an error message for this.
7008 if (ARGCOUNT == 0)
7009 return;
7011 # ifdef FEAT_WINDOWS
7012 if (cmdmod.tab)
7014 /* ":tab drop file ...": open a tab for each argument that isn't
7015 * edited in a window yet. It's like ":tab all" but without closing
7016 * windows or tabs. */
7017 ex_all(eap);
7019 else
7020 # endif
7022 /* ":drop file ...": Edit the first argument. Jump to an existing
7023 * window if possible, edit in current window if the current buffer
7024 * can be abandoned, otherwise open a new window. */
7025 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7027 FOR_ALL_TAB_WINDOWS(tp, wp)
7029 if (wp->w_buffer == buf)
7031 # ifdef FEAT_WINDOWS
7032 goto_tabpage_win(tp, wp);
7033 # endif
7034 curwin->w_arg_idx = 0;
7035 return;
7040 * Check whether the current buffer is changed. If so, we will need
7041 * to split the current window or data could be lost.
7042 * Skip the check if the 'hidden' option is set, as in this case the
7043 * buffer won't be lost.
7045 if (!P_HID(curbuf))
7047 # ifdef FEAT_WINDOWS
7048 ++emsg_off;
7049 # endif
7050 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7051 # ifdef FEAT_WINDOWS
7052 --emsg_off;
7053 # else
7054 if (split)
7055 return;
7056 # endif
7059 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7060 if (split)
7062 eap->cmdidx = CMD_sfirst;
7063 eap->cmd[0] = 's';
7065 else
7066 eap->cmdidx = CMD_first;
7067 ex_rewind(eap);
7070 #endif