Merge branch 'vim' into feat/code-check
[vim_extended.git] / src / misc1.c
blobc1ac28332dfcd3d32c22dd298df8943fe604b62e
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 * misc1.c: functions that didn't seem to fit elsewhere
14 #include "vim.h"
15 #include "version.h"
17 static char_u *vim_version_dir __ARGS((char_u *vimdir));
18 static char_u *remove_tail __ARGS((char_u *p, char_u *pend, char_u *name));
19 static int copy_indent __ARGS((int size, char_u *src));
22 * Count the size (in window cells) of the indent in the current line.
24 int
25 get_indent()
27 return get_indent_str(ml_get_curline(), (int)curbuf->b_p_ts);
31 * Count the size (in window cells) of the indent in line "lnum".
33 int
34 get_indent_lnum(lnum)
35 linenr_T lnum;
37 return get_indent_str(ml_get(lnum), (int)curbuf->b_p_ts);
40 #if defined(FEAT_FOLDING) || defined(PROTO)
42 * Count the size (in window cells) of the indent in line "lnum" of buffer
43 * "buf".
45 int
46 get_indent_buf(buf, lnum)
47 buf_T *buf;
48 linenr_T lnum;
50 return get_indent_str(ml_get_buf(buf, lnum, FALSE), (int)buf->b_p_ts);
52 #endif
55 * count the size (in window cells) of the indent in line "ptr", with
56 * 'tabstop' at "ts"
58 int
59 get_indent_str(ptr, ts)
60 char_u *ptr;
61 int ts;
63 int count = 0;
65 for ( ; *ptr; ++ptr)
67 if (*ptr == TAB) /* count a tab for what it is worth */
68 count += ts - (count % ts);
69 else if (*ptr == ' ')
70 ++count; /* count a space for one */
71 else
72 break;
74 return count;
78 * Set the indent of the current line.
79 * Leaves the cursor on the first non-blank in the line.
80 * Caller must take care of undo.
81 * "flags":
82 * SIN_CHANGED: call changed_bytes() if the line was changed.
83 * SIN_INSERT: insert the indent in front of the line.
84 * SIN_UNDO: save line for undo before changing it.
85 * Returns TRUE if the line was changed.
87 int
88 set_indent(size, flags)
89 int size; /* measured in spaces */
90 int flags;
92 char_u *p;
93 char_u *newline;
94 char_u *oldline;
95 char_u *s;
96 int todo;
97 int ind_len; /* measured in characters */
98 int line_len;
99 int doit = FALSE;
100 int ind_done = 0; /* measured in spaces */
101 int tab_pad;
102 int retval = FALSE;
103 int orig_char_len = -1; /* number of initial whitespace chars when
104 'et' and 'pi' are both set */
107 * First check if there is anything to do and compute the number of
108 * characters needed for the indent.
110 todo = size;
111 ind_len = 0;
112 p = oldline = ml_get_curline();
114 /* Calculate the buffer size for the new indent, and check to see if it
115 * isn't already set */
117 /* if 'expandtab' isn't set: use TABs; if both 'expandtab' and
118 * 'preserveindent' are set count the number of characters at the
119 * beginning of the line to be copied */
120 if (!curbuf->b_p_et || (!(flags & SIN_INSERT) && curbuf->b_p_pi))
122 /* If 'preserveindent' is set then reuse as much as possible of
123 * the existing indent structure for the new indent */
124 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
126 ind_done = 0;
128 /* count as many characters as we can use */
129 while (todo > 0 && vim_iswhite(*p))
131 if (*p == TAB)
133 tab_pad = (int)curbuf->b_p_ts
134 - (ind_done % (int)curbuf->b_p_ts);
135 /* stop if this tab will overshoot the target */
136 if (todo < tab_pad)
137 break;
138 todo -= tab_pad;
139 ++ind_len;
140 ind_done += tab_pad;
142 else
144 --todo;
145 ++ind_len;
146 ++ind_done;
148 ++p;
151 /* Set initial number of whitespace chars to copy if we are
152 * preserving indent but expandtab is set */
153 if (curbuf->b_p_et)
154 orig_char_len = ind_len;
156 /* Fill to next tabstop with a tab, if possible */
157 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
158 if (todo >= tab_pad && orig_char_len == -1)
160 doit = TRUE;
161 todo -= tab_pad;
162 ++ind_len;
163 /* ind_done += tab_pad; */
167 /* count tabs required for indent */
168 while (todo >= (int)curbuf->b_p_ts)
170 if (*p != TAB)
171 doit = TRUE;
172 else
173 ++p;
174 todo -= (int)curbuf->b_p_ts;
175 ++ind_len;
176 /* ind_done += (int)curbuf->b_p_ts; */
179 /* count spaces required for indent */
180 while (todo > 0)
182 if (*p != ' ')
183 doit = TRUE;
184 else
185 ++p;
186 --todo;
187 ++ind_len;
188 /* ++ind_done; */
191 /* Return if the indent is OK already. */
192 if (!doit && !vim_iswhite(*p) && !(flags & SIN_INSERT))
193 return FALSE;
195 /* Allocate memory for the new line. */
196 if (flags & SIN_INSERT)
197 p = oldline;
198 else
199 p = skipwhite(p);
200 line_len = (int)STRLEN(p) + 1;
202 /* If 'preserveindent' and 'expandtab' are both set keep the original
203 * characters and allocate accordingly. We will fill the rest with spaces
204 * after the if (!curbuf->b_p_et) below. */
205 if (orig_char_len != -1)
207 newline = alloc(orig_char_len + size - ind_done + line_len);
208 if (newline == NULL)
209 return FALSE;
210 todo = size - ind_done;
211 ind_len = orig_char_len + todo; /* Set total length of indent in
212 * characters, which may have been
213 * undercounted until now */
214 p = oldline;
215 s = newline;
216 while (orig_char_len > 0)
218 *s++ = *p++;
219 orig_char_len--;
222 /* Skip over any additional white space (useful when newindent is less
223 * than old) */
224 while (vim_iswhite(*p))
225 ++p;
228 else
230 todo = size;
231 newline = alloc(ind_len + line_len);
232 if (newline == NULL)
233 return FALSE;
234 s = newline;
237 /* Put the characters in the new line. */
238 /* if 'expandtab' isn't set: use TABs */
239 if (!curbuf->b_p_et)
241 /* If 'preserveindent' is set then reuse as much as possible of
242 * the existing indent structure for the new indent */
243 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
245 p = oldline;
246 ind_done = 0;
248 while (todo > 0 && vim_iswhite(*p))
250 if (*p == TAB)
252 tab_pad = (int)curbuf->b_p_ts
253 - (ind_done % (int)curbuf->b_p_ts);
254 /* stop if this tab will overshoot the target */
255 if (todo < tab_pad)
256 break;
257 todo -= tab_pad;
258 ind_done += tab_pad;
260 else
262 --todo;
263 ++ind_done;
265 *s++ = *p++;
268 /* Fill to next tabstop with a tab, if possible */
269 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
270 if (todo >= tab_pad)
272 *s++ = TAB;
273 todo -= tab_pad;
276 p = skipwhite(p);
279 while (todo >= (int)curbuf->b_p_ts)
281 *s++ = TAB;
282 todo -= (int)curbuf->b_p_ts;
285 while (todo > 0)
287 *s++ = ' ';
288 --todo;
290 mch_memmove(s, p, (size_t)line_len);
292 /* Replace the line (unless undo fails). */
293 if (!(flags & SIN_UNDO) || u_savesub(curwin->w_cursor.lnum) == OK)
295 ml_replace(curwin->w_cursor.lnum, newline, FALSE);
296 if (flags & SIN_CHANGED)
297 changed_bytes(curwin->w_cursor.lnum, 0);
298 /* Correct saved cursor position if it's after the indent. */
299 if (saved_cursor.lnum == curwin->w_cursor.lnum
300 && saved_cursor.col >= (colnr_T)(p - oldline))
301 saved_cursor.col += ind_len - (colnr_T)(p - oldline);
302 retval = TRUE;
304 else
305 vim_free(newline);
307 curwin->w_cursor.col = ind_len;
308 return retval;
312 * Copy the indent from ptr to the current line (and fill to size)
313 * Leaves the cursor on the first non-blank in the line.
314 * Returns TRUE if the line was changed.
316 static int
317 copy_indent(size, src)
318 int size;
319 char_u *src;
321 char_u *p = NULL;
322 char_u *line = NULL;
323 char_u *s;
324 int todo;
325 int ind_len;
326 int line_len = 0;
327 int tab_pad;
328 int ind_done;
329 int round;
331 /* Round 1: compute the number of characters needed for the indent
332 * Round 2: copy the characters. */
333 for (round = 1; round <= 2; ++round)
335 todo = size;
336 ind_len = 0;
337 ind_done = 0;
338 s = src;
340 /* Count/copy the usable portion of the source line */
341 while (todo > 0 && vim_iswhite(*s))
343 if (*s == TAB)
345 tab_pad = (int)curbuf->b_p_ts
346 - (ind_done % (int)curbuf->b_p_ts);
347 /* Stop if this tab will overshoot the target */
348 if (todo < tab_pad)
349 break;
350 todo -= tab_pad;
351 ind_done += tab_pad;
353 else
355 --todo;
356 ++ind_done;
358 ++ind_len;
359 if (p != NULL)
360 *p++ = *s;
361 ++s;
364 /* Fill to next tabstop with a tab, if possible */
365 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
366 if (todo >= tab_pad)
368 todo -= tab_pad;
369 ++ind_len;
370 if (p != NULL)
371 *p++ = TAB;
374 /* Add tabs required for indent */
375 while (todo >= (int)curbuf->b_p_ts)
377 todo -= (int)curbuf->b_p_ts;
378 ++ind_len;
379 if (p != NULL)
380 *p++ = TAB;
383 /* Count/add spaces required for indent */
384 while (todo > 0)
386 --todo;
387 ++ind_len;
388 if (p != NULL)
389 *p++ = ' ';
392 if (p == NULL)
394 /* Allocate memory for the result: the copied indent, new indent
395 * and the rest of the line. */
396 line_len = (int)STRLEN(ml_get_curline()) + 1;
397 line = alloc(ind_len + line_len);
398 if (line == NULL)
399 return FALSE;
400 p = line;
404 /* Append the original line */
405 mch_memmove(p, ml_get_curline(), (size_t)line_len);
407 /* Replace the line */
408 ml_replace(curwin->w_cursor.lnum, line, FALSE);
410 /* Put the cursor after the indent. */
411 curwin->w_cursor.col = ind_len;
412 return TRUE;
416 * Return the indent of the current line after a number. Return -1 if no
417 * number was found. Used for 'n' in 'formatoptions': numbered list.
418 * Since a pattern is used it can actually handle more than numbers.
421 get_number_indent(lnum)
422 linenr_T lnum;
424 colnr_T col;
425 pos_T pos;
426 regmmatch_T regmatch;
428 if (lnum > curbuf->b_ml.ml_line_count)
429 return -1;
430 pos.lnum = 0;
431 regmatch.regprog = vim_regcomp(curbuf->b_p_flp, RE_MAGIC);
432 if (regmatch.regprog != NULL)
434 regmatch.rmm_ic = FALSE;
435 regmatch.rmm_maxcol = 0;
436 if (vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
437 (colnr_T)0, NULL))
439 pos.lnum = regmatch.endpos[0].lnum + lnum;
440 pos.col = regmatch.endpos[0].col;
441 #ifdef FEAT_VIRTUALEDIT
442 pos.coladd = 0;
443 #endif
445 vim_free(regmatch.regprog);
448 if (pos.lnum == 0 || *ml_get_pos(&pos) == NUL)
449 return -1;
450 getvcol(curwin, &pos, &col, NULL, NULL);
451 return (int)col;
454 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
456 static int cin_is_cinword __ARGS((char_u *line));
459 * Return TRUE if the string "line" starts with a word from 'cinwords'.
461 static int
462 cin_is_cinword(line)
463 char_u *line;
465 char_u *cinw;
466 char_u *cinw_buf;
467 int cinw_len;
468 int retval = FALSE;
469 int len;
471 cinw_len = (int)STRLEN(curbuf->b_p_cinw) + 1;
472 cinw_buf = alloc((unsigned)cinw_len);
473 if (cinw_buf != NULL)
475 line = skipwhite(line);
476 for (cinw = curbuf->b_p_cinw; *cinw; )
478 len = copy_option_part(&cinw, cinw_buf, cinw_len, ",");
479 if (STRNCMP(line, cinw_buf, len) == 0
480 && (!vim_iswordc(line[len]) || !vim_iswordc(line[len - 1])))
482 retval = TRUE;
483 break;
486 vim_free(cinw_buf);
488 return retval;
490 #endif
493 * open_line: Add a new line below or above the current line.
495 * For VREPLACE mode, we only add a new line when we get to the end of the
496 * file, otherwise we just start replacing the next line.
498 * Caller must take care of undo. Since VREPLACE may affect any number of
499 * lines however, it may call u_save_cursor() again when starting to change a
500 * new line.
501 * "flags": OPENLINE_DELSPACES delete spaces after cursor
502 * OPENLINE_DO_COM format comments
503 * OPENLINE_KEEPTRAIL keep trailing spaces
504 * OPENLINE_MARKFIX adjust mark positions after the line break
506 * Return TRUE for success, FALSE for failure
509 open_line(dir, flags, old_indent)
510 int dir; /* FORWARD or BACKWARD */
511 int flags;
512 int old_indent; /* indent for after ^^D in Insert mode */
514 char_u *saved_line; /* copy of the original line */
515 char_u *next_line = NULL; /* copy of the next line */
516 char_u *p_extra = NULL; /* what goes to next line */
517 int less_cols = 0; /* less columns for mark in new line */
518 int less_cols_off = 0; /* columns to skip for mark adjust */
519 pos_T old_cursor; /* old cursor position */
520 int newcol = 0; /* new cursor column */
521 int newindent = 0; /* auto-indent of the new line */
522 int n;
523 int trunc_line = FALSE; /* truncate current line afterwards */
524 int retval = FALSE; /* return value, default is FAIL */
525 #ifdef FEAT_COMMENTS
526 int extra_len = 0; /* length of p_extra string */
527 int lead_len; /* length of comment leader */
528 char_u *lead_flags; /* position in 'comments' for comment leader */
529 char_u *leader = NULL; /* copy of comment leader */
530 #endif
531 char_u *allocated = NULL; /* allocated memory */
532 #if defined(FEAT_SMARTINDENT) || defined(FEAT_VREPLACE) || defined(FEAT_LISP) \
533 || defined(FEAT_CINDENT) || defined(FEAT_COMMENTS)
534 char_u *p;
535 #endif
536 int saved_char = NUL; /* init for GCC */
537 #if defined(FEAT_SMARTINDENT) || defined(FEAT_COMMENTS)
538 pos_T *pos;
539 #endif
540 #ifdef FEAT_SMARTINDENT
541 int do_si = (!p_paste && curbuf->b_p_si
542 # ifdef FEAT_CINDENT
543 && !curbuf->b_p_cin
544 # endif
546 int no_si = FALSE; /* reset did_si afterwards */
547 int first_char = NUL; /* init for GCC */
548 #endif
549 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
550 int vreplace_mode;
551 #endif
552 int did_append; /* appended a new line */
553 int saved_pi = curbuf->b_p_pi; /* copy of preserveindent setting */
556 * make a copy of the current line so we can mess with it
558 saved_line = vim_strsave(ml_get_curline());
559 if (saved_line == NULL) /* out of memory! */
560 return FALSE;
562 #ifdef FEAT_VREPLACE
563 if (State & VREPLACE_FLAG)
566 * With VREPLACE we make a copy of the next line, which we will be
567 * starting to replace. First make the new line empty and let vim play
568 * with the indenting and comment leader to its heart's content. Then
569 * we grab what it ended up putting on the new line, put back the
570 * original line, and call ins_char() to put each new character onto
571 * the line, replacing what was there before and pushing the right
572 * stuff onto the replace stack. -- webb.
574 if (curwin->w_cursor.lnum < orig_line_count)
575 next_line = vim_strsave(ml_get(curwin->w_cursor.lnum + 1));
576 else
577 next_line = vim_strsave((char_u *)"");
578 if (next_line == NULL) /* out of memory! */
579 goto theend;
582 * In VREPLACE mode, a NL replaces the rest of the line, and starts
583 * replacing the next line, so push all of the characters left on the
584 * line onto the replace stack. We'll push any other characters that
585 * might be replaced at the start of the next line (due to autoindent
586 * etc) a bit later.
588 replace_push(NUL); /* Call twice because BS over NL expects it */
589 replace_push(NUL);
590 p = saved_line + curwin->w_cursor.col;
591 while (*p != NUL)
593 #ifdef FEAT_MBYTE
594 if (has_mbyte)
595 p += replace_push_mb(p);
596 else
597 #endif
598 replace_push(*p++);
600 saved_line[curwin->w_cursor.col] = NUL;
602 #endif
604 if ((State & INSERT)
605 #ifdef FEAT_VREPLACE
606 && !(State & VREPLACE_FLAG)
607 #endif
610 p_extra = saved_line + curwin->w_cursor.col;
611 #ifdef FEAT_SMARTINDENT
612 if (do_si) /* need first char after new line break */
614 p = skipwhite(p_extra);
615 first_char = *p;
617 #endif
618 #ifdef FEAT_COMMENTS
619 extra_len = (int)STRLEN(p_extra);
620 #endif
621 saved_char = *p_extra;
622 *p_extra = NUL;
625 u_clearline(); /* cannot do "U" command when adding lines */
626 #ifdef FEAT_SMARTINDENT
627 did_si = FALSE;
628 #endif
629 ai_col = 0;
632 * If we just did an auto-indent, then we didn't type anything on
633 * the prior line, and it should be truncated. Do this even if 'ai' is not
634 * set because automatically inserting a comment leader also sets did_ai.
636 if (dir == FORWARD && did_ai)
637 trunc_line = TRUE;
640 * If 'autoindent' and/or 'smartindent' is set, try to figure out what
641 * indent to use for the new line.
643 if (curbuf->b_p_ai
644 #ifdef FEAT_SMARTINDENT
645 || do_si
646 #endif
650 * count white space on current line
652 newindent = get_indent_str(saved_line, (int)curbuf->b_p_ts);
653 if (newindent == 0)
654 newindent = old_indent; /* for ^^D command in insert mode */
656 #ifdef FEAT_SMARTINDENT
658 * Do smart indenting.
659 * In insert/replace mode (only when dir == FORWARD)
660 * we may move some text to the next line. If it starts with '{'
661 * don't add an indent. Fixes inserting a NL before '{' in line
662 * "if (condition) {"
664 if (!trunc_line && do_si && *saved_line != NUL
665 && (p_extra == NULL || first_char != '{'))
667 char_u *ptr;
668 char_u last_char;
670 old_cursor = curwin->w_cursor;
671 ptr = saved_line;
672 # ifdef FEAT_COMMENTS
673 if (flags & OPENLINE_DO_COM)
674 lead_len = get_leader_len(ptr, NULL, FALSE);
675 else
676 lead_len = 0;
677 # endif
678 if (dir == FORWARD)
681 * Skip preprocessor directives, unless they are
682 * recognised as comments.
684 if (
685 # ifdef FEAT_COMMENTS
686 lead_len == 0 &&
687 # endif
688 ptr[0] == '#')
690 while (ptr[0] == '#' && curwin->w_cursor.lnum > 1)
691 ptr = ml_get(--curwin->w_cursor.lnum);
692 newindent = get_indent();
694 # ifdef FEAT_COMMENTS
695 if (flags & OPENLINE_DO_COM)
696 lead_len = get_leader_len(ptr, NULL, FALSE);
697 else
698 lead_len = 0;
699 if (lead_len > 0)
702 * This case gets the following right:
703 * \*
704 * * A comment (read '\' as '/').
705 * *\
706 * #define IN_THE_WAY
707 * This should line up here;
709 p = skipwhite(ptr);
710 if (p[0] == '/' && p[1] == '*')
711 p++;
712 if (p[0] == '*')
714 for (p++; *p; p++)
716 if (p[0] == '/' && p[-1] == '*')
719 * End of C comment, indent should line up
720 * with the line containing the start of
721 * the comment
723 curwin->w_cursor.col = (colnr_T)(p - ptr);
724 if ((pos = findmatch(NULL, NUL)) != NULL)
726 curwin->w_cursor.lnum = pos->lnum;
727 newindent = get_indent();
733 else /* Not a comment line */
734 # endif
736 /* Find last non-blank in line */
737 p = ptr + STRLEN(ptr) - 1;
738 while (p > ptr && vim_iswhite(*p))
739 --p;
740 last_char = *p;
743 * find the character just before the '{' or ';'
745 if (last_char == '{' || last_char == ';')
747 if (p > ptr)
748 --p;
749 while (p > ptr && vim_iswhite(*p))
750 --p;
753 * Try to catch lines that are split over multiple
754 * lines. eg:
755 * if (condition &&
756 * condition) {
757 * Should line up here!
760 if (*p == ')')
762 curwin->w_cursor.col = (colnr_T)(p - ptr);
763 if ((pos = findmatch(NULL, '(')) != NULL)
765 curwin->w_cursor.lnum = pos->lnum;
766 newindent = get_indent();
767 ptr = ml_get_curline();
771 * If last character is '{' do indent, without
772 * checking for "if" and the like.
774 if (last_char == '{')
776 did_si = TRUE; /* do indent */
777 no_si = TRUE; /* don't delete it when '{' typed */
780 * Look for "if" and the like, use 'cinwords'.
781 * Don't do this if the previous line ended in ';' or
782 * '}'.
784 else if (last_char != ';' && last_char != '}'
785 && cin_is_cinword(ptr))
786 did_si = TRUE;
789 else /* dir == BACKWARD */
792 * Skip preprocessor directives, unless they are
793 * recognised as comments.
795 if (
796 # ifdef FEAT_COMMENTS
797 lead_len == 0 &&
798 # endif
799 ptr[0] == '#')
801 int was_backslashed = FALSE;
803 while ((ptr[0] == '#' || was_backslashed) &&
804 curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count)
806 if (*ptr && ptr[STRLEN(ptr) - 1] == '\\')
807 was_backslashed = TRUE;
808 else
809 was_backslashed = FALSE;
810 ptr = ml_get(++curwin->w_cursor.lnum);
812 if (was_backslashed)
813 newindent = 0; /* Got to end of file */
814 else
815 newindent = get_indent();
817 p = skipwhite(ptr);
818 if (*p == '}') /* if line starts with '}': do indent */
819 did_si = TRUE;
820 else /* can delete indent when '{' typed */
821 can_si_back = TRUE;
823 curwin->w_cursor = old_cursor;
825 if (do_si)
826 can_si = TRUE;
827 #endif /* FEAT_SMARTINDENT */
829 did_ai = TRUE;
832 #ifdef FEAT_COMMENTS
834 * Find out if the current line starts with a comment leader.
835 * This may then be inserted in front of the new line.
837 end_comment_pending = NUL;
838 if (flags & OPENLINE_DO_COM)
839 lead_len = get_leader_len(saved_line, &lead_flags, dir == BACKWARD);
840 else
841 lead_len = 0;
842 if (lead_len > 0)
844 char_u *lead_repl = NULL; /* replaces comment leader */
845 int lead_repl_len = 0; /* length of *lead_repl */
846 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
847 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
848 char_u *comment_end = NULL; /* where lead_end has been found */
849 int extra_space = FALSE; /* append extra space */
850 int current_flag;
851 int require_blank = FALSE; /* requires blank after middle */
852 char_u *p2;
855 * If the comment leader has the start, middle or end flag, it may not
856 * be used or may be replaced with the middle leader.
858 for (p = lead_flags; *p && *p != ':'; ++p)
860 if (*p == COM_BLANK)
862 require_blank = TRUE;
863 continue;
865 if (*p == COM_START || *p == COM_MIDDLE)
867 current_flag = *p;
868 if (*p == COM_START)
871 * Doing "O" on a start of comment does not insert leader.
873 if (dir == BACKWARD)
875 lead_len = 0;
876 break;
879 /* find start of middle part */
880 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
881 require_blank = FALSE;
885 * Isolate the strings of the middle and end leader.
887 while (*p && p[-1] != ':') /* find end of middle flags */
889 if (*p == COM_BLANK)
890 require_blank = TRUE;
891 ++p;
893 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
895 while (*p && p[-1] != ':') /* find end of end flags */
897 /* Check whether we allow automatic ending of comments */
898 if (*p == COM_AUTO_END)
899 end_comment_pending = -1; /* means we want to set it */
900 ++p;
902 n = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
904 if (end_comment_pending == -1) /* we can set it now */
905 end_comment_pending = lead_end[n - 1];
908 * If the end of the comment is in the same line, don't use
909 * the comment leader.
911 if (dir == FORWARD)
913 for (p = saved_line + lead_len; *p; ++p)
914 if (STRNCMP(p, lead_end, n) == 0)
916 comment_end = p;
917 lead_len = 0;
918 break;
923 * Doing "o" on a start of comment inserts the middle leader.
925 if (lead_len > 0)
927 if (current_flag == COM_START)
929 lead_repl = lead_middle;
930 lead_repl_len = (int)STRLEN(lead_middle);
934 * If we have hit RETURN immediately after the start
935 * comment leader, then put a space after the middle
936 * comment leader on the next line.
938 if (!vim_iswhite(saved_line[lead_len - 1])
939 && ((p_extra != NULL
940 && (int)curwin->w_cursor.col == lead_len)
941 || (p_extra == NULL
942 && saved_line[lead_len] == NUL)
943 || require_blank))
944 extra_space = TRUE;
946 break;
948 if (*p == COM_END)
951 * Doing "o" on the end of a comment does not insert leader.
952 * Remember where the end is, might want to use it to find the
953 * start (for C-comments).
955 if (dir == FORWARD)
957 comment_end = skipwhite(saved_line);
958 lead_len = 0;
959 break;
963 * Doing "O" on the end of a comment inserts the middle leader.
964 * Find the string for the middle leader, searching backwards.
966 while (p > curbuf->b_p_com && *p != ',')
967 --p;
968 for (lead_repl = p; lead_repl > curbuf->b_p_com
969 && lead_repl[-1] != ':'; --lead_repl)
971 lead_repl_len = (int)(p - lead_repl);
973 /* We can probably always add an extra space when doing "O" on
974 * the comment-end */
975 extra_space = TRUE;
977 /* Check whether we allow automatic ending of comments */
978 for (p2 = p; *p2 && *p2 != ':'; p2++)
980 if (*p2 == COM_AUTO_END)
981 end_comment_pending = -1; /* means we want to set it */
983 if (end_comment_pending == -1)
985 /* Find last character in end-comment string */
986 while (*p2 && *p2 != ',')
987 p2++;
988 end_comment_pending = p2[-1];
990 break;
992 if (*p == COM_FIRST)
995 * Comment leader for first line only: Don't repeat leader
996 * when using "O", blank out leader when using "o".
998 if (dir == BACKWARD)
999 lead_len = 0;
1000 else
1002 lead_repl = (char_u *)"";
1003 lead_repl_len = 0;
1005 break;
1008 if (lead_len)
1010 /* allocate buffer (may concatenate p_exta later) */
1011 leader = alloc(lead_len + lead_repl_len + extra_space +
1012 extra_len + 1);
1013 allocated = leader; /* remember to free it later */
1015 if (leader == NULL)
1016 lead_len = 0;
1017 else
1019 vim_strncpy(leader, saved_line, lead_len);
1022 * Replace leader with lead_repl, right or left adjusted
1024 if (lead_repl != NULL)
1026 int c = 0;
1027 int off = 0;
1029 for (p = lead_flags; *p != NUL && *p != ':'; )
1031 if (*p == COM_RIGHT || *p == COM_LEFT)
1032 c = *p++;
1033 else if (VIM_ISDIGIT(*p) || *p == '-')
1034 off = getdigits(&p);
1035 else
1036 ++p;
1038 if (c == COM_RIGHT) /* right adjusted leader */
1040 /* find last non-white in the leader to line up with */
1041 for (p = leader + lead_len - 1; p > leader
1042 && vim_iswhite(*p); --p)
1044 ++p;
1046 #ifdef FEAT_MBYTE
1047 /* Compute the length of the replaced characters in
1048 * screen characters, not bytes. */
1050 int repl_size = vim_strnsize(lead_repl,
1051 lead_repl_len);
1052 int old_size = 0;
1053 char_u *endp = p;
1054 int l;
1056 while (old_size < repl_size && p > leader)
1058 mb_ptr_back(leader, p);
1059 old_size += ptr2cells(p);
1061 l = lead_repl_len - (int)(endp - p);
1062 if (l != 0)
1063 mch_memmove(endp + l, endp,
1064 (size_t)((leader + lead_len) - endp));
1065 lead_len += l;
1067 #else
1068 if (p < leader + lead_repl_len)
1069 p = leader;
1070 else
1071 p -= lead_repl_len;
1072 #endif
1073 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1074 if (p + lead_repl_len > leader + lead_len)
1075 p[lead_repl_len] = NUL;
1077 /* blank-out any other chars from the old leader. */
1078 while (--p >= leader)
1080 #ifdef FEAT_MBYTE
1081 int l = mb_head_off(leader, p);
1083 if (l > 1)
1085 p -= l;
1086 if (ptr2cells(p) > 1)
1088 p[1] = ' ';
1089 --l;
1091 mch_memmove(p + 1, p + l + 1,
1092 (size_t)((leader + lead_len) - (p + l + 1)));
1093 lead_len -= l;
1094 *p = ' ';
1096 else
1097 #endif
1098 if (!vim_iswhite(*p))
1099 *p = ' ';
1102 else /* left adjusted leader */
1104 p = skipwhite(leader);
1105 #ifdef FEAT_MBYTE
1106 /* Compute the length of the replaced characters in
1107 * screen characters, not bytes. Move the part that is
1108 * not to be overwritten. */
1110 int repl_size = vim_strnsize(lead_repl,
1111 lead_repl_len);
1112 int i;
1113 int l;
1115 for (i = 0; p[i] != NUL && i < lead_len; i += l)
1117 l = (*mb_ptr2len)(p + i);
1118 if (vim_strnsize(p, i + l) > repl_size)
1119 break;
1121 if (i != lead_repl_len)
1123 mch_memmove(p + lead_repl_len, p + i,
1124 (size_t)(lead_len - i - (p - leader)));
1125 lead_len += lead_repl_len - i;
1128 #endif
1129 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1131 /* Replace any remaining non-white chars in the old
1132 * leader by spaces. Keep Tabs, the indent must
1133 * remain the same. */
1134 for (p += lead_repl_len; p < leader + lead_len; ++p)
1135 if (!vim_iswhite(*p))
1137 /* Don't put a space before a TAB. */
1138 if (p + 1 < leader + lead_len && p[1] == TAB)
1140 --lead_len;
1141 mch_memmove(p, p + 1,
1142 (leader + lead_len) - p);
1144 else
1146 #ifdef FEAT_MBYTE
1147 int l = (*mb_ptr2len)(p);
1149 if (l > 1)
1151 if (ptr2cells(p) > 1)
1153 /* Replace a double-wide char with
1154 * two spaces */
1155 --l;
1156 *p++ = ' ';
1158 mch_memmove(p + 1, p + l,
1159 (leader + lead_len) - p);
1160 lead_len -= l - 1;
1162 #endif
1163 *p = ' ';
1166 *p = NUL;
1169 /* Recompute the indent, it may have changed. */
1170 if (curbuf->b_p_ai
1171 #ifdef FEAT_SMARTINDENT
1172 || do_si
1173 #endif
1175 newindent = get_indent_str(leader, (int)curbuf->b_p_ts);
1177 /* Add the indent offset */
1178 if (newindent + off < 0)
1180 off = -newindent;
1181 newindent = 0;
1183 else
1184 newindent += off;
1186 /* Correct trailing spaces for the shift, so that
1187 * alignment remains equal. */
1188 while (off > 0 && lead_len > 0
1189 && leader[lead_len - 1] == ' ')
1191 /* Don't do it when there is a tab before the space */
1192 if (vim_strchr(skipwhite(leader), '\t') != NULL)
1193 break;
1194 --lead_len;
1195 --off;
1198 /* If the leader ends in white space, don't add an
1199 * extra space */
1200 if (lead_len > 0 && vim_iswhite(leader[lead_len - 1]))
1201 extra_space = FALSE;
1202 leader[lead_len] = NUL;
1205 if (extra_space)
1207 leader[lead_len++] = ' ';
1208 leader[lead_len] = NUL;
1211 newcol = lead_len;
1214 * if a new indent will be set below, remove the indent that
1215 * is in the comment leader
1217 if (newindent
1218 #ifdef FEAT_SMARTINDENT
1219 || did_si
1220 #endif
1223 while (lead_len && vim_iswhite(*leader))
1225 --lead_len;
1226 --newcol;
1227 ++leader;
1232 #ifdef FEAT_SMARTINDENT
1233 did_si = can_si = FALSE;
1234 #endif
1236 else if (comment_end != NULL)
1239 * We have finished a comment, so we don't use the leader.
1240 * If this was a C-comment and 'ai' or 'si' is set do a normal
1241 * indent to align with the line containing the start of the
1242 * comment.
1244 if (comment_end[0] == '*' && comment_end[1] == '/' &&
1245 (curbuf->b_p_ai
1246 #ifdef FEAT_SMARTINDENT
1247 || do_si
1248 #endif
1251 old_cursor = curwin->w_cursor;
1252 curwin->w_cursor.col = (colnr_T)(comment_end - saved_line);
1253 if ((pos = findmatch(NULL, NUL)) != NULL)
1255 curwin->w_cursor.lnum = pos->lnum;
1256 newindent = get_indent();
1258 curwin->w_cursor = old_cursor;
1262 #endif
1264 /* (State == INSERT || State == REPLACE), only when dir == FORWARD */
1265 if (p_extra != NULL)
1267 *p_extra = saved_char; /* restore char that NUL replaced */
1270 * When 'ai' set or "flags" has OPENLINE_DELSPACES, skip to the first
1271 * non-blank.
1273 * When in REPLACE mode, put the deleted blanks on the replace stack,
1274 * preceded by a NUL, so they can be put back when a BS is entered.
1276 if (REPLACE_NORMAL(State))
1277 replace_push(NUL); /* end of extra blanks */
1278 if (curbuf->b_p_ai || (flags & OPENLINE_DELSPACES))
1280 while ((*p_extra == ' ' || *p_extra == '\t')
1281 #ifdef FEAT_MBYTE
1282 && (!enc_utf8
1283 || !utf_iscomposing(utf_ptr2char(p_extra + 1)))
1284 #endif
1287 if (REPLACE_NORMAL(State))
1288 replace_push(*p_extra);
1289 ++p_extra;
1290 ++less_cols_off;
1293 if (*p_extra != NUL)
1294 did_ai = FALSE; /* append some text, don't truncate now */
1296 /* columns for marks adjusted for removed columns */
1297 less_cols = (int)(p_extra - saved_line);
1300 if (p_extra == NULL)
1301 p_extra = (char_u *)""; /* append empty line */
1303 #ifdef FEAT_COMMENTS
1304 /* concatenate leader and p_extra, if there is a leader */
1305 if (lead_len)
1307 STRCAT(leader, p_extra);
1308 p_extra = leader;
1309 did_ai = TRUE; /* So truncating blanks works with comments */
1310 less_cols -= lead_len;
1312 else
1313 end_comment_pending = NUL; /* turns out there was no leader */
1314 #endif
1316 old_cursor = curwin->w_cursor;
1317 if (dir == BACKWARD)
1318 --curwin->w_cursor.lnum;
1319 #ifdef FEAT_VREPLACE
1320 if (!(State & VREPLACE_FLAG) || old_cursor.lnum >= orig_line_count)
1321 #endif
1323 if (ml_append(curwin->w_cursor.lnum, p_extra, (colnr_T)0, FALSE)
1324 == FAIL)
1325 goto theend;
1326 /* Postpone calling changed_lines(), because it would mess up folding
1327 * with markers. */
1328 mark_adjust(curwin->w_cursor.lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
1329 did_append = TRUE;
1331 #ifdef FEAT_VREPLACE
1332 else
1335 * In VREPLACE mode we are starting to replace the next line.
1337 curwin->w_cursor.lnum++;
1338 if (curwin->w_cursor.lnum >= Insstart.lnum + vr_lines_changed)
1340 /* In case we NL to a new line, BS to the previous one, and NL
1341 * again, we don't want to save the new line for undo twice.
1343 (void)u_save_cursor(); /* errors are ignored! */
1344 vr_lines_changed++;
1346 ml_replace(curwin->w_cursor.lnum, p_extra, TRUE);
1347 changed_bytes(curwin->w_cursor.lnum, 0);
1348 curwin->w_cursor.lnum--;
1349 did_append = FALSE;
1351 #endif
1353 if (newindent
1354 #ifdef FEAT_SMARTINDENT
1355 || did_si
1356 #endif
1359 ++curwin->w_cursor.lnum;
1360 #ifdef FEAT_SMARTINDENT
1361 if (did_si)
1363 if (p_sr)
1364 newindent -= newindent % (int)curbuf->b_p_sw;
1365 newindent += (int)curbuf->b_p_sw;
1367 #endif
1368 /* Copy the indent */
1369 if (curbuf->b_p_ci)
1371 (void)copy_indent(newindent, saved_line);
1374 * Set the 'preserveindent' option so that any further screwing
1375 * with the line doesn't entirely destroy our efforts to preserve
1376 * it. It gets restored at the function end.
1378 curbuf->b_p_pi = TRUE;
1380 else
1381 (void)set_indent(newindent, SIN_INSERT);
1382 less_cols -= curwin->w_cursor.col;
1384 ai_col = curwin->w_cursor.col;
1387 * In REPLACE mode, for each character in the new indent, there must
1388 * be a NUL on the replace stack, for when it is deleted with BS
1390 if (REPLACE_NORMAL(State))
1391 for (n = 0; n < (int)curwin->w_cursor.col; ++n)
1392 replace_push(NUL);
1393 newcol += curwin->w_cursor.col;
1394 #ifdef FEAT_SMARTINDENT
1395 if (no_si)
1396 did_si = FALSE;
1397 #endif
1400 #ifdef FEAT_COMMENTS
1402 * In REPLACE mode, for each character in the extra leader, there must be
1403 * a NUL on the replace stack, for when it is deleted with BS.
1405 if (REPLACE_NORMAL(State))
1406 while (lead_len-- > 0)
1407 replace_push(NUL);
1408 #endif
1410 curwin->w_cursor = old_cursor;
1412 if (dir == FORWARD)
1414 if (trunc_line || (State & INSERT))
1416 /* truncate current line at cursor */
1417 saved_line[curwin->w_cursor.col] = NUL;
1418 /* Remove trailing white space, unless OPENLINE_KEEPTRAIL used. */
1419 if (trunc_line && !(flags & OPENLINE_KEEPTRAIL))
1420 truncate_spaces(saved_line);
1421 ml_replace(curwin->w_cursor.lnum, saved_line, FALSE);
1422 saved_line = NULL;
1423 if (did_append)
1425 changed_lines(curwin->w_cursor.lnum, curwin->w_cursor.col,
1426 curwin->w_cursor.lnum + 1, 1L);
1427 did_append = FALSE;
1429 /* Move marks after the line break to the new line. */
1430 if (flags & OPENLINE_MARKFIX)
1431 mark_col_adjust(curwin->w_cursor.lnum,
1432 curwin->w_cursor.col + less_cols_off,
1433 1L, (long)-less_cols);
1435 else
1436 changed_bytes(curwin->w_cursor.lnum, curwin->w_cursor.col);
1440 * Put the cursor on the new line. Careful: the scrollup() above may
1441 * have moved w_cursor, we must use old_cursor.
1443 curwin->w_cursor.lnum = old_cursor.lnum + 1;
1445 if (did_append)
1446 changed_lines(curwin->w_cursor.lnum, 0, curwin->w_cursor.lnum, 1L);
1448 curwin->w_cursor.col = newcol;
1449 #ifdef FEAT_VIRTUALEDIT
1450 curwin->w_cursor.coladd = 0;
1451 #endif
1453 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1455 * In VREPLACE mode, we are handling the replace stack ourselves, so stop
1456 * fixthisline() from doing it (via change_indent()) by telling it we're in
1457 * normal INSERT mode.
1459 if (State & VREPLACE_FLAG)
1461 vreplace_mode = State; /* So we know to put things right later */
1462 State = INSERT;
1464 else
1465 vreplace_mode = 0;
1466 #endif
1467 #ifdef FEAT_LISP
1469 * May do lisp indenting.
1471 if (!p_paste
1472 # ifdef FEAT_COMMENTS
1473 && leader == NULL
1474 # endif
1475 && curbuf->b_p_lisp
1476 && curbuf->b_p_ai)
1478 fixthisline(get_lisp_indent);
1479 p = ml_get_curline();
1480 ai_col = (colnr_T)(skipwhite(p) - p);
1482 #endif
1483 #ifdef FEAT_CINDENT
1485 * May do indenting after opening a new line.
1487 if (!p_paste
1488 && (curbuf->b_p_cin
1489 # ifdef FEAT_EVAL
1490 || *curbuf->b_p_inde != NUL
1491 # endif
1493 && in_cinkeys(dir == FORWARD
1494 ? KEY_OPEN_FORW
1495 : KEY_OPEN_BACK, ' ', linewhite(curwin->w_cursor.lnum)))
1497 do_c_expr_indent();
1498 p = ml_get_curline();
1499 ai_col = (colnr_T)(skipwhite(p) - p);
1501 #endif
1502 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1503 if (vreplace_mode != 0)
1504 State = vreplace_mode;
1505 #endif
1507 #ifdef FEAT_VREPLACE
1509 * Finally, VREPLACE gets the stuff on the new line, then puts back the
1510 * original line, and inserts the new stuff char by char, pushing old stuff
1511 * onto the replace stack (via ins_char()).
1513 if (State & VREPLACE_FLAG)
1515 /* Put new line in p_extra */
1516 p_extra = vim_strsave(ml_get_curline());
1517 if (p_extra == NULL)
1518 goto theend;
1520 /* Put back original line */
1521 ml_replace(curwin->w_cursor.lnum, next_line, FALSE);
1523 /* Insert new stuff into line again */
1524 curwin->w_cursor.col = 0;
1525 #ifdef FEAT_VIRTUALEDIT
1526 curwin->w_cursor.coladd = 0;
1527 #endif
1528 ins_bytes(p_extra); /* will call changed_bytes() */
1529 vim_free(p_extra);
1530 next_line = NULL;
1532 #endif
1534 retval = TRUE; /* success! */
1535 theend:
1536 curbuf->b_p_pi = saved_pi;
1537 vim_free(saved_line);
1538 vim_free(next_line);
1539 vim_free(allocated);
1540 return retval;
1543 #if defined(FEAT_COMMENTS) || defined(PROTO)
1545 * get_leader_len() returns the length of the prefix of the given string
1546 * which introduces a comment. If this string is not a comment then 0 is
1547 * returned.
1548 * When "flags" is not NULL, it is set to point to the flags of the recognized
1549 * comment leader.
1550 * "backward" must be true for the "O" command.
1553 get_leader_len(line, flags, backward)
1554 char_u *line;
1555 char_u **flags;
1556 int backward;
1558 int i, j;
1559 int got_com = FALSE;
1560 int found_one;
1561 char_u part_buf[COM_MAX_LEN]; /* buffer for one option part */
1562 char_u *string; /* pointer to comment string */
1563 char_u *list;
1565 i = 0;
1566 while (vim_iswhite(line[i])) /* leading white space is ignored */
1567 ++i;
1570 * Repeat to match several nested comment strings.
1572 while (line[i])
1575 * scan through the 'comments' option for a match
1577 found_one = FALSE;
1578 for (list = curbuf->b_p_com; *list; )
1581 * Get one option part into part_buf[]. Advance list to next one.
1582 * put string at start of string.
1584 if (!got_com && flags != NULL) /* remember where flags started */
1585 *flags = list;
1586 (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
1587 string = vim_strchr(part_buf, ':');
1588 if (string == NULL) /* missing ':', ignore this part */
1589 continue;
1590 *string++ = NUL; /* isolate flags from string */
1593 * When already found a nested comment, only accept further
1594 * nested comments.
1596 if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
1597 continue;
1599 /* When 'O' flag used don't use for "O" command */
1600 if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
1601 continue;
1604 * Line contents and string must match.
1605 * When string starts with white space, must have some white space
1606 * (but the amount does not need to match, there might be a mix of
1607 * TABs and spaces).
1609 if (vim_iswhite(string[0]))
1611 if (i == 0 || !vim_iswhite(line[i - 1]))
1612 continue;
1613 while (vim_iswhite(string[0]))
1614 ++string;
1616 for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
1618 if (string[j] != NUL)
1619 continue;
1622 * When 'b' flag used, there must be white space or an
1623 * end-of-line after the string in the line.
1625 if (vim_strchr(part_buf, COM_BLANK) != NULL
1626 && !vim_iswhite(line[i + j]) && line[i + j] != NUL)
1627 continue;
1630 * We have found a match, stop searching.
1632 i += j;
1633 got_com = TRUE;
1634 found_one = TRUE;
1635 break;
1639 * No match found, stop scanning.
1641 if (!found_one)
1642 break;
1645 * Include any trailing white space.
1647 while (vim_iswhite(line[i]))
1648 ++i;
1651 * If this comment doesn't nest, stop here.
1653 if (vim_strchr(part_buf, COM_NEST) == NULL)
1654 break;
1656 return (got_com ? i : 0);
1658 #endif
1661 * Return the number of window lines occupied by buffer line "lnum".
1664 plines(lnum)
1665 linenr_T lnum;
1667 return plines_win(curwin, lnum, TRUE);
1671 plines_win(wp, lnum, winheight)
1672 win_T *wp;
1673 linenr_T lnum;
1674 int winheight; /* when TRUE limit to window height */
1676 #if defined(FEAT_DIFF) || defined(PROTO)
1677 /* Check for filler lines above this buffer line. When folded the result
1678 * is one line anyway. */
1679 return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
1683 plines_nofill(lnum)
1684 linenr_T lnum;
1686 return plines_win_nofill(curwin, lnum, TRUE);
1690 plines_win_nofill(wp, lnum, winheight)
1691 win_T *wp;
1692 linenr_T lnum;
1693 int winheight; /* when TRUE limit to window height */
1695 #endif
1696 int lines;
1698 if (!wp->w_p_wrap)
1699 return 1;
1701 #ifdef FEAT_VERTSPLIT
1702 if (wp->w_width == 0)
1703 return 1;
1704 #endif
1706 #ifdef FEAT_FOLDING
1707 /* A folded lines is handled just like an empty line. */
1708 /* NOTE: Caller must handle lines that are MAYBE folded. */
1709 if (lineFolded(wp, lnum) == TRUE)
1710 return 1;
1711 #endif
1713 lines = plines_win_nofold(wp, lnum);
1714 if (winheight > 0 && lines > wp->w_height)
1715 return (int)wp->w_height;
1716 return lines;
1720 * Return number of window lines physical line "lnum" will occupy in window
1721 * "wp". Does not care about folding, 'wrap' or 'diff'.
1724 plines_win_nofold(wp, lnum)
1725 win_T *wp;
1726 linenr_T lnum;
1728 char_u *s;
1729 long col;
1730 int width;
1732 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1733 if (*s == NUL) /* empty line */
1734 return 1;
1735 col = win_linetabsize(wp, s, (colnr_T)MAXCOL);
1738 * If list mode is on, then the '$' at the end of the line may take up one
1739 * extra column.
1741 if (wp->w_p_list && lcs_eol != NUL)
1742 col += 1;
1745 * Add column offset for 'number' and 'foldcolumn'.
1747 width = W_WIDTH(wp) - win_col_off(wp);
1748 if (width <= 0)
1749 return 32000;
1750 if (col <= width)
1751 return 1;
1752 col -= width;
1753 width += win_col_off2(wp);
1754 return (col + (width - 1)) / width + 1;
1758 * Like plines_win(), but only reports the number of physical screen lines
1759 * used from the start of the line to the given column number.
1762 plines_win_col(wp, lnum, column)
1763 win_T *wp;
1764 linenr_T lnum;
1765 long column;
1767 long col;
1768 char_u *s;
1769 int lines = 0;
1770 int width;
1772 #ifdef FEAT_DIFF
1773 /* Check for filler lines above this buffer line. When folded the result
1774 * is one line anyway. */
1775 lines = diff_check_fill(wp, lnum);
1776 #endif
1778 if (!wp->w_p_wrap)
1779 return lines + 1;
1781 #ifdef FEAT_VERTSPLIT
1782 if (wp->w_width == 0)
1783 return lines + 1;
1784 #endif
1786 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1788 col = 0;
1789 while (*s != NUL && --column >= 0)
1791 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL);
1792 mb_ptr_adv(s);
1796 * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
1797 * INSERT mode, then col must be adjusted so that it represents the last
1798 * screen position of the TAB. This only fixes an error when the TAB wraps
1799 * from one screen line to the next (when 'columns' is not a multiple of
1800 * 'ts') -- webb.
1802 if (*s == TAB && (State & NORMAL) && (!wp->w_p_list || lcs_tab1))
1803 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL) - 1;
1806 * Add column offset for 'number', 'foldcolumn', etc.
1808 width = W_WIDTH(wp) - win_col_off(wp);
1809 if (width <= 0)
1810 return 9999;
1812 lines += 1;
1813 if (col > width)
1814 lines += (col - width) / (width + win_col_off2(wp)) + 1;
1815 return lines;
1819 plines_m_win(wp, first, last)
1820 win_T *wp;
1821 linenr_T first, last;
1823 int count = 0;
1825 while (first <= last)
1827 #ifdef FEAT_FOLDING
1828 int x;
1830 /* Check if there are any really folded lines, but also included lines
1831 * that are maybe folded. */
1832 x = foldedCount(wp, first, NULL);
1833 if (x > 0)
1835 ++count; /* count 1 for "+-- folded" line */
1836 first += x;
1838 else
1839 #endif
1841 #ifdef FEAT_DIFF
1842 if (first == wp->w_topline)
1843 count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill;
1844 else
1845 #endif
1846 count += plines_win(wp, first, TRUE);
1847 ++first;
1850 return (count);
1853 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) || defined(PROTO)
1855 * Insert string "p" at the cursor position. Stops at a NUL byte.
1856 * Handles Replace mode and multi-byte characters.
1858 void
1859 ins_bytes(p)
1860 char_u *p;
1862 ins_bytes_len(p, (int)STRLEN(p));
1864 #endif
1866 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) \
1867 || defined(FEAT_COMMENTS) || defined(FEAT_MBYTE) || defined(PROTO)
1869 * Insert string "p" with length "len" at the cursor position.
1870 * Handles Replace mode and multi-byte characters.
1872 void
1873 ins_bytes_len(p, len)
1874 char_u *p;
1875 int len;
1877 int i;
1878 # ifdef FEAT_MBYTE
1879 int n;
1881 if (has_mbyte)
1882 for (i = 0; i < len; i += n)
1884 if (enc_utf8)
1885 /* avoid reading past p[len] */
1886 n = utfc_ptr2len_len(p + i, len - i);
1887 else
1888 n = (*mb_ptr2len)(p + i);
1889 ins_char_bytes(p + i, n);
1891 else
1892 # endif
1893 for (i = 0; i < len; ++i)
1894 ins_char(p[i]);
1896 #endif
1899 * Insert or replace a single character at the cursor position.
1900 * When in REPLACE or VREPLACE mode, replace any existing character.
1901 * Caller must have prepared for undo.
1902 * For multi-byte characters we get the whole character, the caller must
1903 * convert bytes to a character.
1905 void
1906 ins_char(c)
1907 int c;
1909 #if defined(FEAT_MBYTE) || defined(PROTO)
1910 char_u buf[MB_MAXBYTES];
1911 int n;
1913 n = (*mb_char2bytes)(c, buf);
1915 /* When "c" is 0x100, 0x200, etc. we don't want to insert a NUL byte.
1916 * Happens for CTRL-Vu9900. */
1917 if (buf[0] == 0)
1918 buf[0] = '\n';
1920 ins_char_bytes(buf, n);
1923 void
1924 ins_char_bytes(buf, charlen)
1925 char_u *buf;
1926 int charlen;
1928 int c = buf[0];
1929 #endif
1930 int newlen; /* nr of bytes inserted */
1931 int oldlen; /* nr of bytes deleted (0 when not replacing) */
1932 char_u *p;
1933 char_u *newp;
1934 char_u *oldp;
1935 int linelen; /* length of old line including NUL */
1936 colnr_T col;
1937 linenr_T lnum = curwin->w_cursor.lnum;
1938 int i;
1940 #ifdef FEAT_VIRTUALEDIT
1941 /* Break tabs if needed. */
1942 if (virtual_active() && curwin->w_cursor.coladd > 0)
1943 coladvance_force(getviscol());
1944 #endif
1946 col = curwin->w_cursor.col;
1947 oldp = ml_get(lnum);
1948 linelen = (int)STRLEN(oldp) + 1;
1950 /* The lengths default to the values for when not replacing. */
1951 oldlen = 0;
1952 #ifdef FEAT_MBYTE
1953 newlen = charlen;
1954 #else
1955 newlen = 1;
1956 #endif
1958 if (State & REPLACE_FLAG)
1960 #ifdef FEAT_VREPLACE
1961 if (State & VREPLACE_FLAG)
1963 colnr_T new_vcol = 0; /* init for GCC */
1964 colnr_T vcol;
1965 int old_list;
1966 #ifndef FEAT_MBYTE
1967 char_u buf[2];
1968 #endif
1971 * Disable 'list' temporarily, unless 'cpo' contains the 'L' flag.
1972 * Returns the old value of list, so when finished,
1973 * curwin->w_p_list should be set back to this.
1975 old_list = curwin->w_p_list;
1976 if (old_list && vim_strchr(p_cpo, CPO_LISTWM) == NULL)
1977 curwin->w_p_list = FALSE;
1980 * In virtual replace mode each character may replace one or more
1981 * characters (zero if it's a TAB). Count the number of bytes to
1982 * be deleted to make room for the new character, counting screen
1983 * cells. May result in adding spaces to fill a gap.
1985 getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL);
1986 #ifndef FEAT_MBYTE
1987 buf[0] = c;
1988 buf[1] = NUL;
1989 #endif
1990 new_vcol = vcol + chartabsize(buf, vcol);
1991 while (oldp[col + oldlen] != NUL && vcol < new_vcol)
1993 vcol += chartabsize(oldp + col + oldlen, vcol);
1994 /* Don't need to remove a TAB that takes us to the right
1995 * position. */
1996 if (vcol > new_vcol && oldp[col + oldlen] == TAB)
1997 break;
1998 #ifdef FEAT_MBYTE
1999 oldlen += (*mb_ptr2len)(oldp + col + oldlen);
2000 #else
2001 ++oldlen;
2002 #endif
2003 /* Deleted a bit too much, insert spaces. */
2004 if (vcol > new_vcol)
2005 newlen += vcol - new_vcol;
2007 curwin->w_p_list = old_list;
2009 else
2010 #endif
2011 if (oldp[col] != NUL)
2013 /* normal replace */
2014 #ifdef FEAT_MBYTE
2015 oldlen = (*mb_ptr2len)(oldp + col);
2016 #else
2017 oldlen = 1;
2018 #endif
2022 /* Push the replaced bytes onto the replace stack, so that they can be
2023 * put back when BS is used. The bytes of a multi-byte character are
2024 * done the other way around, so that the first byte is popped off
2025 * first (it tells the byte length of the character). */
2026 replace_push(NUL);
2027 for (i = 0; i < oldlen; ++i)
2029 #ifdef FEAT_MBYTE
2030 if (has_mbyte)
2031 i += replace_push_mb(oldp + col + i) - 1;
2032 else
2033 #endif
2034 replace_push(oldp[col + i]);
2038 newp = alloc_check((unsigned)(linelen + newlen - oldlen));
2039 if (newp == NULL)
2040 return;
2042 /* Copy bytes before the cursor. */
2043 if (col > 0)
2044 mch_memmove(newp, oldp, (size_t)col);
2046 /* Copy bytes after the changed character(s). */
2047 p = newp + col;
2048 mch_memmove(p + newlen, oldp + col + oldlen,
2049 (size_t)(linelen - col - oldlen));
2051 /* Insert or overwrite the new character. */
2052 #ifdef FEAT_MBYTE
2053 mch_memmove(p, buf, charlen);
2054 i = charlen;
2055 #else
2056 *p = c;
2057 i = 1;
2058 #endif
2060 /* Fill with spaces when necessary. */
2061 while (i < newlen)
2062 p[i++] = ' ';
2064 /* Replace the line in the buffer. */
2065 ml_replace(lnum, newp, FALSE);
2067 /* mark the buffer as changed and prepare for displaying */
2068 changed_bytes(lnum, col);
2071 * If we're in Insert or Replace mode and 'showmatch' is set, then briefly
2072 * show the match for right parens and braces.
2074 if (p_sm && (State & INSERT)
2075 && msg_silent == 0
2076 #ifdef FEAT_MBYTE
2077 && charlen == 1
2078 #endif
2079 #ifdef FEAT_INS_EXPAND
2080 && !ins_compl_active()
2081 #endif
2083 showmatch(c);
2085 #ifdef FEAT_RIGHTLEFT
2086 if (!p_ri || (State & REPLACE_FLAG))
2087 #endif
2089 /* Normal insert: move cursor right */
2090 #ifdef FEAT_MBYTE
2091 curwin->w_cursor.col += charlen;
2092 #else
2093 ++curwin->w_cursor.col;
2094 #endif
2097 * TODO: should try to update w_row here, to avoid recomputing it later.
2102 * Insert a string at the cursor position.
2103 * Note: Does NOT handle Replace mode.
2104 * Caller must have prepared for undo.
2106 void
2107 ins_str(s)
2108 char_u *s;
2110 char_u *oldp, *newp;
2111 int newlen = (int)STRLEN(s);
2112 int oldlen;
2113 colnr_T col;
2114 linenr_T lnum = curwin->w_cursor.lnum;
2116 #ifdef FEAT_VIRTUALEDIT
2117 if (virtual_active() && curwin->w_cursor.coladd > 0)
2118 coladvance_force(getviscol());
2119 #endif
2121 col = curwin->w_cursor.col;
2122 oldp = ml_get(lnum);
2123 oldlen = (int)STRLEN(oldp);
2125 newp = alloc_check((unsigned)(oldlen + newlen + 1));
2126 if (newp == NULL)
2127 return;
2128 if (col > 0)
2129 mch_memmove(newp, oldp, (size_t)col);
2130 mch_memmove(newp + col, s, (size_t)newlen);
2131 mch_memmove(newp + col + newlen, oldp + col, (size_t)(oldlen - col + 1));
2132 ml_replace(lnum, newp, FALSE);
2133 changed_bytes(lnum, col);
2134 curwin->w_cursor.col += newlen;
2138 * Delete one character under the cursor.
2139 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2140 * Caller must have prepared for undo.
2142 * return FAIL for failure, OK otherwise
2145 del_char(fixpos)
2146 int fixpos;
2148 #ifdef FEAT_MBYTE
2149 if (has_mbyte)
2151 /* Make sure the cursor is at the start of a character. */
2152 mb_adjust_cursor();
2153 if (*ml_get_cursor() == NUL)
2154 return FAIL;
2155 return del_chars(1L, fixpos);
2157 #endif
2158 return del_bytes(1L, fixpos, TRUE);
2161 #if defined(FEAT_MBYTE) || defined(PROTO)
2163 * Like del_bytes(), but delete characters instead of bytes.
2166 del_chars(count, fixpos)
2167 long count;
2168 int fixpos;
2170 long bytes = 0;
2171 long i;
2172 char_u *p;
2173 int l;
2175 p = ml_get_cursor();
2176 for (i = 0; i < count && *p != NUL; ++i)
2178 l = (*mb_ptr2len)(p);
2179 bytes += l;
2180 p += l;
2182 return del_bytes(bytes, fixpos, TRUE);
2184 #endif
2187 * Delete "count" bytes under the cursor.
2188 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2189 * Caller must have prepared for undo.
2191 * return FAIL for failure, OK otherwise
2194 del_bytes(count, fixpos_arg, use_delcombine)
2195 long count;
2196 int fixpos_arg;
2197 int use_delcombine UNUSED; /* 'delcombine' option applies */
2199 char_u *oldp, *newp;
2200 colnr_T oldlen;
2201 linenr_T lnum = curwin->w_cursor.lnum;
2202 colnr_T col = curwin->w_cursor.col;
2203 int was_alloced;
2204 long movelen;
2205 int fixpos = fixpos_arg;
2207 oldp = ml_get(lnum);
2208 oldlen = (int)STRLEN(oldp);
2211 * Can't do anything when the cursor is on the NUL after the line.
2213 if (col >= oldlen)
2214 return FAIL;
2216 #ifdef FEAT_MBYTE
2217 /* If 'delcombine' is set and deleting (less than) one character, only
2218 * delete the last combining character. */
2219 if (p_deco && use_delcombine && enc_utf8
2220 && utfc_ptr2len(oldp + col) >= count)
2222 int cc[MAX_MCO];
2223 int n;
2225 (void)utfc_ptr2char(oldp + col, cc);
2226 if (cc[0] != NUL)
2228 /* Find the last composing char, there can be several. */
2229 n = col;
2232 col = n;
2233 count = utf_ptr2len(oldp + n);
2234 n += count;
2235 } while (UTF_COMPOSINGLIKE(oldp + col, oldp + n));
2236 fixpos = 0;
2239 #endif
2242 * When count is too big, reduce it.
2244 movelen = (long)oldlen - (long)col - count + 1; /* includes trailing NUL */
2245 if (movelen <= 1)
2248 * If we just took off the last character of a non-blank line, and
2249 * fixpos is TRUE, we don't want to end up positioned at the NUL,
2250 * unless "restart_edit" is set or 'virtualedit' contains "onemore".
2252 if (col > 0 && fixpos && restart_edit == 0
2253 #ifdef FEAT_VIRTUALEDIT
2254 && (ve_flags & VE_ONEMORE) == 0
2255 #endif
2258 --curwin->w_cursor.col;
2259 #ifdef FEAT_VIRTUALEDIT
2260 curwin->w_cursor.coladd = 0;
2261 #endif
2262 #ifdef FEAT_MBYTE
2263 if (has_mbyte)
2264 curwin->w_cursor.col -=
2265 (*mb_head_off)(oldp, oldp + curwin->w_cursor.col);
2266 #endif
2268 count = oldlen - col;
2269 movelen = 1;
2273 * If the old line has been allocated the deletion can be done in the
2274 * existing line. Otherwise a new line has to be allocated
2275 * Can't do this when using Netbeans, because we would need to invoke
2276 * netbeans_removed(), which deallocates the line. Let ml_replace() take
2277 * care of notifiying Netbeans.
2279 #ifdef FEAT_NETBEANS_INTG
2280 if (usingNetbeans)
2281 was_alloced = FALSE;
2282 else
2283 #endif
2284 was_alloced = ml_line_alloced(); /* check if oldp was allocated */
2285 if (was_alloced)
2286 newp = oldp; /* use same allocated memory */
2287 else
2288 { /* need to allocate a new line */
2289 newp = alloc((unsigned)(oldlen + 1 - count));
2290 if (newp == NULL)
2291 return FAIL;
2292 mch_memmove(newp, oldp, (size_t)col);
2294 mch_memmove(newp + col, oldp + col + count, (size_t)movelen);
2295 if (!was_alloced)
2296 ml_replace(lnum, newp, FALSE);
2298 /* mark the buffer as changed and prepare for displaying */
2299 changed_bytes(lnum, curwin->w_cursor.col);
2301 return OK;
2305 * Delete from cursor to end of line.
2306 * Caller must have prepared for undo.
2308 * return FAIL for failure, OK otherwise
2311 truncate_line(fixpos)
2312 int fixpos; /* if TRUE fix the cursor position when done */
2314 char_u *newp;
2315 linenr_T lnum = curwin->w_cursor.lnum;
2316 colnr_T col = curwin->w_cursor.col;
2318 if (col == 0)
2319 newp = vim_strsave((char_u *)"");
2320 else
2321 newp = vim_strnsave(ml_get(lnum), col);
2323 if (newp == NULL)
2324 return FAIL;
2326 ml_replace(lnum, newp, FALSE);
2328 /* mark the buffer as changed and prepare for displaying */
2329 changed_bytes(lnum, curwin->w_cursor.col);
2332 * If "fixpos" is TRUE we don't want to end up positioned at the NUL.
2334 if (fixpos && curwin->w_cursor.col > 0)
2335 --curwin->w_cursor.col;
2337 return OK;
2341 * Delete "nlines" lines at the cursor.
2342 * Saves the lines for undo first if "undo" is TRUE.
2344 void
2345 del_lines(nlines, undo)
2346 long nlines; /* number of lines to delete */
2347 int undo; /* if TRUE, prepare for undo */
2349 long n;
2350 linenr_T first = curwin->w_cursor.lnum;
2352 if (nlines <= 0)
2353 return;
2355 /* save the deleted lines for undo */
2356 if (undo && u_savedel(first, nlines) == FAIL)
2357 return;
2359 for (n = 0; n < nlines; )
2361 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
2362 break;
2364 ml_delete(first, TRUE);
2365 ++n;
2367 /* If we delete the last line in the file, stop */
2368 if (first > curbuf->b_ml.ml_line_count)
2369 break;
2372 /* Correct the cursor position before calling deleted_lines_mark(), it may
2373 * trigger a callback to display the cursor. */
2374 curwin->w_cursor.col = 0;
2375 check_cursor_lnum();
2377 /* adjust marks, mark the buffer as changed and prepare for displaying */
2378 deleted_lines_mark(first, n);
2382 gchar_pos(pos)
2383 pos_T *pos;
2385 char_u *ptr = ml_get_pos(pos);
2387 #ifdef FEAT_MBYTE
2388 if (has_mbyte)
2389 return (*mb_ptr2char)(ptr);
2390 #endif
2391 return (int)*ptr;
2395 gchar_cursor()
2397 #ifdef FEAT_MBYTE
2398 if (has_mbyte)
2399 return (*mb_ptr2char)(ml_get_cursor());
2400 #endif
2401 return (int)*ml_get_cursor();
2405 * Write a character at the current cursor position.
2406 * It is directly written into the block.
2408 void
2409 pchar_cursor(c)
2410 int c;
2412 *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
2413 + curwin->w_cursor.col) = c;
2416 #if 0 /* not used */
2418 * Put *pos at end of current buffer
2420 void
2421 goto_endofbuf(pos)
2422 pos_T *pos;
2424 char_u *p;
2426 pos->lnum = curbuf->b_ml.ml_line_count;
2427 pos->col = 0;
2428 p = ml_get(pos->lnum);
2429 while (*p++)
2430 ++pos->col;
2432 #endif
2435 * When extra == 0: Return TRUE if the cursor is before or on the first
2436 * non-blank in the line.
2437 * When extra == 1: Return TRUE if the cursor is before the first non-blank in
2438 * the line.
2441 inindent(extra)
2442 int extra;
2444 char_u *ptr;
2445 colnr_T col;
2447 for (col = 0, ptr = ml_get_curline(); vim_iswhite(*ptr); ++col)
2448 ++ptr;
2449 if (col >= curwin->w_cursor.col + extra)
2450 return TRUE;
2451 else
2452 return FALSE;
2456 * Skip to next part of an option argument: Skip space and comma.
2458 char_u *
2459 skip_to_option_part(p)
2460 char_u *p;
2462 if (*p == ',')
2463 ++p;
2464 while (*p == ' ')
2465 ++p;
2466 return p;
2470 * changed() is called when something in the current buffer is changed.
2472 * Most often called through changed_bytes() and changed_lines(), which also
2473 * mark the area of the display to be redrawn.
2475 void
2476 changed()
2478 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2479 /* The text of the preediting area is inserted, but this doesn't
2480 * mean a change of the buffer yet. That is delayed until the
2481 * text is committed. (this means preedit becomes empty) */
2482 if (im_is_preediting() && !xim_changed_while_preediting)
2483 return;
2484 xim_changed_while_preediting = FALSE;
2485 #endif
2487 if (!curbuf->b_changed)
2489 int save_msg_scroll = msg_scroll;
2491 /* Give a warning about changing a read-only file. This may also
2492 * check-out the file, thus change "curbuf"! */
2493 change_warning(0);
2495 /* Create a swap file if that is wanted.
2496 * Don't do this for "nofile" and "nowrite" buffer types. */
2497 if (curbuf->b_may_swap
2498 #ifdef FEAT_QUICKFIX
2499 && !bt_dontwrite(curbuf)
2500 #endif
2503 ml_open_file(curbuf);
2505 /* The ml_open_file() can cause an ATTENTION message.
2506 * Wait two seconds, to make sure the user reads this unexpected
2507 * message. Since we could be anywhere, call wait_return() now,
2508 * and don't let the emsg() set msg_scroll. */
2509 if (need_wait_return && emsg_silent == 0)
2511 out_flush();
2512 ui_delay(2000L, TRUE);
2513 wait_return(TRUE);
2514 msg_scroll = save_msg_scroll;
2517 curbuf->b_changed = TRUE;
2518 ml_setflags(curbuf);
2519 #ifdef FEAT_WINDOWS
2520 check_status(curbuf);
2521 redraw_tabline = TRUE;
2522 #endif
2523 #ifdef FEAT_TITLE
2524 need_maketitle = TRUE; /* set window title later */
2525 #endif
2527 ++curbuf->b_changedtick;
2530 static void changedOneline __ARGS((buf_T *buf, linenr_T lnum));
2531 static void changed_lines_buf __ARGS((buf_T *buf, linenr_T lnum, linenr_T lnume, long xtra));
2532 static void changed_common __ARGS((linenr_T lnum, colnr_T col, linenr_T lnume, long xtra));
2535 * Changed bytes within a single line for the current buffer.
2536 * - marks the windows on this buffer to be redisplayed
2537 * - marks the buffer changed by calling changed()
2538 * - invalidates cached values
2540 void
2541 changed_bytes(lnum, col)
2542 linenr_T lnum;
2543 colnr_T col;
2545 changedOneline(curbuf, lnum);
2546 changed_common(lnum, col, lnum + 1, 0L);
2548 #ifdef FEAT_DIFF
2549 /* Diff highlighting in other diff windows may need to be updated too. */
2550 if (curwin->w_p_diff)
2552 win_T *wp;
2553 linenr_T wlnum;
2555 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2556 if (wp->w_p_diff && wp != curwin)
2558 redraw_win_later(wp, VALID);
2559 wlnum = diff_lnum_win(lnum, wp);
2560 if (wlnum > 0)
2561 changedOneline(wp->w_buffer, wlnum);
2564 #endif
2567 static void
2568 changedOneline(buf, lnum)
2569 buf_T *buf;
2570 linenr_T lnum;
2572 if (buf->b_mod_set)
2574 /* find the maximum area that must be redisplayed */
2575 if (lnum < buf->b_mod_top)
2576 buf->b_mod_top = lnum;
2577 else if (lnum >= buf->b_mod_bot)
2578 buf->b_mod_bot = lnum + 1;
2580 else
2582 /* set the area that must be redisplayed to one line */
2583 buf->b_mod_set = TRUE;
2584 buf->b_mod_top = lnum;
2585 buf->b_mod_bot = lnum + 1;
2586 buf->b_mod_xlines = 0;
2591 * Appended "count" lines below line "lnum" in the current buffer.
2592 * Must be called AFTER the change and after mark_adjust().
2593 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2595 void
2596 appended_lines(lnum, count)
2597 linenr_T lnum;
2598 long count;
2600 changed_lines(lnum + 1, 0, lnum + 1, count);
2604 * Like appended_lines(), but adjust marks first.
2606 void
2607 appended_lines_mark(lnum, count)
2608 linenr_T lnum;
2609 long count;
2611 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, count, 0L);
2612 changed_lines(lnum + 1, 0, lnum + 1, count);
2616 * Deleted "count" lines at line "lnum" in the current buffer.
2617 * Must be called AFTER the change and after mark_adjust().
2618 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2620 void
2621 deleted_lines(lnum, count)
2622 linenr_T lnum;
2623 long count;
2625 changed_lines(lnum, 0, lnum + count, -count);
2629 * Like deleted_lines(), but adjust marks first.
2630 * Make sure the cursor is on a valid line before calling, a GUI callback may
2631 * be triggered to display the cursor.
2633 void
2634 deleted_lines_mark(lnum, count)
2635 linenr_T lnum;
2636 long count;
2638 mark_adjust(lnum, (linenr_T)(lnum + count - 1), (long)MAXLNUM, -count);
2639 changed_lines(lnum, 0, lnum + count, -count);
2643 * Changed lines for the current buffer.
2644 * Must be called AFTER the change and after mark_adjust().
2645 * - mark the buffer changed by calling changed()
2646 * - mark the windows on this buffer to be redisplayed
2647 * - invalidate cached values
2648 * "lnum" is the first line that needs displaying, "lnume" the first line
2649 * below the changed lines (BEFORE the change).
2650 * When only inserting lines, "lnum" and "lnume" are equal.
2651 * Takes care of calling changed() and updating b_mod_*.
2653 void
2654 changed_lines(lnum, col, lnume, xtra)
2655 linenr_T lnum; /* first line with change */
2656 colnr_T col; /* column in first line with change */
2657 linenr_T lnume; /* line below last changed line */
2658 long xtra; /* number of extra lines (negative when deleting) */
2660 changed_lines_buf(curbuf, lnum, lnume, xtra);
2662 #ifdef FEAT_DIFF
2663 if (xtra == 0 && curwin->w_p_diff)
2665 /* When the number of lines doesn't change then mark_adjust() isn't
2666 * called and other diff buffers still need to be marked for
2667 * displaying. */
2668 win_T *wp;
2669 linenr_T wlnum;
2671 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2672 if (wp->w_p_diff && wp != curwin)
2674 redraw_win_later(wp, VALID);
2675 wlnum = diff_lnum_win(lnum, wp);
2676 if (wlnum > 0)
2677 changed_lines_buf(wp->w_buffer, wlnum,
2678 lnume - lnum + wlnum, 0L);
2681 #endif
2683 changed_common(lnum, col, lnume, xtra);
2685 /* update ew linenumbers for CodeCheck if the current buffer is
2686 * being watched. */
2687 if (cc_is_buf_watched(curbuf))
2688 cc_update_ew_lnums(curbuf, lnum, col, xtra);
2691 static void
2692 changed_lines_buf(buf, lnum, lnume, xtra)
2693 buf_T *buf;
2694 linenr_T lnum; /* first line with change */
2695 linenr_T lnume; /* line below last changed line */
2696 long xtra; /* number of extra lines (negative when deleting) */
2698 if (buf->b_mod_set)
2700 /* find the maximum area that must be redisplayed */
2701 if (lnum < buf->b_mod_top)
2702 buf->b_mod_top = lnum;
2703 if (lnum < buf->b_mod_bot)
2705 /* adjust old bot position for xtra lines */
2706 buf->b_mod_bot += xtra;
2707 if (buf->b_mod_bot < lnum)
2708 buf->b_mod_bot = lnum;
2710 if (lnume + xtra > buf->b_mod_bot)
2711 buf->b_mod_bot = lnume + xtra;
2712 buf->b_mod_xlines += xtra;
2714 else
2716 /* set the area that must be redisplayed */
2717 buf->b_mod_set = TRUE;
2718 buf->b_mod_top = lnum;
2719 buf->b_mod_bot = lnume + xtra;
2720 buf->b_mod_xlines = xtra;
2724 static void
2725 changed_common(lnum, col, lnume, xtra)
2726 linenr_T lnum;
2727 colnr_T col;
2728 linenr_T lnume;
2729 long xtra;
2731 win_T *wp;
2732 #ifdef FEAT_WINDOWS
2733 tabpage_T *tp;
2734 #endif
2735 int i;
2736 #ifdef FEAT_JUMPLIST
2737 int cols;
2738 pos_T *p;
2739 int add;
2740 #endif
2742 /* mark the buffer as modified */
2743 changed();
2745 /* set the '. mark */
2746 if (!cmdmod.keepjumps)
2748 curbuf->b_last_change.lnum = lnum;
2749 curbuf->b_last_change.col = col;
2751 #ifdef FEAT_JUMPLIST
2752 /* Create a new entry if a new undo-able change was started or we
2753 * don't have an entry yet. */
2754 if (curbuf->b_new_change || curbuf->b_changelistlen == 0)
2756 if (curbuf->b_changelistlen == 0)
2757 add = TRUE;
2758 else
2760 /* Don't create a new entry when the line number is the same
2761 * as the last one and the column is not too far away. Avoids
2762 * creating many entries for typing "xxxxx". */
2763 p = &curbuf->b_changelist[curbuf->b_changelistlen - 1];
2764 if (p->lnum != lnum)
2765 add = TRUE;
2766 else
2768 cols = comp_textwidth(FALSE);
2769 if (cols == 0)
2770 cols = 79;
2771 add = (p->col + cols < col || col + cols < p->col);
2774 if (add)
2776 /* This is the first of a new sequence of undo-able changes
2777 * and it's at some distance of the last change. Use a new
2778 * position in the changelist. */
2779 curbuf->b_new_change = FALSE;
2781 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2783 /* changelist is full: remove oldest entry */
2784 curbuf->b_changelistlen = JUMPLISTSIZE - 1;
2785 mch_memmove(curbuf->b_changelist, curbuf->b_changelist + 1,
2786 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2787 FOR_ALL_TAB_WINDOWS(tp, wp)
2789 /* Correct position in changelist for other windows on
2790 * this buffer. */
2791 if (wp->w_buffer == curbuf && wp->w_changelistidx > 0)
2792 --wp->w_changelistidx;
2795 FOR_ALL_TAB_WINDOWS(tp, wp)
2797 /* For other windows, if the position in the changelist is
2798 * at the end it stays at the end. */
2799 if (wp->w_buffer == curbuf
2800 && wp->w_changelistidx == curbuf->b_changelistlen)
2801 ++wp->w_changelistidx;
2803 ++curbuf->b_changelistlen;
2806 curbuf->b_changelist[curbuf->b_changelistlen - 1] =
2807 curbuf->b_last_change;
2808 /* The current window is always after the last change, so that "g,"
2809 * takes you back to it. */
2810 curwin->w_changelistidx = curbuf->b_changelistlen;
2811 #endif
2814 FOR_ALL_TAB_WINDOWS(tp, wp)
2816 if (wp->w_buffer == curbuf)
2818 /* Mark this window to be redrawn later. */
2819 if (wp->w_redr_type < VALID)
2820 wp->w_redr_type = VALID;
2822 /* Check if a change in the buffer has invalidated the cached
2823 * values for the cursor. */
2824 #ifdef FEAT_FOLDING
2826 * Update the folds for this window. Can't postpone this, because
2827 * a following operator might work on the whole fold: ">>dd".
2829 foldUpdate(wp, lnum, lnume + xtra - 1);
2831 /* The change may cause lines above or below the change to become
2832 * included in a fold. Set lnum/lnume to the first/last line that
2833 * might be displayed differently.
2834 * Set w_cline_folded here as an efficient way to update it when
2835 * inserting lines just above a closed fold. */
2836 i = hasFoldingWin(wp, lnum, &lnum, NULL, FALSE, NULL);
2837 if (wp->w_cursor.lnum == lnum)
2838 wp->w_cline_folded = i;
2839 i = hasFoldingWin(wp, lnume, NULL, &lnume, FALSE, NULL);
2840 if (wp->w_cursor.lnum == lnume)
2841 wp->w_cline_folded = i;
2843 /* If the changed line is in a range of previously folded lines,
2844 * compare with the first line in that range. */
2845 if (wp->w_cursor.lnum <= lnum)
2847 i = find_wl_entry(wp, lnum);
2848 if (i >= 0 && wp->w_cursor.lnum > wp->w_lines[i].wl_lnum)
2849 changed_line_abv_curs_win(wp);
2851 #endif
2853 if (wp->w_cursor.lnum > lnum)
2854 changed_line_abv_curs_win(wp);
2855 else if (wp->w_cursor.lnum == lnum && wp->w_cursor.col >= col)
2856 changed_cline_bef_curs_win(wp);
2857 if (wp->w_botline >= lnum)
2859 /* Assume that botline doesn't change (inserted lines make
2860 * other lines scroll down below botline). */
2861 approximate_botline_win(wp);
2864 /* Check if any w_lines[] entries have become invalid.
2865 * For entries below the change: Correct the lnums for
2866 * inserted/deleted lines. Makes it possible to stop displaying
2867 * after the change. */
2868 for (i = 0; i < wp->w_lines_valid; ++i)
2869 if (wp->w_lines[i].wl_valid)
2871 if (wp->w_lines[i].wl_lnum >= lnum)
2873 if (wp->w_lines[i].wl_lnum < lnume)
2875 /* line included in change */
2876 wp->w_lines[i].wl_valid = FALSE;
2878 else if (xtra != 0)
2880 /* line below change */
2881 wp->w_lines[i].wl_lnum += xtra;
2882 #ifdef FEAT_FOLDING
2883 wp->w_lines[i].wl_lastlnum += xtra;
2884 #endif
2887 #ifdef FEAT_FOLDING
2888 else if (wp->w_lines[i].wl_lastlnum >= lnum)
2890 /* change somewhere inside this range of folded lines,
2891 * may need to be redrawn */
2892 wp->w_lines[i].wl_valid = FALSE;
2894 #endif
2897 #ifdef FEAT_FOLDING
2898 /* Take care of side effects for setting w_topline when folds have
2899 * changed. Esp. when the buffer was changed in another window. */
2900 if (hasAnyFolding(wp))
2901 set_topline(wp, wp->w_topline);
2902 #endif
2906 /* Call update_screen() later, which checks out what needs to be redrawn,
2907 * since it notices b_mod_set and then uses b_mod_*. */
2908 if (must_redraw < VALID)
2909 must_redraw = VALID;
2911 #ifdef FEAT_AUTOCMD
2912 /* when the cursor line is changed always trigger CursorMoved */
2913 if (lnum <= curwin->w_cursor.lnum
2914 && lnume + (xtra < 0 ? -xtra : xtra) > curwin->w_cursor.lnum)
2915 last_cursormoved.lnum = 0;
2916 #endif
2920 * unchanged() is called when the changed flag must be reset for buffer 'buf'
2922 void
2923 unchanged(buf, ff)
2924 buf_T *buf;
2925 int ff; /* also reset 'fileformat' */
2927 if (buf->b_changed || (ff && file_ff_differs(buf)))
2929 buf->b_changed = 0;
2930 ml_setflags(buf);
2931 if (ff)
2932 save_file_ff(buf);
2933 #ifdef FEAT_WINDOWS
2934 check_status(buf);
2935 redraw_tabline = TRUE;
2936 #endif
2937 #ifdef FEAT_TITLE
2938 need_maketitle = TRUE; /* set window title later */
2939 #endif
2941 ++buf->b_changedtick;
2942 #ifdef FEAT_NETBEANS_INTG
2943 netbeans_unmodified(buf);
2944 #endif
2947 #if defined(FEAT_WINDOWS) || defined(PROTO)
2949 * check_status: called when the status bars for the buffer 'buf'
2950 * need to be updated
2952 void
2953 check_status(buf)
2954 buf_T *buf;
2956 win_T *wp;
2958 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2959 if (wp->w_buffer == buf && wp->w_status_height)
2961 wp->w_redr_status = TRUE;
2962 if (must_redraw < VALID)
2963 must_redraw = VALID;
2966 #endif
2969 * If the file is readonly, give a warning message with the first change.
2970 * Don't do this for autocommands.
2971 * Don't use emsg(), because it flushes the macro buffer.
2972 * If we have undone all changes b_changed will be FALSE, but "b_did_warn"
2973 * will be TRUE.
2975 void
2976 change_warning(col)
2977 int col; /* column for message; non-zero when in insert
2978 mode and 'showmode' is on */
2980 static char *w_readonly = N_("W10: Warning: Changing a readonly file");
2982 if (curbuf->b_did_warn == FALSE
2983 && curbufIsChanged() == 0
2984 #ifdef FEAT_AUTOCMD
2985 && !autocmd_busy
2986 #endif
2987 && curbuf->b_p_ro)
2989 #ifdef FEAT_AUTOCMD
2990 ++curbuf_lock;
2991 apply_autocmds(EVENT_FILECHANGEDRO, NULL, NULL, FALSE, curbuf);
2992 --curbuf_lock;
2993 if (!curbuf->b_p_ro)
2994 return;
2995 #endif
2997 * Do what msg() does, but with a column offset if the warning should
2998 * be after the mode message.
3000 msg_start();
3001 if (msg_row == Rows - 1)
3002 msg_col = col;
3003 msg_source(hl_attr(HLF_W));
3004 MSG_PUTS_ATTR(_(w_readonly), hl_attr(HLF_W) | MSG_HIST);
3005 #ifdef FEAT_EVAL
3006 set_vim_var_string(VV_WARNINGMSG, (char_u *)_(w_readonly), -1);
3007 #endif
3008 msg_clr_eos();
3009 (void)msg_end();
3010 if (msg_silent == 0 && !silent_mode)
3012 out_flush();
3013 ui_delay(1000L, TRUE); /* give the user time to think about it */
3015 curbuf->b_did_warn = TRUE;
3016 redraw_cmdline = FALSE; /* don't redraw and erase the message */
3017 if (msg_row < Rows - 1)
3018 showmode();
3023 * Ask for a reply from the user, a 'y' or a 'n'.
3024 * No other characters are accepted, the message is repeated until a valid
3025 * reply is entered or CTRL-C is hit.
3026 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
3027 * from any buffers but directly from the user.
3029 * return the 'y' or 'n'
3032 ask_yesno(str, direct)
3033 char_u *str;
3034 int direct;
3036 int r = ' ';
3037 int save_State = State;
3039 if (exiting) /* put terminal in raw mode for this question */
3040 settmode(TMODE_RAW);
3041 ++no_wait_return;
3042 #ifdef USE_ON_FLY_SCROLL
3043 dont_scroll = TRUE; /* disallow scrolling here */
3044 #endif
3045 State = CONFIRM; /* mouse behaves like with :confirm */
3046 #ifdef FEAT_MOUSE
3047 setmouse(); /* disables mouse for xterm */
3048 #endif
3049 ++no_mapping;
3050 ++allow_keys; /* no mapping here, but recognize keys */
3052 while (r != 'y' && r != 'n')
3054 /* same highlighting as for wait_return */
3055 smsg_attr(hl_attr(HLF_R), (char_u *)"%s (y/n)?", str);
3056 if (direct)
3057 r = get_keystroke();
3058 else
3059 r = plain_vgetc();
3060 if (r == Ctrl_C || r == ESC)
3061 r = 'n';
3062 msg_putchar(r); /* show what you typed */
3063 out_flush();
3065 --no_wait_return;
3066 State = save_State;
3067 #ifdef FEAT_MOUSE
3068 setmouse();
3069 #endif
3070 --no_mapping;
3071 --allow_keys;
3073 return r;
3077 * Get a key stroke directly from the user.
3078 * Ignores mouse clicks and scrollbar events, except a click for the left
3079 * button (used at the more prompt).
3080 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
3081 * Disadvantage: typeahead is ignored.
3082 * Translates the interrupt character for unix to ESC.
3085 get_keystroke()
3087 #define CBUFLEN 151
3088 char_u buf[CBUFLEN];
3089 int len = 0;
3090 int n;
3091 int save_mapped_ctrl_c = mapped_ctrl_c;
3092 int waited = 0;
3094 mapped_ctrl_c = FALSE; /* mappings are not used here */
3095 for (;;)
3097 cursor_on();
3098 out_flush();
3100 /* First time: blocking wait. Second time: wait up to 100ms for a
3101 * terminal code to complete. Leave some room for check_termcode() to
3102 * insert a key code into (max 5 chars plus NUL). And
3103 * fix_input_buffer() can triple the number of bytes. */
3104 n = ui_inchar(buf + len, (CBUFLEN - 6 - len) / 3,
3105 len == 0 ? -1L : 100L, 0);
3106 if (n > 0)
3108 /* Replace zero and CSI by a special key code. */
3109 n = fix_input_buffer(buf + len, n, FALSE);
3110 len += n;
3111 waited = 0;
3113 else if (len > 0)
3114 ++waited; /* keep track of the waiting time */
3116 /* Incomplete termcode and not timed out yet: get more characters */
3117 if ((n = check_termcode(1, buf, len)) < 0
3118 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
3119 continue;
3121 /* found a termcode: adjust length */
3122 if (n > 0)
3123 len = n;
3124 if (len == 0) /* nothing typed yet */
3125 continue;
3127 /* Handle modifier and/or special key code. */
3128 n = buf[0];
3129 if (n == K_SPECIAL)
3131 n = TO_SPECIAL(buf[1], buf[2]);
3132 if (buf[1] == KS_MODIFIER
3133 || n == K_IGNORE
3134 #ifdef FEAT_MOUSE
3135 || n == K_LEFTMOUSE_NM
3136 || n == K_LEFTDRAG
3137 || n == K_LEFTRELEASE
3138 || n == K_LEFTRELEASE_NM
3139 || n == K_MIDDLEMOUSE
3140 || n == K_MIDDLEDRAG
3141 || n == K_MIDDLERELEASE
3142 || n == K_RIGHTMOUSE
3143 || n == K_RIGHTDRAG
3144 || n == K_RIGHTRELEASE
3145 || n == K_MOUSEDOWN
3146 || n == K_MOUSEUP
3147 || n == K_X1MOUSE
3148 || n == K_X1DRAG
3149 || n == K_X1RELEASE
3150 || n == K_X2MOUSE
3151 || n == K_X2DRAG
3152 || n == K_X2RELEASE
3153 # ifdef FEAT_GUI
3154 || n == K_VER_SCROLLBAR
3155 || n == K_HOR_SCROLLBAR
3156 # endif
3157 #endif
3160 if (buf[1] == KS_MODIFIER)
3161 mod_mask = buf[2];
3162 len -= 3;
3163 if (len > 0)
3164 mch_memmove(buf, buf + 3, (size_t)len);
3165 continue;
3167 break;
3169 #ifdef FEAT_MBYTE
3170 if (has_mbyte)
3172 if (MB_BYTE2LEN(n) > len)
3173 continue; /* more bytes to get */
3174 buf[len >= CBUFLEN ? CBUFLEN - 1 : len] = NUL;
3175 n = (*mb_ptr2char)(buf);
3177 #endif
3178 #ifdef UNIX
3179 if (n == intr_char)
3180 n = ESC;
3181 #endif
3182 break;
3185 mapped_ctrl_c = save_mapped_ctrl_c;
3186 return n;
3190 * Get a number from the user.
3191 * When "mouse_used" is not NULL allow using the mouse.
3194 get_number(colon, mouse_used)
3195 int colon; /* allow colon to abort */
3196 int *mouse_used;
3198 int n = 0;
3199 int c;
3200 int typed = 0;
3202 if (mouse_used != NULL)
3203 *mouse_used = FALSE;
3205 /* When not printing messages, the user won't know what to type, return a
3206 * zero (as if CR was hit). */
3207 if (msg_silent != 0)
3208 return 0;
3210 #ifdef USE_ON_FLY_SCROLL
3211 dont_scroll = TRUE; /* disallow scrolling here */
3212 #endif
3213 ++no_mapping;
3214 ++allow_keys; /* no mapping here, but recognize keys */
3215 for (;;)
3217 windgoto(msg_row, msg_col);
3218 c = safe_vgetc();
3219 if (VIM_ISDIGIT(c))
3221 n = n * 10 + c - '0';
3222 msg_putchar(c);
3223 ++typed;
3225 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
3227 if (typed > 0)
3229 MSG_PUTS("\b \b");
3230 --typed;
3232 n /= 10;
3234 #ifdef FEAT_MOUSE
3235 else if (mouse_used != NULL && c == K_LEFTMOUSE)
3237 *mouse_used = TRUE;
3238 n = mouse_row + 1;
3239 break;
3241 #endif
3242 else if (n == 0 && c == ':' && colon)
3244 stuffcharReadbuff(':');
3245 if (!exmode_active)
3246 cmdline_row = msg_row;
3247 skip_redraw = TRUE; /* skip redraw once */
3248 do_redraw = FALSE;
3249 break;
3251 else if (c == CAR || c == NL || c == Ctrl_C || c == ESC)
3252 break;
3254 --no_mapping;
3255 --allow_keys;
3256 return n;
3260 * Ask the user to enter a number.
3261 * When "mouse_used" is not NULL allow using the mouse and in that case return
3262 * the line number.
3265 prompt_for_number(mouse_used)
3266 int *mouse_used;
3268 int i;
3269 int save_cmdline_row;
3270 int save_State;
3272 /* When using ":silent" assume that <CR> was entered. */
3273 if (mouse_used != NULL)
3274 MSG_PUTS(_("Type number and <Enter> or click with mouse (empty cancels): "));
3275 else
3276 MSG_PUTS(_("Type number and <Enter> (empty cancels): "));
3278 /* Set the state such that text can be selected/copied/pasted and we still
3279 * get mouse events. */
3280 save_cmdline_row = cmdline_row;
3281 cmdline_row = 0;
3282 save_State = State;
3283 State = CMDLINE;
3285 i = get_number(TRUE, mouse_used);
3286 if (KeyTyped)
3288 /* don't call wait_return() now */
3289 /* msg_putchar('\n'); */
3290 cmdline_row = msg_row - 1;
3291 need_wait_return = FALSE;
3292 msg_didany = FALSE;
3293 msg_didout = FALSE;
3295 else
3296 cmdline_row = save_cmdline_row;
3297 State = save_State;
3299 return i;
3302 void
3303 msgmore(n)
3304 long n;
3306 long pn;
3308 if (global_busy /* no messages now, wait until global is finished */
3309 || !messaging()) /* 'lazyredraw' set, don't do messages now */
3310 return;
3312 /* We don't want to overwrite another important message, but do overwrite
3313 * a previous "more lines" or "fewer lines" message, so that "5dd" and
3314 * then "put" reports the last action. */
3315 if (keep_msg != NULL && !keep_msg_more)
3316 return;
3318 if (n > 0)
3319 pn = n;
3320 else
3321 pn = -n;
3323 if (pn > p_report)
3325 if (pn == 1)
3327 if (n > 0)
3328 STRCPY(msg_buf, _("1 more line"));
3329 else
3330 STRCPY(msg_buf, _("1 line less"));
3332 else
3334 if (n > 0)
3335 sprintf((char *)msg_buf, _("%ld more lines"), pn);
3336 else
3337 sprintf((char *)msg_buf, _("%ld fewer lines"), pn);
3339 if (got_int)
3340 STRCAT(msg_buf, _(" (Interrupted)"));
3341 if (msg(msg_buf))
3343 set_keep_msg(msg_buf, 0);
3344 keep_msg_more = TRUE;
3350 * flush map and typeahead buffers and give a warning for an error
3352 void
3353 beep_flush()
3355 if (emsg_silent == 0)
3357 flush_buffers(FALSE);
3358 vim_beep();
3363 * give a warning for an error
3365 void
3366 vim_beep()
3368 if (emsg_silent == 0)
3370 if (p_vb
3371 #ifdef FEAT_GUI
3372 /* While the GUI is starting up the termcap is set for the GUI
3373 * but the output still goes to a terminal. */
3374 && !(gui.in_use && gui.starting)
3375 #endif
3378 out_str(T_VB);
3380 else
3382 #ifdef MSDOS
3384 * The number of beeps outputted is reduced to avoid having to wait
3385 * for all the beeps to finish. This is only a problem on systems
3386 * where the beeps don't overlap.
3388 if (beep_count == 0 || beep_count == 10)
3390 out_char(BELL);
3391 beep_count = 1;
3393 else
3394 ++beep_count;
3395 #else
3396 out_char(BELL);
3397 #endif
3400 /* When 'verbose' is set and we are sourcing a script or executing a
3401 * function give the user a hint where the beep comes from. */
3402 if (vim_strchr(p_debug, 'e') != NULL)
3404 msg_source(hl_attr(HLF_W));
3405 msg_attr((char_u *)_("Beep!"), hl_attr(HLF_W));
3411 * To get the "real" home directory:
3412 * - get value of $HOME
3413 * For Unix:
3414 * - go to that directory
3415 * - do mch_dirname() to get the real name of that directory.
3416 * This also works with mounts and links.
3417 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
3419 static char_u *homedir = NULL;
3421 void
3422 init_homedir()
3424 char_u *var;
3426 /* In case we are called a second time (when 'encoding' changes). */
3427 vim_free(homedir);
3428 homedir = NULL;
3430 #ifdef VMS
3431 var = mch_getenv((char_u *)"SYS$LOGIN");
3432 #else
3433 var = mch_getenv((char_u *)"HOME");
3434 #endif
3436 if (var != NULL && *var == NUL) /* empty is same as not set */
3437 var = NULL;
3439 #ifdef WIN3264
3441 * Weird but true: $HOME may contain an indirect reference to another
3442 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
3443 * when $HOME is being set.
3445 if (var != NULL && *var == '%')
3447 char_u *p;
3448 char_u *exp;
3450 p = vim_strchr(var + 1, '%');
3451 if (p != NULL)
3453 vim_strncpy(NameBuff, var + 1, p - (var + 1));
3454 exp = mch_getenv(NameBuff);
3455 if (exp != NULL && *exp != NUL
3456 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
3458 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
3459 var = NameBuff;
3460 /* Also set $HOME, it's needed for _viminfo. */
3461 vim_setenv((char_u *)"HOME", NameBuff);
3467 * Typically, $HOME is not defined on Windows, unless the user has
3468 * specifically defined it for Vim's sake. However, on Windows NT
3469 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
3470 * each user. Try constructing $HOME from these.
3472 if (var == NULL)
3474 char_u *homedrive, *homepath;
3476 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
3477 homepath = mch_getenv((char_u *)"HOMEPATH");
3478 if (homepath == NULL || *homepath == NUL)
3479 homepath = "\\";
3480 if (homedrive != NULL
3481 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
3483 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
3484 if (NameBuff[0] != NUL)
3486 var = NameBuff;
3487 /* Also set $HOME, it's needed for _viminfo. */
3488 vim_setenv((char_u *)"HOME", NameBuff);
3493 # if defined(FEAT_MBYTE)
3494 if (enc_utf8 && var != NULL)
3496 int len;
3497 char_u *pp;
3499 /* Convert from active codepage to UTF-8. Other conversions are
3500 * not done, because they would fail for non-ASCII characters. */
3501 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
3502 if (pp != NULL)
3504 homedir = pp;
3505 return;
3508 # endif
3509 #endif
3511 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3513 * Default home dir is C:/
3514 * Best assumption we can make in such a situation.
3516 if (var == NULL)
3517 var = "C:/";
3518 #endif
3519 if (var != NULL)
3521 #ifdef UNIX
3523 * Change to the directory and get the actual path. This resolves
3524 * links. Don't do it when we can't return.
3526 if (mch_dirname(NameBuff, MAXPATHL) == OK
3527 && mch_chdir((char *)NameBuff) == 0)
3529 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
3530 var = IObuff;
3531 if (mch_chdir((char *)NameBuff) != 0)
3532 EMSG(_(e_prev_dir));
3534 #endif
3535 homedir = vim_strsave(var);
3539 #if defined(EXITFREE) || defined(PROTO)
3540 void
3541 free_homedir()
3543 vim_free(homedir);
3545 #endif
3548 * Call expand_env() and store the result in an allocated string.
3549 * This is not very memory efficient, this expects the result to be freed
3550 * again soon.
3552 char_u *
3553 expand_env_save(src)
3554 char_u *src;
3556 return expand_env_save_opt(src, FALSE);
3560 * Idem, but when "one" is TRUE handle the string as one file name, only
3561 * expand "~" at the start.
3563 char_u *
3564 expand_env_save_opt(src, one)
3565 char_u *src;
3566 int one;
3568 char_u *p;
3570 p = alloc(MAXPATHL);
3571 if (p != NULL)
3572 expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
3573 return p;
3577 * Expand environment variable with path name.
3578 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
3579 * Skips over "\ ", "\~" and "\$" (not for Win32 though).
3580 * If anything fails no expansion is done and dst equals src.
3582 void
3583 expand_env(src, dst, dstlen)
3584 char_u *src; /* input string e.g. "$HOME/vim.hlp" */
3585 char_u *dst; /* where to put the result */
3586 int dstlen; /* maximum length of the result */
3588 expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
3591 void
3592 expand_env_esc(srcp, dst, dstlen, esc, one, startstr)
3593 char_u *srcp; /* input string e.g. "$HOME/vim.hlp" */
3594 char_u *dst; /* where to put the result */
3595 int dstlen; /* maximum length of the result */
3596 int esc; /* escape spaces in expanded variables */
3597 int one; /* "srcp" is one file name */
3598 char_u *startstr; /* start again after this (can be NULL) */
3600 char_u *src;
3601 char_u *tail;
3602 int c;
3603 char_u *var;
3604 int copy_char;
3605 int mustfree; /* var was allocated, need to free it later */
3606 int at_start = TRUE; /* at start of a name */
3607 int startstr_len = 0;
3609 if (startstr != NULL)
3610 startstr_len = (int)STRLEN(startstr);
3612 src = skipwhite(srcp);
3613 --dstlen; /* leave one char space for "\," */
3614 while (*src && dstlen > 0)
3616 copy_char = TRUE;
3617 if ((*src == '$'
3618 #ifdef VMS
3619 && at_start
3620 #endif
3622 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3623 || *src == '%'
3624 #endif
3625 || (*src == '~' && at_start))
3627 mustfree = FALSE;
3630 * The variable name is copied into dst temporarily, because it may
3631 * be a string in read-only memory and a NUL needs to be appended.
3633 if (*src != '~') /* environment var */
3635 tail = src + 1;
3636 var = dst;
3637 c = dstlen - 1;
3639 #ifdef UNIX
3640 /* Unix has ${var-name} type environment vars */
3641 if (*tail == '{' && !vim_isIDc('{'))
3643 tail++; /* ignore '{' */
3644 while (c-- > 0 && *tail && *tail != '}')
3645 *var++ = *tail++;
3647 else
3648 #endif
3650 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
3651 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3652 || (*src == '%' && *tail != '%')
3653 #endif
3656 #ifdef OS2 /* env vars only in uppercase */
3657 *var++ = TOUPPER_LOC(*tail);
3658 tail++; /* toupper() may be a macro! */
3659 #else
3660 *var++ = *tail++;
3661 #endif
3665 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3666 # ifdef UNIX
3667 if (src[1] == '{' && *tail != '}')
3668 # else
3669 if (*src == '%' && *tail != '%')
3670 # endif
3671 var = NULL;
3672 else
3674 # ifdef UNIX
3675 if (src[1] == '{')
3676 # else
3677 if (*src == '%')
3678 #endif
3679 ++tail;
3680 #endif
3681 *var = NUL;
3682 var = vim_getenv(dst, &mustfree);
3683 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3685 #endif
3687 /* home directory */
3688 else if ( src[1] == NUL
3689 || vim_ispathsep(src[1])
3690 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
3692 var = homedir;
3693 tail = src + 1;
3695 else /* user directory */
3697 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
3699 * Copy ~user to dst[], so we can put a NUL after it.
3701 tail = src;
3702 var = dst;
3703 c = dstlen - 1;
3704 while ( c-- > 0
3705 && *tail
3706 && vim_isfilec(*tail)
3707 && !vim_ispathsep(*tail))
3708 *var++ = *tail++;
3709 *var = NUL;
3710 # ifdef UNIX
3712 * If the system supports getpwnam(), use it.
3713 * Otherwise, or if getpwnam() fails, the shell is used to
3714 * expand ~user. This is slower and may fail if the shell
3715 * does not support ~user (old versions of /bin/sh).
3717 # if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
3719 struct passwd *pw;
3721 /* Note: memory allocated by getpwnam() is never freed.
3722 * Calling endpwent() apparently doesn't help. */
3723 pw = getpwnam((char *)dst + 1);
3724 if (pw != NULL)
3725 var = (char_u *)pw->pw_dir;
3726 else
3727 var = NULL;
3729 if (var == NULL)
3730 # endif
3732 expand_T xpc;
3734 ExpandInit(&xpc);
3735 xpc.xp_context = EXPAND_FILES;
3736 var = ExpandOne(&xpc, dst, NULL,
3737 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
3738 mustfree = TRUE;
3741 # else /* !UNIX, thus VMS */
3743 * USER_HOME is a comma-separated list of
3744 * directories to search for the user account in.
3747 char_u test[MAXPATHL], paths[MAXPATHL];
3748 char_u *path, *next_path, *ptr;
3749 struct stat st;
3751 STRCPY(paths, USER_HOME);
3752 next_path = paths;
3753 while (*next_path)
3755 for (path = next_path; *next_path && *next_path != ',';
3756 next_path++);
3757 if (*next_path)
3758 *next_path++ = NUL;
3759 STRCPY(test, path);
3760 STRCAT(test, "/");
3761 STRCAT(test, dst + 1);
3762 if (mch_stat(test, &st) == 0)
3764 var = alloc(STRLEN(test) + 1);
3765 STRCPY(var, test);
3766 mustfree = TRUE;
3767 break;
3771 # endif /* UNIX */
3772 #else
3773 /* cannot expand user's home directory, so don't try */
3774 var = NULL;
3775 tail = (char_u *)""; /* for gcc */
3776 #endif /* UNIX || VMS */
3779 #ifdef BACKSLASH_IN_FILENAME
3780 /* If 'shellslash' is set change backslashes to forward slashes.
3781 * Can't use slash_adjust(), p_ssl may be set temporarily. */
3782 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
3784 char_u *p = vim_strsave(var);
3786 if (p != NULL)
3788 if (mustfree)
3789 vim_free(var);
3790 var = p;
3791 mustfree = TRUE;
3792 forward_slash(var);
3795 #endif
3797 /* If "var" contains white space, escape it with a backslash.
3798 * Required for ":e ~/tt" when $HOME includes a space. */
3799 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
3801 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
3803 if (p != NULL)
3805 if (mustfree)
3806 vim_free(var);
3807 var = p;
3808 mustfree = TRUE;
3812 if (var != NULL && *var != NUL
3813 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
3815 STRCPY(dst, var);
3816 dstlen -= (int)STRLEN(var);
3817 c = (int)STRLEN(var);
3818 /* if var[] ends in a path separator and tail[] starts
3819 * with it, skip a character */
3820 if (*var != NUL && after_pathsep(dst, dst + c)
3821 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
3822 && dst[-1] != ':'
3823 #endif
3824 && vim_ispathsep(*tail))
3825 ++tail;
3826 dst += c;
3827 src = tail;
3828 copy_char = FALSE;
3830 if (mustfree)
3831 vim_free(var);
3834 if (copy_char) /* copy at least one char */
3837 * Recognize the start of a new name, for '~'.
3838 * Don't do this when "one" is TRUE, to avoid expanding "~" in
3839 * ":edit foo ~ foo".
3841 at_start = FALSE;
3842 if (src[0] == '\\' && src[1] != NUL)
3844 *dst++ = *src++;
3845 --dstlen;
3847 else if ((src[0] == ' ' || src[0] == ',') && !one)
3848 at_start = TRUE;
3849 *dst++ = *src++;
3850 --dstlen;
3852 if (startstr != NULL && src - startstr_len >= srcp
3853 && STRNCMP(src - startstr_len, startstr, startstr_len) == 0)
3854 at_start = TRUE;
3857 *dst = NUL;
3861 * Vim's version of getenv().
3862 * Special handling of $HOME, $VIM and $VIMRUNTIME.
3863 * Also does ACP to 'enc' conversion for Win32.
3865 char_u *
3866 vim_getenv(name, mustfree)
3867 char_u *name;
3868 int *mustfree; /* set to TRUE when returned is allocated */
3870 char_u *p;
3871 char_u *pend;
3872 int vimruntime;
3874 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3875 /* use "C:/" when $HOME is not set */
3876 if (STRCMP(name, "HOME") == 0)
3877 return homedir;
3878 #endif
3880 p = mch_getenv(name);
3881 if (p != NULL && *p == NUL) /* empty is the same as not set */
3882 p = NULL;
3884 if (p != NULL)
3886 #if defined(FEAT_MBYTE) && defined(WIN3264)
3887 if (enc_utf8)
3889 int len;
3890 char_u *pp;
3892 /* Convert from active codepage to UTF-8. Other conversions are
3893 * not done, because they would fail for non-ASCII characters. */
3894 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3895 if (pp != NULL)
3897 p = pp;
3898 *mustfree = TRUE;
3901 #endif
3902 return p;
3905 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
3906 if (!vimruntime && STRCMP(name, "VIM") != 0)
3907 return NULL;
3910 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
3911 * Don't do this when default_vimruntime_dir is non-empty.
3913 if (vimruntime
3914 #ifdef HAVE_PATHDEF
3915 && *default_vimruntime_dir == NUL
3916 #endif
3919 p = mch_getenv((char_u *)"VIM");
3920 if (p != NULL && *p == NUL) /* empty is the same as not set */
3921 p = NULL;
3922 if (p != NULL)
3924 p = vim_version_dir(p);
3925 if (p != NULL)
3926 *mustfree = TRUE;
3927 else
3928 p = mch_getenv((char_u *)"VIM");
3930 #if defined(FEAT_MBYTE) && defined(WIN3264)
3931 if (enc_utf8)
3933 int len;
3934 char_u *pp;
3936 /* Convert from active codepage to UTF-8. Other conversions
3937 * are not done, because they would fail for non-ASCII
3938 * characters. */
3939 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3940 if (pp != NULL)
3942 if (mustfree)
3943 vim_free(p);
3944 p = pp;
3945 *mustfree = TRUE;
3948 #endif
3953 * When expanding $VIM or $VIMRUNTIME fails, try using:
3954 * - the directory name from 'helpfile' (unless it contains '$')
3955 * - the executable name from argv[0]
3957 if (p == NULL)
3959 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
3960 p = p_hf;
3961 #ifdef USE_EXE_NAME
3963 * Use the name of the executable, obtained from argv[0].
3965 else
3966 p = exe_name;
3967 #endif
3968 if (p != NULL)
3970 /* remove the file name */
3971 pend = gettail(p);
3973 /* remove "doc/" from 'helpfile', if present */
3974 if (p == p_hf)
3975 pend = remove_tail(p, pend, (char_u *)"doc");
3977 #ifdef USE_EXE_NAME
3978 # ifdef MACOS_X
3979 /* remove "MacOS" from exe_name and add "Resources/vim" */
3980 if (p == exe_name)
3982 char_u *pend1;
3983 char_u *pnew;
3985 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
3986 if (pend1 != pend)
3988 pnew = alloc((unsigned)(pend1 - p) + 15);
3989 if (pnew != NULL)
3991 STRNCPY(pnew, p, (pend1 - p));
3992 STRCPY(pnew + (pend1 - p), "Resources/vim");
3993 p = pnew;
3994 pend = p + STRLEN(p);
3998 # endif
3999 /* remove "src/" from exe_name, if present */
4000 if (p == exe_name)
4001 pend = remove_tail(p, pend, (char_u *)"src");
4002 #endif
4004 /* for $VIM, remove "runtime/" or "vim54/", if present */
4005 if (!vimruntime)
4007 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
4008 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
4011 /* remove trailing path separator */
4012 #ifndef MACOS_CLASSIC
4013 /* With MacOS path (with colons) the final colon is required */
4014 /* to avoid confusion between absolute and relative path */
4015 if (pend > p && after_pathsep(p, pend))
4016 --pend;
4017 #endif
4019 #ifdef MACOS_X
4020 if (p == exe_name || p == p_hf)
4021 #endif
4022 /* check that the result is a directory name */
4023 p = vim_strnsave(p, (int)(pend - p));
4025 if (p != NULL && !mch_isdir(p))
4027 vim_free(p);
4028 p = NULL;
4030 else
4032 #ifdef USE_EXE_NAME
4033 /* may add "/vim54" or "/runtime" if it exists */
4034 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
4036 vim_free(p);
4037 p = pend;
4039 #endif
4040 *mustfree = TRUE;
4045 #ifdef HAVE_PATHDEF
4046 /* When there is a pathdef.c file we can use default_vim_dir and
4047 * default_vimruntime_dir */
4048 if (p == NULL)
4050 /* Only use default_vimruntime_dir when it is not empty */
4051 if (vimruntime && *default_vimruntime_dir != NUL)
4053 p = default_vimruntime_dir;
4054 *mustfree = FALSE;
4056 else if (*default_vim_dir != NUL)
4058 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
4059 *mustfree = TRUE;
4060 else
4062 p = default_vim_dir;
4063 *mustfree = FALSE;
4067 #endif
4070 * Set the environment variable, so that the new value can be found fast
4071 * next time, and others can also use it (e.g. Perl).
4073 if (p != NULL)
4075 if (vimruntime)
4077 vim_setenv((char_u *)"VIMRUNTIME", p);
4078 didset_vimruntime = TRUE;
4079 #ifdef FEAT_GETTEXT
4081 char_u *buf = concat_str(p, (char_u *)"/lang");
4083 if (buf != NULL)
4085 bindtextdomain(VIMPACKAGE, (char *)buf);
4086 vim_free(buf);
4089 #endif
4091 else
4093 vim_setenv((char_u *)"VIM", p);
4094 didset_vim = TRUE;
4097 return p;
4101 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
4102 * Return NULL if not, return its name in allocated memory otherwise.
4104 static char_u *
4105 vim_version_dir(vimdir)
4106 char_u *vimdir;
4108 char_u *p;
4110 if (vimdir == NULL || *vimdir == NUL)
4111 return NULL;
4112 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
4113 if (p != NULL && mch_isdir(p))
4114 return p;
4115 vim_free(p);
4116 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
4117 if (p != NULL && mch_isdir(p))
4118 return p;
4119 vim_free(p);
4120 return NULL;
4124 * If the string between "p" and "pend" ends in "name/", return "pend" minus
4125 * the length of "name/". Otherwise return "pend".
4127 static char_u *
4128 remove_tail(p, pend, name)
4129 char_u *p;
4130 char_u *pend;
4131 char_u *name;
4133 int len = (int)STRLEN(name) + 1;
4134 char_u *newend = pend - len;
4136 if (newend >= p
4137 && fnamencmp(newend, name, len - 1) == 0
4138 && (newend == p || after_pathsep(p, newend)))
4139 return newend;
4140 return pend;
4144 * Our portable version of setenv.
4146 void
4147 vim_setenv(name, val)
4148 char_u *name;
4149 char_u *val;
4151 #ifdef HAVE_SETENV
4152 mch_setenv((char *)name, (char *)val, 1);
4153 #else
4154 char_u *envbuf;
4157 * Putenv does not copy the string, it has to remain
4158 * valid. The allocated memory will never be freed.
4160 envbuf = alloc((unsigned)(STRLEN(name) + STRLEN(val) + 2));
4161 if (envbuf != NULL)
4163 sprintf((char *)envbuf, "%s=%s", name, val);
4164 putenv((char *)envbuf);
4166 #endif
4169 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4171 * Function given to ExpandGeneric() to obtain an environment variable name.
4173 char_u *
4174 get_env_name(xp, idx)
4175 expand_T *xp UNUSED;
4176 int idx;
4178 # if defined(AMIGA) || defined(__MRC__) || defined(__SC__)
4180 * No environ[] on the Amiga and on the Mac (using MPW).
4182 return NULL;
4183 # else
4184 # ifndef __WIN32__
4185 /* Borland C++ 5.2 has this in a header file. */
4186 extern char **environ;
4187 # endif
4188 # define ENVNAMELEN 100
4189 static char_u name[ENVNAMELEN];
4190 char_u *str;
4191 int n;
4193 str = (char_u *)environ[idx];
4194 if (str == NULL)
4195 return NULL;
4197 for (n = 0; n < ENVNAMELEN - 1; ++n)
4199 if (str[n] == '=' || str[n] == NUL)
4200 break;
4201 name[n] = str[n];
4203 name[n] = NUL;
4204 return name;
4205 # endif
4207 #endif
4210 * Replace home directory by "~" in each space or comma separated file name in
4211 * 'src'.
4212 * If anything fails (except when out of space) dst equals src.
4214 void
4215 home_replace(buf, src, dst, dstlen, one)
4216 buf_T *buf; /* when not NULL, check for help files */
4217 char_u *src; /* input file name */
4218 char_u *dst; /* where to put the result */
4219 int dstlen; /* maximum length of the result */
4220 int one; /* if TRUE, only replace one file name, include
4221 spaces and commas in the file name. */
4223 size_t dirlen = 0, envlen = 0;
4224 size_t len;
4225 char_u *homedir_env;
4226 char_u *p;
4228 if (src == NULL)
4230 *dst = NUL;
4231 return;
4235 * If the file is a help file, remove the path completely.
4237 if (buf != NULL && buf->b_help)
4239 STRCPY(dst, gettail(src));
4240 return;
4244 * We check both the value of the $HOME environment variable and the
4245 * "real" home directory.
4247 if (homedir != NULL)
4248 dirlen = STRLEN(homedir);
4250 #ifdef VMS
4251 homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
4252 #else
4253 homedir_env = mch_getenv((char_u *)"HOME");
4254 #endif
4256 if (homedir_env != NULL && *homedir_env == NUL)
4257 homedir_env = NULL;
4258 if (homedir_env != NULL)
4259 envlen = STRLEN(homedir_env);
4261 if (!one)
4262 src = skipwhite(src);
4263 while (*src && dstlen > 0)
4266 * Here we are at the beginning of a file name.
4267 * First, check to see if the beginning of the file name matches
4268 * $HOME or the "real" home directory. Check that there is a '/'
4269 * after the match (so that if e.g. the file is "/home/pieter/bla",
4270 * and the home directory is "/home/piet", the file does not end up
4271 * as "~er/bla" (which would seem to indicate the file "bla" in user
4272 * er's home directory)).
4274 p = homedir;
4275 len = dirlen;
4276 for (;;)
4278 if ( len
4279 && fnamencmp(src, p, len) == 0
4280 && (vim_ispathsep(src[len])
4281 || (!one && (src[len] == ',' || src[len] == ' '))
4282 || src[len] == NUL))
4284 src += len;
4285 if (--dstlen > 0)
4286 *dst++ = '~';
4289 * If it's just the home directory, add "/".
4291 if (!vim_ispathsep(src[0]) && --dstlen > 0)
4292 *dst++ = '/';
4293 break;
4295 if (p == homedir_env)
4296 break;
4297 p = homedir_env;
4298 len = envlen;
4301 /* if (!one) skip to separator: space or comma */
4302 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
4303 *dst++ = *src++;
4304 /* skip separator */
4305 while ((*src == ' ' || *src == ',') && --dstlen > 0)
4306 *dst++ = *src++;
4308 /* if (dstlen == 0) out of space, what to do??? */
4310 *dst = NUL;
4314 * Like home_replace, store the replaced string in allocated memory.
4315 * When something fails, NULL is returned.
4317 char_u *
4318 home_replace_save(buf, src)
4319 buf_T *buf; /* when not NULL, check for help files */
4320 char_u *src; /* input file name */
4322 char_u *dst;
4323 unsigned len;
4325 len = 3; /* space for "~/" and trailing NUL */
4326 if (src != NULL) /* just in case */
4327 len += (unsigned)STRLEN(src);
4328 dst = alloc(len);
4329 if (dst != NULL)
4330 home_replace(buf, src, dst, len, TRUE);
4331 return dst;
4335 * Compare two file names and return:
4336 * FPC_SAME if they both exist and are the same file.
4337 * FPC_SAMEX if they both don't exist and have the same file name.
4338 * FPC_DIFF if they both exist and are different files.
4339 * FPC_NOTX if they both don't exist.
4340 * FPC_DIFFX if one of them doesn't exist.
4341 * For the first name environment variables are expanded
4344 fullpathcmp(s1, s2, checkname)
4345 char_u *s1, *s2;
4346 int checkname; /* when both don't exist, check file names */
4348 #ifdef UNIX
4349 char_u exp1[MAXPATHL];
4350 char_u full1[MAXPATHL];
4351 char_u full2[MAXPATHL];
4352 struct stat st1, st2;
4353 int r1, r2;
4355 expand_env(s1, exp1, MAXPATHL);
4356 r1 = mch_stat((char *)exp1, &st1);
4357 r2 = mch_stat((char *)s2, &st2);
4358 if (r1 != 0 && r2 != 0)
4360 /* if mch_stat() doesn't work, may compare the names */
4361 if (checkname)
4363 if (fnamecmp(exp1, s2) == 0)
4364 return FPC_SAMEX;
4365 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4366 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4367 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
4368 return FPC_SAMEX;
4370 return FPC_NOTX;
4372 if (r1 != 0 || r2 != 0)
4373 return FPC_DIFFX;
4374 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
4375 return FPC_SAME;
4376 return FPC_DIFF;
4377 #else
4378 char_u *exp1; /* expanded s1 */
4379 char_u *full1; /* full path of s1 */
4380 char_u *full2; /* full path of s2 */
4381 int retval = FPC_DIFF;
4382 int r1, r2;
4384 /* allocate one buffer to store three paths (alloc()/free() is slow!) */
4385 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
4387 full1 = exp1 + MAXPATHL;
4388 full2 = full1 + MAXPATHL;
4390 expand_env(s1, exp1, MAXPATHL);
4391 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4392 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4394 /* If vim_FullName() fails, the file probably doesn't exist. */
4395 if (r1 != OK && r2 != OK)
4397 if (checkname && fnamecmp(exp1, s2) == 0)
4398 retval = FPC_SAMEX;
4399 else
4400 retval = FPC_NOTX;
4402 else if (r1 != OK || r2 != OK)
4403 retval = FPC_DIFFX;
4404 else if (fnamecmp(full1, full2))
4405 retval = FPC_DIFF;
4406 else
4407 retval = FPC_SAME;
4408 vim_free(exp1);
4410 return retval;
4411 #endif
4415 * Get the tail of a path: the file name.
4416 * Fail safe: never returns NULL.
4418 char_u *
4419 gettail(fname)
4420 char_u *fname;
4422 char_u *p1, *p2;
4424 if (fname == NULL)
4425 return (char_u *)"";
4426 for (p1 = p2 = fname; *p2; ) /* find last part of path */
4428 if (vim_ispathsep(*p2))
4429 p1 = p2 + 1;
4430 mb_ptr_adv(p2);
4432 return p1;
4436 * Get pointer to tail of "fname", including path separators. Putting a NUL
4437 * here leaves the directory name. Takes care of "c:/" and "//".
4438 * Always returns a valid pointer.
4440 char_u *
4441 gettail_sep(fname)
4442 char_u *fname;
4444 char_u *p;
4445 char_u *t;
4447 p = get_past_head(fname); /* don't remove the '/' from "c:/file" */
4448 t = gettail(fname);
4449 while (t > p && after_pathsep(fname, t))
4450 --t;
4451 #ifdef VMS
4452 /* path separator is part of the path */
4453 ++t;
4454 #endif
4455 return t;
4459 * get the next path component (just after the next path separator).
4461 char_u *
4462 getnextcomp(fname)
4463 char_u *fname;
4465 while (*fname && !vim_ispathsep(*fname))
4466 mb_ptr_adv(fname);
4467 if (*fname)
4468 ++fname;
4469 return fname;
4473 * Get a pointer to one character past the head of a path name.
4474 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
4475 * If there is no head, path is returned.
4477 char_u *
4478 get_past_head(path)
4479 char_u *path;
4481 char_u *retval;
4483 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4484 /* may skip "c:" */
4485 if (isalpha(path[0]) && path[1] == ':')
4486 retval = path + 2;
4487 else
4488 retval = path;
4489 #else
4490 # if defined(AMIGA)
4491 /* may skip "label:" */
4492 retval = vim_strchr(path, ':');
4493 if (retval == NULL)
4494 retval = path;
4495 # else /* Unix */
4496 retval = path;
4497 # endif
4498 #endif
4500 while (vim_ispathsep(*retval))
4501 ++retval;
4503 return retval;
4507 * return TRUE if 'c' is a path separator.
4510 vim_ispathsep(c)
4511 int c;
4513 #ifdef RISCOS
4514 return (c == '.' || c == ':');
4515 #else
4516 # ifdef UNIX
4517 return (c == '/'); /* UNIX has ':' inside file names */
4518 # else
4519 # ifdef BACKSLASH_IN_FILENAME
4520 return (c == ':' || c == '/' || c == '\\');
4521 # else
4522 # ifdef VMS
4523 /* server"user passwd"::device:[full.path.name]fname.extension;version" */
4524 return (c == ':' || c == '[' || c == ']' || c == '/'
4525 || c == '<' || c == '>' || c == '"' );
4526 # else /* Amiga */
4527 return (c == ':' || c == '/');
4528 # endif /* VMS */
4529 # endif
4530 # endif
4531 #endif /* RISC OS */
4534 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
4536 * return TRUE if 'c' is a path list separator.
4539 vim_ispathlistsep(c)
4540 int c;
4542 #ifdef UNIX
4543 return (c == ':');
4544 #else
4545 return (c == ';'); /* might not be right for every system... */
4546 #endif
4548 #endif
4550 #if defined(FEAT_GUI_TABLINE) || defined(FEAT_WINDOWS) \
4551 || defined(FEAT_EVAL) || defined(PROTO)
4553 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
4554 * It's done in-place.
4556 void
4557 shorten_dir(str)
4558 char_u *str;
4560 char_u *tail, *s, *d;
4561 int skip = FALSE;
4563 tail = gettail(str);
4564 d = str;
4565 for (s = str; ; ++s)
4567 if (s >= tail) /* copy the whole tail */
4569 *d++ = *s;
4570 if (*s == NUL)
4571 break;
4573 else if (vim_ispathsep(*s)) /* copy '/' and next char */
4575 *d++ = *s;
4576 skip = FALSE;
4578 else if (!skip)
4580 *d++ = *s; /* copy next char */
4581 if (*s != '~' && *s != '.') /* and leading "~" and "." */
4582 skip = TRUE;
4583 # ifdef FEAT_MBYTE
4584 if (has_mbyte)
4586 int l = mb_ptr2len(s);
4588 while (--l > 0)
4589 *d++ = *++s;
4591 # endif
4595 #endif
4598 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
4599 * Also returns TRUE if there is no directory name.
4600 * "fname" must be writable!.
4603 dir_of_file_exists(fname)
4604 char_u *fname;
4606 char_u *p;
4607 int c;
4608 int retval;
4610 p = gettail_sep(fname);
4611 if (p == fname)
4612 return TRUE;
4613 c = *p;
4614 *p = NUL;
4615 retval = mch_isdir(fname);
4616 *p = c;
4617 return retval;
4620 #if (defined(CASE_INSENSITIVE_FILENAME) && defined(BACKSLASH_IN_FILENAME)) \
4621 || defined(PROTO)
4623 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally.
4626 vim_fnamecmp(x, y)
4627 char_u *x, *y;
4629 return vim_fnamencmp(x, y, MAXPATHL);
4633 vim_fnamencmp(x, y, len)
4634 char_u *x, *y;
4635 size_t len;
4637 while (len > 0 && *x && *y)
4639 if (TOLOWER_LOC(*x) != TOLOWER_LOC(*y)
4640 && !(*x == '/' && *y == '\\')
4641 && !(*x == '\\' && *y == '/'))
4642 break;
4643 ++x;
4644 ++y;
4645 --len;
4647 if (len == 0)
4648 return 0;
4649 return (*x - *y);
4651 #endif
4654 * Concatenate file names fname1 and fname2 into allocated memory.
4655 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
4657 char_u *
4658 concat_fnames(fname1, fname2, sep)
4659 char_u *fname1;
4660 char_u *fname2;
4661 int sep;
4663 char_u *dest;
4665 dest = alloc((unsigned)(STRLEN(fname1) + STRLEN(fname2) + 3));
4666 if (dest != NULL)
4668 STRCPY(dest, fname1);
4669 if (sep)
4670 add_pathsep(dest);
4671 STRCAT(dest, fname2);
4673 return dest;
4677 * Concatenate two strings and return the result in allocated memory.
4678 * Returns NULL when out of memory.
4680 char_u *
4681 concat_str(str1, str2)
4682 char_u *str1;
4683 char_u *str2;
4685 char_u *dest;
4686 size_t l = STRLEN(str1);
4688 dest = alloc((unsigned)(l + STRLEN(str2) + 1L));
4689 if (dest != NULL)
4691 STRCPY(dest, str1);
4692 STRCPY(dest + l, str2);
4694 return dest;
4698 * Add a path separator to a file name, unless it already ends in a path
4699 * separator.
4701 void
4702 add_pathsep(p)
4703 char_u *p;
4705 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
4706 STRCAT(p, PATHSEPSTR);
4710 * FullName_save - Make an allocated copy of a full file name.
4711 * Returns NULL when out of memory.
4713 char_u *
4714 FullName_save(fname, force)
4715 char_u *fname;
4716 int force; /* force expansion, even when it already looks
4717 like a full path name */
4719 char_u *buf;
4720 char_u *new_fname = NULL;
4722 if (fname == NULL)
4723 return NULL;
4725 buf = alloc((unsigned)MAXPATHL);
4726 if (buf != NULL)
4728 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
4729 new_fname = vim_strsave(buf);
4730 else
4731 new_fname = vim_strsave(fname);
4732 vim_free(buf);
4734 return new_fname;
4737 #if defined(FEAT_CINDENT) || defined(FEAT_SYN_HL)
4739 static char_u *skip_string __ARGS((char_u *p));
4742 * Find the start of a comment, not knowing if we are in a comment right now.
4743 * Search starts at w_cursor.lnum and goes backwards.
4745 pos_T *
4746 find_start_comment(ind_maxcomment) /* XXX */
4747 int ind_maxcomment;
4749 pos_T *pos;
4750 char_u *line;
4751 char_u *p;
4752 int cur_maxcomment = ind_maxcomment;
4754 for (;;)
4756 pos = findmatchlimit(NULL, '*', FM_BACKWARD, cur_maxcomment);
4757 if (pos == NULL)
4758 break;
4761 * Check if the comment start we found is inside a string.
4762 * If it is then restrict the search to below this line and try again.
4764 line = ml_get(pos->lnum);
4765 for (p = line; *p && (colnr_T)(p - line) < pos->col; ++p)
4766 p = skip_string(p);
4767 if ((colnr_T)(p - line) <= pos->col)
4768 break;
4769 cur_maxcomment = curwin->w_cursor.lnum - pos->lnum - 1;
4770 if (cur_maxcomment <= 0)
4772 pos = NULL;
4773 break;
4776 return pos;
4780 * Skip to the end of a "string" and a 'c' character.
4781 * If there is no string or character, return argument unmodified.
4783 static char_u *
4784 skip_string(p)
4785 char_u *p;
4787 int i;
4790 * We loop, because strings may be concatenated: "date""time".
4792 for ( ; ; ++p)
4794 if (p[0] == '\'') /* 'c' or '\n' or '\000' */
4796 if (!p[1]) /* ' at end of line */
4797 break;
4798 i = 2;
4799 if (p[1] == '\\') /* '\n' or '\000' */
4801 ++i;
4802 while (vim_isdigit(p[i - 1])) /* '\000' */
4803 ++i;
4805 if (p[i] == '\'') /* check for trailing ' */
4807 p += i;
4808 continue;
4811 else if (p[0] == '"') /* start of string */
4813 for (++p; p[0]; ++p)
4815 if (p[0] == '\\' && p[1] != NUL)
4816 ++p;
4817 else if (p[0] == '"') /* end of string */
4818 break;
4820 if (p[0] == '"')
4821 continue;
4823 break; /* no string found */
4825 if (!*p)
4826 --p; /* backup from NUL */
4827 return p;
4829 #endif /* FEAT_CINDENT || FEAT_SYN_HL */
4831 #if defined(FEAT_CINDENT) || defined(PROTO)
4834 * Do C or expression indenting on the current line.
4836 void
4837 do_c_expr_indent()
4839 # ifdef FEAT_EVAL
4840 if (*curbuf->b_p_inde != NUL)
4841 fixthisline(get_expr_indent);
4842 else
4843 # endif
4844 fixthisline(get_c_indent);
4848 * Functions for C-indenting.
4849 * Most of this originally comes from Eric Fischer.
4852 * Below "XXX" means that this function may unlock the current line.
4855 static char_u *cin_skipcomment __ARGS((char_u *));
4856 static int cin_nocode __ARGS((char_u *));
4857 static pos_T *find_line_comment __ARGS((void));
4858 static int cin_islabel_skip __ARGS((char_u **));
4859 static int cin_isdefault __ARGS((char_u *));
4860 static char_u *after_label __ARGS((char_u *l));
4861 static int get_indent_nolabel __ARGS((linenr_T lnum));
4862 static int skip_label __ARGS((linenr_T, char_u **pp, int ind_maxcomment));
4863 static int cin_first_id_amount __ARGS((void));
4864 static int cin_get_equal_amount __ARGS((linenr_T lnum));
4865 static int cin_ispreproc __ARGS((char_u *));
4866 static int cin_ispreproc_cont __ARGS((char_u **pp, linenr_T *lnump));
4867 static int cin_iscomment __ARGS((char_u *));
4868 static int cin_islinecomment __ARGS((char_u *));
4869 static int cin_isterminated __ARGS((char_u *, int, int));
4870 static int cin_isinit __ARGS((void));
4871 static int cin_isfuncdecl __ARGS((char_u **, linenr_T));
4872 static int cin_isif __ARGS((char_u *));
4873 static int cin_iselse __ARGS((char_u *));
4874 static int cin_isdo __ARGS((char_u *));
4875 static int cin_iswhileofdo __ARGS((char_u *, linenr_T, int));
4876 static int cin_iswhileofdo_end __ARGS((int terminated, int ind_maxparen, int ind_maxcomment));
4877 static int cin_isbreak __ARGS((char_u *));
4878 static int cin_is_cpp_baseclass __ARGS((colnr_T *col));
4879 static int get_baseclass_amount __ARGS((int col, int ind_maxparen, int ind_maxcomment, int ind_cpp_baseclass));
4880 static int cin_ends_in __ARGS((char_u *, char_u *, char_u *));
4881 static int cin_skip2pos __ARGS((pos_T *trypos));
4882 static pos_T *find_start_brace __ARGS((int));
4883 static pos_T *find_match_paren __ARGS((int, int));
4884 static int corr_ind_maxparen __ARGS((int ind_maxparen, pos_T *startpos));
4885 static int find_last_paren __ARGS((char_u *l, int start, int end));
4886 static int find_match __ARGS((int lookfor, linenr_T ourscope, int ind_maxparen, int ind_maxcomment));
4888 static int ind_hash_comment = 0; /* # starts a comment */
4891 * Skip over white space and C comments within the line.
4892 * Also skip over Perl/shell comments if desired.
4894 static char_u *
4895 cin_skipcomment(s)
4896 char_u *s;
4898 while (*s)
4900 char_u *prev_s = s;
4902 s = skipwhite(s);
4904 /* Perl/shell # comment comment continues until eol. Require a space
4905 * before # to avoid recognizing $#array. */
4906 if (ind_hash_comment != 0 && s != prev_s && *s == '#')
4908 s += STRLEN(s);
4909 break;
4911 if (*s != '/')
4912 break;
4913 ++s;
4914 if (*s == '/') /* slash-slash comment continues till eol */
4916 s += STRLEN(s);
4917 break;
4919 if (*s != '*')
4920 break;
4921 for (++s; *s; ++s) /* skip slash-star comment */
4922 if (s[0] == '*' && s[1] == '/')
4924 s += 2;
4925 break;
4928 return s;
4932 * Return TRUE if there there is no code at *s. White space and comments are
4933 * not considered code.
4935 static int
4936 cin_nocode(s)
4937 char_u *s;
4939 return *cin_skipcomment(s) == NUL;
4943 * Check previous lines for a "//" line comment, skipping over blank lines.
4945 static pos_T *
4946 find_line_comment() /* XXX */
4948 static pos_T pos;
4949 char_u *line;
4950 char_u *p;
4952 pos = curwin->w_cursor;
4953 while (--pos.lnum > 0)
4955 line = ml_get(pos.lnum);
4956 p = skipwhite(line);
4957 if (cin_islinecomment(p))
4959 pos.col = (int)(p - line);
4960 return &pos;
4962 if (*p != NUL)
4963 break;
4965 return NULL;
4969 * Check if string matches "label:"; move to character after ':' if true.
4971 static int
4972 cin_islabel_skip(s)
4973 char_u **s;
4975 if (!vim_isIDc(**s)) /* need at least one ID character */
4976 return FALSE;
4978 while (vim_isIDc(**s))
4979 (*s)++;
4981 *s = cin_skipcomment(*s);
4983 /* "::" is not a label, it's C++ */
4984 return (**s == ':' && *++*s != ':');
4988 * Recognize a label: "label:".
4989 * Note: curwin->w_cursor must be where we are looking for the label.
4992 cin_islabel(ind_maxcomment) /* XXX */
4993 int ind_maxcomment;
4995 char_u *s;
4997 s = cin_skipcomment(ml_get_curline());
5000 * Exclude "default" from labels, since it should be indented
5001 * like a switch label. Same for C++ scope declarations.
5003 if (cin_isdefault(s))
5004 return FALSE;
5005 if (cin_isscopedecl(s))
5006 return FALSE;
5008 if (cin_islabel_skip(&s))
5011 * Only accept a label if the previous line is terminated or is a case
5012 * label.
5014 pos_T cursor_save;
5015 pos_T *trypos;
5016 char_u *line;
5018 cursor_save = curwin->w_cursor;
5019 while (curwin->w_cursor.lnum > 1)
5021 --curwin->w_cursor.lnum;
5024 * If we're in a comment now, skip to the start of the comment.
5026 curwin->w_cursor.col = 0;
5027 if ((trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
5028 curwin->w_cursor = *trypos;
5030 line = ml_get_curline();
5031 if (cin_ispreproc(line)) /* ignore #defines, #if, etc. */
5032 continue;
5033 if (*(line = cin_skipcomment(line)) == NUL)
5034 continue;
5036 curwin->w_cursor = cursor_save;
5037 if (cin_isterminated(line, TRUE, FALSE)
5038 || cin_isscopedecl(line)
5039 || cin_iscase(line)
5040 || (cin_islabel_skip(&line) && cin_nocode(line)))
5041 return TRUE;
5042 return FALSE;
5044 curwin->w_cursor = cursor_save;
5045 return TRUE; /* label at start of file??? */
5047 return FALSE;
5051 * Recognize structure initialization and enumerations.
5052 * Q&D-Implementation:
5053 * check for "=" at end or "[typedef] enum" at beginning of line.
5055 static int
5056 cin_isinit(void)
5058 char_u *s;
5060 s = cin_skipcomment(ml_get_curline());
5062 if (STRNCMP(s, "typedef", 7) == 0 && !vim_isIDc(s[7]))
5063 s = cin_skipcomment(s + 7);
5065 if (STRNCMP(s, "enum", 4) == 0 && !vim_isIDc(s[4]))
5066 return TRUE;
5068 if (cin_ends_in(s, (char_u *)"=", (char_u *)"{"))
5069 return TRUE;
5071 return FALSE;
5075 * Recognize a switch label: "case .*:" or "default:".
5078 cin_iscase(s)
5079 char_u *s;
5081 s = cin_skipcomment(s);
5082 if (STRNCMP(s, "case", 4) == 0 && !vim_isIDc(s[4]))
5084 for (s += 4; *s; ++s)
5086 s = cin_skipcomment(s);
5087 if (*s == ':')
5089 if (s[1] == ':') /* skip over "::" for C++ */
5090 ++s;
5091 else
5092 return TRUE;
5094 if (*s == '\'' && s[1] && s[2] == '\'')
5095 s += 2; /* skip over '.' */
5096 else if (*s == '/' && (s[1] == '*' || s[1] == '/'))
5097 return FALSE; /* stop at comment */
5098 else if (*s == '"')
5099 return FALSE; /* stop at string */
5101 return FALSE;
5104 if (cin_isdefault(s))
5105 return TRUE;
5106 return FALSE;
5110 * Recognize a "default" switch label.
5112 static int
5113 cin_isdefault(s)
5114 char_u *s;
5116 return (STRNCMP(s, "default", 7) == 0
5117 && *(s = cin_skipcomment(s + 7)) == ':'
5118 && s[1] != ':');
5122 * Recognize a "public/private/proctected" scope declaration label.
5125 cin_isscopedecl(s)
5126 char_u *s;
5128 int i;
5130 s = cin_skipcomment(s);
5131 if (STRNCMP(s, "public", 6) == 0)
5132 i = 6;
5133 else if (STRNCMP(s, "protected", 9) == 0)
5134 i = 9;
5135 else if (STRNCMP(s, "private", 7) == 0)
5136 i = 7;
5137 else
5138 return FALSE;
5139 return (*(s = cin_skipcomment(s + i)) == ':' && s[1] != ':');
5143 * Return a pointer to the first non-empty non-comment character after a ':'.
5144 * Return NULL if not found.
5145 * case 234: a = b;
5148 static char_u *
5149 after_label(l)
5150 char_u *l;
5152 for ( ; *l; ++l)
5154 if (*l == ':')
5156 if (l[1] == ':') /* skip over "::" for C++ */
5157 ++l;
5158 else if (!cin_iscase(l + 1))
5159 break;
5161 else if (*l == '\'' && l[1] && l[2] == '\'')
5162 l += 2; /* skip over 'x' */
5164 if (*l == NUL)
5165 return NULL;
5166 l = cin_skipcomment(l + 1);
5167 if (*l == NUL)
5168 return NULL;
5169 return l;
5173 * Get indent of line "lnum", skipping a label.
5174 * Return 0 if there is nothing after the label.
5176 static int
5177 get_indent_nolabel(lnum) /* XXX */
5178 linenr_T lnum;
5180 char_u *l;
5181 pos_T fp;
5182 colnr_T col;
5183 char_u *p;
5185 l = ml_get(lnum);
5186 p = after_label(l);
5187 if (p == NULL)
5188 return 0;
5190 fp.col = (colnr_T)(p - l);
5191 fp.lnum = lnum;
5192 getvcol(curwin, &fp, &col, NULL, NULL);
5193 return (int)col;
5197 * Find indent for line "lnum", ignoring any case or jump label.
5198 * Also return a pointer to the text (after the label) in "pp".
5199 * label: if (asdf && asdfasdf)
5202 static int
5203 skip_label(lnum, pp, ind_maxcomment)
5204 linenr_T lnum;
5205 char_u **pp;
5206 int ind_maxcomment;
5208 char_u *l;
5209 int amount;
5210 pos_T cursor_save;
5212 cursor_save = curwin->w_cursor;
5213 curwin->w_cursor.lnum = lnum;
5214 l = ml_get_curline();
5215 /* XXX */
5216 if (cin_iscase(l) || cin_isscopedecl(l) || cin_islabel(ind_maxcomment))
5218 amount = get_indent_nolabel(lnum);
5219 l = after_label(ml_get_curline());
5220 if (l == NULL) /* just in case */
5221 l = ml_get_curline();
5223 else
5225 amount = get_indent();
5226 l = ml_get_curline();
5228 *pp = l;
5230 curwin->w_cursor = cursor_save;
5231 return amount;
5235 * Return the indent of the first variable name after a type in a declaration.
5236 * int a, indent of "a"
5237 * static struct foo b, indent of "b"
5238 * enum bla c, indent of "c"
5239 * Returns zero when it doesn't look like a declaration.
5241 static int
5242 cin_first_id_amount()
5244 char_u *line, *p, *s;
5245 int len;
5246 pos_T fp;
5247 colnr_T col;
5249 line = ml_get_curline();
5250 p = skipwhite(line);
5251 len = (int)(skiptowhite(p) - p);
5252 if (len == 6 && STRNCMP(p, "static", 6) == 0)
5254 p = skipwhite(p + 6);
5255 len = (int)(skiptowhite(p) - p);
5257 if (len == 6 && STRNCMP(p, "struct", 6) == 0)
5258 p = skipwhite(p + 6);
5259 else if (len == 4 && STRNCMP(p, "enum", 4) == 0)
5260 p = skipwhite(p + 4);
5261 else if ((len == 8 && STRNCMP(p, "unsigned", 8) == 0)
5262 || (len == 6 && STRNCMP(p, "signed", 6) == 0))
5264 s = skipwhite(p + len);
5265 if ((STRNCMP(s, "int", 3) == 0 && vim_iswhite(s[3]))
5266 || (STRNCMP(s, "long", 4) == 0 && vim_iswhite(s[4]))
5267 || (STRNCMP(s, "short", 5) == 0 && vim_iswhite(s[5]))
5268 || (STRNCMP(s, "char", 4) == 0 && vim_iswhite(s[4])))
5269 p = s;
5271 for (len = 0; vim_isIDc(p[len]); ++len)
5273 if (len == 0 || !vim_iswhite(p[len]) || cin_nocode(p))
5274 return 0;
5276 p = skipwhite(p + len);
5277 fp.lnum = curwin->w_cursor.lnum;
5278 fp.col = (colnr_T)(p - line);
5279 getvcol(curwin, &fp, &col, NULL, NULL);
5280 return (int)col;
5284 * Return the indent of the first non-blank after an equal sign.
5285 * char *foo = "here";
5286 * Return zero if no (useful) equal sign found.
5287 * Return -1 if the line above "lnum" ends in a backslash.
5288 * foo = "asdf\
5289 * asdf\
5290 * here";
5292 static int
5293 cin_get_equal_amount(lnum)
5294 linenr_T lnum;
5296 char_u *line;
5297 char_u *s;
5298 colnr_T col;
5299 pos_T fp;
5301 if (lnum > 1)
5303 line = ml_get(lnum - 1);
5304 if (*line != NUL && line[STRLEN(line) - 1] == '\\')
5305 return -1;
5308 line = s = ml_get(lnum);
5309 while (*s != NUL && vim_strchr((char_u *)"=;{}\"'", *s) == NULL)
5311 if (cin_iscomment(s)) /* ignore comments */
5312 s = cin_skipcomment(s);
5313 else
5314 ++s;
5316 if (*s != '=')
5317 return 0;
5319 s = skipwhite(s + 1);
5320 if (cin_nocode(s))
5321 return 0;
5323 if (*s == '"') /* nice alignment for continued strings */
5324 ++s;
5326 fp.lnum = lnum;
5327 fp.col = (colnr_T)(s - line);
5328 getvcol(curwin, &fp, &col, NULL, NULL);
5329 return (int)col;
5333 * Recognize a preprocessor statement: Any line that starts with '#'.
5335 static int
5336 cin_ispreproc(s)
5337 char_u *s;
5339 s = skipwhite(s);
5340 if (*s == '#')
5341 return TRUE;
5342 return FALSE;
5346 * Return TRUE if line "*pp" at "*lnump" is a preprocessor statement or a
5347 * continuation line of a preprocessor statement. Decrease "*lnump" to the
5348 * start and return the line in "*pp".
5350 static int
5351 cin_ispreproc_cont(pp, lnump)
5352 char_u **pp;
5353 linenr_T *lnump;
5355 char_u *line = *pp;
5356 linenr_T lnum = *lnump;
5357 int retval = FALSE;
5359 for (;;)
5361 if (cin_ispreproc(line))
5363 retval = TRUE;
5364 *lnump = lnum;
5365 break;
5367 if (lnum == 1)
5368 break;
5369 line = ml_get(--lnum);
5370 if (*line == NUL || line[STRLEN(line) - 1] != '\\')
5371 break;
5374 if (lnum != *lnump)
5375 *pp = ml_get(*lnump);
5376 return retval;
5380 * Recognize the start of a C or C++ comment.
5382 static int
5383 cin_iscomment(p)
5384 char_u *p;
5386 return (p[0] == '/' && (p[1] == '*' || p[1] == '/'));
5390 * Recognize the start of a "//" comment.
5392 static int
5393 cin_islinecomment(p)
5394 char_u *p;
5396 return (p[0] == '/' && p[1] == '/');
5400 * Recognize a line that starts with '{' or '}', or ends with ';', '{' or '}'.
5401 * Don't consider "} else" a terminated line.
5402 * Return the character terminating the line (ending char's have precedence if
5403 * both apply in order to determine initializations).
5405 static int
5406 cin_isterminated(s, incl_open, incl_comma)
5407 char_u *s;
5408 int incl_open; /* include '{' at the end as terminator */
5409 int incl_comma; /* recognize a trailing comma */
5411 char_u found_start = 0;
5413 s = cin_skipcomment(s);
5415 if (*s == '{' || (*s == '}' && !cin_iselse(s)))
5416 found_start = *s;
5418 while (*s)
5420 /* skip over comments, "" strings and 'c'haracters */
5421 s = skip_string(cin_skipcomment(s));
5422 if ((*s == ';' || (incl_open && *s == '{') || *s == '}'
5423 || (incl_comma && *s == ','))
5424 && cin_nocode(s + 1))
5425 return *s;
5427 if (*s)
5428 s++;
5430 return found_start;
5434 * Recognize the basic picture of a function declaration -- it needs to
5435 * have an open paren somewhere and a close paren at the end of the line and
5436 * no semicolons anywhere.
5437 * When a line ends in a comma we continue looking in the next line.
5438 * "sp" points to a string with the line. When looking at other lines it must
5439 * be restored to the line. When it's NULL fetch lines here.
5440 * "lnum" is where we start looking.
5442 static int
5443 cin_isfuncdecl(sp, first_lnum)
5444 char_u **sp;
5445 linenr_T first_lnum;
5447 char_u *s;
5448 linenr_T lnum = first_lnum;
5449 int retval = FALSE;
5451 if (sp == NULL)
5452 s = ml_get(lnum);
5453 else
5454 s = *sp;
5456 while (*s && *s != '(' && *s != ';' && *s != '\'' && *s != '"')
5458 if (cin_iscomment(s)) /* ignore comments */
5459 s = cin_skipcomment(s);
5460 else
5461 ++s;
5463 if (*s != '(')
5464 return FALSE; /* ';', ' or " before any () or no '(' */
5466 while (*s && *s != ';' && *s != '\'' && *s != '"')
5468 if (*s == ')' && cin_nocode(s + 1))
5470 /* ')' at the end: may have found a match
5471 * Check for he previous line not to end in a backslash:
5472 * #if defined(x) && \
5473 * defined(y)
5475 lnum = first_lnum - 1;
5476 s = ml_get(lnum);
5477 if (*s == NUL || s[STRLEN(s) - 1] != '\\')
5478 retval = TRUE;
5479 goto done;
5481 if (*s == ',' && cin_nocode(s + 1))
5483 /* ',' at the end: continue looking in the next line */
5484 if (lnum >= curbuf->b_ml.ml_line_count)
5485 break;
5487 s = ml_get(++lnum);
5489 else if (cin_iscomment(s)) /* ignore comments */
5490 s = cin_skipcomment(s);
5491 else
5492 ++s;
5495 done:
5496 if (lnum != first_lnum && sp != NULL)
5497 *sp = ml_get(first_lnum);
5499 return retval;
5502 static int
5503 cin_isif(p)
5504 char_u *p;
5506 return (STRNCMP(p, "if", 2) == 0 && !vim_isIDc(p[2]));
5509 static int
5510 cin_iselse(p)
5511 char_u *p;
5513 if (*p == '}') /* accept "} else" */
5514 p = cin_skipcomment(p + 1);
5515 return (STRNCMP(p, "else", 4) == 0 && !vim_isIDc(p[4]));
5518 static int
5519 cin_isdo(p)
5520 char_u *p;
5522 return (STRNCMP(p, "do", 2) == 0 && !vim_isIDc(p[2]));
5526 * Check if this is a "while" that should have a matching "do".
5527 * We only accept a "while (condition) ;", with only white space between the
5528 * ')' and ';'. The condition may be spread over several lines.
5530 static int
5531 cin_iswhileofdo(p, lnum, ind_maxparen) /* XXX */
5532 char_u *p;
5533 linenr_T lnum;
5534 int ind_maxparen;
5536 pos_T cursor_save;
5537 pos_T *trypos;
5538 int retval = FALSE;
5540 p = cin_skipcomment(p);
5541 if (*p == '}') /* accept "} while (cond);" */
5542 p = cin_skipcomment(p + 1);
5543 if (STRNCMP(p, "while", 5) == 0 && !vim_isIDc(p[5]))
5545 cursor_save = curwin->w_cursor;
5546 curwin->w_cursor.lnum = lnum;
5547 curwin->w_cursor.col = 0;
5548 p = ml_get_curline();
5549 while (*p && *p != 'w') /* skip any '}', until the 'w' of the "while" */
5551 ++p;
5552 ++curwin->w_cursor.col;
5554 if ((trypos = findmatchlimit(NULL, 0, 0, ind_maxparen)) != NULL
5555 && *cin_skipcomment(ml_get_pos(trypos) + 1) == ';')
5556 retval = TRUE;
5557 curwin->w_cursor = cursor_save;
5559 return retval;
5563 * Return TRUE if we are at the end of a do-while.
5564 * do
5565 * nothing;
5566 * while (foo
5567 * && bar); <-- here
5568 * Adjust the cursor to the line with "while".
5570 static int
5571 cin_iswhileofdo_end(terminated, ind_maxparen, ind_maxcomment)
5572 int terminated;
5573 int ind_maxparen;
5574 int ind_maxcomment;
5576 char_u *line;
5577 char_u *p;
5578 char_u *s;
5579 pos_T *trypos;
5580 int i;
5582 if (terminated != ';') /* there must be a ';' at the end */
5583 return FALSE;
5585 p = line = ml_get_curline();
5586 while (*p != NUL)
5588 p = cin_skipcomment(p);
5589 if (*p == ')')
5591 s = skipwhite(p + 1);
5592 if (*s == ';' && cin_nocode(s + 1))
5594 /* Found ");" at end of the line, now check there is "while"
5595 * before the matching '('. XXX */
5596 i = (int)(p - line);
5597 curwin->w_cursor.col = i;
5598 trypos = find_match_paren(ind_maxparen, ind_maxcomment);
5599 if (trypos != NULL)
5601 s = cin_skipcomment(ml_get(trypos->lnum));
5602 if (*s == '}') /* accept "} while (cond);" */
5603 s = cin_skipcomment(s + 1);
5604 if (STRNCMP(s, "while", 5) == 0 && !vim_isIDc(s[5]))
5606 curwin->w_cursor.lnum = trypos->lnum;
5607 return TRUE;
5611 /* Searching may have made "line" invalid, get it again. */
5612 line = ml_get_curline();
5613 p = line + i;
5616 if (*p != NUL)
5617 ++p;
5619 return FALSE;
5622 static int
5623 cin_isbreak(p)
5624 char_u *p;
5626 return (STRNCMP(p, "break", 5) == 0 && !vim_isIDc(p[5]));
5630 * Find the position of a C++ base-class declaration or
5631 * constructor-initialization. eg:
5633 * class MyClass :
5634 * baseClass <-- here
5635 * class MyClass : public baseClass,
5636 * anotherBaseClass <-- here (should probably lineup ??)
5637 * MyClass::MyClass(...) :
5638 * baseClass(...) <-- here (constructor-initialization)
5640 * This is a lot of guessing. Watch out for "cond ? func() : foo".
5642 static int
5643 cin_is_cpp_baseclass(col)
5644 colnr_T *col; /* return: column to align with */
5646 char_u *s;
5647 int class_or_struct, lookfor_ctor_init, cpp_base_class;
5648 linenr_T lnum = curwin->w_cursor.lnum;
5649 char_u *line = ml_get_curline();
5651 *col = 0;
5653 s = skipwhite(line);
5654 if (*s == '#') /* skip #define FOO x ? (x) : x */
5655 return FALSE;
5656 s = cin_skipcomment(s);
5657 if (*s == NUL)
5658 return FALSE;
5660 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5662 /* Search for a line starting with '#', empty, ending in ';' or containing
5663 * '{' or '}' and start below it. This handles the following situations:
5664 * a = cond ?
5665 * func() :
5666 * asdf;
5667 * func::foo()
5668 * : something
5669 * {}
5670 * Foo::Foo (int one, int two)
5671 * : something(4),
5672 * somethingelse(3)
5673 * {}
5675 while (lnum > 1)
5677 line = ml_get(lnum - 1);
5678 s = skipwhite(line);
5679 if (*s == '#' || *s == NUL)
5680 break;
5681 while (*s != NUL)
5683 s = cin_skipcomment(s);
5684 if (*s == '{' || *s == '}'
5685 || (*s == ';' && cin_nocode(s + 1)))
5686 break;
5687 if (*s != NUL)
5688 ++s;
5690 if (*s != NUL)
5691 break;
5692 --lnum;
5695 line = ml_get(lnum);
5696 s = cin_skipcomment(line);
5697 for (;;)
5699 if (*s == NUL)
5701 if (lnum == curwin->w_cursor.lnum)
5702 break;
5703 /* Continue in the cursor line. */
5704 line = ml_get(++lnum);
5705 s = cin_skipcomment(line);
5706 if (*s == NUL)
5707 continue;
5710 if (s[0] == ':')
5712 if (s[1] == ':')
5714 /* skip double colon. It can't be a constructor
5715 * initialization any more */
5716 lookfor_ctor_init = FALSE;
5717 s = cin_skipcomment(s + 2);
5719 else if (lookfor_ctor_init || class_or_struct)
5721 /* we have something found, that looks like the start of
5722 * cpp-base-class-declaration or constructor-initialization */
5723 cpp_base_class = TRUE;
5724 lookfor_ctor_init = class_or_struct = FALSE;
5725 *col = 0;
5726 s = cin_skipcomment(s + 1);
5728 else
5729 s = cin_skipcomment(s + 1);
5731 else if ((STRNCMP(s, "class", 5) == 0 && !vim_isIDc(s[5]))
5732 || (STRNCMP(s, "struct", 6) == 0 && !vim_isIDc(s[6])))
5734 class_or_struct = TRUE;
5735 lookfor_ctor_init = FALSE;
5737 if (*s == 'c')
5738 s = cin_skipcomment(s + 5);
5739 else
5740 s = cin_skipcomment(s + 6);
5742 else
5744 if (s[0] == '{' || s[0] == '}' || s[0] == ';')
5746 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5748 else if (s[0] == ')')
5750 /* Constructor-initialization is assumed if we come across
5751 * something like "):" */
5752 class_or_struct = FALSE;
5753 lookfor_ctor_init = TRUE;
5755 else if (s[0] == '?')
5757 /* Avoid seeing '() :' after '?' as constructor init. */
5758 return FALSE;
5760 else if (!vim_isIDc(s[0]))
5762 /* if it is not an identifier, we are wrong */
5763 class_or_struct = FALSE;
5764 lookfor_ctor_init = FALSE;
5766 else if (*col == 0)
5768 /* it can't be a constructor-initialization any more */
5769 lookfor_ctor_init = FALSE;
5771 /* the first statement starts here: lineup with this one... */
5772 if (cpp_base_class)
5773 *col = (colnr_T)(s - line);
5776 /* When the line ends in a comma don't align with it. */
5777 if (lnum == curwin->w_cursor.lnum && *s == ',' && cin_nocode(s + 1))
5778 *col = 0;
5780 s = cin_skipcomment(s + 1);
5784 return cpp_base_class;
5787 static int
5788 get_baseclass_amount(col, ind_maxparen, ind_maxcomment, ind_cpp_baseclass)
5789 int col;
5790 int ind_maxparen;
5791 int ind_maxcomment;
5792 int ind_cpp_baseclass;
5794 int amount;
5795 colnr_T vcol;
5796 pos_T *trypos;
5798 if (col == 0)
5800 amount = get_indent();
5801 if (find_last_paren(ml_get_curline(), '(', ')')
5802 && (trypos = find_match_paren(ind_maxparen,
5803 ind_maxcomment)) != NULL)
5804 amount = get_indent_lnum(trypos->lnum); /* XXX */
5805 if (!cin_ends_in(ml_get_curline(), (char_u *)",", NULL))
5806 amount += ind_cpp_baseclass;
5808 else
5810 curwin->w_cursor.col = col;
5811 getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
5812 amount = (int)vcol;
5814 if (amount < ind_cpp_baseclass)
5815 amount = ind_cpp_baseclass;
5816 return amount;
5820 * Return TRUE if string "s" ends with the string "find", possibly followed by
5821 * white space and comments. Skip strings and comments.
5822 * Ignore "ignore" after "find" if it's not NULL.
5824 static int
5825 cin_ends_in(s, find, ignore)
5826 char_u *s;
5827 char_u *find;
5828 char_u *ignore;
5830 char_u *p = s;
5831 char_u *r;
5832 int len = (int)STRLEN(find);
5834 while (*p != NUL)
5836 p = cin_skipcomment(p);
5837 if (STRNCMP(p, find, len) == 0)
5839 r = skipwhite(p + len);
5840 if (ignore != NULL && STRNCMP(r, ignore, STRLEN(ignore)) == 0)
5841 r = skipwhite(r + STRLEN(ignore));
5842 if (cin_nocode(r))
5843 return TRUE;
5845 if (*p != NUL)
5846 ++p;
5848 return FALSE;
5852 * Skip strings, chars and comments until at or past "trypos".
5853 * Return the column found.
5855 static int
5856 cin_skip2pos(trypos)
5857 pos_T *trypos;
5859 char_u *line;
5860 char_u *p;
5862 p = line = ml_get(trypos->lnum);
5863 while (*p && (colnr_T)(p - line) < trypos->col)
5865 if (cin_iscomment(p))
5866 p = cin_skipcomment(p);
5867 else
5869 p = skip_string(p);
5870 ++p;
5873 return (int)(p - line);
5877 * Find the '{' at the start of the block we are in.
5878 * Return NULL if no match found.
5879 * Ignore a '{' that is in a comment, makes indenting the next three lines
5880 * work. */
5881 /* foo() */
5882 /* { */
5883 /* } */
5885 static pos_T *
5886 find_start_brace(ind_maxcomment) /* XXX */
5887 int ind_maxcomment;
5889 pos_T cursor_save;
5890 pos_T *trypos;
5891 pos_T *pos;
5892 static pos_T pos_copy;
5894 cursor_save = curwin->w_cursor;
5895 while ((trypos = findmatchlimit(NULL, '{', FM_BLOCKSTOP, 0)) != NULL)
5897 pos_copy = *trypos; /* copy pos_T, next findmatch will change it */
5898 trypos = &pos_copy;
5899 curwin->w_cursor = *trypos;
5900 pos = NULL;
5901 /* ignore the { if it's in a // or / * * / comment */
5902 if ((colnr_T)cin_skip2pos(trypos) == trypos->col
5903 && (pos = find_start_comment(ind_maxcomment)) == NULL) /* XXX */
5904 break;
5905 if (pos != NULL)
5906 curwin->w_cursor.lnum = pos->lnum;
5908 curwin->w_cursor = cursor_save;
5909 return trypos;
5913 * Find the matching '(', failing if it is in a comment.
5914 * Return NULL of no match found.
5916 static pos_T *
5917 find_match_paren(ind_maxparen, ind_maxcomment) /* XXX */
5918 int ind_maxparen;
5919 int ind_maxcomment;
5921 pos_T cursor_save;
5922 pos_T *trypos;
5923 static pos_T pos_copy;
5925 cursor_save = curwin->w_cursor;
5926 if ((trypos = findmatchlimit(NULL, '(', 0, ind_maxparen)) != NULL)
5928 /* check if the ( is in a // comment */
5929 if ((colnr_T)cin_skip2pos(trypos) > trypos->col)
5930 trypos = NULL;
5931 else
5933 pos_copy = *trypos; /* copy trypos, findmatch will change it */
5934 trypos = &pos_copy;
5935 curwin->w_cursor = *trypos;
5936 if (find_start_comment(ind_maxcomment) != NULL) /* XXX */
5937 trypos = NULL;
5940 curwin->w_cursor = cursor_save;
5941 return trypos;
5945 * Return ind_maxparen corrected for the difference in line number between the
5946 * cursor position and "startpos". This makes sure that searching for a
5947 * matching paren above the cursor line doesn't find a match because of
5948 * looking a few lines further.
5950 static int
5951 corr_ind_maxparen(ind_maxparen, startpos)
5952 int ind_maxparen;
5953 pos_T *startpos;
5955 long n = (long)startpos->lnum - (long)curwin->w_cursor.lnum;
5957 if (n > 0 && n < ind_maxparen / 2)
5958 return ind_maxparen - (int)n;
5959 return ind_maxparen;
5963 * Set w_cursor.col to the column number of the last unmatched ')' or '{' in
5964 * line "l".
5966 static int
5967 find_last_paren(l, start, end)
5968 char_u *l;
5969 int start, end;
5971 int i;
5972 int retval = FALSE;
5973 int open_count = 0;
5975 curwin->w_cursor.col = 0; /* default is start of line */
5977 for (i = 0; l[i]; i++)
5979 i = (int)(cin_skipcomment(l + i) - l); /* ignore parens in comments */
5980 i = (int)(skip_string(l + i) - l); /* ignore parens in quotes */
5981 if (l[i] == start)
5982 ++open_count;
5983 else if (l[i] == end)
5985 if (open_count > 0)
5986 --open_count;
5987 else
5989 curwin->w_cursor.col = i;
5990 retval = TRUE;
5994 return retval;
5998 get_c_indent()
6001 * spaces from a block's opening brace the prevailing indent for that
6002 * block should be
6004 int ind_level = curbuf->b_p_sw;
6007 * spaces from the edge of the line an open brace that's at the end of a
6008 * line is imagined to be.
6010 int ind_open_imag = 0;
6013 * spaces from the prevailing indent for a line that is not precededof by
6014 * an opening brace.
6016 int ind_no_brace = 0;
6019 * column where the first { of a function should be located }
6021 int ind_first_open = 0;
6024 * spaces from the prevailing indent a leftmost open brace should be
6025 * located
6027 int ind_open_extra = 0;
6030 * spaces from the matching open brace (real location for one at the left
6031 * edge; imaginary location from one that ends a line) the matching close
6032 * brace should be located
6034 int ind_close_extra = 0;
6037 * spaces from the edge of the line an open brace sitting in the leftmost
6038 * column is imagined to be
6040 int ind_open_left_imag = 0;
6043 * spaces from the switch() indent a "case xx" label should be located
6045 int ind_case = curbuf->b_p_sw;
6048 * spaces from the "case xx:" code after a switch() should be located
6050 int ind_case_code = curbuf->b_p_sw;
6053 * lineup break at end of case in switch() with case label
6055 int ind_case_break = 0;
6058 * spaces from the class declaration indent a scope declaration label
6059 * should be located
6061 int ind_scopedecl = curbuf->b_p_sw;
6064 * spaces from the scope declaration label code should be located
6066 int ind_scopedecl_code = curbuf->b_p_sw;
6069 * amount K&R-style parameters should be indented
6071 int ind_param = curbuf->b_p_sw;
6074 * amount a function type spec should be indented
6076 int ind_func_type = curbuf->b_p_sw;
6079 * amount a cpp base class declaration or constructor initialization
6080 * should be indented
6082 int ind_cpp_baseclass = curbuf->b_p_sw;
6085 * additional spaces beyond the prevailing indent a continuation line
6086 * should be located
6088 int ind_continuation = curbuf->b_p_sw;
6091 * spaces from the indent of the line with an unclosed parentheses
6093 int ind_unclosed = curbuf->b_p_sw * 2;
6096 * spaces from the indent of the line with an unclosed parentheses, which
6097 * itself is also unclosed
6099 int ind_unclosed2 = curbuf->b_p_sw;
6102 * suppress ignoring spaces from the indent of a line starting with an
6103 * unclosed parentheses.
6105 int ind_unclosed_noignore = 0;
6108 * If the opening paren is the last nonwhite character on the line, and
6109 * ind_unclosed_wrapped is nonzero, use this indent relative to the outer
6110 * context (for very long lines).
6112 int ind_unclosed_wrapped = 0;
6115 * suppress ignoring white space when lining up with the character after
6116 * an unclosed parentheses.
6118 int ind_unclosed_whiteok = 0;
6121 * indent a closing parentheses under the line start of the matching
6122 * opening parentheses.
6124 int ind_matching_paren = 0;
6127 * indent a closing parentheses under the previous line.
6129 int ind_paren_prev = 0;
6132 * Extra indent for comments.
6134 int ind_comment = 0;
6137 * spaces from the comment opener when there is nothing after it.
6139 int ind_in_comment = 3;
6142 * boolean: if non-zero, use ind_in_comment even if there is something
6143 * after the comment opener.
6145 int ind_in_comment2 = 0;
6148 * max lines to search for an open paren
6150 int ind_maxparen = 20;
6153 * max lines to search for an open comment
6155 int ind_maxcomment = 70;
6158 * handle braces for java code
6160 int ind_java = 0;
6163 * handle blocked cases correctly
6165 int ind_keep_case_label = 0;
6167 pos_T cur_curpos;
6168 int amount;
6169 int scope_amount;
6170 int cur_amount = MAXCOL;
6171 colnr_T col;
6172 char_u *theline;
6173 char_u *linecopy;
6174 pos_T *trypos;
6175 pos_T *tryposBrace = NULL;
6176 pos_T our_paren_pos;
6177 char_u *start;
6178 int start_brace;
6179 #define BRACE_IN_COL0 1 /* '{' is in column 0 */
6180 #define BRACE_AT_START 2 /* '{' is at start of line */
6181 #define BRACE_AT_END 3 /* '{' is at end of line */
6182 linenr_T ourscope;
6183 char_u *l;
6184 char_u *look;
6185 char_u terminated;
6186 int lookfor;
6187 #define LOOKFOR_INITIAL 0
6188 #define LOOKFOR_IF 1
6189 #define LOOKFOR_DO 2
6190 #define LOOKFOR_CASE 3
6191 #define LOOKFOR_ANY 4
6192 #define LOOKFOR_TERM 5
6193 #define LOOKFOR_UNTERM 6
6194 #define LOOKFOR_SCOPEDECL 7
6195 #define LOOKFOR_NOBREAK 8
6196 #define LOOKFOR_CPP_BASECLASS 9
6197 #define LOOKFOR_ENUM_OR_INIT 10
6199 int whilelevel;
6200 linenr_T lnum;
6201 char_u *options;
6202 int fraction = 0; /* init for GCC */
6203 int divider;
6204 int n;
6205 int iscase;
6206 int lookfor_break;
6207 int cont_amount = 0; /* amount for continuation line */
6209 for (options = curbuf->b_p_cino; *options; )
6211 l = options++;
6212 if (*options == '-')
6213 ++options;
6214 n = getdigits(&options);
6215 divider = 0;
6216 if (*options == '.') /* ".5s" means a fraction */
6218 fraction = atol((char *)++options);
6219 while (VIM_ISDIGIT(*options))
6221 ++options;
6222 if (divider)
6223 divider *= 10;
6224 else
6225 divider = 10;
6228 if (*options == 's') /* "2s" means two times 'shiftwidth' */
6230 if (n == 0 && fraction == 0)
6231 n = curbuf->b_p_sw; /* just "s" is one 'shiftwidth' */
6232 else
6234 n *= curbuf->b_p_sw;
6235 if (divider)
6236 n += (curbuf->b_p_sw * fraction + divider / 2) / divider;
6238 ++options;
6240 if (l[1] == '-')
6241 n = -n;
6242 /* When adding an entry here, also update the default 'cinoptions' in
6243 * doc/indent.txt, and add explanation for it! */
6244 switch (*l)
6246 case '>': ind_level = n; break;
6247 case 'e': ind_open_imag = n; break;
6248 case 'n': ind_no_brace = n; break;
6249 case 'f': ind_first_open = n; break;
6250 case '{': ind_open_extra = n; break;
6251 case '}': ind_close_extra = n; break;
6252 case '^': ind_open_left_imag = n; break;
6253 case ':': ind_case = n; break;
6254 case '=': ind_case_code = n; break;
6255 case 'b': ind_case_break = n; break;
6256 case 'p': ind_param = n; break;
6257 case 't': ind_func_type = n; break;
6258 case '/': ind_comment = n; break;
6259 case 'c': ind_in_comment = n; break;
6260 case 'C': ind_in_comment2 = n; break;
6261 case 'i': ind_cpp_baseclass = n; break;
6262 case '+': ind_continuation = n; break;
6263 case '(': ind_unclosed = n; break;
6264 case 'u': ind_unclosed2 = n; break;
6265 case 'U': ind_unclosed_noignore = n; break;
6266 case 'W': ind_unclosed_wrapped = n; break;
6267 case 'w': ind_unclosed_whiteok = n; break;
6268 case 'm': ind_matching_paren = n; break;
6269 case 'M': ind_paren_prev = n; break;
6270 case ')': ind_maxparen = n; break;
6271 case '*': ind_maxcomment = n; break;
6272 case 'g': ind_scopedecl = n; break;
6273 case 'h': ind_scopedecl_code = n; break;
6274 case 'j': ind_java = n; break;
6275 case 'l': ind_keep_case_label = n; break;
6276 case '#': ind_hash_comment = n; break;
6280 /* remember where the cursor was when we started */
6281 cur_curpos = curwin->w_cursor;
6283 /* Get a copy of the current contents of the line.
6284 * This is required, because only the most recent line obtained with
6285 * ml_get is valid! */
6286 linecopy = vim_strsave(ml_get(cur_curpos.lnum));
6287 if (linecopy == NULL)
6288 return 0;
6291 * In insert mode and the cursor is on a ')' truncate the line at the
6292 * cursor position. We don't want to line up with the matching '(' when
6293 * inserting new stuff.
6294 * For unknown reasons the cursor might be past the end of the line, thus
6295 * check for that.
6297 if ((State & INSERT)
6298 && curwin->w_cursor.col < (colnr_T)STRLEN(linecopy)
6299 && linecopy[curwin->w_cursor.col] == ')')
6300 linecopy[curwin->w_cursor.col] = NUL;
6302 theline = skipwhite(linecopy);
6304 /* move the cursor to the start of the line */
6306 curwin->w_cursor.col = 0;
6309 * #defines and so on always go at the left when included in 'cinkeys'.
6311 if (*theline == '#' && (*linecopy == '#' || in_cinkeys('#', ' ', TRUE)))
6313 amount = 0;
6317 * Is it a non-case label? Then that goes at the left margin too.
6319 else if (cin_islabel(ind_maxcomment)) /* XXX */
6321 amount = 0;
6325 * If we're inside a "//" comment and there is a "//" comment in a
6326 * previous line, lineup with that one.
6328 else if (cin_islinecomment(theline)
6329 && (trypos = find_line_comment()) != NULL) /* XXX */
6331 /* find how indented the line beginning the comment is */
6332 getvcol(curwin, trypos, &col, NULL, NULL);
6333 amount = col;
6337 * If we're inside a comment and not looking at the start of the
6338 * comment, try using the 'comments' option.
6340 else if (!cin_iscomment(theline)
6341 && (trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
6343 int lead_start_len = 2;
6344 int lead_middle_len = 1;
6345 char_u lead_start[COM_MAX_LEN]; /* start-comment string */
6346 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
6347 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
6348 char_u *p;
6349 int start_align = 0;
6350 int start_off = 0;
6351 int done = FALSE;
6353 /* find how indented the line beginning the comment is */
6354 getvcol(curwin, trypos, &col, NULL, NULL);
6355 amount = col;
6357 p = curbuf->b_p_com;
6358 while (*p != NUL)
6360 int align = 0;
6361 int off = 0;
6362 int what = 0;
6364 while (*p != NUL && *p != ':')
6366 if (*p == COM_START || *p == COM_END || *p == COM_MIDDLE)
6367 what = *p++;
6368 else if (*p == COM_LEFT || *p == COM_RIGHT)
6369 align = *p++;
6370 else if (VIM_ISDIGIT(*p) || *p == '-')
6371 off = getdigits(&p);
6372 else
6373 ++p;
6376 if (*p == ':')
6377 ++p;
6378 (void)copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6379 if (what == COM_START)
6381 STRCPY(lead_start, lead_end);
6382 lead_start_len = (int)STRLEN(lead_start);
6383 start_off = off;
6384 start_align = align;
6386 else if (what == COM_MIDDLE)
6388 STRCPY(lead_middle, lead_end);
6389 lead_middle_len = (int)STRLEN(lead_middle);
6391 else if (what == COM_END)
6393 /* If our line starts with the middle comment string, line it
6394 * up with the comment opener per the 'comments' option. */
6395 if (STRNCMP(theline, lead_middle, lead_middle_len) == 0
6396 && STRNCMP(theline, lead_end, STRLEN(lead_end)) != 0)
6398 done = TRUE;
6399 if (curwin->w_cursor.lnum > 1)
6401 /* If the start comment string matches in the previous
6402 * line, use the indent of that line plus offset. If
6403 * the middle comment string matches in the previous
6404 * line, use the indent of that line. XXX */
6405 look = skipwhite(ml_get(curwin->w_cursor.lnum - 1));
6406 if (STRNCMP(look, lead_start, lead_start_len) == 0)
6407 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6408 else if (STRNCMP(look, lead_middle,
6409 lead_middle_len) == 0)
6411 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6412 break;
6414 /* If the start comment string doesn't match with the
6415 * start of the comment, skip this entry. XXX */
6416 else if (STRNCMP(ml_get(trypos->lnum) + trypos->col,
6417 lead_start, lead_start_len) != 0)
6418 continue;
6420 if (start_off != 0)
6421 amount += start_off;
6422 else if (start_align == COM_RIGHT)
6423 amount += vim_strsize(lead_start)
6424 - vim_strsize(lead_middle);
6425 break;
6428 /* If our line starts with the end comment string, line it up
6429 * with the middle comment */
6430 if (STRNCMP(theline, lead_middle, lead_middle_len) != 0
6431 && STRNCMP(theline, lead_end, STRLEN(lead_end)) == 0)
6433 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6434 /* XXX */
6435 if (off != 0)
6436 amount += off;
6437 else if (align == COM_RIGHT)
6438 amount += vim_strsize(lead_start)
6439 - vim_strsize(lead_middle);
6440 done = TRUE;
6441 break;
6446 /* If our line starts with an asterisk, line up with the
6447 * asterisk in the comment opener; otherwise, line up
6448 * with the first character of the comment text.
6450 if (done)
6452 else if (theline[0] == '*')
6453 amount += 1;
6454 else
6457 * If we are more than one line away from the comment opener, take
6458 * the indent of the previous non-empty line. If 'cino' has "CO"
6459 * and we are just below the comment opener and there are any
6460 * white characters after it line up with the text after it;
6461 * otherwise, add the amount specified by "c" in 'cino'
6463 amount = -1;
6464 for (lnum = cur_curpos.lnum - 1; lnum > trypos->lnum; --lnum)
6466 if (linewhite(lnum)) /* skip blank lines */
6467 continue;
6468 amount = get_indent_lnum(lnum); /* XXX */
6469 break;
6471 if (amount == -1) /* use the comment opener */
6473 if (!ind_in_comment2)
6475 start = ml_get(trypos->lnum);
6476 look = start + trypos->col + 2; /* skip / and * */
6477 if (*look != NUL) /* if something after it */
6478 trypos->col = (colnr_T)(skipwhite(look) - start);
6480 getvcol(curwin, trypos, &col, NULL, NULL);
6481 amount = col;
6482 if (ind_in_comment2 || *look == NUL)
6483 amount += ind_in_comment;
6489 * Are we inside parentheses or braces?
6490 */ /* XXX */
6491 else if (((trypos = find_match_paren(ind_maxparen, ind_maxcomment)) != NULL
6492 && ind_java == 0)
6493 || (tryposBrace = find_start_brace(ind_maxcomment)) != NULL
6494 || trypos != NULL)
6496 if (trypos != NULL && tryposBrace != NULL)
6498 /* Both an unmatched '(' and '{' is found. Use the one which is
6499 * closer to the current cursor position, set the other to NULL. */
6500 if (trypos->lnum != tryposBrace->lnum
6501 ? trypos->lnum < tryposBrace->lnum
6502 : trypos->col < tryposBrace->col)
6503 trypos = NULL;
6504 else
6505 tryposBrace = NULL;
6508 if (trypos != NULL)
6511 * If the matching paren is more than one line away, use the indent of
6512 * a previous non-empty line that matches the same paren.
6514 if (theline[0] == ')' && ind_paren_prev)
6516 /* Line up with the start of the matching paren line. */
6517 amount = get_indent_lnum(curwin->w_cursor.lnum - 1); /* XXX */
6519 else
6521 amount = -1;
6522 our_paren_pos = *trypos;
6523 for (lnum = cur_curpos.lnum - 1; lnum > our_paren_pos.lnum; --lnum)
6525 l = skipwhite(ml_get(lnum));
6526 if (cin_nocode(l)) /* skip comment lines */
6527 continue;
6528 if (cin_ispreproc_cont(&l, &lnum))
6529 continue; /* ignore #define, #if, etc. */
6530 curwin->w_cursor.lnum = lnum;
6532 /* Skip a comment. XXX */
6533 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6535 lnum = trypos->lnum + 1;
6536 continue;
6539 /* XXX */
6540 if ((trypos = find_match_paren(
6541 corr_ind_maxparen(ind_maxparen, &cur_curpos),
6542 ind_maxcomment)) != NULL
6543 && trypos->lnum == our_paren_pos.lnum
6544 && trypos->col == our_paren_pos.col)
6546 amount = get_indent_lnum(lnum); /* XXX */
6548 if (theline[0] == ')')
6550 if (our_paren_pos.lnum != lnum
6551 && cur_amount > amount)
6552 cur_amount = amount;
6553 amount = -1;
6555 break;
6561 * Line up with line where the matching paren is. XXX
6562 * If the line starts with a '(' or the indent for unclosed
6563 * parentheses is zero, line up with the unclosed parentheses.
6565 if (amount == -1)
6567 int ignore_paren_col = 0;
6569 amount = skip_label(our_paren_pos.lnum, &look, ind_maxcomment);
6570 look = skipwhite(look);
6571 if (*look == '(')
6573 linenr_T save_lnum = curwin->w_cursor.lnum;
6574 char_u *line;
6575 int look_col;
6577 /* Ignore a '(' in front of the line that has a match before
6578 * our matching '('. */
6579 curwin->w_cursor.lnum = our_paren_pos.lnum;
6580 line = ml_get_curline();
6581 look_col = (int)(look - line);
6582 curwin->w_cursor.col = look_col + 1;
6583 if ((trypos = findmatchlimit(NULL, ')', 0, ind_maxparen))
6584 != NULL
6585 && trypos->lnum == our_paren_pos.lnum
6586 && trypos->col < our_paren_pos.col)
6587 ignore_paren_col = trypos->col + 1;
6589 curwin->w_cursor.lnum = save_lnum;
6590 look = ml_get(our_paren_pos.lnum) + look_col;
6592 if (theline[0] == ')' || ind_unclosed == 0
6593 || (!ind_unclosed_noignore && *look == '('
6594 && ignore_paren_col == 0))
6597 * If we're looking at a close paren, line up right there;
6598 * otherwise, line up with the next (non-white) character.
6599 * When ind_unclosed_wrapped is set and the matching paren is
6600 * the last nonwhite character of the line, use either the
6601 * indent of the current line or the indentation of the next
6602 * outer paren and add ind_unclosed_wrapped (for very long
6603 * lines).
6605 if (theline[0] != ')')
6607 cur_amount = MAXCOL;
6608 l = ml_get(our_paren_pos.lnum);
6609 if (ind_unclosed_wrapped
6610 && cin_ends_in(l, (char_u *)"(", NULL))
6612 /* look for opening unmatched paren, indent one level
6613 * for each additional level */
6614 n = 1;
6615 for (col = 0; col < our_paren_pos.col; ++col)
6617 switch (l[col])
6619 case '(':
6620 case '{': ++n;
6621 break;
6623 case ')':
6624 case '}': if (n > 1)
6625 --n;
6626 break;
6630 our_paren_pos.col = 0;
6631 amount += n * ind_unclosed_wrapped;
6633 else if (ind_unclosed_whiteok)
6634 our_paren_pos.col++;
6635 else
6637 col = our_paren_pos.col + 1;
6638 while (vim_iswhite(l[col]))
6639 col++;
6640 if (l[col] != NUL) /* In case of trailing space */
6641 our_paren_pos.col = col;
6642 else
6643 our_paren_pos.col++;
6648 * Find how indented the paren is, or the character after it
6649 * if we did the above "if".
6651 if (our_paren_pos.col > 0)
6653 getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
6654 if (cur_amount > (int)col)
6655 cur_amount = col;
6659 if (theline[0] == ')' && ind_matching_paren)
6661 /* Line up with the start of the matching paren line. */
6663 else if (ind_unclosed == 0 || (!ind_unclosed_noignore
6664 && *look == '(' && ignore_paren_col == 0))
6666 if (cur_amount != MAXCOL)
6667 amount = cur_amount;
6669 else
6671 /* Add ind_unclosed2 for each '(' before our matching one, but
6672 * ignore (void) before the line (ignore_paren_col). */
6673 col = our_paren_pos.col;
6674 while ((int)our_paren_pos.col > ignore_paren_col)
6676 --our_paren_pos.col;
6677 switch (*ml_get_pos(&our_paren_pos))
6679 case '(': amount += ind_unclosed2;
6680 col = our_paren_pos.col;
6681 break;
6682 case ')': amount -= ind_unclosed2;
6683 col = MAXCOL;
6684 break;
6688 /* Use ind_unclosed once, when the first '(' is not inside
6689 * braces */
6690 if (col == MAXCOL)
6691 amount += ind_unclosed;
6692 else
6694 curwin->w_cursor.lnum = our_paren_pos.lnum;
6695 curwin->w_cursor.col = col;
6696 if ((trypos = find_match_paren(ind_maxparen,
6697 ind_maxcomment)) != NULL)
6698 amount += ind_unclosed2;
6699 else
6700 amount += ind_unclosed;
6703 * For a line starting with ')' use the minimum of the two
6704 * positions, to avoid giving it more indent than the previous
6705 * lines:
6706 * func_long_name( if (x
6707 * arg && yy
6708 * ) ^ not here ) ^ not here
6710 if (cur_amount < amount)
6711 amount = cur_amount;
6715 /* add extra indent for a comment */
6716 if (cin_iscomment(theline))
6717 amount += ind_comment;
6721 * Are we at least inside braces, then?
6723 else
6725 trypos = tryposBrace;
6727 ourscope = trypos->lnum;
6728 start = ml_get(ourscope);
6731 * Now figure out how indented the line is in general.
6732 * If the brace was at the start of the line, we use that;
6733 * otherwise, check out the indentation of the line as
6734 * a whole and then add the "imaginary indent" to that.
6736 look = skipwhite(start);
6737 if (*look == '{')
6739 getvcol(curwin, trypos, &col, NULL, NULL);
6740 amount = col;
6741 if (*start == '{')
6742 start_brace = BRACE_IN_COL0;
6743 else
6744 start_brace = BRACE_AT_START;
6746 else
6749 * that opening brace might have been on a continuation
6750 * line. if so, find the start of the line.
6752 curwin->w_cursor.lnum = ourscope;
6755 * position the cursor over the rightmost paren, so that
6756 * matching it will take us back to the start of the line.
6758 lnum = ourscope;
6759 if (find_last_paren(start, '(', ')')
6760 && (trypos = find_match_paren(ind_maxparen,
6761 ind_maxcomment)) != NULL)
6762 lnum = trypos->lnum;
6765 * It could have been something like
6766 * case 1: if (asdf &&
6767 * ldfd) {
6770 if (ind_keep_case_label && cin_iscase(skipwhite(ml_get_curline())))
6771 amount = get_indent();
6772 else
6773 amount = skip_label(lnum, &l, ind_maxcomment);
6775 start_brace = BRACE_AT_END;
6779 * if we're looking at a closing brace, that's where
6780 * we want to be. otherwise, add the amount of room
6781 * that an indent is supposed to be.
6783 if (theline[0] == '}')
6786 * they may want closing braces to line up with something
6787 * other than the open brace. indulge them, if so.
6789 amount += ind_close_extra;
6791 else
6794 * If we're looking at an "else", try to find an "if"
6795 * to match it with.
6796 * If we're looking at a "while", try to find a "do"
6797 * to match it with.
6799 lookfor = LOOKFOR_INITIAL;
6800 if (cin_iselse(theline))
6801 lookfor = LOOKFOR_IF;
6802 else if (cin_iswhileofdo(theline, cur_curpos.lnum, ind_maxparen))
6803 /* XXX */
6804 lookfor = LOOKFOR_DO;
6805 if (lookfor != LOOKFOR_INITIAL)
6807 curwin->w_cursor.lnum = cur_curpos.lnum;
6808 if (find_match(lookfor, ourscope, ind_maxparen,
6809 ind_maxcomment) == OK)
6811 amount = get_indent(); /* XXX */
6812 goto theend;
6817 * We get here if we are not on an "while-of-do" or "else" (or
6818 * failed to find a matching "if").
6819 * Search backwards for something to line up with.
6820 * First set amount for when we don't find anything.
6824 * if the '{' is _really_ at the left margin, use the imaginary
6825 * location of a left-margin brace. Otherwise, correct the
6826 * location for ind_open_extra.
6829 if (start_brace == BRACE_IN_COL0) /* '{' is in column 0 */
6831 amount = ind_open_left_imag;
6833 else
6835 if (start_brace == BRACE_AT_END) /* '{' is at end of line */
6836 amount += ind_open_imag;
6837 else
6839 /* Compensate for adding ind_open_extra later. */
6840 amount -= ind_open_extra;
6841 if (amount < 0)
6842 amount = 0;
6846 lookfor_break = FALSE;
6848 if (cin_iscase(theline)) /* it's a switch() label */
6850 lookfor = LOOKFOR_CASE; /* find a previous switch() label */
6851 amount += ind_case;
6853 else if (cin_isscopedecl(theline)) /* private:, ... */
6855 lookfor = LOOKFOR_SCOPEDECL; /* class decl is this block */
6856 amount += ind_scopedecl;
6858 else
6860 if (ind_case_break && cin_isbreak(theline)) /* break; ... */
6861 lookfor_break = TRUE;
6863 lookfor = LOOKFOR_INITIAL;
6864 amount += ind_level; /* ind_level from start of block */
6866 scope_amount = amount;
6867 whilelevel = 0;
6870 * Search backwards. If we find something we recognize, line up
6871 * with that.
6873 * if we're looking at an open brace, indent
6874 * the usual amount relative to the conditional
6875 * that opens the block.
6877 curwin->w_cursor = cur_curpos;
6878 for (;;)
6880 curwin->w_cursor.lnum--;
6881 curwin->w_cursor.col = 0;
6884 * If we went all the way back to the start of our scope, line
6885 * up with it.
6887 if (curwin->w_cursor.lnum <= ourscope)
6889 /* we reached end of scope:
6890 * if looking for a enum or structure initialization
6891 * go further back:
6892 * if it is an initializer (enum xxx or xxx =), then
6893 * don't add ind_continuation, otherwise it is a variable
6894 * declaration:
6895 * int x,
6896 * here; <-- add ind_continuation
6898 if (lookfor == LOOKFOR_ENUM_OR_INIT)
6900 if (curwin->w_cursor.lnum == 0
6901 || curwin->w_cursor.lnum
6902 < ourscope - ind_maxparen)
6904 /* nothing found (abuse ind_maxparen as limit)
6905 * assume terminated line (i.e. a variable
6906 * initialization) */
6907 if (cont_amount > 0)
6908 amount = cont_amount;
6909 else
6910 amount += ind_continuation;
6911 break;
6914 l = ml_get_curline();
6917 * If we're in a comment now, skip to the start of the
6918 * comment.
6920 trypos = find_start_comment(ind_maxcomment);
6921 if (trypos != NULL)
6923 curwin->w_cursor.lnum = trypos->lnum + 1;
6924 curwin->w_cursor.col = 0;
6925 continue;
6929 * Skip preprocessor directives and blank lines.
6931 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
6932 continue;
6934 if (cin_nocode(l))
6935 continue;
6937 terminated = cin_isterminated(l, FALSE, TRUE);
6940 * If we are at top level and the line looks like a
6941 * function declaration, we are done
6942 * (it's a variable declaration).
6944 if (start_brace != BRACE_IN_COL0
6945 || !cin_isfuncdecl(&l, curwin->w_cursor.lnum))
6947 /* if the line is terminated with another ','
6948 * it is a continued variable initialization.
6949 * don't add extra indent.
6950 * TODO: does not work, if a function
6951 * declaration is split over multiple lines:
6952 * cin_isfuncdecl returns FALSE then.
6954 if (terminated == ',')
6955 break;
6957 /* if it es a enum declaration or an assignment,
6958 * we are done.
6960 if (terminated != ';' && cin_isinit())
6961 break;
6963 /* nothing useful found */
6964 if (terminated == 0 || terminated == '{')
6965 continue;
6968 if (terminated != ';')
6970 /* Skip parens and braces. Position the cursor
6971 * over the rightmost paren, so that matching it
6972 * will take us back to the start of the line.
6973 */ /* XXX */
6974 trypos = NULL;
6975 if (find_last_paren(l, '(', ')'))
6976 trypos = find_match_paren(ind_maxparen,
6977 ind_maxcomment);
6979 if (trypos == NULL && find_last_paren(l, '{', '}'))
6980 trypos = find_start_brace(ind_maxcomment);
6982 if (trypos != NULL)
6984 curwin->w_cursor.lnum = trypos->lnum + 1;
6985 curwin->w_cursor.col = 0;
6986 continue;
6990 /* it's a variable declaration, add indentation
6991 * like in
6992 * int a,
6993 * b;
6995 if (cont_amount > 0)
6996 amount = cont_amount;
6997 else
6998 amount += ind_continuation;
7000 else if (lookfor == LOOKFOR_UNTERM)
7002 if (cont_amount > 0)
7003 amount = cont_amount;
7004 else
7005 amount += ind_continuation;
7007 else if (lookfor != LOOKFOR_TERM
7008 && lookfor != LOOKFOR_CPP_BASECLASS)
7010 amount = scope_amount;
7011 if (theline[0] == '{')
7012 amount += ind_open_extra;
7014 break;
7018 * If we're in a comment now, skip to the start of the comment.
7019 */ /* XXX */
7020 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7022 curwin->w_cursor.lnum = trypos->lnum + 1;
7023 curwin->w_cursor.col = 0;
7024 continue;
7027 l = ml_get_curline();
7030 * If this is a switch() label, may line up relative to that.
7031 * If this is a C++ scope declaration, do the same.
7033 iscase = cin_iscase(l);
7034 if (iscase || cin_isscopedecl(l))
7036 /* we are only looking for cpp base class
7037 * declaration/initialization any longer */
7038 if (lookfor == LOOKFOR_CPP_BASECLASS)
7039 break;
7041 /* When looking for a "do" we are not interested in
7042 * labels. */
7043 if (whilelevel > 0)
7044 continue;
7047 * case xx:
7048 * c = 99 + <- this indent plus continuation
7049 *-> here;
7051 if (lookfor == LOOKFOR_UNTERM
7052 || lookfor == LOOKFOR_ENUM_OR_INIT)
7054 if (cont_amount > 0)
7055 amount = cont_amount;
7056 else
7057 amount += ind_continuation;
7058 break;
7062 * case xx: <- line up with this case
7063 * x = 333;
7064 * case yy:
7066 if ( (iscase && lookfor == LOOKFOR_CASE)
7067 || (iscase && lookfor_break)
7068 || (!iscase && lookfor == LOOKFOR_SCOPEDECL))
7071 * Check that this case label is not for another
7072 * switch()
7073 */ /* XXX */
7074 if ((trypos = find_start_brace(ind_maxcomment)) ==
7075 NULL || trypos->lnum == ourscope)
7077 amount = get_indent(); /* XXX */
7078 break;
7080 continue;
7083 n = get_indent_nolabel(curwin->w_cursor.lnum); /* XXX */
7086 * case xx: if (cond) <- line up with this if
7087 * y = y + 1;
7088 * -> s = 99;
7090 * case xx:
7091 * if (cond) <- line up with this line
7092 * y = y + 1;
7093 * -> s = 99;
7095 if (lookfor == LOOKFOR_TERM)
7097 if (n)
7098 amount = n;
7100 if (!lookfor_break)
7101 break;
7105 * case xx: x = x + 1; <- line up with this x
7106 * -> y = y + 1;
7108 * case xx: if (cond) <- line up with this if
7109 * -> y = y + 1;
7111 if (n)
7113 amount = n;
7114 l = after_label(ml_get_curline());
7115 if (l != NULL && cin_is_cinword(l))
7117 if (theline[0] == '{')
7118 amount += ind_open_extra;
7119 else
7120 amount += ind_level + ind_no_brace;
7122 break;
7126 * Try to get the indent of a statement before the switch
7127 * label. If nothing is found, line up relative to the
7128 * switch label.
7129 * break; <- may line up with this line
7130 * case xx:
7131 * -> y = 1;
7133 scope_amount = get_indent() + (iscase /* XXX */
7134 ? ind_case_code : ind_scopedecl_code);
7135 lookfor = ind_case_break ? LOOKFOR_NOBREAK : LOOKFOR_ANY;
7136 continue;
7140 * Looking for a switch() label or C++ scope declaration,
7141 * ignore other lines, skip {}-blocks.
7143 if (lookfor == LOOKFOR_CASE || lookfor == LOOKFOR_SCOPEDECL)
7145 if (find_last_paren(l, '{', '}') && (trypos =
7146 find_start_brace(ind_maxcomment)) != NULL)
7148 curwin->w_cursor.lnum = trypos->lnum + 1;
7149 curwin->w_cursor.col = 0;
7151 continue;
7155 * Ignore jump labels with nothing after them.
7157 if (cin_islabel(ind_maxcomment))
7159 l = after_label(ml_get_curline());
7160 if (l == NULL || cin_nocode(l))
7161 continue;
7165 * Ignore #defines, #if, etc.
7166 * Ignore comment and empty lines.
7167 * (need to get the line again, cin_islabel() may have
7168 * unlocked it)
7170 l = ml_get_curline();
7171 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum)
7172 || cin_nocode(l))
7173 continue;
7176 * Are we at the start of a cpp base class declaration or
7177 * constructor initialization?
7178 */ /* XXX */
7179 n = FALSE;
7180 if (lookfor != LOOKFOR_TERM && ind_cpp_baseclass > 0)
7182 n = cin_is_cpp_baseclass(&col);
7183 l = ml_get_curline();
7185 if (n)
7187 if (lookfor == LOOKFOR_UNTERM)
7189 if (cont_amount > 0)
7190 amount = cont_amount;
7191 else
7192 amount += ind_continuation;
7194 else if (theline[0] == '{')
7196 /* Need to find start of the declaration. */
7197 lookfor = LOOKFOR_UNTERM;
7198 ind_continuation = 0;
7199 continue;
7201 else
7202 /* XXX */
7203 amount = get_baseclass_amount(col, ind_maxparen,
7204 ind_maxcomment, ind_cpp_baseclass);
7205 break;
7207 else if (lookfor == LOOKFOR_CPP_BASECLASS)
7209 /* only look, whether there is a cpp base class
7210 * declaration or initialization before the opening brace.
7212 if (cin_isterminated(l, TRUE, FALSE))
7213 break;
7214 else
7215 continue;
7219 * What happens next depends on the line being terminated.
7220 * If terminated with a ',' only consider it terminating if
7221 * there is another unterminated statement behind, eg:
7222 * 123,
7223 * sizeof
7224 * here
7225 * Otherwise check whether it is a enumeration or structure
7226 * initialisation (not indented) or a variable declaration
7227 * (indented).
7229 terminated = cin_isterminated(l, FALSE, TRUE);
7231 if (terminated == 0 || (lookfor != LOOKFOR_UNTERM
7232 && terminated == ','))
7235 * if we're in the middle of a paren thing,
7236 * go back to the line that starts it so
7237 * we can get the right prevailing indent
7238 * if ( foo &&
7239 * bar )
7242 * position the cursor over the rightmost paren, so that
7243 * matching it will take us back to the start of the line.
7245 (void)find_last_paren(l, '(', ')');
7246 trypos = find_match_paren(
7247 corr_ind_maxparen(ind_maxparen, &cur_curpos),
7248 ind_maxcomment);
7251 * If we are looking for ',', we also look for matching
7252 * braces.
7254 if (trypos == NULL && terminated == ','
7255 && find_last_paren(l, '{', '}'))
7256 trypos = find_start_brace(ind_maxcomment);
7258 if (trypos != NULL)
7261 * Check if we are on a case label now. This is
7262 * handled above.
7263 * case xx: if ( asdf &&
7264 * asdf)
7266 curwin->w_cursor = *trypos;
7267 l = ml_get_curline();
7268 if (cin_iscase(l) || cin_isscopedecl(l))
7270 ++curwin->w_cursor.lnum;
7271 curwin->w_cursor.col = 0;
7272 continue;
7277 * Skip over continuation lines to find the one to get the
7278 * indent from
7279 * char *usethis = "bla\
7280 * bla",
7281 * here;
7283 if (terminated == ',')
7285 while (curwin->w_cursor.lnum > 1)
7287 l = ml_get(curwin->w_cursor.lnum - 1);
7288 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7289 break;
7290 --curwin->w_cursor.lnum;
7291 curwin->w_cursor.col = 0;
7296 * Get indent and pointer to text for current line,
7297 * ignoring any jump label. XXX
7299 cur_amount = skip_label(curwin->w_cursor.lnum,
7300 &l, ind_maxcomment);
7303 * If this is just above the line we are indenting, and it
7304 * starts with a '{', line it up with this line.
7305 * while (not)
7306 * -> {
7309 if (terminated != ',' && lookfor != LOOKFOR_TERM
7310 && theline[0] == '{')
7312 amount = cur_amount;
7314 * Only add ind_open_extra when the current line
7315 * doesn't start with a '{', which must have a match
7316 * in the same line (scope is the same). Probably:
7317 * { 1, 2 },
7318 * -> { 3, 4 }
7320 if (*skipwhite(l) != '{')
7321 amount += ind_open_extra;
7323 if (ind_cpp_baseclass)
7325 /* have to look back, whether it is a cpp base
7326 * class declaration or initialization */
7327 lookfor = LOOKFOR_CPP_BASECLASS;
7328 continue;
7330 break;
7334 * Check if we are after an "if", "while", etc.
7335 * Also allow " } else".
7337 if (cin_is_cinword(l) || cin_iselse(skipwhite(l)))
7340 * Found an unterminated line after an if (), line up
7341 * with the last one.
7342 * if (cond)
7343 * 100 +
7344 * -> here;
7346 if (lookfor == LOOKFOR_UNTERM
7347 || lookfor == LOOKFOR_ENUM_OR_INIT)
7349 if (cont_amount > 0)
7350 amount = cont_amount;
7351 else
7352 amount += ind_continuation;
7353 break;
7357 * If this is just above the line we are indenting, we
7358 * are finished.
7359 * while (not)
7360 * -> here;
7361 * Otherwise this indent can be used when the line
7362 * before this is terminated.
7363 * yyy;
7364 * if (stat)
7365 * while (not)
7366 * xxx;
7367 * -> here;
7369 amount = cur_amount;
7370 if (theline[0] == '{')
7371 amount += ind_open_extra;
7372 if (lookfor != LOOKFOR_TERM)
7374 amount += ind_level + ind_no_brace;
7375 break;
7379 * Special trick: when expecting the while () after a
7380 * do, line up with the while()
7381 * do
7382 * x = 1;
7383 * -> here
7385 l = skipwhite(ml_get_curline());
7386 if (cin_isdo(l))
7388 if (whilelevel == 0)
7389 break;
7390 --whilelevel;
7394 * When searching for a terminated line, don't use the
7395 * one between the "if" and the "else".
7396 * Need to use the scope of this "else". XXX
7397 * If whilelevel != 0 continue looking for a "do {".
7399 if (cin_iselse(l)
7400 && whilelevel == 0
7401 && ((trypos = find_start_brace(ind_maxcomment))
7402 == NULL
7403 || find_match(LOOKFOR_IF, trypos->lnum,
7404 ind_maxparen, ind_maxcomment) == FAIL))
7405 break;
7409 * If we're below an unterminated line that is not an
7410 * "if" or something, we may line up with this line or
7411 * add something for a continuation line, depending on
7412 * the line before this one.
7414 else
7417 * Found two unterminated lines on a row, line up with
7418 * the last one.
7419 * c = 99 +
7420 * 100 +
7421 * -> here;
7423 if (lookfor == LOOKFOR_UNTERM)
7425 /* When line ends in a comma add extra indent */
7426 if (terminated == ',')
7427 amount += ind_continuation;
7428 break;
7431 if (lookfor == LOOKFOR_ENUM_OR_INIT)
7433 /* Found two lines ending in ',', lineup with the
7434 * lowest one, but check for cpp base class
7435 * declaration/initialization, if it is an
7436 * opening brace or we are looking just for
7437 * enumerations/initializations. */
7438 if (terminated == ',')
7440 if (ind_cpp_baseclass == 0)
7441 break;
7443 lookfor = LOOKFOR_CPP_BASECLASS;
7444 continue;
7447 /* Ignore unterminated lines in between, but
7448 * reduce indent. */
7449 if (amount > cur_amount)
7450 amount = cur_amount;
7452 else
7455 * Found first unterminated line on a row, may
7456 * line up with this line, remember its indent
7457 * 100 +
7458 * -> here;
7460 amount = cur_amount;
7463 * If previous line ends in ',', check whether we
7464 * are in an initialization or enum
7465 * struct xxx =
7467 * sizeof a,
7468 * 124 };
7469 * or a normal possible continuation line.
7470 * but only, of no other statement has been found
7471 * yet.
7473 if (lookfor == LOOKFOR_INITIAL && terminated == ',')
7475 lookfor = LOOKFOR_ENUM_OR_INIT;
7476 cont_amount = cin_first_id_amount();
7478 else
7480 if (lookfor == LOOKFOR_INITIAL
7481 && *l != NUL
7482 && l[STRLEN(l) - 1] == '\\')
7483 /* XXX */
7484 cont_amount = cin_get_equal_amount(
7485 curwin->w_cursor.lnum);
7486 if (lookfor != LOOKFOR_TERM)
7487 lookfor = LOOKFOR_UNTERM;
7494 * Check if we are after a while (cond);
7495 * If so: Ignore until the matching "do".
7497 /* XXX */
7498 else if (cin_iswhileofdo_end(terminated, ind_maxparen,
7499 ind_maxcomment))
7502 * Found an unterminated line after a while ();, line up
7503 * with the last one.
7504 * while (cond);
7505 * 100 + <- line up with this one
7506 * -> here;
7508 if (lookfor == LOOKFOR_UNTERM
7509 || lookfor == LOOKFOR_ENUM_OR_INIT)
7511 if (cont_amount > 0)
7512 amount = cont_amount;
7513 else
7514 amount += ind_continuation;
7515 break;
7518 if (whilelevel == 0)
7520 lookfor = LOOKFOR_TERM;
7521 amount = get_indent(); /* XXX */
7522 if (theline[0] == '{')
7523 amount += ind_open_extra;
7525 ++whilelevel;
7529 * We are after a "normal" statement.
7530 * If we had another statement we can stop now and use the
7531 * indent of that other statement.
7532 * Otherwise the indent of the current statement may be used,
7533 * search backwards for the next "normal" statement.
7535 else
7538 * Skip single break line, if before a switch label. It
7539 * may be lined up with the case label.
7541 if (lookfor == LOOKFOR_NOBREAK
7542 && cin_isbreak(skipwhite(ml_get_curline())))
7544 lookfor = LOOKFOR_ANY;
7545 continue;
7549 * Handle "do {" line.
7551 if (whilelevel > 0)
7553 l = cin_skipcomment(ml_get_curline());
7554 if (cin_isdo(l))
7556 amount = get_indent(); /* XXX */
7557 --whilelevel;
7558 continue;
7563 * Found a terminated line above an unterminated line. Add
7564 * the amount for a continuation line.
7565 * x = 1;
7566 * y = foo +
7567 * -> here;
7568 * or
7569 * int x = 1;
7570 * int foo,
7571 * -> here;
7573 if (lookfor == LOOKFOR_UNTERM
7574 || lookfor == LOOKFOR_ENUM_OR_INIT)
7576 if (cont_amount > 0)
7577 amount = cont_amount;
7578 else
7579 amount += ind_continuation;
7580 break;
7584 * Found a terminated line above a terminated line or "if"
7585 * etc. line. Use the amount of the line below us.
7586 * x = 1; x = 1;
7587 * if (asdf) y = 2;
7588 * while (asdf) ->here;
7589 * here;
7590 * ->foo;
7592 if (lookfor == LOOKFOR_TERM)
7594 if (!lookfor_break && whilelevel == 0)
7595 break;
7599 * First line above the one we're indenting is terminated.
7600 * To know what needs to be done look further backward for
7601 * a terminated line.
7603 else
7606 * position the cursor over the rightmost paren, so
7607 * that matching it will take us back to the start of
7608 * the line. Helps for:
7609 * func(asdr,
7610 * asdfasdf);
7611 * here;
7613 term_again:
7614 l = ml_get_curline();
7615 if (find_last_paren(l, '(', ')')
7616 && (trypos = find_match_paren(ind_maxparen,
7617 ind_maxcomment)) != NULL)
7620 * Check if we are on a case label now. This is
7621 * handled above.
7622 * case xx: if ( asdf &&
7623 * asdf)
7625 curwin->w_cursor = *trypos;
7626 l = ml_get_curline();
7627 if (cin_iscase(l) || cin_isscopedecl(l))
7629 ++curwin->w_cursor.lnum;
7630 curwin->w_cursor.col = 0;
7631 continue;
7635 /* When aligning with the case statement, don't align
7636 * with a statement after it.
7637 * case 1: { <-- don't use this { position
7638 * stat;
7640 * case 2:
7641 * stat;
7644 iscase = (ind_keep_case_label && cin_iscase(l));
7647 * Get indent and pointer to text for current line,
7648 * ignoring any jump label.
7650 amount = skip_label(curwin->w_cursor.lnum,
7651 &l, ind_maxcomment);
7653 if (theline[0] == '{')
7654 amount += ind_open_extra;
7655 /* See remark above: "Only add ind_open_extra.." */
7656 l = skipwhite(l);
7657 if (*l == '{')
7658 amount -= ind_open_extra;
7659 lookfor = iscase ? LOOKFOR_ANY : LOOKFOR_TERM;
7662 * When a terminated line starts with "else" skip to
7663 * the matching "if":
7664 * else 3;
7665 * indent this;
7666 * Need to use the scope of this "else". XXX
7667 * If whilelevel != 0 continue looking for a "do {".
7669 if (lookfor == LOOKFOR_TERM
7670 && *l != '}'
7671 && cin_iselse(l)
7672 && whilelevel == 0)
7674 if ((trypos = find_start_brace(ind_maxcomment))
7675 == NULL
7676 || find_match(LOOKFOR_IF, trypos->lnum,
7677 ind_maxparen, ind_maxcomment) == FAIL)
7678 break;
7679 continue;
7683 * If we're at the end of a block, skip to the start of
7684 * that block.
7686 curwin->w_cursor.col = 0;
7687 if (*cin_skipcomment(l) == '}'
7688 && (trypos = find_start_brace(ind_maxcomment))
7689 != NULL) /* XXX */
7691 curwin->w_cursor = *trypos;
7692 /* if not "else {" check for terminated again */
7693 /* but skip block for "} else {" */
7694 l = cin_skipcomment(ml_get_curline());
7695 if (*l == '}' || !cin_iselse(l))
7696 goto term_again;
7697 ++curwin->w_cursor.lnum;
7698 curwin->w_cursor.col = 0;
7706 /* add extra indent for a comment */
7707 if (cin_iscomment(theline))
7708 amount += ind_comment;
7712 * ok -- we're not inside any sort of structure at all!
7714 * this means we're at the top level, and everything should
7715 * basically just match where the previous line is, except
7716 * for the lines immediately following a function declaration,
7717 * which are K&R-style parameters and need to be indented.
7719 else
7722 * if our line starts with an open brace, forget about any
7723 * prevailing indent and make sure it looks like the start
7724 * of a function
7727 if (theline[0] == '{')
7729 amount = ind_first_open;
7733 * If the NEXT line is a function declaration, the current
7734 * line needs to be indented as a function type spec.
7735 * Don't do this if the current line looks like a comment or if the
7736 * current line is terminated, ie. ends in ';', or if the current line
7737 * contains { or }: "void f() {\n if (1)"
7739 else if (cur_curpos.lnum < curbuf->b_ml.ml_line_count
7740 && !cin_nocode(theline)
7741 && vim_strchr(theline, '{') == NULL
7742 && vim_strchr(theline, '}') == NULL
7743 && !cin_ends_in(theline, (char_u *)":", NULL)
7744 && !cin_ends_in(theline, (char_u *)",", NULL)
7745 && cin_isfuncdecl(NULL, cur_curpos.lnum + 1)
7746 && !cin_isterminated(theline, FALSE, TRUE))
7748 amount = ind_func_type;
7750 else
7752 amount = 0;
7753 curwin->w_cursor = cur_curpos;
7755 /* search backwards until we find something we recognize */
7757 while (curwin->w_cursor.lnum > 1)
7759 curwin->w_cursor.lnum--;
7760 curwin->w_cursor.col = 0;
7762 l = ml_get_curline();
7765 * If we're in a comment now, skip to the start of the comment.
7766 */ /* XXX */
7767 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7769 curwin->w_cursor.lnum = trypos->lnum + 1;
7770 curwin->w_cursor.col = 0;
7771 continue;
7775 * Are we at the start of a cpp base class declaration or
7776 * constructor initialization?
7777 */ /* XXX */
7778 n = FALSE;
7779 if (ind_cpp_baseclass != 0 && theline[0] != '{')
7781 n = cin_is_cpp_baseclass(&col);
7782 l = ml_get_curline();
7784 if (n)
7786 /* XXX */
7787 amount = get_baseclass_amount(col, ind_maxparen,
7788 ind_maxcomment, ind_cpp_baseclass);
7789 break;
7793 * Skip preprocessor directives and blank lines.
7795 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
7796 continue;
7798 if (cin_nocode(l))
7799 continue;
7802 * If the previous line ends in ',', use one level of
7803 * indentation:
7804 * int foo,
7805 * bar;
7806 * do this before checking for '}' in case of eg.
7807 * enum foobar
7809 * ...
7810 * } foo,
7811 * bar;
7813 n = 0;
7814 if (cin_ends_in(l, (char_u *)",", NULL)
7815 || (*l != NUL && (n = l[STRLEN(l) - 1]) == '\\'))
7817 /* take us back to opening paren */
7818 if (find_last_paren(l, '(', ')')
7819 && (trypos = find_match_paren(ind_maxparen,
7820 ind_maxcomment)) != NULL)
7821 curwin->w_cursor = *trypos;
7823 /* For a line ending in ',' that is a continuation line go
7824 * back to the first line with a backslash:
7825 * char *foo = "bla\
7826 * bla",
7827 * here;
7829 while (n == 0 && curwin->w_cursor.lnum > 1)
7831 l = ml_get(curwin->w_cursor.lnum - 1);
7832 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7833 break;
7834 --curwin->w_cursor.lnum;
7835 curwin->w_cursor.col = 0;
7838 amount = get_indent(); /* XXX */
7840 if (amount == 0)
7841 amount = cin_first_id_amount();
7842 if (amount == 0)
7843 amount = ind_continuation;
7844 break;
7848 * If the line looks like a function declaration, and we're
7849 * not in a comment, put it the left margin.
7851 if (cin_isfuncdecl(NULL, cur_curpos.lnum)) /* XXX */
7852 break;
7853 l = ml_get_curline();
7856 * Finding the closing '}' of a previous function. Put
7857 * current line at the left margin. For when 'cino' has "fs".
7859 if (*skipwhite(l) == '}')
7860 break;
7862 /* (matching {)
7863 * If the previous line ends on '};' (maybe followed by
7864 * comments) align at column 0. For example:
7865 * char *string_array[] = { "foo",
7866 * / * x * / "b};ar" }; / * foobar * /
7868 if (cin_ends_in(l, (char_u *)"};", NULL))
7869 break;
7872 * If the PREVIOUS line is a function declaration, the current
7873 * line (and the ones that follow) needs to be indented as
7874 * parameters.
7876 if (cin_isfuncdecl(&l, curwin->w_cursor.lnum))
7878 amount = ind_param;
7879 break;
7883 * If the previous line ends in ';' and the line before the
7884 * previous line ends in ',' or '\', ident to column zero:
7885 * int foo,
7886 * bar;
7887 * indent_to_0 here;
7889 if (cin_ends_in(l, (char_u *)";", NULL))
7891 l = ml_get(curwin->w_cursor.lnum - 1);
7892 if (cin_ends_in(l, (char_u *)",", NULL)
7893 || (*l != NUL && l[STRLEN(l) - 1] == '\\'))
7894 break;
7895 l = ml_get_curline();
7899 * Doesn't look like anything interesting -- so just
7900 * use the indent of this line.
7902 * Position the cursor over the rightmost paren, so that
7903 * matching it will take us back to the start of the line.
7905 find_last_paren(l, '(', ')');
7907 if ((trypos = find_match_paren(ind_maxparen,
7908 ind_maxcomment)) != NULL)
7909 curwin->w_cursor = *trypos;
7910 amount = get_indent(); /* XXX */
7911 break;
7914 /* add extra indent for a comment */
7915 if (cin_iscomment(theline))
7916 amount += ind_comment;
7918 /* add extra indent if the previous line ended in a backslash:
7919 * "asdfasdf\
7920 * here";
7921 * char *foo = "asdf\
7922 * here";
7924 if (cur_curpos.lnum > 1)
7926 l = ml_get(cur_curpos.lnum - 1);
7927 if (*l != NUL && l[STRLEN(l) - 1] == '\\')
7929 cur_amount = cin_get_equal_amount(cur_curpos.lnum - 1);
7930 if (cur_amount > 0)
7931 amount = cur_amount;
7932 else if (cur_amount == 0)
7933 amount += ind_continuation;
7939 theend:
7940 /* put the cursor back where it belongs */
7941 curwin->w_cursor = cur_curpos;
7943 vim_free(linecopy);
7945 if (amount < 0)
7946 return 0;
7947 return amount;
7950 static int
7951 find_match(lookfor, ourscope, ind_maxparen, ind_maxcomment)
7952 int lookfor;
7953 linenr_T ourscope;
7954 int ind_maxparen;
7955 int ind_maxcomment;
7957 char_u *look;
7958 pos_T *theirscope;
7959 char_u *mightbeif;
7960 int elselevel;
7961 int whilelevel;
7963 if (lookfor == LOOKFOR_IF)
7965 elselevel = 1;
7966 whilelevel = 0;
7968 else
7970 elselevel = 0;
7971 whilelevel = 1;
7974 curwin->w_cursor.col = 0;
7976 while (curwin->w_cursor.lnum > ourscope + 1)
7978 curwin->w_cursor.lnum--;
7979 curwin->w_cursor.col = 0;
7981 look = cin_skipcomment(ml_get_curline());
7982 if (cin_iselse(look)
7983 || cin_isif(look)
7984 || cin_isdo(look) /* XXX */
7985 || cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7988 * if we've gone outside the braces entirely,
7989 * we must be out of scope...
7991 theirscope = find_start_brace(ind_maxcomment); /* XXX */
7992 if (theirscope == NULL)
7993 break;
7996 * and if the brace enclosing this is further
7997 * back than the one enclosing the else, we're
7998 * out of luck too.
8000 if (theirscope->lnum < ourscope)
8001 break;
8004 * and if they're enclosed in a *deeper* brace,
8005 * then we can ignore it because it's in a
8006 * different scope...
8008 if (theirscope->lnum > ourscope)
8009 continue;
8012 * if it was an "else" (that's not an "else if")
8013 * then we need to go back to another if, so
8014 * increment elselevel
8016 look = cin_skipcomment(ml_get_curline());
8017 if (cin_iselse(look))
8019 mightbeif = cin_skipcomment(look + 4);
8020 if (!cin_isif(mightbeif))
8021 ++elselevel;
8022 continue;
8026 * if it was a "while" then we need to go back to
8027 * another "do", so increment whilelevel. XXX
8029 if (cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
8031 ++whilelevel;
8032 continue;
8035 /* If it's an "if" decrement elselevel */
8036 look = cin_skipcomment(ml_get_curline());
8037 if (cin_isif(look))
8039 elselevel--;
8041 * When looking for an "if" ignore "while"s that
8042 * get in the way.
8044 if (elselevel == 0 && lookfor == LOOKFOR_IF)
8045 whilelevel = 0;
8048 /* If it's a "do" decrement whilelevel */
8049 if (cin_isdo(look))
8050 whilelevel--;
8053 * if we've used up all the elses, then
8054 * this must be the if that we want!
8055 * match the indent level of that if.
8057 if (elselevel <= 0 && whilelevel <= 0)
8059 return OK;
8063 return FAIL;
8066 # if defined(FEAT_EVAL) || defined(PROTO)
8068 * Get indent level from 'indentexpr'.
8071 get_expr_indent()
8073 int indent;
8074 pos_T pos;
8075 int save_State;
8076 int use_sandbox = was_set_insecurely((char_u *)"indentexpr",
8077 OPT_LOCAL);
8079 pos = curwin->w_cursor;
8080 set_vim_var_nr(VV_LNUM, curwin->w_cursor.lnum);
8081 if (use_sandbox)
8082 ++sandbox;
8083 ++textlock;
8084 indent = eval_to_number(curbuf->b_p_inde);
8085 if (use_sandbox)
8086 --sandbox;
8087 --textlock;
8089 /* Restore the cursor position so that 'indentexpr' doesn't need to.
8090 * Pretend to be in Insert mode, allow cursor past end of line for "o"
8091 * command. */
8092 save_State = State;
8093 State = INSERT;
8094 curwin->w_cursor = pos;
8095 check_cursor();
8096 State = save_State;
8098 /* If there is an error, just keep the current indent. */
8099 if (indent < 0)
8100 indent = get_indent();
8102 return indent;
8104 # endif
8106 #endif /* FEAT_CINDENT */
8108 #if defined(FEAT_LISP) || defined(PROTO)
8110 static int lisp_match __ARGS((char_u *p));
8112 static int
8113 lisp_match(p)
8114 char_u *p;
8116 char_u buf[LSIZE];
8117 int len;
8118 char_u *word = p_lispwords;
8120 while (*word != NUL)
8122 (void)copy_option_part(&word, buf, LSIZE, ",");
8123 len = (int)STRLEN(buf);
8124 if (STRNCMP(buf, p, len) == 0 && p[len] == ' ')
8125 return TRUE;
8127 return FALSE;
8131 * When 'p' is present in 'cpoptions, a Vi compatible method is used.
8132 * The incompatible newer method is quite a bit better at indenting
8133 * code in lisp-like languages than the traditional one; it's still
8134 * mostly heuristics however -- Dirk van Deun, dirk@rave.org
8136 * TODO:
8137 * Findmatch() should be adapted for lisp, also to make showmatch
8138 * work correctly: now (v5.3) it seems all C/C++ oriented:
8139 * - it does not recognize the #\( and #\) notations as character literals
8140 * - it doesn't know about comments starting with a semicolon
8141 * - it incorrectly interprets '(' as a character literal
8142 * All this messes up get_lisp_indent in some rare cases.
8143 * Update from Sergey Khorev:
8144 * I tried to fix the first two issues.
8147 get_lisp_indent()
8149 pos_T *pos, realpos, paren;
8150 int amount;
8151 char_u *that;
8152 colnr_T col;
8153 colnr_T firsttry;
8154 int parencount, quotecount;
8155 int vi_lisp;
8157 /* Set vi_lisp to use the vi-compatible method */
8158 vi_lisp = (vim_strchr(p_cpo, CPO_LISP) != NULL);
8160 realpos = curwin->w_cursor;
8161 curwin->w_cursor.col = 0;
8163 if ((pos = findmatch(NULL, '(')) == NULL)
8164 pos = findmatch(NULL, '[');
8165 else
8167 paren = *pos;
8168 pos = findmatch(NULL, '[');
8169 if (pos == NULL || ltp(pos, &paren))
8170 pos = &paren;
8172 if (pos != NULL)
8174 /* Extra trick: Take the indent of the first previous non-white
8175 * line that is at the same () level. */
8176 amount = -1;
8177 parencount = 0;
8179 while (--curwin->w_cursor.lnum >= pos->lnum)
8181 if (linewhite(curwin->w_cursor.lnum))
8182 continue;
8183 for (that = ml_get_curline(); *that != NUL; ++that)
8185 if (*that == ';')
8187 while (*(that + 1) != NUL)
8188 ++that;
8189 continue;
8191 if (*that == '\\')
8193 if (*(that + 1) != NUL)
8194 ++that;
8195 continue;
8197 if (*that == '"' && *(that + 1) != NUL)
8199 while (*++that && *that != '"')
8201 /* skipping escaped characters in the string */
8202 if (*that == '\\')
8204 if (*++that == NUL)
8205 break;
8206 if (that[1] == NUL)
8208 ++that;
8209 break;
8214 if (*that == '(' || *that == '[')
8215 ++parencount;
8216 else if (*that == ')' || *that == ']')
8217 --parencount;
8219 if (parencount == 0)
8221 amount = get_indent();
8222 break;
8226 if (amount == -1)
8228 curwin->w_cursor.lnum = pos->lnum;
8229 curwin->w_cursor.col = pos->col;
8230 col = pos->col;
8232 that = ml_get_curline();
8234 if (vi_lisp && get_indent() == 0)
8235 amount = 2;
8236 else
8238 amount = 0;
8239 while (*that && col)
8241 amount += lbr_chartabsize_adv(&that, (colnr_T)amount);
8242 col--;
8246 * Some keywords require "body" indenting rules (the
8247 * non-standard-lisp ones are Scheme special forms):
8249 * (let ((a 1)) instead (let ((a 1))
8250 * (...)) of (...))
8253 if (!vi_lisp && (*that == '(' || *that == '[')
8254 && lisp_match(that + 1))
8255 amount += 2;
8256 else
8258 that++;
8259 amount++;
8260 firsttry = amount;
8262 while (vim_iswhite(*that))
8264 amount += lbr_chartabsize(that, (colnr_T)amount);
8265 ++that;
8268 if (*that && *that != ';') /* not a comment line */
8270 /* test *that != '(' to accommodate first let/do
8271 * argument if it is more than one line */
8272 if (!vi_lisp && *that != '(' && *that != '[')
8273 firsttry++;
8275 parencount = 0;
8276 quotecount = 0;
8278 if (vi_lisp
8279 || (*that != '"'
8280 && *that != '\''
8281 && *that != '#'
8282 && (*that < '0' || *that > '9')))
8284 while (*that
8285 && (!vim_iswhite(*that)
8286 || quotecount
8287 || parencount)
8288 && (!((*that == '(' || *that == '[')
8289 && !quotecount
8290 && !parencount
8291 && vi_lisp)))
8293 if (*that == '"')
8294 quotecount = !quotecount;
8295 if ((*that == '(' || *that == '[')
8296 && !quotecount)
8297 ++parencount;
8298 if ((*that == ')' || *that == ']')
8299 && !quotecount)
8300 --parencount;
8301 if (*that == '\\' && *(that+1) != NUL)
8302 amount += lbr_chartabsize_adv(&that,
8303 (colnr_T)amount);
8304 amount += lbr_chartabsize_adv(&that,
8305 (colnr_T)amount);
8308 while (vim_iswhite(*that))
8310 amount += lbr_chartabsize(that, (colnr_T)amount);
8311 that++;
8313 if (!*that || *that == ';')
8314 amount = firsttry;
8320 else
8321 amount = 0; /* no matching '(' or '[' found, use zero indent */
8323 curwin->w_cursor = realpos;
8325 return amount;
8327 #endif /* FEAT_LISP */
8329 void
8330 prepare_to_exit()
8332 #if defined(SIGHUP) && defined(SIG_IGN)
8333 /* Ignore SIGHUP, because a dropped connection causes a read error, which
8334 * makes Vim exit and then handling SIGHUP causes various reentrance
8335 * problems. */
8336 signal(SIGHUP, SIG_IGN);
8337 #endif
8339 #ifdef FEAT_GUI
8340 if (gui.in_use)
8342 gui.dying = TRUE;
8343 out_trash(); /* trash any pending output */
8345 else
8346 #endif
8348 windgoto((int)Rows - 1, 0);
8351 * Switch terminal mode back now, so messages end up on the "normal"
8352 * screen (if there are two screens).
8354 settmode(TMODE_COOK);
8355 #ifdef WIN3264
8356 if (can_end_termcap_mode(FALSE) == TRUE)
8357 #endif
8358 stoptermcap();
8359 out_flush();
8364 * Preserve files and exit.
8365 * When called IObuff must contain a message.
8367 void
8368 preserve_exit()
8370 buf_T *buf;
8372 prepare_to_exit();
8374 /* Setting this will prevent free() calls. That avoids calling free()
8375 * recursively when free() was invoked with a bad pointer. */
8376 really_exiting = TRUE;
8378 out_str(IObuff);
8379 screen_start(); /* don't know where cursor is now */
8380 out_flush();
8382 ml_close_notmod(); /* close all not-modified buffers */
8384 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8386 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
8388 OUT_STR(_("Vim: preserving files...\n"));
8389 screen_start(); /* don't know where cursor is now */
8390 out_flush();
8391 ml_sync_all(FALSE, FALSE); /* preserve all swap files */
8392 break;
8396 ml_close_all(FALSE); /* close all memfiles, without deleting */
8398 OUT_STR(_("Vim: Finished.\n"));
8400 getout(1);
8404 * return TRUE if "fname" exists.
8407 vim_fexists(fname)
8408 char_u *fname;
8410 struct stat st;
8412 if (mch_stat((char *)fname, &st))
8413 return FALSE;
8414 return TRUE;
8418 * Check for CTRL-C pressed, but only once in a while.
8419 * Should be used instead of ui_breakcheck() for functions that check for
8420 * each line in the file. Calling ui_breakcheck() each time takes too much
8421 * time, because it can be a system call.
8424 #ifndef BREAKCHECK_SKIP
8425 # ifdef FEAT_GUI /* assume the GUI only runs on fast computers */
8426 # define BREAKCHECK_SKIP 200
8427 # else
8428 # define BREAKCHECK_SKIP 32
8429 # endif
8430 #endif
8432 static int breakcheck_count = 0;
8434 void
8435 line_breakcheck()
8437 if (++breakcheck_count >= BREAKCHECK_SKIP)
8439 breakcheck_count = 0;
8440 ui_breakcheck();
8445 * Like line_breakcheck() but check 10 times less often.
8447 void
8448 fast_breakcheck()
8450 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
8452 breakcheck_count = 0;
8453 ui_breakcheck();
8458 * Invoke expand_wildcards() for one pattern.
8459 * Expand items like "%:h" before the expansion.
8460 * Returns OK or FAIL.
8463 expand_wildcards_eval(pat, num_file, file, flags)
8464 char_u **pat; /* pointer to input pattern */
8465 int *num_file; /* resulting number of files */
8466 char_u ***file; /* array of resulting files */
8467 int flags; /* EW_DIR, etc. */
8469 int ret = FAIL;
8470 char_u *eval_pat = NULL;
8471 char_u *exp_pat = *pat;
8472 char_u *ignored_msg;
8473 int usedlen;
8475 if (*exp_pat == '%' || *exp_pat == '#' || *exp_pat == '<')
8477 ++emsg_off;
8478 eval_pat = eval_vars(exp_pat, exp_pat, &usedlen,
8479 NULL, &ignored_msg, NULL);
8480 --emsg_off;
8481 if (eval_pat != NULL)
8482 exp_pat = concat_str(eval_pat, exp_pat + usedlen);
8485 if (exp_pat != NULL)
8486 ret = expand_wildcards(1, &exp_pat, num_file, file, flags);
8488 if (eval_pat != NULL)
8490 vim_free(exp_pat);
8491 vim_free(eval_pat);
8494 return ret;
8498 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
8499 * 'wildignore'.
8500 * Returns OK or FAIL.
8503 expand_wildcards(num_pat, pat, num_file, file, flags)
8504 int num_pat; /* number of input patterns */
8505 char_u **pat; /* array of input patterns */
8506 int *num_file; /* resulting number of files */
8507 char_u ***file; /* array of resulting files */
8508 int flags; /* EW_DIR, etc. */
8510 int retval;
8511 int i, j;
8512 char_u *p;
8513 int non_suf_match; /* number without matching suffix */
8515 retval = gen_expand_wildcards(num_pat, pat, num_file, file, flags);
8517 /* When keeping all matches, return here */
8518 if (flags & EW_KEEPALL)
8519 return retval;
8521 #ifdef FEAT_WILDIGN
8523 * Remove names that match 'wildignore'.
8525 if (*p_wig)
8527 char_u *ffname;
8529 /* check all files in (*file)[] */
8530 for (i = 0; i < *num_file; ++i)
8532 ffname = FullName_save((*file)[i], FALSE);
8533 if (ffname == NULL) /* out of memory */
8534 break;
8535 # ifdef VMS
8536 vms_remove_version(ffname);
8537 # endif
8538 if (match_file_list(p_wig, (*file)[i], ffname))
8540 /* remove this matching file from the list */
8541 vim_free((*file)[i]);
8542 for (j = i; j + 1 < *num_file; ++j)
8543 (*file)[j] = (*file)[j + 1];
8544 --*num_file;
8545 --i;
8547 vim_free(ffname);
8550 #endif
8553 * Move the names where 'suffixes' match to the end.
8555 if (*num_file > 1)
8557 non_suf_match = 0;
8558 for (i = 0; i < *num_file; ++i)
8560 if (!match_suffix((*file)[i]))
8563 * Move the name without matching suffix to the front
8564 * of the list.
8566 p = (*file)[i];
8567 for (j = i; j > non_suf_match; --j)
8568 (*file)[j] = (*file)[j - 1];
8569 (*file)[non_suf_match++] = p;
8574 return retval;
8578 * Return TRUE if "fname" matches with an entry in 'suffixes'.
8581 match_suffix(fname)
8582 char_u *fname;
8584 int fnamelen, setsuflen;
8585 char_u *setsuf;
8586 #define MAXSUFLEN 30 /* maximum length of a file suffix */
8587 char_u suf_buf[MAXSUFLEN];
8589 fnamelen = (int)STRLEN(fname);
8590 setsuflen = 0;
8591 for (setsuf = p_su; *setsuf; )
8593 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
8594 if (setsuflen == 0)
8596 char_u *tail = gettail(fname);
8598 /* empty entry: match name without a '.' */
8599 if (vim_strchr(tail, '.') == NULL)
8601 setsuflen = 1;
8602 break;
8605 else
8607 if (fnamelen >= setsuflen
8608 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
8609 (size_t)setsuflen) == 0)
8610 break;
8611 setsuflen = 0;
8614 return (setsuflen != 0);
8617 #if !defined(NO_EXPANDPATH) || defined(PROTO)
8619 # ifdef VIM_BACKTICK
8620 static int vim_backtick __ARGS((char_u *p));
8621 static int expand_backtick __ARGS((garray_T *gap, char_u *pat, int flags));
8622 # endif
8624 # if defined(MSDOS) || defined(FEAT_GUI_W16) || defined(WIN3264)
8626 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
8627 * it's shared between these systems.
8629 # if defined(DJGPP) || defined(PROTO)
8630 # define _cdecl /* DJGPP doesn't have this */
8631 # else
8632 # ifdef __BORLANDC__
8633 # define _cdecl _RTLENTRYF
8634 # endif
8635 # endif
8638 * comparison function for qsort in dos_expandpath()
8640 static int _cdecl
8641 pstrcmp(const void *a, const void *b)
8643 return (pathcmp(*(char **)a, *(char **)b, -1));
8646 # ifndef WIN3264
8647 static void
8648 namelowcpy(
8649 char_u *d,
8650 char_u *s)
8652 # ifdef DJGPP
8653 if (USE_LONG_FNAME) /* don't lower case on Windows 95/NT systems */
8654 while (*s)
8655 *d++ = *s++;
8656 else
8657 # endif
8658 while (*s)
8659 *d++ = TOLOWER_LOC(*s++);
8660 *d = NUL;
8662 # endif
8665 * Recursively expand one path component into all matching files and/or
8666 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8667 * Return the number of matches found.
8668 * "path" has backslashes before chars that are not to be expanded, starting
8669 * at "path[wildoff]".
8670 * Return the number of matches found.
8671 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
8673 static int
8674 dos_expandpath(
8675 garray_T *gap,
8676 char_u *path,
8677 int wildoff,
8678 int flags, /* EW_* flags */
8679 int didstar) /* expanded "**" once already */
8681 char_u *buf;
8682 char_u *path_end;
8683 char_u *p, *s, *e;
8684 int start_len = gap->ga_len;
8685 char_u *pat;
8686 regmatch_T regmatch;
8687 int starts_with_dot;
8688 int matches;
8689 int len;
8690 int starstar = FALSE;
8691 static int stardepth = 0; /* depth for "**" expansion */
8692 #ifdef WIN3264
8693 WIN32_FIND_DATA fb;
8694 HANDLE hFind = (HANDLE)0;
8695 # ifdef FEAT_MBYTE
8696 WIN32_FIND_DATAW wfb;
8697 WCHAR *wn = NULL; /* UCS-2 name, NULL when not used. */
8698 # endif
8699 #else
8700 struct ffblk fb;
8701 #endif
8702 char_u *matchname;
8703 int ok;
8705 /* Expanding "**" may take a long time, check for CTRL-C. */
8706 if (stardepth > 0)
8708 ui_breakcheck();
8709 if (got_int)
8710 return 0;
8713 /* make room for file name */
8714 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8715 if (buf == NULL)
8716 return 0;
8719 * Find the first part in the path name that contains a wildcard or a ~1.
8720 * Copy it into buf, including the preceding characters.
8722 p = buf;
8723 s = buf;
8724 e = NULL;
8725 path_end = path;
8726 while (*path_end != NUL)
8728 /* May ignore a wildcard that has a backslash before it; it will
8729 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8730 if (path_end >= path + wildoff && rem_backslash(path_end))
8731 *p++ = *path_end++;
8732 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
8734 if (e != NULL)
8735 break;
8736 s = p + 1;
8738 else if (path_end >= path + wildoff
8739 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
8740 e = p;
8741 #ifdef FEAT_MBYTE
8742 if (has_mbyte)
8744 len = (*mb_ptr2len)(path_end);
8745 STRNCPY(p, path_end, len);
8746 p += len;
8747 path_end += len;
8749 else
8750 #endif
8751 *p++ = *path_end++;
8753 e = p;
8754 *e = NUL;
8756 /* now we have one wildcard component between s and e */
8757 /* Remove backslashes between "wildoff" and the start of the wildcard
8758 * component. */
8759 for (p = buf + wildoff; p < s; ++p)
8760 if (rem_backslash(p))
8762 STRMOVE(p, p + 1);
8763 --e;
8764 --s;
8767 /* Check for "**" between "s" and "e". */
8768 for (p = s; p < e; ++p)
8769 if (p[0] == '*' && p[1] == '*')
8770 starstar = TRUE;
8772 starts_with_dot = (*s == '.');
8773 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8774 if (pat == NULL)
8776 vim_free(buf);
8777 return 0;
8780 /* compile the regexp into a program */
8781 regmatch.rm_ic = TRUE; /* Always ignore case */
8782 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8783 vim_free(pat);
8785 if (regmatch.regprog == NULL)
8787 vim_free(buf);
8788 return 0;
8791 /* remember the pattern or file name being looked for */
8792 matchname = vim_strsave(s);
8794 /* If "**" is by itself, this is the first time we encounter it and more
8795 * is following then find matches without any directory. */
8796 if (!didstar && stardepth < 100 && starstar && e - s == 2
8797 && *path_end == '/')
8799 STRCPY(s, path_end + 1);
8800 ++stardepth;
8801 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8802 --stardepth;
8805 /* Scan all files in the directory with "dir/ *.*" */
8806 STRCPY(s, "*.*");
8807 #ifdef WIN3264
8808 # ifdef FEAT_MBYTE
8809 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
8811 /* The active codepage differs from 'encoding'. Attempt using the
8812 * wide function. If it fails because it is not implemented fall back
8813 * to the non-wide version (for Windows 98) */
8814 wn = enc_to_utf16(buf, NULL);
8815 if (wn != NULL)
8817 hFind = FindFirstFileW(wn, &wfb);
8818 if (hFind == INVALID_HANDLE_VALUE
8819 && GetLastError() == ERROR_CALL_NOT_IMPLEMENTED)
8821 vim_free(wn);
8822 wn = NULL;
8827 if (wn == NULL)
8828 # endif
8829 hFind = FindFirstFile(buf, &fb);
8830 ok = (hFind != INVALID_HANDLE_VALUE);
8831 #else
8832 /* If we are expanding wildcards we try both files and directories */
8833 ok = (findfirst((char *)buf, &fb,
8834 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8835 #endif
8837 while (ok)
8839 #ifdef WIN3264
8840 # ifdef FEAT_MBYTE
8841 if (wn != NULL)
8842 p = utf16_to_enc(wfb.cFileName, NULL); /* p is allocated here */
8843 else
8844 # endif
8845 p = (char_u *)fb.cFileName;
8846 #else
8847 p = (char_u *)fb.ff_name;
8848 #endif
8849 /* Ignore entries starting with a dot, unless when asked for. Accept
8850 * all entries found with "matchname". */
8851 if ((p[0] != '.' || starts_with_dot)
8852 && (matchname == NULL
8853 || vim_regexec(&regmatch, p, (colnr_T)0)))
8855 #ifdef WIN3264
8856 STRCPY(s, p);
8857 #else
8858 namelowcpy(s, p);
8859 #endif
8860 len = (int)STRLEN(buf);
8862 if (starstar && stardepth < 100)
8864 /* For "**" in the pattern first go deeper in the tree to
8865 * find matches. */
8866 STRCPY(buf + len, "/**");
8867 STRCPY(buf + len + 3, path_end);
8868 ++stardepth;
8869 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
8870 --stardepth;
8873 STRCPY(buf + len, path_end);
8874 if (mch_has_exp_wildcard(path_end))
8876 /* need to expand another component of the path */
8877 /* remove backslashes for the remaining components only */
8878 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
8880 else
8882 /* no more wildcards, check if there is a match */
8883 /* remove backslashes for the remaining components only */
8884 if (*path_end != 0)
8885 backslash_halve(buf + len + 1);
8886 if (mch_getperm(buf) >= 0) /* add existing file */
8887 addfile(gap, buf, flags);
8891 #ifdef WIN3264
8892 # ifdef FEAT_MBYTE
8893 if (wn != NULL)
8895 vim_free(p);
8896 ok = FindNextFileW(hFind, &wfb);
8898 else
8899 # endif
8900 ok = FindNextFile(hFind, &fb);
8901 #else
8902 ok = (findnext(&fb) == 0);
8903 #endif
8905 /* If no more matches and no match was used, try expanding the name
8906 * itself. Finds the long name of a short filename. */
8907 if (!ok && matchname != NULL && gap->ga_len == start_len)
8909 STRCPY(s, matchname);
8910 #ifdef WIN3264
8911 FindClose(hFind);
8912 # ifdef FEAT_MBYTE
8913 if (wn != NULL)
8915 vim_free(wn);
8916 wn = enc_to_utf16(buf, NULL);
8917 if (wn != NULL)
8918 hFind = FindFirstFileW(wn, &wfb);
8920 if (wn == NULL)
8921 # endif
8922 hFind = FindFirstFile(buf, &fb);
8923 ok = (hFind != INVALID_HANDLE_VALUE);
8924 #else
8925 ok = (findfirst((char *)buf, &fb,
8926 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8927 #endif
8928 vim_free(matchname);
8929 matchname = NULL;
8933 #ifdef WIN3264
8934 FindClose(hFind);
8935 # ifdef FEAT_MBYTE
8936 vim_free(wn);
8937 # endif
8938 #endif
8939 vim_free(buf);
8940 vim_free(regmatch.regprog);
8941 vim_free(matchname);
8943 matches = gap->ga_len - start_len;
8944 if (matches > 0)
8945 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
8946 sizeof(char_u *), pstrcmp);
8947 return matches;
8951 mch_expandpath(
8952 garray_T *gap,
8953 char_u *path,
8954 int flags) /* EW_* flags */
8956 return dos_expandpath(gap, path, 0, flags, FALSE);
8958 # endif /* MSDOS || FEAT_GUI_W16 || WIN3264 */
8960 #if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
8961 || defined(PROTO)
8963 * Unix style wildcard expansion code.
8964 * It's here because it's used both for Unix and Mac.
8966 static int pstrcmp __ARGS((const void *, const void *));
8968 static int
8969 pstrcmp(a, b)
8970 const void *a, *b;
8972 return (pathcmp(*(char **)a, *(char **)b, -1));
8976 * Recursively expand one path component into all matching files and/or
8977 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8978 * "path" has backslashes before chars that are not to be expanded, starting
8979 * at "path + wildoff".
8980 * Return the number of matches found.
8981 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
8984 unix_expandpath(gap, path, wildoff, flags, didstar)
8985 garray_T *gap;
8986 char_u *path;
8987 int wildoff;
8988 int flags; /* EW_* flags */
8989 int didstar; /* expanded "**" once already */
8991 char_u *buf;
8992 char_u *path_end;
8993 char_u *p, *s, *e;
8994 int start_len = gap->ga_len;
8995 char_u *pat;
8996 regmatch_T regmatch;
8997 int starts_with_dot;
8998 int matches;
8999 int len;
9000 int starstar = FALSE;
9001 static int stardepth = 0; /* depth for "**" expansion */
9003 DIR *dirp;
9004 struct dirent *dp;
9006 /* Expanding "**" may take a long time, check for CTRL-C. */
9007 if (stardepth > 0)
9009 ui_breakcheck();
9010 if (got_int)
9011 return 0;
9014 /* make room for file name */
9015 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
9016 if (buf == NULL)
9017 return 0;
9020 * Find the first part in the path name that contains a wildcard.
9021 * Copy it into "buf", including the preceding characters.
9023 p = buf;
9024 s = buf;
9025 e = NULL;
9026 path_end = path;
9027 while (*path_end != NUL)
9029 /* May ignore a wildcard that has a backslash before it; it will
9030 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
9031 if (path_end >= path + wildoff && rem_backslash(path_end))
9032 *p++ = *path_end++;
9033 else if (*path_end == '/')
9035 if (e != NULL)
9036 break;
9037 s = p + 1;
9039 else if (path_end >= path + wildoff
9040 && vim_strchr((char_u *)"*?[{~$", *path_end) != NULL)
9041 e = p;
9042 #ifdef FEAT_MBYTE
9043 if (has_mbyte)
9045 len = (*mb_ptr2len)(path_end);
9046 STRNCPY(p, path_end, len);
9047 p += len;
9048 path_end += len;
9050 else
9051 #endif
9052 *p++ = *path_end++;
9054 e = p;
9055 *e = NUL;
9057 /* now we have one wildcard component between "s" and "e" */
9058 /* Remove backslashes between "wildoff" and the start of the wildcard
9059 * component. */
9060 for (p = buf + wildoff; p < s; ++p)
9061 if (rem_backslash(p))
9063 STRMOVE(p, p + 1);
9064 --e;
9065 --s;
9068 /* Check for "**" between "s" and "e". */
9069 for (p = s; p < e; ++p)
9070 if (p[0] == '*' && p[1] == '*')
9071 starstar = TRUE;
9073 /* convert the file pattern to a regexp pattern */
9074 starts_with_dot = (*s == '.');
9075 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
9076 if (pat == NULL)
9078 vim_free(buf);
9079 return 0;
9082 /* compile the regexp into a program */
9083 #ifdef CASE_INSENSITIVE_FILENAME
9084 regmatch.rm_ic = TRUE; /* Behave like Terminal.app */
9085 #else
9086 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9087 #endif
9088 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
9089 vim_free(pat);
9091 if (regmatch.regprog == NULL)
9093 vim_free(buf);
9094 return 0;
9097 /* If "**" is by itself, this is the first time we encounter it and more
9098 * is following then find matches without any directory. */
9099 if (!didstar && stardepth < 100 && starstar && e - s == 2
9100 && *path_end == '/')
9102 STRCPY(s, path_end + 1);
9103 ++stardepth;
9104 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
9105 --stardepth;
9108 /* open the directory for scanning */
9109 *s = NUL;
9110 dirp = opendir(*buf == NUL ? "." : (char *)buf);
9112 /* Find all matching entries */
9113 if (dirp != NULL)
9115 for (;;)
9117 dp = readdir(dirp);
9118 if (dp == NULL)
9119 break;
9120 if ((dp->d_name[0] != '.' || starts_with_dot)
9121 && vim_regexec(&regmatch, (char_u *)dp->d_name, (colnr_T)0))
9123 STRCPY(s, dp->d_name);
9124 len = STRLEN(buf);
9126 if (starstar && stardepth < 100)
9128 /* For "**" in the pattern first go deeper in the tree to
9129 * find matches. */
9130 STRCPY(buf + len, "/**");
9131 STRCPY(buf + len + 3, path_end);
9132 ++stardepth;
9133 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
9134 --stardepth;
9137 STRCPY(buf + len, path_end);
9138 if (mch_has_exp_wildcard(path_end)) /* handle more wildcards */
9140 /* need to expand another component of the path */
9141 /* remove backslashes for the remaining components only */
9142 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
9144 else
9146 /* no more wildcards, check if there is a match */
9147 /* remove backslashes for the remaining components only */
9148 if (*path_end != NUL)
9149 backslash_halve(buf + len + 1);
9150 if (mch_getperm(buf) >= 0) /* add existing file */
9152 #ifdef MACOS_CONVERT
9153 size_t precomp_len = STRLEN(buf)+1;
9154 char_u *precomp_buf =
9155 mac_precompose_path(buf, precomp_len, &precomp_len);
9157 if (precomp_buf)
9159 mch_memmove(buf, precomp_buf, precomp_len);
9160 vim_free(precomp_buf);
9162 #endif
9163 addfile(gap, buf, flags);
9169 closedir(dirp);
9172 vim_free(buf);
9173 vim_free(regmatch.regprog);
9175 matches = gap->ga_len - start_len;
9176 if (matches > 0)
9177 qsort(((char_u **)gap->ga_data) + start_len, matches,
9178 sizeof(char_u *), pstrcmp);
9179 return matches;
9181 #endif
9184 * Generic wildcard expansion code.
9186 * Characters in "pat" that should not be expanded must be preceded with a
9187 * backslash. E.g., "/path\ with\ spaces/my\*star*"
9189 * Return FAIL when no single file was found. In this case "num_file" is not
9190 * set, and "file" may contain an error message.
9191 * Return OK when some files found. "num_file" is set to the number of
9192 * matches, "file" to the array of matches. Call FreeWild() later.
9195 gen_expand_wildcards(num_pat, pat, num_file, file, flags)
9196 int num_pat; /* number of input patterns */
9197 char_u **pat; /* array of input patterns */
9198 int *num_file; /* resulting number of files */
9199 char_u ***file; /* array of resulting files */
9200 int flags; /* EW_* flags */
9202 int i;
9203 garray_T ga;
9204 char_u *p;
9205 static int recursive = FALSE;
9206 int add_pat;
9209 * expand_env() is called to expand things like "~user". If this fails,
9210 * it calls ExpandOne(), which brings us back here. In this case, always
9211 * call the machine specific expansion function, if possible. Otherwise,
9212 * return FAIL.
9214 if (recursive)
9215 #ifdef SPECIAL_WILDCHAR
9216 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9217 #else
9218 return FAIL;
9219 #endif
9221 #ifdef SPECIAL_WILDCHAR
9223 * If there are any special wildcard characters which we cannot handle
9224 * here, call machine specific function for all the expansion. This
9225 * avoids starting the shell for each argument separately.
9226 * For `=expr` do use the internal function.
9228 for (i = 0; i < num_pat; i++)
9230 if (vim_strpbrk(pat[i], (char_u *)SPECIAL_WILDCHAR) != NULL
9231 # ifdef VIM_BACKTICK
9232 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
9233 # endif
9235 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9237 #endif
9239 recursive = TRUE;
9242 * The matching file names are stored in a growarray. Init it empty.
9244 ga_init2(&ga, (int)sizeof(char_u *), 30);
9246 for (i = 0; i < num_pat; ++i)
9248 add_pat = -1;
9249 p = pat[i];
9251 #ifdef VIM_BACKTICK
9252 if (vim_backtick(p))
9253 add_pat = expand_backtick(&ga, p, flags);
9254 else
9255 #endif
9258 * First expand environment variables, "~/" and "~user/".
9260 if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9262 p = expand_env_save_opt(p, TRUE);
9263 if (p == NULL)
9264 p = pat[i];
9265 #ifdef UNIX
9267 * On Unix, if expand_env() can't expand an environment
9268 * variable, use the shell to do that. Discard previously
9269 * found file names and start all over again.
9271 else if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9273 vim_free(p);
9274 ga_clear_strings(&ga);
9275 i = mch_expand_wildcards(num_pat, pat, num_file, file,
9276 flags);
9277 recursive = FALSE;
9278 return i;
9280 #endif
9284 * If there are wildcards: Expand file names and add each match to
9285 * the list. If there is no match, and EW_NOTFOUND is given, add
9286 * the pattern.
9287 * If there are no wildcards: Add the file name if it exists or
9288 * when EW_NOTFOUND is given.
9290 if (mch_has_exp_wildcard(p))
9291 add_pat = mch_expandpath(&ga, p, flags);
9294 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
9296 char_u *t = backslash_halve_save(p);
9298 #if defined(MACOS_CLASSIC)
9299 slash_to_colon(t);
9300 #endif
9301 /* When EW_NOTFOUND is used, always add files and dirs. Makes
9302 * "vim c:/" work. */
9303 if (flags & EW_NOTFOUND)
9304 addfile(&ga, t, flags | EW_DIR | EW_FILE);
9305 else if (mch_getperm(t) >= 0)
9306 addfile(&ga, t, flags);
9307 vim_free(t);
9310 if (p != pat[i])
9311 vim_free(p);
9314 *num_file = ga.ga_len;
9315 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data : (char_u **)"";
9317 recursive = FALSE;
9319 return (ga.ga_data != NULL) ? OK : FAIL;
9322 # ifdef VIM_BACKTICK
9325 * Return TRUE if we can expand this backtick thing here.
9327 static int
9328 vim_backtick(p)
9329 char_u *p;
9331 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
9335 * Expand an item in `backticks` by executing it as a command.
9336 * Currently only works when pat[] starts and ends with a `.
9337 * Returns number of file names found.
9339 static int
9340 expand_backtick(gap, pat, flags)
9341 garray_T *gap;
9342 char_u *pat;
9343 int flags; /* EW_* flags */
9345 char_u *p;
9346 char_u *cmd;
9347 char_u *buffer;
9348 int cnt = 0;
9349 int i;
9351 /* Create the command: lop off the backticks. */
9352 cmd = vim_strnsave(pat + 1, (int)STRLEN(pat) - 2);
9353 if (cmd == NULL)
9354 return 0;
9356 #ifdef FEAT_EVAL
9357 if (*cmd == '=') /* `={expr}`: Expand expression */
9358 buffer = eval_to_string(cmd + 1, &p, TRUE);
9359 else
9360 #endif
9361 buffer = get_cmd_output(cmd, NULL,
9362 (flags & EW_SILENT) ? SHELL_SILENT : 0);
9363 vim_free(cmd);
9364 if (buffer == NULL)
9365 return 0;
9367 cmd = buffer;
9368 while (*cmd != NUL)
9370 cmd = skipwhite(cmd); /* skip over white space */
9371 p = cmd;
9372 while (*p != NUL && *p != '\r' && *p != '\n') /* skip over entry */
9373 ++p;
9374 /* add an entry if it is not empty */
9375 if (p > cmd)
9377 i = *p;
9378 *p = NUL;
9379 addfile(gap, cmd, flags);
9380 *p = i;
9381 ++cnt;
9383 cmd = p;
9384 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
9385 ++cmd;
9388 vim_free(buffer);
9389 return cnt;
9391 # endif /* VIM_BACKTICK */
9394 * Add a file to a file list. Accepted flags:
9395 * EW_DIR add directories
9396 * EW_FILE add files
9397 * EW_EXEC add executable files
9398 * EW_NOTFOUND add even when it doesn't exist
9399 * EW_ADDSLASH add slash after directory name
9401 void
9402 addfile(gap, f, flags)
9403 garray_T *gap;
9404 char_u *f; /* filename */
9405 int flags;
9407 char_u *p;
9408 int isdir;
9410 /* if the file/dir doesn't exist, may not add it */
9411 if (!(flags & EW_NOTFOUND) && mch_getperm(f) < 0)
9412 return;
9414 #ifdef FNAME_ILLEGAL
9415 /* if the file/dir contains illegal characters, don't add it */
9416 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
9417 return;
9418 #endif
9420 isdir = mch_isdir(f);
9421 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
9422 return;
9424 /* If the file isn't executable, may not add it. Do accept directories. */
9425 if (!isdir && (flags & EW_EXEC) && !mch_can_exe(f))
9426 return;
9428 /* Make room for another item in the file list. */
9429 if (ga_grow(gap, 1) == FAIL)
9430 return;
9432 p = alloc((unsigned)(STRLEN(f) + 1 + isdir));
9433 if (p == NULL)
9434 return;
9436 STRCPY(p, f);
9437 #ifdef BACKSLASH_IN_FILENAME
9438 slash_adjust(p);
9439 #endif
9441 * Append a slash or backslash after directory names if none is present.
9443 #ifndef DONT_ADD_PATHSEP_TO_DIR
9444 if (isdir && (flags & EW_ADDSLASH))
9445 add_pathsep(p);
9446 #endif
9447 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
9449 #endif /* !NO_EXPANDPATH */
9451 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) || defined(PROTO)
9453 #ifndef SEEK_SET
9454 # define SEEK_SET 0
9455 #endif
9456 #ifndef SEEK_END
9457 # define SEEK_END 2
9458 #endif
9461 * Get the stdout of an external command.
9462 * Returns an allocated string, or NULL for error.
9464 char_u *
9465 get_cmd_output(cmd, infile, flags)
9466 char_u *cmd;
9467 char_u *infile; /* optional input file name */
9468 int flags; /* can be SHELL_SILENT */
9470 char_u *tempname;
9471 char_u *command;
9472 char_u *buffer = NULL;
9473 int len;
9474 int i = 0;
9475 FILE *fd;
9477 if (check_restricted() || check_secure())
9478 return NULL;
9480 /* get a name for the temp file */
9481 if ((tempname = vim_tempname('o')) == NULL)
9483 EMSG(_(e_notmp));
9484 return NULL;
9487 /* Add the redirection stuff */
9488 command = make_filter_cmd(cmd, infile, tempname);
9489 if (command == NULL)
9490 goto done;
9493 * Call the shell to execute the command (errors are ignored).
9494 * Don't check timestamps here.
9496 ++no_check_timestamps;
9497 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
9498 --no_check_timestamps;
9500 vim_free(command);
9503 * read the names from the file into memory
9505 # ifdef VMS
9506 /* created temporary file is not always readable as binary */
9507 fd = mch_fopen((char *)tempname, "r");
9508 # else
9509 fd = mch_fopen((char *)tempname, READBIN);
9510 # endif
9512 if (fd == NULL)
9514 EMSG2(_(e_notopen), tempname);
9515 goto done;
9518 fseek(fd, 0L, SEEK_END);
9519 len = ftell(fd); /* get size of temp file */
9520 fseek(fd, 0L, SEEK_SET);
9522 buffer = alloc(len + 1);
9523 if (buffer != NULL)
9524 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
9525 fclose(fd);
9526 mch_remove(tempname);
9527 if (buffer == NULL)
9528 goto done;
9529 #ifdef VMS
9530 len = i; /* VMS doesn't give us what we asked for... */
9531 #endif
9532 if (i != len)
9534 EMSG2(_(e_notread), tempname);
9535 vim_free(buffer);
9536 buffer = NULL;
9538 else
9539 buffer[len] = '\0'; /* make sure the buffer is terminated */
9541 done:
9542 vim_free(tempname);
9543 return buffer;
9545 #endif
9548 * Free the list of files returned by expand_wildcards() or other expansion
9549 * functions.
9551 void
9552 FreeWild(count, files)
9553 int count;
9554 char_u **files;
9556 if (count <= 0 || files == NULL)
9557 return;
9558 #if defined(__EMX__) && defined(__ALWAYS_HAS_TRAILING_NULL_POINTER) /* XXX */
9560 * Is this still OK for when other functions than expand_wildcards() have
9561 * been used???
9563 _fnexplodefree((char **)files);
9564 #else
9565 while (count--)
9566 vim_free(files[count]);
9567 vim_free(files);
9568 #endif
9572 * return TRUE when need to go to Insert mode because of 'insertmode'.
9573 * Don't do this when still processing a command or a mapping.
9574 * Don't do this when inside a ":normal" command.
9577 goto_im()
9579 return (p_im && stuff_empty() && typebuf_typed());