Code cleanup
[MacVim/KaoriYa.git] / src / misc1.c
blobdf2ccaaf873a101cf9564708aa5570f932e88953
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 #ifdef HAVE_FCNTL_H
18 # include <fcntl.h> /* for chdir() */
19 #endif
21 static char_u *vim_version_dir __ARGS((char_u *vimdir));
22 static char_u *remove_tail __ARGS((char_u *p, char_u *pend, char_u *name));
23 static int copy_indent __ARGS((int size, char_u *src));
26 * Count the size (in window cells) of the indent in the current line.
28 int
29 get_indent()
31 return get_indent_str(ml_get_curline(), (int)curbuf->b_p_ts);
35 * Count the size (in window cells) of the indent in line "lnum".
37 int
38 get_indent_lnum(lnum)
39 linenr_T lnum;
41 return get_indent_str(ml_get(lnum), (int)curbuf->b_p_ts);
44 #if defined(FEAT_FOLDING) || defined(PROTO)
46 * Count the size (in window cells) of the indent in line "lnum" of buffer
47 * "buf".
49 int
50 get_indent_buf(buf, lnum)
51 buf_T *buf;
52 linenr_T lnum;
54 return get_indent_str(ml_get_buf(buf, lnum, FALSE), (int)buf->b_p_ts);
56 #endif
59 * count the size (in window cells) of the indent in line "ptr", with
60 * 'tabstop' at "ts"
62 int
63 get_indent_str(ptr, ts)
64 char_u *ptr;
65 int ts;
67 int count = 0;
69 for ( ; *ptr; ++ptr)
71 if (*ptr == TAB) /* count a tab for what it is worth */
72 count += ts - (count % ts);
73 else if (*ptr == ' ')
74 ++count; /* count a space for one */
75 else
76 break;
78 return count;
82 * Set the indent of the current line.
83 * Leaves the cursor on the first non-blank in the line.
84 * Caller must take care of undo.
85 * "flags":
86 * SIN_CHANGED: call changed_bytes() if the line was changed.
87 * SIN_INSERT: insert the indent in front of the line.
88 * SIN_UNDO: save line for undo before changing it.
89 * Returns TRUE if the line was changed.
91 int
92 set_indent(size, flags)
93 int size; /* measured in spaces */
94 int flags;
96 char_u *p;
97 char_u *newline;
98 char_u *oldline;
99 char_u *s;
100 int todo;
101 int ind_len; /* measured in characters */
102 int line_len;
103 int doit = FALSE;
104 int ind_done = 0; /* measured in spaces */
105 int tab_pad;
106 int retval = FALSE;
107 int orig_char_len = -1; /* number of initial whitespace chars when
108 'et' and 'pi' are both set */
111 * First check if there is anything to do and compute the number of
112 * characters needed for the indent.
114 todo = size;
115 ind_len = 0;
116 p = oldline = ml_get_curline();
118 /* Calculate the buffer size for the new indent, and check to see if it
119 * isn't already set */
121 /* if 'expandtab' isn't set: use TABs; if both 'expandtab' and
122 * 'preserveindent' are set count the number of characters at the
123 * beginning of the line to be copied */
124 if (!curbuf->b_p_et || (!(flags & SIN_INSERT) && curbuf->b_p_pi))
126 /* If 'preserveindent' is set then reuse as much as possible of
127 * the existing indent structure for the new indent */
128 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
130 ind_done = 0;
132 /* count as many characters as we can use */
133 while (todo > 0 && vim_iswhite(*p))
135 if (*p == TAB)
137 tab_pad = (int)curbuf->b_p_ts
138 - (ind_done % (int)curbuf->b_p_ts);
139 /* stop if this tab will overshoot the target */
140 if (todo < tab_pad)
141 break;
142 todo -= tab_pad;
143 ++ind_len;
144 ind_done += tab_pad;
146 else
148 --todo;
149 ++ind_len;
150 ++ind_done;
152 ++p;
155 /* Set initial number of whitespace chars to copy if we are
156 * preserving indent but expandtab is set */
157 if (curbuf->b_p_et)
158 orig_char_len = ind_len;
160 /* Fill to next tabstop with a tab, if possible */
161 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
162 if (todo >= tab_pad && orig_char_len == -1)
164 doit = TRUE;
165 todo -= tab_pad;
166 ++ind_len;
167 /* ind_done += tab_pad; */
171 /* count tabs required for indent */
172 while (todo >= (int)curbuf->b_p_ts)
174 if (*p != TAB)
175 doit = TRUE;
176 else
177 ++p;
178 todo -= (int)curbuf->b_p_ts;
179 ++ind_len;
180 /* ind_done += (int)curbuf->b_p_ts; */
183 /* count spaces required for indent */
184 while (todo > 0)
186 if (*p != ' ')
187 doit = TRUE;
188 else
189 ++p;
190 --todo;
191 ++ind_len;
192 /* ++ind_done; */
195 /* Return if the indent is OK already. */
196 if (!doit && !vim_iswhite(*p) && !(flags & SIN_INSERT))
197 return FALSE;
199 /* Allocate memory for the new line. */
200 if (flags & SIN_INSERT)
201 p = oldline;
202 else
203 p = skipwhite(p);
204 line_len = (int)STRLEN(p) + 1;
206 /* If 'preserveindent' and 'expandtab' are both set keep the original
207 * characters and allocate accordingly. We will fill the rest with spaces
208 * after the if (!curbuf->b_p_et) below. */
209 if (orig_char_len != -1)
211 newline = alloc(orig_char_len + size - ind_done + line_len);
212 if (newline == NULL)
213 return FALSE;
214 todo = size - ind_done;
215 ind_len = orig_char_len + todo; /* Set total length of indent in
216 * characters, which may have been
217 * undercounted until now */
218 p = oldline;
219 s = newline;
220 while (orig_char_len > 0)
222 *s++ = *p++;
223 orig_char_len--;
226 /* Skip over any additional white space (useful when newindent is less
227 * than old) */
228 while (vim_iswhite(*p))
229 ++p;
232 else
234 todo = size;
235 newline = alloc(ind_len + line_len);
236 if (newline == NULL)
237 return FALSE;
238 s = newline;
241 /* Put the characters in the new line. */
242 /* if 'expandtab' isn't set: use TABs */
243 if (!curbuf->b_p_et)
245 /* If 'preserveindent' is set then reuse as much as possible of
246 * the existing indent structure for the new indent */
247 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
249 p = oldline;
250 ind_done = 0;
252 while (todo > 0 && vim_iswhite(*p))
254 if (*p == TAB)
256 tab_pad = (int)curbuf->b_p_ts
257 - (ind_done % (int)curbuf->b_p_ts);
258 /* stop if this tab will overshoot the target */
259 if (todo < tab_pad)
260 break;
261 todo -= tab_pad;
262 ind_done += tab_pad;
264 else
266 --todo;
267 ++ind_done;
269 *s++ = *p++;
272 /* Fill to next tabstop with a tab, if possible */
273 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
274 if (todo >= tab_pad)
276 *s++ = TAB;
277 todo -= tab_pad;
280 p = skipwhite(p);
283 while (todo >= (int)curbuf->b_p_ts)
285 *s++ = TAB;
286 todo -= (int)curbuf->b_p_ts;
289 while (todo > 0)
291 *s++ = ' ';
292 --todo;
294 mch_memmove(s, p, (size_t)line_len);
296 /* Replace the line (unless undo fails). */
297 if (!(flags & SIN_UNDO) || u_savesub(curwin->w_cursor.lnum) == OK)
299 ml_replace(curwin->w_cursor.lnum, newline, FALSE);
300 if (flags & SIN_CHANGED)
301 changed_bytes(curwin->w_cursor.lnum, 0);
302 /* Correct saved cursor position if it's after the indent. */
303 if (saved_cursor.lnum == curwin->w_cursor.lnum
304 && saved_cursor.col >= (colnr_T)(p - oldline))
305 saved_cursor.col += ind_len - (colnr_T)(p - oldline);
306 retval = TRUE;
308 else
309 vim_free(newline);
311 curwin->w_cursor.col = ind_len;
312 return retval;
316 * Copy the indent from ptr to the current line (and fill to size)
317 * Leaves the cursor on the first non-blank in the line.
318 * Returns TRUE if the line was changed.
320 static int
321 copy_indent(size, src)
322 int size;
323 char_u *src;
325 char_u *p = NULL;
326 char_u *line = NULL;
327 char_u *s;
328 int todo;
329 int ind_len;
330 int line_len = 0;
331 int tab_pad;
332 int ind_done;
333 int round;
335 /* Round 1: compute the number of characters needed for the indent
336 * Round 2: copy the characters. */
337 for (round = 1; round <= 2; ++round)
339 todo = size;
340 ind_len = 0;
341 ind_done = 0;
342 s = src;
344 /* Count/copy the usable portion of the source line */
345 while (todo > 0 && vim_iswhite(*s))
347 if (*s == TAB)
349 tab_pad = (int)curbuf->b_p_ts
350 - (ind_done % (int)curbuf->b_p_ts);
351 /* Stop if this tab will overshoot the target */
352 if (todo < tab_pad)
353 break;
354 todo -= tab_pad;
355 ind_done += tab_pad;
357 else
359 --todo;
360 ++ind_done;
362 ++ind_len;
363 if (p != NULL)
364 *p++ = *s;
365 ++s;
368 /* Fill to next tabstop with a tab, if possible */
369 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
370 if (todo >= tab_pad)
372 todo -= tab_pad;
373 ++ind_len;
374 if (p != NULL)
375 *p++ = TAB;
378 /* Add tabs required for indent */
379 while (todo >= (int)curbuf->b_p_ts)
381 todo -= (int)curbuf->b_p_ts;
382 ++ind_len;
383 if (p != NULL)
384 *p++ = TAB;
387 /* Count/add spaces required for indent */
388 while (todo > 0)
390 --todo;
391 ++ind_len;
392 if (p != NULL)
393 *p++ = ' ';
396 if (p == NULL)
398 /* Allocate memory for the result: the copied indent, new indent
399 * and the rest of the line. */
400 line_len = (int)STRLEN(ml_get_curline()) + 1;
401 line = alloc(ind_len + line_len);
402 if (line == NULL)
403 return FALSE;
404 p = line;
408 /* Append the original line */
409 mch_memmove(p, ml_get_curline(), (size_t)line_len);
411 /* Replace the line */
412 ml_replace(curwin->w_cursor.lnum, line, FALSE);
414 /* Put the cursor after the indent. */
415 curwin->w_cursor.col = ind_len;
416 return TRUE;
420 * Return the indent of the current line after a number. Return -1 if no
421 * number was found. Used for 'n' in 'formatoptions': numbered list.
422 * Since a pattern is used it can actually handle more than numbers.
425 get_number_indent(lnum)
426 linenr_T lnum;
428 colnr_T col;
429 pos_T pos;
430 regmmatch_T regmatch;
432 if (lnum > curbuf->b_ml.ml_line_count)
433 return -1;
434 pos.lnum = 0;
435 regmatch.regprog = vim_regcomp(curbuf->b_p_flp, RE_MAGIC);
436 if (regmatch.regprog != NULL)
438 regmatch.rmm_ic = FALSE;
439 regmatch.rmm_maxcol = 0;
440 if (vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
441 (colnr_T)0, NULL))
443 pos.lnum = regmatch.endpos[0].lnum + lnum;
444 pos.col = regmatch.endpos[0].col;
445 #ifdef FEAT_VIRTUALEDIT
446 pos.coladd = 0;
447 #endif
449 vim_free(regmatch.regprog);
452 if (pos.lnum == 0 || *ml_get_pos(&pos) == NUL)
453 return -1;
454 getvcol(curwin, &pos, &col, NULL, NULL);
455 return (int)col;
458 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
460 static int cin_is_cinword __ARGS((char_u *line));
463 * Return TRUE if the string "line" starts with a word from 'cinwords'.
465 static int
466 cin_is_cinword(line)
467 char_u *line;
469 char_u *cinw;
470 char_u *cinw_buf;
471 int cinw_len;
472 int retval = FALSE;
473 int len;
475 cinw_len = (int)STRLEN(curbuf->b_p_cinw) + 1;
476 cinw_buf = alloc((unsigned)cinw_len);
477 if (cinw_buf != NULL)
479 line = skipwhite(line);
480 for (cinw = curbuf->b_p_cinw; *cinw; )
482 len = copy_option_part(&cinw, cinw_buf, cinw_len, ",");
483 if (STRNCMP(line, cinw_buf, len) == 0
484 && (!vim_iswordc(line[len]) || !vim_iswordc(line[len - 1])))
486 retval = TRUE;
487 break;
490 vim_free(cinw_buf);
492 return retval;
494 #endif
497 * open_line: Add a new line below or above the current line.
499 * For VREPLACE mode, we only add a new line when we get to the end of the
500 * file, otherwise we just start replacing the next line.
502 * Caller must take care of undo. Since VREPLACE may affect any number of
503 * lines however, it may call u_save_cursor() again when starting to change a
504 * new line.
505 * "flags": OPENLINE_DELSPACES delete spaces after cursor
506 * OPENLINE_DO_COM format comments
507 * OPENLINE_KEEPTRAIL keep trailing spaces
508 * OPENLINE_MARKFIX adjust mark positions after the line break
510 * Return TRUE for success, FALSE for failure
513 open_line(dir, flags, old_indent)
514 int dir; /* FORWARD or BACKWARD */
515 int flags;
516 int old_indent; /* indent for after ^^D in Insert mode */
518 char_u *saved_line; /* copy of the original line */
519 char_u *next_line = NULL; /* copy of the next line */
520 char_u *p_extra = NULL; /* what goes to next line */
521 int less_cols = 0; /* less columns for mark in new line */
522 int less_cols_off = 0; /* columns to skip for mark adjust */
523 pos_T old_cursor; /* old cursor position */
524 int newcol = 0; /* new cursor column */
525 int newindent = 0; /* auto-indent of the new line */
526 int n;
527 int trunc_line = FALSE; /* truncate current line afterwards */
528 int retval = FALSE; /* return value, default is FAIL */
529 #ifdef FEAT_COMMENTS
530 int extra_len = 0; /* length of p_extra string */
531 int lead_len; /* length of comment leader */
532 char_u *lead_flags; /* position in 'comments' for comment leader */
533 char_u *leader = NULL; /* copy of comment leader */
534 #endif
535 char_u *allocated = NULL; /* allocated memory */
536 #if defined(FEAT_SMARTINDENT) || defined(FEAT_VREPLACE) || defined(FEAT_LISP) \
537 || defined(FEAT_CINDENT) || defined(FEAT_COMMENTS)
538 char_u *p;
539 #endif
540 int saved_char = NUL; /* init for GCC */
541 #if defined(FEAT_SMARTINDENT) || defined(FEAT_COMMENTS)
542 pos_T *pos;
543 #endif
544 #ifdef FEAT_SMARTINDENT
545 int do_si = (!p_paste && curbuf->b_p_si
546 # ifdef FEAT_CINDENT
547 && !curbuf->b_p_cin
548 # endif
550 int no_si = FALSE; /* reset did_si afterwards */
551 int first_char = NUL; /* init for GCC */
552 #endif
553 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
554 int vreplace_mode;
555 #endif
556 int did_append; /* appended a new line */
557 int saved_pi = curbuf->b_p_pi; /* copy of preserveindent setting */
560 * make a copy of the current line so we can mess with it
562 saved_line = vim_strsave(ml_get_curline());
563 if (saved_line == NULL) /* out of memory! */
564 return FALSE;
566 #ifdef FEAT_VREPLACE
567 if (State & VREPLACE_FLAG)
570 * With VREPLACE we make a copy of the next line, which we will be
571 * starting to replace. First make the new line empty and let vim play
572 * with the indenting and comment leader to its heart's content. Then
573 * we grab what it ended up putting on the new line, put back the
574 * original line, and call ins_char() to put each new character onto
575 * the line, replacing what was there before and pushing the right
576 * stuff onto the replace stack. -- webb.
578 if (curwin->w_cursor.lnum < orig_line_count)
579 next_line = vim_strsave(ml_get(curwin->w_cursor.lnum + 1));
580 else
581 next_line = vim_strsave((char_u *)"");
582 if (next_line == NULL) /* out of memory! */
583 goto theend;
586 * In VREPLACE mode, a NL replaces the rest of the line, and starts
587 * replacing the next line, so push all of the characters left on the
588 * line onto the replace stack. We'll push any other characters that
589 * might be replaced at the start of the next line (due to autoindent
590 * etc) a bit later.
592 replace_push(NUL); /* Call twice because BS over NL expects it */
593 replace_push(NUL);
594 p = saved_line + curwin->w_cursor.col;
595 while (*p != NUL)
597 #ifdef FEAT_MBYTE
598 if (has_mbyte)
599 p += replace_push_mb(p);
600 else
601 #endif
602 replace_push(*p++);
604 saved_line[curwin->w_cursor.col] = NUL;
606 #endif
608 if ((State & INSERT)
609 #ifdef FEAT_VREPLACE
610 && !(State & VREPLACE_FLAG)
611 #endif
614 p_extra = saved_line + curwin->w_cursor.col;
615 #ifdef FEAT_SMARTINDENT
616 if (do_si) /* need first char after new line break */
618 p = skipwhite(p_extra);
619 first_char = *p;
621 #endif
622 #ifdef FEAT_COMMENTS
623 extra_len = (int)STRLEN(p_extra);
624 #endif
625 saved_char = *p_extra;
626 *p_extra = NUL;
629 u_clearline(); /* cannot do "U" command when adding lines */
630 #ifdef FEAT_SMARTINDENT
631 did_si = FALSE;
632 #endif
633 ai_col = 0;
636 * If we just did an auto-indent, then we didn't type anything on
637 * the prior line, and it should be truncated. Do this even if 'ai' is not
638 * set because automatically inserting a comment leader also sets did_ai.
640 if (dir == FORWARD && did_ai)
641 trunc_line = TRUE;
644 * If 'autoindent' and/or 'smartindent' is set, try to figure out what
645 * indent to use for the new line.
647 if (curbuf->b_p_ai
648 #ifdef FEAT_SMARTINDENT
649 || do_si
650 #endif
654 * count white space on current line
656 newindent = get_indent_str(saved_line, (int)curbuf->b_p_ts);
657 if (newindent == 0)
658 newindent = old_indent; /* for ^^D command in insert mode */
660 #ifdef FEAT_SMARTINDENT
662 * Do smart indenting.
663 * In insert/replace mode (only when dir == FORWARD)
664 * we may move some text to the next line. If it starts with '{'
665 * don't add an indent. Fixes inserting a NL before '{' in line
666 * "if (condition) {"
668 if (!trunc_line && do_si && *saved_line != NUL
669 && (p_extra == NULL || first_char != '{'))
671 char_u *ptr;
672 char_u last_char;
674 old_cursor = curwin->w_cursor;
675 ptr = saved_line;
676 # ifdef FEAT_COMMENTS
677 if (flags & OPENLINE_DO_COM)
678 lead_len = get_leader_len(ptr, NULL, FALSE);
679 else
680 lead_len = 0;
681 # endif
682 if (dir == FORWARD)
685 * Skip preprocessor directives, unless they are
686 * recognised as comments.
688 if (
689 # ifdef FEAT_COMMENTS
690 lead_len == 0 &&
691 # endif
692 ptr[0] == '#')
694 while (ptr[0] == '#' && curwin->w_cursor.lnum > 1)
695 ptr = ml_get(--curwin->w_cursor.lnum);
696 newindent = get_indent();
698 # ifdef FEAT_COMMENTS
699 if (flags & OPENLINE_DO_COM)
700 lead_len = get_leader_len(ptr, NULL, FALSE);
701 else
702 lead_len = 0;
703 if (lead_len > 0)
706 * This case gets the following right:
707 * \*
708 * * A comment (read '\' as '/').
709 * *\
710 * #define IN_THE_WAY
711 * This should line up here;
713 p = skipwhite(ptr);
714 if (p[0] == '/' && p[1] == '*')
715 p++;
716 if (p[0] == '*')
718 for (p++; *p; p++)
720 if (p[0] == '/' && p[-1] == '*')
723 * End of C comment, indent should line up
724 * with the line containing the start of
725 * the comment
727 curwin->w_cursor.col = (colnr_T)(p - ptr);
728 if ((pos = findmatch(NULL, NUL)) != NULL)
730 curwin->w_cursor.lnum = pos->lnum;
731 newindent = get_indent();
737 else /* Not a comment line */
738 # endif
740 /* Find last non-blank in line */
741 p = ptr + STRLEN(ptr) - 1;
742 while (p > ptr && vim_iswhite(*p))
743 --p;
744 last_char = *p;
747 * find the character just before the '{' or ';'
749 if (last_char == '{' || last_char == ';')
751 if (p > ptr)
752 --p;
753 while (p > ptr && vim_iswhite(*p))
754 --p;
757 * Try to catch lines that are split over multiple
758 * lines. eg:
759 * if (condition &&
760 * condition) {
761 * Should line up here!
764 if (*p == ')')
766 curwin->w_cursor.col = (colnr_T)(p - ptr);
767 if ((pos = findmatch(NULL, '(')) != NULL)
769 curwin->w_cursor.lnum = pos->lnum;
770 newindent = get_indent();
771 ptr = ml_get_curline();
775 * If last character is '{' do indent, without
776 * checking for "if" and the like.
778 if (last_char == '{')
780 did_si = TRUE; /* do indent */
781 no_si = TRUE; /* don't delete it when '{' typed */
784 * Look for "if" and the like, use 'cinwords'.
785 * Don't do this if the previous line ended in ';' or
786 * '}'.
788 else if (last_char != ';' && last_char != '}'
789 && cin_is_cinword(ptr))
790 did_si = TRUE;
793 else /* dir == BACKWARD */
796 * Skip preprocessor directives, unless they are
797 * recognised as comments.
799 if (
800 # ifdef FEAT_COMMENTS
801 lead_len == 0 &&
802 # endif
803 ptr[0] == '#')
805 int was_backslashed = FALSE;
807 while ((ptr[0] == '#' || was_backslashed) &&
808 curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count)
810 if (*ptr && ptr[STRLEN(ptr) - 1] == '\\')
811 was_backslashed = TRUE;
812 else
813 was_backslashed = FALSE;
814 ptr = ml_get(++curwin->w_cursor.lnum);
816 if (was_backslashed)
817 newindent = 0; /* Got to end of file */
818 else
819 newindent = get_indent();
821 p = skipwhite(ptr);
822 if (*p == '}') /* if line starts with '}': do indent */
823 did_si = TRUE;
824 else /* can delete indent when '{' typed */
825 can_si_back = TRUE;
827 curwin->w_cursor = old_cursor;
829 if (do_si)
830 can_si = TRUE;
831 #endif /* FEAT_SMARTINDENT */
833 did_ai = TRUE;
836 #ifdef FEAT_COMMENTS
838 * Find out if the current line starts with a comment leader.
839 * This may then be inserted in front of the new line.
841 end_comment_pending = NUL;
842 if (flags & OPENLINE_DO_COM)
843 lead_len = get_leader_len(saved_line, &lead_flags, dir == BACKWARD);
844 else
845 lead_len = 0;
846 if (lead_len > 0)
848 char_u *lead_repl = NULL; /* replaces comment leader */
849 int lead_repl_len = 0; /* length of *lead_repl */
850 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
851 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
852 char_u *comment_end = NULL; /* where lead_end has been found */
853 int extra_space = FALSE; /* append extra space */
854 int current_flag;
855 int require_blank = FALSE; /* requires blank after middle */
856 char_u *p2;
859 * If the comment leader has the start, middle or end flag, it may not
860 * be used or may be replaced with the middle leader.
862 for (p = lead_flags; *p && *p != ':'; ++p)
864 if (*p == COM_BLANK)
866 require_blank = TRUE;
867 continue;
869 if (*p == COM_START || *p == COM_MIDDLE)
871 current_flag = *p;
872 if (*p == COM_START)
875 * Doing "O" on a start of comment does not insert leader.
877 if (dir == BACKWARD)
879 lead_len = 0;
880 break;
883 /* find start of middle part */
884 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
885 require_blank = FALSE;
889 * Isolate the strings of the middle and end leader.
891 while (*p && p[-1] != ':') /* find end of middle flags */
893 if (*p == COM_BLANK)
894 require_blank = TRUE;
895 ++p;
897 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
899 while (*p && p[-1] != ':') /* find end of end flags */
901 /* Check whether we allow automatic ending of comments */
902 if (*p == COM_AUTO_END)
903 end_comment_pending = -1; /* means we want to set it */
904 ++p;
906 n = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
908 if (end_comment_pending == -1) /* we can set it now */
909 end_comment_pending = lead_end[n - 1];
912 * If the end of the comment is in the same line, don't use
913 * the comment leader.
915 if (dir == FORWARD)
917 for (p = saved_line + lead_len; *p; ++p)
918 if (STRNCMP(p, lead_end, n) == 0)
920 comment_end = p;
921 lead_len = 0;
922 break;
927 * Doing "o" on a start of comment inserts the middle leader.
929 if (lead_len > 0)
931 if (current_flag == COM_START)
933 lead_repl = lead_middle;
934 lead_repl_len = (int)STRLEN(lead_middle);
938 * If we have hit RETURN immediately after the start
939 * comment leader, then put a space after the middle
940 * comment leader on the next line.
942 if (!vim_iswhite(saved_line[lead_len - 1])
943 && ((p_extra != NULL
944 && (int)curwin->w_cursor.col == lead_len)
945 || (p_extra == NULL
946 && saved_line[lead_len] == NUL)
947 || require_blank))
948 extra_space = TRUE;
950 break;
952 if (*p == COM_END)
955 * Doing "o" on the end of a comment does not insert leader.
956 * Remember where the end is, might want to use it to find the
957 * start (for C-comments).
959 if (dir == FORWARD)
961 comment_end = skipwhite(saved_line);
962 lead_len = 0;
963 break;
967 * Doing "O" on the end of a comment inserts the middle leader.
968 * Find the string for the middle leader, searching backwards.
970 while (p > curbuf->b_p_com && *p != ',')
971 --p;
972 for (lead_repl = p; lead_repl > curbuf->b_p_com
973 && lead_repl[-1] != ':'; --lead_repl)
975 lead_repl_len = (int)(p - lead_repl);
977 /* We can probably always add an extra space when doing "O" on
978 * the comment-end */
979 extra_space = TRUE;
981 /* Check whether we allow automatic ending of comments */
982 for (p2 = p; *p2 && *p2 != ':'; p2++)
984 if (*p2 == COM_AUTO_END)
985 end_comment_pending = -1; /* means we want to set it */
987 if (end_comment_pending == -1)
989 /* Find last character in end-comment string */
990 while (*p2 && *p2 != ',')
991 p2++;
992 end_comment_pending = p2[-1];
994 break;
996 if (*p == COM_FIRST)
999 * Comment leader for first line only: Don't repeat leader
1000 * when using "O", blank out leader when using "o".
1002 if (dir == BACKWARD)
1003 lead_len = 0;
1004 else
1006 lead_repl = (char_u *)"";
1007 lead_repl_len = 0;
1009 break;
1012 if (lead_len)
1014 /* allocate buffer (may concatenate p_exta later) */
1015 leader = alloc(lead_len + lead_repl_len + extra_space +
1016 extra_len + 1);
1017 allocated = leader; /* remember to free it later */
1019 if (leader == NULL)
1020 lead_len = 0;
1021 else
1023 vim_strncpy(leader, saved_line, lead_len);
1026 * Replace leader with lead_repl, right or left adjusted
1028 if (lead_repl != NULL)
1030 int c = 0;
1031 int off = 0;
1033 for (p = lead_flags; *p && *p != ':'; ++p)
1035 if (*p == COM_RIGHT || *p == COM_LEFT)
1036 c = *p;
1037 else if (VIM_ISDIGIT(*p) || *p == '-')
1038 off = getdigits(&p);
1040 if (c == COM_RIGHT) /* right adjusted leader */
1042 /* find last non-white in the leader to line up with */
1043 for (p = leader + lead_len - 1; p > leader
1044 && vim_iswhite(*p); --p)
1046 ++p;
1048 #ifdef FEAT_MBYTE
1049 /* Compute the length of the replaced characters in
1050 * screen characters, not bytes. */
1052 int repl_size = vim_strnsize(lead_repl,
1053 lead_repl_len);
1054 int old_size = 0;
1055 char_u *endp = p;
1056 int l;
1058 while (old_size < repl_size && p > leader)
1060 mb_ptr_back(leader, p);
1061 old_size += ptr2cells(p);
1063 l = lead_repl_len - (int)(endp - p);
1064 if (l != 0)
1065 mch_memmove(endp + l, endp,
1066 (size_t)((leader + lead_len) - endp));
1067 lead_len += l;
1069 #else
1070 if (p < leader + lead_repl_len)
1071 p = leader;
1072 else
1073 p -= lead_repl_len;
1074 #endif
1075 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1076 if (p + lead_repl_len > leader + lead_len)
1077 p[lead_repl_len] = NUL;
1079 /* blank-out any other chars from the old leader. */
1080 while (--p >= leader)
1082 #ifdef FEAT_MBYTE
1083 int l = mb_head_off(leader, p);
1085 if (l > 1)
1087 p -= l;
1088 if (ptr2cells(p) > 1)
1090 p[1] = ' ';
1091 --l;
1093 mch_memmove(p + 1, p + l + 1,
1094 (size_t)((leader + lead_len) - (p + l + 1)));
1095 lead_len -= l;
1096 *p = ' ';
1098 else
1099 #endif
1100 if (!vim_iswhite(*p))
1101 *p = ' ';
1104 else /* left adjusted leader */
1106 p = skipwhite(leader);
1107 #ifdef FEAT_MBYTE
1108 /* Compute the length of the replaced characters in
1109 * screen characters, not bytes. Move the part that is
1110 * not to be overwritten. */
1112 int repl_size = vim_strnsize(lead_repl,
1113 lead_repl_len);
1114 int i;
1115 int l;
1117 for (i = 0; p[i] != NUL && i < lead_len; i += l)
1119 l = (*mb_ptr2len)(p + i);
1120 if (vim_strnsize(p, i + l) > repl_size)
1121 break;
1123 if (i != lead_repl_len)
1125 mch_memmove(p + lead_repl_len, p + i,
1126 (size_t)(lead_len - i - (leader - p)));
1127 lead_len += lead_repl_len - i;
1130 #endif
1131 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1133 /* Replace any remaining non-white chars in the old
1134 * leader by spaces. Keep Tabs, the indent must
1135 * remain the same. */
1136 for (p += lead_repl_len; p < leader + lead_len; ++p)
1137 if (!vim_iswhite(*p))
1139 /* Don't put a space before a TAB. */
1140 if (p + 1 < leader + lead_len && p[1] == TAB)
1142 --lead_len;
1143 mch_memmove(p, p + 1,
1144 (leader + lead_len) - p);
1146 else
1148 #ifdef FEAT_MBYTE
1149 int l = (*mb_ptr2len)(p);
1151 if (l > 1)
1153 if (ptr2cells(p) > 1)
1155 /* Replace a double-wide char with
1156 * two spaces */
1157 --l;
1158 *p++ = ' ';
1160 mch_memmove(p + 1, p + l,
1161 (leader + lead_len) - p);
1162 lead_len -= l - 1;
1164 #endif
1165 *p = ' ';
1168 *p = NUL;
1171 /* Recompute the indent, it may have changed. */
1172 if (curbuf->b_p_ai
1173 #ifdef FEAT_SMARTINDENT
1174 || do_si
1175 #endif
1177 newindent = get_indent_str(leader, (int)curbuf->b_p_ts);
1179 /* Add the indent offset */
1180 if (newindent + off < 0)
1182 off = -newindent;
1183 newindent = 0;
1185 else
1186 newindent += off;
1188 /* Correct trailing spaces for the shift, so that
1189 * alignment remains equal. */
1190 while (off > 0 && lead_len > 0
1191 && leader[lead_len - 1] == ' ')
1193 /* Don't do it when there is a tab before the space */
1194 if (vim_strchr(skipwhite(leader), '\t') != NULL)
1195 break;
1196 --lead_len;
1197 --off;
1200 /* If the leader ends in white space, don't add an
1201 * extra space */
1202 if (lead_len > 0 && vim_iswhite(leader[lead_len - 1]))
1203 extra_space = FALSE;
1204 leader[lead_len] = NUL;
1207 if (extra_space)
1209 leader[lead_len++] = ' ';
1210 leader[lead_len] = NUL;
1213 newcol = lead_len;
1216 * if a new indent will be set below, remove the indent that
1217 * is in the comment leader
1219 if (newindent
1220 #ifdef FEAT_SMARTINDENT
1221 || did_si
1222 #endif
1225 while (lead_len && vim_iswhite(*leader))
1227 --lead_len;
1228 --newcol;
1229 ++leader;
1234 #ifdef FEAT_SMARTINDENT
1235 did_si = can_si = FALSE;
1236 #endif
1238 else if (comment_end != NULL)
1241 * We have finished a comment, so we don't use the leader.
1242 * If this was a C-comment and 'ai' or 'si' is set do a normal
1243 * indent to align with the line containing the start of the
1244 * comment.
1246 if (comment_end[0] == '*' && comment_end[1] == '/' &&
1247 (curbuf->b_p_ai
1248 #ifdef FEAT_SMARTINDENT
1249 || do_si
1250 #endif
1253 old_cursor = curwin->w_cursor;
1254 curwin->w_cursor.col = (colnr_T)(comment_end - saved_line);
1255 if ((pos = findmatch(NULL, NUL)) != NULL)
1257 curwin->w_cursor.lnum = pos->lnum;
1258 newindent = get_indent();
1260 curwin->w_cursor = old_cursor;
1264 #endif
1266 /* (State == INSERT || State == REPLACE), only when dir == FORWARD */
1267 if (p_extra != NULL)
1269 *p_extra = saved_char; /* restore char that NUL replaced */
1272 * When 'ai' set or "flags" has OPENLINE_DELSPACES, skip to the first
1273 * non-blank.
1275 * When in REPLACE mode, put the deleted blanks on the replace stack,
1276 * preceded by a NUL, so they can be put back when a BS is entered.
1278 if (REPLACE_NORMAL(State))
1279 replace_push(NUL); /* end of extra blanks */
1280 if (curbuf->b_p_ai || (flags & OPENLINE_DELSPACES))
1282 while ((*p_extra == ' ' || *p_extra == '\t')
1283 #ifdef FEAT_MBYTE
1284 && (!enc_utf8
1285 || !utf_iscomposing(utf_ptr2char(p_extra + 1)))
1286 #endif
1289 if (REPLACE_NORMAL(State))
1290 replace_push(*p_extra);
1291 ++p_extra;
1292 ++less_cols_off;
1295 if (*p_extra != NUL)
1296 did_ai = FALSE; /* append some text, don't truncate now */
1298 /* columns for marks adjusted for removed columns */
1299 less_cols = (int)(p_extra - saved_line);
1302 if (p_extra == NULL)
1303 p_extra = (char_u *)""; /* append empty line */
1305 #ifdef FEAT_COMMENTS
1306 /* concatenate leader and p_extra, if there is a leader */
1307 if (lead_len)
1309 STRCAT(leader, p_extra);
1310 p_extra = leader;
1311 did_ai = TRUE; /* So truncating blanks works with comments */
1312 less_cols -= lead_len;
1314 else
1315 end_comment_pending = NUL; /* turns out there was no leader */
1316 #endif
1318 old_cursor = curwin->w_cursor;
1319 if (dir == BACKWARD)
1320 --curwin->w_cursor.lnum;
1321 #ifdef FEAT_VREPLACE
1322 if (!(State & VREPLACE_FLAG) || old_cursor.lnum >= orig_line_count)
1323 #endif
1325 if (ml_append(curwin->w_cursor.lnum, p_extra, (colnr_T)0, FALSE)
1326 == FAIL)
1327 goto theend;
1328 /* Postpone calling changed_lines(), because it would mess up folding
1329 * with markers. */
1330 mark_adjust(curwin->w_cursor.lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
1331 did_append = TRUE;
1333 #ifdef FEAT_VREPLACE
1334 else
1337 * In VREPLACE mode we are starting to replace the next line.
1339 curwin->w_cursor.lnum++;
1340 if (curwin->w_cursor.lnum >= Insstart.lnum + vr_lines_changed)
1342 /* In case we NL to a new line, BS to the previous one, and NL
1343 * again, we don't want to save the new line for undo twice.
1345 (void)u_save_cursor(); /* errors are ignored! */
1346 vr_lines_changed++;
1348 ml_replace(curwin->w_cursor.lnum, p_extra, TRUE);
1349 changed_bytes(curwin->w_cursor.lnum, 0);
1350 curwin->w_cursor.lnum--;
1351 did_append = FALSE;
1353 #endif
1355 if (newindent
1356 #ifdef FEAT_SMARTINDENT
1357 || did_si
1358 #endif
1361 ++curwin->w_cursor.lnum;
1362 #ifdef FEAT_SMARTINDENT
1363 if (did_si)
1365 if (p_sr)
1366 newindent -= newindent % (int)curbuf->b_p_sw;
1367 newindent += (int)curbuf->b_p_sw;
1369 #endif
1370 /* Copy the indent */
1371 if (curbuf->b_p_ci)
1373 (void)copy_indent(newindent, saved_line);
1376 * Set the 'preserveindent' option so that any further screwing
1377 * with the line doesn't entirely destroy our efforts to preserve
1378 * it. It gets restored at the function end.
1380 curbuf->b_p_pi = TRUE;
1382 else
1383 (void)set_indent(newindent, SIN_INSERT);
1384 less_cols -= curwin->w_cursor.col;
1386 ai_col = curwin->w_cursor.col;
1389 * In REPLACE mode, for each character in the new indent, there must
1390 * be a NUL on the replace stack, for when it is deleted with BS
1392 if (REPLACE_NORMAL(State))
1393 for (n = 0; n < (int)curwin->w_cursor.col; ++n)
1394 replace_push(NUL);
1395 newcol += curwin->w_cursor.col;
1396 #ifdef FEAT_SMARTINDENT
1397 if (no_si)
1398 did_si = FALSE;
1399 #endif
1402 #ifdef FEAT_COMMENTS
1404 * In REPLACE mode, for each character in the extra leader, there must be
1405 * a NUL on the replace stack, for when it is deleted with BS.
1407 if (REPLACE_NORMAL(State))
1408 while (lead_len-- > 0)
1409 replace_push(NUL);
1410 #endif
1412 curwin->w_cursor = old_cursor;
1414 if (dir == FORWARD)
1416 if (trunc_line || (State & INSERT))
1418 /* truncate current line at cursor */
1419 saved_line[curwin->w_cursor.col] = NUL;
1420 /* Remove trailing white space, unless OPENLINE_KEEPTRAIL used. */
1421 if (trunc_line && !(flags & OPENLINE_KEEPTRAIL))
1422 truncate_spaces(saved_line);
1423 ml_replace(curwin->w_cursor.lnum, saved_line, FALSE);
1424 saved_line = NULL;
1425 if (did_append)
1427 changed_lines(curwin->w_cursor.lnum, curwin->w_cursor.col,
1428 curwin->w_cursor.lnum + 1, 1L);
1429 did_append = FALSE;
1431 /* Move marks after the line break to the new line. */
1432 if (flags & OPENLINE_MARKFIX)
1433 mark_col_adjust(curwin->w_cursor.lnum,
1434 curwin->w_cursor.col + less_cols_off,
1435 1L, (long)-less_cols);
1437 else
1438 changed_bytes(curwin->w_cursor.lnum, curwin->w_cursor.col);
1442 * Put the cursor on the new line. Careful: the scrollup() above may
1443 * have moved w_cursor, we must use old_cursor.
1445 curwin->w_cursor.lnum = old_cursor.lnum + 1;
1447 if (did_append)
1448 changed_lines(curwin->w_cursor.lnum, 0, curwin->w_cursor.lnum, 1L);
1450 curwin->w_cursor.col = newcol;
1451 #ifdef FEAT_VIRTUALEDIT
1452 curwin->w_cursor.coladd = 0;
1453 #endif
1455 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1457 * In VREPLACE mode, we are handling the replace stack ourselves, so stop
1458 * fixthisline() from doing it (via change_indent()) by telling it we're in
1459 * normal INSERT mode.
1461 if (State & VREPLACE_FLAG)
1463 vreplace_mode = State; /* So we know to put things right later */
1464 State = INSERT;
1466 else
1467 vreplace_mode = 0;
1468 #endif
1469 #ifdef FEAT_LISP
1471 * May do lisp indenting.
1473 if (!p_paste
1474 # ifdef FEAT_COMMENTS
1475 && leader == NULL
1476 # endif
1477 && curbuf->b_p_lisp
1478 && curbuf->b_p_ai)
1480 fixthisline(get_lisp_indent);
1481 p = ml_get_curline();
1482 ai_col = (colnr_T)(skipwhite(p) - p);
1484 #endif
1485 #ifdef FEAT_CINDENT
1487 * May do indenting after opening a new line.
1489 if (!p_paste
1490 && (curbuf->b_p_cin
1491 # ifdef FEAT_EVAL
1492 || *curbuf->b_p_inde != NUL
1493 # endif
1495 && in_cinkeys(dir == FORWARD
1496 ? KEY_OPEN_FORW
1497 : KEY_OPEN_BACK, ' ', linewhite(curwin->w_cursor.lnum)))
1499 do_c_expr_indent();
1500 p = ml_get_curline();
1501 ai_col = (colnr_T)(skipwhite(p) - p);
1503 #endif
1504 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1505 if (vreplace_mode != 0)
1506 State = vreplace_mode;
1507 #endif
1509 #ifdef FEAT_VREPLACE
1511 * Finally, VREPLACE gets the stuff on the new line, then puts back the
1512 * original line, and inserts the new stuff char by char, pushing old stuff
1513 * onto the replace stack (via ins_char()).
1515 if (State & VREPLACE_FLAG)
1517 /* Put new line in p_extra */
1518 p_extra = vim_strsave(ml_get_curline());
1519 if (p_extra == NULL)
1520 goto theend;
1522 /* Put back original line */
1523 ml_replace(curwin->w_cursor.lnum, next_line, FALSE);
1525 /* Insert new stuff into line again */
1526 curwin->w_cursor.col = 0;
1527 #ifdef FEAT_VIRTUALEDIT
1528 curwin->w_cursor.coladd = 0;
1529 #endif
1530 ins_bytes(p_extra); /* will call changed_bytes() */
1531 vim_free(p_extra);
1532 next_line = NULL;
1534 #endif
1536 retval = TRUE; /* success! */
1537 theend:
1538 curbuf->b_p_pi = saved_pi;
1539 vim_free(saved_line);
1540 vim_free(next_line);
1541 vim_free(allocated);
1542 return retval;
1545 #if defined(FEAT_COMMENTS) || defined(PROTO)
1547 * get_leader_len() returns the length of the prefix of the given string
1548 * which introduces a comment. If this string is not a comment then 0 is
1549 * returned.
1550 * When "flags" is not NULL, it is set to point to the flags of the recognized
1551 * comment leader.
1552 * "backward" must be true for the "O" command.
1555 get_leader_len(line, flags, backward)
1556 char_u *line;
1557 char_u **flags;
1558 int backward;
1560 int i, j;
1561 int got_com = FALSE;
1562 int found_one;
1563 char_u part_buf[COM_MAX_LEN]; /* buffer for one option part */
1564 char_u *string; /* pointer to comment string */
1565 char_u *list;
1567 i = 0;
1568 while (vim_iswhite(line[i])) /* leading white space is ignored */
1569 ++i;
1572 * Repeat to match several nested comment strings.
1574 while (line[i])
1577 * scan through the 'comments' option for a match
1579 found_one = FALSE;
1580 for (list = curbuf->b_p_com; *list; )
1583 * Get one option part into part_buf[]. Advance list to next one.
1584 * put string at start of string.
1586 if (!got_com && flags != NULL) /* remember where flags started */
1587 *flags = list;
1588 (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
1589 string = vim_strchr(part_buf, ':');
1590 if (string == NULL) /* missing ':', ignore this part */
1591 continue;
1592 *string++ = NUL; /* isolate flags from string */
1595 * When already found a nested comment, only accept further
1596 * nested comments.
1598 if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
1599 continue;
1601 /* When 'O' flag used don't use for "O" command */
1602 if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
1603 continue;
1606 * Line contents and string must match.
1607 * When string starts with white space, must have some white space
1608 * (but the amount does not need to match, there might be a mix of
1609 * TABs and spaces).
1611 if (vim_iswhite(string[0]))
1613 if (i == 0 || !vim_iswhite(line[i - 1]))
1614 continue;
1615 while (vim_iswhite(string[0]))
1616 ++string;
1618 for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
1620 if (string[j] != NUL)
1621 continue;
1624 * When 'b' flag used, there must be white space or an
1625 * end-of-line after the string in the line.
1627 if (vim_strchr(part_buf, COM_BLANK) != NULL
1628 && !vim_iswhite(line[i + j]) && line[i + j] != NUL)
1629 continue;
1632 * We have found a match, stop searching.
1634 i += j;
1635 got_com = TRUE;
1636 found_one = TRUE;
1637 break;
1641 * No match found, stop scanning.
1643 if (!found_one)
1644 break;
1647 * Include any trailing white space.
1649 while (vim_iswhite(line[i]))
1650 ++i;
1653 * If this comment doesn't nest, stop here.
1655 if (vim_strchr(part_buf, COM_NEST) == NULL)
1656 break;
1658 return (got_com ? i : 0);
1660 #endif
1663 * Return the number of window lines occupied by buffer line "lnum".
1666 plines(lnum)
1667 linenr_T lnum;
1669 return plines_win(curwin, lnum, TRUE);
1673 plines_win(wp, lnum, winheight)
1674 win_T *wp;
1675 linenr_T lnum;
1676 int winheight; /* when TRUE limit to window height */
1678 #if defined(FEAT_DIFF) || defined(PROTO)
1679 /* Check for filler lines above this buffer line. When folded the result
1680 * is one line anyway. */
1681 return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
1685 plines_nofill(lnum)
1686 linenr_T lnum;
1688 return plines_win_nofill(curwin, lnum, TRUE);
1692 plines_win_nofill(wp, lnum, winheight)
1693 win_T *wp;
1694 linenr_T lnum;
1695 int winheight; /* when TRUE limit to window height */
1697 #endif
1698 int lines;
1700 if (!wp->w_p_wrap)
1701 return 1;
1703 #ifdef FEAT_VERTSPLIT
1704 if (wp->w_width == 0)
1705 return 1;
1706 #endif
1708 #ifdef FEAT_FOLDING
1709 /* A folded lines is handled just like an empty line. */
1710 /* NOTE: Caller must handle lines that are MAYBE folded. */
1711 if (lineFolded(wp, lnum) == TRUE)
1712 return 1;
1713 #endif
1715 lines = plines_win_nofold(wp, lnum);
1716 if (winheight > 0 && lines > wp->w_height)
1717 return (int)wp->w_height;
1718 return lines;
1722 * Return number of window lines physical line "lnum" will occupy in window
1723 * "wp". Does not care about folding, 'wrap' or 'diff'.
1726 plines_win_nofold(wp, lnum)
1727 win_T *wp;
1728 linenr_T lnum;
1730 char_u *s;
1731 long col;
1732 int width;
1734 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1735 if (*s == NUL) /* empty line */
1736 return 1;
1737 col = win_linetabsize(wp, s, (colnr_T)MAXCOL);
1740 * If list mode is on, then the '$' at the end of the line may take up one
1741 * extra column.
1743 if (wp->w_p_list && lcs_eol != NUL)
1744 col += 1;
1747 * Add column offset for 'number' and 'foldcolumn'.
1749 width = W_WIDTH(wp) - win_col_off(wp);
1750 if (width <= 0)
1751 return 32000;
1752 if (col <= width)
1753 return 1;
1754 col -= width;
1755 width += win_col_off2(wp);
1756 return (col + (width - 1)) / width + 1;
1760 * Like plines_win(), but only reports the number of physical screen lines
1761 * used from the start of the line to the given column number.
1764 plines_win_col(wp, lnum, column)
1765 win_T *wp;
1766 linenr_T lnum;
1767 long column;
1769 long col;
1770 char_u *s;
1771 int lines = 0;
1772 int width;
1774 #ifdef FEAT_DIFF
1775 /* Check for filler lines above this buffer line. When folded the result
1776 * is one line anyway. */
1777 lines = diff_check_fill(wp, lnum);
1778 #endif
1780 if (!wp->w_p_wrap)
1781 return lines + 1;
1783 #ifdef FEAT_VERTSPLIT
1784 if (wp->w_width == 0)
1785 return lines + 1;
1786 #endif
1788 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1790 col = 0;
1791 while (*s != NUL && --column >= 0)
1793 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL);
1794 mb_ptr_adv(s);
1798 * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
1799 * INSERT mode, then col must be adjusted so that it represents the last
1800 * screen position of the TAB. This only fixes an error when the TAB wraps
1801 * from one screen line to the next (when 'columns' is not a multiple of
1802 * 'ts') -- webb.
1804 if (*s == TAB && (State & NORMAL) && (!wp->w_p_list || lcs_tab1))
1805 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL) - 1;
1808 * Add column offset for 'number', 'foldcolumn', etc.
1810 width = W_WIDTH(wp) - win_col_off(wp);
1811 if (width <= 0)
1812 return 9999;
1814 lines += 1;
1815 if (col > width)
1816 lines += (col - width) / (width + win_col_off2(wp)) + 1;
1817 return lines;
1821 plines_m_win(wp, first, last)
1822 win_T *wp;
1823 linenr_T first, last;
1825 int count = 0;
1827 while (first <= last)
1829 #ifdef FEAT_FOLDING
1830 int x;
1832 /* Check if there are any really folded lines, but also included lines
1833 * that are maybe folded. */
1834 x = foldedCount(wp, first, NULL);
1835 if (x > 0)
1837 ++count; /* count 1 for "+-- folded" line */
1838 first += x;
1840 else
1841 #endif
1843 #ifdef FEAT_DIFF
1844 if (first == wp->w_topline)
1845 count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill;
1846 else
1847 #endif
1848 count += plines_win(wp, first, TRUE);
1849 ++first;
1852 return (count);
1855 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) || defined(PROTO)
1857 * Insert string "p" at the cursor position. Stops at a NUL byte.
1858 * Handles Replace mode and multi-byte characters.
1860 void
1861 ins_bytes(p)
1862 char_u *p;
1864 ins_bytes_len(p, (int)STRLEN(p));
1866 #endif
1868 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) \
1869 || defined(FEAT_COMMENTS) || defined(FEAT_MBYTE) || defined(PROTO)
1871 * Insert string "p" with length "len" at the cursor position.
1872 * Handles Replace mode and multi-byte characters.
1874 void
1875 ins_bytes_len(p, len)
1876 char_u *p;
1877 int len;
1879 int i;
1880 # ifdef FEAT_MBYTE
1881 int n;
1883 for (i = 0; i < len; i += n)
1885 n = (*mb_ptr2len)(p + i);
1886 ins_char_bytes(p + i, n);
1888 # else
1889 for (i = 0; i < len; ++i)
1890 ins_char(p[i]);
1891 # endif
1893 #endif
1896 * Insert or replace a single character at the cursor position.
1897 * When in REPLACE or VREPLACE mode, replace any existing character.
1898 * Caller must have prepared for undo.
1899 * For multi-byte characters we get the whole character, the caller must
1900 * convert bytes to a character.
1902 void
1903 ins_char(c)
1904 int c;
1906 #if defined(FEAT_MBYTE) || defined(PROTO)
1907 char_u buf[MB_MAXBYTES];
1908 int n;
1910 n = (*mb_char2bytes)(c, buf);
1912 /* When "c" is 0x100, 0x200, etc. we don't want to insert a NUL byte.
1913 * Happens for CTRL-Vu9900. */
1914 if (buf[0] == 0)
1915 buf[0] = '\n';
1917 ins_char_bytes(buf, n);
1920 void
1921 ins_char_bytes(buf, charlen)
1922 char_u *buf;
1923 int charlen;
1925 int c = buf[0];
1926 #endif
1927 int newlen; /* nr of bytes inserted */
1928 int oldlen; /* nr of bytes deleted (0 when not replacing) */
1929 char_u *p;
1930 char_u *newp;
1931 char_u *oldp;
1932 int linelen; /* length of old line including NUL */
1933 colnr_T col;
1934 linenr_T lnum = curwin->w_cursor.lnum;
1935 int i;
1937 #ifdef FEAT_VIRTUALEDIT
1938 /* Break tabs if needed. */
1939 if (virtual_active() && curwin->w_cursor.coladd > 0)
1940 coladvance_force(getviscol());
1941 #endif
1943 col = curwin->w_cursor.col;
1944 oldp = ml_get(lnum);
1945 linelen = (int)STRLEN(oldp) + 1;
1947 /* The lengths default to the values for when not replacing. */
1948 oldlen = 0;
1949 #ifdef FEAT_MBYTE
1950 newlen = charlen;
1951 #else
1952 newlen = 1;
1953 #endif
1955 if (State & REPLACE_FLAG)
1957 #ifdef FEAT_VREPLACE
1958 if (State & VREPLACE_FLAG)
1960 colnr_T new_vcol = 0; /* init for GCC */
1961 colnr_T vcol;
1962 int old_list;
1963 #ifndef FEAT_MBYTE
1964 char_u buf[2];
1965 #endif
1968 * Disable 'list' temporarily, unless 'cpo' contains the 'L' flag.
1969 * Returns the old value of list, so when finished,
1970 * curwin->w_p_list should be set back to this.
1972 old_list = curwin->w_p_list;
1973 if (old_list && vim_strchr(p_cpo, CPO_LISTWM) == NULL)
1974 curwin->w_p_list = FALSE;
1977 * In virtual replace mode each character may replace one or more
1978 * characters (zero if it's a TAB). Count the number of bytes to
1979 * be deleted to make room for the new character, counting screen
1980 * cells. May result in adding spaces to fill a gap.
1982 getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL);
1983 #ifndef FEAT_MBYTE
1984 buf[0] = c;
1985 buf[1] = NUL;
1986 #endif
1987 new_vcol = vcol + chartabsize(buf, vcol);
1988 while (oldp[col + oldlen] != NUL && vcol < new_vcol)
1990 vcol += chartabsize(oldp + col + oldlen, vcol);
1991 /* Don't need to remove a TAB that takes us to the right
1992 * position. */
1993 if (vcol > new_vcol && oldp[col + oldlen] == TAB)
1994 break;
1995 #ifdef FEAT_MBYTE
1996 oldlen += (*mb_ptr2len)(oldp + col + oldlen);
1997 #else
1998 ++oldlen;
1999 #endif
2000 /* Deleted a bit too much, insert spaces. */
2001 if (vcol > new_vcol)
2002 newlen += vcol - new_vcol;
2004 curwin->w_p_list = old_list;
2006 else
2007 #endif
2008 if (oldp[col] != NUL)
2010 /* normal replace */
2011 #ifdef FEAT_MBYTE
2012 oldlen = (*mb_ptr2len)(oldp + col);
2013 #else
2014 oldlen = 1;
2015 #endif
2019 /* Push the replaced bytes onto the replace stack, so that they can be
2020 * put back when BS is used. The bytes of a multi-byte character are
2021 * done the other way around, so that the first byte is popped off
2022 * first (it tells the byte length of the character). */
2023 replace_push(NUL);
2024 for (i = 0; i < oldlen; ++i)
2026 #ifdef FEAT_MBYTE
2027 if (has_mbyte)
2028 i += replace_push_mb(oldp + col + i) - 1;
2029 else
2030 #endif
2031 replace_push(oldp[col + i]);
2035 newp = alloc_check((unsigned)(linelen + newlen - oldlen));
2036 if (newp == NULL)
2037 return;
2039 /* Copy bytes before the cursor. */
2040 if (col > 0)
2041 mch_memmove(newp, oldp, (size_t)col);
2043 /* Copy bytes after the changed character(s). */
2044 p = newp + col;
2045 mch_memmove(p + newlen, oldp + col + oldlen,
2046 (size_t)(linelen - col - oldlen));
2048 /* Insert or overwrite the new character. */
2049 #ifdef FEAT_MBYTE
2050 mch_memmove(p, buf, charlen);
2051 i = charlen;
2052 #else
2053 *p = c;
2054 i = 1;
2055 #endif
2057 /* Fill with spaces when necessary. */
2058 while (i < newlen)
2059 p[i++] = ' ';
2061 /* Replace the line in the buffer. */
2062 ml_replace(lnum, newp, FALSE);
2064 /* mark the buffer as changed and prepare for displaying */
2065 changed_bytes(lnum, col);
2068 * If we're in Insert or Replace mode and 'showmatch' is set, then briefly
2069 * show the match for right parens and braces.
2071 if (p_sm && (State & INSERT)
2072 && msg_silent == 0
2073 #ifdef FEAT_MBYTE
2074 && charlen == 1
2075 #endif
2076 #ifdef FEAT_INS_EXPAND
2077 && !ins_compl_active()
2078 #endif
2080 showmatch(c);
2082 #ifdef FEAT_RIGHTLEFT
2083 if (!p_ri || (State & REPLACE_FLAG))
2084 #endif
2086 /* Normal insert: move cursor right */
2087 #ifdef FEAT_MBYTE
2088 curwin->w_cursor.col += charlen;
2089 #else
2090 ++curwin->w_cursor.col;
2091 #endif
2094 * TODO: should try to update w_row here, to avoid recomputing it later.
2099 * Insert a string at the cursor position.
2100 * Note: Does NOT handle Replace mode.
2101 * Caller must have prepared for undo.
2103 void
2104 ins_str(s)
2105 char_u *s;
2107 char_u *oldp, *newp;
2108 int newlen = (int)STRLEN(s);
2109 int oldlen;
2110 colnr_T col;
2111 linenr_T lnum = curwin->w_cursor.lnum;
2113 #ifdef FEAT_VIRTUALEDIT
2114 if (virtual_active() && curwin->w_cursor.coladd > 0)
2115 coladvance_force(getviscol());
2116 #endif
2118 col = curwin->w_cursor.col;
2119 oldp = ml_get(lnum);
2120 oldlen = (int)STRLEN(oldp);
2122 newp = alloc_check((unsigned)(oldlen + newlen + 1));
2123 if (newp == NULL)
2124 return;
2125 if (col > 0)
2126 mch_memmove(newp, oldp, (size_t)col);
2127 mch_memmove(newp + col, s, (size_t)newlen);
2128 mch_memmove(newp + col + newlen, oldp + col, (size_t)(oldlen - col + 1));
2129 ml_replace(lnum, newp, FALSE);
2130 changed_bytes(lnum, col);
2131 curwin->w_cursor.col += newlen;
2135 * Delete one character under the cursor.
2136 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2137 * Caller must have prepared for undo.
2139 * return FAIL for failure, OK otherwise
2142 del_char(fixpos)
2143 int fixpos;
2145 #ifdef FEAT_MBYTE
2146 if (has_mbyte)
2148 /* Make sure the cursor is at the start of a character. */
2149 mb_adjust_cursor();
2150 if (*ml_get_cursor() == NUL)
2151 return FAIL;
2152 return del_chars(1L, fixpos);
2154 #endif
2155 return del_bytes(1L, fixpos, TRUE);
2158 #if defined(FEAT_MBYTE) || defined(PROTO)
2160 * Like del_bytes(), but delete characters instead of bytes.
2163 del_chars(count, fixpos)
2164 long count;
2165 int fixpos;
2167 long bytes = 0;
2168 long i;
2169 char_u *p;
2170 int l;
2172 p = ml_get_cursor();
2173 for (i = 0; i < count && *p != NUL; ++i)
2175 l = (*mb_ptr2len)(p);
2176 bytes += l;
2177 p += l;
2179 return del_bytes(bytes, fixpos, TRUE);
2181 #endif
2184 * Delete "count" bytes under the cursor.
2185 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2186 * Caller must have prepared for undo.
2188 * return FAIL for failure, OK otherwise
2190 /*ARGSUSED*/
2192 del_bytes(count, fixpos_arg, use_delcombine)
2193 long count;
2194 int fixpos_arg;
2195 int use_delcombine; /* 'delcombine' option applies */
2197 char_u *oldp, *newp;
2198 colnr_T oldlen;
2199 linenr_T lnum = curwin->w_cursor.lnum;
2200 colnr_T col = curwin->w_cursor.col;
2201 int was_alloced;
2202 long movelen;
2203 int fixpos = fixpos_arg;
2205 oldp = ml_get(lnum);
2206 oldlen = (int)STRLEN(oldp);
2209 * Can't do anything when the cursor is on the NUL after the line.
2211 if (col >= oldlen)
2212 return FAIL;
2214 #ifdef FEAT_MBYTE
2215 /* If 'delcombine' is set and deleting (less than) one character, only
2216 * delete the last combining character. */
2217 if (p_deco && use_delcombine && enc_utf8
2218 && utfc_ptr2len(oldp + col) >= count)
2220 int cc[MAX_MCO];
2221 int n;
2223 (void)utfc_ptr2char(oldp + col, cc);
2224 if (cc[0] != NUL)
2226 /* Find the last composing char, there can be several. */
2227 n = col;
2230 col = n;
2231 count = utf_ptr2len(oldp + n);
2232 n += count;
2233 } while (UTF_COMPOSINGLIKE(oldp + col, oldp + n));
2234 fixpos = 0;
2237 #endif
2240 * When count is too big, reduce it.
2242 movelen = (long)oldlen - (long)col - count + 1; /* includes trailing NUL */
2243 if (movelen <= 1)
2246 * If we just took off the last character of a non-blank line, and
2247 * fixpos is TRUE, we don't want to end up positioned at the NUL,
2248 * unless "restart_edit" is set or 'virtualedit' contains "onemore".
2250 if (col > 0 && fixpos && restart_edit == 0
2251 #ifdef FEAT_VIRTUALEDIT
2252 && (ve_flags & VE_ONEMORE) == 0
2253 #endif
2256 --curwin->w_cursor.col;
2257 #ifdef FEAT_VIRTUALEDIT
2258 curwin->w_cursor.coladd = 0;
2259 #endif
2260 #ifdef FEAT_MBYTE
2261 if (has_mbyte)
2262 curwin->w_cursor.col -=
2263 (*mb_head_off)(oldp, oldp + curwin->w_cursor.col);
2264 #endif
2266 count = oldlen - col;
2267 movelen = 1;
2271 * If the old line has been allocated the deletion can be done in the
2272 * existing line. Otherwise a new line has to be allocated
2274 was_alloced = ml_line_alloced(); /* check if oldp was allocated */
2275 #ifdef FEAT_NETBEANS_INTG
2276 if (was_alloced && usingNetbeans)
2277 netbeans_removed(curbuf, lnum, col, count);
2278 /* else is handled by ml_replace() */
2279 #endif
2280 if (was_alloced)
2281 newp = oldp; /* use same allocated memory */
2282 else
2283 { /* need to allocate a new line */
2284 newp = alloc((unsigned)(oldlen + 1 - count));
2285 if (newp == NULL)
2286 return FAIL;
2287 mch_memmove(newp, oldp, (size_t)col);
2289 mch_memmove(newp + col, oldp + col + count, (size_t)movelen);
2290 if (!was_alloced)
2291 ml_replace(lnum, newp, FALSE);
2293 /* mark the buffer as changed and prepare for displaying */
2294 changed_bytes(lnum, curwin->w_cursor.col);
2296 return OK;
2300 * Delete from cursor to end of line.
2301 * Caller must have prepared for undo.
2303 * return FAIL for failure, OK otherwise
2306 truncate_line(fixpos)
2307 int fixpos; /* if TRUE fix the cursor position when done */
2309 char_u *newp;
2310 linenr_T lnum = curwin->w_cursor.lnum;
2311 colnr_T col = curwin->w_cursor.col;
2313 if (col == 0)
2314 newp = vim_strsave((char_u *)"");
2315 else
2316 newp = vim_strnsave(ml_get(lnum), col);
2318 if (newp == NULL)
2319 return FAIL;
2321 ml_replace(lnum, newp, FALSE);
2323 /* mark the buffer as changed and prepare for displaying */
2324 changed_bytes(lnum, curwin->w_cursor.col);
2327 * If "fixpos" is TRUE we don't want to end up positioned at the NUL.
2329 if (fixpos && curwin->w_cursor.col > 0)
2330 --curwin->w_cursor.col;
2332 return OK;
2336 * Delete "nlines" lines at the cursor.
2337 * Saves the lines for undo first if "undo" is TRUE.
2339 void
2340 del_lines(nlines, undo)
2341 long nlines; /* number of lines to delete */
2342 int undo; /* if TRUE, prepare for undo */
2344 long n;
2346 if (nlines <= 0)
2347 return;
2349 /* save the deleted lines for undo */
2350 if (undo && u_savedel(curwin->w_cursor.lnum, nlines) == FAIL)
2351 return;
2353 for (n = 0; n < nlines; )
2355 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
2356 break;
2358 ml_delete(curwin->w_cursor.lnum, TRUE);
2359 ++n;
2361 /* If we delete the last line in the file, stop */
2362 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
2363 break;
2365 /* adjust marks, mark the buffer as changed and prepare for displaying */
2366 deleted_lines_mark(curwin->w_cursor.lnum, n);
2368 curwin->w_cursor.col = 0;
2369 check_cursor_lnum();
2373 gchar_pos(pos)
2374 pos_T *pos;
2376 char_u *ptr = ml_get_pos(pos);
2378 #ifdef FEAT_MBYTE
2379 if (has_mbyte)
2380 return (*mb_ptr2char)(ptr);
2381 #endif
2382 return (int)*ptr;
2386 gchar_cursor()
2388 #ifdef FEAT_MBYTE
2389 if (has_mbyte)
2390 return (*mb_ptr2char)(ml_get_cursor());
2391 #endif
2392 return (int)*ml_get_cursor();
2396 * Write a character at the current cursor position.
2397 * It is directly written into the block.
2399 void
2400 pchar_cursor(c)
2401 int c;
2403 *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
2404 + curwin->w_cursor.col) = c;
2407 #if 0 /* not used */
2409 * Put *pos at end of current buffer
2411 void
2412 goto_endofbuf(pos)
2413 pos_T *pos;
2415 char_u *p;
2417 pos->lnum = curbuf->b_ml.ml_line_count;
2418 pos->col = 0;
2419 p = ml_get(pos->lnum);
2420 while (*p++)
2421 ++pos->col;
2423 #endif
2426 * When extra == 0: Return TRUE if the cursor is before or on the first
2427 * non-blank in the line.
2428 * When extra == 1: Return TRUE if the cursor is before the first non-blank in
2429 * the line.
2432 inindent(extra)
2433 int extra;
2435 char_u *ptr;
2436 colnr_T col;
2438 for (col = 0, ptr = ml_get_curline(); vim_iswhite(*ptr); ++col)
2439 ++ptr;
2440 if (col >= curwin->w_cursor.col + extra)
2441 return TRUE;
2442 else
2443 return FALSE;
2447 * Skip to next part of an option argument: Skip space and comma.
2449 char_u *
2450 skip_to_option_part(p)
2451 char_u *p;
2453 if (*p == ',')
2454 ++p;
2455 while (*p == ' ')
2456 ++p;
2457 return p;
2461 * changed() is called when something in the current buffer is changed.
2463 * Most often called through changed_bytes() and changed_lines(), which also
2464 * mark the area of the display to be redrawn.
2466 void
2467 changed()
2469 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2470 /* The text of the preediting area is inserted, but this doesn't
2471 * mean a change of the buffer yet. That is delayed until the
2472 * text is committed. (this means preedit becomes empty) */
2473 if (im_is_preediting() && !xim_changed_while_preediting)
2474 return;
2475 xim_changed_while_preediting = FALSE;
2476 #endif
2478 if (!curbuf->b_changed)
2480 int save_msg_scroll = msg_scroll;
2482 /* Give a warning about changing a read-only file. This may also
2483 * check-out the file, thus change "curbuf"! */
2484 change_warning(0);
2486 /* Create a swap file if that is wanted.
2487 * Don't do this for "nofile" and "nowrite" buffer types. */
2488 if (curbuf->b_may_swap
2489 #ifdef FEAT_QUICKFIX
2490 && !bt_dontwrite(curbuf)
2491 #endif
2494 ml_open_file(curbuf);
2496 /* The ml_open_file() can cause an ATTENTION message.
2497 * Wait two seconds, to make sure the user reads this unexpected
2498 * message. Since we could be anywhere, call wait_return() now,
2499 * and don't let the emsg() set msg_scroll. */
2500 if (need_wait_return && emsg_silent == 0)
2502 out_flush();
2503 ui_delay(2000L, TRUE);
2504 wait_return(TRUE);
2505 msg_scroll = save_msg_scroll;
2508 curbuf->b_changed = TRUE;
2509 ml_setflags(curbuf);
2510 #ifdef FEAT_WINDOWS
2511 check_status(curbuf);
2512 redraw_tabline = TRUE;
2513 #endif
2514 #ifdef FEAT_TITLE
2515 need_maketitle = TRUE; /* set window title later */
2516 #endif
2518 ++curbuf->b_changedtick;
2521 static void changedOneline __ARGS((buf_T *buf, linenr_T lnum));
2522 static void changed_lines_buf __ARGS((buf_T *buf, linenr_T lnum, linenr_T lnume, long xtra));
2523 static void changed_common __ARGS((linenr_T lnum, colnr_T col, linenr_T lnume, long xtra));
2526 * Changed bytes within a single line for the current buffer.
2527 * - marks the windows on this buffer to be redisplayed
2528 * - marks the buffer changed by calling changed()
2529 * - invalidates cached values
2531 void
2532 changed_bytes(lnum, col)
2533 linenr_T lnum;
2534 colnr_T col;
2536 changedOneline(curbuf, lnum);
2537 changed_common(lnum, col, lnum + 1, 0L);
2539 #ifdef FEAT_DIFF
2540 /* Diff highlighting in other diff windows may need to be updated too. */
2541 if (curwin->w_p_diff)
2543 win_T *wp;
2544 linenr_T wlnum;
2546 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2547 if (wp->w_p_diff && wp != curwin)
2549 redraw_win_later(wp, VALID);
2550 wlnum = diff_lnum_win(lnum, wp);
2551 if (wlnum > 0)
2552 changedOneline(wp->w_buffer, wlnum);
2555 #endif
2558 static void
2559 changedOneline(buf, lnum)
2560 buf_T *buf;
2561 linenr_T lnum;
2563 if (buf->b_mod_set)
2565 /* find the maximum area that must be redisplayed */
2566 if (lnum < buf->b_mod_top)
2567 buf->b_mod_top = lnum;
2568 else if (lnum >= buf->b_mod_bot)
2569 buf->b_mod_bot = lnum + 1;
2571 else
2573 /* set the area that must be redisplayed to one line */
2574 buf->b_mod_set = TRUE;
2575 buf->b_mod_top = lnum;
2576 buf->b_mod_bot = lnum + 1;
2577 buf->b_mod_xlines = 0;
2582 * Appended "count" lines below line "lnum" in the current buffer.
2583 * Must be called AFTER the change and after mark_adjust().
2584 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2586 void
2587 appended_lines(lnum, count)
2588 linenr_T lnum;
2589 long count;
2591 changed_lines(lnum + 1, 0, lnum + 1, count);
2595 * Like appended_lines(), but adjust marks first.
2597 void
2598 appended_lines_mark(lnum, count)
2599 linenr_T lnum;
2600 long count;
2602 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, count, 0L);
2603 changed_lines(lnum + 1, 0, lnum + 1, count);
2607 * Deleted "count" lines at line "lnum" in the current buffer.
2608 * Must be called AFTER the change and after mark_adjust().
2609 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2611 void
2612 deleted_lines(lnum, count)
2613 linenr_T lnum;
2614 long count;
2616 changed_lines(lnum, 0, lnum + count, -count);
2620 * Like deleted_lines(), but adjust marks first.
2622 void
2623 deleted_lines_mark(lnum, count)
2624 linenr_T lnum;
2625 long count;
2627 mark_adjust(lnum, (linenr_T)(lnum + count - 1), (long)MAXLNUM, -count);
2628 changed_lines(lnum, 0, lnum + count, -count);
2632 * Changed lines for the current buffer.
2633 * Must be called AFTER the change and after mark_adjust().
2634 * - mark the buffer changed by calling changed()
2635 * - mark the windows on this buffer to be redisplayed
2636 * - invalidate cached values
2637 * "lnum" is the first line that needs displaying, "lnume" the first line
2638 * below the changed lines (BEFORE the change).
2639 * When only inserting lines, "lnum" and "lnume" are equal.
2640 * Takes care of calling changed() and updating b_mod_*.
2642 void
2643 changed_lines(lnum, col, lnume, xtra)
2644 linenr_T lnum; /* first line with change */
2645 colnr_T col; /* column in first line with change */
2646 linenr_T lnume; /* line below last changed line */
2647 long xtra; /* number of extra lines (negative when deleting) */
2649 changed_lines_buf(curbuf, lnum, lnume, xtra);
2651 #ifdef FEAT_DIFF
2652 if (xtra == 0 && curwin->w_p_diff)
2654 /* When the number of lines doesn't change then mark_adjust() isn't
2655 * called and other diff buffers still need to be marked for
2656 * displaying. */
2657 win_T *wp;
2658 linenr_T wlnum;
2660 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2661 if (wp->w_p_diff && wp != curwin)
2663 redraw_win_later(wp, VALID);
2664 wlnum = diff_lnum_win(lnum, wp);
2665 if (wlnum > 0)
2666 changed_lines_buf(wp->w_buffer, wlnum,
2667 lnume - lnum + wlnum, 0L);
2670 #endif
2672 changed_common(lnum, col, lnume, xtra);
2675 static void
2676 changed_lines_buf(buf, lnum, lnume, xtra)
2677 buf_T *buf;
2678 linenr_T lnum; /* first line with change */
2679 linenr_T lnume; /* line below last changed line */
2680 long xtra; /* number of extra lines (negative when deleting) */
2682 if (buf->b_mod_set)
2684 /* find the maximum area that must be redisplayed */
2685 if (lnum < buf->b_mod_top)
2686 buf->b_mod_top = lnum;
2687 if (lnum < buf->b_mod_bot)
2689 /* adjust old bot position for xtra lines */
2690 buf->b_mod_bot += xtra;
2691 if (buf->b_mod_bot < lnum)
2692 buf->b_mod_bot = lnum;
2694 if (lnume + xtra > buf->b_mod_bot)
2695 buf->b_mod_bot = lnume + xtra;
2696 buf->b_mod_xlines += xtra;
2698 else
2700 /* set the area that must be redisplayed */
2701 buf->b_mod_set = TRUE;
2702 buf->b_mod_top = lnum;
2703 buf->b_mod_bot = lnume + xtra;
2704 buf->b_mod_xlines = xtra;
2708 static void
2709 changed_common(lnum, col, lnume, xtra)
2710 linenr_T lnum;
2711 colnr_T col;
2712 linenr_T lnume;
2713 long xtra;
2715 win_T *wp;
2716 int i;
2717 #ifdef FEAT_JUMPLIST
2718 int cols;
2719 pos_T *p;
2720 int add;
2721 #endif
2723 /* mark the buffer as modified */
2724 changed();
2726 /* set the '. mark */
2727 if (!cmdmod.keepjumps)
2729 curbuf->b_last_change.lnum = lnum;
2730 curbuf->b_last_change.col = col;
2732 #ifdef FEAT_JUMPLIST
2733 /* Create a new entry if a new undo-able change was started or we
2734 * don't have an entry yet. */
2735 if (curbuf->b_new_change || curbuf->b_changelistlen == 0)
2737 if (curbuf->b_changelistlen == 0)
2738 add = TRUE;
2739 else
2741 /* Don't create a new entry when the line number is the same
2742 * as the last one and the column is not too far away. Avoids
2743 * creating many entries for typing "xxxxx". */
2744 p = &curbuf->b_changelist[curbuf->b_changelistlen - 1];
2745 if (p->lnum != lnum)
2746 add = TRUE;
2747 else
2749 cols = comp_textwidth(FALSE);
2750 if (cols == 0)
2751 cols = 79;
2752 add = (p->col + cols < col || col + cols < p->col);
2755 if (add)
2757 /* This is the first of a new sequence of undo-able changes
2758 * and it's at some distance of the last change. Use a new
2759 * position in the changelist. */
2760 curbuf->b_new_change = FALSE;
2762 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2764 /* changelist is full: remove oldest entry */
2765 curbuf->b_changelistlen = JUMPLISTSIZE - 1;
2766 mch_memmove(curbuf->b_changelist, curbuf->b_changelist + 1,
2767 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2768 FOR_ALL_WINDOWS(wp)
2770 /* Correct position in changelist for other windows on
2771 * this buffer. */
2772 if (wp->w_buffer == curbuf && wp->w_changelistidx > 0)
2773 --wp->w_changelistidx;
2776 FOR_ALL_WINDOWS(wp)
2778 /* For other windows, if the position in the changelist is
2779 * at the end it stays at the end. */
2780 if (wp->w_buffer == curbuf
2781 && wp->w_changelistidx == curbuf->b_changelistlen)
2782 ++wp->w_changelistidx;
2784 ++curbuf->b_changelistlen;
2787 curbuf->b_changelist[curbuf->b_changelistlen - 1] =
2788 curbuf->b_last_change;
2789 /* The current window is always after the last change, so that "g,"
2790 * takes you back to it. */
2791 curwin->w_changelistidx = curbuf->b_changelistlen;
2792 #endif
2795 FOR_ALL_WINDOWS(wp)
2797 if (wp->w_buffer == curbuf)
2799 /* Mark this window to be redrawn later. */
2800 if (wp->w_redr_type < VALID)
2801 wp->w_redr_type = VALID;
2803 /* Check if a change in the buffer has invalidated the cached
2804 * values for the cursor. */
2805 #ifdef FEAT_FOLDING
2807 * Update the folds for this window. Can't postpone this, because
2808 * a following operator might work on the whole fold: ">>dd".
2810 foldUpdate(wp, lnum, lnume + xtra - 1);
2812 /* The change may cause lines above or below the change to become
2813 * included in a fold. Set lnum/lnume to the first/last line that
2814 * might be displayed differently.
2815 * Set w_cline_folded here as an efficient way to update it when
2816 * inserting lines just above a closed fold. */
2817 i = hasFoldingWin(wp, lnum, &lnum, NULL, FALSE, NULL);
2818 if (wp->w_cursor.lnum == lnum)
2819 wp->w_cline_folded = i;
2820 i = hasFoldingWin(wp, lnume, NULL, &lnume, FALSE, NULL);
2821 if (wp->w_cursor.lnum == lnume)
2822 wp->w_cline_folded = i;
2824 /* If the changed line is in a range of previously folded lines,
2825 * compare with the first line in that range. */
2826 if (wp->w_cursor.lnum <= lnum)
2828 i = find_wl_entry(wp, lnum);
2829 if (i >= 0 && wp->w_cursor.lnum > wp->w_lines[i].wl_lnum)
2830 changed_line_abv_curs_win(wp);
2832 #endif
2834 if (wp->w_cursor.lnum > lnum)
2835 changed_line_abv_curs_win(wp);
2836 else if (wp->w_cursor.lnum == lnum && wp->w_cursor.col >= col)
2837 changed_cline_bef_curs_win(wp);
2838 if (wp->w_botline >= lnum)
2840 /* Assume that botline doesn't change (inserted lines make
2841 * other lines scroll down below botline). */
2842 approximate_botline_win(wp);
2845 /* Check if any w_lines[] entries have become invalid.
2846 * For entries below the change: Correct the lnums for
2847 * inserted/deleted lines. Makes it possible to stop displaying
2848 * after the change. */
2849 for (i = 0; i < wp->w_lines_valid; ++i)
2850 if (wp->w_lines[i].wl_valid)
2852 if (wp->w_lines[i].wl_lnum >= lnum)
2854 if (wp->w_lines[i].wl_lnum < lnume)
2856 /* line included in change */
2857 wp->w_lines[i].wl_valid = FALSE;
2859 else if (xtra != 0)
2861 /* line below change */
2862 wp->w_lines[i].wl_lnum += xtra;
2863 #ifdef FEAT_FOLDING
2864 wp->w_lines[i].wl_lastlnum += xtra;
2865 #endif
2868 #ifdef FEAT_FOLDING
2869 else if (wp->w_lines[i].wl_lastlnum >= lnum)
2871 /* change somewhere inside this range of folded lines,
2872 * may need to be redrawn */
2873 wp->w_lines[i].wl_valid = FALSE;
2875 #endif
2880 /* Call update_screen() later, which checks out what needs to be redrawn,
2881 * since it notices b_mod_set and then uses b_mod_*. */
2882 if (must_redraw < VALID)
2883 must_redraw = VALID;
2885 #ifdef FEAT_AUTOCMD
2886 /* when the cursor line is changed always trigger CursorMoved */
2887 if (lnum <= curwin->w_cursor.lnum
2888 && lnume + (xtra < 0 ? -xtra : xtra) > curwin->w_cursor.lnum)
2889 last_cursormoved.lnum = 0;
2890 #endif
2894 * unchanged() is called when the changed flag must be reset for buffer 'buf'
2896 void
2897 unchanged(buf, ff)
2898 buf_T *buf;
2899 int ff; /* also reset 'fileformat' */
2901 if (buf->b_changed || (ff && file_ff_differs(buf)))
2903 buf->b_changed = 0;
2904 ml_setflags(buf);
2905 if (ff)
2906 save_file_ff(buf);
2907 #ifdef FEAT_WINDOWS
2908 check_status(buf);
2909 redraw_tabline = TRUE;
2910 #endif
2911 #ifdef FEAT_TITLE
2912 need_maketitle = TRUE; /* set window title later */
2913 #endif
2915 ++buf->b_changedtick;
2916 #ifdef FEAT_NETBEANS_INTG
2917 netbeans_unmodified(buf);
2918 #endif
2921 #if defined(FEAT_WINDOWS) || defined(PROTO)
2923 * check_status: called when the status bars for the buffer 'buf'
2924 * need to be updated
2926 void
2927 check_status(buf)
2928 buf_T *buf;
2930 win_T *wp;
2932 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2933 if (wp->w_buffer == buf && wp->w_status_height)
2935 wp->w_redr_status = TRUE;
2936 if (must_redraw < VALID)
2937 must_redraw = VALID;
2940 #endif
2943 * If the file is readonly, give a warning message with the first change.
2944 * Don't do this for autocommands.
2945 * Don't use emsg(), because it flushes the macro buffer.
2946 * If we have undone all changes b_changed will be FALSE, but "b_did_warn"
2947 * will be TRUE.
2949 void
2950 change_warning(col)
2951 int col; /* column for message; non-zero when in insert
2952 mode and 'showmode' is on */
2954 if (curbuf->b_did_warn == FALSE
2955 && curbufIsChanged() == 0
2956 #ifdef FEAT_AUTOCMD
2957 && !autocmd_busy
2958 #endif
2959 && curbuf->b_p_ro)
2961 #ifdef FEAT_AUTOCMD
2962 ++curbuf_lock;
2963 apply_autocmds(EVENT_FILECHANGEDRO, NULL, NULL, FALSE, curbuf);
2964 --curbuf_lock;
2965 if (!curbuf->b_p_ro)
2966 return;
2967 #endif
2969 * Do what msg() does, but with a column offset if the warning should
2970 * be after the mode message.
2972 msg_start();
2973 if (msg_row == Rows - 1)
2974 msg_col = col;
2975 msg_source(hl_attr(HLF_W));
2976 MSG_PUTS_ATTR(_("W10: Warning: Changing a readonly file"),
2977 hl_attr(HLF_W) | MSG_HIST);
2978 msg_clr_eos();
2979 (void)msg_end();
2980 if (msg_silent == 0 && !silent_mode)
2982 out_flush();
2983 ui_delay(1000L, TRUE); /* give the user time to think about it */
2985 curbuf->b_did_warn = TRUE;
2986 redraw_cmdline = FALSE; /* don't redraw and erase the message */
2987 if (msg_row < Rows - 1)
2988 showmode();
2993 * Ask for a reply from the user, a 'y' or a 'n'.
2994 * No other characters are accepted, the message is repeated until a valid
2995 * reply is entered or CTRL-C is hit.
2996 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
2997 * from any buffers but directly from the user.
2999 * return the 'y' or 'n'
3002 ask_yesno(str, direct)
3003 char_u *str;
3004 int direct;
3006 int r = ' ';
3007 int save_State = State;
3009 if (exiting) /* put terminal in raw mode for this question */
3010 settmode(TMODE_RAW);
3011 ++no_wait_return;
3012 #ifdef USE_ON_FLY_SCROLL
3013 dont_scroll = TRUE; /* disallow scrolling here */
3014 #endif
3015 State = CONFIRM; /* mouse behaves like with :confirm */
3016 #ifdef FEAT_MOUSE
3017 setmouse(); /* disables mouse for xterm */
3018 #endif
3019 ++no_mapping;
3020 ++allow_keys; /* no mapping here, but recognize keys */
3022 while (r != 'y' && r != 'n')
3024 /* same highlighting as for wait_return */
3025 smsg_attr(hl_attr(HLF_R), (char_u *)"%s (y/n)?", str);
3026 if (direct)
3027 r = get_keystroke();
3028 else
3029 r = plain_vgetc();
3030 if (r == Ctrl_C || r == ESC)
3031 r = 'n';
3032 msg_putchar(r); /* show what you typed */
3033 out_flush();
3035 --no_wait_return;
3036 State = save_State;
3037 #ifdef FEAT_MOUSE
3038 setmouse();
3039 #endif
3040 --no_mapping;
3041 --allow_keys;
3043 return r;
3047 * Get a key stroke directly from the user.
3048 * Ignores mouse clicks and scrollbar events, except a click for the left
3049 * button (used at the more prompt).
3050 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
3051 * Disadvantage: typeahead is ignored.
3052 * Translates the interrupt character for unix to ESC.
3055 get_keystroke()
3057 #define CBUFLEN 151
3058 char_u buf[CBUFLEN];
3059 int len = 0;
3060 int n;
3061 int save_mapped_ctrl_c = mapped_ctrl_c;
3062 int waited = 0;
3064 mapped_ctrl_c = FALSE; /* mappings are not used here */
3065 for (;;)
3067 cursor_on();
3068 out_flush();
3070 /* First time: blocking wait. Second time: wait up to 100ms for a
3071 * terminal code to complete. Leave some room for check_termcode() to
3072 * insert a key code into (max 5 chars plus NUL). And
3073 * fix_input_buffer() can triple the number of bytes. */
3074 n = ui_inchar(buf + len, (CBUFLEN - 6 - len) / 3,
3075 len == 0 ? -1L : 100L, 0);
3076 if (n > 0)
3078 /* Replace zero and CSI by a special key code. */
3079 n = fix_input_buffer(buf + len, n, FALSE);
3080 len += n;
3081 waited = 0;
3083 else if (len > 0)
3084 ++waited; /* keep track of the waiting time */
3086 /* Incomplete termcode and not timed out yet: get more characters */
3087 if ((n = check_termcode(1, buf, len)) < 0
3088 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
3089 continue;
3091 /* found a termcode: adjust length */
3092 if (n > 0)
3093 len = n;
3094 if (len == 0) /* nothing typed yet */
3095 continue;
3097 /* Handle modifier and/or special key code. */
3098 n = buf[0];
3099 if (n == K_SPECIAL)
3101 n = TO_SPECIAL(buf[1], buf[2]);
3102 if (buf[1] == KS_MODIFIER
3103 || n == K_IGNORE
3104 #ifdef FEAT_MOUSE
3105 || n == K_LEFTMOUSE_NM
3106 || n == K_LEFTDRAG
3107 || n == K_LEFTRELEASE
3108 || n == K_LEFTRELEASE_NM
3109 || n == K_MIDDLEMOUSE
3110 || n == K_MIDDLEDRAG
3111 || n == K_MIDDLERELEASE
3112 || n == K_RIGHTMOUSE
3113 || n == K_RIGHTDRAG
3114 || n == K_RIGHTRELEASE
3115 || n == K_MOUSEDOWN
3116 || n == K_MOUSEUP
3117 || n == K_X1MOUSE
3118 || n == K_X1DRAG
3119 || n == K_X1RELEASE
3120 || n == K_X2MOUSE
3121 || n == K_X2DRAG
3122 || n == K_X2RELEASE
3123 # ifdef FEAT_GUI
3124 || n == K_VER_SCROLLBAR
3125 || n == K_HOR_SCROLLBAR
3126 # endif
3127 #endif
3130 if (buf[1] == KS_MODIFIER)
3131 mod_mask = buf[2];
3132 len -= 3;
3133 if (len > 0)
3134 mch_memmove(buf, buf + 3, (size_t)len);
3135 continue;
3137 break;
3139 #ifdef FEAT_MBYTE
3140 if (has_mbyte)
3142 if (MB_BYTE2LEN(n) > len)
3143 continue; /* more bytes to get */
3144 buf[len >= CBUFLEN ? CBUFLEN - 1 : len] = NUL;
3145 n = (*mb_ptr2char)(buf);
3147 #endif
3148 #ifdef UNIX
3149 if (n == intr_char)
3150 n = ESC;
3151 #endif
3152 break;
3155 mapped_ctrl_c = save_mapped_ctrl_c;
3156 return n;
3160 * Get a number from the user.
3161 * When "mouse_used" is not NULL allow using the mouse.
3164 get_number(colon, mouse_used)
3165 int colon; /* allow colon to abort */
3166 int *mouse_used;
3168 int n = 0;
3169 int c;
3170 int typed = 0;
3172 if (mouse_used != NULL)
3173 *mouse_used = FALSE;
3175 /* When not printing messages, the user won't know what to type, return a
3176 * zero (as if CR was hit). */
3177 if (msg_silent != 0)
3178 return 0;
3180 #ifdef USE_ON_FLY_SCROLL
3181 dont_scroll = TRUE; /* disallow scrolling here */
3182 #endif
3183 ++no_mapping;
3184 ++allow_keys; /* no mapping here, but recognize keys */
3185 for (;;)
3187 windgoto(msg_row, msg_col);
3188 c = safe_vgetc();
3189 if (VIM_ISDIGIT(c))
3191 n = n * 10 + c - '0';
3192 msg_putchar(c);
3193 ++typed;
3195 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
3197 if (typed > 0)
3199 MSG_PUTS("\b \b");
3200 --typed;
3202 n /= 10;
3204 #ifdef FEAT_MOUSE
3205 else if (mouse_used != NULL && c == K_LEFTMOUSE)
3207 *mouse_used = TRUE;
3208 n = mouse_row + 1;
3209 break;
3211 #endif
3212 else if (n == 0 && c == ':' && colon)
3214 stuffcharReadbuff(':');
3215 if (!exmode_active)
3216 cmdline_row = msg_row;
3217 skip_redraw = TRUE; /* skip redraw once */
3218 do_redraw = FALSE;
3219 break;
3221 else if (c == CAR || c == NL || c == Ctrl_C || c == ESC)
3222 break;
3224 --no_mapping;
3225 --allow_keys;
3226 return n;
3230 * Ask the user to enter a number.
3231 * When "mouse_used" is not NULL allow using the mouse and in that case return
3232 * the line number.
3235 prompt_for_number(mouse_used)
3236 int *mouse_used;
3238 int i;
3239 int save_cmdline_row;
3240 int save_State;
3242 /* When using ":silent" assume that <CR> was entered. */
3243 if (mouse_used != NULL)
3244 MSG_PUTS(_("Type number or click with mouse (<Enter> cancels): "));
3245 else
3246 MSG_PUTS(_("Choice number (<Enter> cancels): "));
3248 /* Set the state such that text can be selected/copied/pasted and we still
3249 * get mouse events. */
3250 save_cmdline_row = cmdline_row;
3251 cmdline_row = 0;
3252 save_State = State;
3253 State = CMDLINE;
3255 i = get_number(TRUE, mouse_used);
3256 if (KeyTyped)
3258 /* don't call wait_return() now */
3259 /* msg_putchar('\n'); */
3260 cmdline_row = msg_row - 1;
3261 need_wait_return = FALSE;
3262 msg_didany = FALSE;
3264 else
3265 cmdline_row = save_cmdline_row;
3266 State = save_State;
3268 return i;
3271 void
3272 msgmore(n)
3273 long n;
3275 long pn;
3277 if (global_busy /* no messages now, wait until global is finished */
3278 || !messaging()) /* 'lazyredraw' set, don't do messages now */
3279 return;
3281 /* We don't want to overwrite another important message, but do overwrite
3282 * a previous "more lines" or "fewer lines" message, so that "5dd" and
3283 * then "put" reports the last action. */
3284 if (keep_msg != NULL && !keep_msg_more)
3285 return;
3287 if (n > 0)
3288 pn = n;
3289 else
3290 pn = -n;
3292 if (pn > p_report)
3294 if (pn == 1)
3296 if (n > 0)
3297 STRCPY(msg_buf, _("1 more line"));
3298 else
3299 STRCPY(msg_buf, _("1 line less"));
3301 else
3303 if (n > 0)
3304 sprintf((char *)msg_buf, _("%ld more lines"), pn);
3305 else
3306 sprintf((char *)msg_buf, _("%ld fewer lines"), pn);
3308 if (got_int)
3309 STRCAT(msg_buf, _(" (Interrupted)"));
3310 if (msg(msg_buf))
3312 set_keep_msg(msg_buf, 0);
3313 keep_msg_more = TRUE;
3319 * flush map and typeahead buffers and give a warning for an error
3321 void
3322 beep_flush()
3324 if (emsg_silent == 0)
3326 flush_buffers(FALSE);
3327 vim_beep();
3332 * give a warning for an error
3334 void
3335 vim_beep()
3337 if (emsg_silent == 0)
3339 if (p_vb
3340 #ifdef FEAT_GUI
3341 /* While the GUI is starting up the termcap is set for the GUI
3342 * but the output still goes to a terminal. */
3343 && !(gui.in_use && gui.starting)
3344 #endif
3347 out_str(T_VB);
3349 else
3351 #ifdef MSDOS
3353 * The number of beeps outputted is reduced to avoid having to wait
3354 * for all the beeps to finish. This is only a problem on systems
3355 * where the beeps don't overlap.
3357 if (beep_count == 0 || beep_count == 10)
3359 out_char(BELL);
3360 beep_count = 1;
3362 else
3363 ++beep_count;
3364 #else
3365 out_char(BELL);
3366 #endif
3369 /* When 'verbose' is set and we are sourcing a script or executing a
3370 * function give the user a hint where the beep comes from. */
3371 if (vim_strchr(p_debug, 'e') != NULL)
3373 msg_source(hl_attr(HLF_W));
3374 msg_attr((char_u *)_("Beep!"), hl_attr(HLF_W));
3380 * To get the "real" home directory:
3381 * - get value of $HOME
3382 * For Unix:
3383 * - go to that directory
3384 * - do mch_dirname() to get the real name of that directory.
3385 * This also works with mounts and links.
3386 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
3388 static char_u *homedir = NULL;
3390 void
3391 init_homedir()
3393 char_u *var;
3395 /* In case we are called a second time (when 'encoding' changes). */
3396 vim_free(homedir);
3397 homedir = NULL;
3399 #ifdef VMS
3400 var = mch_getenv((char_u *)"SYS$LOGIN");
3401 #else
3402 var = mch_getenv((char_u *)"HOME");
3403 #endif
3405 if (var != NULL && *var == NUL) /* empty is same as not set */
3406 var = NULL;
3408 #ifdef WIN3264
3410 * Weird but true: $HOME may contain an indirect reference to another
3411 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
3412 * when $HOME is being set.
3414 if (var != NULL && *var == '%')
3416 char_u *p;
3417 char_u *exp;
3419 p = vim_strchr(var + 1, '%');
3420 if (p != NULL)
3422 vim_strncpy(NameBuff, var + 1, p - (var + 1));
3423 exp = mch_getenv(NameBuff);
3424 if (exp != NULL && *exp != NUL
3425 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
3427 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
3428 var = NameBuff;
3429 /* Also set $HOME, it's needed for _viminfo. */
3430 vim_setenv((char_u *)"HOME", NameBuff);
3436 * Typically, $HOME is not defined on Windows, unless the user has
3437 * specifically defined it for Vim's sake. However, on Windows NT
3438 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
3439 * each user. Try constructing $HOME from these.
3441 if (var == NULL)
3443 char_u *homedrive, *homepath;
3445 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
3446 homepath = mch_getenv((char_u *)"HOMEPATH");
3447 if (homedrive != NULL && homepath != NULL
3448 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
3450 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
3451 if (NameBuff[0] != NUL)
3453 var = NameBuff;
3454 /* Also set $HOME, it's needed for _viminfo. */
3455 vim_setenv((char_u *)"HOME", NameBuff);
3460 # if defined(FEAT_MBYTE)
3461 if (enc_utf8 && var != NULL)
3463 int len;
3464 char_u *pp;
3466 /* Convert from active codepage to UTF-8. Other conversions are
3467 * not done, because they would fail for non-ASCII characters. */
3468 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
3469 if (pp != NULL)
3471 homedir = pp;
3472 return;
3475 # endif
3476 #endif
3478 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3480 * Default home dir is C:/
3481 * Best assumption we can make in such a situation.
3483 if (var == NULL)
3484 var = "C:/";
3485 #endif
3486 if (var != NULL)
3488 #ifdef UNIX
3490 * Change to the directory and get the actual path. This resolves
3491 * links. Don't do it when we can't return.
3493 if (mch_dirname(NameBuff, MAXPATHL) == OK
3494 && mch_chdir((char *)NameBuff) == 0)
3496 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
3497 var = IObuff;
3498 if (mch_chdir((char *)NameBuff) != 0)
3499 EMSG(_(e_prev_dir));
3501 #endif
3502 homedir = vim_strsave(var);
3506 #if defined(EXITFREE) || defined(PROTO)
3507 void
3508 free_homedir()
3510 vim_free(homedir);
3512 #endif
3515 * Call expand_env() and store the result in an allocated string.
3516 * This is not very memory efficient, this expects the result to be freed
3517 * again soon.
3519 char_u *
3520 expand_env_save(src)
3521 char_u *src;
3523 return expand_env_save_opt(src, FALSE);
3527 * Idem, but when "one" is TRUE handle the string as one file name, only
3528 * expand "~" at the start.
3530 char_u *
3531 expand_env_save_opt(src, one)
3532 char_u *src;
3533 int one;
3535 char_u *p;
3537 p = alloc(MAXPATHL);
3538 if (p != NULL)
3539 expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
3540 return p;
3544 * Expand environment variable with path name.
3545 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
3546 * Skips over "\ ", "\~" and "\$" (not for Win32 though).
3547 * If anything fails no expansion is done and dst equals src.
3549 void
3550 expand_env(src, dst, dstlen)
3551 char_u *src; /* input string e.g. "$HOME/vim.hlp" */
3552 char_u *dst; /* where to put the result */
3553 int dstlen; /* maximum length of the result */
3555 expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
3558 void
3559 expand_env_esc(srcp, dst, dstlen, esc, one, startstr)
3560 char_u *srcp; /* input string e.g. "$HOME/vim.hlp" */
3561 char_u *dst; /* where to put the result */
3562 int dstlen; /* maximum length of the result */
3563 int esc; /* escape spaces in expanded variables */
3564 int one; /* "srcp" is one file name */
3565 char_u *startstr; /* start again after this (can be NULL) */
3567 char_u *src;
3568 char_u *tail;
3569 int c;
3570 char_u *var;
3571 int copy_char;
3572 int mustfree; /* var was allocated, need to free it later */
3573 int at_start = TRUE; /* at start of a name */
3574 int startstr_len = 0;
3576 if (startstr != NULL)
3577 startstr_len = (int)STRLEN(startstr);
3579 src = skipwhite(srcp);
3580 --dstlen; /* leave one char space for "\," */
3581 while (*src && dstlen > 0)
3583 copy_char = TRUE;
3584 if ((*src == '$'
3585 #ifdef VMS
3586 && at_start
3587 #endif
3589 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3590 || *src == '%'
3591 #endif
3592 || (*src == '~' && at_start))
3594 mustfree = FALSE;
3597 * The variable name is copied into dst temporarily, because it may
3598 * be a string in read-only memory and a NUL needs to be appended.
3600 if (*src != '~') /* environment var */
3602 tail = src + 1;
3603 var = dst;
3604 c = dstlen - 1;
3606 #ifdef UNIX
3607 /* Unix has ${var-name} type environment vars */
3608 if (*tail == '{' && !vim_isIDc('{'))
3610 tail++; /* ignore '{' */
3611 while (c-- > 0 && *tail && *tail != '}')
3612 *var++ = *tail++;
3614 else
3615 #endif
3617 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
3618 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3619 || (*src == '%' && *tail != '%')
3620 #endif
3623 #ifdef OS2 /* env vars only in uppercase */
3624 *var++ = TOUPPER_LOC(*tail);
3625 tail++; /* toupper() may be a macro! */
3626 #else
3627 *var++ = *tail++;
3628 #endif
3632 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3633 # ifdef UNIX
3634 if (src[1] == '{' && *tail != '}')
3635 # else
3636 if (*src == '%' && *tail != '%')
3637 # endif
3638 var = NULL;
3639 else
3641 # ifdef UNIX
3642 if (src[1] == '{')
3643 # else
3644 if (*src == '%')
3645 #endif
3646 ++tail;
3647 #endif
3648 *var = NUL;
3649 var = vim_getenv(dst, &mustfree);
3650 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3652 #endif
3654 /* home directory */
3655 else if ( src[1] == NUL
3656 || vim_ispathsep(src[1])
3657 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
3659 var = homedir;
3660 tail = src + 1;
3662 else /* user directory */
3664 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
3666 * Copy ~user to dst[], so we can put a NUL after it.
3668 tail = src;
3669 var = dst;
3670 c = dstlen - 1;
3671 while ( c-- > 0
3672 && *tail
3673 && vim_isfilec(*tail)
3674 && !vim_ispathsep(*tail))
3675 *var++ = *tail++;
3676 *var = NUL;
3677 # ifdef UNIX
3679 * If the system supports getpwnam(), use it.
3680 * Otherwise, or if getpwnam() fails, the shell is used to
3681 * expand ~user. This is slower and may fail if the shell
3682 * does not support ~user (old versions of /bin/sh).
3684 # if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
3686 struct passwd *pw;
3688 /* Note: memory allocated by getpwnam() is never freed.
3689 * Calling endpwent() apparently doesn't help. */
3690 pw = getpwnam((char *)dst + 1);
3691 if (pw != NULL)
3692 var = (char_u *)pw->pw_dir;
3693 else
3694 var = NULL;
3696 if (var == NULL)
3697 # endif
3699 expand_T xpc;
3701 ExpandInit(&xpc);
3702 xpc.xp_context = EXPAND_FILES;
3703 var = ExpandOne(&xpc, dst, NULL,
3704 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
3705 mustfree = TRUE;
3708 # else /* !UNIX, thus VMS */
3710 * USER_HOME is a comma-separated list of
3711 * directories to search for the user account in.
3714 char_u test[MAXPATHL], paths[MAXPATHL];
3715 char_u *path, *next_path, *ptr;
3716 struct stat st;
3718 STRCPY(paths, USER_HOME);
3719 next_path = paths;
3720 while (*next_path)
3722 for (path = next_path; *next_path && *next_path != ',';
3723 next_path++);
3724 if (*next_path)
3725 *next_path++ = NUL;
3726 STRCPY(test, path);
3727 STRCAT(test, "/");
3728 STRCAT(test, dst + 1);
3729 if (mch_stat(test, &st) == 0)
3731 var = alloc(STRLEN(test) + 1);
3732 STRCPY(var, test);
3733 mustfree = TRUE;
3734 break;
3738 # endif /* UNIX */
3739 #else
3740 /* cannot expand user's home directory, so don't try */
3741 var = NULL;
3742 tail = (char_u *)""; /* for gcc */
3743 #endif /* UNIX || VMS */
3746 #ifdef BACKSLASH_IN_FILENAME
3747 /* If 'shellslash' is set change backslashes to forward slashes.
3748 * Can't use slash_adjust(), p_ssl may be set temporarily. */
3749 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
3751 char_u *p = vim_strsave(var);
3753 if (p != NULL)
3755 if (mustfree)
3756 vim_free(var);
3757 var = p;
3758 mustfree = TRUE;
3759 forward_slash(var);
3762 #endif
3764 /* If "var" contains white space, escape it with a backslash.
3765 * Required for ":e ~/tt" when $HOME includes a space. */
3766 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
3768 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
3770 if (p != NULL)
3772 if (mustfree)
3773 vim_free(var);
3774 var = p;
3775 mustfree = TRUE;
3779 if (var != NULL && *var != NUL
3780 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
3782 STRCPY(dst, var);
3783 dstlen -= (int)STRLEN(var);
3784 c = (int)STRLEN(var);
3785 /* if var[] ends in a path separator and tail[] starts
3786 * with it, skip a character */
3787 if (*var != NUL && after_pathsep(dst, dst + c)
3788 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
3789 && dst[-1] != ':'
3790 #endif
3791 && vim_ispathsep(*tail))
3792 ++tail;
3793 dst += c;
3794 src = tail;
3795 copy_char = FALSE;
3797 if (mustfree)
3798 vim_free(var);
3801 if (copy_char) /* copy at least one char */
3804 * Recognize the start of a new name, for '~'.
3805 * Don't do this when "one" is TRUE, to avoid expanding "~" in
3806 * ":edit foo ~ foo".
3808 at_start = FALSE;
3809 if (src[0] == '\\' && src[1] != NUL)
3811 *dst++ = *src++;
3812 --dstlen;
3814 else if ((src[0] == ' ' || src[0] == ',') && !one)
3815 at_start = TRUE;
3816 *dst++ = *src++;
3817 --dstlen;
3819 if (startstr != NULL && src - startstr_len >= srcp
3820 && STRNCMP(src - startstr_len, startstr, startstr_len) == 0)
3821 at_start = TRUE;
3824 *dst = NUL;
3828 * Vim's version of getenv().
3829 * Special handling of $HOME, $VIM and $VIMRUNTIME.
3830 * Also does ACP to 'enc' conversion for Win32.
3832 char_u *
3833 vim_getenv(name, mustfree)
3834 char_u *name;
3835 int *mustfree; /* set to TRUE when returned is allocated */
3837 char_u *p;
3838 char_u *pend;
3839 int vimruntime;
3841 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3842 /* use "C:/" when $HOME is not set */
3843 if (STRCMP(name, "HOME") == 0)
3844 return homedir;
3845 #endif
3847 p = mch_getenv(name);
3848 if (p != NULL && *p == NUL) /* empty is the same as not set */
3849 p = NULL;
3851 if (p != NULL)
3853 #if defined(FEAT_MBYTE) && defined(WIN3264)
3854 if (enc_utf8)
3856 int len;
3857 char_u *pp;
3859 /* Convert from active codepage to UTF-8. Other conversions are
3860 * not done, because they would fail for non-ASCII characters. */
3861 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3862 if (pp != NULL)
3864 p = pp;
3865 *mustfree = TRUE;
3868 #endif
3869 return p;
3872 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
3873 if (!vimruntime && STRCMP(name, "VIM") != 0)
3874 return NULL;
3877 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
3878 * Don't do this when default_vimruntime_dir is non-empty.
3880 if (vimruntime
3881 #ifdef HAVE_PATHDEF
3882 && *default_vimruntime_dir == NUL
3883 #endif
3886 p = mch_getenv((char_u *)"VIM");
3887 if (p != NULL && *p == NUL) /* empty is the same as not set */
3888 p = NULL;
3889 if (p != NULL)
3891 p = vim_version_dir(p);
3892 if (p != NULL)
3893 *mustfree = TRUE;
3894 else
3895 p = mch_getenv((char_u *)"VIM");
3897 #if defined(FEAT_MBYTE) && defined(WIN3264)
3898 if (enc_utf8)
3900 int len;
3901 char_u *pp;
3903 /* Convert from active codepage to UTF-8. Other conversions
3904 * are not done, because they would fail for non-ASCII
3905 * characters. */
3906 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3907 if (pp != NULL)
3909 if (mustfree)
3910 vim_free(p);
3911 p = pp;
3912 *mustfree = TRUE;
3915 #endif
3920 * When expanding $VIM or $VIMRUNTIME fails, try using:
3921 * - the directory name from 'helpfile' (unless it contains '$')
3922 * - the executable name from argv[0]
3924 if (p == NULL)
3926 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
3927 p = p_hf;
3928 #ifdef USE_EXE_NAME
3930 * Use the name of the executable, obtained from argv[0].
3932 else
3933 p = exe_name;
3934 #endif
3935 if (p != NULL)
3937 /* remove the file name */
3938 pend = gettail(p);
3940 /* remove "doc/" from 'helpfile', if present */
3941 if (p == p_hf)
3942 pend = remove_tail(p, pend, (char_u *)"doc");
3944 #ifdef USE_EXE_NAME
3945 # ifdef MACOS_X
3946 /* remove "MacOS" from exe_name and add "Resources/vim" */
3947 if (p == exe_name)
3949 char_u *pend1;
3950 char_u *pnew;
3952 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
3953 if (pend1 != pend)
3955 pnew = alloc((unsigned)(pend1 - p) + 15);
3956 if (pnew != NULL)
3958 STRNCPY(pnew, p, (pend1 - p));
3959 STRCPY(pnew + (pend1 - p), "Resources/vim");
3960 p = pnew;
3961 pend = p + STRLEN(p);
3965 # endif
3966 /* remove "src/" from exe_name, if present */
3967 if (p == exe_name)
3968 pend = remove_tail(p, pend, (char_u *)"src");
3969 #endif
3971 /* for $VIM, remove "runtime/" or "vim54/", if present */
3972 if (!vimruntime)
3974 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
3975 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
3978 /* remove trailing path separator */
3979 #ifndef MACOS_CLASSIC
3980 /* With MacOS path (with colons) the final colon is required */
3981 /* to avoid confusion between absoulute and relative path */
3982 if (pend > p && after_pathsep(p, pend))
3983 --pend;
3984 #endif
3986 #ifdef MACOS_X
3987 if (p == exe_name || p == p_hf)
3988 #endif
3989 /* check that the result is a directory name */
3990 p = vim_strnsave(p, (int)(pend - p));
3992 if (p != NULL && !mch_isdir(p))
3994 vim_free(p);
3995 p = NULL;
3997 else
3999 #ifdef USE_EXE_NAME
4000 /* may add "/vim54" or "/runtime" if it exists */
4001 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
4003 vim_free(p);
4004 p = pend;
4006 #endif
4007 *mustfree = TRUE;
4012 #ifdef HAVE_PATHDEF
4013 /* When there is a pathdef.c file we can use default_vim_dir and
4014 * default_vimruntime_dir */
4015 if (p == NULL)
4017 /* Only use default_vimruntime_dir when it is not empty */
4018 if (vimruntime && *default_vimruntime_dir != NUL)
4020 p = default_vimruntime_dir;
4021 *mustfree = FALSE;
4023 else if (*default_vim_dir != NUL)
4025 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
4026 *mustfree = TRUE;
4027 else
4029 p = default_vim_dir;
4030 *mustfree = FALSE;
4034 #endif
4037 * Set the environment variable, so that the new value can be found fast
4038 * next time, and others can also use it (e.g. Perl).
4040 if (p != NULL)
4042 if (vimruntime)
4044 vim_setenv((char_u *)"VIMRUNTIME", p);
4045 didset_vimruntime = TRUE;
4046 #ifdef FEAT_GETTEXT
4048 char_u *buf = concat_str(p, (char_u *)"/lang");
4050 if (buf != NULL)
4052 bindtextdomain(VIMPACKAGE, (char *)buf);
4053 vim_free(buf);
4056 #endif
4058 else
4060 vim_setenv((char_u *)"VIM", p);
4061 didset_vim = TRUE;
4064 return p;
4068 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
4069 * Return NULL if not, return its name in allocated memory otherwise.
4071 static char_u *
4072 vim_version_dir(vimdir)
4073 char_u *vimdir;
4075 char_u *p;
4077 if (vimdir == NULL || *vimdir == NUL)
4078 return NULL;
4079 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
4080 if (p != NULL && mch_isdir(p))
4081 return p;
4082 vim_free(p);
4083 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
4084 if (p != NULL && mch_isdir(p))
4085 return p;
4086 vim_free(p);
4087 return NULL;
4091 * If the string between "p" and "pend" ends in "name/", return "pend" minus
4092 * the length of "name/". Otherwise return "pend".
4094 static char_u *
4095 remove_tail(p, pend, name)
4096 char_u *p;
4097 char_u *pend;
4098 char_u *name;
4100 int len = (int)STRLEN(name) + 1;
4101 char_u *newend = pend - len;
4103 if (newend >= p
4104 && fnamencmp(newend, name, len - 1) == 0
4105 && (newend == p || after_pathsep(p, newend)))
4106 return newend;
4107 return pend;
4111 * Our portable version of setenv.
4113 void
4114 vim_setenv(name, val)
4115 char_u *name;
4116 char_u *val;
4118 #ifdef HAVE_SETENV
4119 mch_setenv((char *)name, (char *)val, 1);
4120 #else
4121 char_u *envbuf;
4124 * Putenv does not copy the string, it has to remain
4125 * valid. The allocated memory will never be freed.
4127 envbuf = alloc((unsigned)(STRLEN(name) + STRLEN(val) + 2));
4128 if (envbuf != NULL)
4130 sprintf((char *)envbuf, "%s=%s", name, val);
4131 putenv((char *)envbuf);
4133 #endif
4136 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4138 * Function given to ExpandGeneric() to obtain an environment variable name.
4140 /*ARGSUSED*/
4141 char_u *
4142 get_env_name(xp, idx)
4143 expand_T *xp;
4144 int idx;
4146 # if defined(AMIGA) || defined(__MRC__) || defined(__SC__)
4148 * No environ[] on the Amiga and on the Mac (using MPW).
4150 return NULL;
4151 # else
4152 # ifndef __WIN32__
4153 /* Borland C++ 5.2 has this in a header file. */
4154 extern char **environ;
4155 # endif
4156 # define ENVNAMELEN 100
4157 static char_u name[ENVNAMELEN];
4158 char_u *str;
4159 int n;
4161 str = (char_u *)environ[idx];
4162 if (str == NULL)
4163 return NULL;
4165 for (n = 0; n < ENVNAMELEN - 1; ++n)
4167 if (str[n] == '=' || str[n] == NUL)
4168 break;
4169 name[n] = str[n];
4171 name[n] = NUL;
4172 return name;
4173 # endif
4175 #endif
4178 * Replace home directory by "~" in each space or comma separated file name in
4179 * 'src'.
4180 * If anything fails (except when out of space) dst equals src.
4182 void
4183 home_replace(buf, src, dst, dstlen, one)
4184 buf_T *buf; /* when not NULL, check for help files */
4185 char_u *src; /* input file name */
4186 char_u *dst; /* where to put the result */
4187 int dstlen; /* maximum length of the result */
4188 int one; /* if TRUE, only replace one file name, include
4189 spaces and commas in the file name. */
4191 size_t dirlen = 0, envlen = 0;
4192 size_t len;
4193 char_u *homedir_env;
4194 char_u *p;
4196 if (src == NULL)
4198 *dst = NUL;
4199 return;
4203 * If the file is a help file, remove the path completely.
4205 if (buf != NULL && buf->b_help)
4207 STRCPY(dst, gettail(src));
4208 return;
4212 * We check both the value of the $HOME environment variable and the
4213 * "real" home directory.
4215 if (homedir != NULL)
4216 dirlen = STRLEN(homedir);
4218 #ifdef VMS
4219 homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
4220 #else
4221 homedir_env = mch_getenv((char_u *)"HOME");
4222 #endif
4224 if (homedir_env != NULL && *homedir_env == NUL)
4225 homedir_env = NULL;
4226 if (homedir_env != NULL)
4227 envlen = STRLEN(homedir_env);
4229 if (!one)
4230 src = skipwhite(src);
4231 while (*src && dstlen > 0)
4234 * Here we are at the beginning of a file name.
4235 * First, check to see if the beginning of the file name matches
4236 * $HOME or the "real" home directory. Check that there is a '/'
4237 * after the match (so that if e.g. the file is "/home/pieter/bla",
4238 * and the home directory is "/home/piet", the file does not end up
4239 * as "~er/bla" (which would seem to indicate the file "bla" in user
4240 * er's home directory)).
4242 p = homedir;
4243 len = dirlen;
4244 for (;;)
4246 if ( len
4247 && fnamencmp(src, p, len) == 0
4248 && (vim_ispathsep(src[len])
4249 || (!one && (src[len] == ',' || src[len] == ' '))
4250 || src[len] == NUL))
4252 src += len;
4253 if (--dstlen > 0)
4254 *dst++ = '~';
4257 * If it's just the home directory, add "/".
4259 if (!vim_ispathsep(src[0]) && --dstlen > 0)
4260 *dst++ = '/';
4261 break;
4263 if (p == homedir_env)
4264 break;
4265 p = homedir_env;
4266 len = envlen;
4269 /* if (!one) skip to separator: space or comma */
4270 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
4271 *dst++ = *src++;
4272 /* skip separator */
4273 while ((*src == ' ' || *src == ',') && --dstlen > 0)
4274 *dst++ = *src++;
4276 /* if (dstlen == 0) out of space, what to do??? */
4278 *dst = NUL;
4282 * Like home_replace, store the replaced string in allocated memory.
4283 * When something fails, NULL is returned.
4285 char_u *
4286 home_replace_save(buf, src)
4287 buf_T *buf; /* when not NULL, check for help files */
4288 char_u *src; /* input file name */
4290 char_u *dst;
4291 unsigned len;
4293 len = 3; /* space for "~/" and trailing NUL */
4294 if (src != NULL) /* just in case */
4295 len += (unsigned)STRLEN(src);
4296 dst = alloc(len);
4297 if (dst != NULL)
4298 home_replace(buf, src, dst, len, TRUE);
4299 return dst;
4303 * Compare two file names and return:
4304 * FPC_SAME if they both exist and are the same file.
4305 * FPC_SAMEX if they both don't exist and have the same file name.
4306 * FPC_DIFF if they both exist and are different files.
4307 * FPC_NOTX if they both don't exist.
4308 * FPC_DIFFX if one of them doesn't exist.
4309 * For the first name environment variables are expanded
4312 fullpathcmp(s1, s2, checkname)
4313 char_u *s1, *s2;
4314 int checkname; /* when both don't exist, check file names */
4316 #ifdef UNIX
4317 char_u exp1[MAXPATHL];
4318 char_u full1[MAXPATHL];
4319 char_u full2[MAXPATHL];
4320 struct stat st1, st2;
4321 int r1, r2;
4323 expand_env(s1, exp1, MAXPATHL);
4324 r1 = mch_stat((char *)exp1, &st1);
4325 r2 = mch_stat((char *)s2, &st2);
4326 if (r1 != 0 && r2 != 0)
4328 /* if mch_stat() doesn't work, may compare the names */
4329 if (checkname)
4331 if (fnamecmp(exp1, s2) == 0)
4332 return FPC_SAMEX;
4333 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4334 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4335 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
4336 return FPC_SAMEX;
4338 return FPC_NOTX;
4340 if (r1 != 0 || r2 != 0)
4341 return FPC_DIFFX;
4342 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
4343 return FPC_SAME;
4344 return FPC_DIFF;
4345 #else
4346 char_u *exp1; /* expanded s1 */
4347 char_u *full1; /* full path of s1 */
4348 char_u *full2; /* full path of s2 */
4349 int retval = FPC_DIFF;
4350 int r1, r2;
4352 /* allocate one buffer to store three paths (alloc()/free() is slow!) */
4353 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
4355 full1 = exp1 + MAXPATHL;
4356 full2 = full1 + MAXPATHL;
4358 expand_env(s1, exp1, MAXPATHL);
4359 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4360 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4362 /* If vim_FullName() fails, the file probably doesn't exist. */
4363 if (r1 != OK && r2 != OK)
4365 if (checkname && fnamecmp(exp1, s2) == 0)
4366 retval = FPC_SAMEX;
4367 else
4368 retval = FPC_NOTX;
4370 else if (r1 != OK || r2 != OK)
4371 retval = FPC_DIFFX;
4372 else if (fnamecmp(full1, full2))
4373 retval = FPC_DIFF;
4374 else
4375 retval = FPC_SAME;
4376 vim_free(exp1);
4378 return retval;
4379 #endif
4383 * Get the tail of a path: the file name.
4384 * Fail safe: never returns NULL.
4386 char_u *
4387 gettail(fname)
4388 char_u *fname;
4390 char_u *p1, *p2;
4392 if (fname == NULL)
4393 return (char_u *)"";
4394 for (p1 = p2 = fname; *p2; ) /* find last part of path */
4396 if (vim_ispathsep(*p2))
4397 p1 = p2 + 1;
4398 mb_ptr_adv(p2);
4400 return p1;
4404 * Get pointer to tail of "fname", including path separators. Putting a NUL
4405 * here leaves the directory name. Takes care of "c:/" and "//".
4406 * Always returns a valid pointer.
4408 char_u *
4409 gettail_sep(fname)
4410 char_u *fname;
4412 char_u *p;
4413 char_u *t;
4415 p = get_past_head(fname); /* don't remove the '/' from "c:/file" */
4416 t = gettail(fname);
4417 while (t > p && after_pathsep(fname, t))
4418 --t;
4419 #ifdef VMS
4420 /* path separator is part of the path */
4421 ++t;
4422 #endif
4423 return t;
4427 * get the next path component (just after the next path separator).
4429 char_u *
4430 getnextcomp(fname)
4431 char_u *fname;
4433 while (*fname && !vim_ispathsep(*fname))
4434 mb_ptr_adv(fname);
4435 if (*fname)
4436 ++fname;
4437 return fname;
4441 * Get a pointer to one character past the head of a path name.
4442 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
4443 * If there is no head, path is returned.
4445 char_u *
4446 get_past_head(path)
4447 char_u *path;
4449 char_u *retval;
4451 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4452 /* may skip "c:" */
4453 if (isalpha(path[0]) && path[1] == ':')
4454 retval = path + 2;
4455 else
4456 retval = path;
4457 #else
4458 # if defined(AMIGA)
4459 /* may skip "label:" */
4460 retval = vim_strchr(path, ':');
4461 if (retval == NULL)
4462 retval = path;
4463 # else /* Unix */
4464 retval = path;
4465 # endif
4466 #endif
4468 while (vim_ispathsep(*retval))
4469 ++retval;
4471 return retval;
4475 * return TRUE if 'c' is a path separator.
4478 vim_ispathsep(c)
4479 int c;
4481 #ifdef RISCOS
4482 return (c == '.' || c == ':');
4483 #else
4484 # ifdef UNIX
4485 return (c == '/'); /* UNIX has ':' inside file names */
4486 # else
4487 # ifdef BACKSLASH_IN_FILENAME
4488 return (c == ':' || c == '/' || c == '\\');
4489 # else
4490 # ifdef VMS
4491 /* server"user passwd"::device:[full.path.name]fname.extension;version" */
4492 return (c == ':' || c == '[' || c == ']' || c == '/'
4493 || c == '<' || c == '>' || c == '"' );
4494 # else /* Amiga */
4495 return (c == ':' || c == '/');
4496 # endif /* VMS */
4497 # endif
4498 # endif
4499 #endif /* RISC OS */
4502 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
4504 * return TRUE if 'c' is a path list separator.
4507 vim_ispathlistsep(c)
4508 int c;
4510 #ifdef UNIX
4511 return (c == ':');
4512 #else
4513 return (c == ';'); /* might not be right for every system... */
4514 #endif
4516 #endif
4518 #if defined(FEAT_GUI_TABLINE) || defined(FEAT_WINDOWS) \
4519 || defined(FEAT_EVAL) || defined(PROTO)
4521 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
4522 * It's done in-place.
4524 void
4525 shorten_dir(str)
4526 char_u *str;
4528 char_u *tail, *s, *d;
4529 int skip = FALSE;
4531 tail = gettail(str);
4532 d = str;
4533 for (s = str; ; ++s)
4535 if (s >= tail) /* copy the whole tail */
4537 *d++ = *s;
4538 if (*s == NUL)
4539 break;
4541 else if (vim_ispathsep(*s)) /* copy '/' and next char */
4543 *d++ = *s;
4544 skip = FALSE;
4546 else if (!skip)
4548 *d++ = *s; /* copy next char */
4549 if (*s != '~' && *s != '.') /* and leading "~" and "." */
4550 skip = TRUE;
4551 # ifdef FEAT_MBYTE
4552 if (has_mbyte)
4554 int l = mb_ptr2len(s);
4556 while (--l > 0)
4557 *d++ = *++s;
4559 # endif
4563 #endif
4566 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
4567 * Also returns TRUE if there is no directory name.
4568 * "fname" must be writable!.
4571 dir_of_file_exists(fname)
4572 char_u *fname;
4574 char_u *p;
4575 int c;
4576 int retval;
4578 p = gettail_sep(fname);
4579 if (p == fname)
4580 return TRUE;
4581 c = *p;
4582 *p = NUL;
4583 retval = mch_isdir(fname);
4584 *p = c;
4585 return retval;
4588 #if (defined(CASE_INSENSITIVE_FILENAME) && defined(BACKSLASH_IN_FILENAME)) \
4589 || defined(PROTO)
4591 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally.
4594 vim_fnamecmp(x, y)
4595 char_u *x, *y;
4597 return vim_fnamencmp(x, y, MAXPATHL);
4601 vim_fnamencmp(x, y, len)
4602 char_u *x, *y;
4603 size_t len;
4605 while (len > 0 && *x && *y)
4607 if (TOLOWER_LOC(*x) != TOLOWER_LOC(*y)
4608 && !(*x == '/' && *y == '\\')
4609 && !(*x == '\\' && *y == '/'))
4610 break;
4611 ++x;
4612 ++y;
4613 --len;
4615 if (len == 0)
4616 return 0;
4617 return (*x - *y);
4619 #endif
4622 * Concatenate file names fname1 and fname2 into allocated memory.
4623 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
4625 char_u *
4626 concat_fnames(fname1, fname2, sep)
4627 char_u *fname1;
4628 char_u *fname2;
4629 int sep;
4631 char_u *dest;
4633 dest = alloc((unsigned)(STRLEN(fname1) + STRLEN(fname2) + 3));
4634 if (dest != NULL)
4636 STRCPY(dest, fname1);
4637 if (sep)
4638 add_pathsep(dest);
4639 STRCAT(dest, fname2);
4641 return dest;
4644 #if defined(FEAT_EVAL) || defined(FEAT_GETTEXT) || defined(PROTO)
4646 * Concatenate two strings and return the result in allocated memory.
4647 * Returns NULL when out of memory.
4649 char_u *
4650 concat_str(str1, str2)
4651 char_u *str1;
4652 char_u *str2;
4654 char_u *dest;
4655 size_t l = STRLEN(str1);
4657 dest = alloc((unsigned)(l + STRLEN(str2) + 1L));
4658 if (dest != NULL)
4660 STRCPY(dest, str1);
4661 STRCPY(dest + l, str2);
4663 return dest;
4665 #endif
4668 * Add a path separator to a file name, unless it already ends in a path
4669 * separator.
4671 void
4672 add_pathsep(p)
4673 char_u *p;
4675 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
4676 STRCAT(p, PATHSEPSTR);
4680 * FullName_save - Make an allocated copy of a full file name.
4681 * Returns NULL when out of memory.
4683 char_u *
4684 FullName_save(fname, force)
4685 char_u *fname;
4686 int force; /* force expansion, even when it already looks
4687 like a full path name */
4689 char_u *buf;
4690 char_u *new_fname = NULL;
4692 if (fname == NULL)
4693 return NULL;
4695 buf = alloc((unsigned)MAXPATHL);
4696 if (buf != NULL)
4698 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
4699 new_fname = vim_strsave(buf);
4700 else
4701 new_fname = vim_strsave(fname);
4702 vim_free(buf);
4704 return new_fname;
4707 #if defined(FEAT_CINDENT) || defined(FEAT_SYN_HL)
4709 static char_u *skip_string __ARGS((char_u *p));
4712 * Find the start of a comment, not knowing if we are in a comment right now.
4713 * Search starts at w_cursor.lnum and goes backwards.
4715 pos_T *
4716 find_start_comment(ind_maxcomment) /* XXX */
4717 int ind_maxcomment;
4719 pos_T *pos;
4720 char_u *line;
4721 char_u *p;
4722 int cur_maxcomment = ind_maxcomment;
4724 for (;;)
4726 pos = findmatchlimit(NULL, '*', FM_BACKWARD, cur_maxcomment);
4727 if (pos == NULL)
4728 break;
4731 * Check if the comment start we found is inside a string.
4732 * If it is then restrict the search to below this line and try again.
4734 line = ml_get(pos->lnum);
4735 for (p = line; *p && (unsigned)(p - line) < pos->col; ++p)
4736 p = skip_string(p);
4737 if ((unsigned)(p - line) <= pos->col)
4738 break;
4739 cur_maxcomment = curwin->w_cursor.lnum - pos->lnum - 1;
4740 if (cur_maxcomment <= 0)
4742 pos = NULL;
4743 break;
4746 return pos;
4750 * Skip to the end of a "string" and a 'c' character.
4751 * If there is no string or character, return argument unmodified.
4753 static char_u *
4754 skip_string(p)
4755 char_u *p;
4757 int i;
4760 * We loop, because strings may be concatenated: "date""time".
4762 for ( ; ; ++p)
4764 if (p[0] == '\'') /* 'c' or '\n' or '\000' */
4766 if (!p[1]) /* ' at end of line */
4767 break;
4768 i = 2;
4769 if (p[1] == '\\') /* '\n' or '\000' */
4771 ++i;
4772 while (vim_isdigit(p[i - 1])) /* '\000' */
4773 ++i;
4775 if (p[i] == '\'') /* check for trailing ' */
4777 p += i;
4778 continue;
4781 else if (p[0] == '"') /* start of string */
4783 for (++p; p[0]; ++p)
4785 if (p[0] == '\\' && p[1] != NUL)
4786 ++p;
4787 else if (p[0] == '"') /* end of string */
4788 break;
4790 if (p[0] == '"')
4791 continue;
4793 break; /* no string found */
4795 if (!*p)
4796 --p; /* backup from NUL */
4797 return p;
4799 #endif /* FEAT_CINDENT || FEAT_SYN_HL */
4801 #if defined(FEAT_CINDENT) || defined(PROTO)
4804 * Do C or expression indenting on the current line.
4806 void
4807 do_c_expr_indent()
4809 # ifdef FEAT_EVAL
4810 if (*curbuf->b_p_inde != NUL)
4811 fixthisline(get_expr_indent);
4812 else
4813 # endif
4814 fixthisline(get_c_indent);
4818 * Functions for C-indenting.
4819 * Most of this originally comes from Eric Fischer.
4822 * Below "XXX" means that this function may unlock the current line.
4825 static char_u *cin_skipcomment __ARGS((char_u *));
4826 static int cin_nocode __ARGS((char_u *));
4827 static pos_T *find_line_comment __ARGS((void));
4828 static int cin_islabel_skip __ARGS((char_u **));
4829 static int cin_isdefault __ARGS((char_u *));
4830 static char_u *after_label __ARGS((char_u *l));
4831 static int get_indent_nolabel __ARGS((linenr_T lnum));
4832 static int skip_label __ARGS((linenr_T, char_u **pp, int ind_maxcomment));
4833 static int cin_first_id_amount __ARGS((void));
4834 static int cin_get_equal_amount __ARGS((linenr_T lnum));
4835 static int cin_ispreproc __ARGS((char_u *));
4836 static int cin_ispreproc_cont __ARGS((char_u **pp, linenr_T *lnump));
4837 static int cin_iscomment __ARGS((char_u *));
4838 static int cin_islinecomment __ARGS((char_u *));
4839 static int cin_isterminated __ARGS((char_u *, int, int));
4840 static int cin_isinit __ARGS((void));
4841 static int cin_isfuncdecl __ARGS((char_u **, linenr_T));
4842 static int cin_isif __ARGS((char_u *));
4843 static int cin_iselse __ARGS((char_u *));
4844 static int cin_isdo __ARGS((char_u *));
4845 static int cin_iswhileofdo __ARGS((char_u *, linenr_T, int));
4846 static int cin_iswhileofdo_end __ARGS((int terminated, int ind_maxparen, int ind_maxcomment));
4847 static int cin_isbreak __ARGS((char_u *));
4848 static int cin_is_cpp_baseclass __ARGS((colnr_T *col));
4849 static int get_baseclass_amount __ARGS((int col, int ind_maxparen, int ind_maxcomment, int ind_cpp_baseclass));
4850 static int cin_ends_in __ARGS((char_u *, char_u *, char_u *));
4851 static int cin_skip2pos __ARGS((pos_T *trypos));
4852 static pos_T *find_start_brace __ARGS((int));
4853 static pos_T *find_match_paren __ARGS((int, int));
4854 static int corr_ind_maxparen __ARGS((int ind_maxparen, pos_T *startpos));
4855 static int find_last_paren __ARGS((char_u *l, int start, int end));
4856 static int find_match __ARGS((int lookfor, linenr_T ourscope, int ind_maxparen, int ind_maxcomment));
4858 static int ind_hash_comment = 0; /* # starts a comment */
4861 * Skip over white space and C comments within the line.
4862 * Also skip over Perl/shell comments if desired.
4864 static char_u *
4865 cin_skipcomment(s)
4866 char_u *s;
4868 while (*s)
4870 char_u *prev_s = s;
4872 s = skipwhite(s);
4874 /* Perl/shell # comment comment continues until eol. Require a space
4875 * before # to avoid recognizing $#array. */
4876 if (ind_hash_comment != 0 && s != prev_s && *s == '#')
4878 s += STRLEN(s);
4879 break;
4881 if (*s != '/')
4882 break;
4883 ++s;
4884 if (*s == '/') /* slash-slash comment continues till eol */
4886 s += STRLEN(s);
4887 break;
4889 if (*s != '*')
4890 break;
4891 for (++s; *s; ++s) /* skip slash-star comment */
4892 if (s[0] == '*' && s[1] == '/')
4894 s += 2;
4895 break;
4898 return s;
4902 * Return TRUE if there there is no code at *s. White space and comments are
4903 * not considered code.
4905 static int
4906 cin_nocode(s)
4907 char_u *s;
4909 return *cin_skipcomment(s) == NUL;
4913 * Check previous lines for a "//" line comment, skipping over blank lines.
4915 static pos_T *
4916 find_line_comment() /* XXX */
4918 static pos_T pos;
4919 char_u *line;
4920 char_u *p;
4922 pos = curwin->w_cursor;
4923 while (--pos.lnum > 0)
4925 line = ml_get(pos.lnum);
4926 p = skipwhite(line);
4927 if (cin_islinecomment(p))
4929 pos.col = (int)(p - line);
4930 return &pos;
4932 if (*p != NUL)
4933 break;
4935 return NULL;
4939 * Check if string matches "label:"; move to character after ':' if true.
4941 static int
4942 cin_islabel_skip(s)
4943 char_u **s;
4945 if (!vim_isIDc(**s)) /* need at least one ID character */
4946 return FALSE;
4948 while (vim_isIDc(**s))
4949 (*s)++;
4951 *s = cin_skipcomment(*s);
4953 /* "::" is not a label, it's C++ */
4954 return (**s == ':' && *++*s != ':');
4958 * Recognize a label: "label:".
4959 * Note: curwin->w_cursor must be where we are looking for the label.
4962 cin_islabel(ind_maxcomment) /* XXX */
4963 int ind_maxcomment;
4965 char_u *s;
4967 s = cin_skipcomment(ml_get_curline());
4970 * Exclude "default" from labels, since it should be indented
4971 * like a switch label. Same for C++ scope declarations.
4973 if (cin_isdefault(s))
4974 return FALSE;
4975 if (cin_isscopedecl(s))
4976 return FALSE;
4978 if (cin_islabel_skip(&s))
4981 * Only accept a label if the previous line is terminated or is a case
4982 * label.
4984 pos_T cursor_save;
4985 pos_T *trypos;
4986 char_u *line;
4988 cursor_save = curwin->w_cursor;
4989 while (curwin->w_cursor.lnum > 1)
4991 --curwin->w_cursor.lnum;
4994 * If we're in a comment now, skip to the start of the comment.
4996 curwin->w_cursor.col = 0;
4997 if ((trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
4998 curwin->w_cursor = *trypos;
5000 line = ml_get_curline();
5001 if (cin_ispreproc(line)) /* ignore #defines, #if, etc. */
5002 continue;
5003 if (*(line = cin_skipcomment(line)) == NUL)
5004 continue;
5006 curwin->w_cursor = cursor_save;
5007 if (cin_isterminated(line, TRUE, FALSE)
5008 || cin_isscopedecl(line)
5009 || cin_iscase(line)
5010 || (cin_islabel_skip(&line) && cin_nocode(line)))
5011 return TRUE;
5012 return FALSE;
5014 curwin->w_cursor = cursor_save;
5015 return TRUE; /* label at start of file??? */
5017 return FALSE;
5021 * Recognize structure initialization and enumerations.
5022 * Q&D-Implementation:
5023 * check for "=" at end or "[typedef] enum" at beginning of line.
5025 static int
5026 cin_isinit(void)
5028 char_u *s;
5030 s = cin_skipcomment(ml_get_curline());
5032 if (STRNCMP(s, "typedef", 7) == 0 && !vim_isIDc(s[7]))
5033 s = cin_skipcomment(s + 7);
5035 if (STRNCMP(s, "enum", 4) == 0 && !vim_isIDc(s[4]))
5036 return TRUE;
5038 if (cin_ends_in(s, (char_u *)"=", (char_u *)"{"))
5039 return TRUE;
5041 return FALSE;
5045 * Recognize a switch label: "case .*:" or "default:".
5048 cin_iscase(s)
5049 char_u *s;
5051 s = cin_skipcomment(s);
5052 if (STRNCMP(s, "case", 4) == 0 && !vim_isIDc(s[4]))
5054 for (s += 4; *s; ++s)
5056 s = cin_skipcomment(s);
5057 if (*s == ':')
5059 if (s[1] == ':') /* skip over "::" for C++ */
5060 ++s;
5061 else
5062 return TRUE;
5064 if (*s == '\'' && s[1] && s[2] == '\'')
5065 s += 2; /* skip over '.' */
5066 else if (*s == '/' && (s[1] == '*' || s[1] == '/'))
5067 return FALSE; /* stop at comment */
5068 else if (*s == '"')
5069 return FALSE; /* stop at string */
5071 return FALSE;
5074 if (cin_isdefault(s))
5075 return TRUE;
5076 return FALSE;
5080 * Recognize a "default" switch label.
5082 static int
5083 cin_isdefault(s)
5084 char_u *s;
5086 return (STRNCMP(s, "default", 7) == 0
5087 && *(s = cin_skipcomment(s + 7)) == ':'
5088 && s[1] != ':');
5092 * Recognize a "public/private/proctected" scope declaration label.
5095 cin_isscopedecl(s)
5096 char_u *s;
5098 int i;
5100 s = cin_skipcomment(s);
5101 if (STRNCMP(s, "public", 6) == 0)
5102 i = 6;
5103 else if (STRNCMP(s, "protected", 9) == 0)
5104 i = 9;
5105 else if (STRNCMP(s, "private", 7) == 0)
5106 i = 7;
5107 else
5108 return FALSE;
5109 return (*(s = cin_skipcomment(s + i)) == ':' && s[1] != ':');
5113 * Return a pointer to the first non-empty non-comment character after a ':'.
5114 * Return NULL if not found.
5115 * case 234: a = b;
5118 static char_u *
5119 after_label(l)
5120 char_u *l;
5122 for ( ; *l; ++l)
5124 if (*l == ':')
5126 if (l[1] == ':') /* skip over "::" for C++ */
5127 ++l;
5128 else if (!cin_iscase(l + 1))
5129 break;
5131 else if (*l == '\'' && l[1] && l[2] == '\'')
5132 l += 2; /* skip over 'x' */
5134 if (*l == NUL)
5135 return NULL;
5136 l = cin_skipcomment(l + 1);
5137 if (*l == NUL)
5138 return NULL;
5139 return l;
5143 * Get indent of line "lnum", skipping a label.
5144 * Return 0 if there is nothing after the label.
5146 static int
5147 get_indent_nolabel(lnum) /* XXX */
5148 linenr_T lnum;
5150 char_u *l;
5151 pos_T fp;
5152 colnr_T col;
5153 char_u *p;
5155 l = ml_get(lnum);
5156 p = after_label(l);
5157 if (p == NULL)
5158 return 0;
5160 fp.col = (colnr_T)(p - l);
5161 fp.lnum = lnum;
5162 getvcol(curwin, &fp, &col, NULL, NULL);
5163 return (int)col;
5167 * Find indent for line "lnum", ignoring any case or jump label.
5168 * Also return a pointer to the text (after the label) in "pp".
5169 * label: if (asdf && asdfasdf)
5172 static int
5173 skip_label(lnum, pp, ind_maxcomment)
5174 linenr_T lnum;
5175 char_u **pp;
5176 int ind_maxcomment;
5178 char_u *l;
5179 int amount;
5180 pos_T cursor_save;
5182 cursor_save = curwin->w_cursor;
5183 curwin->w_cursor.lnum = lnum;
5184 l = ml_get_curline();
5185 /* XXX */
5186 if (cin_iscase(l) || cin_isscopedecl(l) || cin_islabel(ind_maxcomment))
5188 amount = get_indent_nolabel(lnum);
5189 l = after_label(ml_get_curline());
5190 if (l == NULL) /* just in case */
5191 l = ml_get_curline();
5193 else
5195 amount = get_indent();
5196 l = ml_get_curline();
5198 *pp = l;
5200 curwin->w_cursor = cursor_save;
5201 return amount;
5205 * Return the indent of the first variable name after a type in a declaration.
5206 * int a, indent of "a"
5207 * static struct foo b, indent of "b"
5208 * enum bla c, indent of "c"
5209 * Returns zero when it doesn't look like a declaration.
5211 static int
5212 cin_first_id_amount()
5214 char_u *line, *p, *s;
5215 int len;
5216 pos_T fp;
5217 colnr_T col;
5219 line = ml_get_curline();
5220 p = skipwhite(line);
5221 len = (int)(skiptowhite(p) - p);
5222 if (len == 6 && STRNCMP(p, "static", 6) == 0)
5224 p = skipwhite(p + 6);
5225 len = (int)(skiptowhite(p) - p);
5227 if (len == 6 && STRNCMP(p, "struct", 6) == 0)
5228 p = skipwhite(p + 6);
5229 else if (len == 4 && STRNCMP(p, "enum", 4) == 0)
5230 p = skipwhite(p + 4);
5231 else if ((len == 8 && STRNCMP(p, "unsigned", 8) == 0)
5232 || (len == 6 && STRNCMP(p, "signed", 6) == 0))
5234 s = skipwhite(p + len);
5235 if ((STRNCMP(s, "int", 3) == 0 && vim_iswhite(s[3]))
5236 || (STRNCMP(s, "long", 4) == 0 && vim_iswhite(s[4]))
5237 || (STRNCMP(s, "short", 5) == 0 && vim_iswhite(s[5]))
5238 || (STRNCMP(s, "char", 4) == 0 && vim_iswhite(s[4])))
5239 p = s;
5241 for (len = 0; vim_isIDc(p[len]); ++len)
5243 if (len == 0 || !vim_iswhite(p[len]) || cin_nocode(p))
5244 return 0;
5246 p = skipwhite(p + len);
5247 fp.lnum = curwin->w_cursor.lnum;
5248 fp.col = (colnr_T)(p - line);
5249 getvcol(curwin, &fp, &col, NULL, NULL);
5250 return (int)col;
5254 * Return the indent of the first non-blank after an equal sign.
5255 * char *foo = "here";
5256 * Return zero if no (useful) equal sign found.
5257 * Return -1 if the line above "lnum" ends in a backslash.
5258 * foo = "asdf\
5259 * asdf\
5260 * here";
5262 static int
5263 cin_get_equal_amount(lnum)
5264 linenr_T lnum;
5266 char_u *line;
5267 char_u *s;
5268 colnr_T col;
5269 pos_T fp;
5271 if (lnum > 1)
5273 line = ml_get(lnum - 1);
5274 if (*line != NUL && line[STRLEN(line) - 1] == '\\')
5275 return -1;
5278 line = s = ml_get(lnum);
5279 while (*s != NUL && vim_strchr((char_u *)"=;{}\"'", *s) == NULL)
5281 if (cin_iscomment(s)) /* ignore comments */
5282 s = cin_skipcomment(s);
5283 else
5284 ++s;
5286 if (*s != '=')
5287 return 0;
5289 s = skipwhite(s + 1);
5290 if (cin_nocode(s))
5291 return 0;
5293 if (*s == '"') /* nice alignment for continued strings */
5294 ++s;
5296 fp.lnum = lnum;
5297 fp.col = (colnr_T)(s - line);
5298 getvcol(curwin, &fp, &col, NULL, NULL);
5299 return (int)col;
5303 * Recognize a preprocessor statement: Any line that starts with '#'.
5305 static int
5306 cin_ispreproc(s)
5307 char_u *s;
5309 s = skipwhite(s);
5310 if (*s == '#')
5311 return TRUE;
5312 return FALSE;
5316 * Return TRUE if line "*pp" at "*lnump" is a preprocessor statement or a
5317 * continuation line of a preprocessor statement. Decrease "*lnump" to the
5318 * start and return the line in "*pp".
5320 static int
5321 cin_ispreproc_cont(pp, lnump)
5322 char_u **pp;
5323 linenr_T *lnump;
5325 char_u *line = *pp;
5326 linenr_T lnum = *lnump;
5327 int retval = FALSE;
5329 for (;;)
5331 if (cin_ispreproc(line))
5333 retval = TRUE;
5334 *lnump = lnum;
5335 break;
5337 if (lnum == 1)
5338 break;
5339 line = ml_get(--lnum);
5340 if (*line == NUL || line[STRLEN(line) - 1] != '\\')
5341 break;
5344 if (lnum != *lnump)
5345 *pp = ml_get(*lnump);
5346 return retval;
5350 * Recognize the start of a C or C++ comment.
5352 static int
5353 cin_iscomment(p)
5354 char_u *p;
5356 return (p[0] == '/' && (p[1] == '*' || p[1] == '/'));
5360 * Recognize the start of a "//" comment.
5362 static int
5363 cin_islinecomment(p)
5364 char_u *p;
5366 return (p[0] == '/' && p[1] == '/');
5370 * Recognize a line that starts with '{' or '}', or ends with ';', '{' or '}'.
5371 * Don't consider "} else" a terminated line.
5372 * Return the character terminating the line (ending char's have precedence if
5373 * both apply in order to determine initializations).
5375 static int
5376 cin_isterminated(s, incl_open, incl_comma)
5377 char_u *s;
5378 int incl_open; /* include '{' at the end as terminator */
5379 int incl_comma; /* recognize a trailing comma */
5381 char_u found_start = 0;
5383 s = cin_skipcomment(s);
5385 if (*s == '{' || (*s == '}' && !cin_iselse(s)))
5386 found_start = *s;
5388 while (*s)
5390 /* skip over comments, "" strings and 'c'haracters */
5391 s = skip_string(cin_skipcomment(s));
5392 if ((*s == ';' || (incl_open && *s == '{') || *s == '}'
5393 || (incl_comma && *s == ','))
5394 && cin_nocode(s + 1))
5395 return *s;
5397 if (*s)
5398 s++;
5400 return found_start;
5404 * Recognize the basic picture of a function declaration -- it needs to
5405 * have an open paren somewhere and a close paren at the end of the line and
5406 * no semicolons anywhere.
5407 * When a line ends in a comma we continue looking in the next line.
5408 * "sp" points to a string with the line. When looking at other lines it must
5409 * be restored to the line. When it's NULL fetch lines here.
5410 * "lnum" is where we start looking.
5412 static int
5413 cin_isfuncdecl(sp, first_lnum)
5414 char_u **sp;
5415 linenr_T first_lnum;
5417 char_u *s;
5418 linenr_T lnum = first_lnum;
5419 int retval = FALSE;
5421 if (sp == NULL)
5422 s = ml_get(lnum);
5423 else
5424 s = *sp;
5426 while (*s && *s != '(' && *s != ';' && *s != '\'' && *s != '"')
5428 if (cin_iscomment(s)) /* ignore comments */
5429 s = cin_skipcomment(s);
5430 else
5431 ++s;
5433 if (*s != '(')
5434 return FALSE; /* ';', ' or " before any () or no '(' */
5436 while (*s && *s != ';' && *s != '\'' && *s != '"')
5438 if (*s == ')' && cin_nocode(s + 1))
5440 /* ')' at the end: may have found a match
5441 * Check for he previous line not to end in a backslash:
5442 * #if defined(x) && \
5443 * defined(y)
5445 lnum = first_lnum - 1;
5446 s = ml_get(lnum);
5447 if (*s == NUL || s[STRLEN(s) - 1] != '\\')
5448 retval = TRUE;
5449 goto done;
5451 if (*s == ',' && cin_nocode(s + 1))
5453 /* ',' at the end: continue looking in the next line */
5454 if (lnum >= curbuf->b_ml.ml_line_count)
5455 break;
5457 s = ml_get(++lnum);
5459 else if (cin_iscomment(s)) /* ignore comments */
5460 s = cin_skipcomment(s);
5461 else
5462 ++s;
5465 done:
5466 if (lnum != first_lnum && sp != NULL)
5467 *sp = ml_get(first_lnum);
5469 return retval;
5472 static int
5473 cin_isif(p)
5474 char_u *p;
5476 return (STRNCMP(p, "if", 2) == 0 && !vim_isIDc(p[2]));
5479 static int
5480 cin_iselse(p)
5481 char_u *p;
5483 if (*p == '}') /* accept "} else" */
5484 p = cin_skipcomment(p + 1);
5485 return (STRNCMP(p, "else", 4) == 0 && !vim_isIDc(p[4]));
5488 static int
5489 cin_isdo(p)
5490 char_u *p;
5492 return (STRNCMP(p, "do", 2) == 0 && !vim_isIDc(p[2]));
5496 * Check if this is a "while" that should have a matching "do".
5497 * We only accept a "while (condition) ;", with only white space between the
5498 * ')' and ';'. The condition may be spread over several lines.
5500 static int
5501 cin_iswhileofdo(p, lnum, ind_maxparen) /* XXX */
5502 char_u *p;
5503 linenr_T lnum;
5504 int ind_maxparen;
5506 pos_T cursor_save;
5507 pos_T *trypos;
5508 int retval = FALSE;
5510 p = cin_skipcomment(p);
5511 if (*p == '}') /* accept "} while (cond);" */
5512 p = cin_skipcomment(p + 1);
5513 if (STRNCMP(p, "while", 5) == 0 && !vim_isIDc(p[5]))
5515 cursor_save = curwin->w_cursor;
5516 curwin->w_cursor.lnum = lnum;
5517 curwin->w_cursor.col = 0;
5518 p = ml_get_curline();
5519 while (*p && *p != 'w') /* skip any '}', until the 'w' of the "while" */
5521 ++p;
5522 ++curwin->w_cursor.col;
5524 if ((trypos = findmatchlimit(NULL, 0, 0, ind_maxparen)) != NULL
5525 && *cin_skipcomment(ml_get_pos(trypos) + 1) == ';')
5526 retval = TRUE;
5527 curwin->w_cursor = cursor_save;
5529 return retval;
5533 * Return TRUE if we are at the end of a do-while.
5534 * do
5535 * nothing;
5536 * while (foo
5537 * && bar); <-- here
5538 * Adjust the cursor to the line with "while".
5540 static int
5541 cin_iswhileofdo_end(terminated, ind_maxparen, ind_maxcomment)
5542 int terminated;
5543 int ind_maxparen;
5544 int ind_maxcomment;
5546 char_u *line;
5547 char_u *p;
5548 char_u *s;
5549 pos_T *trypos;
5550 int i;
5552 if (terminated != ';') /* there must be a ';' at the end */
5553 return FALSE;
5555 p = line = ml_get_curline();
5556 while (*p != NUL)
5558 p = cin_skipcomment(p);
5559 if (*p == ')')
5561 s = skipwhite(p + 1);
5562 if (*s == ';' && cin_nocode(s + 1))
5564 /* Found ");" at end of the line, now check there is "while"
5565 * before the matching '('. XXX */
5566 i = (int)(p - line);
5567 curwin->w_cursor.col = i;
5568 trypos = find_match_paren(ind_maxparen, ind_maxcomment);
5569 if (trypos != NULL)
5571 s = cin_skipcomment(ml_get(trypos->lnum));
5572 if (*s == '}') /* accept "} while (cond);" */
5573 s = cin_skipcomment(s + 1);
5574 if (STRNCMP(s, "while", 5) == 0 && !vim_isIDc(s[5]))
5576 curwin->w_cursor.lnum = trypos->lnum;
5577 return TRUE;
5581 /* Searching may have made "line" invalid, get it again. */
5582 line = ml_get_curline();
5583 p = line + i;
5586 if (*p != NUL)
5587 ++p;
5589 return FALSE;
5592 static int
5593 cin_isbreak(p)
5594 char_u *p;
5596 return (STRNCMP(p, "break", 5) == 0 && !vim_isIDc(p[5]));
5600 * Find the position of a C++ base-class declaration or
5601 * constructor-initialization. eg:
5603 * class MyClass :
5604 * baseClass <-- here
5605 * class MyClass : public baseClass,
5606 * anotherBaseClass <-- here (should probably lineup ??)
5607 * MyClass::MyClass(...) :
5608 * baseClass(...) <-- here (constructor-initialization)
5610 * This is a lot of guessing. Watch out for "cond ? func() : foo".
5612 static int
5613 cin_is_cpp_baseclass(col)
5614 colnr_T *col; /* return: column to align with */
5616 char_u *s;
5617 int class_or_struct, lookfor_ctor_init, cpp_base_class;
5618 linenr_T lnum = curwin->w_cursor.lnum;
5619 char_u *line = ml_get_curline();
5621 *col = 0;
5623 s = skipwhite(line);
5624 if (*s == '#') /* skip #define FOO x ? (x) : x */
5625 return FALSE;
5626 s = cin_skipcomment(s);
5627 if (*s == NUL)
5628 return FALSE;
5630 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5632 /* Search for a line starting with '#', empty, ending in ';' or containing
5633 * '{' or '}' and start below it. This handles the following situations:
5634 * a = cond ?
5635 * func() :
5636 * asdf;
5637 * func::foo()
5638 * : something
5639 * {}
5640 * Foo::Foo (int one, int two)
5641 * : something(4),
5642 * somethingelse(3)
5643 * {}
5645 while (lnum > 1)
5647 line = ml_get(lnum - 1);
5648 s = skipwhite(line);
5649 if (*s == '#' || *s == NUL)
5650 break;
5651 while (*s != NUL)
5653 s = cin_skipcomment(s);
5654 if (*s == '{' || *s == '}'
5655 || (*s == ';' && cin_nocode(s + 1)))
5656 break;
5657 if (*s != NUL)
5658 ++s;
5660 if (*s != NUL)
5661 break;
5662 --lnum;
5665 line = ml_get(lnum);
5666 s = cin_skipcomment(line);
5667 for (;;)
5669 if (*s == NUL)
5671 if (lnum == curwin->w_cursor.lnum)
5672 break;
5673 /* Continue in the cursor line. */
5674 line = ml_get(++lnum);
5675 s = cin_skipcomment(line);
5676 if (*s == NUL)
5677 continue;
5680 if (s[0] == ':')
5682 if (s[1] == ':')
5684 /* skip double colon. It can't be a constructor
5685 * initialization any more */
5686 lookfor_ctor_init = FALSE;
5687 s = cin_skipcomment(s + 2);
5689 else if (lookfor_ctor_init || class_or_struct)
5691 /* we have something found, that looks like the start of
5692 * cpp-base-class-declaration or contructor-initialization */
5693 cpp_base_class = TRUE;
5694 lookfor_ctor_init = class_or_struct = FALSE;
5695 *col = 0;
5696 s = cin_skipcomment(s + 1);
5698 else
5699 s = cin_skipcomment(s + 1);
5701 else if ((STRNCMP(s, "class", 5) == 0 && !vim_isIDc(s[5]))
5702 || (STRNCMP(s, "struct", 6) == 0 && !vim_isIDc(s[6])))
5704 class_or_struct = TRUE;
5705 lookfor_ctor_init = FALSE;
5707 if (*s == 'c')
5708 s = cin_skipcomment(s + 5);
5709 else
5710 s = cin_skipcomment(s + 6);
5712 else
5714 if (s[0] == '{' || s[0] == '}' || s[0] == ';')
5716 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5718 else if (s[0] == ')')
5720 /* Constructor-initialization is assumed if we come across
5721 * something like "):" */
5722 class_or_struct = FALSE;
5723 lookfor_ctor_init = TRUE;
5725 else if (s[0] == '?')
5727 /* Avoid seeing '() :' after '?' as constructor init. */
5728 return FALSE;
5730 else if (!vim_isIDc(s[0]))
5732 /* if it is not an identifier, we are wrong */
5733 class_or_struct = FALSE;
5734 lookfor_ctor_init = FALSE;
5736 else if (*col == 0)
5738 /* it can't be a constructor-initialization any more */
5739 lookfor_ctor_init = FALSE;
5741 /* the first statement starts here: lineup with this one... */
5742 if (cpp_base_class)
5743 *col = (colnr_T)(s - line);
5746 /* When the line ends in a comma don't align with it. */
5747 if (lnum == curwin->w_cursor.lnum && *s == ',' && cin_nocode(s + 1))
5748 *col = 0;
5750 s = cin_skipcomment(s + 1);
5754 return cpp_base_class;
5757 static int
5758 get_baseclass_amount(col, ind_maxparen, ind_maxcomment, ind_cpp_baseclass)
5759 int col;
5760 int ind_maxparen;
5761 int ind_maxcomment;
5762 int ind_cpp_baseclass;
5764 int amount;
5765 colnr_T vcol;
5766 pos_T *trypos;
5768 if (col == 0)
5770 amount = get_indent();
5771 if (find_last_paren(ml_get_curline(), '(', ')')
5772 && (trypos = find_match_paren(ind_maxparen,
5773 ind_maxcomment)) != NULL)
5774 amount = get_indent_lnum(trypos->lnum); /* XXX */
5775 if (!cin_ends_in(ml_get_curline(), (char_u *)",", NULL))
5776 amount += ind_cpp_baseclass;
5778 else
5780 curwin->w_cursor.col = col;
5781 getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
5782 amount = (int)vcol;
5784 if (amount < ind_cpp_baseclass)
5785 amount = ind_cpp_baseclass;
5786 return amount;
5790 * Return TRUE if string "s" ends with the string "find", possibly followed by
5791 * white space and comments. Skip strings and comments.
5792 * Ignore "ignore" after "find" if it's not NULL.
5794 static int
5795 cin_ends_in(s, find, ignore)
5796 char_u *s;
5797 char_u *find;
5798 char_u *ignore;
5800 char_u *p = s;
5801 char_u *r;
5802 int len = (int)STRLEN(find);
5804 while (*p != NUL)
5806 p = cin_skipcomment(p);
5807 if (STRNCMP(p, find, len) == 0)
5809 r = skipwhite(p + len);
5810 if (ignore != NULL && STRNCMP(r, ignore, STRLEN(ignore)) == 0)
5811 r = skipwhite(r + STRLEN(ignore));
5812 if (cin_nocode(r))
5813 return TRUE;
5815 if (*p != NUL)
5816 ++p;
5818 return FALSE;
5822 * Skip strings, chars and comments until at or past "trypos".
5823 * Return the column found.
5825 static int
5826 cin_skip2pos(trypos)
5827 pos_T *trypos;
5829 char_u *line;
5830 char_u *p;
5832 p = line = ml_get(trypos->lnum);
5833 while (*p && (colnr_T)(p - line) < trypos->col)
5835 if (cin_iscomment(p))
5836 p = cin_skipcomment(p);
5837 else
5839 p = skip_string(p);
5840 ++p;
5843 return (int)(p - line);
5847 * Find the '{' at the start of the block we are in.
5848 * Return NULL if no match found.
5849 * Ignore a '{' that is in a comment, makes indenting the next three lines
5850 * work. */
5851 /* foo() */
5852 /* { */
5853 /* } */
5855 static pos_T *
5856 find_start_brace(ind_maxcomment) /* XXX */
5857 int ind_maxcomment;
5859 pos_T cursor_save;
5860 pos_T *trypos;
5861 pos_T *pos;
5862 static pos_T pos_copy;
5864 cursor_save = curwin->w_cursor;
5865 while ((trypos = findmatchlimit(NULL, '{', FM_BLOCKSTOP, 0)) != NULL)
5867 pos_copy = *trypos; /* copy pos_T, next findmatch will change it */
5868 trypos = &pos_copy;
5869 curwin->w_cursor = *trypos;
5870 pos = NULL;
5871 /* ignore the { if it's in a // or / * * / comment */
5872 if ((colnr_T)cin_skip2pos(trypos) == trypos->col
5873 && (pos = find_start_comment(ind_maxcomment)) == NULL) /* XXX */
5874 break;
5875 if (pos != NULL)
5876 curwin->w_cursor.lnum = pos->lnum;
5878 curwin->w_cursor = cursor_save;
5879 return trypos;
5883 * Find the matching '(', failing if it is in a comment.
5884 * Return NULL of no match found.
5886 static pos_T *
5887 find_match_paren(ind_maxparen, ind_maxcomment) /* XXX */
5888 int ind_maxparen;
5889 int ind_maxcomment;
5891 pos_T cursor_save;
5892 pos_T *trypos;
5893 static pos_T pos_copy;
5895 cursor_save = curwin->w_cursor;
5896 if ((trypos = findmatchlimit(NULL, '(', 0, ind_maxparen)) != NULL)
5898 /* check if the ( is in a // comment */
5899 if ((colnr_T)cin_skip2pos(trypos) > trypos->col)
5900 trypos = NULL;
5901 else
5903 pos_copy = *trypos; /* copy trypos, findmatch will change it */
5904 trypos = &pos_copy;
5905 curwin->w_cursor = *trypos;
5906 if (find_start_comment(ind_maxcomment) != NULL) /* XXX */
5907 trypos = NULL;
5910 curwin->w_cursor = cursor_save;
5911 return trypos;
5915 * Return ind_maxparen corrected for the difference in line number between the
5916 * cursor position and "startpos". This makes sure that searching for a
5917 * matching paren above the cursor line doesn't find a match because of
5918 * looking a few lines further.
5920 static int
5921 corr_ind_maxparen(ind_maxparen, startpos)
5922 int ind_maxparen;
5923 pos_T *startpos;
5925 long n = (long)startpos->lnum - (long)curwin->w_cursor.lnum;
5927 if (n > 0 && n < ind_maxparen / 2)
5928 return ind_maxparen - (int)n;
5929 return ind_maxparen;
5933 * Set w_cursor.col to the column number of the last unmatched ')' or '{' in
5934 * line "l".
5936 static int
5937 find_last_paren(l, start, end)
5938 char_u *l;
5939 int start, end;
5941 int i;
5942 int retval = FALSE;
5943 int open_count = 0;
5945 curwin->w_cursor.col = 0; /* default is start of line */
5947 for (i = 0; l[i]; i++)
5949 i = (int)(cin_skipcomment(l + i) - l); /* ignore parens in comments */
5950 i = (int)(skip_string(l + i) - l); /* ignore parens in quotes */
5951 if (l[i] == start)
5952 ++open_count;
5953 else if (l[i] == end)
5955 if (open_count > 0)
5956 --open_count;
5957 else
5959 curwin->w_cursor.col = i;
5960 retval = TRUE;
5964 return retval;
5968 get_c_indent()
5971 * spaces from a block's opening brace the prevailing indent for that
5972 * block should be
5974 int ind_level = curbuf->b_p_sw;
5977 * spaces from the edge of the line an open brace that's at the end of a
5978 * line is imagined to be.
5980 int ind_open_imag = 0;
5983 * spaces from the prevailing indent for a line that is not precededof by
5984 * an opening brace.
5986 int ind_no_brace = 0;
5989 * column where the first { of a function should be located }
5991 int ind_first_open = 0;
5994 * spaces from the prevailing indent a leftmost open brace should be
5995 * located
5997 int ind_open_extra = 0;
6000 * spaces from the matching open brace (real location for one at the left
6001 * edge; imaginary location from one that ends a line) the matching close
6002 * brace should be located
6004 int ind_close_extra = 0;
6007 * spaces from the edge of the line an open brace sitting in the leftmost
6008 * column is imagined to be
6010 int ind_open_left_imag = 0;
6013 * spaces from the switch() indent a "case xx" label should be located
6015 int ind_case = curbuf->b_p_sw;
6018 * spaces from the "case xx:" code after a switch() should be located
6020 int ind_case_code = curbuf->b_p_sw;
6023 * lineup break at end of case in switch() with case label
6025 int ind_case_break = 0;
6028 * spaces from the class declaration indent a scope declaration label
6029 * should be located
6031 int ind_scopedecl = curbuf->b_p_sw;
6034 * spaces from the scope declaration label code should be located
6036 int ind_scopedecl_code = curbuf->b_p_sw;
6039 * amount K&R-style parameters should be indented
6041 int ind_param = curbuf->b_p_sw;
6044 * amount a function type spec should be indented
6046 int ind_func_type = curbuf->b_p_sw;
6049 * amount a cpp base class declaration or constructor initialization
6050 * should be indented
6052 int ind_cpp_baseclass = curbuf->b_p_sw;
6055 * additional spaces beyond the prevailing indent a continuation line
6056 * should be located
6058 int ind_continuation = curbuf->b_p_sw;
6061 * spaces from the indent of the line with an unclosed parentheses
6063 int ind_unclosed = curbuf->b_p_sw * 2;
6066 * spaces from the indent of the line with an unclosed parentheses, which
6067 * itself is also unclosed
6069 int ind_unclosed2 = curbuf->b_p_sw;
6072 * suppress ignoring spaces from the indent of a line starting with an
6073 * unclosed parentheses.
6075 int ind_unclosed_noignore = 0;
6078 * If the opening paren is the last nonwhite character on the line, and
6079 * ind_unclosed_wrapped is nonzero, use this indent relative to the outer
6080 * context (for very long lines).
6082 int ind_unclosed_wrapped = 0;
6085 * suppress ignoring white space when lining up with the character after
6086 * an unclosed parentheses.
6088 int ind_unclosed_whiteok = 0;
6091 * indent a closing parentheses under the line start of the matching
6092 * opening parentheses.
6094 int ind_matching_paren = 0;
6097 * indent a closing parentheses under the previous line.
6099 int ind_paren_prev = 0;
6102 * Extra indent for comments.
6104 int ind_comment = 0;
6107 * spaces from the comment opener when there is nothing after it.
6109 int ind_in_comment = 3;
6112 * boolean: if non-zero, use ind_in_comment even if there is something
6113 * after the comment opener.
6115 int ind_in_comment2 = 0;
6118 * max lines to search for an open paren
6120 int ind_maxparen = 20;
6123 * max lines to search for an open comment
6125 int ind_maxcomment = 70;
6128 * handle braces for java code
6130 int ind_java = 0;
6133 * handle blocked cases correctly
6135 int ind_keep_case_label = 0;
6137 pos_T cur_curpos;
6138 int amount;
6139 int scope_amount;
6140 int cur_amount = MAXCOL;
6141 colnr_T col;
6142 char_u *theline;
6143 char_u *linecopy;
6144 pos_T *trypos;
6145 pos_T *tryposBrace = NULL;
6146 pos_T our_paren_pos;
6147 char_u *start;
6148 int start_brace;
6149 #define BRACE_IN_COL0 1 /* '{' is in comumn 0 */
6150 #define BRACE_AT_START 2 /* '{' is at start of line */
6151 #define BRACE_AT_END 3 /* '{' is at end of line */
6152 linenr_T ourscope;
6153 char_u *l;
6154 char_u *look;
6155 char_u terminated;
6156 int lookfor;
6157 #define LOOKFOR_INITIAL 0
6158 #define LOOKFOR_IF 1
6159 #define LOOKFOR_DO 2
6160 #define LOOKFOR_CASE 3
6161 #define LOOKFOR_ANY 4
6162 #define LOOKFOR_TERM 5
6163 #define LOOKFOR_UNTERM 6
6164 #define LOOKFOR_SCOPEDECL 7
6165 #define LOOKFOR_NOBREAK 8
6166 #define LOOKFOR_CPP_BASECLASS 9
6167 #define LOOKFOR_ENUM_OR_INIT 10
6169 int whilelevel;
6170 linenr_T lnum;
6171 char_u *options;
6172 int fraction = 0; /* init for GCC */
6173 int divider;
6174 int n;
6175 int iscase;
6176 int lookfor_break;
6177 int cont_amount = 0; /* amount for continuation line */
6179 for (options = curbuf->b_p_cino; *options; )
6181 l = options++;
6182 if (*options == '-')
6183 ++options;
6184 n = getdigits(&options);
6185 divider = 0;
6186 if (*options == '.') /* ".5s" means a fraction */
6188 fraction = atol((char *)++options);
6189 while (VIM_ISDIGIT(*options))
6191 ++options;
6192 if (divider)
6193 divider *= 10;
6194 else
6195 divider = 10;
6198 if (*options == 's') /* "2s" means two times 'shiftwidth' */
6200 if (n == 0 && fraction == 0)
6201 n = curbuf->b_p_sw; /* just "s" is one 'shiftwidth' */
6202 else
6204 n *= curbuf->b_p_sw;
6205 if (divider)
6206 n += (curbuf->b_p_sw * fraction + divider / 2) / divider;
6208 ++options;
6210 if (l[1] == '-')
6211 n = -n;
6212 /* When adding an entry here, also update the default 'cinoptions' in
6213 * doc/indent.txt, and add explanation for it! */
6214 switch (*l)
6216 case '>': ind_level = n; break;
6217 case 'e': ind_open_imag = n; break;
6218 case 'n': ind_no_brace = n; break;
6219 case 'f': ind_first_open = n; break;
6220 case '{': ind_open_extra = n; break;
6221 case '}': ind_close_extra = n; break;
6222 case '^': ind_open_left_imag = n; break;
6223 case ':': ind_case = n; break;
6224 case '=': ind_case_code = n; break;
6225 case 'b': ind_case_break = n; break;
6226 case 'p': ind_param = n; break;
6227 case 't': ind_func_type = n; break;
6228 case '/': ind_comment = n; break;
6229 case 'c': ind_in_comment = n; break;
6230 case 'C': ind_in_comment2 = n; break;
6231 case 'i': ind_cpp_baseclass = n; break;
6232 case '+': ind_continuation = n; break;
6233 case '(': ind_unclosed = n; break;
6234 case 'u': ind_unclosed2 = n; break;
6235 case 'U': ind_unclosed_noignore = n; break;
6236 case 'W': ind_unclosed_wrapped = n; break;
6237 case 'w': ind_unclosed_whiteok = n; break;
6238 case 'm': ind_matching_paren = n; break;
6239 case 'M': ind_paren_prev = n; break;
6240 case ')': ind_maxparen = n; break;
6241 case '*': ind_maxcomment = n; break;
6242 case 'g': ind_scopedecl = n; break;
6243 case 'h': ind_scopedecl_code = n; break;
6244 case 'j': ind_java = n; break;
6245 case 'l': ind_keep_case_label = n; break;
6246 case '#': ind_hash_comment = n; break;
6250 /* remember where the cursor was when we started */
6251 cur_curpos = curwin->w_cursor;
6253 /* Get a copy of the current contents of the line.
6254 * This is required, because only the most recent line obtained with
6255 * ml_get is valid! */
6256 linecopy = vim_strsave(ml_get(cur_curpos.lnum));
6257 if (linecopy == NULL)
6258 return 0;
6261 * In insert mode and the cursor is on a ')' truncate the line at the
6262 * cursor position. We don't want to line up with the matching '(' when
6263 * inserting new stuff.
6264 * For unknown reasons the cursor might be past the end of the line, thus
6265 * check for that.
6267 if ((State & INSERT)
6268 && curwin->w_cursor.col < STRLEN(linecopy)
6269 && linecopy[curwin->w_cursor.col] == ')')
6270 linecopy[curwin->w_cursor.col] = NUL;
6272 theline = skipwhite(linecopy);
6274 /* move the cursor to the start of the line */
6276 curwin->w_cursor.col = 0;
6279 * #defines and so on always go at the left when included in 'cinkeys'.
6281 if (*theline == '#' && (*linecopy == '#' || in_cinkeys('#', ' ', TRUE)))
6283 amount = 0;
6287 * Is it a non-case label? Then that goes at the left margin too.
6289 else if (cin_islabel(ind_maxcomment)) /* XXX */
6291 amount = 0;
6295 * If we're inside a "//" comment and there is a "//" comment in a
6296 * previous line, lineup with that one.
6298 else if (cin_islinecomment(theline)
6299 && (trypos = find_line_comment()) != NULL) /* XXX */
6301 /* find how indented the line beginning the comment is */
6302 getvcol(curwin, trypos, &col, NULL, NULL);
6303 amount = col;
6307 * If we're inside a comment and not looking at the start of the
6308 * comment, try using the 'comments' option.
6310 else if (!cin_iscomment(theline)
6311 && (trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
6313 int lead_start_len = 2;
6314 int lead_middle_len = 1;
6315 char_u lead_start[COM_MAX_LEN]; /* start-comment string */
6316 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
6317 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
6318 char_u *p;
6319 int start_align = 0;
6320 int start_off = 0;
6321 int done = FALSE;
6323 /* find how indented the line beginning the comment is */
6324 getvcol(curwin, trypos, &col, NULL, NULL);
6325 amount = col;
6327 p = curbuf->b_p_com;
6328 while (*p != NUL)
6330 int align = 0;
6331 int off = 0;
6332 int what = 0;
6334 while (*p != NUL && *p != ':')
6336 if (*p == COM_START || *p == COM_END || *p == COM_MIDDLE)
6337 what = *p++;
6338 else if (*p == COM_LEFT || *p == COM_RIGHT)
6339 align = *p++;
6340 else if (VIM_ISDIGIT(*p) || *p == '-')
6341 off = getdigits(&p);
6342 else
6343 ++p;
6346 if (*p == ':')
6347 ++p;
6348 (void)copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6349 if (what == COM_START)
6351 STRCPY(lead_start, lead_end);
6352 lead_start_len = (int)STRLEN(lead_start);
6353 start_off = off;
6354 start_align = align;
6356 else if (what == COM_MIDDLE)
6358 STRCPY(lead_middle, lead_end);
6359 lead_middle_len = (int)STRLEN(lead_middle);
6361 else if (what == COM_END)
6363 /* If our line starts with the middle comment string, line it
6364 * up with the comment opener per the 'comments' option. */
6365 if (STRNCMP(theline, lead_middle, lead_middle_len) == 0
6366 && STRNCMP(theline, lead_end, STRLEN(lead_end)) != 0)
6368 done = TRUE;
6369 if (curwin->w_cursor.lnum > 1)
6371 /* If the start comment string matches in the previous
6372 * line, use the indent of that line pluss offset. If
6373 * the middle comment string matches in the previous
6374 * line, use the indent of that line. XXX */
6375 look = skipwhite(ml_get(curwin->w_cursor.lnum - 1));
6376 if (STRNCMP(look, lead_start, lead_start_len) == 0)
6377 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6378 else if (STRNCMP(look, lead_middle,
6379 lead_middle_len) == 0)
6381 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6382 break;
6384 /* If the start comment string doesn't match with the
6385 * start of the comment, skip this entry. XXX */
6386 else if (STRNCMP(ml_get(trypos->lnum) + trypos->col,
6387 lead_start, lead_start_len) != 0)
6388 continue;
6390 if (start_off != 0)
6391 amount += start_off;
6392 else if (start_align == COM_RIGHT)
6393 amount += vim_strsize(lead_start)
6394 - vim_strsize(lead_middle);
6395 break;
6398 /* If our line starts with the end comment string, line it up
6399 * with the middle comment */
6400 if (STRNCMP(theline, lead_middle, lead_middle_len) != 0
6401 && STRNCMP(theline, lead_end, STRLEN(lead_end)) == 0)
6403 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6404 /* XXX */
6405 if (off != 0)
6406 amount += off;
6407 else if (align == COM_RIGHT)
6408 amount += vim_strsize(lead_start)
6409 - vim_strsize(lead_middle);
6410 done = TRUE;
6411 break;
6416 /* If our line starts with an asterisk, line up with the
6417 * asterisk in the comment opener; otherwise, line up
6418 * with the first character of the comment text.
6420 if (done)
6422 else if (theline[0] == '*')
6423 amount += 1;
6424 else
6427 * If we are more than one line away from the comment opener, take
6428 * the indent of the previous non-empty line. If 'cino' has "CO"
6429 * and we are just below the comment opener and there are any
6430 * white characters after it line up with the text after it;
6431 * otherwise, add the amount specified by "c" in 'cino'
6433 amount = -1;
6434 for (lnum = cur_curpos.lnum - 1; lnum > trypos->lnum; --lnum)
6436 if (linewhite(lnum)) /* skip blank lines */
6437 continue;
6438 amount = get_indent_lnum(lnum); /* XXX */
6439 break;
6441 if (amount == -1) /* use the comment opener */
6443 if (!ind_in_comment2)
6445 start = ml_get(trypos->lnum);
6446 look = start + trypos->col + 2; /* skip / and * */
6447 if (*look != NUL) /* if something after it */
6448 trypos->col = (colnr_T)(skipwhite(look) - start);
6450 getvcol(curwin, trypos, &col, NULL, NULL);
6451 amount = col;
6452 if (ind_in_comment2 || *look == NUL)
6453 amount += ind_in_comment;
6459 * Are we inside parentheses or braces?
6460 */ /* XXX */
6461 else if (((trypos = find_match_paren(ind_maxparen, ind_maxcomment)) != NULL
6462 && ind_java == 0)
6463 || (tryposBrace = find_start_brace(ind_maxcomment)) != NULL
6464 || trypos != NULL)
6466 if (trypos != NULL && tryposBrace != NULL)
6468 /* Both an unmatched '(' and '{' is found. Use the one which is
6469 * closer to the current cursor position, set the other to NULL. */
6470 if (trypos->lnum != tryposBrace->lnum
6471 ? trypos->lnum < tryposBrace->lnum
6472 : trypos->col < tryposBrace->col)
6473 trypos = NULL;
6474 else
6475 tryposBrace = NULL;
6478 if (trypos != NULL)
6481 * If the matching paren is more than one line away, use the indent of
6482 * a previous non-empty line that matches the same paren.
6484 if (theline[0] == ')' && ind_paren_prev)
6486 /* Line up with the start of the matching paren line. */
6487 amount = get_indent_lnum(curwin->w_cursor.lnum - 1); /* XXX */
6489 else
6491 amount = -1;
6492 our_paren_pos = *trypos;
6493 for (lnum = cur_curpos.lnum - 1; lnum > our_paren_pos.lnum; --lnum)
6495 l = skipwhite(ml_get(lnum));
6496 if (cin_nocode(l)) /* skip comment lines */
6497 continue;
6498 if (cin_ispreproc_cont(&l, &lnum))
6499 continue; /* ignore #define, #if, etc. */
6500 curwin->w_cursor.lnum = lnum;
6502 /* Skip a comment. XXX */
6503 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6505 lnum = trypos->lnum + 1;
6506 continue;
6509 /* XXX */
6510 if ((trypos = find_match_paren(
6511 corr_ind_maxparen(ind_maxparen, &cur_curpos),
6512 ind_maxcomment)) != NULL
6513 && trypos->lnum == our_paren_pos.lnum
6514 && trypos->col == our_paren_pos.col)
6516 amount = get_indent_lnum(lnum); /* XXX */
6518 if (theline[0] == ')')
6520 if (our_paren_pos.lnum != lnum
6521 && cur_amount > amount)
6522 cur_amount = amount;
6523 amount = -1;
6525 break;
6531 * Line up with line where the matching paren is. XXX
6532 * If the line starts with a '(' or the indent for unclosed
6533 * parentheses is zero, line up with the unclosed parentheses.
6535 if (amount == -1)
6537 int ignore_paren_col = 0;
6539 amount = skip_label(our_paren_pos.lnum, &look, ind_maxcomment);
6540 look = skipwhite(look);
6541 if (*look == '(')
6543 linenr_T save_lnum = curwin->w_cursor.lnum;
6544 char_u *line;
6545 int look_col;
6547 /* Ignore a '(' in front of the line that has a match before
6548 * our matching '('. */
6549 curwin->w_cursor.lnum = our_paren_pos.lnum;
6550 line = ml_get_curline();
6551 look_col = (int)(look - line);
6552 curwin->w_cursor.col = look_col + 1;
6553 if ((trypos = findmatchlimit(NULL, ')', 0, ind_maxparen))
6554 != NULL
6555 && trypos->lnum == our_paren_pos.lnum
6556 && trypos->col < our_paren_pos.col)
6557 ignore_paren_col = trypos->col + 1;
6559 curwin->w_cursor.lnum = save_lnum;
6560 look = ml_get(our_paren_pos.lnum) + look_col;
6562 if (theline[0] == ')' || ind_unclosed == 0
6563 || (!ind_unclosed_noignore && *look == '('
6564 && ignore_paren_col == 0))
6567 * If we're looking at a close paren, line up right there;
6568 * otherwise, line up with the next (non-white) character.
6569 * When ind_unclosed_wrapped is set and the matching paren is
6570 * the last nonwhite character of the line, use either the
6571 * indent of the current line or the indentation of the next
6572 * outer paren and add ind_unclosed_wrapped (for very long
6573 * lines).
6575 if (theline[0] != ')')
6577 cur_amount = MAXCOL;
6578 l = ml_get(our_paren_pos.lnum);
6579 if (ind_unclosed_wrapped
6580 && cin_ends_in(l, (char_u *)"(", NULL))
6582 /* look for opening unmatched paren, indent one level
6583 * for each additional level */
6584 n = 1;
6585 for (col = 0; col < our_paren_pos.col; ++col)
6587 switch (l[col])
6589 case '(':
6590 case '{': ++n;
6591 break;
6593 case ')':
6594 case '}': if (n > 1)
6595 --n;
6596 break;
6600 our_paren_pos.col = 0;
6601 amount += n * ind_unclosed_wrapped;
6603 else if (ind_unclosed_whiteok)
6604 our_paren_pos.col++;
6605 else
6607 col = our_paren_pos.col + 1;
6608 while (vim_iswhite(l[col]))
6609 col++;
6610 if (l[col] != NUL) /* In case of trailing space */
6611 our_paren_pos.col = col;
6612 else
6613 our_paren_pos.col++;
6618 * Find how indented the paren is, or the character after it
6619 * if we did the above "if".
6621 if (our_paren_pos.col > 0)
6623 getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
6624 if (cur_amount > (int)col)
6625 cur_amount = col;
6629 if (theline[0] == ')' && ind_matching_paren)
6631 /* Line up with the start of the matching paren line. */
6633 else if (ind_unclosed == 0 || (!ind_unclosed_noignore
6634 && *look == '(' && ignore_paren_col == 0))
6636 if (cur_amount != MAXCOL)
6637 amount = cur_amount;
6639 else
6641 /* Add ind_unclosed2 for each '(' before our matching one, but
6642 * ignore (void) before the line (ignore_paren_col). */
6643 col = our_paren_pos.col;
6644 while ((int)our_paren_pos.col > ignore_paren_col)
6646 --our_paren_pos.col;
6647 switch (*ml_get_pos(&our_paren_pos))
6649 case '(': amount += ind_unclosed2;
6650 col = our_paren_pos.col;
6651 break;
6652 case ')': amount -= ind_unclosed2;
6653 col = MAXCOL;
6654 break;
6658 /* Use ind_unclosed once, when the first '(' is not inside
6659 * braces */
6660 if (col == MAXCOL)
6661 amount += ind_unclosed;
6662 else
6664 curwin->w_cursor.lnum = our_paren_pos.lnum;
6665 curwin->w_cursor.col = col;
6666 if ((trypos = find_match_paren(ind_maxparen,
6667 ind_maxcomment)) != NULL)
6668 amount += ind_unclosed2;
6669 else
6670 amount += ind_unclosed;
6673 * For a line starting with ')' use the minimum of the two
6674 * positions, to avoid giving it more indent than the previous
6675 * lines:
6676 * func_long_name( if (x
6677 * arg && yy
6678 * ) ^ not here ) ^ not here
6680 if (cur_amount < amount)
6681 amount = cur_amount;
6685 /* add extra indent for a comment */
6686 if (cin_iscomment(theline))
6687 amount += ind_comment;
6691 * Are we at least inside braces, then?
6693 else
6695 trypos = tryposBrace;
6697 ourscope = trypos->lnum;
6698 start = ml_get(ourscope);
6701 * Now figure out how indented the line is in general.
6702 * If the brace was at the start of the line, we use that;
6703 * otherwise, check out the indentation of the line as
6704 * a whole and then add the "imaginary indent" to that.
6706 look = skipwhite(start);
6707 if (*look == '{')
6709 getvcol(curwin, trypos, &col, NULL, NULL);
6710 amount = col;
6711 if (*start == '{')
6712 start_brace = BRACE_IN_COL0;
6713 else
6714 start_brace = BRACE_AT_START;
6716 else
6719 * that opening brace might have been on a continuation
6720 * line. if so, find the start of the line.
6722 curwin->w_cursor.lnum = ourscope;
6725 * position the cursor over the rightmost paren, so that
6726 * matching it will take us back to the start of the line.
6728 lnum = ourscope;
6729 if (find_last_paren(start, '(', ')')
6730 && (trypos = find_match_paren(ind_maxparen,
6731 ind_maxcomment)) != NULL)
6732 lnum = trypos->lnum;
6735 * It could have been something like
6736 * case 1: if (asdf &&
6737 * ldfd) {
6740 if (ind_keep_case_label && cin_iscase(skipwhite(ml_get_curline())))
6741 amount = get_indent();
6742 else
6743 amount = skip_label(lnum, &l, ind_maxcomment);
6745 start_brace = BRACE_AT_END;
6749 * if we're looking at a closing brace, that's where
6750 * we want to be. otherwise, add the amount of room
6751 * that an indent is supposed to be.
6753 if (theline[0] == '}')
6756 * they may want closing braces to line up with something
6757 * other than the open brace. indulge them, if so.
6759 amount += ind_close_extra;
6761 else
6764 * If we're looking at an "else", try to find an "if"
6765 * to match it with.
6766 * If we're looking at a "while", try to find a "do"
6767 * to match it with.
6769 lookfor = LOOKFOR_INITIAL;
6770 if (cin_iselse(theline))
6771 lookfor = LOOKFOR_IF;
6772 else if (cin_iswhileofdo(theline, cur_curpos.lnum, ind_maxparen))
6773 /* XXX */
6774 lookfor = LOOKFOR_DO;
6775 if (lookfor != LOOKFOR_INITIAL)
6777 curwin->w_cursor.lnum = cur_curpos.lnum;
6778 if (find_match(lookfor, ourscope, ind_maxparen,
6779 ind_maxcomment) == OK)
6781 amount = get_indent(); /* XXX */
6782 goto theend;
6787 * We get here if we are not on an "while-of-do" or "else" (or
6788 * failed to find a matching "if").
6789 * Search backwards for something to line up with.
6790 * First set amount for when we don't find anything.
6794 * if the '{' is _really_ at the left margin, use the imaginary
6795 * location of a left-margin brace. Otherwise, correct the
6796 * location for ind_open_extra.
6799 if (start_brace == BRACE_IN_COL0) /* '{' is in column 0 */
6801 amount = ind_open_left_imag;
6803 else
6805 if (start_brace == BRACE_AT_END) /* '{' is at end of line */
6806 amount += ind_open_imag;
6807 else
6809 /* Compensate for adding ind_open_extra later. */
6810 amount -= ind_open_extra;
6811 if (amount < 0)
6812 amount = 0;
6816 lookfor_break = FALSE;
6818 if (cin_iscase(theline)) /* it's a switch() label */
6820 lookfor = LOOKFOR_CASE; /* find a previous switch() label */
6821 amount += ind_case;
6823 else if (cin_isscopedecl(theline)) /* private:, ... */
6825 lookfor = LOOKFOR_SCOPEDECL; /* class decl is this block */
6826 amount += ind_scopedecl;
6828 else
6830 if (ind_case_break && cin_isbreak(theline)) /* break; ... */
6831 lookfor_break = TRUE;
6833 lookfor = LOOKFOR_INITIAL;
6834 amount += ind_level; /* ind_level from start of block */
6836 scope_amount = amount;
6837 whilelevel = 0;
6840 * Search backwards. If we find something we recognize, line up
6841 * with that.
6843 * if we're looking at an open brace, indent
6844 * the usual amount relative to the conditional
6845 * that opens the block.
6847 curwin->w_cursor = cur_curpos;
6848 for (;;)
6850 curwin->w_cursor.lnum--;
6851 curwin->w_cursor.col = 0;
6854 * If we went all the way back to the start of our scope, line
6855 * up with it.
6857 if (curwin->w_cursor.lnum <= ourscope)
6859 /* we reached end of scope:
6860 * if looking for a enum or structure initialization
6861 * go further back:
6862 * if it is an initializer (enum xxx or xxx =), then
6863 * don't add ind_continuation, otherwise it is a variable
6864 * declaration:
6865 * int x,
6866 * here; <-- add ind_continuation
6868 if (lookfor == LOOKFOR_ENUM_OR_INIT)
6870 if (curwin->w_cursor.lnum == 0
6871 || curwin->w_cursor.lnum
6872 < ourscope - ind_maxparen)
6874 /* nothing found (abuse ind_maxparen as limit)
6875 * assume terminated line (i.e. a variable
6876 * initialization) */
6877 if (cont_amount > 0)
6878 amount = cont_amount;
6879 else
6880 amount += ind_continuation;
6881 break;
6884 l = ml_get_curline();
6887 * If we're in a comment now, skip to the start of the
6888 * comment.
6890 trypos = find_start_comment(ind_maxcomment);
6891 if (trypos != NULL)
6893 curwin->w_cursor.lnum = trypos->lnum + 1;
6894 continue;
6898 * Skip preprocessor directives and blank lines.
6900 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
6901 continue;
6903 if (cin_nocode(l))
6904 continue;
6906 terminated = cin_isterminated(l, FALSE, TRUE);
6909 * If we are at top level and the line looks like a
6910 * function declaration, we are done
6911 * (it's a variable declaration).
6913 if (start_brace != BRACE_IN_COL0
6914 || !cin_isfuncdecl(&l, curwin->w_cursor.lnum))
6916 /* if the line is terminated with another ','
6917 * it is a continued variable initialization.
6918 * don't add extra indent.
6919 * TODO: does not work, if a function
6920 * declaration is split over multiple lines:
6921 * cin_isfuncdecl returns FALSE then.
6923 if (terminated == ',')
6924 break;
6926 /* if it es a enum declaration or an assignment,
6927 * we are done.
6929 if (terminated != ';' && cin_isinit())
6930 break;
6932 /* nothing useful found */
6933 if (terminated == 0 || terminated == '{')
6934 continue;
6937 if (terminated != ';')
6939 /* Skip parens and braces. Position the cursor
6940 * over the rightmost paren, so that matching it
6941 * will take us back to the start of the line.
6942 */ /* XXX */
6943 trypos = NULL;
6944 if (find_last_paren(l, '(', ')'))
6945 trypos = find_match_paren(ind_maxparen,
6946 ind_maxcomment);
6948 if (trypos == NULL && find_last_paren(l, '{', '}'))
6949 trypos = find_start_brace(ind_maxcomment);
6951 if (trypos != NULL)
6953 curwin->w_cursor.lnum = trypos->lnum + 1;
6954 continue;
6958 /* it's a variable declaration, add indentation
6959 * like in
6960 * int a,
6961 * b;
6963 if (cont_amount > 0)
6964 amount = cont_amount;
6965 else
6966 amount += ind_continuation;
6968 else if (lookfor == LOOKFOR_UNTERM)
6970 if (cont_amount > 0)
6971 amount = cont_amount;
6972 else
6973 amount += ind_continuation;
6975 else if (lookfor != LOOKFOR_TERM
6976 && lookfor != LOOKFOR_CPP_BASECLASS)
6978 amount = scope_amount;
6979 if (theline[0] == '{')
6980 amount += ind_open_extra;
6982 break;
6986 * If we're in a comment now, skip to the start of the comment.
6987 */ /* XXX */
6988 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6990 curwin->w_cursor.lnum = trypos->lnum + 1;
6991 continue;
6994 l = ml_get_curline();
6997 * If this is a switch() label, may line up relative to that.
6998 * If this is a C++ scope declaration, do the same.
7000 iscase = cin_iscase(l);
7001 if (iscase || cin_isscopedecl(l))
7003 /* we are only looking for cpp base class
7004 * declaration/initialization any longer */
7005 if (lookfor == LOOKFOR_CPP_BASECLASS)
7006 break;
7008 /* When looking for a "do" we are not interested in
7009 * labels. */
7010 if (whilelevel > 0)
7011 continue;
7014 * case xx:
7015 * c = 99 + <- this indent plus continuation
7016 *-> here;
7018 if (lookfor == LOOKFOR_UNTERM
7019 || lookfor == LOOKFOR_ENUM_OR_INIT)
7021 if (cont_amount > 0)
7022 amount = cont_amount;
7023 else
7024 amount += ind_continuation;
7025 break;
7029 * case xx: <- line up with this case
7030 * x = 333;
7031 * case yy:
7033 if ( (iscase && lookfor == LOOKFOR_CASE)
7034 || (iscase && lookfor_break)
7035 || (!iscase && lookfor == LOOKFOR_SCOPEDECL))
7038 * Check that this case label is not for another
7039 * switch()
7040 */ /* XXX */
7041 if ((trypos = find_start_brace(ind_maxcomment)) ==
7042 NULL || trypos->lnum == ourscope)
7044 amount = get_indent(); /* XXX */
7045 break;
7047 continue;
7050 n = get_indent_nolabel(curwin->w_cursor.lnum); /* XXX */
7053 * case xx: if (cond) <- line up with this if
7054 * y = y + 1;
7055 * -> s = 99;
7057 * case xx:
7058 * if (cond) <- line up with this line
7059 * y = y + 1;
7060 * -> s = 99;
7062 if (lookfor == LOOKFOR_TERM)
7064 if (n)
7065 amount = n;
7067 if (!lookfor_break)
7068 break;
7072 * case xx: x = x + 1; <- line up with this x
7073 * -> y = y + 1;
7075 * case xx: if (cond) <- line up with this if
7076 * -> y = y + 1;
7078 if (n)
7080 amount = n;
7081 l = after_label(ml_get_curline());
7082 if (l != NULL && cin_is_cinword(l))
7084 if (theline[0] == '{')
7085 amount += ind_open_extra;
7086 else
7087 amount += ind_level + ind_no_brace;
7089 break;
7093 * Try to get the indent of a statement before the switch
7094 * label. If nothing is found, line up relative to the
7095 * switch label.
7096 * break; <- may line up with this line
7097 * case xx:
7098 * -> y = 1;
7100 scope_amount = get_indent() + (iscase /* XXX */
7101 ? ind_case_code : ind_scopedecl_code);
7102 lookfor = ind_case_break ? LOOKFOR_NOBREAK : LOOKFOR_ANY;
7103 continue;
7107 * Looking for a switch() label or C++ scope declaration,
7108 * ignore other lines, skip {}-blocks.
7110 if (lookfor == LOOKFOR_CASE || lookfor == LOOKFOR_SCOPEDECL)
7112 if (find_last_paren(l, '{', '}') && (trypos =
7113 find_start_brace(ind_maxcomment)) != NULL)
7114 curwin->w_cursor.lnum = trypos->lnum + 1;
7115 continue;
7119 * Ignore jump labels with nothing after them.
7121 if (cin_islabel(ind_maxcomment))
7123 l = after_label(ml_get_curline());
7124 if (l == NULL || cin_nocode(l))
7125 continue;
7129 * Ignore #defines, #if, etc.
7130 * Ignore comment and empty lines.
7131 * (need to get the line again, cin_islabel() may have
7132 * unlocked it)
7134 l = ml_get_curline();
7135 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum)
7136 || cin_nocode(l))
7137 continue;
7140 * Are we at the start of a cpp base class declaration or
7141 * constructor initialization?
7142 */ /* XXX */
7143 n = FALSE;
7144 if (lookfor != LOOKFOR_TERM && ind_cpp_baseclass > 0)
7146 n = cin_is_cpp_baseclass(&col);
7147 l = ml_get_curline();
7149 if (n)
7151 if (lookfor == LOOKFOR_UNTERM)
7153 if (cont_amount > 0)
7154 amount = cont_amount;
7155 else
7156 amount += ind_continuation;
7158 else if (theline[0] == '{')
7160 /* Need to find start of the declaration. */
7161 lookfor = LOOKFOR_UNTERM;
7162 ind_continuation = 0;
7163 continue;
7165 else
7166 /* XXX */
7167 amount = get_baseclass_amount(col, ind_maxparen,
7168 ind_maxcomment, ind_cpp_baseclass);
7169 break;
7171 else if (lookfor == LOOKFOR_CPP_BASECLASS)
7173 /* only look, whether there is a cpp base class
7174 * declaration or initialization before the opening brace.
7176 if (cin_isterminated(l, TRUE, FALSE))
7177 break;
7178 else
7179 continue;
7183 * What happens next depends on the line being terminated.
7184 * If terminated with a ',' only consider it terminating if
7185 * there is another unterminated statement behind, eg:
7186 * 123,
7187 * sizeof
7188 * here
7189 * Otherwise check whether it is a enumeration or structure
7190 * initialisation (not indented) or a variable declaration
7191 * (indented).
7193 terminated = cin_isterminated(l, FALSE, TRUE);
7195 if (terminated == 0 || (lookfor != LOOKFOR_UNTERM
7196 && terminated == ','))
7199 * if we're in the middle of a paren thing,
7200 * go back to the line that starts it so
7201 * we can get the right prevailing indent
7202 * if ( foo &&
7203 * bar )
7206 * position the cursor over the rightmost paren, so that
7207 * matching it will take us back to the start of the line.
7209 (void)find_last_paren(l, '(', ')');
7210 trypos = find_match_paren(
7211 corr_ind_maxparen(ind_maxparen, &cur_curpos),
7212 ind_maxcomment);
7215 * If we are looking for ',', we also look for matching
7216 * braces.
7218 if (trypos == NULL && terminated == ','
7219 && find_last_paren(l, '{', '}'))
7220 trypos = find_start_brace(ind_maxcomment);
7222 if (trypos != NULL)
7225 * Check if we are on a case label now. This is
7226 * handled above.
7227 * case xx: if ( asdf &&
7228 * asdf)
7230 curwin->w_cursor.lnum = trypos->lnum;
7231 l = ml_get_curline();
7232 if (cin_iscase(l) || cin_isscopedecl(l))
7234 ++curwin->w_cursor.lnum;
7235 continue;
7240 * Skip over continuation lines to find the one to get the
7241 * indent from
7242 * char *usethis = "bla\
7243 * bla",
7244 * here;
7246 if (terminated == ',')
7248 while (curwin->w_cursor.lnum > 1)
7250 l = ml_get(curwin->w_cursor.lnum - 1);
7251 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7252 break;
7253 --curwin->w_cursor.lnum;
7258 * Get indent and pointer to text for current line,
7259 * ignoring any jump label. XXX
7261 cur_amount = skip_label(curwin->w_cursor.lnum,
7262 &l, ind_maxcomment);
7265 * If this is just above the line we are indenting, and it
7266 * starts with a '{', line it up with this line.
7267 * while (not)
7268 * -> {
7271 if (terminated != ',' && lookfor != LOOKFOR_TERM
7272 && theline[0] == '{')
7274 amount = cur_amount;
7276 * Only add ind_open_extra when the current line
7277 * doesn't start with a '{', which must have a match
7278 * in the same line (scope is the same). Probably:
7279 * { 1, 2 },
7280 * -> { 3, 4 }
7282 if (*skipwhite(l) != '{')
7283 amount += ind_open_extra;
7285 if (ind_cpp_baseclass)
7287 /* have to look back, whether it is a cpp base
7288 * class declaration or initialization */
7289 lookfor = LOOKFOR_CPP_BASECLASS;
7290 continue;
7292 break;
7296 * Check if we are after an "if", "while", etc.
7297 * Also allow " } else".
7299 if (cin_is_cinword(l) || cin_iselse(skipwhite(l)))
7302 * Found an unterminated line after an if (), line up
7303 * with the last one.
7304 * if (cond)
7305 * 100 +
7306 * -> here;
7308 if (lookfor == LOOKFOR_UNTERM
7309 || lookfor == LOOKFOR_ENUM_OR_INIT)
7311 if (cont_amount > 0)
7312 amount = cont_amount;
7313 else
7314 amount += ind_continuation;
7315 break;
7319 * If this is just above the line we are indenting, we
7320 * are finished.
7321 * while (not)
7322 * -> here;
7323 * Otherwise this indent can be used when the line
7324 * before this is terminated.
7325 * yyy;
7326 * if (stat)
7327 * while (not)
7328 * xxx;
7329 * -> here;
7331 amount = cur_amount;
7332 if (theline[0] == '{')
7333 amount += ind_open_extra;
7334 if (lookfor != LOOKFOR_TERM)
7336 amount += ind_level + ind_no_brace;
7337 break;
7341 * Special trick: when expecting the while () after a
7342 * do, line up with the while()
7343 * do
7344 * x = 1;
7345 * -> here
7347 l = skipwhite(ml_get_curline());
7348 if (cin_isdo(l))
7350 if (whilelevel == 0)
7351 break;
7352 --whilelevel;
7356 * When searching for a terminated line, don't use the
7357 * one between the "if" and the "else".
7358 * Need to use the scope of this "else". XXX
7359 * If whilelevel != 0 continue looking for a "do {".
7361 if (cin_iselse(l)
7362 && whilelevel == 0
7363 && ((trypos = find_start_brace(ind_maxcomment))
7364 == NULL
7365 || find_match(LOOKFOR_IF, trypos->lnum,
7366 ind_maxparen, ind_maxcomment) == FAIL))
7367 break;
7371 * If we're below an unterminated line that is not an
7372 * "if" or something, we may line up with this line or
7373 * add something for a continuation line, depending on
7374 * the line before this one.
7376 else
7379 * Found two unterminated lines on a row, line up with
7380 * the last one.
7381 * c = 99 +
7382 * 100 +
7383 * -> here;
7385 if (lookfor == LOOKFOR_UNTERM)
7387 /* When line ends in a comma add extra indent */
7388 if (terminated == ',')
7389 amount += ind_continuation;
7390 break;
7393 if (lookfor == LOOKFOR_ENUM_OR_INIT)
7395 /* Found two lines ending in ',', lineup with the
7396 * lowest one, but check for cpp base class
7397 * declaration/initialization, if it is an
7398 * opening brace or we are looking just for
7399 * enumerations/initializations. */
7400 if (terminated == ',')
7402 if (ind_cpp_baseclass == 0)
7403 break;
7405 lookfor = LOOKFOR_CPP_BASECLASS;
7406 continue;
7409 /* Ignore unterminated lines in between, but
7410 * reduce indent. */
7411 if (amount > cur_amount)
7412 amount = cur_amount;
7414 else
7417 * Found first unterminated line on a row, may
7418 * line up with this line, remember its indent
7419 * 100 +
7420 * -> here;
7422 amount = cur_amount;
7425 * If previous line ends in ',', check whether we
7426 * are in an initialization or enum
7427 * struct xxx =
7429 * sizeof a,
7430 * 124 };
7431 * or a normal possible continuation line.
7432 * but only, of no other statement has been found
7433 * yet.
7435 if (lookfor == LOOKFOR_INITIAL && terminated == ',')
7437 lookfor = LOOKFOR_ENUM_OR_INIT;
7438 cont_amount = cin_first_id_amount();
7440 else
7442 if (lookfor == LOOKFOR_INITIAL
7443 && *l != NUL
7444 && l[STRLEN(l) - 1] == '\\')
7445 /* XXX */
7446 cont_amount = cin_get_equal_amount(
7447 curwin->w_cursor.lnum);
7448 if (lookfor != LOOKFOR_TERM)
7449 lookfor = LOOKFOR_UNTERM;
7456 * Check if we are after a while (cond);
7457 * If so: Ignore until the matching "do".
7459 /* XXX */
7460 else if (cin_iswhileofdo_end(terminated, ind_maxparen,
7461 ind_maxcomment))
7464 * Found an unterminated line after a while ();, line up
7465 * with the last one.
7466 * while (cond);
7467 * 100 + <- line up with this one
7468 * -> here;
7470 if (lookfor == LOOKFOR_UNTERM
7471 || lookfor == LOOKFOR_ENUM_OR_INIT)
7473 if (cont_amount > 0)
7474 amount = cont_amount;
7475 else
7476 amount += ind_continuation;
7477 break;
7480 if (whilelevel == 0)
7482 lookfor = LOOKFOR_TERM;
7483 amount = get_indent(); /* XXX */
7484 if (theline[0] == '{')
7485 amount += ind_open_extra;
7487 ++whilelevel;
7491 * We are after a "normal" statement.
7492 * If we had another statement we can stop now and use the
7493 * indent of that other statement.
7494 * Otherwise the indent of the current statement may be used,
7495 * search backwards for the next "normal" statement.
7497 else
7500 * Skip single break line, if before a switch label. It
7501 * may be lined up with the case label.
7503 if (lookfor == LOOKFOR_NOBREAK
7504 && cin_isbreak(skipwhite(ml_get_curline())))
7506 lookfor = LOOKFOR_ANY;
7507 continue;
7511 * Handle "do {" line.
7513 if (whilelevel > 0)
7515 l = cin_skipcomment(ml_get_curline());
7516 if (cin_isdo(l))
7518 amount = get_indent(); /* XXX */
7519 --whilelevel;
7520 continue;
7525 * Found a terminated line above an unterminated line. Add
7526 * the amount for a continuation line.
7527 * x = 1;
7528 * y = foo +
7529 * -> here;
7530 * or
7531 * int x = 1;
7532 * int foo,
7533 * -> here;
7535 if (lookfor == LOOKFOR_UNTERM
7536 || lookfor == LOOKFOR_ENUM_OR_INIT)
7538 if (cont_amount > 0)
7539 amount = cont_amount;
7540 else
7541 amount += ind_continuation;
7542 break;
7546 * Found a terminated line above a terminated line or "if"
7547 * etc. line. Use the amount of the line below us.
7548 * x = 1; x = 1;
7549 * if (asdf) y = 2;
7550 * while (asdf) ->here;
7551 * here;
7552 * ->foo;
7554 if (lookfor == LOOKFOR_TERM)
7556 if (!lookfor_break && whilelevel == 0)
7557 break;
7561 * First line above the one we're indenting is terminated.
7562 * To know what needs to be done look further backward for
7563 * a terminated line.
7565 else
7568 * position the cursor over the rightmost paren, so
7569 * that matching it will take us back to the start of
7570 * the line. Helps for:
7571 * func(asdr,
7572 * asdfasdf);
7573 * here;
7575 term_again:
7576 l = ml_get_curline();
7577 if (find_last_paren(l, '(', ')')
7578 && (trypos = find_match_paren(ind_maxparen,
7579 ind_maxcomment)) != NULL)
7582 * Check if we are on a case label now. This is
7583 * handled above.
7584 * case xx: if ( asdf &&
7585 * asdf)
7587 curwin->w_cursor.lnum = trypos->lnum;
7588 l = ml_get_curline();
7589 if (cin_iscase(l) || cin_isscopedecl(l))
7591 ++curwin->w_cursor.lnum;
7592 continue;
7596 /* When aligning with the case statement, don't align
7597 * with a statement after it.
7598 * case 1: { <-- don't use this { position
7599 * stat;
7601 * case 2:
7602 * stat;
7605 iscase = (ind_keep_case_label && cin_iscase(l));
7608 * Get indent and pointer to text for current line,
7609 * ignoring any jump label.
7611 amount = skip_label(curwin->w_cursor.lnum,
7612 &l, ind_maxcomment);
7614 if (theline[0] == '{')
7615 amount += ind_open_extra;
7616 /* See remark above: "Only add ind_open_extra.." */
7617 l = skipwhite(l);
7618 if (*l == '{')
7619 amount -= ind_open_extra;
7620 lookfor = iscase ? LOOKFOR_ANY : LOOKFOR_TERM;
7623 * When a terminated line starts with "else" skip to
7624 * the matching "if":
7625 * else 3;
7626 * indent this;
7627 * Need to use the scope of this "else". XXX
7628 * If whilelevel != 0 continue looking for a "do {".
7630 if (lookfor == LOOKFOR_TERM
7631 && *l != '}'
7632 && cin_iselse(l)
7633 && whilelevel == 0)
7635 if ((trypos = find_start_brace(ind_maxcomment))
7636 == NULL
7637 || find_match(LOOKFOR_IF, trypos->lnum,
7638 ind_maxparen, ind_maxcomment) == FAIL)
7639 break;
7640 continue;
7644 * If we're at the end of a block, skip to the start of
7645 * that block.
7647 curwin->w_cursor.col = 0;
7648 if (*cin_skipcomment(l) == '}'
7649 && (trypos = find_start_brace(ind_maxcomment))
7650 != NULL) /* XXX */
7652 curwin->w_cursor.lnum = trypos->lnum;
7653 /* if not "else {" check for terminated again */
7654 /* but skip block for "} else {" */
7655 l = cin_skipcomment(ml_get_curline());
7656 if (*l == '}' || !cin_iselse(l))
7657 goto term_again;
7658 ++curwin->w_cursor.lnum;
7666 /* add extra indent for a comment */
7667 if (cin_iscomment(theline))
7668 amount += ind_comment;
7672 * ok -- we're not inside any sort of structure at all!
7674 * this means we're at the top level, and everything should
7675 * basically just match where the previous line is, except
7676 * for the lines immediately following a function declaration,
7677 * which are K&R-style parameters and need to be indented.
7679 else
7682 * if our line starts with an open brace, forget about any
7683 * prevailing indent and make sure it looks like the start
7684 * of a function
7687 if (theline[0] == '{')
7689 amount = ind_first_open;
7693 * If the NEXT line is a function declaration, the current
7694 * line needs to be indented as a function type spec.
7695 * Don't do this if the current line looks like a comment
7696 * or if the current line is terminated, ie. ends in ';'.
7698 else if (cur_curpos.lnum < curbuf->b_ml.ml_line_count
7699 && !cin_nocode(theline)
7700 && !cin_ends_in(theline, (char_u *)":", NULL)
7701 && !cin_ends_in(theline, (char_u *)",", NULL)
7702 && cin_isfuncdecl(NULL, cur_curpos.lnum + 1)
7703 && !cin_isterminated(theline, FALSE, TRUE))
7705 amount = ind_func_type;
7707 else
7709 amount = 0;
7710 curwin->w_cursor = cur_curpos;
7712 /* search backwards until we find something we recognize */
7714 while (curwin->w_cursor.lnum > 1)
7716 curwin->w_cursor.lnum--;
7717 curwin->w_cursor.col = 0;
7719 l = ml_get_curline();
7722 * If we're in a comment now, skip to the start of the comment.
7723 */ /* XXX */
7724 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7726 curwin->w_cursor.lnum = trypos->lnum + 1;
7727 continue;
7731 * Are we at the start of a cpp base class declaration or
7732 * constructor initialization?
7733 */ /* XXX */
7734 n = FALSE;
7735 if (ind_cpp_baseclass != 0 && theline[0] != '{')
7737 n = cin_is_cpp_baseclass(&col);
7738 l = ml_get_curline();
7740 if (n)
7742 /* XXX */
7743 amount = get_baseclass_amount(col, ind_maxparen,
7744 ind_maxcomment, ind_cpp_baseclass);
7745 break;
7749 * Skip preprocessor directives and blank lines.
7751 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
7752 continue;
7754 if (cin_nocode(l))
7755 continue;
7758 * If the previous line ends in ',', use one level of
7759 * indentation:
7760 * int foo,
7761 * bar;
7762 * do this before checking for '}' in case of eg.
7763 * enum foobar
7765 * ...
7766 * } foo,
7767 * bar;
7769 n = 0;
7770 if (cin_ends_in(l, (char_u *)",", NULL)
7771 || (*l != NUL && (n = l[STRLEN(l) - 1]) == '\\'))
7773 /* take us back to opening paren */
7774 if (find_last_paren(l, '(', ')')
7775 && (trypos = find_match_paren(ind_maxparen,
7776 ind_maxcomment)) != NULL)
7777 curwin->w_cursor.lnum = trypos->lnum;
7779 /* For a line ending in ',' that is a continuation line go
7780 * back to the first line with a backslash:
7781 * char *foo = "bla\
7782 * bla",
7783 * here;
7785 while (n == 0 && curwin->w_cursor.lnum > 1)
7787 l = ml_get(curwin->w_cursor.lnum - 1);
7788 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7789 break;
7790 --curwin->w_cursor.lnum;
7793 amount = get_indent(); /* XXX */
7795 if (amount == 0)
7796 amount = cin_first_id_amount();
7797 if (amount == 0)
7798 amount = ind_continuation;
7799 break;
7803 * If the line looks like a function declaration, and we're
7804 * not in a comment, put it the left margin.
7806 if (cin_isfuncdecl(NULL, cur_curpos.lnum)) /* XXX */
7807 break;
7808 l = ml_get_curline();
7811 * Finding the closing '}' of a previous function. Put
7812 * current line at the left margin. For when 'cino' has "fs".
7814 if (*skipwhite(l) == '}')
7815 break;
7817 /* (matching {)
7818 * If the previous line ends on '};' (maybe followed by
7819 * comments) align at column 0. For example:
7820 * char *string_array[] = { "foo",
7821 * / * x * / "b};ar" }; / * foobar * /
7823 if (cin_ends_in(l, (char_u *)"};", NULL))
7824 break;
7827 * If the PREVIOUS line is a function declaration, the current
7828 * line (and the ones that follow) needs to be indented as
7829 * parameters.
7831 if (cin_isfuncdecl(&l, curwin->w_cursor.lnum))
7833 amount = ind_param;
7834 break;
7838 * If the previous line ends in ';' and the line before the
7839 * previous line ends in ',' or '\', ident to column zero:
7840 * int foo,
7841 * bar;
7842 * indent_to_0 here;
7844 if (cin_ends_in(l, (char_u *)";", NULL))
7846 l = ml_get(curwin->w_cursor.lnum - 1);
7847 if (cin_ends_in(l, (char_u *)",", NULL)
7848 || (*l != NUL && l[STRLEN(l) - 1] == '\\'))
7849 break;
7850 l = ml_get_curline();
7854 * Doesn't look like anything interesting -- so just
7855 * use the indent of this line.
7857 * Position the cursor over the rightmost paren, so that
7858 * matching it will take us back to the start of the line.
7860 find_last_paren(l, '(', ')');
7862 if ((trypos = find_match_paren(ind_maxparen,
7863 ind_maxcomment)) != NULL)
7864 curwin->w_cursor.lnum = trypos->lnum;
7865 amount = get_indent(); /* XXX */
7866 break;
7869 /* add extra indent for a comment */
7870 if (cin_iscomment(theline))
7871 amount += ind_comment;
7873 /* add extra indent if the previous line ended in a backslash:
7874 * "asdfasdf\
7875 * here";
7876 * char *foo = "asdf\
7877 * here";
7879 if (cur_curpos.lnum > 1)
7881 l = ml_get(cur_curpos.lnum - 1);
7882 if (*l != NUL && l[STRLEN(l) - 1] == '\\')
7884 cur_amount = cin_get_equal_amount(cur_curpos.lnum - 1);
7885 if (cur_amount > 0)
7886 amount = cur_amount;
7887 else if (cur_amount == 0)
7888 amount += ind_continuation;
7894 theend:
7895 /* put the cursor back where it belongs */
7896 curwin->w_cursor = cur_curpos;
7898 vim_free(linecopy);
7900 if (amount < 0)
7901 return 0;
7902 return amount;
7905 static int
7906 find_match(lookfor, ourscope, ind_maxparen, ind_maxcomment)
7907 int lookfor;
7908 linenr_T ourscope;
7909 int ind_maxparen;
7910 int ind_maxcomment;
7912 char_u *look;
7913 pos_T *theirscope;
7914 char_u *mightbeif;
7915 int elselevel;
7916 int whilelevel;
7918 if (lookfor == LOOKFOR_IF)
7920 elselevel = 1;
7921 whilelevel = 0;
7923 else
7925 elselevel = 0;
7926 whilelevel = 1;
7929 curwin->w_cursor.col = 0;
7931 while (curwin->w_cursor.lnum > ourscope + 1)
7933 curwin->w_cursor.lnum--;
7934 curwin->w_cursor.col = 0;
7936 look = cin_skipcomment(ml_get_curline());
7937 if (cin_iselse(look)
7938 || cin_isif(look)
7939 || cin_isdo(look) /* XXX */
7940 || cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7943 * if we've gone outside the braces entirely,
7944 * we must be out of scope...
7946 theirscope = find_start_brace(ind_maxcomment); /* XXX */
7947 if (theirscope == NULL)
7948 break;
7951 * and if the brace enclosing this is further
7952 * back than the one enclosing the else, we're
7953 * out of luck too.
7955 if (theirscope->lnum < ourscope)
7956 break;
7959 * and if they're enclosed in a *deeper* brace,
7960 * then we can ignore it because it's in a
7961 * different scope...
7963 if (theirscope->lnum > ourscope)
7964 continue;
7967 * if it was an "else" (that's not an "else if")
7968 * then we need to go back to another if, so
7969 * increment elselevel
7971 look = cin_skipcomment(ml_get_curline());
7972 if (cin_iselse(look))
7974 mightbeif = cin_skipcomment(look + 4);
7975 if (!cin_isif(mightbeif))
7976 ++elselevel;
7977 continue;
7981 * if it was a "while" then we need to go back to
7982 * another "do", so increment whilelevel. XXX
7984 if (cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7986 ++whilelevel;
7987 continue;
7990 /* If it's an "if" decrement elselevel */
7991 look = cin_skipcomment(ml_get_curline());
7992 if (cin_isif(look))
7994 elselevel--;
7996 * When looking for an "if" ignore "while"s that
7997 * get in the way.
7999 if (elselevel == 0 && lookfor == LOOKFOR_IF)
8000 whilelevel = 0;
8003 /* If it's a "do" decrement whilelevel */
8004 if (cin_isdo(look))
8005 whilelevel--;
8008 * if we've used up all the elses, then
8009 * this must be the if that we want!
8010 * match the indent level of that if.
8012 if (elselevel <= 0 && whilelevel <= 0)
8014 return OK;
8018 return FAIL;
8021 # if defined(FEAT_EVAL) || defined(PROTO)
8023 * Get indent level from 'indentexpr'.
8026 get_expr_indent()
8028 int indent;
8029 pos_T pos;
8030 int save_State;
8031 int use_sandbox = was_set_insecurely((char_u *)"indentexpr",
8032 OPT_LOCAL);
8034 pos = curwin->w_cursor;
8035 set_vim_var_nr(VV_LNUM, curwin->w_cursor.lnum);
8036 if (use_sandbox)
8037 ++sandbox;
8038 ++textlock;
8039 indent = eval_to_number(curbuf->b_p_inde);
8040 if (use_sandbox)
8041 --sandbox;
8042 --textlock;
8044 /* Restore the cursor position so that 'indentexpr' doesn't need to.
8045 * Pretend to be in Insert mode, allow cursor past end of line for "o"
8046 * command. */
8047 save_State = State;
8048 State = INSERT;
8049 curwin->w_cursor = pos;
8050 check_cursor();
8051 State = save_State;
8053 /* If there is an error, just keep the current indent. */
8054 if (indent < 0)
8055 indent = get_indent();
8057 return indent;
8059 # endif
8061 #endif /* FEAT_CINDENT */
8063 #if defined(FEAT_LISP) || defined(PROTO)
8065 static int lisp_match __ARGS((char_u *p));
8067 static int
8068 lisp_match(p)
8069 char_u *p;
8071 char_u buf[LSIZE];
8072 int len;
8073 char_u *word = p_lispwords;
8075 while (*word != NUL)
8077 (void)copy_option_part(&word, buf, LSIZE, ",");
8078 len = (int)STRLEN(buf);
8079 if (STRNCMP(buf, p, len) == 0 && p[len] == ' ')
8080 return TRUE;
8082 return FALSE;
8086 * When 'p' is present in 'cpoptions, a Vi compatible method is used.
8087 * The incompatible newer method is quite a bit better at indenting
8088 * code in lisp-like languages than the traditional one; it's still
8089 * mostly heuristics however -- Dirk van Deun, dirk@rave.org
8091 * TODO:
8092 * Findmatch() should be adapted for lisp, also to make showmatch
8093 * work correctly: now (v5.3) it seems all C/C++ oriented:
8094 * - it does not recognize the #\( and #\) notations as character literals
8095 * - it doesn't know about comments starting with a semicolon
8096 * - it incorrectly interprets '(' as a character literal
8097 * All this messes up get_lisp_indent in some rare cases.
8098 * Update from Sergey Khorev:
8099 * I tried to fix the first two issues.
8102 get_lisp_indent()
8104 pos_T *pos, realpos, paren;
8105 int amount;
8106 char_u *that;
8107 colnr_T col;
8108 colnr_T firsttry;
8109 int parencount, quotecount;
8110 int vi_lisp;
8112 /* Set vi_lisp to use the vi-compatible method */
8113 vi_lisp = (vim_strchr(p_cpo, CPO_LISP) != NULL);
8115 realpos = curwin->w_cursor;
8116 curwin->w_cursor.col = 0;
8118 if ((pos = findmatch(NULL, '(')) == NULL)
8119 pos = findmatch(NULL, '[');
8120 else
8122 paren = *pos;
8123 pos = findmatch(NULL, '[');
8124 if (pos == NULL || ltp(pos, &paren))
8125 pos = &paren;
8127 if (pos != NULL)
8129 /* Extra trick: Take the indent of the first previous non-white
8130 * line that is at the same () level. */
8131 amount = -1;
8132 parencount = 0;
8134 while (--curwin->w_cursor.lnum >= pos->lnum)
8136 if (linewhite(curwin->w_cursor.lnum))
8137 continue;
8138 for (that = ml_get_curline(); *that != NUL; ++that)
8140 if (*that == ';')
8142 while (*(that + 1) != NUL)
8143 ++that;
8144 continue;
8146 if (*that == '\\')
8148 if (*(that + 1) != NUL)
8149 ++that;
8150 continue;
8152 if (*that == '"' && *(that + 1) != NUL)
8154 while (*++that && *that != '"')
8156 /* skipping escaped characters in the string */
8157 if (*that == '\\')
8159 if (*++that == NUL)
8160 break;
8161 if (that[1] == NUL)
8163 ++that;
8164 break;
8169 if (*that == '(' || *that == '[')
8170 ++parencount;
8171 else if (*that == ')' || *that == ']')
8172 --parencount;
8174 if (parencount == 0)
8176 amount = get_indent();
8177 break;
8181 if (amount == -1)
8183 curwin->w_cursor.lnum = pos->lnum;
8184 curwin->w_cursor.col = pos->col;
8185 col = pos->col;
8187 that = ml_get_curline();
8189 if (vi_lisp && get_indent() == 0)
8190 amount = 2;
8191 else
8193 amount = 0;
8194 while (*that && col)
8196 amount += lbr_chartabsize_adv(&that, (colnr_T)amount);
8197 col--;
8201 * Some keywords require "body" indenting rules (the
8202 * non-standard-lisp ones are Scheme special forms):
8204 * (let ((a 1)) instead (let ((a 1))
8205 * (...)) of (...))
8208 if (!vi_lisp && (*that == '(' || *that == '[')
8209 && lisp_match(that + 1))
8210 amount += 2;
8211 else
8213 that++;
8214 amount++;
8215 firsttry = amount;
8217 while (vim_iswhite(*that))
8219 amount += lbr_chartabsize(that, (colnr_T)amount);
8220 ++that;
8223 if (*that && *that != ';') /* not a comment line */
8225 /* test *that != '(' to accomodate first let/do
8226 * argument if it is more than one line */
8227 if (!vi_lisp && *that != '(' && *that != '[')
8228 firsttry++;
8230 parencount = 0;
8231 quotecount = 0;
8233 if (vi_lisp
8234 || (*that != '"'
8235 && *that != '\''
8236 && *that != '#'
8237 && (*that < '0' || *that > '9')))
8239 while (*that
8240 && (!vim_iswhite(*that)
8241 || quotecount
8242 || parencount)
8243 && (!((*that == '(' || *that == '[')
8244 && !quotecount
8245 && !parencount
8246 && vi_lisp)))
8248 if (*that == '"')
8249 quotecount = !quotecount;
8250 if ((*that == '(' || *that == '[')
8251 && !quotecount)
8252 ++parencount;
8253 if ((*that == ')' || *that == ']')
8254 && !quotecount)
8255 --parencount;
8256 if (*that == '\\' && *(that+1) != NUL)
8257 amount += lbr_chartabsize_adv(&that,
8258 (colnr_T)amount);
8259 amount += lbr_chartabsize_adv(&that,
8260 (colnr_T)amount);
8263 while (vim_iswhite(*that))
8265 amount += lbr_chartabsize(that, (colnr_T)amount);
8266 that++;
8268 if (!*that || *that == ';')
8269 amount = firsttry;
8275 else
8276 amount = 0; /* no matching '(' or '[' found, use zero indent */
8278 curwin->w_cursor = realpos;
8280 return amount;
8282 #endif /* FEAT_LISP */
8284 void
8285 prepare_to_exit()
8287 #if defined(SIGHUP) && defined(SIG_IGN)
8288 /* Ignore SIGHUP, because a dropped connection causes a read error, which
8289 * makes Vim exit and then handling SIGHUP causes various reentrance
8290 * problems. */
8291 signal(SIGHUP, SIG_IGN);
8292 #endif
8294 #ifdef FEAT_GUI
8295 if (gui.in_use)
8297 gui.dying = TRUE;
8298 out_trash(); /* trash any pending output */
8300 else
8301 #endif
8303 windgoto((int)Rows - 1, 0);
8306 * Switch terminal mode back now, so messages end up on the "normal"
8307 * screen (if there are two screens).
8309 settmode(TMODE_COOK);
8310 #ifdef WIN3264
8311 if (can_end_termcap_mode(FALSE) == TRUE)
8312 #endif
8313 stoptermcap();
8314 out_flush();
8319 * Preserve files and exit.
8320 * When called IObuff must contain a message.
8322 void
8323 preserve_exit()
8325 buf_T *buf;
8327 prepare_to_exit();
8329 /* Setting this will prevent free() calls. That avoids calling free()
8330 * recursively when free() was invoked with a bad pointer. */
8331 really_exiting = TRUE;
8333 out_str(IObuff);
8334 screen_start(); /* don't know where cursor is now */
8335 out_flush();
8337 ml_close_notmod(); /* close all not-modified buffers */
8339 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8341 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
8343 OUT_STR(_("Vim: preserving files...\n"));
8344 screen_start(); /* don't know where cursor is now */
8345 out_flush();
8346 ml_sync_all(FALSE, FALSE); /* preserve all swap files */
8347 break;
8351 ml_close_all(FALSE); /* close all memfiles, without deleting */
8353 OUT_STR(_("Vim: Finished.\n"));
8355 getout(1);
8359 * return TRUE if "fname" exists.
8362 vim_fexists(fname)
8363 char_u *fname;
8365 struct stat st;
8367 if (mch_stat((char *)fname, &st))
8368 return FALSE;
8369 return TRUE;
8373 * Check for CTRL-C pressed, but only once in a while.
8374 * Should be used instead of ui_breakcheck() for functions that check for
8375 * each line in the file. Calling ui_breakcheck() each time takes too much
8376 * time, because it can be a system call.
8379 #ifndef BREAKCHECK_SKIP
8380 # ifdef FEAT_GUI /* assume the GUI only runs on fast computers */
8381 # define BREAKCHECK_SKIP 200
8382 # else
8383 # define BREAKCHECK_SKIP 32
8384 # endif
8385 #endif
8387 static int breakcheck_count = 0;
8389 void
8390 line_breakcheck()
8392 if (++breakcheck_count >= BREAKCHECK_SKIP)
8394 breakcheck_count = 0;
8395 ui_breakcheck();
8400 * Like line_breakcheck() but check 10 times less often.
8402 void
8403 fast_breakcheck()
8405 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
8407 breakcheck_count = 0;
8408 ui_breakcheck();
8413 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
8414 * 'wildignore'.
8415 * Returns OK or FAIL.
8418 expand_wildcards(num_pat, pat, num_file, file, flags)
8419 int num_pat; /* number of input patterns */
8420 char_u **pat; /* array of input patterns */
8421 int *num_file; /* resulting number of files */
8422 char_u ***file; /* array of resulting files */
8423 int flags; /* EW_DIR, etc. */
8425 int retval;
8426 int i, j;
8427 char_u *p;
8428 int non_suf_match; /* number without matching suffix */
8430 retval = gen_expand_wildcards(num_pat, pat, num_file, file, flags);
8432 /* When keeping all matches, return here */
8433 if (flags & EW_KEEPALL)
8434 return retval;
8436 #ifdef FEAT_WILDIGN
8438 * Remove names that match 'wildignore'.
8440 if (*p_wig)
8442 char_u *ffname;
8444 /* check all files in (*file)[] */
8445 for (i = 0; i < *num_file; ++i)
8447 ffname = FullName_save((*file)[i], FALSE);
8448 if (ffname == NULL) /* out of memory */
8449 break;
8450 # ifdef VMS
8451 vms_remove_version(ffname);
8452 # endif
8453 if (match_file_list(p_wig, (*file)[i], ffname))
8455 /* remove this matching file from the list */
8456 vim_free((*file)[i]);
8457 for (j = i; j + 1 < *num_file; ++j)
8458 (*file)[j] = (*file)[j + 1];
8459 --*num_file;
8460 --i;
8462 vim_free(ffname);
8465 #endif
8468 * Move the names where 'suffixes' match to the end.
8470 if (*num_file > 1)
8472 non_suf_match = 0;
8473 for (i = 0; i < *num_file; ++i)
8475 if (!match_suffix((*file)[i]))
8478 * Move the name without matching suffix to the front
8479 * of the list.
8481 p = (*file)[i];
8482 for (j = i; j > non_suf_match; --j)
8483 (*file)[j] = (*file)[j - 1];
8484 (*file)[non_suf_match++] = p;
8489 return retval;
8493 * Return TRUE if "fname" matches with an entry in 'suffixes'.
8496 match_suffix(fname)
8497 char_u *fname;
8499 int fnamelen, setsuflen;
8500 char_u *setsuf;
8501 #define MAXSUFLEN 30 /* maximum length of a file suffix */
8502 char_u suf_buf[MAXSUFLEN];
8504 fnamelen = (int)STRLEN(fname);
8505 setsuflen = 0;
8506 for (setsuf = p_su; *setsuf; )
8508 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
8509 if (fnamelen >= setsuflen
8510 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
8511 (size_t)setsuflen) == 0)
8512 break;
8513 setsuflen = 0;
8515 return (setsuflen != 0);
8518 #if !defined(NO_EXPANDPATH) || defined(PROTO)
8520 # ifdef VIM_BACKTICK
8521 static int vim_backtick __ARGS((char_u *p));
8522 static int expand_backtick __ARGS((garray_T *gap, char_u *pat, int flags));
8523 # endif
8525 # if defined(MSDOS) || defined(FEAT_GUI_W16) || defined(WIN3264)
8527 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
8528 * it's shared between these systems.
8530 # if defined(DJGPP) || defined(PROTO)
8531 # define _cdecl /* DJGPP doesn't have this */
8532 # else
8533 # ifdef __BORLANDC__
8534 # define _cdecl _RTLENTRYF
8535 # endif
8536 # endif
8539 * comparison function for qsort in dos_expandpath()
8541 static int _cdecl
8542 pstrcmp(const void *a, const void *b)
8544 return (pathcmp(*(char **)a, *(char **)b, -1));
8547 # ifndef WIN3264
8548 static void
8549 namelowcpy(
8550 char_u *d,
8551 char_u *s)
8553 # ifdef DJGPP
8554 if (USE_LONG_FNAME) /* don't lower case on Windows 95/NT systems */
8555 while (*s)
8556 *d++ = *s++;
8557 else
8558 # endif
8559 while (*s)
8560 *d++ = TOLOWER_LOC(*s++);
8561 *d = NUL;
8563 # endif
8566 * Recursively expand one path component into all matching files and/or
8567 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8568 * Return the number of matches found.
8569 * "path" has backslashes before chars that are not to be expanded, starting
8570 * at "path[wildoff]".
8571 * Return the number of matches found.
8572 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
8574 static int
8575 dos_expandpath(
8576 garray_T *gap,
8577 char_u *path,
8578 int wildoff,
8579 int flags, /* EW_* flags */
8580 int didstar) /* expanded "**" once already */
8582 char_u *buf;
8583 char_u *path_end;
8584 char_u *p, *s, *e;
8585 int start_len = gap->ga_len;
8586 char_u *pat;
8587 regmatch_T regmatch;
8588 int starts_with_dot;
8589 int matches;
8590 int len;
8591 int starstar = FALSE;
8592 static int stardepth = 0; /* depth for "**" expansion */
8593 #ifdef WIN3264
8594 WIN32_FIND_DATA fb;
8595 HANDLE hFind = (HANDLE)0;
8596 # ifdef FEAT_MBYTE
8597 WIN32_FIND_DATAW wfb;
8598 WCHAR *wn = NULL; /* UCS-2 name, NULL when not used. */
8599 # endif
8600 #else
8601 struct ffblk fb;
8602 #endif
8603 char_u *matchname;
8604 int ok;
8606 /* Expanding "**" may take a long time, check for CTRL-C. */
8607 if (stardepth > 0)
8609 ui_breakcheck();
8610 if (got_int)
8611 return 0;
8614 /* make room for file name */
8615 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8616 if (buf == NULL)
8617 return 0;
8620 * Find the first part in the path name that contains a wildcard or a ~1.
8621 * Copy it into buf, including the preceding characters.
8623 p = buf;
8624 s = buf;
8625 e = NULL;
8626 path_end = path;
8627 while (*path_end != NUL)
8629 /* May ignore a wildcard that has a backslash before it; it will
8630 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8631 if (path_end >= path + wildoff && rem_backslash(path_end))
8632 *p++ = *path_end++;
8633 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
8635 if (e != NULL)
8636 break;
8637 s = p + 1;
8639 else if (path_end >= path + wildoff
8640 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
8641 e = p;
8642 #ifdef FEAT_MBYTE
8643 if (has_mbyte)
8645 len = (*mb_ptr2len)(path_end);
8646 STRNCPY(p, path_end, len);
8647 p += len;
8648 path_end += len;
8650 else
8651 #endif
8652 *p++ = *path_end++;
8654 e = p;
8655 *e = NUL;
8657 /* now we have one wildcard component between s and e */
8658 /* Remove backslashes between "wildoff" and the start of the wildcard
8659 * component. */
8660 for (p = buf + wildoff; p < s; ++p)
8661 if (rem_backslash(p))
8663 mch_memmove(p, p + 1, STRLEN(p));
8664 --e;
8665 --s;
8668 /* Check for "**" between "s" and "e". */
8669 for (p = s; p < e; ++p)
8670 if (p[0] == '*' && p[1] == '*')
8671 starstar = TRUE;
8673 starts_with_dot = (*s == '.');
8674 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8675 if (pat == NULL)
8677 vim_free(buf);
8678 return 0;
8681 /* compile the regexp into a program */
8682 regmatch.rm_ic = TRUE; /* Always ignore case */
8683 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8684 vim_free(pat);
8686 if (regmatch.regprog == NULL)
8688 vim_free(buf);
8689 return 0;
8692 /* remember the pattern or file name being looked for */
8693 matchname = vim_strsave(s);
8695 /* If "**" is by itself, this is the first time we encounter it and more
8696 * is following then find matches without any directory. */
8697 if (!didstar && stardepth < 100 && starstar && e - s == 2
8698 && *path_end == '/')
8700 STRCPY(s, path_end + 1);
8701 ++stardepth;
8702 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8703 --stardepth;
8706 /* Scan all files in the directory with "dir/ *.*" */
8707 STRCPY(s, "*.*");
8708 #ifdef WIN3264
8709 # ifdef FEAT_MBYTE
8710 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
8712 /* The active codepage differs from 'encoding'. Attempt using the
8713 * wide function. If it fails because it is not implemented fall back
8714 * to the non-wide version (for Windows 98) */
8715 wn = enc_to_ucs2(buf, NULL);
8716 if (wn != NULL)
8718 hFind = FindFirstFileW(wn, &wfb);
8719 if (hFind == INVALID_HANDLE_VALUE
8720 && GetLastError() == ERROR_CALL_NOT_IMPLEMENTED)
8722 vim_free(wn);
8723 wn = NULL;
8728 if (wn == NULL)
8729 # endif
8730 hFind = FindFirstFile(buf, &fb);
8731 ok = (hFind != INVALID_HANDLE_VALUE);
8732 #else
8733 /* If we are expanding wildcards we try both files and directories */
8734 ok = (findfirst((char *)buf, &fb,
8735 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8736 #endif
8738 while (ok)
8740 #ifdef WIN3264
8741 # ifdef FEAT_MBYTE
8742 if (wn != NULL)
8743 p = ucs2_to_enc(wfb.cFileName, NULL); /* p is allocated here */
8744 else
8745 # endif
8746 p = (char_u *)fb.cFileName;
8747 #else
8748 p = (char_u *)fb.ff_name;
8749 #endif
8750 /* Ignore entries starting with a dot, unless when asked for. Accept
8751 * all entries found with "matchname". */
8752 if ((p[0] != '.' || starts_with_dot)
8753 && (matchname == NULL
8754 || vim_regexec(&regmatch, p, (colnr_T)0)))
8756 #ifdef WIN3264
8757 STRCPY(s, p);
8758 #else
8759 namelowcpy(s, p);
8760 #endif
8761 len = (int)STRLEN(buf);
8763 if (starstar && stardepth < 100)
8765 /* For "**" in the pattern first go deeper in the tree to
8766 * find matches. */
8767 STRCPY(buf + len, "/**");
8768 STRCPY(buf + len + 3, path_end);
8769 ++stardepth;
8770 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
8771 --stardepth;
8774 STRCPY(buf + len, path_end);
8775 if (mch_has_exp_wildcard(path_end))
8777 /* need to expand another component of the path */
8778 /* remove backslashes for the remaining components only */
8779 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
8781 else
8783 /* no more wildcards, check if there is a match */
8784 /* remove backslashes for the remaining components only */
8785 if (*path_end != 0)
8786 backslash_halve(buf + len + 1);
8787 if (mch_getperm(buf) >= 0) /* add existing file */
8788 addfile(gap, buf, flags);
8792 #ifdef WIN3264
8793 # ifdef FEAT_MBYTE
8794 if (wn != NULL)
8796 vim_free(p);
8797 ok = FindNextFileW(hFind, &wfb);
8799 else
8800 # endif
8801 ok = FindNextFile(hFind, &fb);
8802 #else
8803 ok = (findnext(&fb) == 0);
8804 #endif
8806 /* If no more matches and no match was used, try expanding the name
8807 * itself. Finds the long name of a short filename. */
8808 if (!ok && matchname != NULL && gap->ga_len == start_len)
8810 STRCPY(s, matchname);
8811 #ifdef WIN3264
8812 FindClose(hFind);
8813 # ifdef FEAT_MBYTE
8814 if (wn != NULL)
8816 vim_free(wn);
8817 wn = enc_to_ucs2(buf, NULL);
8818 if (wn != NULL)
8819 hFind = FindFirstFileW(wn, &wfb);
8821 if (wn == NULL)
8822 # endif
8823 hFind = FindFirstFile(buf, &fb);
8824 ok = (hFind != INVALID_HANDLE_VALUE);
8825 #else
8826 ok = (findfirst((char *)buf, &fb,
8827 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8828 #endif
8829 vim_free(matchname);
8830 matchname = NULL;
8834 #ifdef WIN3264
8835 FindClose(hFind);
8836 # ifdef FEAT_MBYTE
8837 vim_free(wn);
8838 # endif
8839 #endif
8840 vim_free(buf);
8841 vim_free(regmatch.regprog);
8842 vim_free(matchname);
8844 matches = gap->ga_len - start_len;
8845 if (matches > 0)
8846 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
8847 sizeof(char_u *), pstrcmp);
8848 return matches;
8852 mch_expandpath(
8853 garray_T *gap,
8854 char_u *path,
8855 int flags) /* EW_* flags */
8857 return dos_expandpath(gap, path, 0, flags, FALSE);
8859 # endif /* MSDOS || FEAT_GUI_W16 || WIN3264 */
8861 #if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
8862 || defined(PROTO)
8864 * Unix style wildcard expansion code.
8865 * It's here because it's used both for Unix and Mac.
8867 static int pstrcmp __ARGS((const void *, const void *));
8869 static int
8870 pstrcmp(a, b)
8871 const void *a, *b;
8873 return (pathcmp(*(char **)a, *(char **)b, -1));
8877 * Recursively expand one path component into all matching files and/or
8878 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8879 * "path" has backslashes before chars that are not to be expanded, starting
8880 * at "path + wildoff".
8881 * Return the number of matches found.
8882 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
8885 unix_expandpath(gap, path, wildoff, flags, didstar)
8886 garray_T *gap;
8887 char_u *path;
8888 int wildoff;
8889 int flags; /* EW_* flags */
8890 int didstar; /* expanded "**" once already */
8892 char_u *buf;
8893 char_u *path_end;
8894 char_u *p, *s, *e;
8895 int start_len = gap->ga_len;
8896 char_u *pat;
8897 regmatch_T regmatch;
8898 int starts_with_dot;
8899 int matches;
8900 int len;
8901 int starstar = FALSE;
8902 static int stardepth = 0; /* depth for "**" expansion */
8904 DIR *dirp;
8905 struct dirent *dp;
8907 /* Expanding "**" may take a long time, check for CTRL-C. */
8908 if (stardepth > 0)
8910 ui_breakcheck();
8911 if (got_int)
8912 return 0;
8915 /* make room for file name */
8916 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8917 if (buf == NULL)
8918 return 0;
8921 * Find the first part in the path name that contains a wildcard.
8922 * Copy it into "buf", including the preceding characters.
8924 p = buf;
8925 s = buf;
8926 e = NULL;
8927 path_end = path;
8928 while (*path_end != NUL)
8930 /* May ignore a wildcard that has a backslash before it; it will
8931 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8932 if (path_end >= path + wildoff && rem_backslash(path_end))
8933 *p++ = *path_end++;
8934 else if (*path_end == '/')
8936 if (e != NULL)
8937 break;
8938 s = p + 1;
8940 else if (path_end >= path + wildoff
8941 && vim_strchr((char_u *)"*?[{~$", *path_end) != NULL)
8942 e = p;
8943 #ifdef FEAT_MBYTE
8944 if (has_mbyte)
8946 len = (*mb_ptr2len)(path_end);
8947 STRNCPY(p, path_end, len);
8948 p += len;
8949 path_end += len;
8951 else
8952 #endif
8953 *p++ = *path_end++;
8955 e = p;
8956 *e = NUL;
8958 /* now we have one wildcard component between "s" and "e" */
8959 /* Remove backslashes between "wildoff" and the start of the wildcard
8960 * component. */
8961 for (p = buf + wildoff; p < s; ++p)
8962 if (rem_backslash(p))
8964 mch_memmove(p, p + 1, STRLEN(p));
8965 --e;
8966 --s;
8969 /* Check for "**" between "s" and "e". */
8970 for (p = s; p < e; ++p)
8971 if (p[0] == '*' && p[1] == '*')
8972 starstar = TRUE;
8974 /* convert the file pattern to a regexp pattern */
8975 starts_with_dot = (*s == '.');
8976 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8977 if (pat == NULL)
8979 vim_free(buf);
8980 return 0;
8983 /* compile the regexp into a program */
8984 #ifdef CASE_INSENSITIVE_FILENAME
8985 regmatch.rm_ic = TRUE; /* Behave like Terminal.app */
8986 #else
8987 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
8988 #endif
8989 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8990 vim_free(pat);
8992 if (regmatch.regprog == NULL)
8994 vim_free(buf);
8995 return 0;
8998 /* If "**" is by itself, this is the first time we encounter it and more
8999 * is following then find matches without any directory. */
9000 if (!didstar && stardepth < 100 && starstar && e - s == 2
9001 && *path_end == '/')
9003 STRCPY(s, path_end + 1);
9004 ++stardepth;
9005 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
9006 --stardepth;
9009 /* open the directory for scanning */
9010 *s = NUL;
9011 dirp = opendir(*buf == NUL ? "." : (char *)buf);
9013 /* Find all matching entries */
9014 if (dirp != NULL)
9016 for (;;)
9018 dp = readdir(dirp);
9019 if (dp == NULL)
9020 break;
9021 if ((dp->d_name[0] != '.' || starts_with_dot)
9022 && vim_regexec(&regmatch, (char_u *)dp->d_name, (colnr_T)0))
9024 STRCPY(s, dp->d_name);
9025 len = STRLEN(buf);
9027 if (starstar && stardepth < 100)
9029 /* For "**" in the pattern first go deeper in the tree to
9030 * find matches. */
9031 STRCPY(buf + len, "/**");
9032 STRCPY(buf + len + 3, path_end);
9033 ++stardepth;
9034 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
9035 --stardepth;
9038 STRCPY(buf + len, path_end);
9039 if (mch_has_exp_wildcard(path_end)) /* handle more wildcards */
9041 /* need to expand another component of the path */
9042 /* remove backslashes for the remaining components only */
9043 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
9045 else
9047 /* no more wildcards, check if there is a match */
9048 /* remove backslashes for the remaining components only */
9049 if (*path_end != NUL)
9050 backslash_halve(buf + len + 1);
9051 if (mch_getperm(buf) >= 0) /* add existing file */
9053 #ifdef MACOS_CONVERT
9054 size_t precomp_len = STRLEN(buf)+1;
9055 char_u *precomp_buf =
9056 mac_precompose_path(buf, precomp_len, &precomp_len);
9058 if (precomp_buf)
9060 mch_memmove(buf, precomp_buf, precomp_len);
9061 vim_free(precomp_buf);
9063 #endif
9064 addfile(gap, buf, flags);
9070 closedir(dirp);
9073 vim_free(buf);
9074 vim_free(regmatch.regprog);
9076 matches = gap->ga_len - start_len;
9077 if (matches > 0)
9078 qsort(((char_u **)gap->ga_data) + start_len, matches,
9079 sizeof(char_u *), pstrcmp);
9080 return matches;
9082 #endif
9085 * Generic wildcard expansion code.
9087 * Characters in "pat" that should not be expanded must be preceded with a
9088 * backslash. E.g., "/path\ with\ spaces/my\*star*"
9090 * Return FAIL when no single file was found. In this case "num_file" is not
9091 * set, and "file" may contain an error message.
9092 * Return OK when some files found. "num_file" is set to the number of
9093 * matches, "file" to the array of matches. Call FreeWild() later.
9096 gen_expand_wildcards(num_pat, pat, num_file, file, flags)
9097 int num_pat; /* number of input patterns */
9098 char_u **pat; /* array of input patterns */
9099 int *num_file; /* resulting number of files */
9100 char_u ***file; /* array of resulting files */
9101 int flags; /* EW_* flags */
9103 int i;
9104 garray_T ga;
9105 char_u *p;
9106 static int recursive = FALSE;
9107 int add_pat;
9110 * expand_env() is called to expand things like "~user". If this fails,
9111 * it calls ExpandOne(), which brings us back here. In this case, always
9112 * call the machine specific expansion function, if possible. Otherwise,
9113 * return FAIL.
9115 if (recursive)
9116 #ifdef SPECIAL_WILDCHAR
9117 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9118 #else
9119 return FAIL;
9120 #endif
9122 #ifdef SPECIAL_WILDCHAR
9124 * If there are any special wildcard characters which we cannot handle
9125 * here, call machine specific function for all the expansion. This
9126 * avoids starting the shell for each argument separately.
9127 * For `=expr` do use the internal function.
9129 for (i = 0; i < num_pat; i++)
9131 if (vim_strpbrk(pat[i], (char_u *)SPECIAL_WILDCHAR) != NULL
9132 # ifdef VIM_BACKTICK
9133 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
9134 # endif
9136 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9138 #endif
9140 recursive = TRUE;
9143 * The matching file names are stored in a growarray. Init it empty.
9145 ga_init2(&ga, (int)sizeof(char_u *), 30);
9147 for (i = 0; i < num_pat; ++i)
9149 add_pat = -1;
9150 p = pat[i];
9152 #ifdef VIM_BACKTICK
9153 if (vim_backtick(p))
9154 add_pat = expand_backtick(&ga, p, flags);
9155 else
9156 #endif
9159 * First expand environment variables, "~/" and "~user/".
9161 if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9163 p = expand_env_save_opt(p, TRUE);
9164 if (p == NULL)
9165 p = pat[i];
9166 #ifdef UNIX
9168 * On Unix, if expand_env() can't expand an environment
9169 * variable, use the shell to do that. Discard previously
9170 * found file names and start all over again.
9172 else if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9174 vim_free(p);
9175 ga_clear(&ga);
9176 i = mch_expand_wildcards(num_pat, pat, num_file, file,
9177 flags);
9178 recursive = FALSE;
9179 return i;
9181 #endif
9185 * If there are wildcards: Expand file names and add each match to
9186 * the list. If there is no match, and EW_NOTFOUND is given, add
9187 * the pattern.
9188 * If there are no wildcards: Add the file name if it exists or
9189 * when EW_NOTFOUND is given.
9191 if (mch_has_exp_wildcard(p))
9192 add_pat = mch_expandpath(&ga, p, flags);
9195 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
9197 char_u *t = backslash_halve_save(p);
9199 #if defined(MACOS_CLASSIC)
9200 slash_to_colon(t);
9201 #endif
9202 /* When EW_NOTFOUND is used, always add files and dirs. Makes
9203 * "vim c:/" work. */
9204 if (flags & EW_NOTFOUND)
9205 addfile(&ga, t, flags | EW_DIR | EW_FILE);
9206 else if (mch_getperm(t) >= 0)
9207 addfile(&ga, t, flags);
9208 vim_free(t);
9211 if (p != pat[i])
9212 vim_free(p);
9215 *num_file = ga.ga_len;
9216 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data : (char_u **)"";
9218 recursive = FALSE;
9220 return (ga.ga_data != NULL) ? OK : FAIL;
9223 # ifdef VIM_BACKTICK
9226 * Return TRUE if we can expand this backtick thing here.
9228 static int
9229 vim_backtick(p)
9230 char_u *p;
9232 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
9236 * Expand an item in `backticks` by executing it as a command.
9237 * Currently only works when pat[] starts and ends with a `.
9238 * Returns number of file names found.
9240 static int
9241 expand_backtick(gap, pat, flags)
9242 garray_T *gap;
9243 char_u *pat;
9244 int flags; /* EW_* flags */
9246 char_u *p;
9247 char_u *cmd;
9248 char_u *buffer;
9249 int cnt = 0;
9250 int i;
9252 /* Create the command: lop off the backticks. */
9253 cmd = vim_strnsave(pat + 1, (int)STRLEN(pat) - 2);
9254 if (cmd == NULL)
9255 return 0;
9257 #ifdef FEAT_EVAL
9258 if (*cmd == '=') /* `={expr}`: Expand expression */
9259 buffer = eval_to_string(cmd + 1, &p, TRUE);
9260 else
9261 #endif
9262 buffer = get_cmd_output(cmd, NULL,
9263 (flags & EW_SILENT) ? SHELL_SILENT : 0);
9264 vim_free(cmd);
9265 if (buffer == NULL)
9266 return 0;
9268 cmd = buffer;
9269 while (*cmd != NUL)
9271 cmd = skipwhite(cmd); /* skip over white space */
9272 p = cmd;
9273 while (*p != NUL && *p != '\r' && *p != '\n') /* skip over entry */
9274 ++p;
9275 /* add an entry if it is not empty */
9276 if (p > cmd)
9278 i = *p;
9279 *p = NUL;
9280 addfile(gap, cmd, flags);
9281 *p = i;
9282 ++cnt;
9284 cmd = p;
9285 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
9286 ++cmd;
9289 vim_free(buffer);
9290 return cnt;
9292 # endif /* VIM_BACKTICK */
9295 * Add a file to a file list. Accepted flags:
9296 * EW_DIR add directories
9297 * EW_FILE add files
9298 * EW_EXEC add executable files
9299 * EW_NOTFOUND add even when it doesn't exist
9300 * EW_ADDSLASH add slash after directory name
9302 void
9303 addfile(gap, f, flags)
9304 garray_T *gap;
9305 char_u *f; /* filename */
9306 int flags;
9308 char_u *p;
9309 int isdir;
9311 /* if the file/dir doesn't exist, may not add it */
9312 if (!(flags & EW_NOTFOUND) && mch_getperm(f) < 0)
9313 return;
9315 #ifdef FNAME_ILLEGAL
9316 /* if the file/dir contains illegal characters, don't add it */
9317 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
9318 return;
9319 #endif
9321 isdir = mch_isdir(f);
9322 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
9323 return;
9325 /* If the file isn't executable, may not add it. Do accept directories. */
9326 if (!isdir && (flags & EW_EXEC) && !mch_can_exe(f))
9327 return;
9329 /* Make room for another item in the file list. */
9330 if (ga_grow(gap, 1) == FAIL)
9331 return;
9333 p = alloc((unsigned)(STRLEN(f) + 1 + isdir));
9334 if (p == NULL)
9335 return;
9337 STRCPY(p, f);
9338 #ifdef BACKSLASH_IN_FILENAME
9339 slash_adjust(p);
9340 #endif
9342 * Append a slash or backslash after directory names if none is present.
9344 #ifndef DONT_ADD_PATHSEP_TO_DIR
9345 if (isdir && (flags & EW_ADDSLASH))
9346 add_pathsep(p);
9347 #endif
9348 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
9350 #endif /* !NO_EXPANDPATH */
9352 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) || defined(PROTO)
9354 #ifndef SEEK_SET
9355 # define SEEK_SET 0
9356 #endif
9357 #ifndef SEEK_END
9358 # define SEEK_END 2
9359 #endif
9362 * Get the stdout of an external command.
9363 * Returns an allocated string, or NULL for error.
9365 char_u *
9366 get_cmd_output(cmd, infile, flags)
9367 char_u *cmd;
9368 char_u *infile; /* optional input file name */
9369 int flags; /* can be SHELL_SILENT */
9371 char_u *tempname;
9372 char_u *command;
9373 char_u *buffer = NULL;
9374 int len;
9375 int i = 0;
9376 FILE *fd;
9378 if (check_restricted() || check_secure())
9379 return NULL;
9381 /* get a name for the temp file */
9382 if ((tempname = vim_tempname('o')) == NULL)
9384 EMSG(_(e_notmp));
9385 return NULL;
9388 /* Add the redirection stuff */
9389 command = make_filter_cmd(cmd, infile, tempname);
9390 if (command == NULL)
9391 goto done;
9394 * Call the shell to execute the command (errors are ignored).
9395 * Don't check timestamps here.
9397 ++no_check_timestamps;
9398 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
9399 --no_check_timestamps;
9401 vim_free(command);
9404 * read the names from the file into memory
9406 # ifdef VMS
9407 /* created temporary file is not always readable as binary */
9408 fd = mch_fopen((char *)tempname, "r");
9409 # else
9410 fd = mch_fopen((char *)tempname, READBIN);
9411 # endif
9413 if (fd == NULL)
9415 EMSG2(_(e_notopen), tempname);
9416 goto done;
9419 fseek(fd, 0L, SEEK_END);
9420 len = ftell(fd); /* get size of temp file */
9421 fseek(fd, 0L, SEEK_SET);
9423 buffer = alloc(len + 1);
9424 if (buffer != NULL)
9425 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
9426 fclose(fd);
9427 mch_remove(tempname);
9428 if (buffer == NULL)
9429 goto done;
9430 #ifdef VMS
9431 len = i; /* VMS doesn't give us what we asked for... */
9432 #endif
9433 if (i != len)
9435 EMSG2(_(e_notread), tempname);
9436 vim_free(buffer);
9437 buffer = NULL;
9439 else
9440 buffer[len] = '\0'; /* make sure the buffer is terminated */
9442 done:
9443 vim_free(tempname);
9444 return buffer;
9446 #endif
9449 * Free the list of files returned by expand_wildcards() or other expansion
9450 * functions.
9452 void
9453 FreeWild(count, files)
9454 int count;
9455 char_u **files;
9457 if (count <= 0 || files == NULL)
9458 return;
9459 #if defined(__EMX__) && defined(__ALWAYS_HAS_TRAILING_NULL_POINTER) /* XXX */
9461 * Is this still OK for when other functions than expand_wildcards() have
9462 * been used???
9464 _fnexplodefree((char **)files);
9465 #else
9466 while (count--)
9467 vim_free(files[count]);
9468 vim_free(files);
9469 #endif
9473 * return TRUE when need to go to Insert mode because of 'insertmode'.
9474 * Don't do this when still processing a command or a mapping.
9475 * Don't do this when inside a ":normal" command.
9478 goto_im()
9480 return (p_im && stuff_empty() && typebuf_typed());