Merge branch 'vim-with-runtime' into feat/tagfunc
[vim_extended.git] / src / misc1.c
blob5482e455734da524ccf9c2264590cc8e41f2a9c9
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 * Call this function 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 * Careful: may trigger autocommands that reload the buffer.
2477 void
2478 changed()
2480 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2481 /* The text of the preediting area is inserted, but this doesn't
2482 * mean a change of the buffer yet. That is delayed until the
2483 * text is committed. (this means preedit becomes empty) */
2484 if (im_is_preediting() && !xim_changed_while_preediting)
2485 return;
2486 xim_changed_while_preediting = FALSE;
2487 #endif
2489 if (!curbuf->b_changed)
2491 int save_msg_scroll = msg_scroll;
2493 /* Give a warning about changing a read-only file. This may also
2494 * check-out the file, thus change "curbuf"! */
2495 change_warning(0);
2497 /* Create a swap file if that is wanted.
2498 * Don't do this for "nofile" and "nowrite" buffer types. */
2499 if (curbuf->b_may_swap
2500 #ifdef FEAT_QUICKFIX
2501 && !bt_dontwrite(curbuf)
2502 #endif
2505 ml_open_file(curbuf);
2507 /* The ml_open_file() can cause an ATTENTION message.
2508 * Wait two seconds, to make sure the user reads this unexpected
2509 * message. Since we could be anywhere, call wait_return() now,
2510 * and don't let the emsg() set msg_scroll. */
2511 if (need_wait_return && emsg_silent == 0)
2513 out_flush();
2514 ui_delay(2000L, TRUE);
2515 wait_return(TRUE);
2516 msg_scroll = save_msg_scroll;
2519 curbuf->b_changed = TRUE;
2520 ml_setflags(curbuf);
2521 #ifdef FEAT_WINDOWS
2522 check_status(curbuf);
2523 redraw_tabline = TRUE;
2524 #endif
2525 #ifdef FEAT_TITLE
2526 need_maketitle = TRUE; /* set window title later */
2527 #endif
2529 ++curbuf->b_changedtick;
2532 static void changedOneline __ARGS((buf_T *buf, linenr_T lnum));
2533 static void changed_lines_buf __ARGS((buf_T *buf, linenr_T lnum, linenr_T lnume, long xtra));
2534 static void changed_common __ARGS((linenr_T lnum, colnr_T col, linenr_T lnume, long xtra));
2537 * Changed bytes within a single line for the current buffer.
2538 * - marks the windows on this buffer to be redisplayed
2539 * - marks the buffer changed by calling changed()
2540 * - invalidates cached values
2541 * Careful: may trigger autocommands that reload the buffer.
2543 void
2544 changed_bytes(lnum, col)
2545 linenr_T lnum;
2546 colnr_T col;
2548 changedOneline(curbuf, lnum);
2549 changed_common(lnum, col, lnum + 1, 0L);
2551 #ifdef FEAT_DIFF
2552 /* Diff highlighting in other diff windows may need to be updated too. */
2553 if (curwin->w_p_diff)
2555 win_T *wp;
2556 linenr_T wlnum;
2558 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2559 if (wp->w_p_diff && wp != curwin)
2561 redraw_win_later(wp, VALID);
2562 wlnum = diff_lnum_win(lnum, wp);
2563 if (wlnum > 0)
2564 changedOneline(wp->w_buffer, wlnum);
2567 #endif
2570 static void
2571 changedOneline(buf, lnum)
2572 buf_T *buf;
2573 linenr_T lnum;
2575 if (buf->b_mod_set)
2577 /* find the maximum area that must be redisplayed */
2578 if (lnum < buf->b_mod_top)
2579 buf->b_mod_top = lnum;
2580 else if (lnum >= buf->b_mod_bot)
2581 buf->b_mod_bot = lnum + 1;
2583 else
2585 /* set the area that must be redisplayed to one line */
2586 buf->b_mod_set = TRUE;
2587 buf->b_mod_top = lnum;
2588 buf->b_mod_bot = lnum + 1;
2589 buf->b_mod_xlines = 0;
2594 * Appended "count" lines below line "lnum" in the current buffer.
2595 * Must be called AFTER the change and after mark_adjust().
2596 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2598 void
2599 appended_lines(lnum, count)
2600 linenr_T lnum;
2601 long count;
2603 changed_lines(lnum + 1, 0, lnum + 1, count);
2607 * Like appended_lines(), but adjust marks first.
2609 void
2610 appended_lines_mark(lnum, count)
2611 linenr_T lnum;
2612 long count;
2614 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, count, 0L);
2615 changed_lines(lnum + 1, 0, lnum + 1, count);
2619 * Deleted "count" lines at line "lnum" in the current buffer.
2620 * Must be called AFTER the change and after mark_adjust().
2621 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2623 void
2624 deleted_lines(lnum, count)
2625 linenr_T lnum;
2626 long count;
2628 changed_lines(lnum, 0, lnum + count, -count);
2632 * Like deleted_lines(), but adjust marks first.
2633 * Make sure the cursor is on a valid line before calling, a GUI callback may
2634 * be triggered to display the cursor.
2636 void
2637 deleted_lines_mark(lnum, count)
2638 linenr_T lnum;
2639 long count;
2641 mark_adjust(lnum, (linenr_T)(lnum + count - 1), (long)MAXLNUM, -count);
2642 changed_lines(lnum, 0, lnum + count, -count);
2646 * Changed lines for the current buffer.
2647 * Must be called AFTER the change and after mark_adjust().
2648 * - mark the buffer changed by calling changed()
2649 * - mark the windows on this buffer to be redisplayed
2650 * - invalidate cached values
2651 * "lnum" is the first line that needs displaying, "lnume" the first line
2652 * below the changed lines (BEFORE the change).
2653 * When only inserting lines, "lnum" and "lnume" are equal.
2654 * Takes care of calling changed() and updating b_mod_*.
2655 * Careful: may trigger autocommands that reload the buffer.
2657 void
2658 changed_lines(lnum, col, lnume, xtra)
2659 linenr_T lnum; /* first line with change */
2660 colnr_T col; /* column in first line with change */
2661 linenr_T lnume; /* line below last changed line */
2662 long xtra; /* number of extra lines (negative when deleting) */
2664 changed_lines_buf(curbuf, lnum, lnume, xtra);
2666 #ifdef FEAT_DIFF
2667 if (xtra == 0 && curwin->w_p_diff)
2669 /* When the number of lines doesn't change then mark_adjust() isn't
2670 * called and other diff buffers still need to be marked for
2671 * displaying. */
2672 win_T *wp;
2673 linenr_T wlnum;
2675 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2676 if (wp->w_p_diff && wp != curwin)
2678 redraw_win_later(wp, VALID);
2679 wlnum = diff_lnum_win(lnum, wp);
2680 if (wlnum > 0)
2681 changed_lines_buf(wp->w_buffer, wlnum,
2682 lnume - lnum + wlnum, 0L);
2685 #endif
2687 changed_common(lnum, col, lnume, xtra);
2690 static void
2691 changed_lines_buf(buf, lnum, lnume, xtra)
2692 buf_T *buf;
2693 linenr_T lnum; /* first line with change */
2694 linenr_T lnume; /* line below last changed line */
2695 long xtra; /* number of extra lines (negative when deleting) */
2697 if (buf->b_mod_set)
2699 /* find the maximum area that must be redisplayed */
2700 if (lnum < buf->b_mod_top)
2701 buf->b_mod_top = lnum;
2702 if (lnum < buf->b_mod_bot)
2704 /* adjust old bot position for xtra lines */
2705 buf->b_mod_bot += xtra;
2706 if (buf->b_mod_bot < lnum)
2707 buf->b_mod_bot = lnum;
2709 if (lnume + xtra > buf->b_mod_bot)
2710 buf->b_mod_bot = lnume + xtra;
2711 buf->b_mod_xlines += xtra;
2713 else
2715 /* set the area that must be redisplayed */
2716 buf->b_mod_set = TRUE;
2717 buf->b_mod_top = lnum;
2718 buf->b_mod_bot = lnume + xtra;
2719 buf->b_mod_xlines = xtra;
2724 * Common code for when a change is was made.
2725 * See changed_lines() for the arguments.
2726 * Careful: may trigger autocommands that reload the buffer.
2728 static void
2729 changed_common(lnum, col, lnume, xtra)
2730 linenr_T lnum;
2731 colnr_T col;
2732 linenr_T lnume;
2733 long xtra;
2735 win_T *wp;
2736 #ifdef FEAT_WINDOWS
2737 tabpage_T *tp;
2738 #endif
2739 int i;
2740 #ifdef FEAT_JUMPLIST
2741 int cols;
2742 pos_T *p;
2743 int add;
2744 #endif
2746 /* mark the buffer as modified */
2747 changed();
2749 /* set the '. mark */
2750 if (!cmdmod.keepjumps)
2752 curbuf->b_last_change.lnum = lnum;
2753 curbuf->b_last_change.col = col;
2755 #ifdef FEAT_JUMPLIST
2756 /* Create a new entry if a new undo-able change was started or we
2757 * don't have an entry yet. */
2758 if (curbuf->b_new_change || curbuf->b_changelistlen == 0)
2760 if (curbuf->b_changelistlen == 0)
2761 add = TRUE;
2762 else
2764 /* Don't create a new entry when the line number is the same
2765 * as the last one and the column is not too far away. Avoids
2766 * creating many entries for typing "xxxxx". */
2767 p = &curbuf->b_changelist[curbuf->b_changelistlen - 1];
2768 if (p->lnum != lnum)
2769 add = TRUE;
2770 else
2772 cols = comp_textwidth(FALSE);
2773 if (cols == 0)
2774 cols = 79;
2775 add = (p->col + cols < col || col + cols < p->col);
2778 if (add)
2780 /* This is the first of a new sequence of undo-able changes
2781 * and it's at some distance of the last change. Use a new
2782 * position in the changelist. */
2783 curbuf->b_new_change = FALSE;
2785 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2787 /* changelist is full: remove oldest entry */
2788 curbuf->b_changelistlen = JUMPLISTSIZE - 1;
2789 mch_memmove(curbuf->b_changelist, curbuf->b_changelist + 1,
2790 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2791 FOR_ALL_TAB_WINDOWS(tp, wp)
2793 /* Correct position in changelist for other windows on
2794 * this buffer. */
2795 if (wp->w_buffer == curbuf && wp->w_changelistidx > 0)
2796 --wp->w_changelistidx;
2799 FOR_ALL_TAB_WINDOWS(tp, wp)
2801 /* For other windows, if the position in the changelist is
2802 * at the end it stays at the end. */
2803 if (wp->w_buffer == curbuf
2804 && wp->w_changelistidx == curbuf->b_changelistlen)
2805 ++wp->w_changelistidx;
2807 ++curbuf->b_changelistlen;
2810 curbuf->b_changelist[curbuf->b_changelistlen - 1] =
2811 curbuf->b_last_change;
2812 /* The current window is always after the last change, so that "g,"
2813 * takes you back to it. */
2814 curwin->w_changelistidx = curbuf->b_changelistlen;
2815 #endif
2818 FOR_ALL_TAB_WINDOWS(tp, wp)
2820 if (wp->w_buffer == curbuf)
2822 /* Mark this window to be redrawn later. */
2823 if (wp->w_redr_type < VALID)
2824 wp->w_redr_type = VALID;
2826 /* Check if a change in the buffer has invalidated the cached
2827 * values for the cursor. */
2828 #ifdef FEAT_FOLDING
2830 * Update the folds for this window. Can't postpone this, because
2831 * a following operator might work on the whole fold: ">>dd".
2833 foldUpdate(wp, lnum, lnume + xtra - 1);
2835 /* The change may cause lines above or below the change to become
2836 * included in a fold. Set lnum/lnume to the first/last line that
2837 * might be displayed differently.
2838 * Set w_cline_folded here as an efficient way to update it when
2839 * inserting lines just above a closed fold. */
2840 i = hasFoldingWin(wp, lnum, &lnum, NULL, FALSE, NULL);
2841 if (wp->w_cursor.lnum == lnum)
2842 wp->w_cline_folded = i;
2843 i = hasFoldingWin(wp, lnume, NULL, &lnume, FALSE, NULL);
2844 if (wp->w_cursor.lnum == lnume)
2845 wp->w_cline_folded = i;
2847 /* If the changed line is in a range of previously folded lines,
2848 * compare with the first line in that range. */
2849 if (wp->w_cursor.lnum <= lnum)
2851 i = find_wl_entry(wp, lnum);
2852 if (i >= 0 && wp->w_cursor.lnum > wp->w_lines[i].wl_lnum)
2853 changed_line_abv_curs_win(wp);
2855 #endif
2857 if (wp->w_cursor.lnum > lnum)
2858 changed_line_abv_curs_win(wp);
2859 else if (wp->w_cursor.lnum == lnum && wp->w_cursor.col >= col)
2860 changed_cline_bef_curs_win(wp);
2861 if (wp->w_botline >= lnum)
2863 /* Assume that botline doesn't change (inserted lines make
2864 * other lines scroll down below botline). */
2865 approximate_botline_win(wp);
2868 /* Check if any w_lines[] entries have become invalid.
2869 * For entries below the change: Correct the lnums for
2870 * inserted/deleted lines. Makes it possible to stop displaying
2871 * after the change. */
2872 for (i = 0; i < wp->w_lines_valid; ++i)
2873 if (wp->w_lines[i].wl_valid)
2875 if (wp->w_lines[i].wl_lnum >= lnum)
2877 if (wp->w_lines[i].wl_lnum < lnume)
2879 /* line included in change */
2880 wp->w_lines[i].wl_valid = FALSE;
2882 else if (xtra != 0)
2884 /* line below change */
2885 wp->w_lines[i].wl_lnum += xtra;
2886 #ifdef FEAT_FOLDING
2887 wp->w_lines[i].wl_lastlnum += xtra;
2888 #endif
2891 #ifdef FEAT_FOLDING
2892 else if (wp->w_lines[i].wl_lastlnum >= lnum)
2894 /* change somewhere inside this range of folded lines,
2895 * may need to be redrawn */
2896 wp->w_lines[i].wl_valid = FALSE;
2898 #endif
2901 #ifdef FEAT_FOLDING
2902 /* Take care of side effects for setting w_topline when folds have
2903 * changed. Esp. when the buffer was changed in another window. */
2904 if (hasAnyFolding(wp))
2905 set_topline(wp, wp->w_topline);
2906 #endif
2910 /* Call update_screen() later, which checks out what needs to be redrawn,
2911 * since it notices b_mod_set and then uses b_mod_*. */
2912 if (must_redraw < VALID)
2913 must_redraw = VALID;
2915 #ifdef FEAT_AUTOCMD
2916 /* when the cursor line is changed always trigger CursorMoved */
2917 if (lnum <= curwin->w_cursor.lnum
2918 && lnume + (xtra < 0 ? -xtra : xtra) > curwin->w_cursor.lnum)
2919 last_cursormoved.lnum = 0;
2920 #endif
2924 * unchanged() is called when the changed flag must be reset for buffer 'buf'
2926 void
2927 unchanged(buf, ff)
2928 buf_T *buf;
2929 int ff; /* also reset 'fileformat' */
2931 if (buf->b_changed || (ff && file_ff_differs(buf)))
2933 buf->b_changed = 0;
2934 ml_setflags(buf);
2935 if (ff)
2936 save_file_ff(buf);
2937 #ifdef FEAT_WINDOWS
2938 check_status(buf);
2939 redraw_tabline = TRUE;
2940 #endif
2941 #ifdef FEAT_TITLE
2942 need_maketitle = TRUE; /* set window title later */
2943 #endif
2945 ++buf->b_changedtick;
2946 #ifdef FEAT_NETBEANS_INTG
2947 netbeans_unmodified(buf);
2948 #endif
2951 #if defined(FEAT_WINDOWS) || defined(PROTO)
2953 * check_status: called when the status bars for the buffer 'buf'
2954 * need to be updated
2956 void
2957 check_status(buf)
2958 buf_T *buf;
2960 win_T *wp;
2962 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2963 if (wp->w_buffer == buf && wp->w_status_height)
2965 wp->w_redr_status = TRUE;
2966 if (must_redraw < VALID)
2967 must_redraw = VALID;
2970 #endif
2973 * If the file is readonly, give a warning message with the first change.
2974 * Don't do this for autocommands.
2975 * Don't use emsg(), because it flushes the macro buffer.
2976 * If we have undone all changes b_changed will be FALSE, but "b_did_warn"
2977 * will be TRUE.
2978 * Careful: may trigger autocommands that reload the buffer.
2980 void
2981 change_warning(col)
2982 int col; /* column for message; non-zero when in insert
2983 mode and 'showmode' is on */
2985 static char *w_readonly = N_("W10: Warning: Changing a readonly file");
2987 if (curbuf->b_did_warn == FALSE
2988 && curbufIsChanged() == 0
2989 #ifdef FEAT_AUTOCMD
2990 && !autocmd_busy
2991 #endif
2992 && curbuf->b_p_ro)
2994 #ifdef FEAT_AUTOCMD
2995 ++curbuf_lock;
2996 apply_autocmds(EVENT_FILECHANGEDRO, NULL, NULL, FALSE, curbuf);
2997 --curbuf_lock;
2998 if (!curbuf->b_p_ro)
2999 return;
3000 #endif
3002 * Do what msg() does, but with a column offset if the warning should
3003 * be after the mode message.
3005 msg_start();
3006 if (msg_row == Rows - 1)
3007 msg_col = col;
3008 msg_source(hl_attr(HLF_W));
3009 MSG_PUTS_ATTR(_(w_readonly), hl_attr(HLF_W) | MSG_HIST);
3010 #ifdef FEAT_EVAL
3011 set_vim_var_string(VV_WARNINGMSG, (char_u *)_(w_readonly), -1);
3012 #endif
3013 msg_clr_eos();
3014 (void)msg_end();
3015 if (msg_silent == 0 && !silent_mode)
3017 out_flush();
3018 ui_delay(1000L, TRUE); /* give the user time to think about it */
3020 curbuf->b_did_warn = TRUE;
3021 redraw_cmdline = FALSE; /* don't redraw and erase the message */
3022 if (msg_row < Rows - 1)
3023 showmode();
3028 * Ask for a reply from the user, a 'y' or a 'n'.
3029 * No other characters are accepted, the message is repeated until a valid
3030 * reply is entered or CTRL-C is hit.
3031 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
3032 * from any buffers but directly from the user.
3034 * return the 'y' or 'n'
3037 ask_yesno(str, direct)
3038 char_u *str;
3039 int direct;
3041 int r = ' ';
3042 int save_State = State;
3044 if (exiting) /* put terminal in raw mode for this question */
3045 settmode(TMODE_RAW);
3046 ++no_wait_return;
3047 #ifdef USE_ON_FLY_SCROLL
3048 dont_scroll = TRUE; /* disallow scrolling here */
3049 #endif
3050 State = CONFIRM; /* mouse behaves like with :confirm */
3051 #ifdef FEAT_MOUSE
3052 setmouse(); /* disables mouse for xterm */
3053 #endif
3054 ++no_mapping;
3055 ++allow_keys; /* no mapping here, but recognize keys */
3057 while (r != 'y' && r != 'n')
3059 /* same highlighting as for wait_return */
3060 smsg_attr(hl_attr(HLF_R), (char_u *)"%s (y/n)?", str);
3061 if (direct)
3062 r = get_keystroke();
3063 else
3064 r = plain_vgetc();
3065 if (r == Ctrl_C || r == ESC)
3066 r = 'n';
3067 msg_putchar(r); /* show what you typed */
3068 out_flush();
3070 --no_wait_return;
3071 State = save_State;
3072 #ifdef FEAT_MOUSE
3073 setmouse();
3074 #endif
3075 --no_mapping;
3076 --allow_keys;
3078 return r;
3082 * Get a key stroke directly from the user.
3083 * Ignores mouse clicks and scrollbar events, except a click for the left
3084 * button (used at the more prompt).
3085 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
3086 * Disadvantage: typeahead is ignored.
3087 * Translates the interrupt character for unix to ESC.
3090 get_keystroke()
3092 #define CBUFLEN 151
3093 char_u buf[CBUFLEN];
3094 int len = 0;
3095 int n;
3096 int save_mapped_ctrl_c = mapped_ctrl_c;
3097 int waited = 0;
3099 mapped_ctrl_c = FALSE; /* mappings are not used here */
3100 for (;;)
3102 cursor_on();
3103 out_flush();
3105 /* First time: blocking wait. Second time: wait up to 100ms for a
3106 * terminal code to complete. Leave some room for check_termcode() to
3107 * insert a key code into (max 5 chars plus NUL). And
3108 * fix_input_buffer() can triple the number of bytes. */
3109 n = ui_inchar(buf + len, (CBUFLEN - 6 - len) / 3,
3110 len == 0 ? -1L : 100L, 0);
3111 if (n > 0)
3113 /* Replace zero and CSI by a special key code. */
3114 n = fix_input_buffer(buf + len, n, FALSE);
3115 len += n;
3116 waited = 0;
3118 else if (len > 0)
3119 ++waited; /* keep track of the waiting time */
3121 /* Incomplete termcode and not timed out yet: get more characters */
3122 if ((n = check_termcode(1, buf, len)) < 0
3123 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
3124 continue;
3126 /* found a termcode: adjust length */
3127 if (n > 0)
3128 len = n;
3129 if (len == 0) /* nothing typed yet */
3130 continue;
3132 /* Handle modifier and/or special key code. */
3133 n = buf[0];
3134 if (n == K_SPECIAL)
3136 n = TO_SPECIAL(buf[1], buf[2]);
3137 if (buf[1] == KS_MODIFIER
3138 || n == K_IGNORE
3139 #ifdef FEAT_MOUSE
3140 || n == K_LEFTMOUSE_NM
3141 || n == K_LEFTDRAG
3142 || n == K_LEFTRELEASE
3143 || n == K_LEFTRELEASE_NM
3144 || n == K_MIDDLEMOUSE
3145 || n == K_MIDDLEDRAG
3146 || n == K_MIDDLERELEASE
3147 || n == K_RIGHTMOUSE
3148 || n == K_RIGHTDRAG
3149 || n == K_RIGHTRELEASE
3150 || n == K_MOUSEDOWN
3151 || n == K_MOUSEUP
3152 || n == K_X1MOUSE
3153 || n == K_X1DRAG
3154 || n == K_X1RELEASE
3155 || n == K_X2MOUSE
3156 || n == K_X2DRAG
3157 || n == K_X2RELEASE
3158 # ifdef FEAT_GUI
3159 || n == K_VER_SCROLLBAR
3160 || n == K_HOR_SCROLLBAR
3161 # endif
3162 #endif
3165 if (buf[1] == KS_MODIFIER)
3166 mod_mask = buf[2];
3167 len -= 3;
3168 if (len > 0)
3169 mch_memmove(buf, buf + 3, (size_t)len);
3170 continue;
3172 break;
3174 #ifdef FEAT_MBYTE
3175 if (has_mbyte)
3177 if (MB_BYTE2LEN(n) > len)
3178 continue; /* more bytes to get */
3179 buf[len >= CBUFLEN ? CBUFLEN - 1 : len] = NUL;
3180 n = (*mb_ptr2char)(buf);
3182 #endif
3183 #ifdef UNIX
3184 if (n == intr_char)
3185 n = ESC;
3186 #endif
3187 break;
3190 mapped_ctrl_c = save_mapped_ctrl_c;
3191 return n;
3195 * Get a number from the user.
3196 * When "mouse_used" is not NULL allow using the mouse.
3199 get_number(colon, mouse_used)
3200 int colon; /* allow colon to abort */
3201 int *mouse_used;
3203 int n = 0;
3204 int c;
3205 int typed = 0;
3207 if (mouse_used != NULL)
3208 *mouse_used = FALSE;
3210 /* When not printing messages, the user won't know what to type, return a
3211 * zero (as if CR was hit). */
3212 if (msg_silent != 0)
3213 return 0;
3215 #ifdef USE_ON_FLY_SCROLL
3216 dont_scroll = TRUE; /* disallow scrolling here */
3217 #endif
3218 ++no_mapping;
3219 ++allow_keys; /* no mapping here, but recognize keys */
3220 for (;;)
3222 windgoto(msg_row, msg_col);
3223 c = safe_vgetc();
3224 if (VIM_ISDIGIT(c))
3226 n = n * 10 + c - '0';
3227 msg_putchar(c);
3228 ++typed;
3230 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
3232 if (typed > 0)
3234 MSG_PUTS("\b \b");
3235 --typed;
3237 n /= 10;
3239 #ifdef FEAT_MOUSE
3240 else if (mouse_used != NULL && c == K_LEFTMOUSE)
3242 *mouse_used = TRUE;
3243 n = mouse_row + 1;
3244 break;
3246 #endif
3247 else if (n == 0 && c == ':' && colon)
3249 stuffcharReadbuff(':');
3250 if (!exmode_active)
3251 cmdline_row = msg_row;
3252 skip_redraw = TRUE; /* skip redraw once */
3253 do_redraw = FALSE;
3254 break;
3256 else if (c == CAR || c == NL || c == Ctrl_C || c == ESC)
3257 break;
3259 --no_mapping;
3260 --allow_keys;
3261 return n;
3265 * Ask the user to enter a number.
3266 * When "mouse_used" is not NULL allow using the mouse and in that case return
3267 * the line number.
3270 prompt_for_number(mouse_used)
3271 int *mouse_used;
3273 int i;
3274 int save_cmdline_row;
3275 int save_State;
3277 /* When using ":silent" assume that <CR> was entered. */
3278 if (mouse_used != NULL)
3279 MSG_PUTS(_("Type number and <Enter> or click with mouse (empty cancels): "));
3280 else
3281 MSG_PUTS(_("Type number and <Enter> (empty cancels): "));
3283 /* Set the state such that text can be selected/copied/pasted and we still
3284 * get mouse events. */
3285 save_cmdline_row = cmdline_row;
3286 cmdline_row = 0;
3287 save_State = State;
3288 State = CMDLINE;
3290 i = get_number(TRUE, mouse_used);
3291 if (KeyTyped)
3293 /* don't call wait_return() now */
3294 /* msg_putchar('\n'); */
3295 cmdline_row = msg_row - 1;
3296 need_wait_return = FALSE;
3297 msg_didany = FALSE;
3298 msg_didout = FALSE;
3300 else
3301 cmdline_row = save_cmdline_row;
3302 State = save_State;
3304 return i;
3307 void
3308 msgmore(n)
3309 long n;
3311 long pn;
3313 if (global_busy /* no messages now, wait until global is finished */
3314 || !messaging()) /* 'lazyredraw' set, don't do messages now */
3315 return;
3317 /* We don't want to overwrite another important message, but do overwrite
3318 * a previous "more lines" or "fewer lines" message, so that "5dd" and
3319 * then "put" reports the last action. */
3320 if (keep_msg != NULL && !keep_msg_more)
3321 return;
3323 if (n > 0)
3324 pn = n;
3325 else
3326 pn = -n;
3328 if (pn > p_report)
3330 if (pn == 1)
3332 if (n > 0)
3333 STRCPY(msg_buf, _("1 more line"));
3334 else
3335 STRCPY(msg_buf, _("1 line less"));
3337 else
3339 if (n > 0)
3340 sprintf((char *)msg_buf, _("%ld more lines"), pn);
3341 else
3342 sprintf((char *)msg_buf, _("%ld fewer lines"), pn);
3344 if (got_int)
3345 STRCAT(msg_buf, _(" (Interrupted)"));
3346 if (msg(msg_buf))
3348 set_keep_msg(msg_buf, 0);
3349 keep_msg_more = TRUE;
3355 * flush map and typeahead buffers and give a warning for an error
3357 void
3358 beep_flush()
3360 if (emsg_silent == 0)
3362 flush_buffers(FALSE);
3363 vim_beep();
3368 * give a warning for an error
3370 void
3371 vim_beep()
3373 if (emsg_silent == 0)
3375 if (p_vb
3376 #ifdef FEAT_GUI
3377 /* While the GUI is starting up the termcap is set for the GUI
3378 * but the output still goes to a terminal. */
3379 && !(gui.in_use && gui.starting)
3380 #endif
3383 out_str(T_VB);
3385 else
3387 #ifdef MSDOS
3389 * The number of beeps outputted is reduced to avoid having to wait
3390 * for all the beeps to finish. This is only a problem on systems
3391 * where the beeps don't overlap.
3393 if (beep_count == 0 || beep_count == 10)
3395 out_char(BELL);
3396 beep_count = 1;
3398 else
3399 ++beep_count;
3400 #else
3401 out_char(BELL);
3402 #endif
3405 /* When 'verbose' is set and we are sourcing a script or executing a
3406 * function give the user a hint where the beep comes from. */
3407 if (vim_strchr(p_debug, 'e') != NULL)
3409 msg_source(hl_attr(HLF_W));
3410 msg_attr((char_u *)_("Beep!"), hl_attr(HLF_W));
3416 * To get the "real" home directory:
3417 * - get value of $HOME
3418 * For Unix:
3419 * - go to that directory
3420 * - do mch_dirname() to get the real name of that directory.
3421 * This also works with mounts and links.
3422 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
3424 static char_u *homedir = NULL;
3426 void
3427 init_homedir()
3429 char_u *var;
3431 /* In case we are called a second time (when 'encoding' changes). */
3432 vim_free(homedir);
3433 homedir = NULL;
3435 #ifdef VMS
3436 var = mch_getenv((char_u *)"SYS$LOGIN");
3437 #else
3438 var = mch_getenv((char_u *)"HOME");
3439 #endif
3441 if (var != NULL && *var == NUL) /* empty is same as not set */
3442 var = NULL;
3444 #ifdef WIN3264
3446 * Weird but true: $HOME may contain an indirect reference to another
3447 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
3448 * when $HOME is being set.
3450 if (var != NULL && *var == '%')
3452 char_u *p;
3453 char_u *exp;
3455 p = vim_strchr(var + 1, '%');
3456 if (p != NULL)
3458 vim_strncpy(NameBuff, var + 1, p - (var + 1));
3459 exp = mch_getenv(NameBuff);
3460 if (exp != NULL && *exp != NUL
3461 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
3463 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
3464 var = NameBuff;
3465 /* Also set $HOME, it's needed for _viminfo. */
3466 vim_setenv((char_u *)"HOME", NameBuff);
3472 * Typically, $HOME is not defined on Windows, unless the user has
3473 * specifically defined it for Vim's sake. However, on Windows NT
3474 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
3475 * each user. Try constructing $HOME from these.
3477 if (var == NULL)
3479 char_u *homedrive, *homepath;
3481 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
3482 homepath = mch_getenv((char_u *)"HOMEPATH");
3483 if (homepath == NULL || *homepath == NUL)
3484 homepath = "\\";
3485 if (homedrive != NULL
3486 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
3488 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
3489 if (NameBuff[0] != NUL)
3491 var = NameBuff;
3492 /* Also set $HOME, it's needed for _viminfo. */
3493 vim_setenv((char_u *)"HOME", NameBuff);
3498 # if defined(FEAT_MBYTE)
3499 if (enc_utf8 && var != NULL)
3501 int len;
3502 char_u *pp;
3504 /* Convert from active codepage to UTF-8. Other conversions are
3505 * not done, because they would fail for non-ASCII characters. */
3506 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
3507 if (pp != NULL)
3509 homedir = pp;
3510 return;
3513 # endif
3514 #endif
3516 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3518 * Default home dir is C:/
3519 * Best assumption we can make in such a situation.
3521 if (var == NULL)
3522 var = "C:/";
3523 #endif
3524 if (var != NULL)
3526 #ifdef UNIX
3528 * Change to the directory and get the actual path. This resolves
3529 * links. Don't do it when we can't return.
3531 if (mch_dirname(NameBuff, MAXPATHL) == OK
3532 && mch_chdir((char *)NameBuff) == 0)
3534 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
3535 var = IObuff;
3536 if (mch_chdir((char *)NameBuff) != 0)
3537 EMSG(_(e_prev_dir));
3539 #endif
3540 homedir = vim_strsave(var);
3544 #if defined(EXITFREE) || defined(PROTO)
3545 void
3546 free_homedir()
3548 vim_free(homedir);
3550 #endif
3553 * Call expand_env() and store the result in an allocated string.
3554 * This is not very memory efficient, this expects the result to be freed
3555 * again soon.
3557 char_u *
3558 expand_env_save(src)
3559 char_u *src;
3561 return expand_env_save_opt(src, FALSE);
3565 * Idem, but when "one" is TRUE handle the string as one file name, only
3566 * expand "~" at the start.
3568 char_u *
3569 expand_env_save_opt(src, one)
3570 char_u *src;
3571 int one;
3573 char_u *p;
3575 p = alloc(MAXPATHL);
3576 if (p != NULL)
3577 expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
3578 return p;
3582 * Expand environment variable with path name.
3583 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
3584 * Skips over "\ ", "\~" and "\$" (not for Win32 though).
3585 * If anything fails no expansion is done and dst equals src.
3587 void
3588 expand_env(src, dst, dstlen)
3589 char_u *src; /* input string e.g. "$HOME/vim.hlp" */
3590 char_u *dst; /* where to put the result */
3591 int dstlen; /* maximum length of the result */
3593 expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
3596 void
3597 expand_env_esc(srcp, dst, dstlen, esc, one, startstr)
3598 char_u *srcp; /* input string e.g. "$HOME/vim.hlp" */
3599 char_u *dst; /* where to put the result */
3600 int dstlen; /* maximum length of the result */
3601 int esc; /* escape spaces in expanded variables */
3602 int one; /* "srcp" is one file name */
3603 char_u *startstr; /* start again after this (can be NULL) */
3605 char_u *src;
3606 char_u *tail;
3607 int c;
3608 char_u *var;
3609 int copy_char;
3610 int mustfree; /* var was allocated, need to free it later */
3611 int at_start = TRUE; /* at start of a name */
3612 int startstr_len = 0;
3614 if (startstr != NULL)
3615 startstr_len = (int)STRLEN(startstr);
3617 src = skipwhite(srcp);
3618 --dstlen; /* leave one char space for "\," */
3619 while (*src && dstlen > 0)
3621 copy_char = TRUE;
3622 if ((*src == '$'
3623 #ifdef VMS
3624 && at_start
3625 #endif
3627 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3628 || *src == '%'
3629 #endif
3630 || (*src == '~' && at_start))
3632 mustfree = FALSE;
3635 * The variable name is copied into dst temporarily, because it may
3636 * be a string in read-only memory and a NUL needs to be appended.
3638 if (*src != '~') /* environment var */
3640 tail = src + 1;
3641 var = dst;
3642 c = dstlen - 1;
3644 #ifdef UNIX
3645 /* Unix has ${var-name} type environment vars */
3646 if (*tail == '{' && !vim_isIDc('{'))
3648 tail++; /* ignore '{' */
3649 while (c-- > 0 && *tail && *tail != '}')
3650 *var++ = *tail++;
3652 else
3653 #endif
3655 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
3656 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3657 || (*src == '%' && *tail != '%')
3658 #endif
3661 #ifdef OS2 /* env vars only in uppercase */
3662 *var++ = TOUPPER_LOC(*tail);
3663 tail++; /* toupper() may be a macro! */
3664 #else
3665 *var++ = *tail++;
3666 #endif
3670 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3671 # ifdef UNIX
3672 if (src[1] == '{' && *tail != '}')
3673 # else
3674 if (*src == '%' && *tail != '%')
3675 # endif
3676 var = NULL;
3677 else
3679 # ifdef UNIX
3680 if (src[1] == '{')
3681 # else
3682 if (*src == '%')
3683 #endif
3684 ++tail;
3685 #endif
3686 *var = NUL;
3687 var = vim_getenv(dst, &mustfree);
3688 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3690 #endif
3692 /* home directory */
3693 else if ( src[1] == NUL
3694 || vim_ispathsep(src[1])
3695 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
3697 var = homedir;
3698 tail = src + 1;
3700 else /* user directory */
3702 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
3704 * Copy ~user to dst[], so we can put a NUL after it.
3706 tail = src;
3707 var = dst;
3708 c = dstlen - 1;
3709 while ( c-- > 0
3710 && *tail
3711 && vim_isfilec(*tail)
3712 && !vim_ispathsep(*tail))
3713 *var++ = *tail++;
3714 *var = NUL;
3715 # ifdef UNIX
3717 * If the system supports getpwnam(), use it.
3718 * Otherwise, or if getpwnam() fails, the shell is used to
3719 * expand ~user. This is slower and may fail if the shell
3720 * does not support ~user (old versions of /bin/sh).
3722 # if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
3724 struct passwd *pw;
3726 /* Note: memory allocated by getpwnam() is never freed.
3727 * Calling endpwent() apparently doesn't help. */
3728 pw = getpwnam((char *)dst + 1);
3729 if (pw != NULL)
3730 var = (char_u *)pw->pw_dir;
3731 else
3732 var = NULL;
3734 if (var == NULL)
3735 # endif
3737 expand_T xpc;
3739 ExpandInit(&xpc);
3740 xpc.xp_context = EXPAND_FILES;
3741 var = ExpandOne(&xpc, dst, NULL,
3742 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
3743 mustfree = TRUE;
3746 # else /* !UNIX, thus VMS */
3748 * USER_HOME is a comma-separated list of
3749 * directories to search for the user account in.
3752 char_u test[MAXPATHL], paths[MAXPATHL];
3753 char_u *path, *next_path, *ptr;
3754 struct stat st;
3756 STRCPY(paths, USER_HOME);
3757 next_path = paths;
3758 while (*next_path)
3760 for (path = next_path; *next_path && *next_path != ',';
3761 next_path++);
3762 if (*next_path)
3763 *next_path++ = NUL;
3764 STRCPY(test, path);
3765 STRCAT(test, "/");
3766 STRCAT(test, dst + 1);
3767 if (mch_stat(test, &st) == 0)
3769 var = alloc(STRLEN(test) + 1);
3770 STRCPY(var, test);
3771 mustfree = TRUE;
3772 break;
3776 # endif /* UNIX */
3777 #else
3778 /* cannot expand user's home directory, so don't try */
3779 var = NULL;
3780 tail = (char_u *)""; /* for gcc */
3781 #endif /* UNIX || VMS */
3784 #ifdef BACKSLASH_IN_FILENAME
3785 /* If 'shellslash' is set change backslashes to forward slashes.
3786 * Can't use slash_adjust(), p_ssl may be set temporarily. */
3787 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
3789 char_u *p = vim_strsave(var);
3791 if (p != NULL)
3793 if (mustfree)
3794 vim_free(var);
3795 var = p;
3796 mustfree = TRUE;
3797 forward_slash(var);
3800 #endif
3802 /* If "var" contains white space, escape it with a backslash.
3803 * Required for ":e ~/tt" when $HOME includes a space. */
3804 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
3806 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
3808 if (p != NULL)
3810 if (mustfree)
3811 vim_free(var);
3812 var = p;
3813 mustfree = TRUE;
3817 if (var != NULL && *var != NUL
3818 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
3820 STRCPY(dst, var);
3821 dstlen -= (int)STRLEN(var);
3822 c = (int)STRLEN(var);
3823 /* if var[] ends in a path separator and tail[] starts
3824 * with it, skip a character */
3825 if (*var != NUL && after_pathsep(dst, dst + c)
3826 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
3827 && dst[-1] != ':'
3828 #endif
3829 && vim_ispathsep(*tail))
3830 ++tail;
3831 dst += c;
3832 src = tail;
3833 copy_char = FALSE;
3835 if (mustfree)
3836 vim_free(var);
3839 if (copy_char) /* copy at least one char */
3842 * Recognize the start of a new name, for '~'.
3843 * Don't do this when "one" is TRUE, to avoid expanding "~" in
3844 * ":edit foo ~ foo".
3846 at_start = FALSE;
3847 if (src[0] == '\\' && src[1] != NUL)
3849 *dst++ = *src++;
3850 --dstlen;
3852 else if ((src[0] == ' ' || src[0] == ',') && !one)
3853 at_start = TRUE;
3854 *dst++ = *src++;
3855 --dstlen;
3857 if (startstr != NULL && src - startstr_len >= srcp
3858 && STRNCMP(src - startstr_len, startstr, startstr_len) == 0)
3859 at_start = TRUE;
3862 *dst = NUL;
3866 * Vim's version of getenv().
3867 * Special handling of $HOME, $VIM and $VIMRUNTIME.
3868 * Also does ACP to 'enc' conversion for Win32.
3870 char_u *
3871 vim_getenv(name, mustfree)
3872 char_u *name;
3873 int *mustfree; /* set to TRUE when returned is allocated */
3875 char_u *p;
3876 char_u *pend;
3877 int vimruntime;
3879 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3880 /* use "C:/" when $HOME is not set */
3881 if (STRCMP(name, "HOME") == 0)
3882 return homedir;
3883 #endif
3885 p = mch_getenv(name);
3886 if (p != NULL && *p == NUL) /* empty is the same as not set */
3887 p = NULL;
3889 if (p != NULL)
3891 #if defined(FEAT_MBYTE) && defined(WIN3264)
3892 if (enc_utf8)
3894 int len;
3895 char_u *pp;
3897 /* Convert from active codepage to UTF-8. Other conversions are
3898 * not done, because they would fail for non-ASCII characters. */
3899 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3900 if (pp != NULL)
3902 p = pp;
3903 *mustfree = TRUE;
3906 #endif
3907 return p;
3910 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
3911 if (!vimruntime && STRCMP(name, "VIM") != 0)
3912 return NULL;
3915 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
3916 * Don't do this when default_vimruntime_dir is non-empty.
3918 if (vimruntime
3919 #ifdef HAVE_PATHDEF
3920 && *default_vimruntime_dir == NUL
3921 #endif
3924 p = mch_getenv((char_u *)"VIM");
3925 if (p != NULL && *p == NUL) /* empty is the same as not set */
3926 p = NULL;
3927 if (p != NULL)
3929 p = vim_version_dir(p);
3930 if (p != NULL)
3931 *mustfree = TRUE;
3932 else
3933 p = mch_getenv((char_u *)"VIM");
3935 #if defined(FEAT_MBYTE) && defined(WIN3264)
3936 if (enc_utf8)
3938 int len;
3939 char_u *pp;
3941 /* Convert from active codepage to UTF-8. Other conversions
3942 * are not done, because they would fail for non-ASCII
3943 * characters. */
3944 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3945 if (pp != NULL)
3947 if (mustfree)
3948 vim_free(p);
3949 p = pp;
3950 *mustfree = TRUE;
3953 #endif
3958 * When expanding $VIM or $VIMRUNTIME fails, try using:
3959 * - the directory name from 'helpfile' (unless it contains '$')
3960 * - the executable name from argv[0]
3962 if (p == NULL)
3964 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
3965 p = p_hf;
3966 #ifdef USE_EXE_NAME
3968 * Use the name of the executable, obtained from argv[0].
3970 else
3971 p = exe_name;
3972 #endif
3973 if (p != NULL)
3975 /* remove the file name */
3976 pend = gettail(p);
3978 /* remove "doc/" from 'helpfile', if present */
3979 if (p == p_hf)
3980 pend = remove_tail(p, pend, (char_u *)"doc");
3982 #ifdef USE_EXE_NAME
3983 # ifdef MACOS_X
3984 /* remove "MacOS" from exe_name and add "Resources/vim" */
3985 if (p == exe_name)
3987 char_u *pend1;
3988 char_u *pnew;
3990 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
3991 if (pend1 != pend)
3993 pnew = alloc((unsigned)(pend1 - p) + 15);
3994 if (pnew != NULL)
3996 STRNCPY(pnew, p, (pend1 - p));
3997 STRCPY(pnew + (pend1 - p), "Resources/vim");
3998 p = pnew;
3999 pend = p + STRLEN(p);
4003 # endif
4004 /* remove "src/" from exe_name, if present */
4005 if (p == exe_name)
4006 pend = remove_tail(p, pend, (char_u *)"src");
4007 #endif
4009 /* for $VIM, remove "runtime/" or "vim54/", if present */
4010 if (!vimruntime)
4012 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
4013 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
4016 /* remove trailing path separator */
4017 #ifndef MACOS_CLASSIC
4018 /* With MacOS path (with colons) the final colon is required */
4019 /* to avoid confusion between absolute and relative path */
4020 if (pend > p && after_pathsep(p, pend))
4021 --pend;
4022 #endif
4024 #ifdef MACOS_X
4025 if (p == exe_name || p == p_hf)
4026 #endif
4027 /* check that the result is a directory name */
4028 p = vim_strnsave(p, (int)(pend - p));
4030 if (p != NULL && !mch_isdir(p))
4032 vim_free(p);
4033 p = NULL;
4035 else
4037 #ifdef USE_EXE_NAME
4038 /* may add "/vim54" or "/runtime" if it exists */
4039 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
4041 vim_free(p);
4042 p = pend;
4044 #endif
4045 *mustfree = TRUE;
4050 #ifdef HAVE_PATHDEF
4051 /* When there is a pathdef.c file we can use default_vim_dir and
4052 * default_vimruntime_dir */
4053 if (p == NULL)
4055 /* Only use default_vimruntime_dir when it is not empty */
4056 if (vimruntime && *default_vimruntime_dir != NUL)
4058 p = default_vimruntime_dir;
4059 *mustfree = FALSE;
4061 else if (*default_vim_dir != NUL)
4063 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
4064 *mustfree = TRUE;
4065 else
4067 p = default_vim_dir;
4068 *mustfree = FALSE;
4072 #endif
4075 * Set the environment variable, so that the new value can be found fast
4076 * next time, and others can also use it (e.g. Perl).
4078 if (p != NULL)
4080 if (vimruntime)
4082 vim_setenv((char_u *)"VIMRUNTIME", p);
4083 didset_vimruntime = TRUE;
4084 #ifdef FEAT_GETTEXT
4086 char_u *buf = concat_str(p, (char_u *)"/lang");
4088 if (buf != NULL)
4090 bindtextdomain(VIMPACKAGE, (char *)buf);
4091 vim_free(buf);
4094 #endif
4096 else
4098 vim_setenv((char_u *)"VIM", p);
4099 didset_vim = TRUE;
4102 return p;
4106 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
4107 * Return NULL if not, return its name in allocated memory otherwise.
4109 static char_u *
4110 vim_version_dir(vimdir)
4111 char_u *vimdir;
4113 char_u *p;
4115 if (vimdir == NULL || *vimdir == NUL)
4116 return NULL;
4117 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
4118 if (p != NULL && mch_isdir(p))
4119 return p;
4120 vim_free(p);
4121 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
4122 if (p != NULL && mch_isdir(p))
4123 return p;
4124 vim_free(p);
4125 return NULL;
4129 * If the string between "p" and "pend" ends in "name/", return "pend" minus
4130 * the length of "name/". Otherwise return "pend".
4132 static char_u *
4133 remove_tail(p, pend, name)
4134 char_u *p;
4135 char_u *pend;
4136 char_u *name;
4138 int len = (int)STRLEN(name) + 1;
4139 char_u *newend = pend - len;
4141 if (newend >= p
4142 && fnamencmp(newend, name, len - 1) == 0
4143 && (newend == p || after_pathsep(p, newend)))
4144 return newend;
4145 return pend;
4149 * Our portable version of setenv.
4151 void
4152 vim_setenv(name, val)
4153 char_u *name;
4154 char_u *val;
4156 #ifdef HAVE_SETENV
4157 mch_setenv((char *)name, (char *)val, 1);
4158 #else
4159 char_u *envbuf;
4162 * Putenv does not copy the string, it has to remain
4163 * valid. The allocated memory will never be freed.
4165 envbuf = alloc((unsigned)(STRLEN(name) + STRLEN(val) + 2));
4166 if (envbuf != NULL)
4168 sprintf((char *)envbuf, "%s=%s", name, val);
4169 putenv((char *)envbuf);
4171 #endif
4174 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4176 * Function given to ExpandGeneric() to obtain an environment variable name.
4178 char_u *
4179 get_env_name(xp, idx)
4180 expand_T *xp UNUSED;
4181 int idx;
4183 # if defined(AMIGA) || defined(__MRC__) || defined(__SC__)
4185 * No environ[] on the Amiga and on the Mac (using MPW).
4187 return NULL;
4188 # else
4189 # ifndef __WIN32__
4190 /* Borland C++ 5.2 has this in a header file. */
4191 extern char **environ;
4192 # endif
4193 # define ENVNAMELEN 100
4194 static char_u name[ENVNAMELEN];
4195 char_u *str;
4196 int n;
4198 str = (char_u *)environ[idx];
4199 if (str == NULL)
4200 return NULL;
4202 for (n = 0; n < ENVNAMELEN - 1; ++n)
4204 if (str[n] == '=' || str[n] == NUL)
4205 break;
4206 name[n] = str[n];
4208 name[n] = NUL;
4209 return name;
4210 # endif
4212 #endif
4215 * Replace home directory by "~" in each space or comma separated file name in
4216 * 'src'.
4217 * If anything fails (except when out of space) dst equals src.
4219 void
4220 home_replace(buf, src, dst, dstlen, one)
4221 buf_T *buf; /* when not NULL, check for help files */
4222 char_u *src; /* input file name */
4223 char_u *dst; /* where to put the result */
4224 int dstlen; /* maximum length of the result */
4225 int one; /* if TRUE, only replace one file name, include
4226 spaces and commas in the file name. */
4228 size_t dirlen = 0, envlen = 0;
4229 size_t len;
4230 char_u *homedir_env;
4231 char_u *p;
4233 if (src == NULL)
4235 *dst = NUL;
4236 return;
4240 * If the file is a help file, remove the path completely.
4242 if (buf != NULL && buf->b_help)
4244 STRCPY(dst, gettail(src));
4245 return;
4249 * We check both the value of the $HOME environment variable and the
4250 * "real" home directory.
4252 if (homedir != NULL)
4253 dirlen = STRLEN(homedir);
4255 #ifdef VMS
4256 homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
4257 #else
4258 homedir_env = mch_getenv((char_u *)"HOME");
4259 #endif
4261 if (homedir_env != NULL && *homedir_env == NUL)
4262 homedir_env = NULL;
4263 if (homedir_env != NULL)
4264 envlen = STRLEN(homedir_env);
4266 if (!one)
4267 src = skipwhite(src);
4268 while (*src && dstlen > 0)
4271 * Here we are at the beginning of a file name.
4272 * First, check to see if the beginning of the file name matches
4273 * $HOME or the "real" home directory. Check that there is a '/'
4274 * after the match (so that if e.g. the file is "/home/pieter/bla",
4275 * and the home directory is "/home/piet", the file does not end up
4276 * as "~er/bla" (which would seem to indicate the file "bla" in user
4277 * er's home directory)).
4279 p = homedir;
4280 len = dirlen;
4281 for (;;)
4283 if ( len
4284 && fnamencmp(src, p, len) == 0
4285 && (vim_ispathsep(src[len])
4286 || (!one && (src[len] == ',' || src[len] == ' '))
4287 || src[len] == NUL))
4289 src += len;
4290 if (--dstlen > 0)
4291 *dst++ = '~';
4294 * If it's just the home directory, add "/".
4296 if (!vim_ispathsep(src[0]) && --dstlen > 0)
4297 *dst++ = '/';
4298 break;
4300 if (p == homedir_env)
4301 break;
4302 p = homedir_env;
4303 len = envlen;
4306 /* if (!one) skip to separator: space or comma */
4307 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
4308 *dst++ = *src++;
4309 /* skip separator */
4310 while ((*src == ' ' || *src == ',') && --dstlen > 0)
4311 *dst++ = *src++;
4313 /* if (dstlen == 0) out of space, what to do??? */
4315 *dst = NUL;
4319 * Like home_replace, store the replaced string in allocated memory.
4320 * When something fails, NULL is returned.
4322 char_u *
4323 home_replace_save(buf, src)
4324 buf_T *buf; /* when not NULL, check for help files */
4325 char_u *src; /* input file name */
4327 char_u *dst;
4328 unsigned len;
4330 len = 3; /* space for "~/" and trailing NUL */
4331 if (src != NULL) /* just in case */
4332 len += (unsigned)STRLEN(src);
4333 dst = alloc(len);
4334 if (dst != NULL)
4335 home_replace(buf, src, dst, len, TRUE);
4336 return dst;
4340 * Compare two file names and return:
4341 * FPC_SAME if they both exist and are the same file.
4342 * FPC_SAMEX if they both don't exist and have the same file name.
4343 * FPC_DIFF if they both exist and are different files.
4344 * FPC_NOTX if they both don't exist.
4345 * FPC_DIFFX if one of them doesn't exist.
4346 * For the first name environment variables are expanded
4349 fullpathcmp(s1, s2, checkname)
4350 char_u *s1, *s2;
4351 int checkname; /* when both don't exist, check file names */
4353 #ifdef UNIX
4354 char_u exp1[MAXPATHL];
4355 char_u full1[MAXPATHL];
4356 char_u full2[MAXPATHL];
4357 struct stat st1, st2;
4358 int r1, r2;
4360 expand_env(s1, exp1, MAXPATHL);
4361 r1 = mch_stat((char *)exp1, &st1);
4362 r2 = mch_stat((char *)s2, &st2);
4363 if (r1 != 0 && r2 != 0)
4365 /* if mch_stat() doesn't work, may compare the names */
4366 if (checkname)
4368 if (fnamecmp(exp1, s2) == 0)
4369 return FPC_SAMEX;
4370 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4371 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4372 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
4373 return FPC_SAMEX;
4375 return FPC_NOTX;
4377 if (r1 != 0 || r2 != 0)
4378 return FPC_DIFFX;
4379 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
4380 return FPC_SAME;
4381 return FPC_DIFF;
4382 #else
4383 char_u *exp1; /* expanded s1 */
4384 char_u *full1; /* full path of s1 */
4385 char_u *full2; /* full path of s2 */
4386 int retval = FPC_DIFF;
4387 int r1, r2;
4389 /* allocate one buffer to store three paths (alloc()/free() is slow!) */
4390 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
4392 full1 = exp1 + MAXPATHL;
4393 full2 = full1 + MAXPATHL;
4395 expand_env(s1, exp1, MAXPATHL);
4396 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4397 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4399 /* If vim_FullName() fails, the file probably doesn't exist. */
4400 if (r1 != OK && r2 != OK)
4402 if (checkname && fnamecmp(exp1, s2) == 0)
4403 retval = FPC_SAMEX;
4404 else
4405 retval = FPC_NOTX;
4407 else if (r1 != OK || r2 != OK)
4408 retval = FPC_DIFFX;
4409 else if (fnamecmp(full1, full2))
4410 retval = FPC_DIFF;
4411 else
4412 retval = FPC_SAME;
4413 vim_free(exp1);
4415 return retval;
4416 #endif
4420 * Get the tail of a path: the file name.
4421 * Fail safe: never returns NULL.
4423 char_u *
4424 gettail(fname)
4425 char_u *fname;
4427 char_u *p1, *p2;
4429 if (fname == NULL)
4430 return (char_u *)"";
4431 for (p1 = p2 = fname; *p2; ) /* find last part of path */
4433 if (vim_ispathsep(*p2))
4434 p1 = p2 + 1;
4435 mb_ptr_adv(p2);
4437 return p1;
4441 * Get pointer to tail of "fname", including path separators. Putting a NUL
4442 * here leaves the directory name. Takes care of "c:/" and "//".
4443 * Always returns a valid pointer.
4445 char_u *
4446 gettail_sep(fname)
4447 char_u *fname;
4449 char_u *p;
4450 char_u *t;
4452 p = get_past_head(fname); /* don't remove the '/' from "c:/file" */
4453 t = gettail(fname);
4454 while (t > p && after_pathsep(fname, t))
4455 --t;
4456 #ifdef VMS
4457 /* path separator is part of the path */
4458 ++t;
4459 #endif
4460 return t;
4464 * get the next path component (just after the next path separator).
4466 char_u *
4467 getnextcomp(fname)
4468 char_u *fname;
4470 while (*fname && !vim_ispathsep(*fname))
4471 mb_ptr_adv(fname);
4472 if (*fname)
4473 ++fname;
4474 return fname;
4478 * Get a pointer to one character past the head of a path name.
4479 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
4480 * If there is no head, path is returned.
4482 char_u *
4483 get_past_head(path)
4484 char_u *path;
4486 char_u *retval;
4488 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4489 /* may skip "c:" */
4490 if (isalpha(path[0]) && path[1] == ':')
4491 retval = path + 2;
4492 else
4493 retval = path;
4494 #else
4495 # if defined(AMIGA)
4496 /* may skip "label:" */
4497 retval = vim_strchr(path, ':');
4498 if (retval == NULL)
4499 retval = path;
4500 # else /* Unix */
4501 retval = path;
4502 # endif
4503 #endif
4505 while (vim_ispathsep(*retval))
4506 ++retval;
4508 return retval;
4512 * return TRUE if 'c' is a path separator.
4515 vim_ispathsep(c)
4516 int c;
4518 #ifdef RISCOS
4519 return (c == '.' || c == ':');
4520 #else
4521 # ifdef UNIX
4522 return (c == '/'); /* UNIX has ':' inside file names */
4523 # else
4524 # ifdef BACKSLASH_IN_FILENAME
4525 return (c == ':' || c == '/' || c == '\\');
4526 # else
4527 # ifdef VMS
4528 /* server"user passwd"::device:[full.path.name]fname.extension;version" */
4529 return (c == ':' || c == '[' || c == ']' || c == '/'
4530 || c == '<' || c == '>' || c == '"' );
4531 # else /* Amiga */
4532 return (c == ':' || c == '/');
4533 # endif /* VMS */
4534 # endif
4535 # endif
4536 #endif /* RISC OS */
4539 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
4541 * return TRUE if 'c' is a path list separator.
4544 vim_ispathlistsep(c)
4545 int c;
4547 #ifdef UNIX
4548 return (c == ':');
4549 #else
4550 return (c == ';'); /* might not be right for every system... */
4551 #endif
4553 #endif
4555 #if defined(FEAT_GUI_TABLINE) || defined(FEAT_WINDOWS) \
4556 || defined(FEAT_EVAL) || defined(PROTO)
4558 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
4559 * It's done in-place.
4561 void
4562 shorten_dir(str)
4563 char_u *str;
4565 char_u *tail, *s, *d;
4566 int skip = FALSE;
4568 tail = gettail(str);
4569 d = str;
4570 for (s = str; ; ++s)
4572 if (s >= tail) /* copy the whole tail */
4574 *d++ = *s;
4575 if (*s == NUL)
4576 break;
4578 else if (vim_ispathsep(*s)) /* copy '/' and next char */
4580 *d++ = *s;
4581 skip = FALSE;
4583 else if (!skip)
4585 *d++ = *s; /* copy next char */
4586 if (*s != '~' && *s != '.') /* and leading "~" and "." */
4587 skip = TRUE;
4588 # ifdef FEAT_MBYTE
4589 if (has_mbyte)
4591 int l = mb_ptr2len(s);
4593 while (--l > 0)
4594 *d++ = *++s;
4596 # endif
4600 #endif
4603 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
4604 * Also returns TRUE if there is no directory name.
4605 * "fname" must be writable!.
4608 dir_of_file_exists(fname)
4609 char_u *fname;
4611 char_u *p;
4612 int c;
4613 int retval;
4615 p = gettail_sep(fname);
4616 if (p == fname)
4617 return TRUE;
4618 c = *p;
4619 *p = NUL;
4620 retval = mch_isdir(fname);
4621 *p = c;
4622 return retval;
4625 #if (defined(CASE_INSENSITIVE_FILENAME) && defined(BACKSLASH_IN_FILENAME)) \
4626 || defined(PROTO)
4628 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally.
4631 vim_fnamecmp(x, y)
4632 char_u *x, *y;
4634 return vim_fnamencmp(x, y, MAXPATHL);
4638 vim_fnamencmp(x, y, len)
4639 char_u *x, *y;
4640 size_t len;
4642 while (len > 0 && *x && *y)
4644 if (TOLOWER_LOC(*x) != TOLOWER_LOC(*y)
4645 && !(*x == '/' && *y == '\\')
4646 && !(*x == '\\' && *y == '/'))
4647 break;
4648 ++x;
4649 ++y;
4650 --len;
4652 if (len == 0)
4653 return 0;
4654 return (*x - *y);
4656 #endif
4659 * Concatenate file names fname1 and fname2 into allocated memory.
4660 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
4662 char_u *
4663 concat_fnames(fname1, fname2, sep)
4664 char_u *fname1;
4665 char_u *fname2;
4666 int sep;
4668 char_u *dest;
4670 dest = alloc((unsigned)(STRLEN(fname1) + STRLEN(fname2) + 3));
4671 if (dest != NULL)
4673 STRCPY(dest, fname1);
4674 if (sep)
4675 add_pathsep(dest);
4676 STRCAT(dest, fname2);
4678 return dest;
4682 * Concatenate two strings and return the result in allocated memory.
4683 * Returns NULL when out of memory.
4685 char_u *
4686 concat_str(str1, str2)
4687 char_u *str1;
4688 char_u *str2;
4690 char_u *dest;
4691 size_t l = STRLEN(str1);
4693 dest = alloc((unsigned)(l + STRLEN(str2) + 1L));
4694 if (dest != NULL)
4696 STRCPY(dest, str1);
4697 STRCPY(dest + l, str2);
4699 return dest;
4703 * Add a path separator to a file name, unless it already ends in a path
4704 * separator.
4706 void
4707 add_pathsep(p)
4708 char_u *p;
4710 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
4711 STRCAT(p, PATHSEPSTR);
4715 * FullName_save - Make an allocated copy of a full file name.
4716 * Returns NULL when out of memory.
4718 char_u *
4719 FullName_save(fname, force)
4720 char_u *fname;
4721 int force; /* force expansion, even when it already looks
4722 like a full path name */
4724 char_u *buf;
4725 char_u *new_fname = NULL;
4727 if (fname == NULL)
4728 return NULL;
4730 buf = alloc((unsigned)MAXPATHL);
4731 if (buf != NULL)
4733 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
4734 new_fname = vim_strsave(buf);
4735 else
4736 new_fname = vim_strsave(fname);
4737 vim_free(buf);
4739 return new_fname;
4742 #if defined(FEAT_CINDENT) || defined(FEAT_SYN_HL)
4744 static char_u *skip_string __ARGS((char_u *p));
4747 * Find the start of a comment, not knowing if we are in a comment right now.
4748 * Search starts at w_cursor.lnum and goes backwards.
4750 pos_T *
4751 find_start_comment(ind_maxcomment) /* XXX */
4752 int ind_maxcomment;
4754 pos_T *pos;
4755 char_u *line;
4756 char_u *p;
4757 int cur_maxcomment = ind_maxcomment;
4759 for (;;)
4761 pos = findmatchlimit(NULL, '*', FM_BACKWARD, cur_maxcomment);
4762 if (pos == NULL)
4763 break;
4766 * Check if the comment start we found is inside a string.
4767 * If it is then restrict the search to below this line and try again.
4769 line = ml_get(pos->lnum);
4770 for (p = line; *p && (colnr_T)(p - line) < pos->col; ++p)
4771 p = skip_string(p);
4772 if ((colnr_T)(p - line) <= pos->col)
4773 break;
4774 cur_maxcomment = curwin->w_cursor.lnum - pos->lnum - 1;
4775 if (cur_maxcomment <= 0)
4777 pos = NULL;
4778 break;
4781 return pos;
4785 * Skip to the end of a "string" and a 'c' character.
4786 * If there is no string or character, return argument unmodified.
4788 static char_u *
4789 skip_string(p)
4790 char_u *p;
4792 int i;
4795 * We loop, because strings may be concatenated: "date""time".
4797 for ( ; ; ++p)
4799 if (p[0] == '\'') /* 'c' or '\n' or '\000' */
4801 if (!p[1]) /* ' at end of line */
4802 break;
4803 i = 2;
4804 if (p[1] == '\\') /* '\n' or '\000' */
4806 ++i;
4807 while (vim_isdigit(p[i - 1])) /* '\000' */
4808 ++i;
4810 if (p[i] == '\'') /* check for trailing ' */
4812 p += i;
4813 continue;
4816 else if (p[0] == '"') /* start of string */
4818 for (++p; p[0]; ++p)
4820 if (p[0] == '\\' && p[1] != NUL)
4821 ++p;
4822 else if (p[0] == '"') /* end of string */
4823 break;
4825 if (p[0] == '"')
4826 continue;
4828 break; /* no string found */
4830 if (!*p)
4831 --p; /* backup from NUL */
4832 return p;
4834 #endif /* FEAT_CINDENT || FEAT_SYN_HL */
4836 #if defined(FEAT_CINDENT) || defined(PROTO)
4839 * Do C or expression indenting on the current line.
4841 void
4842 do_c_expr_indent()
4844 # ifdef FEAT_EVAL
4845 if (*curbuf->b_p_inde != NUL)
4846 fixthisline(get_expr_indent);
4847 else
4848 # endif
4849 fixthisline(get_c_indent);
4853 * Functions for C-indenting.
4854 * Most of this originally comes from Eric Fischer.
4857 * Below "XXX" means that this function may unlock the current line.
4860 static char_u *cin_skipcomment __ARGS((char_u *));
4861 static int cin_nocode __ARGS((char_u *));
4862 static pos_T *find_line_comment __ARGS((void));
4863 static int cin_islabel_skip __ARGS((char_u **));
4864 static int cin_isdefault __ARGS((char_u *));
4865 static char_u *after_label __ARGS((char_u *l));
4866 static int get_indent_nolabel __ARGS((linenr_T lnum));
4867 static int skip_label __ARGS((linenr_T, char_u **pp, int ind_maxcomment));
4868 static int cin_first_id_amount __ARGS((void));
4869 static int cin_get_equal_amount __ARGS((linenr_T lnum));
4870 static int cin_ispreproc __ARGS((char_u *));
4871 static int cin_ispreproc_cont __ARGS((char_u **pp, linenr_T *lnump));
4872 static int cin_iscomment __ARGS((char_u *));
4873 static int cin_islinecomment __ARGS((char_u *));
4874 static int cin_isterminated __ARGS((char_u *, int, int));
4875 static int cin_isinit __ARGS((void));
4876 static int cin_isfuncdecl __ARGS((char_u **, linenr_T));
4877 static int cin_isif __ARGS((char_u *));
4878 static int cin_iselse __ARGS((char_u *));
4879 static int cin_isdo __ARGS((char_u *));
4880 static int cin_iswhileofdo __ARGS((char_u *, linenr_T, int));
4881 static int cin_iswhileofdo_end __ARGS((int terminated, int ind_maxparen, int ind_maxcomment));
4882 static int cin_isbreak __ARGS((char_u *));
4883 static int cin_is_cpp_baseclass __ARGS((colnr_T *col));
4884 static int get_baseclass_amount __ARGS((int col, int ind_maxparen, int ind_maxcomment, int ind_cpp_baseclass));
4885 static int cin_ends_in __ARGS((char_u *, char_u *, char_u *));
4886 static int cin_skip2pos __ARGS((pos_T *trypos));
4887 static pos_T *find_start_brace __ARGS((int));
4888 static pos_T *find_match_paren __ARGS((int, int));
4889 static int corr_ind_maxparen __ARGS((int ind_maxparen, pos_T *startpos));
4890 static int find_last_paren __ARGS((char_u *l, int start, int end));
4891 static int find_match __ARGS((int lookfor, linenr_T ourscope, int ind_maxparen, int ind_maxcomment));
4893 static int ind_hash_comment = 0; /* # starts a comment */
4896 * Skip over white space and C comments within the line.
4897 * Also skip over Perl/shell comments if desired.
4899 static char_u *
4900 cin_skipcomment(s)
4901 char_u *s;
4903 while (*s)
4905 char_u *prev_s = s;
4907 s = skipwhite(s);
4909 /* Perl/shell # comment comment continues until eol. Require a space
4910 * before # to avoid recognizing $#array. */
4911 if (ind_hash_comment != 0 && s != prev_s && *s == '#')
4913 s += STRLEN(s);
4914 break;
4916 if (*s != '/')
4917 break;
4918 ++s;
4919 if (*s == '/') /* slash-slash comment continues till eol */
4921 s += STRLEN(s);
4922 break;
4924 if (*s != '*')
4925 break;
4926 for (++s; *s; ++s) /* skip slash-star comment */
4927 if (s[0] == '*' && s[1] == '/')
4929 s += 2;
4930 break;
4933 return s;
4937 * Return TRUE if there there is no code at *s. White space and comments are
4938 * not considered code.
4940 static int
4941 cin_nocode(s)
4942 char_u *s;
4944 return *cin_skipcomment(s) == NUL;
4948 * Check previous lines for a "//" line comment, skipping over blank lines.
4950 static pos_T *
4951 find_line_comment() /* XXX */
4953 static pos_T pos;
4954 char_u *line;
4955 char_u *p;
4957 pos = curwin->w_cursor;
4958 while (--pos.lnum > 0)
4960 line = ml_get(pos.lnum);
4961 p = skipwhite(line);
4962 if (cin_islinecomment(p))
4964 pos.col = (int)(p - line);
4965 return &pos;
4967 if (*p != NUL)
4968 break;
4970 return NULL;
4974 * Check if string matches "label:"; move to character after ':' if true.
4976 static int
4977 cin_islabel_skip(s)
4978 char_u **s;
4980 if (!vim_isIDc(**s)) /* need at least one ID character */
4981 return FALSE;
4983 while (vim_isIDc(**s))
4984 (*s)++;
4986 *s = cin_skipcomment(*s);
4988 /* "::" is not a label, it's C++ */
4989 return (**s == ':' && *++*s != ':');
4993 * Recognize a label: "label:".
4994 * Note: curwin->w_cursor must be where we are looking for the label.
4997 cin_islabel(ind_maxcomment) /* XXX */
4998 int ind_maxcomment;
5000 char_u *s;
5002 s = cin_skipcomment(ml_get_curline());
5005 * Exclude "default" from labels, since it should be indented
5006 * like a switch label. Same for C++ scope declarations.
5008 if (cin_isdefault(s))
5009 return FALSE;
5010 if (cin_isscopedecl(s))
5011 return FALSE;
5013 if (cin_islabel_skip(&s))
5016 * Only accept a label if the previous line is terminated or is a case
5017 * label.
5019 pos_T cursor_save;
5020 pos_T *trypos;
5021 char_u *line;
5023 cursor_save = curwin->w_cursor;
5024 while (curwin->w_cursor.lnum > 1)
5026 --curwin->w_cursor.lnum;
5029 * If we're in a comment now, skip to the start of the comment.
5031 curwin->w_cursor.col = 0;
5032 if ((trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
5033 curwin->w_cursor = *trypos;
5035 line = ml_get_curline();
5036 if (cin_ispreproc(line)) /* ignore #defines, #if, etc. */
5037 continue;
5038 if (*(line = cin_skipcomment(line)) == NUL)
5039 continue;
5041 curwin->w_cursor = cursor_save;
5042 if (cin_isterminated(line, TRUE, FALSE)
5043 || cin_isscopedecl(line)
5044 || cin_iscase(line)
5045 || (cin_islabel_skip(&line) && cin_nocode(line)))
5046 return TRUE;
5047 return FALSE;
5049 curwin->w_cursor = cursor_save;
5050 return TRUE; /* label at start of file??? */
5052 return FALSE;
5056 * Recognize structure initialization and enumerations.
5057 * Q&D-Implementation:
5058 * check for "=" at end or "[typedef] enum" at beginning of line.
5060 static int
5061 cin_isinit(void)
5063 char_u *s;
5065 s = cin_skipcomment(ml_get_curline());
5067 if (STRNCMP(s, "typedef", 7) == 0 && !vim_isIDc(s[7]))
5068 s = cin_skipcomment(s + 7);
5070 if (STRNCMP(s, "enum", 4) == 0 && !vim_isIDc(s[4]))
5071 return TRUE;
5073 if (cin_ends_in(s, (char_u *)"=", (char_u *)"{"))
5074 return TRUE;
5076 return FALSE;
5080 * Recognize a switch label: "case .*:" or "default:".
5083 cin_iscase(s)
5084 char_u *s;
5086 s = cin_skipcomment(s);
5087 if (STRNCMP(s, "case", 4) == 0 && !vim_isIDc(s[4]))
5089 for (s += 4; *s; ++s)
5091 s = cin_skipcomment(s);
5092 if (*s == ':')
5094 if (s[1] == ':') /* skip over "::" for C++ */
5095 ++s;
5096 else
5097 return TRUE;
5099 if (*s == '\'' && s[1] && s[2] == '\'')
5100 s += 2; /* skip over '.' */
5101 else if (*s == '/' && (s[1] == '*' || s[1] == '/'))
5102 return FALSE; /* stop at comment */
5103 else if (*s == '"')
5104 return FALSE; /* stop at string */
5106 return FALSE;
5109 if (cin_isdefault(s))
5110 return TRUE;
5111 return FALSE;
5115 * Recognize a "default" switch label.
5117 static int
5118 cin_isdefault(s)
5119 char_u *s;
5121 return (STRNCMP(s, "default", 7) == 0
5122 && *(s = cin_skipcomment(s + 7)) == ':'
5123 && s[1] != ':');
5127 * Recognize a "public/private/proctected" scope declaration label.
5130 cin_isscopedecl(s)
5131 char_u *s;
5133 int i;
5135 s = cin_skipcomment(s);
5136 if (STRNCMP(s, "public", 6) == 0)
5137 i = 6;
5138 else if (STRNCMP(s, "protected", 9) == 0)
5139 i = 9;
5140 else if (STRNCMP(s, "private", 7) == 0)
5141 i = 7;
5142 else
5143 return FALSE;
5144 return (*(s = cin_skipcomment(s + i)) == ':' && s[1] != ':');
5148 * Return a pointer to the first non-empty non-comment character after a ':'.
5149 * Return NULL if not found.
5150 * case 234: a = b;
5153 static char_u *
5154 after_label(l)
5155 char_u *l;
5157 for ( ; *l; ++l)
5159 if (*l == ':')
5161 if (l[1] == ':') /* skip over "::" for C++ */
5162 ++l;
5163 else if (!cin_iscase(l + 1))
5164 break;
5166 else if (*l == '\'' && l[1] && l[2] == '\'')
5167 l += 2; /* skip over 'x' */
5169 if (*l == NUL)
5170 return NULL;
5171 l = cin_skipcomment(l + 1);
5172 if (*l == NUL)
5173 return NULL;
5174 return l;
5178 * Get indent of line "lnum", skipping a label.
5179 * Return 0 if there is nothing after the label.
5181 static int
5182 get_indent_nolabel(lnum) /* XXX */
5183 linenr_T lnum;
5185 char_u *l;
5186 pos_T fp;
5187 colnr_T col;
5188 char_u *p;
5190 l = ml_get(lnum);
5191 p = after_label(l);
5192 if (p == NULL)
5193 return 0;
5195 fp.col = (colnr_T)(p - l);
5196 fp.lnum = lnum;
5197 getvcol(curwin, &fp, &col, NULL, NULL);
5198 return (int)col;
5202 * Find indent for line "lnum", ignoring any case or jump label.
5203 * Also return a pointer to the text (after the label) in "pp".
5204 * label: if (asdf && asdfasdf)
5207 static int
5208 skip_label(lnum, pp, ind_maxcomment)
5209 linenr_T lnum;
5210 char_u **pp;
5211 int ind_maxcomment;
5213 char_u *l;
5214 int amount;
5215 pos_T cursor_save;
5217 cursor_save = curwin->w_cursor;
5218 curwin->w_cursor.lnum = lnum;
5219 l = ml_get_curline();
5220 /* XXX */
5221 if (cin_iscase(l) || cin_isscopedecl(l) || cin_islabel(ind_maxcomment))
5223 amount = get_indent_nolabel(lnum);
5224 l = after_label(ml_get_curline());
5225 if (l == NULL) /* just in case */
5226 l = ml_get_curline();
5228 else
5230 amount = get_indent();
5231 l = ml_get_curline();
5233 *pp = l;
5235 curwin->w_cursor = cursor_save;
5236 return amount;
5240 * Return the indent of the first variable name after a type in a declaration.
5241 * int a, indent of "a"
5242 * static struct foo b, indent of "b"
5243 * enum bla c, indent of "c"
5244 * Returns zero when it doesn't look like a declaration.
5246 static int
5247 cin_first_id_amount()
5249 char_u *line, *p, *s;
5250 int len;
5251 pos_T fp;
5252 colnr_T col;
5254 line = ml_get_curline();
5255 p = skipwhite(line);
5256 len = (int)(skiptowhite(p) - p);
5257 if (len == 6 && STRNCMP(p, "static", 6) == 0)
5259 p = skipwhite(p + 6);
5260 len = (int)(skiptowhite(p) - p);
5262 if (len == 6 && STRNCMP(p, "struct", 6) == 0)
5263 p = skipwhite(p + 6);
5264 else if (len == 4 && STRNCMP(p, "enum", 4) == 0)
5265 p = skipwhite(p + 4);
5266 else if ((len == 8 && STRNCMP(p, "unsigned", 8) == 0)
5267 || (len == 6 && STRNCMP(p, "signed", 6) == 0))
5269 s = skipwhite(p + len);
5270 if ((STRNCMP(s, "int", 3) == 0 && vim_iswhite(s[3]))
5271 || (STRNCMP(s, "long", 4) == 0 && vim_iswhite(s[4]))
5272 || (STRNCMP(s, "short", 5) == 0 && vim_iswhite(s[5]))
5273 || (STRNCMP(s, "char", 4) == 0 && vim_iswhite(s[4])))
5274 p = s;
5276 for (len = 0; vim_isIDc(p[len]); ++len)
5278 if (len == 0 || !vim_iswhite(p[len]) || cin_nocode(p))
5279 return 0;
5281 p = skipwhite(p + len);
5282 fp.lnum = curwin->w_cursor.lnum;
5283 fp.col = (colnr_T)(p - line);
5284 getvcol(curwin, &fp, &col, NULL, NULL);
5285 return (int)col;
5289 * Return the indent of the first non-blank after an equal sign.
5290 * char *foo = "here";
5291 * Return zero if no (useful) equal sign found.
5292 * Return -1 if the line above "lnum" ends in a backslash.
5293 * foo = "asdf\
5294 * asdf\
5295 * here";
5297 static int
5298 cin_get_equal_amount(lnum)
5299 linenr_T lnum;
5301 char_u *line;
5302 char_u *s;
5303 colnr_T col;
5304 pos_T fp;
5306 if (lnum > 1)
5308 line = ml_get(lnum - 1);
5309 if (*line != NUL && line[STRLEN(line) - 1] == '\\')
5310 return -1;
5313 line = s = ml_get(lnum);
5314 while (*s != NUL && vim_strchr((char_u *)"=;{}\"'", *s) == NULL)
5316 if (cin_iscomment(s)) /* ignore comments */
5317 s = cin_skipcomment(s);
5318 else
5319 ++s;
5321 if (*s != '=')
5322 return 0;
5324 s = skipwhite(s + 1);
5325 if (cin_nocode(s))
5326 return 0;
5328 if (*s == '"') /* nice alignment for continued strings */
5329 ++s;
5331 fp.lnum = lnum;
5332 fp.col = (colnr_T)(s - line);
5333 getvcol(curwin, &fp, &col, NULL, NULL);
5334 return (int)col;
5338 * Recognize a preprocessor statement: Any line that starts with '#'.
5340 static int
5341 cin_ispreproc(s)
5342 char_u *s;
5344 s = skipwhite(s);
5345 if (*s == '#')
5346 return TRUE;
5347 return FALSE;
5351 * Return TRUE if line "*pp" at "*lnump" is a preprocessor statement or a
5352 * continuation line of a preprocessor statement. Decrease "*lnump" to the
5353 * start and return the line in "*pp".
5355 static int
5356 cin_ispreproc_cont(pp, lnump)
5357 char_u **pp;
5358 linenr_T *lnump;
5360 char_u *line = *pp;
5361 linenr_T lnum = *lnump;
5362 int retval = FALSE;
5364 for (;;)
5366 if (cin_ispreproc(line))
5368 retval = TRUE;
5369 *lnump = lnum;
5370 break;
5372 if (lnum == 1)
5373 break;
5374 line = ml_get(--lnum);
5375 if (*line == NUL || line[STRLEN(line) - 1] != '\\')
5376 break;
5379 if (lnum != *lnump)
5380 *pp = ml_get(*lnump);
5381 return retval;
5385 * Recognize the start of a C or C++ comment.
5387 static int
5388 cin_iscomment(p)
5389 char_u *p;
5391 return (p[0] == '/' && (p[1] == '*' || p[1] == '/'));
5395 * Recognize the start of a "//" comment.
5397 static int
5398 cin_islinecomment(p)
5399 char_u *p;
5401 return (p[0] == '/' && p[1] == '/');
5405 * Recognize a line that starts with '{' or '}', or ends with ';', '{' or '}'.
5406 * Don't consider "} else" a terminated line.
5407 * Return the character terminating the line (ending char's have precedence if
5408 * both apply in order to determine initializations).
5410 static int
5411 cin_isterminated(s, incl_open, incl_comma)
5412 char_u *s;
5413 int incl_open; /* include '{' at the end as terminator */
5414 int incl_comma; /* recognize a trailing comma */
5416 char_u found_start = 0;
5418 s = cin_skipcomment(s);
5420 if (*s == '{' || (*s == '}' && !cin_iselse(s)))
5421 found_start = *s;
5423 while (*s)
5425 /* skip over comments, "" strings and 'c'haracters */
5426 s = skip_string(cin_skipcomment(s));
5427 if ((*s == ';' || (incl_open && *s == '{') || *s == '}'
5428 || (incl_comma && *s == ','))
5429 && cin_nocode(s + 1))
5430 return *s;
5432 if (*s)
5433 s++;
5435 return found_start;
5439 * Recognize the basic picture of a function declaration -- it needs to
5440 * have an open paren somewhere and a close paren at the end of the line and
5441 * no semicolons anywhere.
5442 * When a line ends in a comma we continue looking in the next line.
5443 * "sp" points to a string with the line. When looking at other lines it must
5444 * be restored to the line. When it's NULL fetch lines here.
5445 * "lnum" is where we start looking.
5447 static int
5448 cin_isfuncdecl(sp, first_lnum)
5449 char_u **sp;
5450 linenr_T first_lnum;
5452 char_u *s;
5453 linenr_T lnum = first_lnum;
5454 int retval = FALSE;
5456 if (sp == NULL)
5457 s = ml_get(lnum);
5458 else
5459 s = *sp;
5461 while (*s && *s != '(' && *s != ';' && *s != '\'' && *s != '"')
5463 if (cin_iscomment(s)) /* ignore comments */
5464 s = cin_skipcomment(s);
5465 else
5466 ++s;
5468 if (*s != '(')
5469 return FALSE; /* ';', ' or " before any () or no '(' */
5471 while (*s && *s != ';' && *s != '\'' && *s != '"')
5473 if (*s == ')' && cin_nocode(s + 1))
5475 /* ')' at the end: may have found a match
5476 * Check for he previous line not to end in a backslash:
5477 * #if defined(x) && \
5478 * defined(y)
5480 lnum = first_lnum - 1;
5481 s = ml_get(lnum);
5482 if (*s == NUL || s[STRLEN(s) - 1] != '\\')
5483 retval = TRUE;
5484 goto done;
5486 if (*s == ',' && cin_nocode(s + 1))
5488 /* ',' at the end: continue looking in the next line */
5489 if (lnum >= curbuf->b_ml.ml_line_count)
5490 break;
5492 s = ml_get(++lnum);
5494 else if (cin_iscomment(s)) /* ignore comments */
5495 s = cin_skipcomment(s);
5496 else
5497 ++s;
5500 done:
5501 if (lnum != first_lnum && sp != NULL)
5502 *sp = ml_get(first_lnum);
5504 return retval;
5507 static int
5508 cin_isif(p)
5509 char_u *p;
5511 return (STRNCMP(p, "if", 2) == 0 && !vim_isIDc(p[2]));
5514 static int
5515 cin_iselse(p)
5516 char_u *p;
5518 if (*p == '}') /* accept "} else" */
5519 p = cin_skipcomment(p + 1);
5520 return (STRNCMP(p, "else", 4) == 0 && !vim_isIDc(p[4]));
5523 static int
5524 cin_isdo(p)
5525 char_u *p;
5527 return (STRNCMP(p, "do", 2) == 0 && !vim_isIDc(p[2]));
5531 * Check if this is a "while" that should have a matching "do".
5532 * We only accept a "while (condition) ;", with only white space between the
5533 * ')' and ';'. The condition may be spread over several lines.
5535 static int
5536 cin_iswhileofdo(p, lnum, ind_maxparen) /* XXX */
5537 char_u *p;
5538 linenr_T lnum;
5539 int ind_maxparen;
5541 pos_T cursor_save;
5542 pos_T *trypos;
5543 int retval = FALSE;
5545 p = cin_skipcomment(p);
5546 if (*p == '}') /* accept "} while (cond);" */
5547 p = cin_skipcomment(p + 1);
5548 if (STRNCMP(p, "while", 5) == 0 && !vim_isIDc(p[5]))
5550 cursor_save = curwin->w_cursor;
5551 curwin->w_cursor.lnum = lnum;
5552 curwin->w_cursor.col = 0;
5553 p = ml_get_curline();
5554 while (*p && *p != 'w') /* skip any '}', until the 'w' of the "while" */
5556 ++p;
5557 ++curwin->w_cursor.col;
5559 if ((trypos = findmatchlimit(NULL, 0, 0, ind_maxparen)) != NULL
5560 && *cin_skipcomment(ml_get_pos(trypos) + 1) == ';')
5561 retval = TRUE;
5562 curwin->w_cursor = cursor_save;
5564 return retval;
5568 * Return TRUE if we are at the end of a do-while.
5569 * do
5570 * nothing;
5571 * while (foo
5572 * && bar); <-- here
5573 * Adjust the cursor to the line with "while".
5575 static int
5576 cin_iswhileofdo_end(terminated, ind_maxparen, ind_maxcomment)
5577 int terminated;
5578 int ind_maxparen;
5579 int ind_maxcomment;
5581 char_u *line;
5582 char_u *p;
5583 char_u *s;
5584 pos_T *trypos;
5585 int i;
5587 if (terminated != ';') /* there must be a ';' at the end */
5588 return FALSE;
5590 p = line = ml_get_curline();
5591 while (*p != NUL)
5593 p = cin_skipcomment(p);
5594 if (*p == ')')
5596 s = skipwhite(p + 1);
5597 if (*s == ';' && cin_nocode(s + 1))
5599 /* Found ");" at end of the line, now check there is "while"
5600 * before the matching '('. XXX */
5601 i = (int)(p - line);
5602 curwin->w_cursor.col = i;
5603 trypos = find_match_paren(ind_maxparen, ind_maxcomment);
5604 if (trypos != NULL)
5606 s = cin_skipcomment(ml_get(trypos->lnum));
5607 if (*s == '}') /* accept "} while (cond);" */
5608 s = cin_skipcomment(s + 1);
5609 if (STRNCMP(s, "while", 5) == 0 && !vim_isIDc(s[5]))
5611 curwin->w_cursor.lnum = trypos->lnum;
5612 return TRUE;
5616 /* Searching may have made "line" invalid, get it again. */
5617 line = ml_get_curline();
5618 p = line + i;
5621 if (*p != NUL)
5622 ++p;
5624 return FALSE;
5627 static int
5628 cin_isbreak(p)
5629 char_u *p;
5631 return (STRNCMP(p, "break", 5) == 0 && !vim_isIDc(p[5]));
5635 * Find the position of a C++ base-class declaration or
5636 * constructor-initialization. eg:
5638 * class MyClass :
5639 * baseClass <-- here
5640 * class MyClass : public baseClass,
5641 * anotherBaseClass <-- here (should probably lineup ??)
5642 * MyClass::MyClass(...) :
5643 * baseClass(...) <-- here (constructor-initialization)
5645 * This is a lot of guessing. Watch out for "cond ? func() : foo".
5647 static int
5648 cin_is_cpp_baseclass(col)
5649 colnr_T *col; /* return: column to align with */
5651 char_u *s;
5652 int class_or_struct, lookfor_ctor_init, cpp_base_class;
5653 linenr_T lnum = curwin->w_cursor.lnum;
5654 char_u *line = ml_get_curline();
5656 *col = 0;
5658 s = skipwhite(line);
5659 if (*s == '#') /* skip #define FOO x ? (x) : x */
5660 return FALSE;
5661 s = cin_skipcomment(s);
5662 if (*s == NUL)
5663 return FALSE;
5665 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5667 /* Search for a line starting with '#', empty, ending in ';' or containing
5668 * '{' or '}' and start below it. This handles the following situations:
5669 * a = cond ?
5670 * func() :
5671 * asdf;
5672 * func::foo()
5673 * : something
5674 * {}
5675 * Foo::Foo (int one, int two)
5676 * : something(4),
5677 * somethingelse(3)
5678 * {}
5680 while (lnum > 1)
5682 line = ml_get(lnum - 1);
5683 s = skipwhite(line);
5684 if (*s == '#' || *s == NUL)
5685 break;
5686 while (*s != NUL)
5688 s = cin_skipcomment(s);
5689 if (*s == '{' || *s == '}'
5690 || (*s == ';' && cin_nocode(s + 1)))
5691 break;
5692 if (*s != NUL)
5693 ++s;
5695 if (*s != NUL)
5696 break;
5697 --lnum;
5700 line = ml_get(lnum);
5701 s = cin_skipcomment(line);
5702 for (;;)
5704 if (*s == NUL)
5706 if (lnum == curwin->w_cursor.lnum)
5707 break;
5708 /* Continue in the cursor line. */
5709 line = ml_get(++lnum);
5710 s = cin_skipcomment(line);
5711 if (*s == NUL)
5712 continue;
5715 if (s[0] == ':')
5717 if (s[1] == ':')
5719 /* skip double colon. It can't be a constructor
5720 * initialization any more */
5721 lookfor_ctor_init = FALSE;
5722 s = cin_skipcomment(s + 2);
5724 else if (lookfor_ctor_init || class_or_struct)
5726 /* we have something found, that looks like the start of
5727 * cpp-base-class-declaration or constructor-initialization */
5728 cpp_base_class = TRUE;
5729 lookfor_ctor_init = class_or_struct = FALSE;
5730 *col = 0;
5731 s = cin_skipcomment(s + 1);
5733 else
5734 s = cin_skipcomment(s + 1);
5736 else if ((STRNCMP(s, "class", 5) == 0 && !vim_isIDc(s[5]))
5737 || (STRNCMP(s, "struct", 6) == 0 && !vim_isIDc(s[6])))
5739 class_or_struct = TRUE;
5740 lookfor_ctor_init = FALSE;
5742 if (*s == 'c')
5743 s = cin_skipcomment(s + 5);
5744 else
5745 s = cin_skipcomment(s + 6);
5747 else
5749 if (s[0] == '{' || s[0] == '}' || s[0] == ';')
5751 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5753 else if (s[0] == ')')
5755 /* Constructor-initialization is assumed if we come across
5756 * something like "):" */
5757 class_or_struct = FALSE;
5758 lookfor_ctor_init = TRUE;
5760 else if (s[0] == '?')
5762 /* Avoid seeing '() :' after '?' as constructor init. */
5763 return FALSE;
5765 else if (!vim_isIDc(s[0]))
5767 /* if it is not an identifier, we are wrong */
5768 class_or_struct = FALSE;
5769 lookfor_ctor_init = FALSE;
5771 else if (*col == 0)
5773 /* it can't be a constructor-initialization any more */
5774 lookfor_ctor_init = FALSE;
5776 /* the first statement starts here: lineup with this one... */
5777 if (cpp_base_class)
5778 *col = (colnr_T)(s - line);
5781 /* When the line ends in a comma don't align with it. */
5782 if (lnum == curwin->w_cursor.lnum && *s == ',' && cin_nocode(s + 1))
5783 *col = 0;
5785 s = cin_skipcomment(s + 1);
5789 return cpp_base_class;
5792 static int
5793 get_baseclass_amount(col, ind_maxparen, ind_maxcomment, ind_cpp_baseclass)
5794 int col;
5795 int ind_maxparen;
5796 int ind_maxcomment;
5797 int ind_cpp_baseclass;
5799 int amount;
5800 colnr_T vcol;
5801 pos_T *trypos;
5803 if (col == 0)
5805 amount = get_indent();
5806 if (find_last_paren(ml_get_curline(), '(', ')')
5807 && (trypos = find_match_paren(ind_maxparen,
5808 ind_maxcomment)) != NULL)
5809 amount = get_indent_lnum(trypos->lnum); /* XXX */
5810 if (!cin_ends_in(ml_get_curline(), (char_u *)",", NULL))
5811 amount += ind_cpp_baseclass;
5813 else
5815 curwin->w_cursor.col = col;
5816 getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
5817 amount = (int)vcol;
5819 if (amount < ind_cpp_baseclass)
5820 amount = ind_cpp_baseclass;
5821 return amount;
5825 * Return TRUE if string "s" ends with the string "find", possibly followed by
5826 * white space and comments. Skip strings and comments.
5827 * Ignore "ignore" after "find" if it's not NULL.
5829 static int
5830 cin_ends_in(s, find, ignore)
5831 char_u *s;
5832 char_u *find;
5833 char_u *ignore;
5835 char_u *p = s;
5836 char_u *r;
5837 int len = (int)STRLEN(find);
5839 while (*p != NUL)
5841 p = cin_skipcomment(p);
5842 if (STRNCMP(p, find, len) == 0)
5844 r = skipwhite(p + len);
5845 if (ignore != NULL && STRNCMP(r, ignore, STRLEN(ignore)) == 0)
5846 r = skipwhite(r + STRLEN(ignore));
5847 if (cin_nocode(r))
5848 return TRUE;
5850 if (*p != NUL)
5851 ++p;
5853 return FALSE;
5857 * Skip strings, chars and comments until at or past "trypos".
5858 * Return the column found.
5860 static int
5861 cin_skip2pos(trypos)
5862 pos_T *trypos;
5864 char_u *line;
5865 char_u *p;
5867 p = line = ml_get(trypos->lnum);
5868 while (*p && (colnr_T)(p - line) < trypos->col)
5870 if (cin_iscomment(p))
5871 p = cin_skipcomment(p);
5872 else
5874 p = skip_string(p);
5875 ++p;
5878 return (int)(p - line);
5882 * Find the '{' at the start of the block we are in.
5883 * Return NULL if no match found.
5884 * Ignore a '{' that is in a comment, makes indenting the next three lines
5885 * work. */
5886 /* foo() */
5887 /* { */
5888 /* } */
5890 static pos_T *
5891 find_start_brace(ind_maxcomment) /* XXX */
5892 int ind_maxcomment;
5894 pos_T cursor_save;
5895 pos_T *trypos;
5896 pos_T *pos;
5897 static pos_T pos_copy;
5899 cursor_save = curwin->w_cursor;
5900 while ((trypos = findmatchlimit(NULL, '{', FM_BLOCKSTOP, 0)) != NULL)
5902 pos_copy = *trypos; /* copy pos_T, next findmatch will change it */
5903 trypos = &pos_copy;
5904 curwin->w_cursor = *trypos;
5905 pos = NULL;
5906 /* ignore the { if it's in a // or / * * / comment */
5907 if ((colnr_T)cin_skip2pos(trypos) == trypos->col
5908 && (pos = find_start_comment(ind_maxcomment)) == NULL) /* XXX */
5909 break;
5910 if (pos != NULL)
5911 curwin->w_cursor.lnum = pos->lnum;
5913 curwin->w_cursor = cursor_save;
5914 return trypos;
5918 * Find the matching '(', failing if it is in a comment.
5919 * Return NULL of no match found.
5921 static pos_T *
5922 find_match_paren(ind_maxparen, ind_maxcomment) /* XXX */
5923 int ind_maxparen;
5924 int ind_maxcomment;
5926 pos_T cursor_save;
5927 pos_T *trypos;
5928 static pos_T pos_copy;
5930 cursor_save = curwin->w_cursor;
5931 if ((trypos = findmatchlimit(NULL, '(', 0, ind_maxparen)) != NULL)
5933 /* check if the ( is in a // comment */
5934 if ((colnr_T)cin_skip2pos(trypos) > trypos->col)
5935 trypos = NULL;
5936 else
5938 pos_copy = *trypos; /* copy trypos, findmatch will change it */
5939 trypos = &pos_copy;
5940 curwin->w_cursor = *trypos;
5941 if (find_start_comment(ind_maxcomment) != NULL) /* XXX */
5942 trypos = NULL;
5945 curwin->w_cursor = cursor_save;
5946 return trypos;
5950 * Return ind_maxparen corrected for the difference in line number between the
5951 * cursor position and "startpos". This makes sure that searching for a
5952 * matching paren above the cursor line doesn't find a match because of
5953 * looking a few lines further.
5955 static int
5956 corr_ind_maxparen(ind_maxparen, startpos)
5957 int ind_maxparen;
5958 pos_T *startpos;
5960 long n = (long)startpos->lnum - (long)curwin->w_cursor.lnum;
5962 if (n > 0 && n < ind_maxparen / 2)
5963 return ind_maxparen - (int)n;
5964 return ind_maxparen;
5968 * Set w_cursor.col to the column number of the last unmatched ')' or '{' in
5969 * line "l".
5971 static int
5972 find_last_paren(l, start, end)
5973 char_u *l;
5974 int start, end;
5976 int i;
5977 int retval = FALSE;
5978 int open_count = 0;
5980 curwin->w_cursor.col = 0; /* default is start of line */
5982 for (i = 0; l[i]; i++)
5984 i = (int)(cin_skipcomment(l + i) - l); /* ignore parens in comments */
5985 i = (int)(skip_string(l + i) - l); /* ignore parens in quotes */
5986 if (l[i] == start)
5987 ++open_count;
5988 else if (l[i] == end)
5990 if (open_count > 0)
5991 --open_count;
5992 else
5994 curwin->w_cursor.col = i;
5995 retval = TRUE;
5999 return retval;
6003 get_c_indent()
6006 * spaces from a block's opening brace the prevailing indent for that
6007 * block should be
6009 int ind_level = curbuf->b_p_sw;
6012 * spaces from the edge of the line an open brace that's at the end of a
6013 * line is imagined to be.
6015 int ind_open_imag = 0;
6018 * spaces from the prevailing indent for a line that is not precededof by
6019 * an opening brace.
6021 int ind_no_brace = 0;
6024 * column where the first { of a function should be located }
6026 int ind_first_open = 0;
6029 * spaces from the prevailing indent a leftmost open brace should be
6030 * located
6032 int ind_open_extra = 0;
6035 * spaces from the matching open brace (real location for one at the left
6036 * edge; imaginary location from one that ends a line) the matching close
6037 * brace should be located
6039 int ind_close_extra = 0;
6042 * spaces from the edge of the line an open brace sitting in the leftmost
6043 * column is imagined to be
6045 int ind_open_left_imag = 0;
6048 * spaces from the switch() indent a "case xx" label should be located
6050 int ind_case = curbuf->b_p_sw;
6053 * spaces from the "case xx:" code after a switch() should be located
6055 int ind_case_code = curbuf->b_p_sw;
6058 * lineup break at end of case in switch() with case label
6060 int ind_case_break = 0;
6063 * spaces from the class declaration indent a scope declaration label
6064 * should be located
6066 int ind_scopedecl = curbuf->b_p_sw;
6069 * spaces from the scope declaration label code should be located
6071 int ind_scopedecl_code = curbuf->b_p_sw;
6074 * amount K&R-style parameters should be indented
6076 int ind_param = curbuf->b_p_sw;
6079 * amount a function type spec should be indented
6081 int ind_func_type = curbuf->b_p_sw;
6084 * amount a cpp base class declaration or constructor initialization
6085 * should be indented
6087 int ind_cpp_baseclass = curbuf->b_p_sw;
6090 * additional spaces beyond the prevailing indent a continuation line
6091 * should be located
6093 int ind_continuation = curbuf->b_p_sw;
6096 * spaces from the indent of the line with an unclosed parentheses
6098 int ind_unclosed = curbuf->b_p_sw * 2;
6101 * spaces from the indent of the line with an unclosed parentheses, which
6102 * itself is also unclosed
6104 int ind_unclosed2 = curbuf->b_p_sw;
6107 * suppress ignoring spaces from the indent of a line starting with an
6108 * unclosed parentheses.
6110 int ind_unclosed_noignore = 0;
6113 * If the opening paren is the last nonwhite character on the line, and
6114 * ind_unclosed_wrapped is nonzero, use this indent relative to the outer
6115 * context (for very long lines).
6117 int ind_unclosed_wrapped = 0;
6120 * suppress ignoring white space when lining up with the character after
6121 * an unclosed parentheses.
6123 int ind_unclosed_whiteok = 0;
6126 * indent a closing parentheses under the line start of the matching
6127 * opening parentheses.
6129 int ind_matching_paren = 0;
6132 * indent a closing parentheses under the previous line.
6134 int ind_paren_prev = 0;
6137 * Extra indent for comments.
6139 int ind_comment = 0;
6142 * spaces from the comment opener when there is nothing after it.
6144 int ind_in_comment = 3;
6147 * boolean: if non-zero, use ind_in_comment even if there is something
6148 * after the comment opener.
6150 int ind_in_comment2 = 0;
6153 * max lines to search for an open paren
6155 int ind_maxparen = 20;
6158 * max lines to search for an open comment
6160 int ind_maxcomment = 70;
6163 * handle braces for java code
6165 int ind_java = 0;
6168 * handle blocked cases correctly
6170 int ind_keep_case_label = 0;
6172 pos_T cur_curpos;
6173 int amount;
6174 int scope_amount;
6175 int cur_amount = MAXCOL;
6176 colnr_T col;
6177 char_u *theline;
6178 char_u *linecopy;
6179 pos_T *trypos;
6180 pos_T *tryposBrace = NULL;
6181 pos_T our_paren_pos;
6182 char_u *start;
6183 int start_brace;
6184 #define BRACE_IN_COL0 1 /* '{' is in column 0 */
6185 #define BRACE_AT_START 2 /* '{' is at start of line */
6186 #define BRACE_AT_END 3 /* '{' is at end of line */
6187 linenr_T ourscope;
6188 char_u *l;
6189 char_u *look;
6190 char_u terminated;
6191 int lookfor;
6192 #define LOOKFOR_INITIAL 0
6193 #define LOOKFOR_IF 1
6194 #define LOOKFOR_DO 2
6195 #define LOOKFOR_CASE 3
6196 #define LOOKFOR_ANY 4
6197 #define LOOKFOR_TERM 5
6198 #define LOOKFOR_UNTERM 6
6199 #define LOOKFOR_SCOPEDECL 7
6200 #define LOOKFOR_NOBREAK 8
6201 #define LOOKFOR_CPP_BASECLASS 9
6202 #define LOOKFOR_ENUM_OR_INIT 10
6204 int whilelevel;
6205 linenr_T lnum;
6206 char_u *options;
6207 int fraction = 0; /* init for GCC */
6208 int divider;
6209 int n;
6210 int iscase;
6211 int lookfor_break;
6212 int cont_amount = 0; /* amount for continuation line */
6214 for (options = curbuf->b_p_cino; *options; )
6216 l = options++;
6217 if (*options == '-')
6218 ++options;
6219 n = getdigits(&options);
6220 divider = 0;
6221 if (*options == '.') /* ".5s" means a fraction */
6223 fraction = atol((char *)++options);
6224 while (VIM_ISDIGIT(*options))
6226 ++options;
6227 if (divider)
6228 divider *= 10;
6229 else
6230 divider = 10;
6233 if (*options == 's') /* "2s" means two times 'shiftwidth' */
6235 if (n == 0 && fraction == 0)
6236 n = curbuf->b_p_sw; /* just "s" is one 'shiftwidth' */
6237 else
6239 n *= curbuf->b_p_sw;
6240 if (divider)
6241 n += (curbuf->b_p_sw * fraction + divider / 2) / divider;
6243 ++options;
6245 if (l[1] == '-')
6246 n = -n;
6247 /* When adding an entry here, also update the default 'cinoptions' in
6248 * doc/indent.txt, and add explanation for it! */
6249 switch (*l)
6251 case '>': ind_level = n; break;
6252 case 'e': ind_open_imag = n; break;
6253 case 'n': ind_no_brace = n; break;
6254 case 'f': ind_first_open = n; break;
6255 case '{': ind_open_extra = n; break;
6256 case '}': ind_close_extra = n; break;
6257 case '^': ind_open_left_imag = n; break;
6258 case ':': ind_case = n; break;
6259 case '=': ind_case_code = n; break;
6260 case 'b': ind_case_break = n; break;
6261 case 'p': ind_param = n; break;
6262 case 't': ind_func_type = n; break;
6263 case '/': ind_comment = n; break;
6264 case 'c': ind_in_comment = n; break;
6265 case 'C': ind_in_comment2 = n; break;
6266 case 'i': ind_cpp_baseclass = n; break;
6267 case '+': ind_continuation = n; break;
6268 case '(': ind_unclosed = n; break;
6269 case 'u': ind_unclosed2 = n; break;
6270 case 'U': ind_unclosed_noignore = n; break;
6271 case 'W': ind_unclosed_wrapped = n; break;
6272 case 'w': ind_unclosed_whiteok = n; break;
6273 case 'm': ind_matching_paren = n; break;
6274 case 'M': ind_paren_prev = n; break;
6275 case ')': ind_maxparen = n; break;
6276 case '*': ind_maxcomment = n; break;
6277 case 'g': ind_scopedecl = n; break;
6278 case 'h': ind_scopedecl_code = n; break;
6279 case 'j': ind_java = n; break;
6280 case 'l': ind_keep_case_label = n; break;
6281 case '#': ind_hash_comment = n; break;
6283 if (*options == ',')
6284 ++options;
6287 /* remember where the cursor was when we started */
6288 cur_curpos = curwin->w_cursor;
6290 /* Get a copy of the current contents of the line.
6291 * This is required, because only the most recent line obtained with
6292 * ml_get is valid! */
6293 linecopy = vim_strsave(ml_get(cur_curpos.lnum));
6294 if (linecopy == NULL)
6295 return 0;
6298 * In insert mode and the cursor is on a ')' truncate the line at the
6299 * cursor position. We don't want to line up with the matching '(' when
6300 * inserting new stuff.
6301 * For unknown reasons the cursor might be past the end of the line, thus
6302 * check for that.
6304 if ((State & INSERT)
6305 && curwin->w_cursor.col < (colnr_T)STRLEN(linecopy)
6306 && linecopy[curwin->w_cursor.col] == ')')
6307 linecopy[curwin->w_cursor.col] = NUL;
6309 theline = skipwhite(linecopy);
6311 /* move the cursor to the start of the line */
6313 curwin->w_cursor.col = 0;
6316 * #defines and so on always go at the left when included in 'cinkeys'.
6318 if (*theline == '#' && (*linecopy == '#' || in_cinkeys('#', ' ', TRUE)))
6320 amount = 0;
6324 * Is it a non-case label? Then that goes at the left margin too.
6326 else if (cin_islabel(ind_maxcomment)) /* XXX */
6328 amount = 0;
6332 * If we're inside a "//" comment and there is a "//" comment in a
6333 * previous line, lineup with that one.
6335 else if (cin_islinecomment(theline)
6336 && (trypos = find_line_comment()) != NULL) /* XXX */
6338 /* find how indented the line beginning the comment is */
6339 getvcol(curwin, trypos, &col, NULL, NULL);
6340 amount = col;
6344 * If we're inside a comment and not looking at the start of the
6345 * comment, try using the 'comments' option.
6347 else if (!cin_iscomment(theline)
6348 && (trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
6350 int lead_start_len = 2;
6351 int lead_middle_len = 1;
6352 char_u lead_start[COM_MAX_LEN]; /* start-comment string */
6353 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
6354 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
6355 char_u *p;
6356 int start_align = 0;
6357 int start_off = 0;
6358 int done = FALSE;
6360 /* find how indented the line beginning the comment is */
6361 getvcol(curwin, trypos, &col, NULL, NULL);
6362 amount = col;
6364 p = curbuf->b_p_com;
6365 while (*p != NUL)
6367 int align = 0;
6368 int off = 0;
6369 int what = 0;
6371 while (*p != NUL && *p != ':')
6373 if (*p == COM_START || *p == COM_END || *p == COM_MIDDLE)
6374 what = *p++;
6375 else if (*p == COM_LEFT || *p == COM_RIGHT)
6376 align = *p++;
6377 else if (VIM_ISDIGIT(*p) || *p == '-')
6378 off = getdigits(&p);
6379 else
6380 ++p;
6383 if (*p == ':')
6384 ++p;
6385 (void)copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6386 if (what == COM_START)
6388 STRCPY(lead_start, lead_end);
6389 lead_start_len = (int)STRLEN(lead_start);
6390 start_off = off;
6391 start_align = align;
6393 else if (what == COM_MIDDLE)
6395 STRCPY(lead_middle, lead_end);
6396 lead_middle_len = (int)STRLEN(lead_middle);
6398 else if (what == COM_END)
6400 /* If our line starts with the middle comment string, line it
6401 * up with the comment opener per the 'comments' option. */
6402 if (STRNCMP(theline, lead_middle, lead_middle_len) == 0
6403 && STRNCMP(theline, lead_end, STRLEN(lead_end)) != 0)
6405 done = TRUE;
6406 if (curwin->w_cursor.lnum > 1)
6408 /* If the start comment string matches in the previous
6409 * line, use the indent of that line plus offset. If
6410 * the middle comment string matches in the previous
6411 * line, use the indent of that line. XXX */
6412 look = skipwhite(ml_get(curwin->w_cursor.lnum - 1));
6413 if (STRNCMP(look, lead_start, lead_start_len) == 0)
6414 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6415 else if (STRNCMP(look, lead_middle,
6416 lead_middle_len) == 0)
6418 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6419 break;
6421 /* If the start comment string doesn't match with the
6422 * start of the comment, skip this entry. XXX */
6423 else if (STRNCMP(ml_get(trypos->lnum) + trypos->col,
6424 lead_start, lead_start_len) != 0)
6425 continue;
6427 if (start_off != 0)
6428 amount += start_off;
6429 else if (start_align == COM_RIGHT)
6430 amount += vim_strsize(lead_start)
6431 - vim_strsize(lead_middle);
6432 break;
6435 /* If our line starts with the end comment string, line it up
6436 * with the middle comment */
6437 if (STRNCMP(theline, lead_middle, lead_middle_len) != 0
6438 && STRNCMP(theline, lead_end, STRLEN(lead_end)) == 0)
6440 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6441 /* XXX */
6442 if (off != 0)
6443 amount += off;
6444 else if (align == COM_RIGHT)
6445 amount += vim_strsize(lead_start)
6446 - vim_strsize(lead_middle);
6447 done = TRUE;
6448 break;
6453 /* If our line starts with an asterisk, line up with the
6454 * asterisk in the comment opener; otherwise, line up
6455 * with the first character of the comment text.
6457 if (done)
6459 else if (theline[0] == '*')
6460 amount += 1;
6461 else
6464 * If we are more than one line away from the comment opener, take
6465 * the indent of the previous non-empty line. If 'cino' has "CO"
6466 * and we are just below the comment opener and there are any
6467 * white characters after it line up with the text after it;
6468 * otherwise, add the amount specified by "c" in 'cino'
6470 amount = -1;
6471 for (lnum = cur_curpos.lnum - 1; lnum > trypos->lnum; --lnum)
6473 if (linewhite(lnum)) /* skip blank lines */
6474 continue;
6475 amount = get_indent_lnum(lnum); /* XXX */
6476 break;
6478 if (amount == -1) /* use the comment opener */
6480 if (!ind_in_comment2)
6482 start = ml_get(trypos->lnum);
6483 look = start + trypos->col + 2; /* skip / and * */
6484 if (*look != NUL) /* if something after it */
6485 trypos->col = (colnr_T)(skipwhite(look) - start);
6487 getvcol(curwin, trypos, &col, NULL, NULL);
6488 amount = col;
6489 if (ind_in_comment2 || *look == NUL)
6490 amount += ind_in_comment;
6496 * Are we inside parentheses or braces?
6497 */ /* XXX */
6498 else if (((trypos = find_match_paren(ind_maxparen, ind_maxcomment)) != NULL
6499 && ind_java == 0)
6500 || (tryposBrace = find_start_brace(ind_maxcomment)) != NULL
6501 || trypos != NULL)
6503 if (trypos != NULL && tryposBrace != NULL)
6505 /* Both an unmatched '(' and '{' is found. Use the one which is
6506 * closer to the current cursor position, set the other to NULL. */
6507 if (trypos->lnum != tryposBrace->lnum
6508 ? trypos->lnum < tryposBrace->lnum
6509 : trypos->col < tryposBrace->col)
6510 trypos = NULL;
6511 else
6512 tryposBrace = NULL;
6515 if (trypos != NULL)
6518 * If the matching paren is more than one line away, use the indent of
6519 * a previous non-empty line that matches the same paren.
6521 if (theline[0] == ')' && ind_paren_prev)
6523 /* Line up with the start of the matching paren line. */
6524 amount = get_indent_lnum(curwin->w_cursor.lnum - 1); /* XXX */
6526 else
6528 amount = -1;
6529 our_paren_pos = *trypos;
6530 for (lnum = cur_curpos.lnum - 1; lnum > our_paren_pos.lnum; --lnum)
6532 l = skipwhite(ml_get(lnum));
6533 if (cin_nocode(l)) /* skip comment lines */
6534 continue;
6535 if (cin_ispreproc_cont(&l, &lnum))
6536 continue; /* ignore #define, #if, etc. */
6537 curwin->w_cursor.lnum = lnum;
6539 /* Skip a comment. XXX */
6540 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6542 lnum = trypos->lnum + 1;
6543 continue;
6546 /* XXX */
6547 if ((trypos = find_match_paren(
6548 corr_ind_maxparen(ind_maxparen, &cur_curpos),
6549 ind_maxcomment)) != NULL
6550 && trypos->lnum == our_paren_pos.lnum
6551 && trypos->col == our_paren_pos.col)
6553 amount = get_indent_lnum(lnum); /* XXX */
6555 if (theline[0] == ')')
6557 if (our_paren_pos.lnum != lnum
6558 && cur_amount > amount)
6559 cur_amount = amount;
6560 amount = -1;
6562 break;
6568 * Line up with line where the matching paren is. XXX
6569 * If the line starts with a '(' or the indent for unclosed
6570 * parentheses is zero, line up with the unclosed parentheses.
6572 if (amount == -1)
6574 int ignore_paren_col = 0;
6576 amount = skip_label(our_paren_pos.lnum, &look, ind_maxcomment);
6577 look = skipwhite(look);
6578 if (*look == '(')
6580 linenr_T save_lnum = curwin->w_cursor.lnum;
6581 char_u *line;
6582 int look_col;
6584 /* Ignore a '(' in front of the line that has a match before
6585 * our matching '('. */
6586 curwin->w_cursor.lnum = our_paren_pos.lnum;
6587 line = ml_get_curline();
6588 look_col = (int)(look - line);
6589 curwin->w_cursor.col = look_col + 1;
6590 if ((trypos = findmatchlimit(NULL, ')', 0, ind_maxparen))
6591 != NULL
6592 && trypos->lnum == our_paren_pos.lnum
6593 && trypos->col < our_paren_pos.col)
6594 ignore_paren_col = trypos->col + 1;
6596 curwin->w_cursor.lnum = save_lnum;
6597 look = ml_get(our_paren_pos.lnum) + look_col;
6599 if (theline[0] == ')' || ind_unclosed == 0
6600 || (!ind_unclosed_noignore && *look == '('
6601 && ignore_paren_col == 0))
6604 * If we're looking at a close paren, line up right there;
6605 * otherwise, line up with the next (non-white) character.
6606 * When ind_unclosed_wrapped is set and the matching paren is
6607 * the last nonwhite character of the line, use either the
6608 * indent of the current line or the indentation of the next
6609 * outer paren and add ind_unclosed_wrapped (for very long
6610 * lines).
6612 if (theline[0] != ')')
6614 cur_amount = MAXCOL;
6615 l = ml_get(our_paren_pos.lnum);
6616 if (ind_unclosed_wrapped
6617 && cin_ends_in(l, (char_u *)"(", NULL))
6619 /* look for opening unmatched paren, indent one level
6620 * for each additional level */
6621 n = 1;
6622 for (col = 0; col < our_paren_pos.col; ++col)
6624 switch (l[col])
6626 case '(':
6627 case '{': ++n;
6628 break;
6630 case ')':
6631 case '}': if (n > 1)
6632 --n;
6633 break;
6637 our_paren_pos.col = 0;
6638 amount += n * ind_unclosed_wrapped;
6640 else if (ind_unclosed_whiteok)
6641 our_paren_pos.col++;
6642 else
6644 col = our_paren_pos.col + 1;
6645 while (vim_iswhite(l[col]))
6646 col++;
6647 if (l[col] != NUL) /* In case of trailing space */
6648 our_paren_pos.col = col;
6649 else
6650 our_paren_pos.col++;
6655 * Find how indented the paren is, or the character after it
6656 * if we did the above "if".
6658 if (our_paren_pos.col > 0)
6660 getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
6661 if (cur_amount > (int)col)
6662 cur_amount = col;
6666 if (theline[0] == ')' && ind_matching_paren)
6668 /* Line up with the start of the matching paren line. */
6670 else if (ind_unclosed == 0 || (!ind_unclosed_noignore
6671 && *look == '(' && ignore_paren_col == 0))
6673 if (cur_amount != MAXCOL)
6674 amount = cur_amount;
6676 else
6678 /* Add ind_unclosed2 for each '(' before our matching one, but
6679 * ignore (void) before the line (ignore_paren_col). */
6680 col = our_paren_pos.col;
6681 while ((int)our_paren_pos.col > ignore_paren_col)
6683 --our_paren_pos.col;
6684 switch (*ml_get_pos(&our_paren_pos))
6686 case '(': amount += ind_unclosed2;
6687 col = our_paren_pos.col;
6688 break;
6689 case ')': amount -= ind_unclosed2;
6690 col = MAXCOL;
6691 break;
6695 /* Use ind_unclosed once, when the first '(' is not inside
6696 * braces */
6697 if (col == MAXCOL)
6698 amount += ind_unclosed;
6699 else
6701 curwin->w_cursor.lnum = our_paren_pos.lnum;
6702 curwin->w_cursor.col = col;
6703 if ((trypos = find_match_paren(ind_maxparen,
6704 ind_maxcomment)) != NULL)
6705 amount += ind_unclosed2;
6706 else
6707 amount += ind_unclosed;
6710 * For a line starting with ')' use the minimum of the two
6711 * positions, to avoid giving it more indent than the previous
6712 * lines:
6713 * func_long_name( if (x
6714 * arg && yy
6715 * ) ^ not here ) ^ not here
6717 if (cur_amount < amount)
6718 amount = cur_amount;
6722 /* add extra indent for a comment */
6723 if (cin_iscomment(theline))
6724 amount += ind_comment;
6728 * Are we at least inside braces, then?
6730 else
6732 trypos = tryposBrace;
6734 ourscope = trypos->lnum;
6735 start = ml_get(ourscope);
6738 * Now figure out how indented the line is in general.
6739 * If the brace was at the start of the line, we use that;
6740 * otherwise, check out the indentation of the line as
6741 * a whole and then add the "imaginary indent" to that.
6743 look = skipwhite(start);
6744 if (*look == '{')
6746 getvcol(curwin, trypos, &col, NULL, NULL);
6747 amount = col;
6748 if (*start == '{')
6749 start_brace = BRACE_IN_COL0;
6750 else
6751 start_brace = BRACE_AT_START;
6753 else
6756 * that opening brace might have been on a continuation
6757 * line. if so, find the start of the line.
6759 curwin->w_cursor.lnum = ourscope;
6762 * position the cursor over the rightmost paren, so that
6763 * matching it will take us back to the start of the line.
6765 lnum = ourscope;
6766 if (find_last_paren(start, '(', ')')
6767 && (trypos = find_match_paren(ind_maxparen,
6768 ind_maxcomment)) != NULL)
6769 lnum = trypos->lnum;
6772 * It could have been something like
6773 * case 1: if (asdf &&
6774 * ldfd) {
6777 if (ind_keep_case_label && cin_iscase(skipwhite(ml_get_curline())))
6778 amount = get_indent();
6779 else
6780 amount = skip_label(lnum, &l, ind_maxcomment);
6782 start_brace = BRACE_AT_END;
6786 * if we're looking at a closing brace, that's where
6787 * we want to be. otherwise, add the amount of room
6788 * that an indent is supposed to be.
6790 if (theline[0] == '}')
6793 * they may want closing braces to line up with something
6794 * other than the open brace. indulge them, if so.
6796 amount += ind_close_extra;
6798 else
6801 * If we're looking at an "else", try to find an "if"
6802 * to match it with.
6803 * If we're looking at a "while", try to find a "do"
6804 * to match it with.
6806 lookfor = LOOKFOR_INITIAL;
6807 if (cin_iselse(theline))
6808 lookfor = LOOKFOR_IF;
6809 else if (cin_iswhileofdo(theline, cur_curpos.lnum, ind_maxparen))
6810 /* XXX */
6811 lookfor = LOOKFOR_DO;
6812 if (lookfor != LOOKFOR_INITIAL)
6814 curwin->w_cursor.lnum = cur_curpos.lnum;
6815 if (find_match(lookfor, ourscope, ind_maxparen,
6816 ind_maxcomment) == OK)
6818 amount = get_indent(); /* XXX */
6819 goto theend;
6824 * We get here if we are not on an "while-of-do" or "else" (or
6825 * failed to find a matching "if").
6826 * Search backwards for something to line up with.
6827 * First set amount for when we don't find anything.
6831 * if the '{' is _really_ at the left margin, use the imaginary
6832 * location of a left-margin brace. Otherwise, correct the
6833 * location for ind_open_extra.
6836 if (start_brace == BRACE_IN_COL0) /* '{' is in column 0 */
6838 amount = ind_open_left_imag;
6840 else
6842 if (start_brace == BRACE_AT_END) /* '{' is at end of line */
6843 amount += ind_open_imag;
6844 else
6846 /* Compensate for adding ind_open_extra later. */
6847 amount -= ind_open_extra;
6848 if (amount < 0)
6849 amount = 0;
6853 lookfor_break = FALSE;
6855 if (cin_iscase(theline)) /* it's a switch() label */
6857 lookfor = LOOKFOR_CASE; /* find a previous switch() label */
6858 amount += ind_case;
6860 else if (cin_isscopedecl(theline)) /* private:, ... */
6862 lookfor = LOOKFOR_SCOPEDECL; /* class decl is this block */
6863 amount += ind_scopedecl;
6865 else
6867 if (ind_case_break && cin_isbreak(theline)) /* break; ... */
6868 lookfor_break = TRUE;
6870 lookfor = LOOKFOR_INITIAL;
6871 amount += ind_level; /* ind_level from start of block */
6873 scope_amount = amount;
6874 whilelevel = 0;
6877 * Search backwards. If we find something we recognize, line up
6878 * with that.
6880 * if we're looking at an open brace, indent
6881 * the usual amount relative to the conditional
6882 * that opens the block.
6884 curwin->w_cursor = cur_curpos;
6885 for (;;)
6887 curwin->w_cursor.lnum--;
6888 curwin->w_cursor.col = 0;
6891 * If we went all the way back to the start of our scope, line
6892 * up with it.
6894 if (curwin->w_cursor.lnum <= ourscope)
6896 /* we reached end of scope:
6897 * if looking for a enum or structure initialization
6898 * go further back:
6899 * if it is an initializer (enum xxx or xxx =), then
6900 * don't add ind_continuation, otherwise it is a variable
6901 * declaration:
6902 * int x,
6903 * here; <-- add ind_continuation
6905 if (lookfor == LOOKFOR_ENUM_OR_INIT)
6907 if (curwin->w_cursor.lnum == 0
6908 || curwin->w_cursor.lnum
6909 < ourscope - ind_maxparen)
6911 /* nothing found (abuse ind_maxparen as limit)
6912 * assume terminated line (i.e. a variable
6913 * initialization) */
6914 if (cont_amount > 0)
6915 amount = cont_amount;
6916 else
6917 amount += ind_continuation;
6918 break;
6921 l = ml_get_curline();
6924 * If we're in a comment now, skip to the start of the
6925 * comment.
6927 trypos = find_start_comment(ind_maxcomment);
6928 if (trypos != NULL)
6930 curwin->w_cursor.lnum = trypos->lnum + 1;
6931 curwin->w_cursor.col = 0;
6932 continue;
6936 * Skip preprocessor directives and blank lines.
6938 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
6939 continue;
6941 if (cin_nocode(l))
6942 continue;
6944 terminated = cin_isterminated(l, FALSE, TRUE);
6947 * If we are at top level and the line looks like a
6948 * function declaration, we are done
6949 * (it's a variable declaration).
6951 if (start_brace != BRACE_IN_COL0
6952 || !cin_isfuncdecl(&l, curwin->w_cursor.lnum))
6954 /* if the line is terminated with another ','
6955 * it is a continued variable initialization.
6956 * don't add extra indent.
6957 * TODO: does not work, if a function
6958 * declaration is split over multiple lines:
6959 * cin_isfuncdecl returns FALSE then.
6961 if (terminated == ',')
6962 break;
6964 /* if it es a enum declaration or an assignment,
6965 * we are done.
6967 if (terminated != ';' && cin_isinit())
6968 break;
6970 /* nothing useful found */
6971 if (terminated == 0 || terminated == '{')
6972 continue;
6975 if (terminated != ';')
6977 /* Skip parens and braces. Position the cursor
6978 * over the rightmost paren, so that matching it
6979 * will take us back to the start of the line.
6980 */ /* XXX */
6981 trypos = NULL;
6982 if (find_last_paren(l, '(', ')'))
6983 trypos = find_match_paren(ind_maxparen,
6984 ind_maxcomment);
6986 if (trypos == NULL && find_last_paren(l, '{', '}'))
6987 trypos = find_start_brace(ind_maxcomment);
6989 if (trypos != NULL)
6991 curwin->w_cursor.lnum = trypos->lnum + 1;
6992 curwin->w_cursor.col = 0;
6993 continue;
6997 /* it's a variable declaration, add indentation
6998 * like in
6999 * int a,
7000 * b;
7002 if (cont_amount > 0)
7003 amount = cont_amount;
7004 else
7005 amount += ind_continuation;
7007 else if (lookfor == LOOKFOR_UNTERM)
7009 if (cont_amount > 0)
7010 amount = cont_amount;
7011 else
7012 amount += ind_continuation;
7014 else if (lookfor != LOOKFOR_TERM
7015 && lookfor != LOOKFOR_CPP_BASECLASS)
7017 amount = scope_amount;
7018 if (theline[0] == '{')
7019 amount += ind_open_extra;
7021 break;
7025 * If we're in a comment now, skip to the start of the comment.
7026 */ /* XXX */
7027 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7029 curwin->w_cursor.lnum = trypos->lnum + 1;
7030 curwin->w_cursor.col = 0;
7031 continue;
7034 l = ml_get_curline();
7037 * If this is a switch() label, may line up relative to that.
7038 * If this is a C++ scope declaration, do the same.
7040 iscase = cin_iscase(l);
7041 if (iscase || cin_isscopedecl(l))
7043 /* we are only looking for cpp base class
7044 * declaration/initialization any longer */
7045 if (lookfor == LOOKFOR_CPP_BASECLASS)
7046 break;
7048 /* When looking for a "do" we are not interested in
7049 * labels. */
7050 if (whilelevel > 0)
7051 continue;
7054 * case xx:
7055 * c = 99 + <- this indent plus continuation
7056 *-> here;
7058 if (lookfor == LOOKFOR_UNTERM
7059 || lookfor == LOOKFOR_ENUM_OR_INIT)
7061 if (cont_amount > 0)
7062 amount = cont_amount;
7063 else
7064 amount += ind_continuation;
7065 break;
7069 * case xx: <- line up with this case
7070 * x = 333;
7071 * case yy:
7073 if ( (iscase && lookfor == LOOKFOR_CASE)
7074 || (iscase && lookfor_break)
7075 || (!iscase && lookfor == LOOKFOR_SCOPEDECL))
7078 * Check that this case label is not for another
7079 * switch()
7080 */ /* XXX */
7081 if ((trypos = find_start_brace(ind_maxcomment)) ==
7082 NULL || trypos->lnum == ourscope)
7084 amount = get_indent(); /* XXX */
7085 break;
7087 continue;
7090 n = get_indent_nolabel(curwin->w_cursor.lnum); /* XXX */
7093 * case xx: if (cond) <- line up with this if
7094 * y = y + 1;
7095 * -> s = 99;
7097 * case xx:
7098 * if (cond) <- line up with this line
7099 * y = y + 1;
7100 * -> s = 99;
7102 if (lookfor == LOOKFOR_TERM)
7104 if (n)
7105 amount = n;
7107 if (!lookfor_break)
7108 break;
7112 * case xx: x = x + 1; <- line up with this x
7113 * -> y = y + 1;
7115 * case xx: if (cond) <- line up with this if
7116 * -> y = y + 1;
7118 if (n)
7120 amount = n;
7121 l = after_label(ml_get_curline());
7122 if (l != NULL && cin_is_cinword(l))
7124 if (theline[0] == '{')
7125 amount += ind_open_extra;
7126 else
7127 amount += ind_level + ind_no_brace;
7129 break;
7133 * Try to get the indent of a statement before the switch
7134 * label. If nothing is found, line up relative to the
7135 * switch label.
7136 * break; <- may line up with this line
7137 * case xx:
7138 * -> y = 1;
7140 scope_amount = get_indent() + (iscase /* XXX */
7141 ? ind_case_code : ind_scopedecl_code);
7142 lookfor = ind_case_break ? LOOKFOR_NOBREAK : LOOKFOR_ANY;
7143 continue;
7147 * Looking for a switch() label or C++ scope declaration,
7148 * ignore other lines, skip {}-blocks.
7150 if (lookfor == LOOKFOR_CASE || lookfor == LOOKFOR_SCOPEDECL)
7152 if (find_last_paren(l, '{', '}') && (trypos =
7153 find_start_brace(ind_maxcomment)) != NULL)
7155 curwin->w_cursor.lnum = trypos->lnum + 1;
7156 curwin->w_cursor.col = 0;
7158 continue;
7162 * Ignore jump labels with nothing after them.
7164 if (cin_islabel(ind_maxcomment))
7166 l = after_label(ml_get_curline());
7167 if (l == NULL || cin_nocode(l))
7168 continue;
7172 * Ignore #defines, #if, etc.
7173 * Ignore comment and empty lines.
7174 * (need to get the line again, cin_islabel() may have
7175 * unlocked it)
7177 l = ml_get_curline();
7178 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum)
7179 || cin_nocode(l))
7180 continue;
7183 * Are we at the start of a cpp base class declaration or
7184 * constructor initialization?
7185 */ /* XXX */
7186 n = FALSE;
7187 if (lookfor != LOOKFOR_TERM && ind_cpp_baseclass > 0)
7189 n = cin_is_cpp_baseclass(&col);
7190 l = ml_get_curline();
7192 if (n)
7194 if (lookfor == LOOKFOR_UNTERM)
7196 if (cont_amount > 0)
7197 amount = cont_amount;
7198 else
7199 amount += ind_continuation;
7201 else if (theline[0] == '{')
7203 /* Need to find start of the declaration. */
7204 lookfor = LOOKFOR_UNTERM;
7205 ind_continuation = 0;
7206 continue;
7208 else
7209 /* XXX */
7210 amount = get_baseclass_amount(col, ind_maxparen,
7211 ind_maxcomment, ind_cpp_baseclass);
7212 break;
7214 else if (lookfor == LOOKFOR_CPP_BASECLASS)
7216 /* only look, whether there is a cpp base class
7217 * declaration or initialization before the opening brace.
7219 if (cin_isterminated(l, TRUE, FALSE))
7220 break;
7221 else
7222 continue;
7226 * What happens next depends on the line being terminated.
7227 * If terminated with a ',' only consider it terminating if
7228 * there is another unterminated statement behind, eg:
7229 * 123,
7230 * sizeof
7231 * here
7232 * Otherwise check whether it is a enumeration or structure
7233 * initialisation (not indented) or a variable declaration
7234 * (indented).
7236 terminated = cin_isterminated(l, FALSE, TRUE);
7238 if (terminated == 0 || (lookfor != LOOKFOR_UNTERM
7239 && terminated == ','))
7242 * if we're in the middle of a paren thing,
7243 * go back to the line that starts it so
7244 * we can get the right prevailing indent
7245 * if ( foo &&
7246 * bar )
7249 * position the cursor over the rightmost paren, so that
7250 * matching it will take us back to the start of the line.
7252 (void)find_last_paren(l, '(', ')');
7253 trypos = find_match_paren(
7254 corr_ind_maxparen(ind_maxparen, &cur_curpos),
7255 ind_maxcomment);
7258 * If we are looking for ',', we also look for matching
7259 * braces.
7261 if (trypos == NULL && terminated == ','
7262 && find_last_paren(l, '{', '}'))
7263 trypos = find_start_brace(ind_maxcomment);
7265 if (trypos != NULL)
7268 * Check if we are on a case label now. This is
7269 * handled above.
7270 * case xx: if ( asdf &&
7271 * asdf)
7273 curwin->w_cursor = *trypos;
7274 l = ml_get_curline();
7275 if (cin_iscase(l) || cin_isscopedecl(l))
7277 ++curwin->w_cursor.lnum;
7278 curwin->w_cursor.col = 0;
7279 continue;
7284 * Skip over continuation lines to find the one to get the
7285 * indent from
7286 * char *usethis = "bla\
7287 * bla",
7288 * here;
7290 if (terminated == ',')
7292 while (curwin->w_cursor.lnum > 1)
7294 l = ml_get(curwin->w_cursor.lnum - 1);
7295 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7296 break;
7297 --curwin->w_cursor.lnum;
7298 curwin->w_cursor.col = 0;
7303 * Get indent and pointer to text for current line,
7304 * ignoring any jump label. XXX
7306 cur_amount = skip_label(curwin->w_cursor.lnum,
7307 &l, ind_maxcomment);
7310 * If this is just above the line we are indenting, and it
7311 * starts with a '{', line it up with this line.
7312 * while (not)
7313 * -> {
7316 if (terminated != ',' && lookfor != LOOKFOR_TERM
7317 && theline[0] == '{')
7319 amount = cur_amount;
7321 * Only add ind_open_extra when the current line
7322 * doesn't start with a '{', which must have a match
7323 * in the same line (scope is the same). Probably:
7324 * { 1, 2 },
7325 * -> { 3, 4 }
7327 if (*skipwhite(l) != '{')
7328 amount += ind_open_extra;
7330 if (ind_cpp_baseclass)
7332 /* have to look back, whether it is a cpp base
7333 * class declaration or initialization */
7334 lookfor = LOOKFOR_CPP_BASECLASS;
7335 continue;
7337 break;
7341 * Check if we are after an "if", "while", etc.
7342 * Also allow " } else".
7344 if (cin_is_cinword(l) || cin_iselse(skipwhite(l)))
7347 * Found an unterminated line after an if (), line up
7348 * with the last one.
7349 * if (cond)
7350 * 100 +
7351 * -> here;
7353 if (lookfor == LOOKFOR_UNTERM
7354 || lookfor == LOOKFOR_ENUM_OR_INIT)
7356 if (cont_amount > 0)
7357 amount = cont_amount;
7358 else
7359 amount += ind_continuation;
7360 break;
7364 * If this is just above the line we are indenting, we
7365 * are finished.
7366 * while (not)
7367 * -> here;
7368 * Otherwise this indent can be used when the line
7369 * before this is terminated.
7370 * yyy;
7371 * if (stat)
7372 * while (not)
7373 * xxx;
7374 * -> here;
7376 amount = cur_amount;
7377 if (theline[0] == '{')
7378 amount += ind_open_extra;
7379 if (lookfor != LOOKFOR_TERM)
7381 amount += ind_level + ind_no_brace;
7382 break;
7386 * Special trick: when expecting the while () after a
7387 * do, line up with the while()
7388 * do
7389 * x = 1;
7390 * -> here
7392 l = skipwhite(ml_get_curline());
7393 if (cin_isdo(l))
7395 if (whilelevel == 0)
7396 break;
7397 --whilelevel;
7401 * When searching for a terminated line, don't use the
7402 * one between the "if" and the "else".
7403 * Need to use the scope of this "else". XXX
7404 * If whilelevel != 0 continue looking for a "do {".
7406 if (cin_iselse(l)
7407 && whilelevel == 0
7408 && ((trypos = find_start_brace(ind_maxcomment))
7409 == NULL
7410 || find_match(LOOKFOR_IF, trypos->lnum,
7411 ind_maxparen, ind_maxcomment) == FAIL))
7412 break;
7416 * If we're below an unterminated line that is not an
7417 * "if" or something, we may line up with this line or
7418 * add something for a continuation line, depending on
7419 * the line before this one.
7421 else
7424 * Found two unterminated lines on a row, line up with
7425 * the last one.
7426 * c = 99 +
7427 * 100 +
7428 * -> here;
7430 if (lookfor == LOOKFOR_UNTERM)
7432 /* When line ends in a comma add extra indent */
7433 if (terminated == ',')
7434 amount += ind_continuation;
7435 break;
7438 if (lookfor == LOOKFOR_ENUM_OR_INIT)
7440 /* Found two lines ending in ',', lineup with the
7441 * lowest one, but check for cpp base class
7442 * declaration/initialization, if it is an
7443 * opening brace or we are looking just for
7444 * enumerations/initializations. */
7445 if (terminated == ',')
7447 if (ind_cpp_baseclass == 0)
7448 break;
7450 lookfor = LOOKFOR_CPP_BASECLASS;
7451 continue;
7454 /* Ignore unterminated lines in between, but
7455 * reduce indent. */
7456 if (amount > cur_amount)
7457 amount = cur_amount;
7459 else
7462 * Found first unterminated line on a row, may
7463 * line up with this line, remember its indent
7464 * 100 +
7465 * -> here;
7467 amount = cur_amount;
7470 * If previous line ends in ',', check whether we
7471 * are in an initialization or enum
7472 * struct xxx =
7474 * sizeof a,
7475 * 124 };
7476 * or a normal possible continuation line.
7477 * but only, of no other statement has been found
7478 * yet.
7480 if (lookfor == LOOKFOR_INITIAL && terminated == ',')
7482 lookfor = LOOKFOR_ENUM_OR_INIT;
7483 cont_amount = cin_first_id_amount();
7485 else
7487 if (lookfor == LOOKFOR_INITIAL
7488 && *l != NUL
7489 && l[STRLEN(l) - 1] == '\\')
7490 /* XXX */
7491 cont_amount = cin_get_equal_amount(
7492 curwin->w_cursor.lnum);
7493 if (lookfor != LOOKFOR_TERM)
7494 lookfor = LOOKFOR_UNTERM;
7501 * Check if we are after a while (cond);
7502 * If so: Ignore until the matching "do".
7504 /* XXX */
7505 else if (cin_iswhileofdo_end(terminated, ind_maxparen,
7506 ind_maxcomment))
7509 * Found an unterminated line after a while ();, line up
7510 * with the last one.
7511 * while (cond);
7512 * 100 + <- line up with this one
7513 * -> here;
7515 if (lookfor == LOOKFOR_UNTERM
7516 || lookfor == LOOKFOR_ENUM_OR_INIT)
7518 if (cont_amount > 0)
7519 amount = cont_amount;
7520 else
7521 amount += ind_continuation;
7522 break;
7525 if (whilelevel == 0)
7527 lookfor = LOOKFOR_TERM;
7528 amount = get_indent(); /* XXX */
7529 if (theline[0] == '{')
7530 amount += ind_open_extra;
7532 ++whilelevel;
7536 * We are after a "normal" statement.
7537 * If we had another statement we can stop now and use the
7538 * indent of that other statement.
7539 * Otherwise the indent of the current statement may be used,
7540 * search backwards for the next "normal" statement.
7542 else
7545 * Skip single break line, if before a switch label. It
7546 * may be lined up with the case label.
7548 if (lookfor == LOOKFOR_NOBREAK
7549 && cin_isbreak(skipwhite(ml_get_curline())))
7551 lookfor = LOOKFOR_ANY;
7552 continue;
7556 * Handle "do {" line.
7558 if (whilelevel > 0)
7560 l = cin_skipcomment(ml_get_curline());
7561 if (cin_isdo(l))
7563 amount = get_indent(); /* XXX */
7564 --whilelevel;
7565 continue;
7570 * Found a terminated line above an unterminated line. Add
7571 * the amount for a continuation line.
7572 * x = 1;
7573 * y = foo +
7574 * -> here;
7575 * or
7576 * int x = 1;
7577 * int foo,
7578 * -> here;
7580 if (lookfor == LOOKFOR_UNTERM
7581 || lookfor == LOOKFOR_ENUM_OR_INIT)
7583 if (cont_amount > 0)
7584 amount = cont_amount;
7585 else
7586 amount += ind_continuation;
7587 break;
7591 * Found a terminated line above a terminated line or "if"
7592 * etc. line. Use the amount of the line below us.
7593 * x = 1; x = 1;
7594 * if (asdf) y = 2;
7595 * while (asdf) ->here;
7596 * here;
7597 * ->foo;
7599 if (lookfor == LOOKFOR_TERM)
7601 if (!lookfor_break && whilelevel == 0)
7602 break;
7606 * First line above the one we're indenting is terminated.
7607 * To know what needs to be done look further backward for
7608 * a terminated line.
7610 else
7613 * position the cursor over the rightmost paren, so
7614 * that matching it will take us back to the start of
7615 * the line. Helps for:
7616 * func(asdr,
7617 * asdfasdf);
7618 * here;
7620 term_again:
7621 l = ml_get_curline();
7622 if (find_last_paren(l, '(', ')')
7623 && (trypos = find_match_paren(ind_maxparen,
7624 ind_maxcomment)) != NULL)
7627 * Check if we are on a case label now. This is
7628 * handled above.
7629 * case xx: if ( asdf &&
7630 * asdf)
7632 curwin->w_cursor = *trypos;
7633 l = ml_get_curline();
7634 if (cin_iscase(l) || cin_isscopedecl(l))
7636 ++curwin->w_cursor.lnum;
7637 curwin->w_cursor.col = 0;
7638 continue;
7642 /* When aligning with the case statement, don't align
7643 * with a statement after it.
7644 * case 1: { <-- don't use this { position
7645 * stat;
7647 * case 2:
7648 * stat;
7651 iscase = (ind_keep_case_label && cin_iscase(l));
7654 * Get indent and pointer to text for current line,
7655 * ignoring any jump label.
7657 amount = skip_label(curwin->w_cursor.lnum,
7658 &l, ind_maxcomment);
7660 if (theline[0] == '{')
7661 amount += ind_open_extra;
7662 /* See remark above: "Only add ind_open_extra.." */
7663 l = skipwhite(l);
7664 if (*l == '{')
7665 amount -= ind_open_extra;
7666 lookfor = iscase ? LOOKFOR_ANY : LOOKFOR_TERM;
7669 * When a terminated line starts with "else" skip to
7670 * the matching "if":
7671 * else 3;
7672 * indent this;
7673 * Need to use the scope of this "else". XXX
7674 * If whilelevel != 0 continue looking for a "do {".
7676 if (lookfor == LOOKFOR_TERM
7677 && *l != '}'
7678 && cin_iselse(l)
7679 && whilelevel == 0)
7681 if ((trypos = find_start_brace(ind_maxcomment))
7682 == NULL
7683 || find_match(LOOKFOR_IF, trypos->lnum,
7684 ind_maxparen, ind_maxcomment) == FAIL)
7685 break;
7686 continue;
7690 * If we're at the end of a block, skip to the start of
7691 * that block.
7693 curwin->w_cursor.col = 0;
7694 if (*cin_skipcomment(l) == '}'
7695 && (trypos = find_start_brace(ind_maxcomment))
7696 != NULL) /* XXX */
7698 curwin->w_cursor = *trypos;
7699 /* if not "else {" check for terminated again */
7700 /* but skip block for "} else {" */
7701 l = cin_skipcomment(ml_get_curline());
7702 if (*l == '}' || !cin_iselse(l))
7703 goto term_again;
7704 ++curwin->w_cursor.lnum;
7705 curwin->w_cursor.col = 0;
7713 /* add extra indent for a comment */
7714 if (cin_iscomment(theline))
7715 amount += ind_comment;
7719 * ok -- we're not inside any sort of structure at all!
7721 * this means we're at the top level, and everything should
7722 * basically just match where the previous line is, except
7723 * for the lines immediately following a function declaration,
7724 * which are K&R-style parameters and need to be indented.
7726 else
7729 * if our line starts with an open brace, forget about any
7730 * prevailing indent and make sure it looks like the start
7731 * of a function
7734 if (theline[0] == '{')
7736 amount = ind_first_open;
7740 * If the NEXT line is a function declaration, the current
7741 * line needs to be indented as a function type spec.
7742 * Don't do this if the current line looks like a comment or if the
7743 * current line is terminated, ie. ends in ';', or if the current line
7744 * contains { or }: "void f() {\n if (1)"
7746 else if (cur_curpos.lnum < curbuf->b_ml.ml_line_count
7747 && !cin_nocode(theline)
7748 && vim_strchr(theline, '{') == NULL
7749 && vim_strchr(theline, '}') == NULL
7750 && !cin_ends_in(theline, (char_u *)":", NULL)
7751 && !cin_ends_in(theline, (char_u *)",", NULL)
7752 && cin_isfuncdecl(NULL, cur_curpos.lnum + 1)
7753 && !cin_isterminated(theline, FALSE, TRUE))
7755 amount = ind_func_type;
7757 else
7759 amount = 0;
7760 curwin->w_cursor = cur_curpos;
7762 /* search backwards until we find something we recognize */
7764 while (curwin->w_cursor.lnum > 1)
7766 curwin->w_cursor.lnum--;
7767 curwin->w_cursor.col = 0;
7769 l = ml_get_curline();
7772 * If we're in a comment now, skip to the start of the comment.
7773 */ /* XXX */
7774 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7776 curwin->w_cursor.lnum = trypos->lnum + 1;
7777 curwin->w_cursor.col = 0;
7778 continue;
7782 * Are we at the start of a cpp base class declaration or
7783 * constructor initialization?
7784 */ /* XXX */
7785 n = FALSE;
7786 if (ind_cpp_baseclass != 0 && theline[0] != '{')
7788 n = cin_is_cpp_baseclass(&col);
7789 l = ml_get_curline();
7791 if (n)
7793 /* XXX */
7794 amount = get_baseclass_amount(col, ind_maxparen,
7795 ind_maxcomment, ind_cpp_baseclass);
7796 break;
7800 * Skip preprocessor directives and blank lines.
7802 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
7803 continue;
7805 if (cin_nocode(l))
7806 continue;
7809 * If the previous line ends in ',', use one level of
7810 * indentation:
7811 * int foo,
7812 * bar;
7813 * do this before checking for '}' in case of eg.
7814 * enum foobar
7816 * ...
7817 * } foo,
7818 * bar;
7820 n = 0;
7821 if (cin_ends_in(l, (char_u *)",", NULL)
7822 || (*l != NUL && (n = l[STRLEN(l) - 1]) == '\\'))
7824 /* take us back to opening paren */
7825 if (find_last_paren(l, '(', ')')
7826 && (trypos = find_match_paren(ind_maxparen,
7827 ind_maxcomment)) != NULL)
7828 curwin->w_cursor = *trypos;
7830 /* For a line ending in ',' that is a continuation line go
7831 * back to the first line with a backslash:
7832 * char *foo = "bla\
7833 * bla",
7834 * here;
7836 while (n == 0 && curwin->w_cursor.lnum > 1)
7838 l = ml_get(curwin->w_cursor.lnum - 1);
7839 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7840 break;
7841 --curwin->w_cursor.lnum;
7842 curwin->w_cursor.col = 0;
7845 amount = get_indent(); /* XXX */
7847 if (amount == 0)
7848 amount = cin_first_id_amount();
7849 if (amount == 0)
7850 amount = ind_continuation;
7851 break;
7855 * If the line looks like a function declaration, and we're
7856 * not in a comment, put it the left margin.
7858 if (cin_isfuncdecl(NULL, cur_curpos.lnum)) /* XXX */
7859 break;
7860 l = ml_get_curline();
7863 * Finding the closing '}' of a previous function. Put
7864 * current line at the left margin. For when 'cino' has "fs".
7866 if (*skipwhite(l) == '}')
7867 break;
7869 /* (matching {)
7870 * If the previous line ends on '};' (maybe followed by
7871 * comments) align at column 0. For example:
7872 * char *string_array[] = { "foo",
7873 * / * x * / "b};ar" }; / * foobar * /
7875 if (cin_ends_in(l, (char_u *)"};", NULL))
7876 break;
7879 * If the PREVIOUS line is a function declaration, the current
7880 * line (and the ones that follow) needs to be indented as
7881 * parameters.
7883 if (cin_isfuncdecl(&l, curwin->w_cursor.lnum))
7885 amount = ind_param;
7886 break;
7890 * If the previous line ends in ';' and the line before the
7891 * previous line ends in ',' or '\', ident to column zero:
7892 * int foo,
7893 * bar;
7894 * indent_to_0 here;
7896 if (cin_ends_in(l, (char_u *)";", NULL))
7898 l = ml_get(curwin->w_cursor.lnum - 1);
7899 if (cin_ends_in(l, (char_u *)",", NULL)
7900 || (*l != NUL && l[STRLEN(l) - 1] == '\\'))
7901 break;
7902 l = ml_get_curline();
7906 * Doesn't look like anything interesting -- so just
7907 * use the indent of this line.
7909 * Position the cursor over the rightmost paren, so that
7910 * matching it will take us back to the start of the line.
7912 find_last_paren(l, '(', ')');
7914 if ((trypos = find_match_paren(ind_maxparen,
7915 ind_maxcomment)) != NULL)
7916 curwin->w_cursor = *trypos;
7917 amount = get_indent(); /* XXX */
7918 break;
7921 /* add extra indent for a comment */
7922 if (cin_iscomment(theline))
7923 amount += ind_comment;
7925 /* add extra indent if the previous line ended in a backslash:
7926 * "asdfasdf\
7927 * here";
7928 * char *foo = "asdf\
7929 * here";
7931 if (cur_curpos.lnum > 1)
7933 l = ml_get(cur_curpos.lnum - 1);
7934 if (*l != NUL && l[STRLEN(l) - 1] == '\\')
7936 cur_amount = cin_get_equal_amount(cur_curpos.lnum - 1);
7937 if (cur_amount > 0)
7938 amount = cur_amount;
7939 else if (cur_amount == 0)
7940 amount += ind_continuation;
7946 theend:
7947 /* put the cursor back where it belongs */
7948 curwin->w_cursor = cur_curpos;
7950 vim_free(linecopy);
7952 if (amount < 0)
7953 return 0;
7954 return amount;
7957 static int
7958 find_match(lookfor, ourscope, ind_maxparen, ind_maxcomment)
7959 int lookfor;
7960 linenr_T ourscope;
7961 int ind_maxparen;
7962 int ind_maxcomment;
7964 char_u *look;
7965 pos_T *theirscope;
7966 char_u *mightbeif;
7967 int elselevel;
7968 int whilelevel;
7970 if (lookfor == LOOKFOR_IF)
7972 elselevel = 1;
7973 whilelevel = 0;
7975 else
7977 elselevel = 0;
7978 whilelevel = 1;
7981 curwin->w_cursor.col = 0;
7983 while (curwin->w_cursor.lnum > ourscope + 1)
7985 curwin->w_cursor.lnum--;
7986 curwin->w_cursor.col = 0;
7988 look = cin_skipcomment(ml_get_curline());
7989 if (cin_iselse(look)
7990 || cin_isif(look)
7991 || cin_isdo(look) /* XXX */
7992 || cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7995 * if we've gone outside the braces entirely,
7996 * we must be out of scope...
7998 theirscope = find_start_brace(ind_maxcomment); /* XXX */
7999 if (theirscope == NULL)
8000 break;
8003 * and if the brace enclosing this is further
8004 * back than the one enclosing the else, we're
8005 * out of luck too.
8007 if (theirscope->lnum < ourscope)
8008 break;
8011 * and if they're enclosed in a *deeper* brace,
8012 * then we can ignore it because it's in a
8013 * different scope...
8015 if (theirscope->lnum > ourscope)
8016 continue;
8019 * if it was an "else" (that's not an "else if")
8020 * then we need to go back to another if, so
8021 * increment elselevel
8023 look = cin_skipcomment(ml_get_curline());
8024 if (cin_iselse(look))
8026 mightbeif = cin_skipcomment(look + 4);
8027 if (!cin_isif(mightbeif))
8028 ++elselevel;
8029 continue;
8033 * if it was a "while" then we need to go back to
8034 * another "do", so increment whilelevel. XXX
8036 if (cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
8038 ++whilelevel;
8039 continue;
8042 /* If it's an "if" decrement elselevel */
8043 look = cin_skipcomment(ml_get_curline());
8044 if (cin_isif(look))
8046 elselevel--;
8048 * When looking for an "if" ignore "while"s that
8049 * get in the way.
8051 if (elselevel == 0 && lookfor == LOOKFOR_IF)
8052 whilelevel = 0;
8055 /* If it's a "do" decrement whilelevel */
8056 if (cin_isdo(look))
8057 whilelevel--;
8060 * if we've used up all the elses, then
8061 * this must be the if that we want!
8062 * match the indent level of that if.
8064 if (elselevel <= 0 && whilelevel <= 0)
8066 return OK;
8070 return FAIL;
8073 # if defined(FEAT_EVAL) || defined(PROTO)
8075 * Get indent level from 'indentexpr'.
8078 get_expr_indent()
8080 int indent;
8081 pos_T pos;
8082 int save_State;
8083 int use_sandbox = was_set_insecurely((char_u *)"indentexpr",
8084 OPT_LOCAL);
8086 pos = curwin->w_cursor;
8087 set_vim_var_nr(VV_LNUM, curwin->w_cursor.lnum);
8088 if (use_sandbox)
8089 ++sandbox;
8090 ++textlock;
8091 indent = eval_to_number(curbuf->b_p_inde);
8092 if (use_sandbox)
8093 --sandbox;
8094 --textlock;
8096 /* Restore the cursor position so that 'indentexpr' doesn't need to.
8097 * Pretend to be in Insert mode, allow cursor past end of line for "o"
8098 * command. */
8099 save_State = State;
8100 State = INSERT;
8101 curwin->w_cursor = pos;
8102 check_cursor();
8103 State = save_State;
8105 /* If there is an error, just keep the current indent. */
8106 if (indent < 0)
8107 indent = get_indent();
8109 return indent;
8111 # endif
8113 #endif /* FEAT_CINDENT */
8115 #if defined(FEAT_LISP) || defined(PROTO)
8117 static int lisp_match __ARGS((char_u *p));
8119 static int
8120 lisp_match(p)
8121 char_u *p;
8123 char_u buf[LSIZE];
8124 int len;
8125 char_u *word = p_lispwords;
8127 while (*word != NUL)
8129 (void)copy_option_part(&word, buf, LSIZE, ",");
8130 len = (int)STRLEN(buf);
8131 if (STRNCMP(buf, p, len) == 0 && p[len] == ' ')
8132 return TRUE;
8134 return FALSE;
8138 * When 'p' is present in 'cpoptions, a Vi compatible method is used.
8139 * The incompatible newer method is quite a bit better at indenting
8140 * code in lisp-like languages than the traditional one; it's still
8141 * mostly heuristics however -- Dirk van Deun, dirk@rave.org
8143 * TODO:
8144 * Findmatch() should be adapted for lisp, also to make showmatch
8145 * work correctly: now (v5.3) it seems all C/C++ oriented:
8146 * - it does not recognize the #\( and #\) notations as character literals
8147 * - it doesn't know about comments starting with a semicolon
8148 * - it incorrectly interprets '(' as a character literal
8149 * All this messes up get_lisp_indent in some rare cases.
8150 * Update from Sergey Khorev:
8151 * I tried to fix the first two issues.
8154 get_lisp_indent()
8156 pos_T *pos, realpos, paren;
8157 int amount;
8158 char_u *that;
8159 colnr_T col;
8160 colnr_T firsttry;
8161 int parencount, quotecount;
8162 int vi_lisp;
8164 /* Set vi_lisp to use the vi-compatible method */
8165 vi_lisp = (vim_strchr(p_cpo, CPO_LISP) != NULL);
8167 realpos = curwin->w_cursor;
8168 curwin->w_cursor.col = 0;
8170 if ((pos = findmatch(NULL, '(')) == NULL)
8171 pos = findmatch(NULL, '[');
8172 else
8174 paren = *pos;
8175 pos = findmatch(NULL, '[');
8176 if (pos == NULL || ltp(pos, &paren))
8177 pos = &paren;
8179 if (pos != NULL)
8181 /* Extra trick: Take the indent of the first previous non-white
8182 * line that is at the same () level. */
8183 amount = -1;
8184 parencount = 0;
8186 while (--curwin->w_cursor.lnum >= pos->lnum)
8188 if (linewhite(curwin->w_cursor.lnum))
8189 continue;
8190 for (that = ml_get_curline(); *that != NUL; ++that)
8192 if (*that == ';')
8194 while (*(that + 1) != NUL)
8195 ++that;
8196 continue;
8198 if (*that == '\\')
8200 if (*(that + 1) != NUL)
8201 ++that;
8202 continue;
8204 if (*that == '"' && *(that + 1) != NUL)
8206 while (*++that && *that != '"')
8208 /* skipping escaped characters in the string */
8209 if (*that == '\\')
8211 if (*++that == NUL)
8212 break;
8213 if (that[1] == NUL)
8215 ++that;
8216 break;
8221 if (*that == '(' || *that == '[')
8222 ++parencount;
8223 else if (*that == ')' || *that == ']')
8224 --parencount;
8226 if (parencount == 0)
8228 amount = get_indent();
8229 break;
8233 if (amount == -1)
8235 curwin->w_cursor.lnum = pos->lnum;
8236 curwin->w_cursor.col = pos->col;
8237 col = pos->col;
8239 that = ml_get_curline();
8241 if (vi_lisp && get_indent() == 0)
8242 amount = 2;
8243 else
8245 amount = 0;
8246 while (*that && col)
8248 amount += lbr_chartabsize_adv(&that, (colnr_T)amount);
8249 col--;
8253 * Some keywords require "body" indenting rules (the
8254 * non-standard-lisp ones are Scheme special forms):
8256 * (let ((a 1)) instead (let ((a 1))
8257 * (...)) of (...))
8260 if (!vi_lisp && (*that == '(' || *that == '[')
8261 && lisp_match(that + 1))
8262 amount += 2;
8263 else
8265 that++;
8266 amount++;
8267 firsttry = amount;
8269 while (vim_iswhite(*that))
8271 amount += lbr_chartabsize(that, (colnr_T)amount);
8272 ++that;
8275 if (*that && *that != ';') /* not a comment line */
8277 /* test *that != '(' to accommodate first let/do
8278 * argument if it is more than one line */
8279 if (!vi_lisp && *that != '(' && *that != '[')
8280 firsttry++;
8282 parencount = 0;
8283 quotecount = 0;
8285 if (vi_lisp
8286 || (*that != '"'
8287 && *that != '\''
8288 && *that != '#'
8289 && (*that < '0' || *that > '9')))
8291 while (*that
8292 && (!vim_iswhite(*that)
8293 || quotecount
8294 || parencount)
8295 && (!((*that == '(' || *that == '[')
8296 && !quotecount
8297 && !parencount
8298 && vi_lisp)))
8300 if (*that == '"')
8301 quotecount = !quotecount;
8302 if ((*that == '(' || *that == '[')
8303 && !quotecount)
8304 ++parencount;
8305 if ((*that == ')' || *that == ']')
8306 && !quotecount)
8307 --parencount;
8308 if (*that == '\\' && *(that+1) != NUL)
8309 amount += lbr_chartabsize_adv(&that,
8310 (colnr_T)amount);
8311 amount += lbr_chartabsize_adv(&that,
8312 (colnr_T)amount);
8315 while (vim_iswhite(*that))
8317 amount += lbr_chartabsize(that, (colnr_T)amount);
8318 that++;
8320 if (!*that || *that == ';')
8321 amount = firsttry;
8327 else
8328 amount = 0; /* no matching '(' or '[' found, use zero indent */
8330 curwin->w_cursor = realpos;
8332 return amount;
8334 #endif /* FEAT_LISP */
8336 void
8337 prepare_to_exit()
8339 #if defined(SIGHUP) && defined(SIG_IGN)
8340 /* Ignore SIGHUP, because a dropped connection causes a read error, which
8341 * makes Vim exit and then handling SIGHUP causes various reentrance
8342 * problems. */
8343 signal(SIGHUP, SIG_IGN);
8344 #endif
8346 #ifdef FEAT_GUI
8347 if (gui.in_use)
8349 gui.dying = TRUE;
8350 out_trash(); /* trash any pending output */
8352 else
8353 #endif
8355 windgoto((int)Rows - 1, 0);
8358 * Switch terminal mode back now, so messages end up on the "normal"
8359 * screen (if there are two screens).
8361 settmode(TMODE_COOK);
8362 #ifdef WIN3264
8363 if (can_end_termcap_mode(FALSE) == TRUE)
8364 #endif
8365 stoptermcap();
8366 out_flush();
8371 * Preserve files and exit.
8372 * When called IObuff must contain a message.
8374 void
8375 preserve_exit()
8377 buf_T *buf;
8379 prepare_to_exit();
8381 /* Setting this will prevent free() calls. That avoids calling free()
8382 * recursively when free() was invoked with a bad pointer. */
8383 really_exiting = TRUE;
8385 out_str(IObuff);
8386 screen_start(); /* don't know where cursor is now */
8387 out_flush();
8389 ml_close_notmod(); /* close all not-modified buffers */
8391 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8393 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
8395 OUT_STR(_("Vim: preserving files...\n"));
8396 screen_start(); /* don't know where cursor is now */
8397 out_flush();
8398 ml_sync_all(FALSE, FALSE); /* preserve all swap files */
8399 break;
8403 ml_close_all(FALSE); /* close all memfiles, without deleting */
8405 OUT_STR(_("Vim: Finished.\n"));
8407 getout(1);
8411 * return TRUE if "fname" exists.
8414 vim_fexists(fname)
8415 char_u *fname;
8417 struct stat st;
8419 if (mch_stat((char *)fname, &st))
8420 return FALSE;
8421 return TRUE;
8425 * Check for CTRL-C pressed, but only once in a while.
8426 * Should be used instead of ui_breakcheck() for functions that check for
8427 * each line in the file. Calling ui_breakcheck() each time takes too much
8428 * time, because it can be a system call.
8431 #ifndef BREAKCHECK_SKIP
8432 # ifdef FEAT_GUI /* assume the GUI only runs on fast computers */
8433 # define BREAKCHECK_SKIP 200
8434 # else
8435 # define BREAKCHECK_SKIP 32
8436 # endif
8437 #endif
8439 static int breakcheck_count = 0;
8441 void
8442 line_breakcheck()
8444 if (++breakcheck_count >= BREAKCHECK_SKIP)
8446 breakcheck_count = 0;
8447 ui_breakcheck();
8452 * Like line_breakcheck() but check 10 times less often.
8454 void
8455 fast_breakcheck()
8457 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
8459 breakcheck_count = 0;
8460 ui_breakcheck();
8465 * Invoke expand_wildcards() for one pattern.
8466 * Expand items like "%:h" before the expansion.
8467 * Returns OK or FAIL.
8470 expand_wildcards_eval(pat, num_file, file, flags)
8471 char_u **pat; /* pointer to input pattern */
8472 int *num_file; /* resulting number of files */
8473 char_u ***file; /* array of resulting files */
8474 int flags; /* EW_DIR, etc. */
8476 int ret = FAIL;
8477 char_u *eval_pat = NULL;
8478 char_u *exp_pat = *pat;
8479 char_u *ignored_msg;
8480 int usedlen;
8482 if (*exp_pat == '%' || *exp_pat == '#' || *exp_pat == '<')
8484 ++emsg_off;
8485 eval_pat = eval_vars(exp_pat, exp_pat, &usedlen,
8486 NULL, &ignored_msg, NULL);
8487 --emsg_off;
8488 if (eval_pat != NULL)
8489 exp_pat = concat_str(eval_pat, exp_pat + usedlen);
8492 if (exp_pat != NULL)
8493 ret = expand_wildcards(1, &exp_pat, num_file, file, flags);
8495 if (eval_pat != NULL)
8497 vim_free(exp_pat);
8498 vim_free(eval_pat);
8501 return ret;
8505 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
8506 * 'wildignore'.
8507 * Returns OK or FAIL.
8510 expand_wildcards(num_pat, pat, num_file, file, flags)
8511 int num_pat; /* number of input patterns */
8512 char_u **pat; /* array of input patterns */
8513 int *num_file; /* resulting number of files */
8514 char_u ***file; /* array of resulting files */
8515 int flags; /* EW_DIR, etc. */
8517 int retval;
8518 int i, j;
8519 char_u *p;
8520 int non_suf_match; /* number without matching suffix */
8522 retval = gen_expand_wildcards(num_pat, pat, num_file, file, flags);
8524 /* When keeping all matches, return here */
8525 if (flags & EW_KEEPALL)
8526 return retval;
8528 #ifdef FEAT_WILDIGN
8530 * Remove names that match 'wildignore'.
8532 if (*p_wig)
8534 char_u *ffname;
8536 /* check all files in (*file)[] */
8537 for (i = 0; i < *num_file; ++i)
8539 ffname = FullName_save((*file)[i], FALSE);
8540 if (ffname == NULL) /* out of memory */
8541 break;
8542 # ifdef VMS
8543 vms_remove_version(ffname);
8544 # endif
8545 if (match_file_list(p_wig, (*file)[i], ffname))
8547 /* remove this matching file from the list */
8548 vim_free((*file)[i]);
8549 for (j = i; j + 1 < *num_file; ++j)
8550 (*file)[j] = (*file)[j + 1];
8551 --*num_file;
8552 --i;
8554 vim_free(ffname);
8557 #endif
8560 * Move the names where 'suffixes' match to the end.
8562 if (*num_file > 1)
8564 non_suf_match = 0;
8565 for (i = 0; i < *num_file; ++i)
8567 if (!match_suffix((*file)[i]))
8570 * Move the name without matching suffix to the front
8571 * of the list.
8573 p = (*file)[i];
8574 for (j = i; j > non_suf_match; --j)
8575 (*file)[j] = (*file)[j - 1];
8576 (*file)[non_suf_match++] = p;
8581 return retval;
8585 * Return TRUE if "fname" matches with an entry in 'suffixes'.
8588 match_suffix(fname)
8589 char_u *fname;
8591 int fnamelen, setsuflen;
8592 char_u *setsuf;
8593 #define MAXSUFLEN 30 /* maximum length of a file suffix */
8594 char_u suf_buf[MAXSUFLEN];
8596 fnamelen = (int)STRLEN(fname);
8597 setsuflen = 0;
8598 for (setsuf = p_su; *setsuf; )
8600 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
8601 if (setsuflen == 0)
8603 char_u *tail = gettail(fname);
8605 /* empty entry: match name without a '.' */
8606 if (vim_strchr(tail, '.') == NULL)
8608 setsuflen = 1;
8609 break;
8612 else
8614 if (fnamelen >= setsuflen
8615 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
8616 (size_t)setsuflen) == 0)
8617 break;
8618 setsuflen = 0;
8621 return (setsuflen != 0);
8624 #if !defined(NO_EXPANDPATH) || defined(PROTO)
8626 # ifdef VIM_BACKTICK
8627 static int vim_backtick __ARGS((char_u *p));
8628 static int expand_backtick __ARGS((garray_T *gap, char_u *pat, int flags));
8629 # endif
8631 # if defined(MSDOS) || defined(FEAT_GUI_W16) || defined(WIN3264)
8633 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
8634 * it's shared between these systems.
8636 # if defined(DJGPP) || defined(PROTO)
8637 # define _cdecl /* DJGPP doesn't have this */
8638 # else
8639 # ifdef __BORLANDC__
8640 # define _cdecl _RTLENTRYF
8641 # endif
8642 # endif
8645 * comparison function for qsort in dos_expandpath()
8647 static int _cdecl
8648 pstrcmp(const void *a, const void *b)
8650 return (pathcmp(*(char **)a, *(char **)b, -1));
8653 # ifndef WIN3264
8654 static void
8655 namelowcpy(
8656 char_u *d,
8657 char_u *s)
8659 # ifdef DJGPP
8660 if (USE_LONG_FNAME) /* don't lower case on Windows 95/NT systems */
8661 while (*s)
8662 *d++ = *s++;
8663 else
8664 # endif
8665 while (*s)
8666 *d++ = TOLOWER_LOC(*s++);
8667 *d = NUL;
8669 # endif
8672 * Recursively expand one path component into all matching files and/or
8673 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8674 * Return the number of matches found.
8675 * "path" has backslashes before chars that are not to be expanded, starting
8676 * at "path[wildoff]".
8677 * Return the number of matches found.
8678 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
8680 static int
8681 dos_expandpath(
8682 garray_T *gap,
8683 char_u *path,
8684 int wildoff,
8685 int flags, /* EW_* flags */
8686 int didstar) /* expanded "**" once already */
8688 char_u *buf;
8689 char_u *path_end;
8690 char_u *p, *s, *e;
8691 int start_len = gap->ga_len;
8692 char_u *pat;
8693 regmatch_T regmatch;
8694 int starts_with_dot;
8695 int matches;
8696 int len;
8697 int starstar = FALSE;
8698 static int stardepth = 0; /* depth for "**" expansion */
8699 #ifdef WIN3264
8700 WIN32_FIND_DATA fb;
8701 HANDLE hFind = (HANDLE)0;
8702 # ifdef FEAT_MBYTE
8703 WIN32_FIND_DATAW wfb;
8704 WCHAR *wn = NULL; /* UCS-2 name, NULL when not used. */
8705 # endif
8706 #else
8707 struct ffblk fb;
8708 #endif
8709 char_u *matchname;
8710 int ok;
8712 /* Expanding "**" may take a long time, check for CTRL-C. */
8713 if (stardepth > 0)
8715 ui_breakcheck();
8716 if (got_int)
8717 return 0;
8720 /* make room for file name */
8721 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8722 if (buf == NULL)
8723 return 0;
8726 * Find the first part in the path name that contains a wildcard or a ~1.
8727 * Copy it into buf, including the preceding characters.
8729 p = buf;
8730 s = buf;
8731 e = NULL;
8732 path_end = path;
8733 while (*path_end != NUL)
8735 /* May ignore a wildcard that has a backslash before it; it will
8736 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8737 if (path_end >= path + wildoff && rem_backslash(path_end))
8738 *p++ = *path_end++;
8739 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
8741 if (e != NULL)
8742 break;
8743 s = p + 1;
8745 else if (path_end >= path + wildoff
8746 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
8747 e = p;
8748 #ifdef FEAT_MBYTE
8749 if (has_mbyte)
8751 len = (*mb_ptr2len)(path_end);
8752 STRNCPY(p, path_end, len);
8753 p += len;
8754 path_end += len;
8756 else
8757 #endif
8758 *p++ = *path_end++;
8760 e = p;
8761 *e = NUL;
8763 /* now we have one wildcard component between s and e */
8764 /* Remove backslashes between "wildoff" and the start of the wildcard
8765 * component. */
8766 for (p = buf + wildoff; p < s; ++p)
8767 if (rem_backslash(p))
8769 STRMOVE(p, p + 1);
8770 --e;
8771 --s;
8774 /* Check for "**" between "s" and "e". */
8775 for (p = s; p < e; ++p)
8776 if (p[0] == '*' && p[1] == '*')
8777 starstar = TRUE;
8779 starts_with_dot = (*s == '.');
8780 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8781 if (pat == NULL)
8783 vim_free(buf);
8784 return 0;
8787 /* compile the regexp into a program */
8788 regmatch.rm_ic = TRUE; /* Always ignore case */
8789 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8790 vim_free(pat);
8792 if (regmatch.regprog == NULL)
8794 vim_free(buf);
8795 return 0;
8798 /* remember the pattern or file name being looked for */
8799 matchname = vim_strsave(s);
8801 /* If "**" is by itself, this is the first time we encounter it and more
8802 * is following then find matches without any directory. */
8803 if (!didstar && stardepth < 100 && starstar && e - s == 2
8804 && *path_end == '/')
8806 STRCPY(s, path_end + 1);
8807 ++stardepth;
8808 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8809 --stardepth;
8812 /* Scan all files in the directory with "dir/ *.*" */
8813 STRCPY(s, "*.*");
8814 #ifdef WIN3264
8815 # ifdef FEAT_MBYTE
8816 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
8818 /* The active codepage differs from 'encoding'. Attempt using the
8819 * wide function. If it fails because it is not implemented fall back
8820 * to the non-wide version (for Windows 98) */
8821 wn = enc_to_utf16(buf, NULL);
8822 if (wn != NULL)
8824 hFind = FindFirstFileW(wn, &wfb);
8825 if (hFind == INVALID_HANDLE_VALUE
8826 && GetLastError() == ERROR_CALL_NOT_IMPLEMENTED)
8828 vim_free(wn);
8829 wn = NULL;
8834 if (wn == NULL)
8835 # endif
8836 hFind = FindFirstFile(buf, &fb);
8837 ok = (hFind != INVALID_HANDLE_VALUE);
8838 #else
8839 /* If we are expanding wildcards we try both files and directories */
8840 ok = (findfirst((char *)buf, &fb,
8841 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8842 #endif
8844 while (ok)
8846 #ifdef WIN3264
8847 # ifdef FEAT_MBYTE
8848 if (wn != NULL)
8849 p = utf16_to_enc(wfb.cFileName, NULL); /* p is allocated here */
8850 else
8851 # endif
8852 p = (char_u *)fb.cFileName;
8853 #else
8854 p = (char_u *)fb.ff_name;
8855 #endif
8856 /* Ignore entries starting with a dot, unless when asked for. Accept
8857 * all entries found with "matchname". */
8858 if ((p[0] != '.' || starts_with_dot)
8859 && (matchname == NULL
8860 || vim_regexec(&regmatch, p, (colnr_T)0)))
8862 #ifdef WIN3264
8863 STRCPY(s, p);
8864 #else
8865 namelowcpy(s, p);
8866 #endif
8867 len = (int)STRLEN(buf);
8869 if (starstar && stardepth < 100)
8871 /* For "**" in the pattern first go deeper in the tree to
8872 * find matches. */
8873 STRCPY(buf + len, "/**");
8874 STRCPY(buf + len + 3, path_end);
8875 ++stardepth;
8876 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
8877 --stardepth;
8880 STRCPY(buf + len, path_end);
8881 if (mch_has_exp_wildcard(path_end))
8883 /* need to expand another component of the path */
8884 /* remove backslashes for the remaining components only */
8885 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
8887 else
8889 /* no more wildcards, check if there is a match */
8890 /* remove backslashes for the remaining components only */
8891 if (*path_end != 0)
8892 backslash_halve(buf + len + 1);
8893 if (mch_getperm(buf) >= 0) /* add existing file */
8894 addfile(gap, buf, flags);
8898 #ifdef WIN3264
8899 # ifdef FEAT_MBYTE
8900 if (wn != NULL)
8902 vim_free(p);
8903 ok = FindNextFileW(hFind, &wfb);
8905 else
8906 # endif
8907 ok = FindNextFile(hFind, &fb);
8908 #else
8909 ok = (findnext(&fb) == 0);
8910 #endif
8912 /* If no more matches and no match was used, try expanding the name
8913 * itself. Finds the long name of a short filename. */
8914 if (!ok && matchname != NULL && gap->ga_len == start_len)
8916 STRCPY(s, matchname);
8917 #ifdef WIN3264
8918 FindClose(hFind);
8919 # ifdef FEAT_MBYTE
8920 if (wn != NULL)
8922 vim_free(wn);
8923 wn = enc_to_utf16(buf, NULL);
8924 if (wn != NULL)
8925 hFind = FindFirstFileW(wn, &wfb);
8927 if (wn == NULL)
8928 # endif
8929 hFind = FindFirstFile(buf, &fb);
8930 ok = (hFind != INVALID_HANDLE_VALUE);
8931 #else
8932 ok = (findfirst((char *)buf, &fb,
8933 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8934 #endif
8935 vim_free(matchname);
8936 matchname = NULL;
8940 #ifdef WIN3264
8941 FindClose(hFind);
8942 # ifdef FEAT_MBYTE
8943 vim_free(wn);
8944 # endif
8945 #endif
8946 vim_free(buf);
8947 vim_free(regmatch.regprog);
8948 vim_free(matchname);
8950 matches = gap->ga_len - start_len;
8951 if (matches > 0)
8952 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
8953 sizeof(char_u *), pstrcmp);
8954 return matches;
8958 mch_expandpath(
8959 garray_T *gap,
8960 char_u *path,
8961 int flags) /* EW_* flags */
8963 return dos_expandpath(gap, path, 0, flags, FALSE);
8965 # endif /* MSDOS || FEAT_GUI_W16 || WIN3264 */
8967 #if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
8968 || defined(PROTO)
8970 * Unix style wildcard expansion code.
8971 * It's here because it's used both for Unix and Mac.
8973 static int pstrcmp __ARGS((const void *, const void *));
8975 static int
8976 pstrcmp(a, b)
8977 const void *a, *b;
8979 return (pathcmp(*(char **)a, *(char **)b, -1));
8983 * Recursively expand one path component into all matching files and/or
8984 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8985 * "path" has backslashes before chars that are not to be expanded, starting
8986 * at "path + wildoff".
8987 * Return the number of matches found.
8988 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
8991 unix_expandpath(gap, path, wildoff, flags, didstar)
8992 garray_T *gap;
8993 char_u *path;
8994 int wildoff;
8995 int flags; /* EW_* flags */
8996 int didstar; /* expanded "**" once already */
8998 char_u *buf;
8999 char_u *path_end;
9000 char_u *p, *s, *e;
9001 int start_len = gap->ga_len;
9002 char_u *pat;
9003 regmatch_T regmatch;
9004 int starts_with_dot;
9005 int matches;
9006 int len;
9007 int starstar = FALSE;
9008 static int stardepth = 0; /* depth for "**" expansion */
9010 DIR *dirp;
9011 struct dirent *dp;
9013 /* Expanding "**" may take a long time, check for CTRL-C. */
9014 if (stardepth > 0)
9016 ui_breakcheck();
9017 if (got_int)
9018 return 0;
9021 /* make room for file name */
9022 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
9023 if (buf == NULL)
9024 return 0;
9027 * Find the first part in the path name that contains a wildcard.
9028 * Copy it into "buf", including the preceding characters.
9030 p = buf;
9031 s = buf;
9032 e = NULL;
9033 path_end = path;
9034 while (*path_end != NUL)
9036 /* May ignore a wildcard that has a backslash before it; it will
9037 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
9038 if (path_end >= path + wildoff && rem_backslash(path_end))
9039 *p++ = *path_end++;
9040 else if (*path_end == '/')
9042 if (e != NULL)
9043 break;
9044 s = p + 1;
9046 else if (path_end >= path + wildoff
9047 && vim_strchr((char_u *)"*?[{~$", *path_end) != NULL)
9048 e = p;
9049 #ifdef FEAT_MBYTE
9050 if (has_mbyte)
9052 len = (*mb_ptr2len)(path_end);
9053 STRNCPY(p, path_end, len);
9054 p += len;
9055 path_end += len;
9057 else
9058 #endif
9059 *p++ = *path_end++;
9061 e = p;
9062 *e = NUL;
9064 /* now we have one wildcard component between "s" and "e" */
9065 /* Remove backslashes between "wildoff" and the start of the wildcard
9066 * component. */
9067 for (p = buf + wildoff; p < s; ++p)
9068 if (rem_backslash(p))
9070 STRMOVE(p, p + 1);
9071 --e;
9072 --s;
9075 /* Check for "**" between "s" and "e". */
9076 for (p = s; p < e; ++p)
9077 if (p[0] == '*' && p[1] == '*')
9078 starstar = TRUE;
9080 /* convert the file pattern to a regexp pattern */
9081 starts_with_dot = (*s == '.');
9082 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
9083 if (pat == NULL)
9085 vim_free(buf);
9086 return 0;
9089 /* compile the regexp into a program */
9090 #ifdef CASE_INSENSITIVE_FILENAME
9091 regmatch.rm_ic = TRUE; /* Behave like Terminal.app */
9092 #else
9093 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9094 #endif
9095 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
9096 vim_free(pat);
9098 if (regmatch.regprog == NULL)
9100 vim_free(buf);
9101 return 0;
9104 /* If "**" is by itself, this is the first time we encounter it and more
9105 * is following then find matches without any directory. */
9106 if (!didstar && stardepth < 100 && starstar && e - s == 2
9107 && *path_end == '/')
9109 STRCPY(s, path_end + 1);
9110 ++stardepth;
9111 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
9112 --stardepth;
9115 /* open the directory for scanning */
9116 *s = NUL;
9117 dirp = opendir(*buf == NUL ? "." : (char *)buf);
9119 /* Find all matching entries */
9120 if (dirp != NULL)
9122 for (;;)
9124 dp = readdir(dirp);
9125 if (dp == NULL)
9126 break;
9127 if ((dp->d_name[0] != '.' || starts_with_dot)
9128 && vim_regexec(&regmatch, (char_u *)dp->d_name, (colnr_T)0))
9130 STRCPY(s, dp->d_name);
9131 len = STRLEN(buf);
9133 if (starstar && stardepth < 100)
9135 /* For "**" in the pattern first go deeper in the tree to
9136 * find matches. */
9137 STRCPY(buf + len, "/**");
9138 STRCPY(buf + len + 3, path_end);
9139 ++stardepth;
9140 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
9141 --stardepth;
9144 STRCPY(buf + len, path_end);
9145 if (mch_has_exp_wildcard(path_end)) /* handle more wildcards */
9147 /* need to expand another component of the path */
9148 /* remove backslashes for the remaining components only */
9149 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
9151 else
9153 /* no more wildcards, check if there is a match */
9154 /* remove backslashes for the remaining components only */
9155 if (*path_end != NUL)
9156 backslash_halve(buf + len + 1);
9157 if (mch_getperm(buf) >= 0) /* add existing file */
9159 #ifdef MACOS_CONVERT
9160 size_t precomp_len = STRLEN(buf)+1;
9161 char_u *precomp_buf =
9162 mac_precompose_path(buf, precomp_len, &precomp_len);
9164 if (precomp_buf)
9166 mch_memmove(buf, precomp_buf, precomp_len);
9167 vim_free(precomp_buf);
9169 #endif
9170 addfile(gap, buf, flags);
9176 closedir(dirp);
9179 vim_free(buf);
9180 vim_free(regmatch.regprog);
9182 matches = gap->ga_len - start_len;
9183 if (matches > 0)
9184 qsort(((char_u **)gap->ga_data) + start_len, matches,
9185 sizeof(char_u *), pstrcmp);
9186 return matches;
9188 #endif
9191 * Generic wildcard expansion code.
9193 * Characters in "pat" that should not be expanded must be preceded with a
9194 * backslash. E.g., "/path\ with\ spaces/my\*star*"
9196 * Return FAIL when no single file was found. In this case "num_file" is not
9197 * set, and "file" may contain an error message.
9198 * Return OK when some files found. "num_file" is set to the number of
9199 * matches, "file" to the array of matches. Call FreeWild() later.
9202 gen_expand_wildcards(num_pat, pat, num_file, file, flags)
9203 int num_pat; /* number of input patterns */
9204 char_u **pat; /* array of input patterns */
9205 int *num_file; /* resulting number of files */
9206 char_u ***file; /* array of resulting files */
9207 int flags; /* EW_* flags */
9209 int i;
9210 garray_T ga;
9211 char_u *p;
9212 static int recursive = FALSE;
9213 int add_pat;
9216 * expand_env() is called to expand things like "~user". If this fails,
9217 * it calls ExpandOne(), which brings us back here. In this case, always
9218 * call the machine specific expansion function, if possible. Otherwise,
9219 * return FAIL.
9221 if (recursive)
9222 #ifdef SPECIAL_WILDCHAR
9223 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9224 #else
9225 return FAIL;
9226 #endif
9228 #ifdef SPECIAL_WILDCHAR
9230 * If there are any special wildcard characters which we cannot handle
9231 * here, call machine specific function for all the expansion. This
9232 * avoids starting the shell for each argument separately.
9233 * For `=expr` do use the internal function.
9235 for (i = 0; i < num_pat; i++)
9237 if (vim_strpbrk(pat[i], (char_u *)SPECIAL_WILDCHAR) != NULL
9238 # ifdef VIM_BACKTICK
9239 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
9240 # endif
9242 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9244 #endif
9246 recursive = TRUE;
9249 * The matching file names are stored in a growarray. Init it empty.
9251 ga_init2(&ga, (int)sizeof(char_u *), 30);
9253 for (i = 0; i < num_pat; ++i)
9255 add_pat = -1;
9256 p = pat[i];
9258 #ifdef VIM_BACKTICK
9259 if (vim_backtick(p))
9260 add_pat = expand_backtick(&ga, p, flags);
9261 else
9262 #endif
9265 * First expand environment variables, "~/" and "~user/".
9267 if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9269 p = expand_env_save_opt(p, TRUE);
9270 if (p == NULL)
9271 p = pat[i];
9272 #ifdef UNIX
9274 * On Unix, if expand_env() can't expand an environment
9275 * variable, use the shell to do that. Discard previously
9276 * found file names and start all over again.
9278 else if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9280 vim_free(p);
9281 ga_clear_strings(&ga);
9282 i = mch_expand_wildcards(num_pat, pat, num_file, file,
9283 flags);
9284 recursive = FALSE;
9285 return i;
9287 #endif
9291 * If there are wildcards: Expand file names and add each match to
9292 * the list. If there is no match, and EW_NOTFOUND is given, add
9293 * the pattern.
9294 * If there are no wildcards: Add the file name if it exists or
9295 * when EW_NOTFOUND is given.
9297 if (mch_has_exp_wildcard(p))
9298 add_pat = mch_expandpath(&ga, p, flags);
9301 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
9303 char_u *t = backslash_halve_save(p);
9305 #if defined(MACOS_CLASSIC)
9306 slash_to_colon(t);
9307 #endif
9308 /* When EW_NOTFOUND is used, always add files and dirs. Makes
9309 * "vim c:/" work. */
9310 if (flags & EW_NOTFOUND)
9311 addfile(&ga, t, flags | EW_DIR | EW_FILE);
9312 else if (mch_getperm(t) >= 0)
9313 addfile(&ga, t, flags);
9314 vim_free(t);
9317 if (p != pat[i])
9318 vim_free(p);
9321 *num_file = ga.ga_len;
9322 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data : (char_u **)"";
9324 recursive = FALSE;
9326 return (ga.ga_data != NULL) ? OK : FAIL;
9329 # ifdef VIM_BACKTICK
9332 * Return TRUE if we can expand this backtick thing here.
9334 static int
9335 vim_backtick(p)
9336 char_u *p;
9338 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
9342 * Expand an item in `backticks` by executing it as a command.
9343 * Currently only works when pat[] starts and ends with a `.
9344 * Returns number of file names found.
9346 static int
9347 expand_backtick(gap, pat, flags)
9348 garray_T *gap;
9349 char_u *pat;
9350 int flags; /* EW_* flags */
9352 char_u *p;
9353 char_u *cmd;
9354 char_u *buffer;
9355 int cnt = 0;
9356 int i;
9358 /* Create the command: lop off the backticks. */
9359 cmd = vim_strnsave(pat + 1, (int)STRLEN(pat) - 2);
9360 if (cmd == NULL)
9361 return 0;
9363 #ifdef FEAT_EVAL
9364 if (*cmd == '=') /* `={expr}`: Expand expression */
9365 buffer = eval_to_string(cmd + 1, &p, TRUE);
9366 else
9367 #endif
9368 buffer = get_cmd_output(cmd, NULL,
9369 (flags & EW_SILENT) ? SHELL_SILENT : 0);
9370 vim_free(cmd);
9371 if (buffer == NULL)
9372 return 0;
9374 cmd = buffer;
9375 while (*cmd != NUL)
9377 cmd = skipwhite(cmd); /* skip over white space */
9378 p = cmd;
9379 while (*p != NUL && *p != '\r' && *p != '\n') /* skip over entry */
9380 ++p;
9381 /* add an entry if it is not empty */
9382 if (p > cmd)
9384 i = *p;
9385 *p = NUL;
9386 addfile(gap, cmd, flags);
9387 *p = i;
9388 ++cnt;
9390 cmd = p;
9391 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
9392 ++cmd;
9395 vim_free(buffer);
9396 return cnt;
9398 # endif /* VIM_BACKTICK */
9401 * Add a file to a file list. Accepted flags:
9402 * EW_DIR add directories
9403 * EW_FILE add files
9404 * EW_EXEC add executable files
9405 * EW_NOTFOUND add even when it doesn't exist
9406 * EW_ADDSLASH add slash after directory name
9408 void
9409 addfile(gap, f, flags)
9410 garray_T *gap;
9411 char_u *f; /* filename */
9412 int flags;
9414 char_u *p;
9415 int isdir;
9417 /* if the file/dir doesn't exist, may not add it */
9418 if (!(flags & EW_NOTFOUND) && mch_getperm(f) < 0)
9419 return;
9421 #ifdef FNAME_ILLEGAL
9422 /* if the file/dir contains illegal characters, don't add it */
9423 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
9424 return;
9425 #endif
9427 isdir = mch_isdir(f);
9428 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
9429 return;
9431 /* If the file isn't executable, may not add it. Do accept directories. */
9432 if (!isdir && (flags & EW_EXEC) && !mch_can_exe(f))
9433 return;
9435 /* Make room for another item in the file list. */
9436 if (ga_grow(gap, 1) == FAIL)
9437 return;
9439 p = alloc((unsigned)(STRLEN(f) + 1 + isdir));
9440 if (p == NULL)
9441 return;
9443 STRCPY(p, f);
9444 #ifdef BACKSLASH_IN_FILENAME
9445 slash_adjust(p);
9446 #endif
9448 * Append a slash or backslash after directory names if none is present.
9450 #ifndef DONT_ADD_PATHSEP_TO_DIR
9451 if (isdir && (flags & EW_ADDSLASH))
9452 add_pathsep(p);
9453 #endif
9454 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
9456 #endif /* !NO_EXPANDPATH */
9458 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) || defined(PROTO)
9460 #ifndef SEEK_SET
9461 # define SEEK_SET 0
9462 #endif
9463 #ifndef SEEK_END
9464 # define SEEK_END 2
9465 #endif
9468 * Get the stdout of an external command.
9469 * Returns an allocated string, or NULL for error.
9471 char_u *
9472 get_cmd_output(cmd, infile, flags)
9473 char_u *cmd;
9474 char_u *infile; /* optional input file name */
9475 int flags; /* can be SHELL_SILENT */
9477 char_u *tempname;
9478 char_u *command;
9479 char_u *buffer = NULL;
9480 int len;
9481 int i = 0;
9482 FILE *fd;
9484 if (check_restricted() || check_secure())
9485 return NULL;
9487 /* get a name for the temp file */
9488 if ((tempname = vim_tempname('o')) == NULL)
9490 EMSG(_(e_notmp));
9491 return NULL;
9494 /* Add the redirection stuff */
9495 command = make_filter_cmd(cmd, infile, tempname);
9496 if (command == NULL)
9497 goto done;
9500 * Call the shell to execute the command (errors are ignored).
9501 * Don't check timestamps here.
9503 ++no_check_timestamps;
9504 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
9505 --no_check_timestamps;
9507 vim_free(command);
9510 * read the names from the file into memory
9512 # ifdef VMS
9513 /* created temporary file is not always readable as binary */
9514 fd = mch_fopen((char *)tempname, "r");
9515 # else
9516 fd = mch_fopen((char *)tempname, READBIN);
9517 # endif
9519 if (fd == NULL)
9521 EMSG2(_(e_notopen), tempname);
9522 goto done;
9525 fseek(fd, 0L, SEEK_END);
9526 len = ftell(fd); /* get size of temp file */
9527 fseek(fd, 0L, SEEK_SET);
9529 buffer = alloc(len + 1);
9530 if (buffer != NULL)
9531 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
9532 fclose(fd);
9533 mch_remove(tempname);
9534 if (buffer == NULL)
9535 goto done;
9536 #ifdef VMS
9537 len = i; /* VMS doesn't give us what we asked for... */
9538 #endif
9539 if (i != len)
9541 EMSG2(_(e_notread), tempname);
9542 vim_free(buffer);
9543 buffer = NULL;
9545 else
9546 buffer[len] = '\0'; /* make sure the buffer is terminated */
9548 done:
9549 vim_free(tempname);
9550 return buffer;
9552 #endif
9555 * Free the list of files returned by expand_wildcards() or other expansion
9556 * functions.
9558 void
9559 FreeWild(count, files)
9560 int count;
9561 char_u **files;
9563 if (count <= 0 || files == NULL)
9564 return;
9565 #if defined(__EMX__) && defined(__ALWAYS_HAS_TRAILING_NULL_POINTER) /* XXX */
9567 * Is this still OK for when other functions than expand_wildcards() have
9568 * been used???
9570 _fnexplodefree((char **)files);
9571 #else
9572 while (count--)
9573 vim_free(files[count]);
9574 vim_free(files);
9575 #endif
9579 * return TRUE when need to go to Insert mode because of 'insertmode'.
9580 * Don't do this when still processing a command or a mapping.
9581 * Don't do this when inside a ":normal" command.
9584 goto_im()
9586 return (p_im && stuff_empty() && typebuf_typed());