Merged from the latest developing branch.
[vim_extended.git] / src / misc1.c
blob99c90f76bc0d1bfb39b48939c7bf51034a4e8b67
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--;
225 /* Skip over any additional white space (useful when newindent is less
226 * than old) */
227 while (vim_iswhite(*p))
228 (void)*p++;
231 else
233 todo = size;
234 newline = alloc(ind_len + line_len);
235 if (newline == NULL)
236 return FALSE;
237 s = newline;
240 /* Put the characters in the new line. */
241 /* if 'expandtab' isn't set: use TABs */
242 if (!curbuf->b_p_et)
244 /* If 'preserveindent' is set then reuse as much as possible of
245 * the existing indent structure for the new indent */
246 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
248 p = oldline;
249 ind_done = 0;
251 while (todo > 0 && vim_iswhite(*p))
253 if (*p == TAB)
255 tab_pad = (int)curbuf->b_p_ts
256 - (ind_done % (int)curbuf->b_p_ts);
257 /* stop if this tab will overshoot the target */
258 if (todo < tab_pad)
259 break;
260 todo -= tab_pad;
261 ind_done += tab_pad;
263 else
265 --todo;
266 ++ind_done;
268 *s++ = *p++;
271 /* Fill to next tabstop with a tab, if possible */
272 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
273 if (todo >= tab_pad)
275 *s++ = TAB;
276 todo -= tab_pad;
279 p = skipwhite(p);
282 while (todo >= (int)curbuf->b_p_ts)
284 *s++ = TAB;
285 todo -= (int)curbuf->b_p_ts;
288 while (todo > 0)
290 *s++ = ' ';
291 --todo;
293 mch_memmove(s, p, (size_t)line_len);
295 /* Replace the line (unless undo fails). */
296 if (!(flags & SIN_UNDO) || u_savesub(curwin->w_cursor.lnum) == OK)
298 ml_replace(curwin->w_cursor.lnum, newline, FALSE);
299 if (flags & SIN_CHANGED)
300 changed_bytes(curwin->w_cursor.lnum, 0);
301 /* Correct saved cursor position if it's after the indent. */
302 if (saved_cursor.lnum == curwin->w_cursor.lnum
303 && saved_cursor.col >= (colnr_T)(p - oldline))
304 saved_cursor.col += ind_len - (colnr_T)(p - oldline);
305 retval = TRUE;
307 else
308 vim_free(newline);
310 curwin->w_cursor.col = ind_len;
311 return retval;
315 * Copy the indent from ptr to the current line (and fill to size)
316 * Leaves the cursor on the first non-blank in the line.
317 * Returns TRUE if the line was changed.
319 static int
320 copy_indent(size, src)
321 int size;
322 char_u *src;
324 char_u *p = NULL;
325 char_u *line = NULL;
326 char_u *s;
327 int todo;
328 int ind_len;
329 int line_len = 0;
330 int tab_pad;
331 int ind_done;
332 int round;
334 /* Round 1: compute the number of characters needed for the indent
335 * Round 2: copy the characters. */
336 for (round = 1; round <= 2; ++round)
338 todo = size;
339 ind_len = 0;
340 ind_done = 0;
341 s = src;
343 /* Count/copy the usable portion of the source line */
344 while (todo > 0 && vim_iswhite(*s))
346 if (*s == TAB)
348 tab_pad = (int)curbuf->b_p_ts
349 - (ind_done % (int)curbuf->b_p_ts);
350 /* Stop if this tab will overshoot the target */
351 if (todo < tab_pad)
352 break;
353 todo -= tab_pad;
354 ind_done += tab_pad;
356 else
358 --todo;
359 ++ind_done;
361 ++ind_len;
362 if (p != NULL)
363 *p++ = *s;
364 ++s;
367 /* Fill to next tabstop with a tab, if possible */
368 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
369 if (todo >= tab_pad)
371 todo -= tab_pad;
372 ++ind_len;
373 if (p != NULL)
374 *p++ = TAB;
377 /* Add tabs required for indent */
378 while (todo >= (int)curbuf->b_p_ts)
380 todo -= (int)curbuf->b_p_ts;
381 ++ind_len;
382 if (p != NULL)
383 *p++ = TAB;
386 /* Count/add spaces required for indent */
387 while (todo > 0)
389 --todo;
390 ++ind_len;
391 if (p != NULL)
392 *p++ = ' ';
395 if (p == NULL)
397 /* Allocate memory for the result: the copied indent, new indent
398 * and the rest of the line. */
399 line_len = (int)STRLEN(ml_get_curline()) + 1;
400 line = alloc(ind_len + line_len);
401 if (line == NULL)
402 return FALSE;
403 p = line;
407 /* Append the original line */
408 mch_memmove(p, ml_get_curline(), (size_t)line_len);
410 /* Replace the line */
411 ml_replace(curwin->w_cursor.lnum, line, FALSE);
413 /* Put the cursor after the indent. */
414 curwin->w_cursor.col = ind_len;
415 return TRUE;
419 * Return the indent of the current line after a number. Return -1 if no
420 * number was found. Used for 'n' in 'formatoptions': numbered list.
421 * Since a pattern is used it can actually handle more than numbers.
424 get_number_indent(lnum)
425 linenr_T lnum;
427 colnr_T col;
428 pos_T pos;
429 regmmatch_T regmatch;
431 if (lnum > curbuf->b_ml.ml_line_count)
432 return -1;
433 pos.lnum = 0;
434 regmatch.regprog = vim_regcomp(curbuf->b_p_flp, RE_MAGIC);
435 if (regmatch.regprog != NULL)
437 regmatch.rmm_ic = FALSE;
438 regmatch.rmm_maxcol = 0;
439 if (vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0))
441 pos.lnum = regmatch.endpos[0].lnum + lnum;
442 pos.col = regmatch.endpos[0].col;
443 #ifdef FEAT_VIRTUALEDIT
444 pos.coladd = 0;
445 #endif
447 vim_free(regmatch.regprog);
450 if (pos.lnum == 0 || *ml_get_pos(&pos) == NUL)
451 return -1;
452 getvcol(curwin, &pos, &col, NULL, NULL);
453 return (int)col;
456 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
458 static int cin_is_cinword __ARGS((char_u *line));
461 * Return TRUE if the string "line" starts with a word from 'cinwords'.
463 static int
464 cin_is_cinword(line)
465 char_u *line;
467 char_u *cinw;
468 char_u *cinw_buf;
469 int cinw_len;
470 int retval = FALSE;
471 int len;
473 cinw_len = (int)STRLEN(curbuf->b_p_cinw) + 1;
474 cinw_buf = alloc((unsigned)cinw_len);
475 if (cinw_buf != NULL)
477 line = skipwhite(line);
478 for (cinw = curbuf->b_p_cinw; *cinw; )
480 len = copy_option_part(&cinw, cinw_buf, cinw_len, ",");
481 if (STRNCMP(line, cinw_buf, len) == 0
482 && (!vim_iswordc(line[len]) || !vim_iswordc(line[len - 1])))
484 retval = TRUE;
485 break;
488 vim_free(cinw_buf);
490 return retval;
492 #endif
495 * open_line: Add a new line below or above the current line.
497 * For VREPLACE mode, we only add a new line when we get to the end of the
498 * file, otherwise we just start replacing the next line.
500 * Caller must take care of undo. Since VREPLACE may affect any number of
501 * lines however, it may call u_save_cursor() again when starting to change a
502 * new line.
503 * "flags": OPENLINE_DELSPACES delete spaces after cursor
504 * OPENLINE_DO_COM format comments
505 * OPENLINE_KEEPTRAIL keep trailing spaces
506 * OPENLINE_MARKFIX adjust mark positions after the line break
508 * Return TRUE for success, FALSE for failure
511 open_line(dir, flags, old_indent)
512 int dir; /* FORWARD or BACKWARD */
513 int flags;
514 int old_indent; /* indent for after ^^D in Insert mode */
516 char_u *saved_line; /* copy of the original line */
517 char_u *next_line = NULL; /* copy of the next line */
518 char_u *p_extra = NULL; /* what goes to next line */
519 int less_cols = 0; /* less columns for mark in new line */
520 int less_cols_off = 0; /* columns to skip for mark adjust */
521 pos_T old_cursor; /* old cursor position */
522 int newcol = 0; /* new cursor column */
523 int newindent = 0; /* auto-indent of the new line */
524 int n;
525 int trunc_line = FALSE; /* truncate current line afterwards */
526 int retval = FALSE; /* return value, default is FAIL */
527 #ifdef FEAT_COMMENTS
528 int extra_len = 0; /* length of p_extra string */
529 int lead_len; /* length of comment leader */
530 char_u *lead_flags; /* position in 'comments' for comment leader */
531 char_u *leader = NULL; /* copy of comment leader */
532 #endif
533 char_u *allocated = NULL; /* allocated memory */
534 #if defined(FEAT_SMARTINDENT) || defined(FEAT_VREPLACE) || defined(FEAT_LISP) \
535 || defined(FEAT_CINDENT) || defined(FEAT_COMMENTS)
536 char_u *p;
537 #endif
538 int saved_char = NUL; /* init for GCC */
539 #if defined(FEAT_SMARTINDENT) || defined(FEAT_COMMENTS)
540 pos_T *pos;
541 #endif
542 #ifdef FEAT_SMARTINDENT
543 int do_si = (!p_paste && curbuf->b_p_si
544 # ifdef FEAT_CINDENT
545 && !curbuf->b_p_cin
546 # endif
548 int no_si = FALSE; /* reset did_si afterwards */
549 int first_char = NUL; /* init for GCC */
550 #endif
551 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
552 int vreplace_mode;
553 #endif
554 int did_append; /* appended a new line */
555 int saved_pi = curbuf->b_p_pi; /* copy of preserveindent setting */
558 * make a copy of the current line so we can mess with it
560 saved_line = vim_strsave(ml_get_curline());
561 if (saved_line == NULL) /* out of memory! */
562 return FALSE;
564 #ifdef FEAT_VREPLACE
565 if (State & VREPLACE_FLAG)
568 * With VREPLACE we make a copy of the next line, which we will be
569 * starting to replace. First make the new line empty and let vim play
570 * with the indenting and comment leader to its heart's content. Then
571 * we grab what it ended up putting on the new line, put back the
572 * original line, and call ins_char() to put each new character onto
573 * the line, replacing what was there before and pushing the right
574 * stuff onto the replace stack. -- webb.
576 if (curwin->w_cursor.lnum < orig_line_count)
577 next_line = vim_strsave(ml_get(curwin->w_cursor.lnum + 1));
578 else
579 next_line = vim_strsave((char_u *)"");
580 if (next_line == NULL) /* out of memory! */
581 goto theend;
584 * In VREPLACE mode, a NL replaces the rest of the line, and starts
585 * replacing the next line, so push all of the characters left on the
586 * line onto the replace stack. We'll push any other characters that
587 * might be replaced at the start of the next line (due to autoindent
588 * etc) a bit later.
590 replace_push(NUL); /* Call twice because BS over NL expects it */
591 replace_push(NUL);
592 p = saved_line + curwin->w_cursor.col;
593 while (*p != NUL)
595 #ifdef FEAT_MBYTE
596 if (has_mbyte)
597 p += replace_push_mb(p);
598 else
599 #endif
600 replace_push(*p++);
602 saved_line[curwin->w_cursor.col] = NUL;
604 #endif
606 if ((State & INSERT)
607 #ifdef FEAT_VREPLACE
608 && !(State & VREPLACE_FLAG)
609 #endif
612 p_extra = saved_line + curwin->w_cursor.col;
613 #ifdef FEAT_SMARTINDENT
614 if (do_si) /* need first char after new line break */
616 p = skipwhite(p_extra);
617 first_char = *p;
619 #endif
620 #ifdef FEAT_COMMENTS
621 extra_len = (int)STRLEN(p_extra);
622 #endif
623 saved_char = *p_extra;
624 *p_extra = NUL;
627 u_clearline(); /* cannot do "U" command when adding lines */
628 #ifdef FEAT_SMARTINDENT
629 did_si = FALSE;
630 #endif
631 ai_col = 0;
634 * If we just did an auto-indent, then we didn't type anything on
635 * the prior line, and it should be truncated. Do this even if 'ai' is not
636 * set because automatically inserting a comment leader also sets did_ai.
638 if (dir == FORWARD && did_ai)
639 trunc_line = TRUE;
642 * If 'autoindent' and/or 'smartindent' is set, try to figure out what
643 * indent to use for the new line.
645 if (curbuf->b_p_ai
646 #ifdef FEAT_SMARTINDENT
647 || do_si
648 #endif
652 * count white space on current line
654 newindent = get_indent_str(saved_line, (int)curbuf->b_p_ts);
655 if (newindent == 0)
656 newindent = old_indent; /* for ^^D command in insert mode */
658 #ifdef FEAT_SMARTINDENT
660 * Do smart indenting.
661 * In insert/replace mode (only when dir == FORWARD)
662 * we may move some text to the next line. If it starts with '{'
663 * don't add an indent. Fixes inserting a NL before '{' in line
664 * "if (condition) {"
666 if (!trunc_line && do_si && *saved_line != NUL
667 && (p_extra == NULL || first_char != '{'))
669 char_u *ptr;
670 char_u last_char;
672 old_cursor = curwin->w_cursor;
673 ptr = saved_line;
674 # ifdef FEAT_COMMENTS
675 if (flags & OPENLINE_DO_COM)
676 lead_len = get_leader_len(ptr, NULL, FALSE);
677 else
678 lead_len = 0;
679 # endif
680 if (dir == FORWARD)
683 * Skip preprocessor directives, unless they are
684 * recognised as comments.
686 if (
687 # ifdef FEAT_COMMENTS
688 lead_len == 0 &&
689 # endif
690 ptr[0] == '#')
692 while (ptr[0] == '#' && curwin->w_cursor.lnum > 1)
693 ptr = ml_get(--curwin->w_cursor.lnum);
694 newindent = get_indent();
696 # ifdef FEAT_COMMENTS
697 if (flags & OPENLINE_DO_COM)
698 lead_len = get_leader_len(ptr, NULL, FALSE);
699 else
700 lead_len = 0;
701 if (lead_len > 0)
704 * This case gets the following right:
705 * \*
706 * * A comment (read '\' as '/').
707 * *\
708 * #define IN_THE_WAY
709 * This should line up here;
711 p = skipwhite(ptr);
712 if (p[0] == '/' && p[1] == '*')
713 p++;
714 if (p[0] == '*')
716 for (p++; *p; p++)
718 if (p[0] == '/' && p[-1] == '*')
721 * End of C comment, indent should line up
722 * with the line containing the start of
723 * the comment
725 curwin->w_cursor.col = (colnr_T)(p - ptr);
726 if ((pos = findmatch(NULL, NUL)) != NULL)
728 curwin->w_cursor.lnum = pos->lnum;
729 newindent = get_indent();
735 else /* Not a comment line */
736 # endif
738 /* Find last non-blank in line */
739 p = ptr + STRLEN(ptr) - 1;
740 while (p > ptr && vim_iswhite(*p))
741 --p;
742 last_char = *p;
745 * find the character just before the '{' or ';'
747 if (last_char == '{' || last_char == ';')
749 if (p > ptr)
750 --p;
751 while (p > ptr && vim_iswhite(*p))
752 --p;
755 * Try to catch lines that are split over multiple
756 * lines. eg:
757 * if (condition &&
758 * condition) {
759 * Should line up here!
762 if (*p == ')')
764 curwin->w_cursor.col = (colnr_T)(p - ptr);
765 if ((pos = findmatch(NULL, '(')) != NULL)
767 curwin->w_cursor.lnum = pos->lnum;
768 newindent = get_indent();
769 ptr = ml_get_curline();
773 * If last character is '{' do indent, without
774 * checking for "if" and the like.
776 if (last_char == '{')
778 did_si = TRUE; /* do indent */
779 no_si = TRUE; /* don't delete it when '{' typed */
782 * Look for "if" and the like, use 'cinwords'.
783 * Don't do this if the previous line ended in ';' or
784 * '}'.
786 else if (last_char != ';' && last_char != '}'
787 && cin_is_cinword(ptr))
788 did_si = TRUE;
791 else /* dir == BACKWARD */
794 * Skip preprocessor directives, unless they are
795 * recognised as comments.
797 if (
798 # ifdef FEAT_COMMENTS
799 lead_len == 0 &&
800 # endif
801 ptr[0] == '#')
803 int was_backslashed = FALSE;
805 while ((ptr[0] == '#' || was_backslashed) &&
806 curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count)
808 if (*ptr && ptr[STRLEN(ptr) - 1] == '\\')
809 was_backslashed = TRUE;
810 else
811 was_backslashed = FALSE;
812 ptr = ml_get(++curwin->w_cursor.lnum);
814 if (was_backslashed)
815 newindent = 0; /* Got to end of file */
816 else
817 newindent = get_indent();
819 p = skipwhite(ptr);
820 if (*p == '}') /* if line starts with '}': do indent */
821 did_si = TRUE;
822 else /* can delete indent when '{' typed */
823 can_si_back = TRUE;
825 curwin->w_cursor = old_cursor;
827 if (do_si)
828 can_si = TRUE;
829 #endif /* FEAT_SMARTINDENT */
831 did_ai = TRUE;
834 #ifdef FEAT_COMMENTS
836 * Find out if the current line starts with a comment leader.
837 * This may then be inserted in front of the new line.
839 end_comment_pending = NUL;
840 if (flags & OPENLINE_DO_COM)
841 lead_len = get_leader_len(saved_line, &lead_flags, dir == BACKWARD);
842 else
843 lead_len = 0;
844 if (lead_len > 0)
846 char_u *lead_repl = NULL; /* replaces comment leader */
847 int lead_repl_len = 0; /* length of *lead_repl */
848 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
849 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
850 char_u *comment_end = NULL; /* where lead_end has been found */
851 int extra_space = FALSE; /* append extra space */
852 int current_flag;
853 int require_blank = FALSE; /* requires blank after middle */
854 char_u *p2;
857 * If the comment leader has the start, middle or end flag, it may not
858 * be used or may be replaced with the middle leader.
860 for (p = lead_flags; *p && *p != ':'; ++p)
862 if (*p == COM_BLANK)
864 require_blank = TRUE;
865 continue;
867 if (*p == COM_START || *p == COM_MIDDLE)
869 current_flag = *p;
870 if (*p == COM_START)
873 * Doing "O" on a start of comment does not insert leader.
875 if (dir == BACKWARD)
877 lead_len = 0;
878 break;
881 /* find start of middle part */
882 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
883 require_blank = FALSE;
887 * Isolate the strings of the middle and end leader.
889 while (*p && p[-1] != ':') /* find end of middle flags */
891 if (*p == COM_BLANK)
892 require_blank = TRUE;
893 ++p;
895 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
897 while (*p && p[-1] != ':') /* find end of end flags */
899 /* Check whether we allow automatic ending of comments */
900 if (*p == COM_AUTO_END)
901 end_comment_pending = -1; /* means we want to set it */
902 ++p;
904 n = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
906 if (end_comment_pending == -1) /* we can set it now */
907 end_comment_pending = lead_end[n - 1];
910 * If the end of the comment is in the same line, don't use
911 * the comment leader.
913 if (dir == FORWARD)
915 for (p = saved_line + lead_len; *p; ++p)
916 if (STRNCMP(p, lead_end, n) == 0)
918 comment_end = p;
919 lead_len = 0;
920 break;
925 * Doing "o" on a start of comment inserts the middle leader.
927 if (lead_len > 0)
929 if (current_flag == COM_START)
931 lead_repl = lead_middle;
932 lead_repl_len = (int)STRLEN(lead_middle);
936 * If we have hit RETURN immediately after the start
937 * comment leader, then put a space after the middle
938 * comment leader on the next line.
940 if (!vim_iswhite(saved_line[lead_len - 1])
941 && ((p_extra != NULL
942 && (int)curwin->w_cursor.col == lead_len)
943 || (p_extra == NULL
944 && saved_line[lead_len] == NUL)
945 || require_blank))
946 extra_space = TRUE;
948 break;
950 if (*p == COM_END)
953 * Doing "o" on the end of a comment does not insert leader.
954 * Remember where the end is, might want to use it to find the
955 * start (for C-comments).
957 if (dir == FORWARD)
959 comment_end = skipwhite(saved_line);
960 lead_len = 0;
961 break;
965 * Doing "O" on the end of a comment inserts the middle leader.
966 * Find the string for the middle leader, searching backwards.
968 while (p > curbuf->b_p_com && *p != ',')
969 --p;
970 for (lead_repl = p; lead_repl > curbuf->b_p_com
971 && lead_repl[-1] != ':'; --lead_repl)
973 lead_repl_len = (int)(p - lead_repl);
975 /* We can probably always add an extra space when doing "O" on
976 * the comment-end */
977 extra_space = TRUE;
979 /* Check whether we allow automatic ending of comments */
980 for (p2 = p; *p2 && *p2 != ':'; p2++)
982 if (*p2 == COM_AUTO_END)
983 end_comment_pending = -1; /* means we want to set it */
985 if (end_comment_pending == -1)
987 /* Find last character in end-comment string */
988 while (*p2 && *p2 != ',')
989 p2++;
990 end_comment_pending = p2[-1];
992 break;
994 if (*p == COM_FIRST)
997 * Comment leader for first line only: Don't repeat leader
998 * when using "O", blank out leader when using "o".
1000 if (dir == BACKWARD)
1001 lead_len = 0;
1002 else
1004 lead_repl = (char_u *)"";
1005 lead_repl_len = 0;
1007 break;
1010 if (lead_len)
1012 /* allocate buffer (may concatenate p_exta later) */
1013 leader = alloc(lead_len + lead_repl_len + extra_space +
1014 extra_len + 1);
1015 allocated = leader; /* remember to free it later */
1017 if (leader == NULL)
1018 lead_len = 0;
1019 else
1021 vim_strncpy(leader, saved_line, lead_len);
1024 * Replace leader with lead_repl, right or left adjusted
1026 if (lead_repl != NULL)
1028 int c = 0;
1029 int off = 0;
1031 for (p = lead_flags; *p && *p != ':'; ++p)
1033 if (*p == COM_RIGHT || *p == COM_LEFT)
1034 c = *p;
1035 else if (VIM_ISDIGIT(*p) || *p == '-')
1036 off = getdigits(&p);
1038 if (c == COM_RIGHT) /* right adjusted leader */
1040 /* find last non-white in the leader to line up with */
1041 for (p = leader + lead_len - 1; p > leader
1042 && vim_iswhite(*p); --p)
1044 ++p;
1046 #ifdef FEAT_MBYTE
1047 /* Compute the length of the replaced characters in
1048 * screen characters, not bytes. */
1050 int repl_size = vim_strnsize(lead_repl,
1051 lead_repl_len);
1052 int old_size = 0;
1053 char_u *endp = p;
1054 int l;
1056 while (old_size < repl_size && p > leader)
1058 mb_ptr_back(leader, p);
1059 old_size += ptr2cells(p);
1061 l = lead_repl_len - (int)(endp - p);
1062 if (l != 0)
1063 mch_memmove(endp + l, endp,
1064 (size_t)((leader + lead_len) - endp));
1065 lead_len += l;
1067 #else
1068 if (p < leader + lead_repl_len)
1069 p = leader;
1070 else
1071 p -= lead_repl_len;
1072 #endif
1073 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1074 if (p + lead_repl_len > leader + lead_len)
1075 p[lead_repl_len] = NUL;
1077 /* blank-out any other chars from the old leader. */
1078 while (--p >= leader)
1080 #ifdef FEAT_MBYTE
1081 int l = mb_head_off(leader, p);
1083 if (l > 1)
1085 p -= l;
1086 if (ptr2cells(p) > 1)
1088 p[1] = ' ';
1089 --l;
1091 mch_memmove(p + 1, p + l + 1,
1092 (size_t)((leader + lead_len) - (p + l + 1)));
1093 lead_len -= l;
1094 *p = ' ';
1096 else
1097 #endif
1098 if (!vim_iswhite(*p))
1099 *p = ' ';
1102 else /* left adjusted leader */
1104 p = skipwhite(leader);
1105 #ifdef FEAT_MBYTE
1106 /* Compute the length of the replaced characters in
1107 * screen characters, not bytes. Move the part that is
1108 * not to be overwritten. */
1110 int repl_size = vim_strnsize(lead_repl,
1111 lead_repl_len);
1112 int i;
1113 int l;
1115 for (i = 0; p[i] != NUL && i < lead_len; i += l)
1117 l = (*mb_ptr2len)(p + i);
1118 if (vim_strnsize(p, i + l) > repl_size)
1119 break;
1121 if (i != lead_repl_len)
1123 mch_memmove(p + lead_repl_len, p + i,
1124 (size_t)(lead_len - i - (leader - p)));
1125 lead_len += lead_repl_len - i;
1128 #endif
1129 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1131 /* Replace any remaining non-white chars in the old
1132 * leader by spaces. Keep Tabs, the indent must
1133 * remain the same. */
1134 for (p += lead_repl_len; p < leader + lead_len; ++p)
1135 if (!vim_iswhite(*p))
1137 /* Don't put a space before a TAB. */
1138 if (p + 1 < leader + lead_len && p[1] == TAB)
1140 --lead_len;
1141 mch_memmove(p, p + 1,
1142 (leader + lead_len) - p);
1144 else
1146 #ifdef FEAT_MBYTE
1147 int l = (*mb_ptr2len)(p);
1149 if (l > 1)
1151 if (ptr2cells(p) > 1)
1153 /* Replace a double-wide char with
1154 * two spaces */
1155 --l;
1156 *p++ = ' ';
1158 mch_memmove(p + 1, p + l,
1159 (leader + lead_len) - p);
1160 lead_len -= l - 1;
1162 #endif
1163 *p = ' ';
1166 *p = NUL;
1169 /* Recompute the indent, it may have changed. */
1170 if (curbuf->b_p_ai
1171 #ifdef FEAT_SMARTINDENT
1172 || do_si
1173 #endif
1175 newindent = get_indent_str(leader, (int)curbuf->b_p_ts);
1177 /* Add the indent offset */
1178 if (newindent + off < 0)
1180 off = -newindent;
1181 newindent = 0;
1183 else
1184 newindent += off;
1186 /* Correct trailing spaces for the shift, so that
1187 * alignment remains equal. */
1188 while (off > 0 && lead_len > 0
1189 && leader[lead_len - 1] == ' ')
1191 /* Don't do it when there is a tab before the space */
1192 if (vim_strchr(skipwhite(leader), '\t') != NULL)
1193 break;
1194 --lead_len;
1195 --off;
1198 /* If the leader ends in white space, don't add an
1199 * extra space */
1200 if (lead_len > 0 && vim_iswhite(leader[lead_len - 1]))
1201 extra_space = FALSE;
1202 leader[lead_len] = NUL;
1205 if (extra_space)
1207 leader[lead_len++] = ' ';
1208 leader[lead_len] = NUL;
1211 newcol = lead_len;
1214 * if a new indent will be set below, remove the indent that
1215 * is in the comment leader
1217 if (newindent
1218 #ifdef FEAT_SMARTINDENT
1219 || did_si
1220 #endif
1223 while (lead_len && vim_iswhite(*leader))
1225 --lead_len;
1226 --newcol;
1227 ++leader;
1232 #ifdef FEAT_SMARTINDENT
1233 did_si = can_si = FALSE;
1234 #endif
1236 else if (comment_end != NULL)
1239 * We have finished a comment, so we don't use the leader.
1240 * If this was a C-comment and 'ai' or 'si' is set do a normal
1241 * indent to align with the line containing the start of the
1242 * comment.
1244 if (comment_end[0] == '*' && comment_end[1] == '/' &&
1245 (curbuf->b_p_ai
1246 #ifdef FEAT_SMARTINDENT
1247 || do_si
1248 #endif
1251 old_cursor = curwin->w_cursor;
1252 curwin->w_cursor.col = (colnr_T)(comment_end - saved_line);
1253 if ((pos = findmatch(NULL, NUL)) != NULL)
1255 curwin->w_cursor.lnum = pos->lnum;
1256 newindent = get_indent();
1258 curwin->w_cursor = old_cursor;
1262 #endif
1264 /* (State == INSERT || State == REPLACE), only when dir == FORWARD */
1265 if (p_extra != NULL)
1267 *p_extra = saved_char; /* restore char that NUL replaced */
1270 * When 'ai' set or "flags" has OPENLINE_DELSPACES, skip to the first
1271 * non-blank.
1273 * When in REPLACE mode, put the deleted blanks on the replace stack,
1274 * preceded by a NUL, so they can be put back when a BS is entered.
1276 if (REPLACE_NORMAL(State))
1277 replace_push(NUL); /* end of extra blanks */
1278 if (curbuf->b_p_ai || (flags & OPENLINE_DELSPACES))
1280 while ((*p_extra == ' ' || *p_extra == '\t')
1281 #ifdef FEAT_MBYTE
1282 && (!enc_utf8
1283 || !utf_iscomposing(utf_ptr2char(p_extra + 1)))
1284 #endif
1287 if (REPLACE_NORMAL(State))
1288 replace_push(*p_extra);
1289 ++p_extra;
1290 ++less_cols_off;
1293 if (*p_extra != NUL)
1294 did_ai = FALSE; /* append some text, don't truncate now */
1296 /* columns for marks adjusted for removed columns */
1297 less_cols = (int)(p_extra - saved_line);
1300 if (p_extra == NULL)
1301 p_extra = (char_u *)""; /* append empty line */
1303 #ifdef FEAT_COMMENTS
1304 /* concatenate leader and p_extra, if there is a leader */
1305 if (lead_len)
1307 STRCAT(leader, p_extra);
1308 p_extra = leader;
1309 did_ai = TRUE; /* So truncating blanks works with comments */
1310 less_cols -= lead_len;
1312 else
1313 end_comment_pending = NUL; /* turns out there was no leader */
1314 #endif
1316 old_cursor = curwin->w_cursor;
1317 if (dir == BACKWARD)
1318 --curwin->w_cursor.lnum;
1319 #ifdef FEAT_VREPLACE
1320 if (!(State & VREPLACE_FLAG) || old_cursor.lnum >= orig_line_count)
1321 #endif
1323 if (ml_append(curwin->w_cursor.lnum, p_extra, (colnr_T)0, FALSE)
1324 == FAIL)
1325 goto theend;
1326 /* Postpone calling changed_lines(), because it would mess up folding
1327 * with markers. */
1328 mark_adjust(curwin->w_cursor.lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
1329 did_append = TRUE;
1331 #ifdef FEAT_VREPLACE
1332 else
1335 * In VREPLACE mode we are starting to replace the next line.
1337 curwin->w_cursor.lnum++;
1338 if (curwin->w_cursor.lnum >= Insstart.lnum + vr_lines_changed)
1340 /* In case we NL to a new line, BS to the previous one, and NL
1341 * again, we don't want to save the new line for undo twice.
1343 (void)u_save_cursor(); /* errors are ignored! */
1344 vr_lines_changed++;
1346 ml_replace(curwin->w_cursor.lnum, p_extra, TRUE);
1347 changed_bytes(curwin->w_cursor.lnum, 0);
1348 curwin->w_cursor.lnum--;
1349 did_append = FALSE;
1351 #endif
1353 if (newindent
1354 #ifdef FEAT_SMARTINDENT
1355 || did_si
1356 #endif
1359 ++curwin->w_cursor.lnum;
1360 #ifdef FEAT_SMARTINDENT
1361 if (did_si)
1363 if (p_sr)
1364 newindent -= newindent % (int)curbuf->b_p_sw;
1365 newindent += (int)curbuf->b_p_sw;
1367 #endif
1368 /* Copy the indent */
1369 if (curbuf->b_p_ci)
1371 (void)copy_indent(newindent, saved_line);
1374 * Set the 'preserveindent' option so that any further screwing
1375 * with the line doesn't entirely destroy our efforts to preserve
1376 * it. It gets restored at the function end.
1378 curbuf->b_p_pi = TRUE;
1380 else
1381 (void)set_indent(newindent, SIN_INSERT);
1382 less_cols -= curwin->w_cursor.col;
1384 ai_col = curwin->w_cursor.col;
1387 * In REPLACE mode, for each character in the new indent, there must
1388 * be a NUL on the replace stack, for when it is deleted with BS
1390 if (REPLACE_NORMAL(State))
1391 for (n = 0; n < (int)curwin->w_cursor.col; ++n)
1392 replace_push(NUL);
1393 newcol += curwin->w_cursor.col;
1394 #ifdef FEAT_SMARTINDENT
1395 if (no_si)
1396 did_si = FALSE;
1397 #endif
1400 #ifdef FEAT_COMMENTS
1402 * In REPLACE mode, for each character in the extra leader, there must be
1403 * a NUL on the replace stack, for when it is deleted with BS.
1405 if (REPLACE_NORMAL(State))
1406 while (lead_len-- > 0)
1407 replace_push(NUL);
1408 #endif
1410 curwin->w_cursor = old_cursor;
1412 if (dir == FORWARD)
1414 if (trunc_line || (State & INSERT))
1416 /* truncate current line at cursor */
1417 saved_line[curwin->w_cursor.col] = NUL;
1418 /* Remove trailing white space, unless OPENLINE_KEEPTRAIL used. */
1419 if (trunc_line && !(flags & OPENLINE_KEEPTRAIL))
1420 truncate_spaces(saved_line);
1421 ml_replace(curwin->w_cursor.lnum, saved_line, FALSE);
1422 saved_line = NULL;
1423 if (did_append)
1425 changed_lines(curwin->w_cursor.lnum, curwin->w_cursor.col,
1426 curwin->w_cursor.lnum + 1, 1L);
1427 did_append = FALSE;
1429 /* Move marks after the line break to the new line. */
1430 if (flags & OPENLINE_MARKFIX)
1431 mark_col_adjust(curwin->w_cursor.lnum,
1432 curwin->w_cursor.col + less_cols_off,
1433 1L, (long)-less_cols);
1435 else
1436 changed_bytes(curwin->w_cursor.lnum, curwin->w_cursor.col);
1440 * Put the cursor on the new line. Careful: the scrollup() above may
1441 * have moved w_cursor, we must use old_cursor.
1443 curwin->w_cursor.lnum = old_cursor.lnum + 1;
1445 if (did_append)
1446 changed_lines(curwin->w_cursor.lnum, 0, curwin->w_cursor.lnum, 1L);
1448 curwin->w_cursor.col = newcol;
1449 #ifdef FEAT_VIRTUALEDIT
1450 curwin->w_cursor.coladd = 0;
1451 #endif
1453 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1455 * In VREPLACE mode, we are handling the replace stack ourselves, so stop
1456 * fixthisline() from doing it (via change_indent()) by telling it we're in
1457 * normal INSERT mode.
1459 if (State & VREPLACE_FLAG)
1461 vreplace_mode = State; /* So we know to put things right later */
1462 State = INSERT;
1464 else
1465 vreplace_mode = 0;
1466 #endif
1467 #ifdef FEAT_LISP
1469 * May do lisp indenting.
1471 if (!p_paste
1472 # ifdef FEAT_COMMENTS
1473 && leader == NULL
1474 # endif
1475 && curbuf->b_p_lisp
1476 && curbuf->b_p_ai)
1478 fixthisline(get_lisp_indent);
1479 p = ml_get_curline();
1480 ai_col = (colnr_T)(skipwhite(p) - p);
1482 #endif
1483 #ifdef FEAT_CINDENT
1485 * May do indenting after opening a new line.
1487 if (!p_paste
1488 && (curbuf->b_p_cin
1489 # ifdef FEAT_EVAL
1490 || *curbuf->b_p_inde != NUL
1491 # endif
1493 && in_cinkeys(dir == FORWARD
1494 ? KEY_OPEN_FORW
1495 : KEY_OPEN_BACK, ' ', linewhite(curwin->w_cursor.lnum)))
1497 do_c_expr_indent();
1498 p = ml_get_curline();
1499 ai_col = (colnr_T)(skipwhite(p) - p);
1501 #endif
1502 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1503 if (vreplace_mode != 0)
1504 State = vreplace_mode;
1505 #endif
1507 #ifdef FEAT_VREPLACE
1509 * Finally, VREPLACE gets the stuff on the new line, then puts back the
1510 * original line, and inserts the new stuff char by char, pushing old stuff
1511 * onto the replace stack (via ins_char()).
1513 if (State & VREPLACE_FLAG)
1515 /* Put new line in p_extra */
1516 p_extra = vim_strsave(ml_get_curline());
1517 if (p_extra == NULL)
1518 goto theend;
1520 /* Put back original line */
1521 ml_replace(curwin->w_cursor.lnum, next_line, FALSE);
1523 /* Insert new stuff into line again */
1524 curwin->w_cursor.col = 0;
1525 #ifdef FEAT_VIRTUALEDIT
1526 curwin->w_cursor.coladd = 0;
1527 #endif
1528 ins_bytes(p_extra); /* will call changed_bytes() */
1529 vim_free(p_extra);
1530 next_line = NULL;
1532 #endif
1534 retval = TRUE; /* success! */
1535 theend:
1536 curbuf->b_p_pi = saved_pi;
1537 vim_free(saved_line);
1538 vim_free(next_line);
1539 vim_free(allocated);
1540 return retval;
1543 #if defined(FEAT_COMMENTS) || defined(PROTO)
1545 * get_leader_len() returns the length of the prefix of the given string
1546 * which introduces a comment. If this string is not a comment then 0 is
1547 * returned.
1548 * When "flags" is not NULL, it is set to point to the flags of the recognized
1549 * comment leader.
1550 * "backward" must be true for the "O" command.
1553 get_leader_len(line, flags, backward)
1554 char_u *line;
1555 char_u **flags;
1556 int backward;
1558 int i, j;
1559 int got_com = FALSE;
1560 int found_one;
1561 char_u part_buf[COM_MAX_LEN]; /* buffer for one option part */
1562 char_u *string; /* pointer to comment string */
1563 char_u *list;
1565 i = 0;
1566 while (vim_iswhite(line[i])) /* leading white space is ignored */
1567 ++i;
1570 * Repeat to match several nested comment strings.
1572 while (line[i])
1575 * scan through the 'comments' option for a match
1577 found_one = FALSE;
1578 for (list = curbuf->b_p_com; *list; )
1581 * Get one option part into part_buf[]. Advance list to next one.
1582 * put string at start of string.
1584 if (!got_com && flags != NULL) /* remember where flags started */
1585 *flags = list;
1586 (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
1587 string = vim_strchr(part_buf, ':');
1588 if (string == NULL) /* missing ':', ignore this part */
1589 continue;
1590 *string++ = NUL; /* isolate flags from string */
1593 * When already found a nested comment, only accept further
1594 * nested comments.
1596 if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
1597 continue;
1599 /* When 'O' flag used don't use for "O" command */
1600 if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
1601 continue;
1604 * Line contents and string must match.
1605 * When string starts with white space, must have some white space
1606 * (but the amount does not need to match, there might be a mix of
1607 * TABs and spaces).
1609 if (vim_iswhite(string[0]))
1611 if (i == 0 || !vim_iswhite(line[i - 1]))
1612 continue;
1613 while (vim_iswhite(string[0]))
1614 ++string;
1616 for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
1618 if (string[j] != NUL)
1619 continue;
1622 * When 'b' flag used, there must be white space or an
1623 * end-of-line after the string in the line.
1625 if (vim_strchr(part_buf, COM_BLANK) != NULL
1626 && !vim_iswhite(line[i + j]) && line[i + j] != NUL)
1627 continue;
1630 * We have found a match, stop searching.
1632 i += j;
1633 got_com = TRUE;
1634 found_one = TRUE;
1635 break;
1639 * No match found, stop scanning.
1641 if (!found_one)
1642 break;
1645 * Include any trailing white space.
1647 while (vim_iswhite(line[i]))
1648 ++i;
1651 * If this comment doesn't nest, stop here.
1653 if (vim_strchr(part_buf, COM_NEST) == NULL)
1654 break;
1656 return (got_com ? i : 0);
1658 #endif
1661 * Return the number of window lines occupied by buffer line "lnum".
1664 plines(lnum)
1665 linenr_T lnum;
1667 return plines_win(curwin, lnum, TRUE);
1671 plines_win(wp, lnum, winheight)
1672 win_T *wp;
1673 linenr_T lnum;
1674 int winheight; /* when TRUE limit to window height */
1676 #if defined(FEAT_DIFF) || defined(PROTO)
1677 /* Check for filler lines above this buffer line. When folded the result
1678 * is one line anyway. */
1679 return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
1683 plines_nofill(lnum)
1684 linenr_T lnum;
1686 return plines_win_nofill(curwin, lnum, TRUE);
1690 plines_win_nofill(wp, lnum, winheight)
1691 win_T *wp;
1692 linenr_T lnum;
1693 int winheight; /* when TRUE limit to window height */
1695 #endif
1696 int lines;
1698 if (!wp->w_p_wrap)
1699 return 1;
1701 #ifdef FEAT_VERTSPLIT
1702 if (wp->w_width == 0)
1703 return 1;
1704 #endif
1706 #ifdef FEAT_FOLDING
1707 /* A folded lines is handled just like an empty line. */
1708 /* NOTE: Caller must handle lines that are MAYBE folded. */
1709 if (lineFolded(wp, lnum) == TRUE)
1710 return 1;
1711 #endif
1713 lines = plines_win_nofold(wp, lnum);
1714 if (winheight > 0 && lines > wp->w_height)
1715 return (int)wp->w_height;
1716 return lines;
1720 * Return number of window lines physical line "lnum" will occupy in window
1721 * "wp". Does not care about folding, 'wrap' or 'diff'.
1724 plines_win_nofold(wp, lnum)
1725 win_T *wp;
1726 linenr_T lnum;
1728 char_u *s;
1729 long col;
1730 int width;
1732 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1733 if (*s == NUL) /* empty line */
1734 return 1;
1735 col = win_linetabsize(wp, s, (colnr_T)MAXCOL);
1738 * If list mode is on, then the '$' at the end of the line may take up one
1739 * extra column.
1741 if (wp->w_p_list && lcs_eol != NUL)
1742 col += 1;
1745 * Add column offset for 'number' and 'foldcolumn'.
1747 width = W_WIDTH(wp) - win_col_off(wp);
1748 if (width <= 0)
1749 return 32000;
1750 if (col <= width)
1751 return 1;
1752 col -= width;
1753 width += win_col_off2(wp);
1754 return (col + (width - 1)) / width + 1;
1758 * Like plines_win(), but only reports the number of physical screen lines
1759 * used from the start of the line to the given column number.
1762 plines_win_col(wp, lnum, column)
1763 win_T *wp;
1764 linenr_T lnum;
1765 long column;
1767 long col;
1768 char_u *s;
1769 int lines = 0;
1770 int width;
1772 #ifdef FEAT_DIFF
1773 /* Check for filler lines above this buffer line. When folded the result
1774 * is one line anyway. */
1775 lines = diff_check_fill(wp, lnum);
1776 #endif
1778 if (!wp->w_p_wrap)
1779 return lines + 1;
1781 #ifdef FEAT_VERTSPLIT
1782 if (wp->w_width == 0)
1783 return lines + 1;
1784 #endif
1786 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1788 col = 0;
1789 while (*s != NUL && --column >= 0)
1791 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL);
1792 mb_ptr_adv(s);
1796 * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
1797 * INSERT mode, then col must be adjusted so that it represents the last
1798 * screen position of the TAB. This only fixes an error when the TAB wraps
1799 * from one screen line to the next (when 'columns' is not a multiple of
1800 * 'ts') -- webb.
1802 if (*s == TAB && (State & NORMAL) && (!wp->w_p_list || lcs_tab1))
1803 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL) - 1;
1806 * Add column offset for 'number', 'foldcolumn', etc.
1808 width = W_WIDTH(wp) - win_col_off(wp);
1809 if (width <= 0)
1810 return 9999;
1812 lines += 1;
1813 if (col > width)
1814 lines += (col - width) / (width + win_col_off2(wp)) + 1;
1815 return lines;
1819 plines_m_win(wp, first, last)
1820 win_T *wp;
1821 linenr_T first, last;
1823 int count = 0;
1825 while (first <= last)
1827 #ifdef FEAT_FOLDING
1828 int x;
1830 /* Check if there are any really folded lines, but also included lines
1831 * that are maybe folded. */
1832 x = foldedCount(wp, first, NULL);
1833 if (x > 0)
1835 ++count; /* count 1 for "+-- folded" line */
1836 first += x;
1838 else
1839 #endif
1841 #ifdef FEAT_DIFF
1842 if (first == wp->w_topline)
1843 count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill;
1844 else
1845 #endif
1846 count += plines_win(wp, first, TRUE);
1847 ++first;
1850 return (count);
1853 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) || defined(PROTO)
1855 * Insert string "p" at the cursor position. Stops at a NUL byte.
1856 * Handles Replace mode and multi-byte characters.
1858 void
1859 ins_bytes(p)
1860 char_u *p;
1862 ins_bytes_len(p, (int)STRLEN(p));
1864 #endif
1866 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) \
1867 || defined(FEAT_COMMENTS) || defined(FEAT_MBYTE) || defined(PROTO)
1869 * Insert string "p" with length "len" at the cursor position.
1870 * Handles Replace mode and multi-byte characters.
1872 void
1873 ins_bytes_len(p, len)
1874 char_u *p;
1875 int len;
1877 int i;
1878 # ifdef FEAT_MBYTE
1879 int n;
1881 for (i = 0; i < len; i += n)
1883 n = (*mb_ptr2len)(p + i);
1884 ins_char_bytes(p + i, n);
1886 # else
1887 for (i = 0; i < len; ++i)
1888 ins_char(p[i]);
1889 # endif
1891 #endif
1894 * Insert or replace a single character at the cursor position.
1895 * When in REPLACE or VREPLACE mode, replace any existing character.
1896 * Caller must have prepared for undo.
1897 * For multi-byte characters we get the whole character, the caller must
1898 * convert bytes to a character.
1900 void
1901 ins_char(c)
1902 int c;
1904 #if defined(FEAT_MBYTE) || defined(PROTO)
1905 char_u buf[MB_MAXBYTES];
1906 int n;
1908 n = (*mb_char2bytes)(c, buf);
1910 /* When "c" is 0x100, 0x200, etc. we don't want to insert a NUL byte.
1911 * Happens for CTRL-Vu9900. */
1912 if (buf[0] == 0)
1913 buf[0] = '\n';
1915 ins_char_bytes(buf, n);
1918 void
1919 ins_char_bytes(buf, charlen)
1920 char_u *buf;
1921 int charlen;
1923 int c = buf[0];
1924 #endif
1925 int newlen; /* nr of bytes inserted */
1926 int oldlen; /* nr of bytes deleted (0 when not replacing) */
1927 char_u *p;
1928 char_u *newp;
1929 char_u *oldp;
1930 int linelen; /* length of old line including NUL */
1931 colnr_T col;
1932 linenr_T lnum = curwin->w_cursor.lnum;
1933 int i;
1935 #ifdef FEAT_VIRTUALEDIT
1936 /* Break tabs if needed. */
1937 if (virtual_active() && curwin->w_cursor.coladd > 0)
1938 coladvance_force(getviscol());
1939 #endif
1941 col = curwin->w_cursor.col;
1942 oldp = ml_get(lnum);
1943 linelen = (int)STRLEN(oldp) + 1;
1945 /* The lengths default to the values for when not replacing. */
1946 oldlen = 0;
1947 #ifdef FEAT_MBYTE
1948 newlen = charlen;
1949 #else
1950 newlen = 1;
1951 #endif
1953 if (State & REPLACE_FLAG)
1955 #ifdef FEAT_VREPLACE
1956 if (State & VREPLACE_FLAG)
1958 colnr_T new_vcol = 0; /* init for GCC */
1959 colnr_T vcol;
1960 int old_list;
1961 #ifndef FEAT_MBYTE
1962 char_u buf[2];
1963 #endif
1966 * Disable 'list' temporarily, unless 'cpo' contains the 'L' flag.
1967 * Returns the old value of list, so when finished,
1968 * curwin->w_p_list should be set back to this.
1970 old_list = curwin->w_p_list;
1971 if (old_list && vim_strchr(p_cpo, CPO_LISTWM) == NULL)
1972 curwin->w_p_list = FALSE;
1975 * In virtual replace mode each character may replace one or more
1976 * characters (zero if it's a TAB). Count the number of bytes to
1977 * be deleted to make room for the new character, counting screen
1978 * cells. May result in adding spaces to fill a gap.
1980 getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL);
1981 #ifndef FEAT_MBYTE
1982 buf[0] = c;
1983 buf[1] = NUL;
1984 #endif
1985 new_vcol = vcol + chartabsize(buf, vcol);
1986 while (oldp[col + oldlen] != NUL && vcol < new_vcol)
1988 vcol += chartabsize(oldp + col + oldlen, vcol);
1989 /* Don't need to remove a TAB that takes us to the right
1990 * position. */
1991 if (vcol > new_vcol && oldp[col + oldlen] == TAB)
1992 break;
1993 #ifdef FEAT_MBYTE
1994 oldlen += (*mb_ptr2len)(oldp + col + oldlen);
1995 #else
1996 ++oldlen;
1997 #endif
1998 /* Deleted a bit too much, insert spaces. */
1999 if (vcol > new_vcol)
2000 newlen += vcol - new_vcol;
2002 curwin->w_p_list = old_list;
2004 else
2005 #endif
2006 if (oldp[col] != NUL)
2008 /* normal replace */
2009 #ifdef FEAT_MBYTE
2010 oldlen = (*mb_ptr2len)(oldp + col);
2011 #else
2012 oldlen = 1;
2013 #endif
2017 /* Push the replaced bytes onto the replace stack, so that they can be
2018 * put back when BS is used. The bytes of a multi-byte character are
2019 * done the other way around, so that the first byte is popped off
2020 * first (it tells the byte length of the character). */
2021 replace_push(NUL);
2022 for (i = 0; i < oldlen; ++i)
2024 #ifdef FEAT_MBYTE
2025 if (has_mbyte)
2026 i += replace_push_mb(oldp + col + i) - 1;
2027 else
2028 #endif
2029 replace_push(oldp[col + i]);
2033 newp = alloc_check((unsigned)(linelen + newlen - oldlen));
2034 if (newp == NULL)
2035 return;
2037 /* Copy bytes before the cursor. */
2038 if (col > 0)
2039 mch_memmove(newp, oldp, (size_t)col);
2041 /* Copy bytes after the changed character(s). */
2042 p = newp + col;
2043 mch_memmove(p + newlen, oldp + col + oldlen,
2044 (size_t)(linelen - col - oldlen));
2046 /* Insert or overwrite the new character. */
2047 #ifdef FEAT_MBYTE
2048 mch_memmove(p, buf, charlen);
2049 i = charlen;
2050 #else
2051 *p = c;
2052 i = 1;
2053 #endif
2055 /* Fill with spaces when necessary. */
2056 while (i < newlen)
2057 p[i++] = ' ';
2059 /* Replace the line in the buffer. */
2060 ml_replace(lnum, newp, FALSE);
2062 /* mark the buffer as changed and prepare for displaying */
2063 changed_bytes(lnum, col);
2066 * If we're in Insert or Replace mode and 'showmatch' is set, then briefly
2067 * show the match for right parens and braces.
2069 if (p_sm && (State & INSERT)
2070 && msg_silent == 0
2071 #ifdef FEAT_MBYTE
2072 && charlen == 1
2073 #endif
2074 #ifdef FEAT_INS_EXPAND
2075 && !ins_compl_active()
2076 #endif
2078 showmatch(c);
2080 #ifdef FEAT_RIGHTLEFT
2081 if (!p_ri || (State & REPLACE_FLAG))
2082 #endif
2084 /* Normal insert: move cursor right */
2085 #ifdef FEAT_MBYTE
2086 curwin->w_cursor.col += charlen;
2087 #else
2088 ++curwin->w_cursor.col;
2089 #endif
2092 * TODO: should try to update w_row here, to avoid recomputing it later.
2097 * Insert a string at the cursor position.
2098 * Note: Does NOT handle Replace mode.
2099 * Caller must have prepared for undo.
2101 void
2102 ins_str(s)
2103 char_u *s;
2105 char_u *oldp, *newp;
2106 int newlen = (int)STRLEN(s);
2107 int oldlen;
2108 colnr_T col;
2109 linenr_T lnum = curwin->w_cursor.lnum;
2111 #ifdef FEAT_VIRTUALEDIT
2112 if (virtual_active() && curwin->w_cursor.coladd > 0)
2113 coladvance_force(getviscol());
2114 #endif
2116 col = curwin->w_cursor.col;
2117 oldp = ml_get(lnum);
2118 oldlen = (int)STRLEN(oldp);
2120 newp = alloc_check((unsigned)(oldlen + newlen + 1));
2121 if (newp == NULL)
2122 return;
2123 if (col > 0)
2124 mch_memmove(newp, oldp, (size_t)col);
2125 mch_memmove(newp + col, s, (size_t)newlen);
2126 mch_memmove(newp + col + newlen, oldp + col, (size_t)(oldlen - col + 1));
2127 ml_replace(lnum, newp, FALSE);
2128 changed_bytes(lnum, col);
2129 curwin->w_cursor.col += newlen;
2133 * Delete one character under the cursor.
2134 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2135 * Caller must have prepared for undo.
2137 * return FAIL for failure, OK otherwise
2140 del_char(fixpos)
2141 int fixpos;
2143 #ifdef FEAT_MBYTE
2144 if (has_mbyte)
2146 /* Make sure the cursor is at the start of a character. */
2147 mb_adjust_cursor();
2148 if (*ml_get_cursor() == NUL)
2149 return FAIL;
2150 return del_chars(1L, fixpos);
2152 #endif
2153 return del_bytes(1L, fixpos, TRUE);
2156 #if defined(FEAT_MBYTE) || defined(PROTO)
2158 * Like del_bytes(), but delete characters instead of bytes.
2161 del_chars(count, fixpos)
2162 long count;
2163 int fixpos;
2165 long bytes = 0;
2166 long i;
2167 char_u *p;
2168 int l;
2170 p = ml_get_cursor();
2171 for (i = 0; i < count && *p != NUL; ++i)
2173 l = (*mb_ptr2len)(p);
2174 bytes += l;
2175 p += l;
2177 return del_bytes(bytes, fixpos, TRUE);
2179 #endif
2182 * Delete "count" bytes under the cursor.
2183 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2184 * Caller must have prepared for undo.
2186 * return FAIL for failure, OK otherwise
2188 /*ARGSUSED*/
2190 del_bytes(count, fixpos_arg, use_delcombine)
2191 long count;
2192 int fixpos_arg;
2193 int use_delcombine; /* 'delcombine' option applies */
2195 char_u *oldp, *newp;
2196 colnr_T oldlen;
2197 linenr_T lnum = curwin->w_cursor.lnum;
2198 colnr_T col = curwin->w_cursor.col;
2199 int was_alloced;
2200 long movelen;
2201 int fixpos = fixpos_arg;
2203 oldp = ml_get(lnum);
2204 oldlen = (int)STRLEN(oldp);
2207 * Can't do anything when the cursor is on the NUL after the line.
2209 if (col >= oldlen)
2210 return FAIL;
2212 #ifdef FEAT_MBYTE
2213 /* If 'delcombine' is set and deleting (less than) one character, only
2214 * delete the last combining character. */
2215 if (p_deco && use_delcombine && enc_utf8
2216 && utfc_ptr2len(oldp + col) >= count)
2218 int cc[MAX_MCO];
2219 int n;
2221 (void)utfc_ptr2char(oldp + col, cc);
2222 if (cc[0] != NUL)
2224 /* Find the last composing char, there can be several. */
2225 n = col;
2228 col = n;
2229 count = utf_ptr2len(oldp + n);
2230 n += count;
2231 } while (UTF_COMPOSINGLIKE(oldp + col, oldp + n));
2232 fixpos = 0;
2235 #endif
2238 * When count is too big, reduce it.
2240 movelen = (long)oldlen - (long)col - count + 1; /* includes trailing NUL */
2241 if (movelen <= 1)
2244 * If we just took off the last character of a non-blank line, and
2245 * fixpos is TRUE, we don't want to end up positioned at the NUL,
2246 * unless "restart_edit" is set or 'virtualedit' contains "onemore".
2248 if (col > 0 && fixpos && restart_edit == 0
2249 #ifdef FEAT_VIRTUALEDIT
2250 && (ve_flags & VE_ONEMORE) == 0
2251 #endif
2254 --curwin->w_cursor.col;
2255 #ifdef FEAT_VIRTUALEDIT
2256 curwin->w_cursor.coladd = 0;
2257 #endif
2258 #ifdef FEAT_MBYTE
2259 if (has_mbyte)
2260 curwin->w_cursor.col -=
2261 (*mb_head_off)(oldp, oldp + curwin->w_cursor.col);
2262 #endif
2264 count = oldlen - col;
2265 movelen = 1;
2269 * If the old line has been allocated the deletion can be done in the
2270 * existing line. Otherwise a new line has to be allocated
2272 was_alloced = ml_line_alloced(); /* check if oldp was allocated */
2273 #ifdef FEAT_NETBEANS_INTG
2274 if (was_alloced && usingNetbeans)
2275 netbeans_removed(curbuf, lnum, col, count);
2276 /* else is handled by ml_replace() */
2277 #endif
2278 if (was_alloced)
2279 newp = oldp; /* use same allocated memory */
2280 else
2281 { /* need to allocate a new line */
2282 newp = alloc((unsigned)(oldlen + 1 - count));
2283 if (newp == NULL)
2284 return FAIL;
2285 mch_memmove(newp, oldp, (size_t)col);
2287 mch_memmove(newp + col, oldp + col + count, (size_t)movelen);
2288 if (!was_alloced)
2289 ml_replace(lnum, newp, FALSE);
2291 /* mark the buffer as changed and prepare for displaying */
2292 changed_bytes(lnum, curwin->w_cursor.col);
2294 return OK;
2298 * Delete from cursor to end of line.
2299 * Caller must have prepared for undo.
2301 * return FAIL for failure, OK otherwise
2304 truncate_line(fixpos)
2305 int fixpos; /* if TRUE fix the cursor position when done */
2307 char_u *newp;
2308 linenr_T lnum = curwin->w_cursor.lnum;
2309 colnr_T col = curwin->w_cursor.col;
2311 if (col == 0)
2312 newp = vim_strsave((char_u *)"");
2313 else
2314 newp = vim_strnsave(ml_get(lnum), col);
2316 if (newp == NULL)
2317 return FAIL;
2319 ml_replace(lnum, newp, FALSE);
2321 /* mark the buffer as changed and prepare for displaying */
2322 changed_bytes(lnum, curwin->w_cursor.col);
2325 * If "fixpos" is TRUE we don't want to end up positioned at the NUL.
2327 if (fixpos && curwin->w_cursor.col > 0)
2328 --curwin->w_cursor.col;
2330 return OK;
2334 * Delete "nlines" lines at the cursor.
2335 * Saves the lines for undo first if "undo" is TRUE.
2337 void
2338 del_lines(nlines, undo)
2339 long nlines; /* number of lines to delete */
2340 int undo; /* if TRUE, prepare for undo */
2342 long n;
2344 if (nlines <= 0)
2345 return;
2347 /* save the deleted lines for undo */
2348 if (undo && u_savedel(curwin->w_cursor.lnum, nlines) == FAIL)
2349 return;
2351 for (n = 0; n < nlines; )
2353 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
2354 break;
2356 ml_delete(curwin->w_cursor.lnum, TRUE);
2357 ++n;
2359 /* If we delete the last line in the file, stop */
2360 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
2361 break;
2363 /* adjust marks, mark the buffer as changed and prepare for displaying */
2364 deleted_lines_mark(curwin->w_cursor.lnum, n);
2366 curwin->w_cursor.col = 0;
2367 check_cursor_lnum();
2371 gchar_pos(pos)
2372 pos_T *pos;
2374 char_u *ptr = ml_get_pos(pos);
2376 #ifdef FEAT_MBYTE
2377 if (has_mbyte)
2378 return (*mb_ptr2char)(ptr);
2379 #endif
2380 return (int)*ptr;
2384 gchar_cursor()
2386 #ifdef FEAT_MBYTE
2387 if (has_mbyte)
2388 return (*mb_ptr2char)(ml_get_cursor());
2389 #endif
2390 return (int)*ml_get_cursor();
2394 * Write a character at the current cursor position.
2395 * It is directly written into the block.
2397 void
2398 pchar_cursor(c)
2399 int c;
2401 *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
2402 + curwin->w_cursor.col) = c;
2405 #if 0 /* not used */
2407 * Put *pos at end of current buffer
2409 void
2410 goto_endofbuf(pos)
2411 pos_T *pos;
2413 char_u *p;
2415 pos->lnum = curbuf->b_ml.ml_line_count;
2416 pos->col = 0;
2417 p = ml_get(pos->lnum);
2418 while (*p++)
2419 ++pos->col;
2421 #endif
2424 * When extra == 0: Return TRUE if the cursor is before or on the first
2425 * non-blank in the line.
2426 * When extra == 1: Return TRUE if the cursor is before the first non-blank in
2427 * the line.
2430 inindent(extra)
2431 int extra;
2433 char_u *ptr;
2434 colnr_T col;
2436 for (col = 0, ptr = ml_get_curline(); vim_iswhite(*ptr); ++col)
2437 ++ptr;
2438 if (col >= curwin->w_cursor.col + extra)
2439 return TRUE;
2440 else
2441 return FALSE;
2445 * Skip to next part of an option argument: Skip space and comma.
2447 char_u *
2448 skip_to_option_part(p)
2449 char_u *p;
2451 if (*p == ',')
2452 ++p;
2453 while (*p == ' ')
2454 ++p;
2455 return p;
2459 * changed() is called when something in the current buffer is changed.
2461 * Most often called through changed_bytes() and changed_lines(), which also
2462 * mark the area of the display to be redrawn.
2464 void
2465 changed()
2467 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2468 /* The text of the preediting area is inserted, but this doesn't
2469 * mean a change of the buffer yet. That is delayed until the
2470 * text is committed. (this means preedit becomes empty) */
2471 if (im_is_preediting() && !xim_changed_while_preediting)
2472 return;
2473 xim_changed_while_preediting = FALSE;
2474 #endif
2476 if (!curbuf->b_changed)
2478 int save_msg_scroll = msg_scroll;
2480 /* Give a warning about changing a read-only file. This may also
2481 * check-out the file, thus change "curbuf"! */
2482 change_warning(0);
2484 /* Create a swap file if that is wanted.
2485 * Don't do this for "nofile" and "nowrite" buffer types. */
2486 if (curbuf->b_may_swap
2487 #ifdef FEAT_QUICKFIX
2488 && !bt_dontwrite(curbuf)
2489 #endif
2492 ml_open_file(curbuf);
2494 /* The ml_open_file() can cause an ATTENTION message.
2495 * Wait two seconds, to make sure the user reads this unexpected
2496 * message. Since we could be anywhere, call wait_return() now,
2497 * and don't let the emsg() set msg_scroll. */
2498 if (need_wait_return && emsg_silent == 0)
2500 out_flush();
2501 ui_delay(2000L, TRUE);
2502 wait_return(TRUE);
2503 msg_scroll = save_msg_scroll;
2506 curbuf->b_changed = TRUE;
2507 ml_setflags(curbuf);
2508 #ifdef FEAT_WINDOWS
2509 check_status(curbuf);
2510 redraw_tabline = TRUE;
2511 #endif
2512 #ifdef FEAT_TITLE
2513 need_maketitle = TRUE; /* set window title later */
2514 #endif
2516 ++curbuf->b_changedtick;
2519 static void changedOneline __ARGS((buf_T *buf, linenr_T lnum));
2520 static void changed_lines_buf __ARGS((buf_T *buf, linenr_T lnum, linenr_T lnume, long xtra));
2521 static void changed_common __ARGS((linenr_T lnum, colnr_T col, linenr_T lnume, long xtra));
2524 * Changed bytes within a single line for the current buffer.
2525 * - marks the windows on this buffer to be redisplayed
2526 * - marks the buffer changed by calling changed()
2527 * - invalidates cached values
2529 void
2530 changed_bytes(lnum, col)
2531 linenr_T lnum;
2532 colnr_T col;
2534 changedOneline(curbuf, lnum);
2535 changed_common(lnum, col, lnum + 1, 0L);
2537 #ifdef FEAT_DIFF
2538 /* Diff highlighting in other diff windows may need to be updated too. */
2539 if (curwin->w_p_diff)
2541 win_T *wp;
2542 linenr_T wlnum;
2544 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2545 if (wp->w_p_diff && wp != curwin)
2547 redraw_win_later(wp, VALID);
2548 wlnum = diff_lnum_win(lnum, wp);
2549 if (wlnum > 0)
2550 changedOneline(wp->w_buffer, wlnum);
2553 #endif
2556 static void
2557 changedOneline(buf, lnum)
2558 buf_T *buf;
2559 linenr_T lnum;
2561 if (buf->b_mod_set)
2563 /* find the maximum area that must be redisplayed */
2564 if (lnum < buf->b_mod_top)
2565 buf->b_mod_top = lnum;
2566 else if (lnum >= buf->b_mod_bot)
2567 buf->b_mod_bot = lnum + 1;
2569 else
2571 /* set the area that must be redisplayed to one line */
2572 buf->b_mod_set = TRUE;
2573 buf->b_mod_top = lnum;
2574 buf->b_mod_bot = lnum + 1;
2575 buf->b_mod_xlines = 0;
2580 * Appended "count" lines below line "lnum" in the current buffer.
2581 * Must be called AFTER the change and after mark_adjust().
2582 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2584 void
2585 appended_lines(lnum, count)
2586 linenr_T lnum;
2587 long count;
2589 changed_lines(lnum + 1, 0, lnum + 1, count);
2593 * Like appended_lines(), but adjust marks first.
2595 void
2596 appended_lines_mark(lnum, count)
2597 linenr_T lnum;
2598 long count;
2600 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, count, 0L);
2601 changed_lines(lnum + 1, 0, lnum + 1, count);
2605 * Deleted "count" lines at line "lnum" in the current buffer.
2606 * Must be called AFTER the change and after mark_adjust().
2607 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2609 void
2610 deleted_lines(lnum, count)
2611 linenr_T lnum;
2612 long count;
2614 changed_lines(lnum, 0, lnum + count, -count);
2618 * Like deleted_lines(), but adjust marks first.
2620 void
2621 deleted_lines_mark(lnum, count)
2622 linenr_T lnum;
2623 long count;
2625 mark_adjust(lnum, (linenr_T)(lnum + count - 1), (long)MAXLNUM, -count);
2626 changed_lines(lnum, 0, lnum + count, -count);
2630 * Changed lines for the current buffer.
2631 * Must be called AFTER the change and after mark_adjust().
2632 * - mark the buffer changed by calling changed()
2633 * - mark the windows on this buffer to be redisplayed
2634 * - invalidate cached values
2635 * "lnum" is the first line that needs displaying, "lnume" the first line
2636 * below the changed lines (BEFORE the change).
2637 * When only inserting lines, "lnum" and "lnume" are equal.
2638 * Takes care of calling changed() and updating b_mod_*.
2640 void
2641 changed_lines(lnum, col, lnume, xtra)
2642 linenr_T lnum; /* first line with change */
2643 colnr_T col; /* column in first line with change */
2644 linenr_T lnume; /* line below last changed line */
2645 long xtra; /* number of extra lines (negative when deleting) */
2647 changed_lines_buf(curbuf, lnum, lnume, xtra);
2649 #ifdef FEAT_DIFF
2650 if (xtra == 0 && curwin->w_p_diff)
2652 /* When the number of lines doesn't change then mark_adjust() isn't
2653 * called and other diff buffers still need to be marked for
2654 * displaying. */
2655 win_T *wp;
2656 linenr_T wlnum;
2658 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2659 if (wp->w_p_diff && wp != curwin)
2661 redraw_win_later(wp, VALID);
2662 wlnum = diff_lnum_win(lnum, wp);
2663 if (wlnum > 0)
2664 changed_lines_buf(wp->w_buffer, wlnum,
2665 lnume - lnum + wlnum, 0L);
2668 #endif
2670 changed_common(lnum, col, lnume, xtra);
2673 static void
2674 changed_lines_buf(buf, lnum, lnume, xtra)
2675 buf_T *buf;
2676 linenr_T lnum; /* first line with change */
2677 linenr_T lnume; /* line below last changed line */
2678 long xtra; /* number of extra lines (negative when deleting) */
2680 if (buf->b_mod_set)
2682 /* find the maximum area that must be redisplayed */
2683 if (lnum < buf->b_mod_top)
2684 buf->b_mod_top = lnum;
2685 if (lnum < buf->b_mod_bot)
2687 /* adjust old bot position for xtra lines */
2688 buf->b_mod_bot += xtra;
2689 if (buf->b_mod_bot < lnum)
2690 buf->b_mod_bot = lnum;
2692 if (lnume + xtra > buf->b_mod_bot)
2693 buf->b_mod_bot = lnume + xtra;
2694 buf->b_mod_xlines += xtra;
2696 else
2698 /* set the area that must be redisplayed */
2699 buf->b_mod_set = TRUE;
2700 buf->b_mod_top = lnum;
2701 buf->b_mod_bot = lnume + xtra;
2702 buf->b_mod_xlines = xtra;
2706 static void
2707 changed_common(lnum, col, lnume, xtra)
2708 linenr_T lnum;
2709 colnr_T col;
2710 linenr_T lnume;
2711 long xtra;
2713 win_T *wp;
2714 int i;
2715 #ifdef FEAT_JUMPLIST
2716 int cols;
2717 pos_T *p;
2718 int add;
2719 #endif
2721 /* mark the buffer as modified */
2722 changed();
2724 /* set the '. mark */
2725 if (!cmdmod.keepjumps)
2727 curbuf->b_last_change.lnum = lnum;
2728 curbuf->b_last_change.col = col;
2730 #ifdef FEAT_JUMPLIST
2731 /* Create a new entry if a new undo-able change was started or we
2732 * don't have an entry yet. */
2733 if (curbuf->b_new_change || curbuf->b_changelistlen == 0)
2735 if (curbuf->b_changelistlen == 0)
2736 add = TRUE;
2737 else
2739 /* Don't create a new entry when the line number is the same
2740 * as the last one and the column is not too far away. Avoids
2741 * creating many entries for typing "xxxxx". */
2742 p = &curbuf->b_changelist[curbuf->b_changelistlen - 1];
2743 if (p->lnum != lnum)
2744 add = TRUE;
2745 else
2747 cols = comp_textwidth(FALSE);
2748 if (cols == 0)
2749 cols = 79;
2750 add = (p->col + cols < col || col + cols < p->col);
2753 if (add)
2755 /* This is the first of a new sequence of undo-able changes
2756 * and it's at some distance of the last change. Use a new
2757 * position in the changelist. */
2758 curbuf->b_new_change = FALSE;
2760 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2762 /* changelist is full: remove oldest entry */
2763 curbuf->b_changelistlen = JUMPLISTSIZE - 1;
2764 mch_memmove(curbuf->b_changelist, curbuf->b_changelist + 1,
2765 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2766 FOR_ALL_WINDOWS(wp)
2768 /* Correct position in changelist for other windows on
2769 * this buffer. */
2770 if (wp->w_buffer == curbuf && wp->w_changelistidx > 0)
2771 --wp->w_changelistidx;
2774 FOR_ALL_WINDOWS(wp)
2776 /* For other windows, if the position in the changelist is
2777 * at the end it stays at the end. */
2778 if (wp->w_buffer == curbuf
2779 && wp->w_changelistidx == curbuf->b_changelistlen)
2780 ++wp->w_changelistidx;
2782 ++curbuf->b_changelistlen;
2785 curbuf->b_changelist[curbuf->b_changelistlen - 1] =
2786 curbuf->b_last_change;
2787 /* The current window is always after the last change, so that "g,"
2788 * takes you back to it. */
2789 curwin->w_changelistidx = curbuf->b_changelistlen;
2790 #endif
2793 FOR_ALL_WINDOWS(wp)
2795 if (wp->w_buffer == curbuf)
2797 /* Mark this window to be redrawn later. */
2798 if (wp->w_redr_type < VALID)
2799 wp->w_redr_type = VALID;
2801 /* Check if a change in the buffer has invalidated the cached
2802 * values for the cursor. */
2803 #ifdef FEAT_FOLDING
2805 * Update the folds for this window. Can't postpone this, because
2806 * a following operator might work on the whole fold: ">>dd".
2808 foldUpdate(wp, lnum, lnume + xtra - 1);
2810 /* The change may cause lines above or below the change to become
2811 * included in a fold. Set lnum/lnume to the first/last line that
2812 * might be displayed differently.
2813 * Set w_cline_folded here as an efficient way to update it when
2814 * inserting lines just above a closed fold. */
2815 i = hasFoldingWin(wp, lnum, &lnum, NULL, FALSE, NULL);
2816 if (wp->w_cursor.lnum == lnum)
2817 wp->w_cline_folded = i;
2818 i = hasFoldingWin(wp, lnume, NULL, &lnume, FALSE, NULL);
2819 if (wp->w_cursor.lnum == lnume)
2820 wp->w_cline_folded = i;
2822 /* If the changed line is in a range of previously folded lines,
2823 * compare with the first line in that range. */
2824 if (wp->w_cursor.lnum <= lnum)
2826 i = find_wl_entry(wp, lnum);
2827 if (i >= 0 && wp->w_cursor.lnum > wp->w_lines[i].wl_lnum)
2828 changed_line_abv_curs_win(wp);
2830 #endif
2832 if (wp->w_cursor.lnum > lnum)
2833 changed_line_abv_curs_win(wp);
2834 else if (wp->w_cursor.lnum == lnum && wp->w_cursor.col >= col)
2835 changed_cline_bef_curs_win(wp);
2836 if (wp->w_botline >= lnum)
2838 /* Assume that botline doesn't change (inserted lines make
2839 * other lines scroll down below botline). */
2840 approximate_botline_win(wp);
2843 /* Check if any w_lines[] entries have become invalid.
2844 * For entries below the change: Correct the lnums for
2845 * inserted/deleted lines. Makes it possible to stop displaying
2846 * after the change. */
2847 for (i = 0; i < wp->w_lines_valid; ++i)
2848 if (wp->w_lines[i].wl_valid)
2850 if (wp->w_lines[i].wl_lnum >= lnum)
2852 if (wp->w_lines[i].wl_lnum < lnume)
2854 /* line included in change */
2855 wp->w_lines[i].wl_valid = FALSE;
2857 else if (xtra != 0)
2859 /* line below change */
2860 wp->w_lines[i].wl_lnum += xtra;
2861 #ifdef FEAT_FOLDING
2862 wp->w_lines[i].wl_lastlnum += xtra;
2863 #endif
2866 #ifdef FEAT_FOLDING
2867 else if (wp->w_lines[i].wl_lastlnum >= lnum)
2869 /* change somewhere inside this range of folded lines,
2870 * may need to be redrawn */
2871 wp->w_lines[i].wl_valid = FALSE;
2873 #endif
2878 /* Call update_screen() later, which checks out what needs to be redrawn,
2879 * since it notices b_mod_set and then uses b_mod_*. */
2880 if (must_redraw < VALID)
2881 must_redraw = VALID;
2883 #ifdef FEAT_AUTOCMD
2884 /* when the cursor line is changed always trigger CursorMoved */
2885 if (lnum <= curwin->w_cursor.lnum
2886 && lnume + (xtra < 0 ? -xtra : xtra) > curwin->w_cursor.lnum)
2887 last_cursormoved.lnum = 0;
2888 #endif
2892 * unchanged() is called when the changed flag must be reset for buffer 'buf'
2894 void
2895 unchanged(buf, ff)
2896 buf_T *buf;
2897 int ff; /* also reset 'fileformat' */
2899 if (buf->b_changed || (ff && file_ff_differs(buf)))
2901 buf->b_changed = 0;
2902 ml_setflags(buf);
2903 if (ff)
2904 save_file_ff(buf);
2905 #ifdef FEAT_WINDOWS
2906 check_status(buf);
2907 redraw_tabline = TRUE;
2908 #endif
2909 #ifdef FEAT_TITLE
2910 need_maketitle = TRUE; /* set window title later */
2911 #endif
2913 ++buf->b_changedtick;
2914 #ifdef FEAT_NETBEANS_INTG
2915 netbeans_unmodified(buf);
2916 #endif
2919 #if defined(FEAT_WINDOWS) || defined(PROTO)
2921 * check_status: called when the status bars for the buffer 'buf'
2922 * need to be updated
2924 void
2925 check_status(buf)
2926 buf_T *buf;
2928 win_T *wp;
2930 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2931 if (wp->w_buffer == buf && wp->w_status_height)
2933 wp->w_redr_status = TRUE;
2934 if (must_redraw < VALID)
2935 must_redraw = VALID;
2938 #endif
2941 * If the file is readonly, give a warning message with the first change.
2942 * Don't do this for autocommands.
2943 * Don't use emsg(), because it flushes the macro buffer.
2944 * If we have undone all changes b_changed will be FALSE, but "b_did_warn"
2945 * will be TRUE.
2947 void
2948 change_warning(col)
2949 int col; /* column for message; non-zero when in insert
2950 mode and 'showmode' is on */
2952 if (curbuf->b_did_warn == FALSE
2953 && curbufIsChanged() == 0
2954 #ifdef FEAT_AUTOCMD
2955 && !autocmd_busy
2956 #endif
2957 && curbuf->b_p_ro)
2959 #ifdef FEAT_AUTOCMD
2960 ++curbuf_lock;
2961 apply_autocmds(EVENT_FILECHANGEDRO, NULL, NULL, FALSE, curbuf);
2962 --curbuf_lock;
2963 if (!curbuf->b_p_ro)
2964 return;
2965 #endif
2967 * Do what msg() does, but with a column offset if the warning should
2968 * be after the mode message.
2970 msg_start();
2971 if (msg_row == Rows - 1)
2972 msg_col = col;
2973 msg_source(hl_attr(HLF_W));
2974 MSG_PUTS_ATTR(_("W10: Warning: Changing a readonly file"),
2975 hl_attr(HLF_W) | MSG_HIST);
2976 msg_clr_eos();
2977 (void)msg_end();
2978 if (msg_silent == 0 && !silent_mode)
2980 out_flush();
2981 ui_delay(1000L, TRUE); /* give the user time to think about it */
2983 curbuf->b_did_warn = TRUE;
2984 redraw_cmdline = FALSE; /* don't redraw and erase the message */
2985 if (msg_row < Rows - 1)
2986 showmode();
2991 * Ask for a reply from the user, a 'y' or a 'n'.
2992 * No other characters are accepted, the message is repeated until a valid
2993 * reply is entered or CTRL-C is hit.
2994 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
2995 * from any buffers but directly from the user.
2997 * return the 'y' or 'n'
3000 ask_yesno(str, direct)
3001 char_u *str;
3002 int direct;
3004 int r = ' ';
3005 int save_State = State;
3007 if (exiting) /* put terminal in raw mode for this question */
3008 settmode(TMODE_RAW);
3009 ++no_wait_return;
3010 #ifdef USE_ON_FLY_SCROLL
3011 dont_scroll = TRUE; /* disallow scrolling here */
3012 #endif
3013 State = CONFIRM; /* mouse behaves like with :confirm */
3014 #ifdef FEAT_MOUSE
3015 setmouse(); /* disables mouse for xterm */
3016 #endif
3017 ++no_mapping;
3018 ++allow_keys; /* no mapping here, but recognize keys */
3020 while (r != 'y' && r != 'n')
3022 /* same highlighting as for wait_return */
3023 smsg_attr(hl_attr(HLF_R), (char_u *)"%s (y/n)?", str);
3024 if (direct)
3025 r = get_keystroke();
3026 else
3027 r = safe_vgetc();
3028 if (r == Ctrl_C || r == ESC)
3029 r = 'n';
3030 msg_putchar(r); /* show what you typed */
3031 out_flush();
3033 --no_wait_return;
3034 State = save_State;
3035 #ifdef FEAT_MOUSE
3036 setmouse();
3037 #endif
3038 --no_mapping;
3039 --allow_keys;
3041 return r;
3045 * Get a key stroke directly from the user.
3046 * Ignores mouse clicks and scrollbar events, except a click for the left
3047 * button (used at the more prompt).
3048 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
3049 * Disadvantage: typeahead is ignored.
3050 * Translates the interrupt character for unix to ESC.
3053 get_keystroke()
3055 #define CBUFLEN 151
3056 char_u buf[CBUFLEN];
3057 int len = 0;
3058 int n;
3059 int save_mapped_ctrl_c = mapped_ctrl_c;
3060 int waited = 0;
3062 mapped_ctrl_c = FALSE; /* mappings are not used here */
3063 for (;;)
3065 cursor_on();
3066 out_flush();
3068 /* First time: blocking wait. Second time: wait up to 100ms for a
3069 * terminal code to complete. Leave some room for check_termcode() to
3070 * insert a key code into (max 5 chars plus NUL). And
3071 * fix_input_buffer() can triple the number of bytes. */
3072 n = ui_inchar(buf + len, (CBUFLEN - 6 - len) / 3,
3073 len == 0 ? -1L : 100L, 0);
3074 if (n > 0)
3076 /* Replace zero and CSI by a special key code. */
3077 n = fix_input_buffer(buf + len, n, FALSE);
3078 len += n;
3079 waited = 0;
3081 else if (len > 0)
3082 ++waited; /* keep track of the waiting time */
3084 /* Incomplete termcode and not timed out yet: get more characters */
3085 if ((n = check_termcode(1, buf, len)) < 0
3086 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
3087 continue;
3089 /* found a termcode: adjust length */
3090 if (n > 0)
3091 len = n;
3092 if (len == 0) /* nothing typed yet */
3093 continue;
3095 /* Handle modifier and/or special key code. */
3096 n = buf[0];
3097 if (n == K_SPECIAL)
3099 n = TO_SPECIAL(buf[1], buf[2]);
3100 if (buf[1] == KS_MODIFIER
3101 || n == K_IGNORE
3102 #ifdef FEAT_MOUSE
3103 || n == K_LEFTMOUSE_NM
3104 || n == K_LEFTDRAG
3105 || n == K_LEFTRELEASE
3106 || n == K_LEFTRELEASE_NM
3107 || n == K_MIDDLEMOUSE
3108 || n == K_MIDDLEDRAG
3109 || n == K_MIDDLERELEASE
3110 || n == K_RIGHTMOUSE
3111 || n == K_RIGHTDRAG
3112 || n == K_RIGHTRELEASE
3113 || n == K_MOUSEDOWN
3114 || n == K_MOUSEUP
3115 || n == K_X1MOUSE
3116 || n == K_X1DRAG
3117 || n == K_X1RELEASE
3118 || n == K_X2MOUSE
3119 || n == K_X2DRAG
3120 || n == K_X2RELEASE
3121 # ifdef FEAT_GUI
3122 || n == K_VER_SCROLLBAR
3123 || n == K_HOR_SCROLLBAR
3124 # endif
3125 #endif
3128 if (buf[1] == KS_MODIFIER)
3129 mod_mask = buf[2];
3130 len -= 3;
3131 if (len > 0)
3132 mch_memmove(buf, buf + 3, (size_t)len);
3133 continue;
3135 break;
3137 #ifdef FEAT_MBYTE
3138 if (has_mbyte)
3140 if (MB_BYTE2LEN(n) > len)
3141 continue; /* more bytes to get */
3142 buf[len >= CBUFLEN ? CBUFLEN - 1 : len] = NUL;
3143 n = (*mb_ptr2char)(buf);
3145 #endif
3146 #ifdef UNIX
3147 if (n == intr_char)
3148 n = ESC;
3149 #endif
3150 break;
3153 mapped_ctrl_c = save_mapped_ctrl_c;
3154 return n;
3158 * Get a number from the user.
3159 * When "mouse_used" is not NULL allow using the mouse.
3162 get_number(colon, mouse_used)
3163 int colon; /* allow colon to abort */
3164 int *mouse_used;
3166 int n = 0;
3167 int c;
3168 int typed = 0;
3170 if (mouse_used != NULL)
3171 *mouse_used = FALSE;
3173 /* When not printing messages, the user won't know what to type, return a
3174 * zero (as if CR was hit). */
3175 if (msg_silent != 0)
3176 return 0;
3178 #ifdef USE_ON_FLY_SCROLL
3179 dont_scroll = TRUE; /* disallow scrolling here */
3180 #endif
3181 ++no_mapping;
3182 ++allow_keys; /* no mapping here, but recognize keys */
3183 for (;;)
3185 windgoto(msg_row, msg_col);
3186 c = safe_vgetc();
3187 if (VIM_ISDIGIT(c))
3189 n = n * 10 + c - '0';
3190 msg_putchar(c);
3191 ++typed;
3193 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
3195 if (typed > 0)
3197 MSG_PUTS("\b \b");
3198 --typed;
3200 n /= 10;
3202 #ifdef FEAT_MOUSE
3203 else if (mouse_used != NULL && c == K_LEFTMOUSE)
3205 *mouse_used = TRUE;
3206 n = mouse_row + 1;
3207 break;
3209 #endif
3210 else if (n == 0 && c == ':' && colon)
3212 stuffcharReadbuff(':');
3213 if (!exmode_active)
3214 cmdline_row = msg_row;
3215 skip_redraw = TRUE; /* skip redraw once */
3216 do_redraw = FALSE;
3217 break;
3219 else if (c == CAR || c == NL || c == Ctrl_C || c == ESC)
3220 break;
3222 --no_mapping;
3223 --allow_keys;
3224 return n;
3228 * Ask the user to enter a number.
3229 * When "mouse_used" is not NULL allow using the mouse and in that case return
3230 * the line number.
3233 prompt_for_number(mouse_used)
3234 int *mouse_used;
3236 int i;
3237 int save_cmdline_row;
3238 int save_State;
3240 /* When using ":silent" assume that <CR> was entered. */
3241 if (mouse_used != NULL)
3242 MSG_PUTS(_("Type number or click with mouse (<Enter> cancels): "));
3243 else
3244 MSG_PUTS(_("Choice number (<Enter> cancels): "));
3246 /* Set the state such that text can be selected/copied/pasted and we still
3247 * get mouse events. */
3248 save_cmdline_row = cmdline_row;
3249 cmdline_row = 0;
3250 save_State = State;
3251 State = CMDLINE;
3253 i = get_number(TRUE, mouse_used);
3254 if (KeyTyped)
3256 /* don't call wait_return() now */
3257 /* msg_putchar('\n'); */
3258 cmdline_row = msg_row - 1;
3259 need_wait_return = FALSE;
3260 msg_didany = FALSE;
3262 else
3263 cmdline_row = save_cmdline_row;
3264 State = save_State;
3266 return i;
3269 void
3270 msgmore(n)
3271 long n;
3273 long pn;
3275 if (global_busy /* no messages now, wait until global is finished */
3276 || !messaging()) /* 'lazyredraw' set, don't do messages now */
3277 return;
3279 /* We don't want to overwrite another important message, but do overwrite
3280 * a previous "more lines" or "fewer lines" message, so that "5dd" and
3281 * then "put" reports the last action. */
3282 if (keep_msg != NULL && !keep_msg_more)
3283 return;
3285 if (n > 0)
3286 pn = n;
3287 else
3288 pn = -n;
3290 if (pn > p_report)
3292 if (pn == 1)
3294 if (n > 0)
3295 STRCPY(msg_buf, _("1 more line"));
3296 else
3297 STRCPY(msg_buf, _("1 line less"));
3299 else
3301 if (n > 0)
3302 sprintf((char *)msg_buf, _("%ld more lines"), pn);
3303 else
3304 sprintf((char *)msg_buf, _("%ld fewer lines"), pn);
3306 if (got_int)
3307 STRCAT(msg_buf, _(" (Interrupted)"));
3308 if (msg(msg_buf))
3310 set_keep_msg(msg_buf, 0);
3311 keep_msg_more = TRUE;
3317 * flush map and typeahead buffers and give a warning for an error
3319 void
3320 beep_flush()
3322 if (emsg_silent == 0)
3324 flush_buffers(FALSE);
3325 vim_beep();
3330 * give a warning for an error
3332 void
3333 vim_beep()
3335 if (emsg_silent == 0)
3337 if (p_vb
3338 #ifdef FEAT_GUI
3339 /* While the GUI is starting up the termcap is set for the GUI
3340 * but the output still goes to a terminal. */
3341 && !(gui.in_use && gui.starting)
3342 #endif
3345 out_str(T_VB);
3347 else
3349 #ifdef MSDOS
3351 * The number of beeps outputted is reduced to avoid having to wait
3352 * for all the beeps to finish. This is only a problem on systems
3353 * where the beeps don't overlap.
3355 if (beep_count == 0 || beep_count == 10)
3357 out_char(BELL);
3358 beep_count = 1;
3360 else
3361 ++beep_count;
3362 #else
3363 out_char(BELL);
3364 #endif
3367 /* When 'verbose' is set and we are sourcing a script or executing a
3368 * function give the user a hint where the beep comes from. */
3369 if (vim_strchr(p_debug, 'e') != NULL)
3371 msg_source(hl_attr(HLF_W));
3372 msg_attr((char_u *)_("Beep!"), hl_attr(HLF_W));
3378 * To get the "real" home directory:
3379 * - get value of $HOME
3380 * For Unix:
3381 * - go to that directory
3382 * - do mch_dirname() to get the real name of that directory.
3383 * This also works with mounts and links.
3384 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
3386 static char_u *homedir = NULL;
3388 void
3389 init_homedir()
3391 char_u *var;
3393 /* In case we are called a second time (when 'encoding' changes). */
3394 vim_free(homedir);
3395 homedir = NULL;
3397 #ifdef VMS
3398 var = mch_getenv((char_u *)"SYS$LOGIN");
3399 #else
3400 var = mch_getenv((char_u *)"HOME");
3401 #endif
3403 if (var != NULL && *var == NUL) /* empty is same as not set */
3404 var = NULL;
3406 #ifdef WIN3264
3408 * Weird but true: $HOME may contain an indirect reference to another
3409 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
3410 * when $HOME is being set.
3412 if (var != NULL && *var == '%')
3414 char_u *p;
3415 char_u *exp;
3417 p = vim_strchr(var + 1, '%');
3418 if (p != NULL)
3420 vim_strncpy(NameBuff, var + 1, p - (var + 1));
3421 exp = mch_getenv(NameBuff);
3422 if (exp != NULL && *exp != NUL
3423 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
3425 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
3426 var = NameBuff;
3427 /* Also set $HOME, it's needed for _viminfo. */
3428 vim_setenv((char_u *)"HOME", NameBuff);
3434 * Typically, $HOME is not defined on Windows, unless the user has
3435 * specifically defined it for Vim's sake. However, on Windows NT
3436 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
3437 * each user. Try constructing $HOME from these.
3439 if (var == NULL)
3441 char_u *homedrive, *homepath;
3443 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
3444 homepath = mch_getenv((char_u *)"HOMEPATH");
3445 if (homedrive != NULL && homepath != NULL
3446 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
3448 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
3449 if (NameBuff[0] != NUL)
3451 var = NameBuff;
3452 /* Also set $HOME, it's needed for _viminfo. */
3453 vim_setenv((char_u *)"HOME", NameBuff);
3458 # if defined(FEAT_MBYTE)
3459 if (enc_utf8 && var != NULL)
3461 int len;
3462 char_u *pp;
3464 /* Convert from active codepage to UTF-8. Other conversions are
3465 * not done, because they would fail for non-ASCII characters. */
3466 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
3467 if (pp != NULL)
3469 homedir = pp;
3470 return;
3473 # endif
3474 #endif
3476 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3478 * Default home dir is C:/
3479 * Best assumption we can make in such a situation.
3481 if (var == NULL)
3482 var = "C:/";
3483 #endif
3484 if (var != NULL)
3486 #ifdef UNIX
3488 * Change to the directory and get the actual path. This resolves
3489 * links. Don't do it when we can't return.
3491 if (mch_dirname(NameBuff, MAXPATHL) == OK
3492 && mch_chdir((char *)NameBuff) == 0)
3494 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
3495 var = IObuff;
3496 if (mch_chdir((char *)NameBuff) != 0)
3497 EMSG(_(e_prev_dir));
3499 #endif
3500 homedir = vim_strsave(var);
3504 #if defined(EXITFREE) || defined(PROTO)
3505 void
3506 free_homedir()
3508 vim_free(homedir);
3510 #endif
3513 * Call expand_env() and store the result in an allocated string.
3514 * This is not very memory efficient, this expects the result to be freed
3515 * again soon.
3517 char_u *
3518 expand_env_save(src)
3519 char_u *src;
3521 return expand_env_save_opt(src, FALSE);
3525 * Idem, but when "one" is TRUE handle the string as one file name, only
3526 * expand "~" at the start.
3528 char_u *
3529 expand_env_save_opt(src, one)
3530 char_u *src;
3531 int one;
3533 char_u *p;
3535 p = alloc(MAXPATHL);
3536 if (p != NULL)
3537 expand_env_esc(src, p, MAXPATHL, FALSE, one, NULL);
3538 return p;
3542 * Expand environment variable with path name.
3543 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
3544 * Skips over "\ ", "\~" and "\$" (not for Win32 though).
3545 * If anything fails no expansion is done and dst equals src.
3547 void
3548 expand_env(src, dst, dstlen)
3549 char_u *src; /* input string e.g. "$HOME/vim.hlp" */
3550 char_u *dst; /* where to put the result */
3551 int dstlen; /* maximum length of the result */
3553 expand_env_esc(src, dst, dstlen, FALSE, FALSE, NULL);
3556 void
3557 expand_env_esc(srcp, dst, dstlen, esc, one, startstr)
3558 char_u *srcp; /* input string e.g. "$HOME/vim.hlp" */
3559 char_u *dst; /* where to put the result */
3560 int dstlen; /* maximum length of the result */
3561 int esc; /* escape spaces in expanded variables */
3562 int one; /* "srcp" is one file name */
3563 char_u *startstr; /* start again after this (can be NULL) */
3565 char_u *src;
3566 char_u *tail;
3567 int c;
3568 char_u *var;
3569 int copy_char;
3570 int mustfree; /* var was allocated, need to free it later */
3571 int at_start = TRUE; /* at start of a name */
3572 int startstr_len = 0;
3574 if (startstr != NULL)
3575 startstr_len = (int)STRLEN(startstr);
3577 src = skipwhite(srcp);
3578 --dstlen; /* leave one char space for "\," */
3579 while (*src && dstlen > 0)
3581 copy_char = TRUE;
3582 if ((*src == '$'
3583 #ifdef VMS
3584 && at_start
3585 #endif
3587 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3588 || *src == '%'
3589 #endif
3590 || (*src == '~' && at_start))
3592 mustfree = FALSE;
3595 * The variable name is copied into dst temporarily, because it may
3596 * be a string in read-only memory and a NUL needs to be appended.
3598 if (*src != '~') /* environment var */
3600 tail = src + 1;
3601 var = dst;
3602 c = dstlen - 1;
3604 #ifdef UNIX
3605 /* Unix has ${var-name} type environment vars */
3606 if (*tail == '{' && !vim_isIDc('{'))
3608 tail++; /* ignore '{' */
3609 while (c-- > 0 && *tail && *tail != '}')
3610 *var++ = *tail++;
3612 else
3613 #endif
3615 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
3616 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3617 || (*src == '%' && *tail != '%')
3618 #endif
3621 #ifdef OS2 /* env vars only in uppercase */
3622 *var++ = TOUPPER_LOC(*tail);
3623 tail++; /* toupper() may be a macro! */
3624 #else
3625 *var++ = *tail++;
3626 #endif
3630 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3631 # ifdef UNIX
3632 if (src[1] == '{' && *tail != '}')
3633 # else
3634 if (*src == '%' && *tail != '%')
3635 # endif
3636 var = NULL;
3637 else
3639 # ifdef UNIX
3640 if (src[1] == '{')
3641 # else
3642 if (*src == '%')
3643 #endif
3644 ++tail;
3645 #endif
3646 *var = NUL;
3647 var = vim_getenv(dst, &mustfree);
3648 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3650 #endif
3652 /* home directory */
3653 else if ( src[1] == NUL
3654 || vim_ispathsep(src[1])
3655 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
3657 var = homedir;
3658 tail = src + 1;
3660 else /* user directory */
3662 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
3664 * Copy ~user to dst[], so we can put a NUL after it.
3666 tail = src;
3667 var = dst;
3668 c = dstlen - 1;
3669 while ( c-- > 0
3670 && *tail
3671 && vim_isfilec(*tail)
3672 && !vim_ispathsep(*tail))
3673 *var++ = *tail++;
3674 *var = NUL;
3675 # ifdef UNIX
3677 * If the system supports getpwnam(), use it.
3678 * Otherwise, or if getpwnam() fails, the shell is used to
3679 * expand ~user. This is slower and may fail if the shell
3680 * does not support ~user (old versions of /bin/sh).
3682 # if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
3684 struct passwd *pw;
3686 /* Note: memory allocated by getpwnam() is never freed.
3687 * Calling endpwent() apparently doesn't help. */
3688 pw = getpwnam((char *)dst + 1);
3689 if (pw != NULL)
3690 var = (char_u *)pw->pw_dir;
3691 else
3692 var = NULL;
3694 if (var == NULL)
3695 # endif
3697 expand_T xpc;
3699 ExpandInit(&xpc);
3700 xpc.xp_context = EXPAND_FILES;
3701 var = ExpandOne(&xpc, dst, NULL,
3702 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
3703 mustfree = TRUE;
3706 # else /* !UNIX, thus VMS */
3708 * USER_HOME is a comma-separated list of
3709 * directories to search for the user account in.
3712 char_u test[MAXPATHL], paths[MAXPATHL];
3713 char_u *path, *next_path, *ptr;
3714 struct stat st;
3716 STRCPY(paths, USER_HOME);
3717 next_path = paths;
3718 while (*next_path)
3720 for (path = next_path; *next_path && *next_path != ',';
3721 next_path++);
3722 if (*next_path)
3723 *next_path++ = NUL;
3724 STRCPY(test, path);
3725 STRCAT(test, "/");
3726 STRCAT(test, dst + 1);
3727 if (mch_stat(test, &st) == 0)
3729 var = alloc(STRLEN(test) + 1);
3730 STRCPY(var, test);
3731 mustfree = TRUE;
3732 break;
3736 # endif /* UNIX */
3737 #else
3738 /* cannot expand user's home directory, so don't try */
3739 var = NULL;
3740 tail = (char_u *)""; /* for gcc */
3741 #endif /* UNIX || VMS */
3744 #ifdef BACKSLASH_IN_FILENAME
3745 /* If 'shellslash' is set change backslashes to forward slashes.
3746 * Can't use slash_adjust(), p_ssl may be set temporarily. */
3747 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
3749 char_u *p = vim_strsave(var);
3751 if (p != NULL)
3753 if (mustfree)
3754 vim_free(var);
3755 var = p;
3756 mustfree = TRUE;
3757 forward_slash(var);
3760 #endif
3762 /* If "var" contains white space, escape it with a backslash.
3763 * Required for ":e ~/tt" when $HOME includes a space. */
3764 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
3766 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
3768 if (p != NULL)
3770 if (mustfree)
3771 vim_free(var);
3772 var = p;
3773 mustfree = TRUE;
3777 if (var != NULL && *var != NUL
3778 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
3780 STRCPY(dst, var);
3781 dstlen -= (int)STRLEN(var);
3782 c = (int)STRLEN(var);
3783 /* if var[] ends in a path separator and tail[] starts
3784 * with it, skip a character */
3785 if (*var != NUL && after_pathsep(dst, dst + c)
3786 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
3787 && dst[-1] != ':'
3788 #endif
3789 && vim_ispathsep(*tail))
3790 ++tail;
3791 dst += c;
3792 src = tail;
3793 copy_char = FALSE;
3795 if (mustfree)
3796 vim_free(var);
3799 if (copy_char) /* copy at least one char */
3802 * Recognize the start of a new name, for '~'.
3803 * Don't do this when "one" is TRUE, to avoid expanding "~" in
3804 * ":edit foo ~ foo".
3806 at_start = FALSE;
3807 if (src[0] == '\\' && src[1] != NUL)
3809 *dst++ = *src++;
3810 --dstlen;
3812 else if ((src[0] == ' ' || src[0] == ',') && !one)
3813 at_start = TRUE;
3814 *dst++ = *src++;
3815 --dstlen;
3817 if (startstr != NULL && src - startstr_len >= srcp
3818 && STRNCMP(src - startstr_len, startstr, startstr_len) == 0)
3819 at_start = TRUE;
3822 *dst = NUL;
3826 * Vim's version of getenv().
3827 * Special handling of $HOME, $VIM and $VIMRUNTIME.
3828 * Also does ACP to 'enc' conversion for Win32.
3830 char_u *
3831 vim_getenv(name, mustfree)
3832 char_u *name;
3833 int *mustfree; /* set to TRUE when returned is allocated */
3835 char_u *p;
3836 char_u *pend;
3837 int vimruntime;
3839 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3840 /* use "C:/" when $HOME is not set */
3841 if (STRCMP(name, "HOME") == 0)
3842 return homedir;
3843 #endif
3845 p = mch_getenv(name);
3846 if (p != NULL && *p == NUL) /* empty is the same as not set */
3847 p = NULL;
3849 if (p != NULL)
3851 #if defined(FEAT_MBYTE) && defined(WIN3264)
3852 if (enc_utf8)
3854 int len;
3855 char_u *pp;
3857 /* Convert from active codepage to UTF-8. Other conversions are
3858 * not done, because they would fail for non-ASCII characters. */
3859 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3860 if (pp != NULL)
3862 p = pp;
3863 *mustfree = TRUE;
3866 #endif
3867 return p;
3870 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
3871 if (!vimruntime && STRCMP(name, "VIM") != 0)
3872 return NULL;
3875 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
3876 * Don't do this when default_vimruntime_dir is non-empty.
3878 if (vimruntime
3879 #ifdef HAVE_PATHDEF
3880 && *default_vimruntime_dir == NUL
3881 #endif
3884 p = mch_getenv((char_u *)"VIM");
3885 if (p != NULL && *p == NUL) /* empty is the same as not set */
3886 p = NULL;
3887 if (p != NULL)
3889 p = vim_version_dir(p);
3890 if (p != NULL)
3891 *mustfree = TRUE;
3892 else
3893 p = mch_getenv((char_u *)"VIM");
3895 #if defined(FEAT_MBYTE) && defined(WIN3264)
3896 if (enc_utf8)
3898 int len;
3899 char_u *pp;
3901 /* Convert from active codepage to UTF-8. Other conversions
3902 * are not done, because they would fail for non-ASCII
3903 * characters. */
3904 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3905 if (pp != NULL)
3907 if (mustfree)
3908 vim_free(p);
3909 p = pp;
3910 *mustfree = TRUE;
3913 #endif
3918 * When expanding $VIM or $VIMRUNTIME fails, try using:
3919 * - the directory name from 'helpfile' (unless it contains '$')
3920 * - the executable name from argv[0]
3922 if (p == NULL)
3924 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
3925 p = p_hf;
3926 #ifdef USE_EXE_NAME
3928 * Use the name of the executable, obtained from argv[0].
3930 else
3931 p = exe_name;
3932 #endif
3933 if (p != NULL)
3935 /* remove the file name */
3936 pend = gettail(p);
3938 /* remove "doc/" from 'helpfile', if present */
3939 if (p == p_hf)
3940 pend = remove_tail(p, pend, (char_u *)"doc");
3942 #ifdef USE_EXE_NAME
3943 # ifdef MACOS_X
3944 /* remove "MacOS" from exe_name and add "Resources/vim" */
3945 if (p == exe_name)
3947 char_u *pend1;
3948 char_u *pnew;
3950 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
3951 if (pend1 != pend)
3953 pnew = alloc((unsigned)(pend1 - p) + 15);
3954 if (pnew != NULL)
3956 STRNCPY(pnew, p, (pend1 - p));
3957 STRCPY(pnew + (pend1 - p), "Resources/vim");
3958 p = pnew;
3959 pend = p + STRLEN(p);
3963 # endif
3964 /* remove "src/" from exe_name, if present */
3965 if (p == exe_name)
3966 pend = remove_tail(p, pend, (char_u *)"src");
3967 #endif
3969 /* for $VIM, remove "runtime/" or "vim54/", if present */
3970 if (!vimruntime)
3972 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
3973 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
3976 /* remove trailing path separator */
3977 #ifndef MACOS_CLASSIC
3978 /* With MacOS path (with colons) the final colon is required */
3979 /* to avoid confusion between absoulute and relative path */
3980 if (pend > p && after_pathsep(p, pend))
3981 --pend;
3982 #endif
3984 #ifdef MACOS_X
3985 if (p == exe_name || p == p_hf)
3986 #endif
3987 /* check that the result is a directory name */
3988 p = vim_strnsave(p, (int)(pend - p));
3990 if (p != NULL && !mch_isdir(p))
3992 vim_free(p);
3993 p = NULL;
3995 else
3997 #ifdef USE_EXE_NAME
3998 /* may add "/vim54" or "/runtime" if it exists */
3999 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
4001 vim_free(p);
4002 p = pend;
4004 #endif
4005 *mustfree = TRUE;
4010 #ifdef HAVE_PATHDEF
4011 /* When there is a pathdef.c file we can use default_vim_dir and
4012 * default_vimruntime_dir */
4013 if (p == NULL)
4015 /* Only use default_vimruntime_dir when it is not empty */
4016 if (vimruntime && *default_vimruntime_dir != NUL)
4018 p = default_vimruntime_dir;
4019 *mustfree = FALSE;
4021 else if (*default_vim_dir != NUL)
4023 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
4024 *mustfree = TRUE;
4025 else
4027 p = default_vim_dir;
4028 *mustfree = FALSE;
4032 #endif
4035 * Set the environment variable, so that the new value can be found fast
4036 * next time, and others can also use it (e.g. Perl).
4038 if (p != NULL)
4040 if (vimruntime)
4042 vim_setenv((char_u *)"VIMRUNTIME", p);
4043 didset_vimruntime = TRUE;
4044 #ifdef FEAT_GETTEXT
4046 char_u *buf = concat_str(p, (char_u *)"/lang");
4048 if (buf != NULL)
4050 bindtextdomain(VIMPACKAGE, (char *)buf);
4051 vim_free(buf);
4054 #endif
4056 else
4058 vim_setenv((char_u *)"VIM", p);
4059 didset_vim = TRUE;
4062 return p;
4066 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
4067 * Return NULL if not, return its name in allocated memory otherwise.
4069 static char_u *
4070 vim_version_dir(vimdir)
4071 char_u *vimdir;
4073 char_u *p;
4075 if (vimdir == NULL || *vimdir == NUL)
4076 return NULL;
4077 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
4078 if (p != NULL && mch_isdir(p))
4079 return p;
4080 vim_free(p);
4081 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
4082 if (p != NULL && mch_isdir(p))
4083 return p;
4084 vim_free(p);
4085 return NULL;
4089 * If the string between "p" and "pend" ends in "name/", return "pend" minus
4090 * the length of "name/". Otherwise return "pend".
4092 static char_u *
4093 remove_tail(p, pend, name)
4094 char_u *p;
4095 char_u *pend;
4096 char_u *name;
4098 int len = (int)STRLEN(name) + 1;
4099 char_u *newend = pend - len;
4101 if (newend >= p
4102 && fnamencmp(newend, name, len - 1) == 0
4103 && (newend == p || after_pathsep(p, newend)))
4104 return newend;
4105 return pend;
4109 * Our portable version of setenv.
4111 void
4112 vim_setenv(name, val)
4113 char_u *name;
4114 char_u *val;
4116 #ifdef HAVE_SETENV
4117 mch_setenv((char *)name, (char *)val, 1);
4118 #else
4119 char_u *envbuf;
4122 * Putenv does not copy the string, it has to remain
4123 * valid. The allocated memory will never be freed.
4125 envbuf = alloc((unsigned)(STRLEN(name) + STRLEN(val) + 2));
4126 if (envbuf != NULL)
4128 sprintf((char *)envbuf, "%s=%s", name, val);
4129 putenv((char *)envbuf);
4131 #endif
4134 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4136 * Function given to ExpandGeneric() to obtain an environment variable name.
4138 /*ARGSUSED*/
4139 char_u *
4140 get_env_name(xp, idx)
4141 expand_T *xp;
4142 int idx;
4144 # if defined(AMIGA) || defined(__MRC__) || defined(__SC__)
4146 * No environ[] on the Amiga and on the Mac (using MPW).
4148 return NULL;
4149 # else
4150 # ifndef __WIN32__
4151 /* Borland C++ 5.2 has this in a header file. */
4152 extern char **environ;
4153 # endif
4154 # define ENVNAMELEN 100
4155 static char_u name[ENVNAMELEN];
4156 char_u *str;
4157 int n;
4159 str = (char_u *)environ[idx];
4160 if (str == NULL)
4161 return NULL;
4163 for (n = 0; n < ENVNAMELEN - 1; ++n)
4165 if (str[n] == '=' || str[n] == NUL)
4166 break;
4167 name[n] = str[n];
4169 name[n] = NUL;
4170 return name;
4171 # endif
4173 #endif
4176 * Replace home directory by "~" in each space or comma separated file name in
4177 * 'src'.
4178 * If anything fails (except when out of space) dst equals src.
4180 void
4181 home_replace(buf, src, dst, dstlen, one)
4182 buf_T *buf; /* when not NULL, check for help files */
4183 char_u *src; /* input file name */
4184 char_u *dst; /* where to put the result */
4185 int dstlen; /* maximum length of the result */
4186 int one; /* if TRUE, only replace one file name, include
4187 spaces and commas in the file name. */
4189 size_t dirlen = 0, envlen = 0;
4190 size_t len;
4191 char_u *homedir_env;
4192 char_u *p;
4194 if (src == NULL)
4196 *dst = NUL;
4197 return;
4201 * If the file is a help file, remove the path completely.
4203 if (buf != NULL && buf->b_help)
4205 STRCPY(dst, gettail(src));
4206 return;
4210 * We check both the value of the $HOME environment variable and the
4211 * "real" home directory.
4213 if (homedir != NULL)
4214 dirlen = STRLEN(homedir);
4216 #ifdef VMS
4217 homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
4218 #else
4219 homedir_env = mch_getenv((char_u *)"HOME");
4220 #endif
4222 if (homedir_env != NULL && *homedir_env == NUL)
4223 homedir_env = NULL;
4224 if (homedir_env != NULL)
4225 envlen = STRLEN(homedir_env);
4227 if (!one)
4228 src = skipwhite(src);
4229 while (*src && dstlen > 0)
4232 * Here we are at the beginning of a file name.
4233 * First, check to see if the beginning of the file name matches
4234 * $HOME or the "real" home directory. Check that there is a '/'
4235 * after the match (so that if e.g. the file is "/home/pieter/bla",
4236 * and the home directory is "/home/piet", the file does not end up
4237 * as "~er/bla" (which would seem to indicate the file "bla" in user
4238 * er's home directory)).
4240 p = homedir;
4241 len = dirlen;
4242 for (;;)
4244 if ( len
4245 && fnamencmp(src, p, len) == 0
4246 && (vim_ispathsep(src[len])
4247 || (!one && (src[len] == ',' || src[len] == ' '))
4248 || src[len] == NUL))
4250 src += len;
4251 if (--dstlen > 0)
4252 *dst++ = '~';
4255 * If it's just the home directory, add "/".
4257 if (!vim_ispathsep(src[0]) && --dstlen > 0)
4258 *dst++ = '/';
4259 break;
4261 if (p == homedir_env)
4262 break;
4263 p = homedir_env;
4264 len = envlen;
4267 /* if (!one) skip to separator: space or comma */
4268 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
4269 *dst++ = *src++;
4270 /* skip separator */
4271 while ((*src == ' ' || *src == ',') && --dstlen > 0)
4272 *dst++ = *src++;
4274 /* if (dstlen == 0) out of space, what to do??? */
4276 *dst = NUL;
4280 * Like home_replace, store the replaced string in allocated memory.
4281 * When something fails, NULL is returned.
4283 char_u *
4284 home_replace_save(buf, src)
4285 buf_T *buf; /* when not NULL, check for help files */
4286 char_u *src; /* input file name */
4288 char_u *dst;
4289 unsigned len;
4291 len = 3; /* space for "~/" and trailing NUL */
4292 if (src != NULL) /* just in case */
4293 len += (unsigned)STRLEN(src);
4294 dst = alloc(len);
4295 if (dst != NULL)
4296 home_replace(buf, src, dst, len, TRUE);
4297 return dst;
4301 * Compare two file names and return:
4302 * FPC_SAME if they both exist and are the same file.
4303 * FPC_SAMEX if they both don't exist and have the same file name.
4304 * FPC_DIFF if they both exist and are different files.
4305 * FPC_NOTX if they both don't exist.
4306 * FPC_DIFFX if one of them doesn't exist.
4307 * For the first name environment variables are expanded
4310 fullpathcmp(s1, s2, checkname)
4311 char_u *s1, *s2;
4312 int checkname; /* when both don't exist, check file names */
4314 #ifdef UNIX
4315 char_u exp1[MAXPATHL];
4316 char_u full1[MAXPATHL];
4317 char_u full2[MAXPATHL];
4318 struct stat st1, st2;
4319 int r1, r2;
4321 expand_env(s1, exp1, MAXPATHL);
4322 r1 = mch_stat((char *)exp1, &st1);
4323 r2 = mch_stat((char *)s2, &st2);
4324 if (r1 != 0 && r2 != 0)
4326 /* if mch_stat() doesn't work, may compare the names */
4327 if (checkname)
4329 if (fnamecmp(exp1, s2) == 0)
4330 return FPC_SAMEX;
4331 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4332 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4333 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
4334 return FPC_SAMEX;
4336 return FPC_NOTX;
4338 if (r1 != 0 || r2 != 0)
4339 return FPC_DIFFX;
4340 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
4341 return FPC_SAME;
4342 return FPC_DIFF;
4343 #else
4344 char_u *exp1; /* expanded s1 */
4345 char_u *full1; /* full path of s1 */
4346 char_u *full2; /* full path of s2 */
4347 int retval = FPC_DIFF;
4348 int r1, r2;
4350 /* allocate one buffer to store three paths (alloc()/free() is slow!) */
4351 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
4353 full1 = exp1 + MAXPATHL;
4354 full2 = full1 + MAXPATHL;
4356 expand_env(s1, exp1, MAXPATHL);
4357 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4358 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4360 /* If vim_FullName() fails, the file probably doesn't exist. */
4361 if (r1 != OK && r2 != OK)
4363 if (checkname && fnamecmp(exp1, s2) == 0)
4364 retval = FPC_SAMEX;
4365 else
4366 retval = FPC_NOTX;
4368 else if (r1 != OK || r2 != OK)
4369 retval = FPC_DIFFX;
4370 else if (fnamecmp(full1, full2))
4371 retval = FPC_DIFF;
4372 else
4373 retval = FPC_SAME;
4374 vim_free(exp1);
4376 return retval;
4377 #endif
4381 * Get the tail of a path: the file name.
4382 * Fail safe: never returns NULL.
4384 char_u *
4385 gettail(fname)
4386 char_u *fname;
4388 char_u *p1, *p2;
4390 if (fname == NULL)
4391 return (char_u *)"";
4392 for (p1 = p2 = fname; *p2; ) /* find last part of path */
4394 if (vim_ispathsep(*p2))
4395 p1 = p2 + 1;
4396 mb_ptr_adv(p2);
4398 return p1;
4402 * Get pointer to tail of "fname", including path separators. Putting a NUL
4403 * here leaves the directory name. Takes care of "c:/" and "//".
4404 * Always returns a valid pointer.
4406 char_u *
4407 gettail_sep(fname)
4408 char_u *fname;
4410 char_u *p;
4411 char_u *t;
4413 p = get_past_head(fname); /* don't remove the '/' from "c:/file" */
4414 t = gettail(fname);
4415 while (t > p && after_pathsep(fname, t))
4416 --t;
4417 #ifdef VMS
4418 /* path separator is part of the path */
4419 ++t;
4420 #endif
4421 return t;
4425 * get the next path component (just after the next path separator).
4427 char_u *
4428 getnextcomp(fname)
4429 char_u *fname;
4431 while (*fname && !vim_ispathsep(*fname))
4432 mb_ptr_adv(fname);
4433 if (*fname)
4434 ++fname;
4435 return fname;
4439 * Get a pointer to one character past the head of a path name.
4440 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
4441 * If there is no head, path is returned.
4443 char_u *
4444 get_past_head(path)
4445 char_u *path;
4447 char_u *retval;
4449 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4450 /* may skip "c:" */
4451 if (isalpha(path[0]) && path[1] == ':')
4452 retval = path + 2;
4453 else
4454 retval = path;
4455 #else
4456 # if defined(AMIGA)
4457 /* may skip "label:" */
4458 retval = vim_strchr(path, ':');
4459 if (retval == NULL)
4460 retval = path;
4461 # else /* Unix */
4462 retval = path;
4463 # endif
4464 #endif
4466 while (vim_ispathsep(*retval))
4467 ++retval;
4469 return retval;
4473 * return TRUE if 'c' is a path separator.
4476 vim_ispathsep(c)
4477 int c;
4479 #ifdef RISCOS
4480 return (c == '.' || c == ':');
4481 #else
4482 # ifdef UNIX
4483 return (c == '/'); /* UNIX has ':' inside file names */
4484 # else
4485 # ifdef BACKSLASH_IN_FILENAME
4486 return (c == ':' || c == '/' || c == '\\');
4487 # else
4488 # ifdef VMS
4489 /* server"user passwd"::device:[full.path.name]fname.extension;version" */
4490 return (c == ':' || c == '[' || c == ']' || c == '/'
4491 || c == '<' || c == '>' || c == '"' );
4492 # else /* Amiga */
4493 return (c == ':' || c == '/');
4494 # endif /* VMS */
4495 # endif
4496 # endif
4497 #endif /* RISC OS */
4500 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
4502 * return TRUE if 'c' is a path list separator.
4505 vim_ispathlistsep(c)
4506 int c;
4508 #ifdef UNIX
4509 return (c == ':');
4510 #else
4511 return (c == ';'); /* might not be right for every system... */
4512 #endif
4514 #endif
4516 #if defined(FEAT_GUI_TABLINE) || defined(FEAT_WINDOWS) \
4517 || defined(FEAT_EVAL) || defined(PROTO)
4519 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
4520 * It's done in-place.
4522 void
4523 shorten_dir(str)
4524 char_u *str;
4526 char_u *tail, *s, *d;
4527 int skip = FALSE;
4529 tail = gettail(str);
4530 d = str;
4531 for (s = str; ; ++s)
4533 if (s >= tail) /* copy the whole tail */
4535 *d++ = *s;
4536 if (*s == NUL)
4537 break;
4539 else if (vim_ispathsep(*s)) /* copy '/' and next char */
4541 *d++ = *s;
4542 skip = FALSE;
4544 else if (!skip)
4546 *d++ = *s; /* copy next char */
4547 if (*s != '~' && *s != '.') /* and leading "~" and "." */
4548 skip = TRUE;
4549 # ifdef FEAT_MBYTE
4550 if (has_mbyte)
4552 int l = mb_ptr2len(s);
4554 while (--l > 0)
4555 *d++ = *++s;
4557 # endif
4561 #endif
4564 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
4565 * Also returns TRUE if there is no directory name.
4566 * "fname" must be writable!.
4569 dir_of_file_exists(fname)
4570 char_u *fname;
4572 char_u *p;
4573 int c;
4574 int retval;
4576 p = gettail_sep(fname);
4577 if (p == fname)
4578 return TRUE;
4579 c = *p;
4580 *p = NUL;
4581 retval = mch_isdir(fname);
4582 *p = c;
4583 return retval;
4586 #if (defined(CASE_INSENSITIVE_FILENAME) && defined(BACKSLASH_IN_FILENAME)) \
4587 || defined(PROTO)
4589 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally.
4592 vim_fnamecmp(x, y)
4593 char_u *x, *y;
4595 return vim_fnamencmp(x, y, MAXPATHL);
4599 vim_fnamencmp(x, y, len)
4600 char_u *x, *y;
4601 size_t len;
4603 while (len > 0 && *x && *y)
4605 if (TOLOWER_LOC(*x) != TOLOWER_LOC(*y)
4606 && !(*x == '/' && *y == '\\')
4607 && !(*x == '\\' && *y == '/'))
4608 break;
4609 ++x;
4610 ++y;
4611 --len;
4613 if (len == 0)
4614 return 0;
4615 return (*x - *y);
4617 #endif
4620 * Concatenate file names fname1 and fname2 into allocated memory.
4621 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
4623 char_u *
4624 concat_fnames(fname1, fname2, sep)
4625 char_u *fname1;
4626 char_u *fname2;
4627 int sep;
4629 char_u *dest;
4631 dest = alloc((unsigned)(STRLEN(fname1) + STRLEN(fname2) + 3));
4632 if (dest != NULL)
4634 STRCPY(dest, fname1);
4635 if (sep)
4636 add_pathsep(dest);
4637 STRCAT(dest, fname2);
4639 return dest;
4642 #if defined(FEAT_EVAL) || defined(FEAT_GETTEXT) || defined(PROTO)
4644 * Concatenate two strings and return the result in allocated memory.
4645 * Returns NULL when out of memory.
4647 char_u *
4648 concat_str(str1, str2)
4649 char_u *str1;
4650 char_u *str2;
4652 char_u *dest;
4653 size_t l = STRLEN(str1);
4655 dest = alloc((unsigned)(l + STRLEN(str2) + 1L));
4656 if (dest != NULL)
4658 STRCPY(dest, str1);
4659 STRCPY(dest + l, str2);
4661 return dest;
4663 #endif
4666 * Add a path separator to a file name, unless it already ends in a path
4667 * separator.
4669 void
4670 add_pathsep(p)
4671 char_u *p;
4673 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
4674 STRCAT(p, PATHSEPSTR);
4678 * FullName_save - Make an allocated copy of a full file name.
4679 * Returns NULL when out of memory.
4681 char_u *
4682 FullName_save(fname, force)
4683 char_u *fname;
4684 int force; /* force expansion, even when it already looks
4685 like a full path name */
4687 char_u *buf;
4688 char_u *new_fname = NULL;
4690 if (fname == NULL)
4691 return NULL;
4693 buf = alloc((unsigned)MAXPATHL);
4694 if (buf != NULL)
4696 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
4697 new_fname = vim_strsave(buf);
4698 else
4699 new_fname = vim_strsave(fname);
4700 vim_free(buf);
4702 return new_fname;
4705 #if defined(FEAT_CINDENT) || defined(FEAT_SYN_HL)
4707 static char_u *skip_string __ARGS((char_u *p));
4710 * Find the start of a comment, not knowing if we are in a comment right now.
4711 * Search starts at w_cursor.lnum and goes backwards.
4713 pos_T *
4714 find_start_comment(ind_maxcomment) /* XXX */
4715 int ind_maxcomment;
4717 pos_T *pos;
4718 char_u *line;
4719 char_u *p;
4720 int cur_maxcomment = ind_maxcomment;
4722 for (;;)
4724 pos = findmatchlimit(NULL, '*', FM_BACKWARD, cur_maxcomment);
4725 if (pos == NULL)
4726 break;
4729 * Check if the comment start we found is inside a string.
4730 * If it is then restrict the search to below this line and try again.
4732 line = ml_get(pos->lnum);
4733 for (p = line; *p && (unsigned)(p - line) < pos->col; ++p)
4734 p = skip_string(p);
4735 if ((unsigned)(p - line) <= pos->col)
4736 break;
4737 cur_maxcomment = curwin->w_cursor.lnum - pos->lnum - 1;
4738 if (cur_maxcomment <= 0)
4740 pos = NULL;
4741 break;
4744 return pos;
4748 * Skip to the end of a "string" and a 'c' character.
4749 * If there is no string or character, return argument unmodified.
4751 static char_u *
4752 skip_string(p)
4753 char_u *p;
4755 int i;
4758 * We loop, because strings may be concatenated: "date""time".
4760 for ( ; ; ++p)
4762 if (p[0] == '\'') /* 'c' or '\n' or '\000' */
4764 if (!p[1]) /* ' at end of line */
4765 break;
4766 i = 2;
4767 if (p[1] == '\\') /* '\n' or '\000' */
4769 ++i;
4770 while (vim_isdigit(p[i - 1])) /* '\000' */
4771 ++i;
4773 if (p[i] == '\'') /* check for trailing ' */
4775 p += i;
4776 continue;
4779 else if (p[0] == '"') /* start of string */
4781 for (++p; p[0]; ++p)
4783 if (p[0] == '\\' && p[1] != NUL)
4784 ++p;
4785 else if (p[0] == '"') /* end of string */
4786 break;
4788 if (p[0] == '"')
4789 continue;
4791 break; /* no string found */
4793 if (!*p)
4794 --p; /* backup from NUL */
4795 return p;
4797 #endif /* FEAT_CINDENT || FEAT_SYN_HL */
4799 #if defined(FEAT_CINDENT) || defined(PROTO)
4802 * Do C or expression indenting on the current line.
4804 void
4805 do_c_expr_indent()
4807 # ifdef FEAT_EVAL
4808 if (*curbuf->b_p_inde != NUL)
4809 fixthisline(get_expr_indent);
4810 else
4811 # endif
4812 fixthisline(get_c_indent);
4816 * Functions for C-indenting.
4817 * Most of this originally comes from Eric Fischer.
4820 * Below "XXX" means that this function may unlock the current line.
4823 static char_u *cin_skipcomment __ARGS((char_u *));
4824 static int cin_nocode __ARGS((char_u *));
4825 static pos_T *find_line_comment __ARGS((void));
4826 static int cin_islabel_skip __ARGS((char_u **));
4827 static int cin_isdefault __ARGS((char_u *));
4828 static char_u *after_label __ARGS((char_u *l));
4829 static int get_indent_nolabel __ARGS((linenr_T lnum));
4830 static int skip_label __ARGS((linenr_T, char_u **pp, int ind_maxcomment));
4831 static int cin_first_id_amount __ARGS((void));
4832 static int cin_get_equal_amount __ARGS((linenr_T lnum));
4833 static int cin_ispreproc __ARGS((char_u *));
4834 static int cin_ispreproc_cont __ARGS((char_u **pp, linenr_T *lnump));
4835 static int cin_iscomment __ARGS((char_u *));
4836 static int cin_islinecomment __ARGS((char_u *));
4837 static int cin_isterminated __ARGS((char_u *, int, int));
4838 static int cin_isinit __ARGS((void));
4839 static int cin_isfuncdecl __ARGS((char_u **, linenr_T));
4840 static int cin_isif __ARGS((char_u *));
4841 static int cin_iselse __ARGS((char_u *));
4842 static int cin_isdo __ARGS((char_u *));
4843 static int cin_iswhileofdo __ARGS((char_u *, linenr_T, int));
4844 static int cin_iswhileofdo_end __ARGS((int terminated, int ind_maxparen, int ind_maxcomment));
4845 static int cin_isbreak __ARGS((char_u *));
4846 static int cin_is_cpp_baseclass __ARGS((colnr_T *col));
4847 static int get_baseclass_amount __ARGS((int col, int ind_maxparen, int ind_maxcomment, int ind_cpp_baseclass));
4848 static int cin_ends_in __ARGS((char_u *, char_u *, char_u *));
4849 static int cin_skip2pos __ARGS((pos_T *trypos));
4850 static pos_T *find_start_brace __ARGS((int));
4851 static pos_T *find_match_paren __ARGS((int, int));
4852 static int corr_ind_maxparen __ARGS((int ind_maxparen, pos_T *startpos));
4853 static int find_last_paren __ARGS((char_u *l, int start, int end));
4854 static int find_match __ARGS((int lookfor, linenr_T ourscope, int ind_maxparen, int ind_maxcomment));
4856 static int ind_hash_comment = 0; /* # starts a comment */
4859 * Skip over white space and C comments within the line.
4860 * Also skip over Perl/shell comments if desired.
4862 static char_u *
4863 cin_skipcomment(s)
4864 char_u *s;
4866 while (*s)
4868 char_u *prev_s = s;
4870 s = skipwhite(s);
4872 /* Perl/shell # comment comment continues until eol. Require a space
4873 * before # to avoid recognizing $#array. */
4874 if (ind_hash_comment != 0 && s != prev_s && *s == '#')
4876 s += STRLEN(s);
4877 break;
4879 if (*s != '/')
4880 break;
4881 ++s;
4882 if (*s == '/') /* slash-slash comment continues till eol */
4884 s += STRLEN(s);
4885 break;
4887 if (*s != '*')
4888 break;
4889 for (++s; *s; ++s) /* skip slash-star comment */
4890 if (s[0] == '*' && s[1] == '/')
4892 s += 2;
4893 break;
4896 return s;
4900 * Return TRUE if there there is no code at *s. White space and comments are
4901 * not considered code.
4903 static int
4904 cin_nocode(s)
4905 char_u *s;
4907 return *cin_skipcomment(s) == NUL;
4911 * Check previous lines for a "//" line comment, skipping over blank lines.
4913 static pos_T *
4914 find_line_comment() /* XXX */
4916 static pos_T pos;
4917 char_u *line;
4918 char_u *p;
4920 pos = curwin->w_cursor;
4921 while (--pos.lnum > 0)
4923 line = ml_get(pos.lnum);
4924 p = skipwhite(line);
4925 if (cin_islinecomment(p))
4927 pos.col = (int)(p - line);
4928 return &pos;
4930 if (*p != NUL)
4931 break;
4933 return NULL;
4937 * Check if string matches "label:"; move to character after ':' if true.
4939 static int
4940 cin_islabel_skip(s)
4941 char_u **s;
4943 if (!vim_isIDc(**s)) /* need at least one ID character */
4944 return FALSE;
4946 while (vim_isIDc(**s))
4947 (*s)++;
4949 *s = cin_skipcomment(*s);
4951 /* "::" is not a label, it's C++ */
4952 return (**s == ':' && *++*s != ':');
4956 * Recognize a label: "label:".
4957 * Note: curwin->w_cursor must be where we are looking for the label.
4960 cin_islabel(ind_maxcomment) /* XXX */
4961 int ind_maxcomment;
4963 char_u *s;
4965 s = cin_skipcomment(ml_get_curline());
4968 * Exclude "default" from labels, since it should be indented
4969 * like a switch label. Same for C++ scope declarations.
4971 if (cin_isdefault(s))
4972 return FALSE;
4973 if (cin_isscopedecl(s))
4974 return FALSE;
4976 if (cin_islabel_skip(&s))
4979 * Only accept a label if the previous line is terminated or is a case
4980 * label.
4982 pos_T cursor_save;
4983 pos_T *trypos;
4984 char_u *line;
4986 cursor_save = curwin->w_cursor;
4987 while (curwin->w_cursor.lnum > 1)
4989 --curwin->w_cursor.lnum;
4992 * If we're in a comment now, skip to the start of the comment.
4994 curwin->w_cursor.col = 0;
4995 if ((trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
4996 curwin->w_cursor = *trypos;
4998 line = ml_get_curline();
4999 if (cin_ispreproc(line)) /* ignore #defines, #if, etc. */
5000 continue;
5001 if (*(line = cin_skipcomment(line)) == NUL)
5002 continue;
5004 curwin->w_cursor = cursor_save;
5005 if (cin_isterminated(line, TRUE, FALSE)
5006 || cin_isscopedecl(line)
5007 || cin_iscase(line)
5008 || (cin_islabel_skip(&line) && cin_nocode(line)))
5009 return TRUE;
5010 return FALSE;
5012 curwin->w_cursor = cursor_save;
5013 return TRUE; /* label at start of file??? */
5015 return FALSE;
5019 * Recognize structure initialization and enumerations.
5020 * Q&D-Implementation:
5021 * check for "=" at end or "[typedef] enum" at beginning of line.
5023 static int
5024 cin_isinit(void)
5026 char_u *s;
5028 s = cin_skipcomment(ml_get_curline());
5030 if (STRNCMP(s, "typedef", 7) == 0 && !vim_isIDc(s[7]))
5031 s = cin_skipcomment(s + 7);
5033 if (STRNCMP(s, "enum", 4) == 0 && !vim_isIDc(s[4]))
5034 return TRUE;
5036 if (cin_ends_in(s, (char_u *)"=", (char_u *)"{"))
5037 return TRUE;
5039 return FALSE;
5043 * Recognize a switch label: "case .*:" or "default:".
5046 cin_iscase(s)
5047 char_u *s;
5049 s = cin_skipcomment(s);
5050 if (STRNCMP(s, "case", 4) == 0 && !vim_isIDc(s[4]))
5052 for (s += 4; *s; ++s)
5054 s = cin_skipcomment(s);
5055 if (*s == ':')
5057 if (s[1] == ':') /* skip over "::" for C++ */
5058 ++s;
5059 else
5060 return TRUE;
5062 if (*s == '\'' && s[1] && s[2] == '\'')
5063 s += 2; /* skip over '.' */
5064 else if (*s == '/' && (s[1] == '*' || s[1] == '/'))
5065 return FALSE; /* stop at comment */
5066 else if (*s == '"')
5067 return FALSE; /* stop at string */
5069 return FALSE;
5072 if (cin_isdefault(s))
5073 return TRUE;
5074 return FALSE;
5078 * Recognize a "default" switch label.
5080 static int
5081 cin_isdefault(s)
5082 char_u *s;
5084 return (STRNCMP(s, "default", 7) == 0
5085 && *(s = cin_skipcomment(s + 7)) == ':'
5086 && s[1] != ':');
5090 * Recognize a "public/private/proctected" scope declaration label.
5093 cin_isscopedecl(s)
5094 char_u *s;
5096 int i;
5098 s = cin_skipcomment(s);
5099 if (STRNCMP(s, "public", 6) == 0)
5100 i = 6;
5101 else if (STRNCMP(s, "protected", 9) == 0)
5102 i = 9;
5103 else if (STRNCMP(s, "private", 7) == 0)
5104 i = 7;
5105 else
5106 return FALSE;
5107 return (*(s = cin_skipcomment(s + i)) == ':' && s[1] != ':');
5111 * Return a pointer to the first non-empty non-comment character after a ':'.
5112 * Return NULL if not found.
5113 * case 234: a = b;
5116 static char_u *
5117 after_label(l)
5118 char_u *l;
5120 for ( ; *l; ++l)
5122 if (*l == ':')
5124 if (l[1] == ':') /* skip over "::" for C++ */
5125 ++l;
5126 else if (!cin_iscase(l + 1))
5127 break;
5129 else if (*l == '\'' && l[1] && l[2] == '\'')
5130 l += 2; /* skip over 'x' */
5132 if (*l == NUL)
5133 return NULL;
5134 l = cin_skipcomment(l + 1);
5135 if (*l == NUL)
5136 return NULL;
5137 return l;
5141 * Get indent of line "lnum", skipping a label.
5142 * Return 0 if there is nothing after the label.
5144 static int
5145 get_indent_nolabel(lnum) /* XXX */
5146 linenr_T lnum;
5148 char_u *l;
5149 pos_T fp;
5150 colnr_T col;
5151 char_u *p;
5153 l = ml_get(lnum);
5154 p = after_label(l);
5155 if (p == NULL)
5156 return 0;
5158 fp.col = (colnr_T)(p - l);
5159 fp.lnum = lnum;
5160 getvcol(curwin, &fp, &col, NULL, NULL);
5161 return (int)col;
5165 * Find indent for line "lnum", ignoring any case or jump label.
5166 * Also return a pointer to the text (after the label) in "pp".
5167 * label: if (asdf && asdfasdf)
5170 static int
5171 skip_label(lnum, pp, ind_maxcomment)
5172 linenr_T lnum;
5173 char_u **pp;
5174 int ind_maxcomment;
5176 char_u *l;
5177 int amount;
5178 pos_T cursor_save;
5180 cursor_save = curwin->w_cursor;
5181 curwin->w_cursor.lnum = lnum;
5182 l = ml_get_curline();
5183 /* XXX */
5184 if (cin_iscase(l) || cin_isscopedecl(l) || cin_islabel(ind_maxcomment))
5186 amount = get_indent_nolabel(lnum);
5187 l = after_label(ml_get_curline());
5188 if (l == NULL) /* just in case */
5189 l = ml_get_curline();
5191 else
5193 amount = get_indent();
5194 l = ml_get_curline();
5196 *pp = l;
5198 curwin->w_cursor = cursor_save;
5199 return amount;
5203 * Return the indent of the first variable name after a type in a declaration.
5204 * int a, indent of "a"
5205 * static struct foo b, indent of "b"
5206 * enum bla c, indent of "c"
5207 * Returns zero when it doesn't look like a declaration.
5209 static int
5210 cin_first_id_amount()
5212 char_u *line, *p, *s;
5213 int len;
5214 pos_T fp;
5215 colnr_T col;
5217 line = ml_get_curline();
5218 p = skipwhite(line);
5219 len = (int)(skiptowhite(p) - p);
5220 if (len == 6 && STRNCMP(p, "static", 6) == 0)
5222 p = skipwhite(p + 6);
5223 len = (int)(skiptowhite(p) - p);
5225 if (len == 6 && STRNCMP(p, "struct", 6) == 0)
5226 p = skipwhite(p + 6);
5227 else if (len == 4 && STRNCMP(p, "enum", 4) == 0)
5228 p = skipwhite(p + 4);
5229 else if ((len == 8 && STRNCMP(p, "unsigned", 8) == 0)
5230 || (len == 6 && STRNCMP(p, "signed", 6) == 0))
5232 s = skipwhite(p + len);
5233 if ((STRNCMP(s, "int", 3) == 0 && vim_iswhite(s[3]))
5234 || (STRNCMP(s, "long", 4) == 0 && vim_iswhite(s[4]))
5235 || (STRNCMP(s, "short", 5) == 0 && vim_iswhite(s[5]))
5236 || (STRNCMP(s, "char", 4) == 0 && vim_iswhite(s[4])))
5237 p = s;
5239 for (len = 0; vim_isIDc(p[len]); ++len)
5241 if (len == 0 || !vim_iswhite(p[len]) || cin_nocode(p))
5242 return 0;
5244 p = skipwhite(p + len);
5245 fp.lnum = curwin->w_cursor.lnum;
5246 fp.col = (colnr_T)(p - line);
5247 getvcol(curwin, &fp, &col, NULL, NULL);
5248 return (int)col;
5252 * Return the indent of the first non-blank after an equal sign.
5253 * char *foo = "here";
5254 * Return zero if no (useful) equal sign found.
5255 * Return -1 if the line above "lnum" ends in a backslash.
5256 * foo = "asdf\
5257 * asdf\
5258 * here";
5260 static int
5261 cin_get_equal_amount(lnum)
5262 linenr_T lnum;
5264 char_u *line;
5265 char_u *s;
5266 colnr_T col;
5267 pos_T fp;
5269 if (lnum > 1)
5271 line = ml_get(lnum - 1);
5272 if (*line != NUL && line[STRLEN(line) - 1] == '\\')
5273 return -1;
5276 line = s = ml_get(lnum);
5277 while (*s != NUL && vim_strchr((char_u *)"=;{}\"'", *s) == NULL)
5279 if (cin_iscomment(s)) /* ignore comments */
5280 s = cin_skipcomment(s);
5281 else
5282 ++s;
5284 if (*s != '=')
5285 return 0;
5287 s = skipwhite(s + 1);
5288 if (cin_nocode(s))
5289 return 0;
5291 if (*s == '"') /* nice alignment for continued strings */
5292 ++s;
5294 fp.lnum = lnum;
5295 fp.col = (colnr_T)(s - line);
5296 getvcol(curwin, &fp, &col, NULL, NULL);
5297 return (int)col;
5301 * Recognize a preprocessor statement: Any line that starts with '#'.
5303 static int
5304 cin_ispreproc(s)
5305 char_u *s;
5307 s = skipwhite(s);
5308 if (*s == '#')
5309 return TRUE;
5310 return FALSE;
5314 * Return TRUE if line "*pp" at "*lnump" is a preprocessor statement or a
5315 * continuation line of a preprocessor statement. Decrease "*lnump" to the
5316 * start and return the line in "*pp".
5318 static int
5319 cin_ispreproc_cont(pp, lnump)
5320 char_u **pp;
5321 linenr_T *lnump;
5323 char_u *line = *pp;
5324 linenr_T lnum = *lnump;
5325 int retval = FALSE;
5327 for (;;)
5329 if (cin_ispreproc(line))
5331 retval = TRUE;
5332 *lnump = lnum;
5333 break;
5335 if (lnum == 1)
5336 break;
5337 line = ml_get(--lnum);
5338 if (*line == NUL || line[STRLEN(line) - 1] != '\\')
5339 break;
5342 if (lnum != *lnump)
5343 *pp = ml_get(*lnump);
5344 return retval;
5348 * Recognize the start of a C or C++ comment.
5350 static int
5351 cin_iscomment(p)
5352 char_u *p;
5354 return (p[0] == '/' && (p[1] == '*' || p[1] == '/'));
5358 * Recognize the start of a "//" comment.
5360 static int
5361 cin_islinecomment(p)
5362 char_u *p;
5364 return (p[0] == '/' && p[1] == '/');
5368 * Recognize a line that starts with '{' or '}', or ends with ';', '{' or '}'.
5369 * Don't consider "} else" a terminated line.
5370 * Return the character terminating the line (ending char's have precedence if
5371 * both apply in order to determine initializations).
5373 static int
5374 cin_isterminated(s, incl_open, incl_comma)
5375 char_u *s;
5376 int incl_open; /* include '{' at the end as terminator */
5377 int incl_comma; /* recognize a trailing comma */
5379 char_u found_start = 0;
5381 s = cin_skipcomment(s);
5383 if (*s == '{' || (*s == '}' && !cin_iselse(s)))
5384 found_start = *s;
5386 while (*s)
5388 /* skip over comments, "" strings and 'c'haracters */
5389 s = skip_string(cin_skipcomment(s));
5390 if ((*s == ';' || (incl_open && *s == '{') || *s == '}'
5391 || (incl_comma && *s == ','))
5392 && cin_nocode(s + 1))
5393 return *s;
5395 if (*s)
5396 s++;
5398 return found_start;
5402 * Recognize the basic picture of a function declaration -- it needs to
5403 * have an open paren somewhere and a close paren at the end of the line and
5404 * no semicolons anywhere.
5405 * When a line ends in a comma we continue looking in the next line.
5406 * "sp" points to a string with the line. When looking at other lines it must
5407 * be restored to the line. When it's NULL fetch lines here.
5408 * "lnum" is where we start looking.
5410 static int
5411 cin_isfuncdecl(sp, first_lnum)
5412 char_u **sp;
5413 linenr_T first_lnum;
5415 char_u *s;
5416 linenr_T lnum = first_lnum;
5417 int retval = FALSE;
5419 if (sp == NULL)
5420 s = ml_get(lnum);
5421 else
5422 s = *sp;
5424 while (*s && *s != '(' && *s != ';' && *s != '\'' && *s != '"')
5426 if (cin_iscomment(s)) /* ignore comments */
5427 s = cin_skipcomment(s);
5428 else
5429 ++s;
5431 if (*s != '(')
5432 return FALSE; /* ';', ' or " before any () or no '(' */
5434 while (*s && *s != ';' && *s != '\'' && *s != '"')
5436 if (*s == ')' && cin_nocode(s + 1))
5438 /* ')' at the end: may have found a match
5439 * Check for he previous line not to end in a backslash:
5440 * #if defined(x) && \
5441 * defined(y)
5443 lnum = first_lnum - 1;
5444 s = ml_get(lnum);
5445 if (*s == NUL || s[STRLEN(s) - 1] != '\\')
5446 retval = TRUE;
5447 goto done;
5449 if (*s == ',' && cin_nocode(s + 1))
5451 /* ',' at the end: continue looking in the next line */
5452 if (lnum >= curbuf->b_ml.ml_line_count)
5453 break;
5455 s = ml_get(++lnum);
5457 else if (cin_iscomment(s)) /* ignore comments */
5458 s = cin_skipcomment(s);
5459 else
5460 ++s;
5463 done:
5464 if (lnum != first_lnum && sp != NULL)
5465 *sp = ml_get(first_lnum);
5467 return retval;
5470 static int
5471 cin_isif(p)
5472 char_u *p;
5474 return (STRNCMP(p, "if", 2) == 0 && !vim_isIDc(p[2]));
5477 static int
5478 cin_iselse(p)
5479 char_u *p;
5481 if (*p == '}') /* accept "} else" */
5482 p = cin_skipcomment(p + 1);
5483 return (STRNCMP(p, "else", 4) == 0 && !vim_isIDc(p[4]));
5486 static int
5487 cin_isdo(p)
5488 char_u *p;
5490 return (STRNCMP(p, "do", 2) == 0 && !vim_isIDc(p[2]));
5494 * Check if this is a "while" that should have a matching "do".
5495 * We only accept a "while (condition) ;", with only white space between the
5496 * ')' and ';'. The condition may be spread over several lines.
5498 static int
5499 cin_iswhileofdo(p, lnum, ind_maxparen) /* XXX */
5500 char_u *p;
5501 linenr_T lnum;
5502 int ind_maxparen;
5504 pos_T cursor_save;
5505 pos_T *trypos;
5506 int retval = FALSE;
5508 p = cin_skipcomment(p);
5509 if (*p == '}') /* accept "} while (cond);" */
5510 p = cin_skipcomment(p + 1);
5511 if (STRNCMP(p, "while", 5) == 0 && !vim_isIDc(p[5]))
5513 cursor_save = curwin->w_cursor;
5514 curwin->w_cursor.lnum = lnum;
5515 curwin->w_cursor.col = 0;
5516 p = ml_get_curline();
5517 while (*p && *p != 'w') /* skip any '}', until the 'w' of the "while" */
5519 ++p;
5520 ++curwin->w_cursor.col;
5522 if ((trypos = findmatchlimit(NULL, 0, 0, ind_maxparen)) != NULL
5523 && *cin_skipcomment(ml_get_pos(trypos) + 1) == ';')
5524 retval = TRUE;
5525 curwin->w_cursor = cursor_save;
5527 return retval;
5531 * Return TRUE if we are at the end of a do-while.
5532 * do
5533 * nothing;
5534 * while (foo
5535 * && bar); <-- here
5536 * Adjust the cursor to the line with "while".
5538 static int
5539 cin_iswhileofdo_end(terminated, ind_maxparen, ind_maxcomment)
5540 int terminated;
5541 int ind_maxparen;
5542 int ind_maxcomment;
5544 char_u *line;
5545 char_u *p;
5546 char_u *s;
5547 pos_T *trypos;
5548 int i;
5550 if (terminated != ';') /* there must be a ';' at the end */
5551 return FALSE;
5553 p = line = ml_get_curline();
5554 while (*p != NUL)
5556 p = cin_skipcomment(p);
5557 if (*p == ')')
5559 s = skipwhite(p + 1);
5560 if (*s == ';' && cin_nocode(s + 1))
5562 /* Found ");" at end of the line, now check there is "while"
5563 * before the matching '('. XXX */
5564 i = (int)(p - line);
5565 curwin->w_cursor.col = i;
5566 trypos = find_match_paren(ind_maxparen, ind_maxcomment);
5567 if (trypos != NULL)
5569 s = cin_skipcomment(ml_get(trypos->lnum));
5570 if (*s == '}') /* accept "} while (cond);" */
5571 s = cin_skipcomment(s + 1);
5572 if (STRNCMP(s, "while", 5) == 0 && !vim_isIDc(s[5]))
5574 curwin->w_cursor.lnum = trypos->lnum;
5575 return TRUE;
5579 /* Searching may have made "line" invalid, get it again. */
5580 line = ml_get_curline();
5581 p = line + i;
5584 if (*p != NUL)
5585 ++p;
5587 return FALSE;
5590 static int
5591 cin_isbreak(p)
5592 char_u *p;
5594 return (STRNCMP(p, "break", 5) == 0 && !vim_isIDc(p[5]));
5598 * Find the position of a C++ base-class declaration or
5599 * constructor-initialization. eg:
5601 * class MyClass :
5602 * baseClass <-- here
5603 * class MyClass : public baseClass,
5604 * anotherBaseClass <-- here (should probably lineup ??)
5605 * MyClass::MyClass(...) :
5606 * baseClass(...) <-- here (constructor-initialization)
5608 * This is a lot of guessing. Watch out for "cond ? func() : foo".
5610 static int
5611 cin_is_cpp_baseclass(col)
5612 colnr_T *col; /* return: column to align with */
5614 char_u *s;
5615 int class_or_struct, lookfor_ctor_init, cpp_base_class;
5616 linenr_T lnum = curwin->w_cursor.lnum;
5617 char_u *line = ml_get_curline();
5619 *col = 0;
5621 s = skipwhite(line);
5622 if (*s == '#') /* skip #define FOO x ? (x) : x */
5623 return FALSE;
5624 s = cin_skipcomment(s);
5625 if (*s == NUL)
5626 return FALSE;
5628 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5630 /* Search for a line starting with '#', empty, ending in ';' or containing
5631 * '{' or '}' and start below it. This handles the following situations:
5632 * a = cond ?
5633 * func() :
5634 * asdf;
5635 * func::foo()
5636 * : something
5637 * {}
5638 * Foo::Foo (int one, int two)
5639 * : something(4),
5640 * somethingelse(3)
5641 * {}
5643 while (lnum > 1)
5645 line = ml_get(lnum - 1);
5646 s = skipwhite(line);
5647 if (*s == '#' || *s == NUL)
5648 break;
5649 while (*s != NUL)
5651 s = cin_skipcomment(s);
5652 if (*s == '{' || *s == '}'
5653 || (*s == ';' && cin_nocode(s + 1)))
5654 break;
5655 if (*s != NUL)
5656 ++s;
5658 if (*s != NUL)
5659 break;
5660 --lnum;
5663 line = ml_get(lnum);
5664 s = cin_skipcomment(line);
5665 for (;;)
5667 if (*s == NUL)
5669 if (lnum == curwin->w_cursor.lnum)
5670 break;
5671 /* Continue in the cursor line. */
5672 line = ml_get(++lnum);
5673 s = cin_skipcomment(line);
5674 if (*s == NUL)
5675 continue;
5678 if (s[0] == ':')
5680 if (s[1] == ':')
5682 /* skip double colon. It can't be a constructor
5683 * initialization any more */
5684 lookfor_ctor_init = FALSE;
5685 s = cin_skipcomment(s + 2);
5687 else if (lookfor_ctor_init || class_or_struct)
5689 /* we have something found, that looks like the start of
5690 * cpp-base-class-declaration or contructor-initialization */
5691 cpp_base_class = TRUE;
5692 lookfor_ctor_init = class_or_struct = FALSE;
5693 *col = 0;
5694 s = cin_skipcomment(s + 1);
5696 else
5697 s = cin_skipcomment(s + 1);
5699 else if ((STRNCMP(s, "class", 5) == 0 && !vim_isIDc(s[5]))
5700 || (STRNCMP(s, "struct", 6) == 0 && !vim_isIDc(s[6])))
5702 class_or_struct = TRUE;
5703 lookfor_ctor_init = FALSE;
5705 if (*s == 'c')
5706 s = cin_skipcomment(s + 5);
5707 else
5708 s = cin_skipcomment(s + 6);
5710 else
5712 if (s[0] == '{' || s[0] == '}' || s[0] == ';')
5714 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5716 else if (s[0] == ')')
5718 /* Constructor-initialization is assumed if we come across
5719 * something like "):" */
5720 class_or_struct = FALSE;
5721 lookfor_ctor_init = TRUE;
5723 else if (s[0] == '?')
5725 /* Avoid seeing '() :' after '?' as constructor init. */
5726 return FALSE;
5728 else if (!vim_isIDc(s[0]))
5730 /* if it is not an identifier, we are wrong */
5731 class_or_struct = FALSE;
5732 lookfor_ctor_init = FALSE;
5734 else if (*col == 0)
5736 /* it can't be a constructor-initialization any more */
5737 lookfor_ctor_init = FALSE;
5739 /* the first statement starts here: lineup with this one... */
5740 if (cpp_base_class)
5741 *col = (colnr_T)(s - line);
5744 /* When the line ends in a comma don't align with it. */
5745 if (lnum == curwin->w_cursor.lnum && *s == ',' && cin_nocode(s + 1))
5746 *col = 0;
5748 s = cin_skipcomment(s + 1);
5752 return cpp_base_class;
5755 static int
5756 get_baseclass_amount(col, ind_maxparen, ind_maxcomment, ind_cpp_baseclass)
5757 int col;
5758 int ind_maxparen;
5759 int ind_maxcomment;
5760 int ind_cpp_baseclass;
5762 int amount;
5763 colnr_T vcol;
5764 pos_T *trypos;
5766 if (col == 0)
5768 amount = get_indent();
5769 if (find_last_paren(ml_get_curline(), '(', ')')
5770 && (trypos = find_match_paren(ind_maxparen,
5771 ind_maxcomment)) != NULL)
5772 amount = get_indent_lnum(trypos->lnum); /* XXX */
5773 if (!cin_ends_in(ml_get_curline(), (char_u *)",", NULL))
5774 amount += ind_cpp_baseclass;
5776 else
5778 curwin->w_cursor.col = col;
5779 getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
5780 amount = (int)vcol;
5782 if (amount < ind_cpp_baseclass)
5783 amount = ind_cpp_baseclass;
5784 return amount;
5788 * Return TRUE if string "s" ends with the string "find", possibly followed by
5789 * white space and comments. Skip strings and comments.
5790 * Ignore "ignore" after "find" if it's not NULL.
5792 static int
5793 cin_ends_in(s, find, ignore)
5794 char_u *s;
5795 char_u *find;
5796 char_u *ignore;
5798 char_u *p = s;
5799 char_u *r;
5800 int len = (int)STRLEN(find);
5802 while (*p != NUL)
5804 p = cin_skipcomment(p);
5805 if (STRNCMP(p, find, len) == 0)
5807 r = skipwhite(p + len);
5808 if (ignore != NULL && STRNCMP(r, ignore, STRLEN(ignore)) == 0)
5809 r = skipwhite(r + STRLEN(ignore));
5810 if (cin_nocode(r))
5811 return TRUE;
5813 if (*p != NUL)
5814 ++p;
5816 return FALSE;
5820 * Skip strings, chars and comments until at or past "trypos".
5821 * Return the column found.
5823 static int
5824 cin_skip2pos(trypos)
5825 pos_T *trypos;
5827 char_u *line;
5828 char_u *p;
5830 p = line = ml_get(trypos->lnum);
5831 while (*p && (colnr_T)(p - line) < trypos->col)
5833 if (cin_iscomment(p))
5834 p = cin_skipcomment(p);
5835 else
5837 p = skip_string(p);
5838 ++p;
5841 return (int)(p - line);
5845 * Find the '{' at the start of the block we are in.
5846 * Return NULL if no match found.
5847 * Ignore a '{' that is in a comment, makes indenting the next three lines
5848 * work. */
5849 /* foo() */
5850 /* { */
5851 /* } */
5853 static pos_T *
5854 find_start_brace(ind_maxcomment) /* XXX */
5855 int ind_maxcomment;
5857 pos_T cursor_save;
5858 pos_T *trypos;
5859 pos_T *pos;
5860 static pos_T pos_copy;
5862 cursor_save = curwin->w_cursor;
5863 while ((trypos = findmatchlimit(NULL, '{', FM_BLOCKSTOP, 0)) != NULL)
5865 pos_copy = *trypos; /* copy pos_T, next findmatch will change it */
5866 trypos = &pos_copy;
5867 curwin->w_cursor = *trypos;
5868 pos = NULL;
5869 /* ignore the { if it's in a // or / * * / comment */
5870 if ((colnr_T)cin_skip2pos(trypos) == trypos->col
5871 && (pos = find_start_comment(ind_maxcomment)) == NULL) /* XXX */
5872 break;
5873 if (pos != NULL)
5874 curwin->w_cursor.lnum = pos->lnum;
5876 curwin->w_cursor = cursor_save;
5877 return trypos;
5881 * Find the matching '(', failing if it is in a comment.
5882 * Return NULL of no match found.
5884 static pos_T *
5885 find_match_paren(ind_maxparen, ind_maxcomment) /* XXX */
5886 int ind_maxparen;
5887 int ind_maxcomment;
5889 pos_T cursor_save;
5890 pos_T *trypos;
5891 static pos_T pos_copy;
5893 cursor_save = curwin->w_cursor;
5894 if ((trypos = findmatchlimit(NULL, '(', 0, ind_maxparen)) != NULL)
5896 /* check if the ( is in a // comment */
5897 if ((colnr_T)cin_skip2pos(trypos) > trypos->col)
5898 trypos = NULL;
5899 else
5901 pos_copy = *trypos; /* copy trypos, findmatch will change it */
5902 trypos = &pos_copy;
5903 curwin->w_cursor = *trypos;
5904 if (find_start_comment(ind_maxcomment) != NULL) /* XXX */
5905 trypos = NULL;
5908 curwin->w_cursor = cursor_save;
5909 return trypos;
5913 * Return ind_maxparen corrected for the difference in line number between the
5914 * cursor position and "startpos". This makes sure that searching for a
5915 * matching paren above the cursor line doesn't find a match because of
5916 * looking a few lines further.
5918 static int
5919 corr_ind_maxparen(ind_maxparen, startpos)
5920 int ind_maxparen;
5921 pos_T *startpos;
5923 long n = (long)startpos->lnum - (long)curwin->w_cursor.lnum;
5925 if (n > 0 && n < ind_maxparen / 2)
5926 return ind_maxparen - (int)n;
5927 return ind_maxparen;
5931 * Set w_cursor.col to the column number of the last unmatched ')' or '{' in
5932 * line "l".
5934 static int
5935 find_last_paren(l, start, end)
5936 char_u *l;
5937 int start, end;
5939 int i;
5940 int retval = FALSE;
5941 int open_count = 0;
5943 curwin->w_cursor.col = 0; /* default is start of line */
5945 for (i = 0; l[i]; i++)
5947 i = (int)(cin_skipcomment(l + i) - l); /* ignore parens in comments */
5948 i = (int)(skip_string(l + i) - l); /* ignore parens in quotes */
5949 if (l[i] == start)
5950 ++open_count;
5951 else if (l[i] == end)
5953 if (open_count > 0)
5954 --open_count;
5955 else
5957 curwin->w_cursor.col = i;
5958 retval = TRUE;
5962 return retval;
5966 get_c_indent()
5969 * spaces from a block's opening brace the prevailing indent for that
5970 * block should be
5972 int ind_level = curbuf->b_p_sw;
5975 * spaces from the edge of the line an open brace that's at the end of a
5976 * line is imagined to be.
5978 int ind_open_imag = 0;
5981 * spaces from the prevailing indent for a line that is not precededof by
5982 * an opening brace.
5984 int ind_no_brace = 0;
5987 * column where the first { of a function should be located }
5989 int ind_first_open = 0;
5992 * spaces from the prevailing indent a leftmost open brace should be
5993 * located
5995 int ind_open_extra = 0;
5998 * spaces from the matching open brace (real location for one at the left
5999 * edge; imaginary location from one that ends a line) the matching close
6000 * brace should be located
6002 int ind_close_extra = 0;
6005 * spaces from the edge of the line an open brace sitting in the leftmost
6006 * column is imagined to be
6008 int ind_open_left_imag = 0;
6011 * spaces from the switch() indent a "case xx" label should be located
6013 int ind_case = curbuf->b_p_sw;
6016 * spaces from the "case xx:" code after a switch() should be located
6018 int ind_case_code = curbuf->b_p_sw;
6021 * lineup break at end of case in switch() with case label
6023 int ind_case_break = 0;
6026 * spaces from the class declaration indent a scope declaration label
6027 * should be located
6029 int ind_scopedecl = curbuf->b_p_sw;
6032 * spaces from the scope declaration label code should be located
6034 int ind_scopedecl_code = curbuf->b_p_sw;
6037 * amount K&R-style parameters should be indented
6039 int ind_param = curbuf->b_p_sw;
6042 * amount a function type spec should be indented
6044 int ind_func_type = curbuf->b_p_sw;
6047 * amount a cpp base class declaration or constructor initialization
6048 * should be indented
6050 int ind_cpp_baseclass = curbuf->b_p_sw;
6053 * additional spaces beyond the prevailing indent a continuation line
6054 * should be located
6056 int ind_continuation = curbuf->b_p_sw;
6059 * spaces from the indent of the line with an unclosed parentheses
6061 int ind_unclosed = curbuf->b_p_sw * 2;
6064 * spaces from the indent of the line with an unclosed parentheses, which
6065 * itself is also unclosed
6067 int ind_unclosed2 = curbuf->b_p_sw;
6070 * suppress ignoring spaces from the indent of a line starting with an
6071 * unclosed parentheses.
6073 int ind_unclosed_noignore = 0;
6076 * If the opening paren is the last nonwhite character on the line, and
6077 * ind_unclosed_wrapped is nonzero, use this indent relative to the outer
6078 * context (for very long lines).
6080 int ind_unclosed_wrapped = 0;
6083 * suppress ignoring white space when lining up with the character after
6084 * an unclosed parentheses.
6086 int ind_unclosed_whiteok = 0;
6089 * indent a closing parentheses under the line start of the matching
6090 * opening parentheses.
6092 int ind_matching_paren = 0;
6095 * indent a closing parentheses under the previous line.
6097 int ind_paren_prev = 0;
6100 * Extra indent for comments.
6102 int ind_comment = 0;
6105 * spaces from the comment opener when there is nothing after it.
6107 int ind_in_comment = 3;
6110 * boolean: if non-zero, use ind_in_comment even if there is something
6111 * after the comment opener.
6113 int ind_in_comment2 = 0;
6116 * max lines to search for an open paren
6118 int ind_maxparen = 20;
6121 * max lines to search for an open comment
6123 int ind_maxcomment = 70;
6126 * handle braces for java code
6128 int ind_java = 0;
6131 * handle blocked cases correctly
6133 int ind_keep_case_label = 0;
6135 pos_T cur_curpos;
6136 int amount;
6137 int scope_amount;
6138 int cur_amount = MAXCOL;
6139 colnr_T col;
6140 char_u *theline;
6141 char_u *linecopy;
6142 pos_T *trypos;
6143 pos_T *tryposBrace = NULL;
6144 pos_T our_paren_pos;
6145 char_u *start;
6146 int start_brace;
6147 #define BRACE_IN_COL0 1 /* '{' is in comumn 0 */
6148 #define BRACE_AT_START 2 /* '{' is at start of line */
6149 #define BRACE_AT_END 3 /* '{' is at end of line */
6150 linenr_T ourscope;
6151 char_u *l;
6152 char_u *look;
6153 char_u terminated;
6154 int lookfor;
6155 #define LOOKFOR_INITIAL 0
6156 #define LOOKFOR_IF 1
6157 #define LOOKFOR_DO 2
6158 #define LOOKFOR_CASE 3
6159 #define LOOKFOR_ANY 4
6160 #define LOOKFOR_TERM 5
6161 #define LOOKFOR_UNTERM 6
6162 #define LOOKFOR_SCOPEDECL 7
6163 #define LOOKFOR_NOBREAK 8
6164 #define LOOKFOR_CPP_BASECLASS 9
6165 #define LOOKFOR_ENUM_OR_INIT 10
6167 int whilelevel;
6168 linenr_T lnum;
6169 char_u *options;
6170 int fraction = 0; /* init for GCC */
6171 int divider;
6172 int n;
6173 int iscase;
6174 int lookfor_break;
6175 int cont_amount = 0; /* amount for continuation line */
6177 for (options = curbuf->b_p_cino; *options; )
6179 l = options++;
6180 if (*options == '-')
6181 ++options;
6182 n = getdigits(&options);
6183 divider = 0;
6184 if (*options == '.') /* ".5s" means a fraction */
6186 fraction = atol((char *)++options);
6187 while (VIM_ISDIGIT(*options))
6189 ++options;
6190 if (divider)
6191 divider *= 10;
6192 else
6193 divider = 10;
6196 if (*options == 's') /* "2s" means two times 'shiftwidth' */
6198 if (n == 0 && fraction == 0)
6199 n = curbuf->b_p_sw; /* just "s" is one 'shiftwidth' */
6200 else
6202 n *= curbuf->b_p_sw;
6203 if (divider)
6204 n += (curbuf->b_p_sw * fraction + divider / 2) / divider;
6206 ++options;
6208 if (l[1] == '-')
6209 n = -n;
6210 /* When adding an entry here, also update the default 'cinoptions' in
6211 * doc/indent.txt, and add explanation for it! */
6212 switch (*l)
6214 case '>': ind_level = n; break;
6215 case 'e': ind_open_imag = n; break;
6216 case 'n': ind_no_brace = n; break;
6217 case 'f': ind_first_open = n; break;
6218 case '{': ind_open_extra = n; break;
6219 case '}': ind_close_extra = n; break;
6220 case '^': ind_open_left_imag = n; break;
6221 case ':': ind_case = n; break;
6222 case '=': ind_case_code = n; break;
6223 case 'b': ind_case_break = n; break;
6224 case 'p': ind_param = n; break;
6225 case 't': ind_func_type = n; break;
6226 case '/': ind_comment = n; break;
6227 case 'c': ind_in_comment = n; break;
6228 case 'C': ind_in_comment2 = n; break;
6229 case 'i': ind_cpp_baseclass = n; break;
6230 case '+': ind_continuation = n; break;
6231 case '(': ind_unclosed = n; break;
6232 case 'u': ind_unclosed2 = n; break;
6233 case 'U': ind_unclosed_noignore = n; break;
6234 case 'W': ind_unclosed_wrapped = n; break;
6235 case 'w': ind_unclosed_whiteok = n; break;
6236 case 'm': ind_matching_paren = n; break;
6237 case 'M': ind_paren_prev = n; break;
6238 case ')': ind_maxparen = n; break;
6239 case '*': ind_maxcomment = n; break;
6240 case 'g': ind_scopedecl = n; break;
6241 case 'h': ind_scopedecl_code = n; break;
6242 case 'j': ind_java = n; break;
6243 case 'l': ind_keep_case_label = n; break;
6244 case '#': ind_hash_comment = n; break;
6248 /* remember where the cursor was when we started */
6249 cur_curpos = curwin->w_cursor;
6251 /* Get a copy of the current contents of the line.
6252 * This is required, because only the most recent line obtained with
6253 * ml_get is valid! */
6254 linecopy = vim_strsave(ml_get(cur_curpos.lnum));
6255 if (linecopy == NULL)
6256 return 0;
6259 * In insert mode and the cursor is on a ')' truncate the line at the
6260 * cursor position. We don't want to line up with the matching '(' when
6261 * inserting new stuff.
6262 * For unknown reasons the cursor might be past the end of the line, thus
6263 * check for that.
6265 if ((State & INSERT)
6266 && curwin->w_cursor.col < STRLEN(linecopy)
6267 && linecopy[curwin->w_cursor.col] == ')')
6268 linecopy[curwin->w_cursor.col] = NUL;
6270 theline = skipwhite(linecopy);
6272 /* move the cursor to the start of the line */
6274 curwin->w_cursor.col = 0;
6277 * #defines and so on always go at the left when included in 'cinkeys'.
6279 if (*theline == '#' && (*linecopy == '#' || in_cinkeys('#', ' ', TRUE)))
6281 amount = 0;
6285 * Is it a non-case label? Then that goes at the left margin too.
6287 else if (cin_islabel(ind_maxcomment)) /* XXX */
6289 amount = 0;
6293 * If we're inside a "//" comment and there is a "//" comment in a
6294 * previous line, lineup with that one.
6296 else if (cin_islinecomment(theline)
6297 && (trypos = find_line_comment()) != NULL) /* XXX */
6299 /* find how indented the line beginning the comment is */
6300 getvcol(curwin, trypos, &col, NULL, NULL);
6301 amount = col;
6305 * If we're inside a comment and not looking at the start of the
6306 * comment, try using the 'comments' option.
6308 else if (!cin_iscomment(theline)
6309 && (trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
6311 int lead_start_len = 2;
6312 int lead_middle_len = 1;
6313 char_u lead_start[COM_MAX_LEN]; /* start-comment string */
6314 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
6315 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
6316 char_u *p;
6317 int start_align = 0;
6318 int start_off = 0;
6319 int done = FALSE;
6321 /* find how indented the line beginning the comment is */
6322 getvcol(curwin, trypos, &col, NULL, NULL);
6323 amount = col;
6325 p = curbuf->b_p_com;
6326 while (*p != NUL)
6328 int align = 0;
6329 int off = 0;
6330 int what = 0;
6332 while (*p != NUL && *p != ':')
6334 if (*p == COM_START || *p == COM_END || *p == COM_MIDDLE)
6335 what = *p++;
6336 else if (*p == COM_LEFT || *p == COM_RIGHT)
6337 align = *p++;
6338 else if (VIM_ISDIGIT(*p) || *p == '-')
6339 off = getdigits(&p);
6340 else
6341 ++p;
6344 if (*p == ':')
6345 ++p;
6346 (void)copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6347 if (what == COM_START)
6349 STRCPY(lead_start, lead_end);
6350 lead_start_len = (int)STRLEN(lead_start);
6351 start_off = off;
6352 start_align = align;
6354 else if (what == COM_MIDDLE)
6356 STRCPY(lead_middle, lead_end);
6357 lead_middle_len = (int)STRLEN(lead_middle);
6359 else if (what == COM_END)
6361 /* If our line starts with the middle comment string, line it
6362 * up with the comment opener per the 'comments' option. */
6363 if (STRNCMP(theline, lead_middle, lead_middle_len) == 0
6364 && STRNCMP(theline, lead_end, STRLEN(lead_end)) != 0)
6366 done = TRUE;
6367 if (curwin->w_cursor.lnum > 1)
6369 /* If the start comment string matches in the previous
6370 * line, use the indent of that line pluss offset. If
6371 * the middle comment string matches in the previous
6372 * line, use the indent of that line. XXX */
6373 look = skipwhite(ml_get(curwin->w_cursor.lnum - 1));
6374 if (STRNCMP(look, lead_start, lead_start_len) == 0)
6375 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6376 else if (STRNCMP(look, lead_middle,
6377 lead_middle_len) == 0)
6379 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6380 break;
6382 /* If the start comment string doesn't match with the
6383 * start of the comment, skip this entry. XXX */
6384 else if (STRNCMP(ml_get(trypos->lnum) + trypos->col,
6385 lead_start, lead_start_len) != 0)
6386 continue;
6388 if (start_off != 0)
6389 amount += start_off;
6390 else if (start_align == COM_RIGHT)
6391 amount += vim_strsize(lead_start)
6392 - vim_strsize(lead_middle);
6393 break;
6396 /* If our line starts with the end comment string, line it up
6397 * with the middle comment */
6398 if (STRNCMP(theline, lead_middle, lead_middle_len) != 0
6399 && STRNCMP(theline, lead_end, STRLEN(lead_end)) == 0)
6401 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6402 /* XXX */
6403 if (off != 0)
6404 amount += off;
6405 else if (align == COM_RIGHT)
6406 amount += vim_strsize(lead_start)
6407 - vim_strsize(lead_middle);
6408 done = TRUE;
6409 break;
6414 /* If our line starts with an asterisk, line up with the
6415 * asterisk in the comment opener; otherwise, line up
6416 * with the first character of the comment text.
6418 if (done)
6420 else if (theline[0] == '*')
6421 amount += 1;
6422 else
6425 * If we are more than one line away from the comment opener, take
6426 * the indent of the previous non-empty line. If 'cino' has "CO"
6427 * and we are just below the comment opener and there are any
6428 * white characters after it line up with the text after it;
6429 * otherwise, add the amount specified by "c" in 'cino'
6431 amount = -1;
6432 for (lnum = cur_curpos.lnum - 1; lnum > trypos->lnum; --lnum)
6434 if (linewhite(lnum)) /* skip blank lines */
6435 continue;
6436 amount = get_indent_lnum(lnum); /* XXX */
6437 break;
6439 if (amount == -1) /* use the comment opener */
6441 if (!ind_in_comment2)
6443 start = ml_get(trypos->lnum);
6444 look = start + trypos->col + 2; /* skip / and * */
6445 if (*look != NUL) /* if something after it */
6446 trypos->col = (colnr_T)(skipwhite(look) - start);
6448 getvcol(curwin, trypos, &col, NULL, NULL);
6449 amount = col;
6450 if (ind_in_comment2 || *look == NUL)
6451 amount += ind_in_comment;
6457 * Are we inside parentheses or braces?
6458 */ /* XXX */
6459 else if (((trypos = find_match_paren(ind_maxparen, ind_maxcomment)) != NULL
6460 && ind_java == 0)
6461 || (tryposBrace = find_start_brace(ind_maxcomment)) != NULL
6462 || trypos != NULL)
6464 if (trypos != NULL && tryposBrace != NULL)
6466 /* Both an unmatched '(' and '{' is found. Use the one which is
6467 * closer to the current cursor position, set the other to NULL. */
6468 if (trypos->lnum != tryposBrace->lnum
6469 ? trypos->lnum < tryposBrace->lnum
6470 : trypos->col < tryposBrace->col)
6471 trypos = NULL;
6472 else
6473 tryposBrace = NULL;
6476 if (trypos != NULL)
6479 * If the matching paren is more than one line away, use the indent of
6480 * a previous non-empty line that matches the same paren.
6482 if (theline[0] == ')' && ind_paren_prev)
6484 /* Line up with the start of the matching paren line. */
6485 amount = get_indent_lnum(curwin->w_cursor.lnum - 1); /* XXX */
6487 else
6489 amount = -1;
6490 our_paren_pos = *trypos;
6491 for (lnum = cur_curpos.lnum - 1; lnum > our_paren_pos.lnum; --lnum)
6493 l = skipwhite(ml_get(lnum));
6494 if (cin_nocode(l)) /* skip comment lines */
6495 continue;
6496 if (cin_ispreproc_cont(&l, &lnum))
6497 continue; /* ignore #define, #if, etc. */
6498 curwin->w_cursor.lnum = lnum;
6500 /* Skip a comment. XXX */
6501 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6503 lnum = trypos->lnum + 1;
6504 continue;
6507 /* XXX */
6508 if ((trypos = find_match_paren(
6509 corr_ind_maxparen(ind_maxparen, &cur_curpos),
6510 ind_maxcomment)) != NULL
6511 && trypos->lnum == our_paren_pos.lnum
6512 && trypos->col == our_paren_pos.col)
6514 amount = get_indent_lnum(lnum); /* XXX */
6516 if (theline[0] == ')')
6518 if (our_paren_pos.lnum != lnum
6519 && cur_amount > amount)
6520 cur_amount = amount;
6521 amount = -1;
6523 break;
6529 * Line up with line where the matching paren is. XXX
6530 * If the line starts with a '(' or the indent for unclosed
6531 * parentheses is zero, line up with the unclosed parentheses.
6533 if (amount == -1)
6535 int ignore_paren_col = 0;
6537 amount = skip_label(our_paren_pos.lnum, &look, ind_maxcomment);
6538 look = skipwhite(look);
6539 if (*look == '(')
6541 linenr_T save_lnum = curwin->w_cursor.lnum;
6542 char_u *line;
6543 int look_col;
6545 /* Ignore a '(' in front of the line that has a match before
6546 * our matching '('. */
6547 curwin->w_cursor.lnum = our_paren_pos.lnum;
6548 line = ml_get_curline();
6549 look_col = (int)(look - line);
6550 curwin->w_cursor.col = look_col + 1;
6551 if ((trypos = findmatchlimit(NULL, ')', 0, ind_maxparen))
6552 != NULL
6553 && trypos->lnum == our_paren_pos.lnum
6554 && trypos->col < our_paren_pos.col)
6555 ignore_paren_col = trypos->col + 1;
6557 curwin->w_cursor.lnum = save_lnum;
6558 look = ml_get(our_paren_pos.lnum) + look_col;
6560 if (theline[0] == ')' || ind_unclosed == 0
6561 || (!ind_unclosed_noignore && *look == '('
6562 && ignore_paren_col == 0))
6565 * If we're looking at a close paren, line up right there;
6566 * otherwise, line up with the next (non-white) character.
6567 * When ind_unclosed_wrapped is set and the matching paren is
6568 * the last nonwhite character of the line, use either the
6569 * indent of the current line or the indentation of the next
6570 * outer paren and add ind_unclosed_wrapped (for very long
6571 * lines).
6573 if (theline[0] != ')')
6575 cur_amount = MAXCOL;
6576 l = ml_get(our_paren_pos.lnum);
6577 if (ind_unclosed_wrapped
6578 && cin_ends_in(l, (char_u *)"(", NULL))
6580 /* look for opening unmatched paren, indent one level
6581 * for each additional level */
6582 n = 1;
6583 for (col = 0; col < our_paren_pos.col; ++col)
6585 switch (l[col])
6587 case '(':
6588 case '{': ++n;
6589 break;
6591 case ')':
6592 case '}': if (n > 1)
6593 --n;
6594 break;
6598 our_paren_pos.col = 0;
6599 amount += n * ind_unclosed_wrapped;
6601 else if (ind_unclosed_whiteok)
6602 our_paren_pos.col++;
6603 else
6605 col = our_paren_pos.col + 1;
6606 while (vim_iswhite(l[col]))
6607 col++;
6608 if (l[col] != NUL) /* In case of trailing space */
6609 our_paren_pos.col = col;
6610 else
6611 our_paren_pos.col++;
6616 * Find how indented the paren is, or the character after it
6617 * if we did the above "if".
6619 if (our_paren_pos.col > 0)
6621 getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
6622 if (cur_amount > (int)col)
6623 cur_amount = col;
6627 if (theline[0] == ')' && ind_matching_paren)
6629 /* Line up with the start of the matching paren line. */
6631 else if (ind_unclosed == 0 || (!ind_unclosed_noignore
6632 && *look == '(' && ignore_paren_col == 0))
6634 if (cur_amount != MAXCOL)
6635 amount = cur_amount;
6637 else
6639 /* Add ind_unclosed2 for each '(' before our matching one, but
6640 * ignore (void) before the line (ignore_paren_col). */
6641 col = our_paren_pos.col;
6642 while ((int)our_paren_pos.col > ignore_paren_col)
6644 --our_paren_pos.col;
6645 switch (*ml_get_pos(&our_paren_pos))
6647 case '(': amount += ind_unclosed2;
6648 col = our_paren_pos.col;
6649 break;
6650 case ')': amount -= ind_unclosed2;
6651 col = MAXCOL;
6652 break;
6656 /* Use ind_unclosed once, when the first '(' is not inside
6657 * braces */
6658 if (col == MAXCOL)
6659 amount += ind_unclosed;
6660 else
6662 curwin->w_cursor.lnum = our_paren_pos.lnum;
6663 curwin->w_cursor.col = col;
6664 if ((trypos = find_match_paren(ind_maxparen,
6665 ind_maxcomment)) != NULL)
6666 amount += ind_unclosed2;
6667 else
6668 amount += ind_unclosed;
6671 * For a line starting with ')' use the minimum of the two
6672 * positions, to avoid giving it more indent than the previous
6673 * lines:
6674 * func_long_name( if (x
6675 * arg && yy
6676 * ) ^ not here ) ^ not here
6678 if (cur_amount < amount)
6679 amount = cur_amount;
6683 /* add extra indent for a comment */
6684 if (cin_iscomment(theline))
6685 amount += ind_comment;
6689 * Are we at least inside braces, then?
6691 else
6693 trypos = tryposBrace;
6695 ourscope = trypos->lnum;
6696 start = ml_get(ourscope);
6699 * Now figure out how indented the line is in general.
6700 * If the brace was at the start of the line, we use that;
6701 * otherwise, check out the indentation of the line as
6702 * a whole and then add the "imaginary indent" to that.
6704 look = skipwhite(start);
6705 if (*look == '{')
6707 getvcol(curwin, trypos, &col, NULL, NULL);
6708 amount = col;
6709 if (*start == '{')
6710 start_brace = BRACE_IN_COL0;
6711 else
6712 start_brace = BRACE_AT_START;
6714 else
6717 * that opening brace might have been on a continuation
6718 * line. if so, find the start of the line.
6720 curwin->w_cursor.lnum = ourscope;
6723 * position the cursor over the rightmost paren, so that
6724 * matching it will take us back to the start of the line.
6726 lnum = ourscope;
6727 if (find_last_paren(start, '(', ')')
6728 && (trypos = find_match_paren(ind_maxparen,
6729 ind_maxcomment)) != NULL)
6730 lnum = trypos->lnum;
6733 * It could have been something like
6734 * case 1: if (asdf &&
6735 * ldfd) {
6738 if (ind_keep_case_label && cin_iscase(skipwhite(ml_get_curline())))
6739 amount = get_indent();
6740 else
6741 amount = skip_label(lnum, &l, ind_maxcomment);
6743 start_brace = BRACE_AT_END;
6747 * if we're looking at a closing brace, that's where
6748 * we want to be. otherwise, add the amount of room
6749 * that an indent is supposed to be.
6751 if (theline[0] == '}')
6754 * they may want closing braces to line up with something
6755 * other than the open brace. indulge them, if so.
6757 amount += ind_close_extra;
6759 else
6762 * If we're looking at an "else", try to find an "if"
6763 * to match it with.
6764 * If we're looking at a "while", try to find a "do"
6765 * to match it with.
6767 lookfor = LOOKFOR_INITIAL;
6768 if (cin_iselse(theline))
6769 lookfor = LOOKFOR_IF;
6770 else if (cin_iswhileofdo(theline, cur_curpos.lnum, ind_maxparen))
6771 /* XXX */
6772 lookfor = LOOKFOR_DO;
6773 if (lookfor != LOOKFOR_INITIAL)
6775 curwin->w_cursor.lnum = cur_curpos.lnum;
6776 if (find_match(lookfor, ourscope, ind_maxparen,
6777 ind_maxcomment) == OK)
6779 amount = get_indent(); /* XXX */
6780 goto theend;
6785 * We get here if we are not on an "while-of-do" or "else" (or
6786 * failed to find a matching "if").
6787 * Search backwards for something to line up with.
6788 * First set amount for when we don't find anything.
6792 * if the '{' is _really_ at the left margin, use the imaginary
6793 * location of a left-margin brace. Otherwise, correct the
6794 * location for ind_open_extra.
6797 if (start_brace == BRACE_IN_COL0) /* '{' is in column 0 */
6799 amount = ind_open_left_imag;
6801 else
6803 if (start_brace == BRACE_AT_END) /* '{' is at end of line */
6804 amount += ind_open_imag;
6805 else
6807 /* Compensate for adding ind_open_extra later. */
6808 amount -= ind_open_extra;
6809 if (amount < 0)
6810 amount = 0;
6814 lookfor_break = FALSE;
6816 if (cin_iscase(theline)) /* it's a switch() label */
6818 lookfor = LOOKFOR_CASE; /* find a previous switch() label */
6819 amount += ind_case;
6821 else if (cin_isscopedecl(theline)) /* private:, ... */
6823 lookfor = LOOKFOR_SCOPEDECL; /* class decl is this block */
6824 amount += ind_scopedecl;
6826 else
6828 if (ind_case_break && cin_isbreak(theline)) /* break; ... */
6829 lookfor_break = TRUE;
6831 lookfor = LOOKFOR_INITIAL;
6832 amount += ind_level; /* ind_level from start of block */
6834 scope_amount = amount;
6835 whilelevel = 0;
6838 * Search backwards. If we find something we recognize, line up
6839 * with that.
6841 * if we're looking at an open brace, indent
6842 * the usual amount relative to the conditional
6843 * that opens the block.
6845 curwin->w_cursor = cur_curpos;
6846 for (;;)
6848 curwin->w_cursor.lnum--;
6849 curwin->w_cursor.col = 0;
6852 * If we went all the way back to the start of our scope, line
6853 * up with it.
6855 if (curwin->w_cursor.lnum <= ourscope)
6857 /* we reached end of scope:
6858 * if looking for a enum or structure initialization
6859 * go further back:
6860 * if it is an initializer (enum xxx or xxx =), then
6861 * don't add ind_continuation, otherwise it is a variable
6862 * declaration:
6863 * int x,
6864 * here; <-- add ind_continuation
6866 if (lookfor == LOOKFOR_ENUM_OR_INIT)
6868 if (curwin->w_cursor.lnum == 0
6869 || curwin->w_cursor.lnum
6870 < ourscope - ind_maxparen)
6872 /* nothing found (abuse ind_maxparen as limit)
6873 * assume terminated line (i.e. a variable
6874 * initialization) */
6875 if (cont_amount > 0)
6876 amount = cont_amount;
6877 else
6878 amount += ind_continuation;
6879 break;
6882 l = ml_get_curline();
6885 * If we're in a comment now, skip to the start of the
6886 * comment.
6888 trypos = find_start_comment(ind_maxcomment);
6889 if (trypos != NULL)
6891 curwin->w_cursor.lnum = trypos->lnum + 1;
6892 continue;
6896 * Skip preprocessor directives and blank lines.
6898 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
6899 continue;
6901 if (cin_nocode(l))
6902 continue;
6904 terminated = cin_isterminated(l, FALSE, TRUE);
6907 * If we are at top level and the line looks like a
6908 * function declaration, we are done
6909 * (it's a variable declaration).
6911 if (start_brace != BRACE_IN_COL0
6912 || !cin_isfuncdecl(&l, curwin->w_cursor.lnum))
6914 /* if the line is terminated with another ','
6915 * it is a continued variable initialization.
6916 * don't add extra indent.
6917 * TODO: does not work, if a function
6918 * declaration is split over multiple lines:
6919 * cin_isfuncdecl returns FALSE then.
6921 if (terminated == ',')
6922 break;
6924 /* if it es a enum declaration or an assignment,
6925 * we are done.
6927 if (terminated != ';' && cin_isinit())
6928 break;
6930 /* nothing useful found */
6931 if (terminated == 0 || terminated == '{')
6932 continue;
6935 if (terminated != ';')
6937 /* Skip parens and braces. Position the cursor
6938 * over the rightmost paren, so that matching it
6939 * will take us back to the start of the line.
6940 */ /* XXX */
6941 trypos = NULL;
6942 if (find_last_paren(l, '(', ')'))
6943 trypos = find_match_paren(ind_maxparen,
6944 ind_maxcomment);
6946 if (trypos == NULL && find_last_paren(l, '{', '}'))
6947 trypos = find_start_brace(ind_maxcomment);
6949 if (trypos != NULL)
6951 curwin->w_cursor.lnum = trypos->lnum + 1;
6952 continue;
6956 /* it's a variable declaration, add indentation
6957 * like in
6958 * int a,
6959 * b;
6961 if (cont_amount > 0)
6962 amount = cont_amount;
6963 else
6964 amount += ind_continuation;
6966 else if (lookfor == LOOKFOR_UNTERM)
6968 if (cont_amount > 0)
6969 amount = cont_amount;
6970 else
6971 amount += ind_continuation;
6973 else if (lookfor != LOOKFOR_TERM
6974 && lookfor != LOOKFOR_CPP_BASECLASS)
6976 amount = scope_amount;
6977 if (theline[0] == '{')
6978 amount += ind_open_extra;
6980 break;
6984 * If we're in a comment now, skip to the start of the comment.
6985 */ /* XXX */
6986 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6988 curwin->w_cursor.lnum = trypos->lnum + 1;
6989 continue;
6992 l = ml_get_curline();
6995 * If this is a switch() label, may line up relative to that.
6996 * If this is a C++ scope declaration, do the same.
6998 iscase = cin_iscase(l);
6999 if (iscase || cin_isscopedecl(l))
7001 /* we are only looking for cpp base class
7002 * declaration/initialization any longer */
7003 if (lookfor == LOOKFOR_CPP_BASECLASS)
7004 break;
7006 /* When looking for a "do" we are not interested in
7007 * labels. */
7008 if (whilelevel > 0)
7009 continue;
7012 * case xx:
7013 * c = 99 + <- this indent plus continuation
7014 *-> here;
7016 if (lookfor == LOOKFOR_UNTERM
7017 || lookfor == LOOKFOR_ENUM_OR_INIT)
7019 if (cont_amount > 0)
7020 amount = cont_amount;
7021 else
7022 amount += ind_continuation;
7023 break;
7027 * case xx: <- line up with this case
7028 * x = 333;
7029 * case yy:
7031 if ( (iscase && lookfor == LOOKFOR_CASE)
7032 || (iscase && lookfor_break)
7033 || (!iscase && lookfor == LOOKFOR_SCOPEDECL))
7036 * Check that this case label is not for another
7037 * switch()
7038 */ /* XXX */
7039 if ((trypos = find_start_brace(ind_maxcomment)) ==
7040 NULL || trypos->lnum == ourscope)
7042 amount = get_indent(); /* XXX */
7043 break;
7045 continue;
7048 n = get_indent_nolabel(curwin->w_cursor.lnum); /* XXX */
7051 * case xx: if (cond) <- line up with this if
7052 * y = y + 1;
7053 * -> s = 99;
7055 * case xx:
7056 * if (cond) <- line up with this line
7057 * y = y + 1;
7058 * -> s = 99;
7060 if (lookfor == LOOKFOR_TERM)
7062 if (n)
7063 amount = n;
7065 if (!lookfor_break)
7066 break;
7070 * case xx: x = x + 1; <- line up with this x
7071 * -> y = y + 1;
7073 * case xx: if (cond) <- line up with this if
7074 * -> y = y + 1;
7076 if (n)
7078 amount = n;
7079 l = after_label(ml_get_curline());
7080 if (l != NULL && cin_is_cinword(l))
7082 if (theline[0] == '{')
7083 amount += ind_open_extra;
7084 else
7085 amount += ind_level + ind_no_brace;
7087 break;
7091 * Try to get the indent of a statement before the switch
7092 * label. If nothing is found, line up relative to the
7093 * switch label.
7094 * break; <- may line up with this line
7095 * case xx:
7096 * -> y = 1;
7098 scope_amount = get_indent() + (iscase /* XXX */
7099 ? ind_case_code : ind_scopedecl_code);
7100 lookfor = ind_case_break ? LOOKFOR_NOBREAK : LOOKFOR_ANY;
7101 continue;
7105 * Looking for a switch() label or C++ scope declaration,
7106 * ignore other lines, skip {}-blocks.
7108 if (lookfor == LOOKFOR_CASE || lookfor == LOOKFOR_SCOPEDECL)
7110 if (find_last_paren(l, '{', '}') && (trypos =
7111 find_start_brace(ind_maxcomment)) != NULL)
7112 curwin->w_cursor.lnum = trypos->lnum + 1;
7113 continue;
7117 * Ignore jump labels with nothing after them.
7119 if (cin_islabel(ind_maxcomment))
7121 l = after_label(ml_get_curline());
7122 if (l == NULL || cin_nocode(l))
7123 continue;
7127 * Ignore #defines, #if, etc.
7128 * Ignore comment and empty lines.
7129 * (need to get the line again, cin_islabel() may have
7130 * unlocked it)
7132 l = ml_get_curline();
7133 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum)
7134 || cin_nocode(l))
7135 continue;
7138 * Are we at the start of a cpp base class declaration or
7139 * constructor initialization?
7140 */ /* XXX */
7141 n = FALSE;
7142 if (lookfor != LOOKFOR_TERM && ind_cpp_baseclass > 0)
7144 n = cin_is_cpp_baseclass(&col);
7145 l = ml_get_curline();
7147 if (n)
7149 if (lookfor == LOOKFOR_UNTERM)
7151 if (cont_amount > 0)
7152 amount = cont_amount;
7153 else
7154 amount += ind_continuation;
7156 else if (theline[0] == '{')
7158 /* Need to find start of the declaration. */
7159 lookfor = LOOKFOR_UNTERM;
7160 ind_continuation = 0;
7161 continue;
7163 else
7164 /* XXX */
7165 amount = get_baseclass_amount(col, ind_maxparen,
7166 ind_maxcomment, ind_cpp_baseclass);
7167 break;
7169 else if (lookfor == LOOKFOR_CPP_BASECLASS)
7171 /* only look, whether there is a cpp base class
7172 * declaration or initialization before the opening brace.
7174 if (cin_isterminated(l, TRUE, FALSE))
7175 break;
7176 else
7177 continue;
7181 * What happens next depends on the line being terminated.
7182 * If terminated with a ',' only consider it terminating if
7183 * there is another unterminated statement behind, eg:
7184 * 123,
7185 * sizeof
7186 * here
7187 * Otherwise check whether it is a enumeration or structure
7188 * initialisation (not indented) or a variable declaration
7189 * (indented).
7191 terminated = cin_isterminated(l, FALSE, TRUE);
7193 if (terminated == 0 || (lookfor != LOOKFOR_UNTERM
7194 && terminated == ','))
7197 * if we're in the middle of a paren thing,
7198 * go back to the line that starts it so
7199 * we can get the right prevailing indent
7200 * if ( foo &&
7201 * bar )
7204 * position the cursor over the rightmost paren, so that
7205 * matching it will take us back to the start of the line.
7207 (void)find_last_paren(l, '(', ')');
7208 trypos = find_match_paren(
7209 corr_ind_maxparen(ind_maxparen, &cur_curpos),
7210 ind_maxcomment);
7213 * If we are looking for ',', we also look for matching
7214 * braces.
7216 if (trypos == NULL && terminated == ','
7217 && find_last_paren(l, '{', '}'))
7218 trypos = find_start_brace(ind_maxcomment);
7220 if (trypos != NULL)
7223 * Check if we are on a case label now. This is
7224 * handled above.
7225 * case xx: if ( asdf &&
7226 * asdf)
7228 curwin->w_cursor.lnum = trypos->lnum;
7229 l = ml_get_curline();
7230 if (cin_iscase(l) || cin_isscopedecl(l))
7232 ++curwin->w_cursor.lnum;
7233 continue;
7238 * Skip over continuation lines to find the one to get the
7239 * indent from
7240 * char *usethis = "bla\
7241 * bla",
7242 * here;
7244 if (terminated == ',')
7246 while (curwin->w_cursor.lnum > 1)
7248 l = ml_get(curwin->w_cursor.lnum - 1);
7249 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7250 break;
7251 --curwin->w_cursor.lnum;
7256 * Get indent and pointer to text for current line,
7257 * ignoring any jump label. XXX
7259 cur_amount = skip_label(curwin->w_cursor.lnum,
7260 &l, ind_maxcomment);
7263 * If this is just above the line we are indenting, and it
7264 * starts with a '{', line it up with this line.
7265 * while (not)
7266 * -> {
7269 if (terminated != ',' && lookfor != LOOKFOR_TERM
7270 && theline[0] == '{')
7272 amount = cur_amount;
7274 * Only add ind_open_extra when the current line
7275 * doesn't start with a '{', which must have a match
7276 * in the same line (scope is the same). Probably:
7277 * { 1, 2 },
7278 * -> { 3, 4 }
7280 if (*skipwhite(l) != '{')
7281 amount += ind_open_extra;
7283 if (ind_cpp_baseclass)
7285 /* have to look back, whether it is a cpp base
7286 * class declaration or initialization */
7287 lookfor = LOOKFOR_CPP_BASECLASS;
7288 continue;
7290 break;
7294 * Check if we are after an "if", "while", etc.
7295 * Also allow " } else".
7297 if (cin_is_cinword(l) || cin_iselse(skipwhite(l)))
7300 * Found an unterminated line after an if (), line up
7301 * with the last one.
7302 * if (cond)
7303 * 100 +
7304 * -> here;
7306 if (lookfor == LOOKFOR_UNTERM
7307 || lookfor == LOOKFOR_ENUM_OR_INIT)
7309 if (cont_amount > 0)
7310 amount = cont_amount;
7311 else
7312 amount += ind_continuation;
7313 break;
7317 * If this is just above the line we are indenting, we
7318 * are finished.
7319 * while (not)
7320 * -> here;
7321 * Otherwise this indent can be used when the line
7322 * before this is terminated.
7323 * yyy;
7324 * if (stat)
7325 * while (not)
7326 * xxx;
7327 * -> here;
7329 amount = cur_amount;
7330 if (theline[0] == '{')
7331 amount += ind_open_extra;
7332 if (lookfor != LOOKFOR_TERM)
7334 amount += ind_level + ind_no_brace;
7335 break;
7339 * Special trick: when expecting the while () after a
7340 * do, line up with the while()
7341 * do
7342 * x = 1;
7343 * -> here
7345 l = skipwhite(ml_get_curline());
7346 if (cin_isdo(l))
7348 if (whilelevel == 0)
7349 break;
7350 --whilelevel;
7354 * When searching for a terminated line, don't use the
7355 * one between the "if" and the "else".
7356 * Need to use the scope of this "else". XXX
7357 * If whilelevel != 0 continue looking for a "do {".
7359 if (cin_iselse(l)
7360 && whilelevel == 0
7361 && ((trypos = find_start_brace(ind_maxcomment))
7362 == NULL
7363 || find_match(LOOKFOR_IF, trypos->lnum,
7364 ind_maxparen, ind_maxcomment) == FAIL))
7365 break;
7369 * If we're below an unterminated line that is not an
7370 * "if" or something, we may line up with this line or
7371 * add something for a continuation line, depending on
7372 * the line before this one.
7374 else
7377 * Found two unterminated lines on a row, line up with
7378 * the last one.
7379 * c = 99 +
7380 * 100 +
7381 * -> here;
7383 if (lookfor == LOOKFOR_UNTERM)
7385 /* When line ends in a comma add extra indent */
7386 if (terminated == ',')
7387 amount += ind_continuation;
7388 break;
7391 if (lookfor == LOOKFOR_ENUM_OR_INIT)
7393 /* Found two lines ending in ',', lineup with the
7394 * lowest one, but check for cpp base class
7395 * declaration/initialization, if it is an
7396 * opening brace or we are looking just for
7397 * enumerations/initializations. */
7398 if (terminated == ',')
7400 if (ind_cpp_baseclass == 0)
7401 break;
7403 lookfor = LOOKFOR_CPP_BASECLASS;
7404 continue;
7407 /* Ignore unterminated lines in between, but
7408 * reduce indent. */
7409 if (amount > cur_amount)
7410 amount = cur_amount;
7412 else
7415 * Found first unterminated line on a row, may
7416 * line up with this line, remember its indent
7417 * 100 +
7418 * -> here;
7420 amount = cur_amount;
7423 * If previous line ends in ',', check whether we
7424 * are in an initialization or enum
7425 * struct xxx =
7427 * sizeof a,
7428 * 124 };
7429 * or a normal possible continuation line.
7430 * but only, of no other statement has been found
7431 * yet.
7433 if (lookfor == LOOKFOR_INITIAL && terminated == ',')
7435 lookfor = LOOKFOR_ENUM_OR_INIT;
7436 cont_amount = cin_first_id_amount();
7438 else
7440 if (lookfor == LOOKFOR_INITIAL
7441 && *l != NUL
7442 && l[STRLEN(l) - 1] == '\\')
7443 /* XXX */
7444 cont_amount = cin_get_equal_amount(
7445 curwin->w_cursor.lnum);
7446 if (lookfor != LOOKFOR_TERM)
7447 lookfor = LOOKFOR_UNTERM;
7454 * Check if we are after a while (cond);
7455 * If so: Ignore until the matching "do".
7457 /* XXX */
7458 else if (cin_iswhileofdo_end(terminated, ind_maxparen,
7459 ind_maxcomment))
7462 * Found an unterminated line after a while ();, line up
7463 * with the last one.
7464 * while (cond);
7465 * 100 + <- line up with this one
7466 * -> here;
7468 if (lookfor == LOOKFOR_UNTERM
7469 || lookfor == LOOKFOR_ENUM_OR_INIT)
7471 if (cont_amount > 0)
7472 amount = cont_amount;
7473 else
7474 amount += ind_continuation;
7475 break;
7478 if (whilelevel == 0)
7480 lookfor = LOOKFOR_TERM;
7481 amount = get_indent(); /* XXX */
7482 if (theline[0] == '{')
7483 amount += ind_open_extra;
7485 ++whilelevel;
7489 * We are after a "normal" statement.
7490 * If we had another statement we can stop now and use the
7491 * indent of that other statement.
7492 * Otherwise the indent of the current statement may be used,
7493 * search backwards for the next "normal" statement.
7495 else
7498 * Skip single break line, if before a switch label. It
7499 * may be lined up with the case label.
7501 if (lookfor == LOOKFOR_NOBREAK
7502 && cin_isbreak(skipwhite(ml_get_curline())))
7504 lookfor = LOOKFOR_ANY;
7505 continue;
7509 * Handle "do {" line.
7511 if (whilelevel > 0)
7513 l = cin_skipcomment(ml_get_curline());
7514 if (cin_isdo(l))
7516 amount = get_indent(); /* XXX */
7517 --whilelevel;
7518 continue;
7523 * Found a terminated line above an unterminated line. Add
7524 * the amount for a continuation line.
7525 * x = 1;
7526 * y = foo +
7527 * -> here;
7528 * or
7529 * int x = 1;
7530 * int foo,
7531 * -> here;
7533 if (lookfor == LOOKFOR_UNTERM
7534 || lookfor == LOOKFOR_ENUM_OR_INIT)
7536 if (cont_amount > 0)
7537 amount = cont_amount;
7538 else
7539 amount += ind_continuation;
7540 break;
7544 * Found a terminated line above a terminated line or "if"
7545 * etc. line. Use the amount of the line below us.
7546 * x = 1; x = 1;
7547 * if (asdf) y = 2;
7548 * while (asdf) ->here;
7549 * here;
7550 * ->foo;
7552 if (lookfor == LOOKFOR_TERM)
7554 if (!lookfor_break && whilelevel == 0)
7555 break;
7559 * First line above the one we're indenting is terminated.
7560 * To know what needs to be done look further backward for
7561 * a terminated line.
7563 else
7566 * position the cursor over the rightmost paren, so
7567 * that matching it will take us back to the start of
7568 * the line. Helps for:
7569 * func(asdr,
7570 * asdfasdf);
7571 * here;
7573 term_again:
7574 l = ml_get_curline();
7575 if (find_last_paren(l, '(', ')')
7576 && (trypos = find_match_paren(ind_maxparen,
7577 ind_maxcomment)) != NULL)
7580 * Check if we are on a case label now. This is
7581 * handled above.
7582 * case xx: if ( asdf &&
7583 * asdf)
7585 curwin->w_cursor.lnum = trypos->lnum;
7586 l = ml_get_curline();
7587 if (cin_iscase(l) || cin_isscopedecl(l))
7589 ++curwin->w_cursor.lnum;
7590 continue;
7594 /* When aligning with the case statement, don't align
7595 * with a statement after it.
7596 * case 1: { <-- don't use this { position
7597 * stat;
7599 * case 2:
7600 * stat;
7603 iscase = (ind_keep_case_label && cin_iscase(l));
7606 * Get indent and pointer to text for current line,
7607 * ignoring any jump label.
7609 amount = skip_label(curwin->w_cursor.lnum,
7610 &l, ind_maxcomment);
7612 if (theline[0] == '{')
7613 amount += ind_open_extra;
7614 /* See remark above: "Only add ind_open_extra.." */
7615 l = skipwhite(l);
7616 if (*l == '{')
7617 amount -= ind_open_extra;
7618 lookfor = iscase ? LOOKFOR_ANY : LOOKFOR_TERM;
7621 * When a terminated line starts with "else" skip to
7622 * the matching "if":
7623 * else 3;
7624 * indent this;
7625 * Need to use the scope of this "else". XXX
7626 * If whilelevel != 0 continue looking for a "do {".
7628 if (lookfor == LOOKFOR_TERM
7629 && *l != '}'
7630 && cin_iselse(l)
7631 && whilelevel == 0)
7633 if ((trypos = find_start_brace(ind_maxcomment))
7634 == NULL
7635 || find_match(LOOKFOR_IF, trypos->lnum,
7636 ind_maxparen, ind_maxcomment) == FAIL)
7637 break;
7638 continue;
7642 * If we're at the end of a block, skip to the start of
7643 * that block.
7645 curwin->w_cursor.col = 0;
7646 if (*cin_skipcomment(l) == '}'
7647 && (trypos = find_start_brace(ind_maxcomment))
7648 != NULL) /* XXX */
7650 curwin->w_cursor.lnum = trypos->lnum;
7651 /* if not "else {" check for terminated again */
7652 /* but skip block for "} else {" */
7653 l = cin_skipcomment(ml_get_curline());
7654 if (*l == '}' || !cin_iselse(l))
7655 goto term_again;
7656 ++curwin->w_cursor.lnum;
7664 /* add extra indent for a comment */
7665 if (cin_iscomment(theline))
7666 amount += ind_comment;
7670 * ok -- we're not inside any sort of structure at all!
7672 * this means we're at the top level, and everything should
7673 * basically just match where the previous line is, except
7674 * for the lines immediately following a function declaration,
7675 * which are K&R-style parameters and need to be indented.
7677 else
7680 * if our line starts with an open brace, forget about any
7681 * prevailing indent and make sure it looks like the start
7682 * of a function
7685 if (theline[0] == '{')
7687 amount = ind_first_open;
7691 * If the NEXT line is a function declaration, the current
7692 * line needs to be indented as a function type spec.
7693 * Don't do this if the current line looks like a comment
7694 * or if the current line is terminated, ie. ends in ';'.
7696 else if (cur_curpos.lnum < curbuf->b_ml.ml_line_count
7697 && !cin_nocode(theline)
7698 && !cin_ends_in(theline, (char_u *)":", NULL)
7699 && !cin_ends_in(theline, (char_u *)",", NULL)
7700 && cin_isfuncdecl(NULL, cur_curpos.lnum + 1)
7701 && !cin_isterminated(theline, FALSE, TRUE))
7703 amount = ind_func_type;
7705 else
7707 amount = 0;
7708 curwin->w_cursor = cur_curpos;
7710 /* search backwards until we find something we recognize */
7712 while (curwin->w_cursor.lnum > 1)
7714 curwin->w_cursor.lnum--;
7715 curwin->w_cursor.col = 0;
7717 l = ml_get_curline();
7720 * If we're in a comment now, skip to the start of the comment.
7721 */ /* XXX */
7722 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7724 curwin->w_cursor.lnum = trypos->lnum + 1;
7725 continue;
7729 * Are we at the start of a cpp base class declaration or
7730 * constructor initialization?
7731 */ /* XXX */
7732 n = FALSE;
7733 if (ind_cpp_baseclass != 0 && theline[0] != '{')
7735 n = cin_is_cpp_baseclass(&col);
7736 l = ml_get_curline();
7738 if (n)
7740 /* XXX */
7741 amount = get_baseclass_amount(col, ind_maxparen,
7742 ind_maxcomment, ind_cpp_baseclass);
7743 break;
7747 * Skip preprocessor directives and blank lines.
7749 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
7750 continue;
7752 if (cin_nocode(l))
7753 continue;
7756 * If the previous line ends in ',', use one level of
7757 * indentation:
7758 * int foo,
7759 * bar;
7760 * do this before checking for '}' in case of eg.
7761 * enum foobar
7763 * ...
7764 * } foo,
7765 * bar;
7767 n = 0;
7768 if (cin_ends_in(l, (char_u *)",", NULL)
7769 || (*l != NUL && (n = l[STRLEN(l) - 1]) == '\\'))
7771 /* take us back to opening paren */
7772 if (find_last_paren(l, '(', ')')
7773 && (trypos = find_match_paren(ind_maxparen,
7774 ind_maxcomment)) != NULL)
7775 curwin->w_cursor.lnum = trypos->lnum;
7777 /* For a line ending in ',' that is a continuation line go
7778 * back to the first line with a backslash:
7779 * char *foo = "bla\
7780 * bla",
7781 * here;
7783 while (n == 0 && curwin->w_cursor.lnum > 1)
7785 l = ml_get(curwin->w_cursor.lnum - 1);
7786 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7787 break;
7788 --curwin->w_cursor.lnum;
7791 amount = get_indent(); /* XXX */
7793 if (amount == 0)
7794 amount = cin_first_id_amount();
7795 if (amount == 0)
7796 amount = ind_continuation;
7797 break;
7801 * If the line looks like a function declaration, and we're
7802 * not in a comment, put it the left margin.
7804 if (cin_isfuncdecl(NULL, cur_curpos.lnum)) /* XXX */
7805 break;
7806 l = ml_get_curline();
7809 * Finding the closing '}' of a previous function. Put
7810 * current line at the left margin. For when 'cino' has "fs".
7812 if (*skipwhite(l) == '}')
7813 break;
7815 /* (matching {)
7816 * If the previous line ends on '};' (maybe followed by
7817 * comments) align at column 0. For example:
7818 * char *string_array[] = { "foo",
7819 * / * x * / "b};ar" }; / * foobar * /
7821 if (cin_ends_in(l, (char_u *)"};", NULL))
7822 break;
7825 * If the PREVIOUS line is a function declaration, the current
7826 * line (and the ones that follow) needs to be indented as
7827 * parameters.
7829 if (cin_isfuncdecl(&l, curwin->w_cursor.lnum))
7831 amount = ind_param;
7832 break;
7836 * If the previous line ends in ';' and the line before the
7837 * previous line ends in ',' or '\', ident to column zero:
7838 * int foo,
7839 * bar;
7840 * indent_to_0 here;
7842 if (cin_ends_in(l, (char_u *)";", NULL))
7844 l = ml_get(curwin->w_cursor.lnum - 1);
7845 if (cin_ends_in(l, (char_u *)",", NULL)
7846 || (*l != NUL && l[STRLEN(l) - 1] == '\\'))
7847 break;
7848 l = ml_get_curline();
7852 * Doesn't look like anything interesting -- so just
7853 * use the indent of this line.
7855 * Position the cursor over the rightmost paren, so that
7856 * matching it will take us back to the start of the line.
7858 find_last_paren(l, '(', ')');
7860 if ((trypos = find_match_paren(ind_maxparen,
7861 ind_maxcomment)) != NULL)
7862 curwin->w_cursor.lnum = trypos->lnum;
7863 amount = get_indent(); /* XXX */
7864 break;
7867 /* add extra indent for a comment */
7868 if (cin_iscomment(theline))
7869 amount += ind_comment;
7871 /* add extra indent if the previous line ended in a backslash:
7872 * "asdfasdf\
7873 * here";
7874 * char *foo = "asdf\
7875 * here";
7877 if (cur_curpos.lnum > 1)
7879 l = ml_get(cur_curpos.lnum - 1);
7880 if (*l != NUL && l[STRLEN(l) - 1] == '\\')
7882 cur_amount = cin_get_equal_amount(cur_curpos.lnum - 1);
7883 if (cur_amount > 0)
7884 amount = cur_amount;
7885 else if (cur_amount == 0)
7886 amount += ind_continuation;
7892 theend:
7893 /* put the cursor back where it belongs */
7894 curwin->w_cursor = cur_curpos;
7896 vim_free(linecopy);
7898 if (amount < 0)
7899 return 0;
7900 return amount;
7903 static int
7904 find_match(lookfor, ourscope, ind_maxparen, ind_maxcomment)
7905 int lookfor;
7906 linenr_T ourscope;
7907 int ind_maxparen;
7908 int ind_maxcomment;
7910 char_u *look;
7911 pos_T *theirscope;
7912 char_u *mightbeif;
7913 int elselevel;
7914 int whilelevel;
7916 if (lookfor == LOOKFOR_IF)
7918 elselevel = 1;
7919 whilelevel = 0;
7921 else
7923 elselevel = 0;
7924 whilelevel = 1;
7927 curwin->w_cursor.col = 0;
7929 while (curwin->w_cursor.lnum > ourscope + 1)
7931 curwin->w_cursor.lnum--;
7932 curwin->w_cursor.col = 0;
7934 look = cin_skipcomment(ml_get_curline());
7935 if (cin_iselse(look)
7936 || cin_isif(look)
7937 || cin_isdo(look) /* XXX */
7938 || cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7941 * if we've gone outside the braces entirely,
7942 * we must be out of scope...
7944 theirscope = find_start_brace(ind_maxcomment); /* XXX */
7945 if (theirscope == NULL)
7946 break;
7949 * and if the brace enclosing this is further
7950 * back than the one enclosing the else, we're
7951 * out of luck too.
7953 if (theirscope->lnum < ourscope)
7954 break;
7957 * and if they're enclosed in a *deeper* brace,
7958 * then we can ignore it because it's in a
7959 * different scope...
7961 if (theirscope->lnum > ourscope)
7962 continue;
7965 * if it was an "else" (that's not an "else if")
7966 * then we need to go back to another if, so
7967 * increment elselevel
7969 look = cin_skipcomment(ml_get_curline());
7970 if (cin_iselse(look))
7972 mightbeif = cin_skipcomment(look + 4);
7973 if (!cin_isif(mightbeif))
7974 ++elselevel;
7975 continue;
7979 * if it was a "while" then we need to go back to
7980 * another "do", so increment whilelevel. XXX
7982 if (cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7984 ++whilelevel;
7985 continue;
7988 /* If it's an "if" decrement elselevel */
7989 look = cin_skipcomment(ml_get_curline());
7990 if (cin_isif(look))
7992 elselevel--;
7994 * When looking for an "if" ignore "while"s that
7995 * get in the way.
7997 if (elselevel == 0 && lookfor == LOOKFOR_IF)
7998 whilelevel = 0;
8001 /* If it's a "do" decrement whilelevel */
8002 if (cin_isdo(look))
8003 whilelevel--;
8006 * if we've used up all the elses, then
8007 * this must be the if that we want!
8008 * match the indent level of that if.
8010 if (elselevel <= 0 && whilelevel <= 0)
8012 return OK;
8016 return FAIL;
8019 # if defined(FEAT_EVAL) || defined(PROTO)
8021 * Get indent level from 'indentexpr'.
8024 get_expr_indent()
8026 int indent;
8027 pos_T pos;
8028 int save_State;
8029 int use_sandbox = was_set_insecurely((char_u *)"indentexpr",
8030 OPT_LOCAL);
8032 pos = curwin->w_cursor;
8033 set_vim_var_nr(VV_LNUM, curwin->w_cursor.lnum);
8034 if (use_sandbox)
8035 ++sandbox;
8036 ++textlock;
8037 indent = eval_to_number(curbuf->b_p_inde);
8038 if (use_sandbox)
8039 --sandbox;
8040 --textlock;
8042 /* Restore the cursor position so that 'indentexpr' doesn't need to.
8043 * Pretend to be in Insert mode, allow cursor past end of line for "o"
8044 * command. */
8045 save_State = State;
8046 State = INSERT;
8047 curwin->w_cursor = pos;
8048 check_cursor();
8049 State = save_State;
8051 /* If there is an error, just keep the current indent. */
8052 if (indent < 0)
8053 indent = get_indent();
8055 return indent;
8057 # endif
8059 #endif /* FEAT_CINDENT */
8061 #if defined(FEAT_LISP) || defined(PROTO)
8063 static int lisp_match __ARGS((char_u *p));
8065 static int
8066 lisp_match(p)
8067 char_u *p;
8069 char_u buf[LSIZE];
8070 int len;
8071 char_u *word = p_lispwords;
8073 while (*word != NUL)
8075 (void)copy_option_part(&word, buf, LSIZE, ",");
8076 len = (int)STRLEN(buf);
8077 if (STRNCMP(buf, p, len) == 0 && p[len] == ' ')
8078 return TRUE;
8080 return FALSE;
8084 * When 'p' is present in 'cpoptions, a Vi compatible method is used.
8085 * The incompatible newer method is quite a bit better at indenting
8086 * code in lisp-like languages than the traditional one; it's still
8087 * mostly heuristics however -- Dirk van Deun, dirk@rave.org
8089 * TODO:
8090 * Findmatch() should be adapted for lisp, also to make showmatch
8091 * work correctly: now (v5.3) it seems all C/C++ oriented:
8092 * - it does not recognize the #\( and #\) notations as character literals
8093 * - it doesn't know about comments starting with a semicolon
8094 * - it incorrectly interprets '(' as a character literal
8095 * All this messes up get_lisp_indent in some rare cases.
8096 * Update from Sergey Khorev:
8097 * I tried to fix the first two issues.
8100 get_lisp_indent()
8102 pos_T *pos, realpos, paren;
8103 int amount;
8104 char_u *that;
8105 colnr_T col;
8106 colnr_T firsttry;
8107 int parencount, quotecount;
8108 int vi_lisp;
8110 /* Set vi_lisp to use the vi-compatible method */
8111 vi_lisp = (vim_strchr(p_cpo, CPO_LISP) != NULL);
8113 realpos = curwin->w_cursor;
8114 curwin->w_cursor.col = 0;
8116 if ((pos = findmatch(NULL, '(')) == NULL)
8117 pos = findmatch(NULL, '[');
8118 else
8120 paren = *pos;
8121 pos = findmatch(NULL, '[');
8122 if (pos == NULL || ltp(pos, &paren))
8123 pos = &paren;
8125 if (pos != NULL)
8127 /* Extra trick: Take the indent of the first previous non-white
8128 * line that is at the same () level. */
8129 amount = -1;
8130 parencount = 0;
8132 while (--curwin->w_cursor.lnum >= pos->lnum)
8134 if (linewhite(curwin->w_cursor.lnum))
8135 continue;
8136 for (that = ml_get_curline(); *that != NUL; ++that)
8138 if (*that == ';')
8140 while (*(that + 1) != NUL)
8141 ++that;
8142 continue;
8144 if (*that == '\\')
8146 if (*(that + 1) != NUL)
8147 ++that;
8148 continue;
8150 if (*that == '"' && *(that + 1) != NUL)
8152 while (*++that && *that != '"')
8154 /* skipping escaped characters in the string */
8155 if (*that == '\\')
8157 if (*++that == NUL)
8158 break;
8159 if (that[1] == NUL)
8161 ++that;
8162 break;
8167 if (*that == '(' || *that == '[')
8168 ++parencount;
8169 else if (*that == ')' || *that == ']')
8170 --parencount;
8172 if (parencount == 0)
8174 amount = get_indent();
8175 break;
8179 if (amount == -1)
8181 curwin->w_cursor.lnum = pos->lnum;
8182 curwin->w_cursor.col = pos->col;
8183 col = pos->col;
8185 that = ml_get_curline();
8187 if (vi_lisp && get_indent() == 0)
8188 amount = 2;
8189 else
8191 amount = 0;
8192 while (*that && col)
8194 amount += lbr_chartabsize_adv(&that, (colnr_T)amount);
8195 col--;
8199 * Some keywords require "body" indenting rules (the
8200 * non-standard-lisp ones are Scheme special forms):
8202 * (let ((a 1)) instead (let ((a 1))
8203 * (...)) of (...))
8206 if (!vi_lisp && (*that == '(' || *that == '[')
8207 && lisp_match(that + 1))
8208 amount += 2;
8209 else
8211 that++;
8212 amount++;
8213 firsttry = amount;
8215 while (vim_iswhite(*that))
8217 amount += lbr_chartabsize(that, (colnr_T)amount);
8218 ++that;
8221 if (*that && *that != ';') /* not a comment line */
8223 /* test *that != '(' to accomodate first let/do
8224 * argument if it is more than one line */
8225 if (!vi_lisp && *that != '(' && *that != '[')
8226 firsttry++;
8228 parencount = 0;
8229 quotecount = 0;
8231 if (vi_lisp
8232 || (*that != '"'
8233 && *that != '\''
8234 && *that != '#'
8235 && (*that < '0' || *that > '9')))
8237 while (*that
8238 && (!vim_iswhite(*that)
8239 || quotecount
8240 || parencount)
8241 && (!((*that == '(' || *that == '[')
8242 && !quotecount
8243 && !parencount
8244 && vi_lisp)))
8246 if (*that == '"')
8247 quotecount = !quotecount;
8248 if ((*that == '(' || *that == '[')
8249 && !quotecount)
8250 ++parencount;
8251 if ((*that == ')' || *that == ']')
8252 && !quotecount)
8253 --parencount;
8254 if (*that == '\\' && *(that+1) != NUL)
8255 amount += lbr_chartabsize_adv(&that,
8256 (colnr_T)amount);
8257 amount += lbr_chartabsize_adv(&that,
8258 (colnr_T)amount);
8261 while (vim_iswhite(*that))
8263 amount += lbr_chartabsize(that, (colnr_T)amount);
8264 that++;
8266 if (!*that || *that == ';')
8267 amount = firsttry;
8273 else
8274 amount = 0; /* no matching '(' or '[' found, use zero indent */
8276 curwin->w_cursor = realpos;
8278 return amount;
8280 #endif /* FEAT_LISP */
8282 void
8283 prepare_to_exit()
8285 #if defined(SIGHUP) && defined(SIG_IGN)
8286 /* Ignore SIGHUP, because a dropped connection causes a read error, which
8287 * makes Vim exit and then handling SIGHUP causes various reentrance
8288 * problems. */
8289 signal(SIGHUP, SIG_IGN);
8290 #endif
8292 #ifdef FEAT_GUI
8293 if (gui.in_use)
8295 gui.dying = TRUE;
8296 out_trash(); /* trash any pending output */
8298 else
8299 #endif
8301 windgoto((int)Rows - 1, 0);
8304 * Switch terminal mode back now, so messages end up on the "normal"
8305 * screen (if there are two screens).
8307 settmode(TMODE_COOK);
8308 #ifdef WIN3264
8309 if (can_end_termcap_mode(FALSE) == TRUE)
8310 #endif
8311 stoptermcap();
8312 out_flush();
8317 * Preserve files and exit.
8318 * When called IObuff must contain a message.
8320 void
8321 preserve_exit()
8323 buf_T *buf;
8325 prepare_to_exit();
8327 /* Setting this will prevent free() calls. That avoids calling free()
8328 * recursively when free() was invoked with a bad pointer. */
8329 really_exiting = TRUE;
8331 out_str(IObuff);
8332 screen_start(); /* don't know where cursor is now */
8333 out_flush();
8335 ml_close_notmod(); /* close all not-modified buffers */
8337 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8339 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
8341 OUT_STR(_("Vim: preserving files...\n"));
8342 screen_start(); /* don't know where cursor is now */
8343 out_flush();
8344 ml_sync_all(FALSE, FALSE); /* preserve all swap files */
8345 break;
8349 ml_close_all(FALSE); /* close all memfiles, without deleting */
8351 OUT_STR(_("Vim: Finished.\n"));
8353 getout(1);
8357 * return TRUE if "fname" exists.
8360 vim_fexists(fname)
8361 char_u *fname;
8363 struct stat st;
8365 if (mch_stat((char *)fname, &st))
8366 return FALSE;
8367 return TRUE;
8371 * Check for CTRL-C pressed, but only once in a while.
8372 * Should be used instead of ui_breakcheck() for functions that check for
8373 * each line in the file. Calling ui_breakcheck() each time takes too much
8374 * time, because it can be a system call.
8377 #ifndef BREAKCHECK_SKIP
8378 # ifdef FEAT_GUI /* assume the GUI only runs on fast computers */
8379 # define BREAKCHECK_SKIP 200
8380 # else
8381 # define BREAKCHECK_SKIP 32
8382 # endif
8383 #endif
8385 static int breakcheck_count = 0;
8387 void
8388 line_breakcheck()
8390 if (++breakcheck_count >= BREAKCHECK_SKIP)
8392 breakcheck_count = 0;
8393 ui_breakcheck();
8398 * Like line_breakcheck() but check 10 times less often.
8400 void
8401 fast_breakcheck()
8403 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
8405 breakcheck_count = 0;
8406 ui_breakcheck();
8411 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
8412 * 'wildignore'.
8413 * Returns OK or FAIL.
8416 expand_wildcards(num_pat, pat, num_file, file, flags)
8417 int num_pat; /* number of input patterns */
8418 char_u **pat; /* array of input patterns */
8419 int *num_file; /* resulting number of files */
8420 char_u ***file; /* array of resulting files */
8421 int flags; /* EW_DIR, etc. */
8423 int retval;
8424 int i, j;
8425 char_u *p;
8426 int non_suf_match; /* number without matching suffix */
8428 retval = gen_expand_wildcards(num_pat, pat, num_file, file, flags);
8430 /* When keeping all matches, return here */
8431 if (flags & EW_KEEPALL)
8432 return retval;
8434 #ifdef FEAT_WILDIGN
8436 * Remove names that match 'wildignore'.
8438 if (*p_wig)
8440 char_u *ffname;
8442 /* check all files in (*file)[] */
8443 for (i = 0; i < *num_file; ++i)
8445 ffname = FullName_save((*file)[i], FALSE);
8446 if (ffname == NULL) /* out of memory */
8447 break;
8448 # ifdef VMS
8449 vms_remove_version(ffname);
8450 # endif
8451 if (match_file_list(p_wig, (*file)[i], ffname))
8453 /* remove this matching file from the list */
8454 vim_free((*file)[i]);
8455 for (j = i; j + 1 < *num_file; ++j)
8456 (*file)[j] = (*file)[j + 1];
8457 --*num_file;
8458 --i;
8460 vim_free(ffname);
8463 #endif
8466 * Move the names where 'suffixes' match to the end.
8468 if (*num_file > 1)
8470 non_suf_match = 0;
8471 for (i = 0; i < *num_file; ++i)
8473 if (!match_suffix((*file)[i]))
8476 * Move the name without matching suffix to the front
8477 * of the list.
8479 p = (*file)[i];
8480 for (j = i; j > non_suf_match; --j)
8481 (*file)[j] = (*file)[j - 1];
8482 (*file)[non_suf_match++] = p;
8487 return retval;
8491 * Return TRUE if "fname" matches with an entry in 'suffixes'.
8494 match_suffix(fname)
8495 char_u *fname;
8497 int fnamelen, setsuflen;
8498 char_u *setsuf;
8499 #define MAXSUFLEN 30 /* maximum length of a file suffix */
8500 char_u suf_buf[MAXSUFLEN];
8502 fnamelen = (int)STRLEN(fname);
8503 setsuflen = 0;
8504 for (setsuf = p_su; *setsuf; )
8506 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
8507 if (fnamelen >= setsuflen
8508 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
8509 (size_t)setsuflen) == 0)
8510 break;
8511 setsuflen = 0;
8513 return (setsuflen != 0);
8516 #if !defined(NO_EXPANDPATH) || defined(PROTO)
8518 # ifdef VIM_BACKTICK
8519 static int vim_backtick __ARGS((char_u *p));
8520 static int expand_backtick __ARGS((garray_T *gap, char_u *pat, int flags));
8521 # endif
8523 # if defined(MSDOS) || defined(FEAT_GUI_W16) || defined(WIN3264)
8525 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
8526 * it's shared between these systems.
8528 # if defined(DJGPP) || defined(PROTO)
8529 # define _cdecl /* DJGPP doesn't have this */
8530 # else
8531 # ifdef __BORLANDC__
8532 # define _cdecl _RTLENTRYF
8533 # endif
8534 # endif
8537 * comparison function for qsort in dos_expandpath()
8539 static int _cdecl
8540 pstrcmp(const void *a, const void *b)
8542 return (pathcmp(*(char **)a, *(char **)b, -1));
8545 # ifndef WIN3264
8546 static void
8547 namelowcpy(
8548 char_u *d,
8549 char_u *s)
8551 # ifdef DJGPP
8552 if (USE_LONG_FNAME) /* don't lower case on Windows 95/NT systems */
8553 while (*s)
8554 *d++ = *s++;
8555 else
8556 # endif
8557 while (*s)
8558 *d++ = TOLOWER_LOC(*s++);
8559 *d = NUL;
8561 # endif
8564 * Recursively expand one path component into all matching files and/or
8565 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8566 * Return the number of matches found.
8567 * "path" has backslashes before chars that are not to be expanded, starting
8568 * at "path[wildoff]".
8569 * Return the number of matches found.
8570 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
8572 static int
8573 dos_expandpath(
8574 garray_T *gap,
8575 char_u *path,
8576 int wildoff,
8577 int flags, /* EW_* flags */
8578 int didstar) /* expanded "**" once already */
8580 char_u *buf;
8581 char_u *path_end;
8582 char_u *p, *s, *e;
8583 int start_len = gap->ga_len;
8584 char_u *pat;
8585 regmatch_T regmatch;
8586 int starts_with_dot;
8587 int matches;
8588 int len;
8589 int starstar = FALSE;
8590 static int stardepth = 0; /* depth for "**" expansion */
8591 #ifdef WIN3264
8592 WIN32_FIND_DATA fb;
8593 HANDLE hFind = (HANDLE)0;
8594 # ifdef FEAT_MBYTE
8595 WIN32_FIND_DATAW wfb;
8596 WCHAR *wn = NULL; /* UCS-2 name, NULL when not used. */
8597 # endif
8598 #else
8599 struct ffblk fb;
8600 #endif
8601 char_u *matchname;
8602 int ok;
8604 /* Expanding "**" may take a long time, check for CTRL-C. */
8605 if (stardepth > 0)
8607 ui_breakcheck();
8608 if (got_int)
8609 return 0;
8612 /* make room for file name */
8613 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8614 if (buf == NULL)
8615 return 0;
8618 * Find the first part in the path name that contains a wildcard or a ~1.
8619 * Copy it into buf, including the preceding characters.
8621 p = buf;
8622 s = buf;
8623 e = NULL;
8624 path_end = path;
8625 while (*path_end != NUL)
8627 /* May ignore a wildcard that has a backslash before it; it will
8628 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8629 if (path_end >= path + wildoff && rem_backslash(path_end))
8630 *p++ = *path_end++;
8631 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
8633 if (e != NULL)
8634 break;
8635 s = p + 1;
8637 else if (path_end >= path + wildoff
8638 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
8639 e = p;
8640 #ifdef FEAT_MBYTE
8641 if (has_mbyte)
8643 len = (*mb_ptr2len)(path_end);
8644 STRNCPY(p, path_end, len);
8645 p += len;
8646 path_end += len;
8648 else
8649 #endif
8650 *p++ = *path_end++;
8652 e = p;
8653 *e = NUL;
8655 /* now we have one wildcard component between s and e */
8656 /* Remove backslashes between "wildoff" and the start of the wildcard
8657 * component. */
8658 for (p = buf + wildoff; p < s; ++p)
8659 if (rem_backslash(p))
8661 mch_memmove(p, p + 1, STRLEN(p));
8662 --e;
8663 --s;
8666 /* Check for "**" between "s" and "e". */
8667 for (p = s; p < e; ++p)
8668 if (p[0] == '*' && p[1] == '*')
8669 starstar = TRUE;
8671 starts_with_dot = (*s == '.');
8672 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8673 if (pat == NULL)
8675 vim_free(buf);
8676 return 0;
8679 /* compile the regexp into a program */
8680 regmatch.rm_ic = TRUE; /* Always ignore case */
8681 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8682 vim_free(pat);
8684 if (regmatch.regprog == NULL)
8686 vim_free(buf);
8687 return 0;
8690 /* remember the pattern or file name being looked for */
8691 matchname = vim_strsave(s);
8693 /* If "**" is by itself, this is the first time we encounter it and more
8694 * is following then find matches without any directory. */
8695 if (!didstar && stardepth < 100 && starstar && e - s == 2
8696 && *path_end == '/')
8698 STRCPY(s, path_end + 1);
8699 ++stardepth;
8700 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8701 --stardepth;
8704 /* Scan all files in the directory with "dir/ *.*" */
8705 STRCPY(s, "*.*");
8706 #ifdef WIN3264
8707 # ifdef FEAT_MBYTE
8708 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
8710 /* The active codepage differs from 'encoding'. Attempt using the
8711 * wide function. If it fails because it is not implemented fall back
8712 * to the non-wide version (for Windows 98) */
8713 wn = enc_to_ucs2(buf, NULL);
8714 if (wn != NULL)
8716 hFind = FindFirstFileW(wn, &wfb);
8717 if (hFind == INVALID_HANDLE_VALUE
8718 && GetLastError() == ERROR_CALL_NOT_IMPLEMENTED)
8720 vim_free(wn);
8721 wn = NULL;
8726 if (wn == NULL)
8727 # endif
8728 hFind = FindFirstFile(buf, &fb);
8729 ok = (hFind != INVALID_HANDLE_VALUE);
8730 #else
8731 /* If we are expanding wildcards we try both files and directories */
8732 ok = (findfirst((char *)buf, &fb,
8733 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8734 #endif
8736 while (ok)
8738 #ifdef WIN3264
8739 # ifdef FEAT_MBYTE
8740 if (wn != NULL)
8741 p = ucs2_to_enc(wfb.cFileName, NULL); /* p is allocated here */
8742 else
8743 # endif
8744 p = (char_u *)fb.cFileName;
8745 #else
8746 p = (char_u *)fb.ff_name;
8747 #endif
8748 /* Ignore entries starting with a dot, unless when asked for. Accept
8749 * all entries found with "matchname". */
8750 if ((p[0] != '.' || starts_with_dot)
8751 && (matchname == NULL
8752 || vim_regexec(&regmatch, p, (colnr_T)0)))
8754 #ifdef WIN3264
8755 STRCPY(s, p);
8756 #else
8757 namelowcpy(s, p);
8758 #endif
8759 len = (int)STRLEN(buf);
8761 if (starstar && stardepth < 100)
8763 /* For "**" in the pattern first go deeper in the tree to
8764 * find matches. */
8765 STRCPY(buf + len, "/**");
8766 STRCPY(buf + len + 3, path_end);
8767 ++stardepth;
8768 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
8769 --stardepth;
8772 STRCPY(buf + len, path_end);
8773 if (mch_has_exp_wildcard(path_end))
8775 /* need to expand another component of the path */
8776 /* remove backslashes for the remaining components only */
8777 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
8779 else
8781 /* no more wildcards, check if there is a match */
8782 /* remove backslashes for the remaining components only */
8783 if (*path_end != 0)
8784 backslash_halve(buf + len + 1);
8785 if (mch_getperm(buf) >= 0) /* add existing file */
8786 addfile(gap, buf, flags);
8790 #ifdef WIN3264
8791 # ifdef FEAT_MBYTE
8792 if (wn != NULL)
8794 vim_free(p);
8795 ok = FindNextFileW(hFind, &wfb);
8797 else
8798 # endif
8799 ok = FindNextFile(hFind, &fb);
8800 #else
8801 ok = (findnext(&fb) == 0);
8802 #endif
8804 /* If no more matches and no match was used, try expanding the name
8805 * itself. Finds the long name of a short filename. */
8806 if (!ok && matchname != NULL && gap->ga_len == start_len)
8808 STRCPY(s, matchname);
8809 #ifdef WIN3264
8810 FindClose(hFind);
8811 # ifdef FEAT_MBYTE
8812 if (wn != NULL)
8814 vim_free(wn);
8815 wn = enc_to_ucs2(buf, NULL);
8816 if (wn != NULL)
8817 hFind = FindFirstFileW(wn, &wfb);
8819 if (wn == NULL)
8820 # endif
8821 hFind = FindFirstFile(buf, &fb);
8822 ok = (hFind != INVALID_HANDLE_VALUE);
8823 #else
8824 ok = (findfirst((char *)buf, &fb,
8825 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8826 #endif
8827 vim_free(matchname);
8828 matchname = NULL;
8832 #ifdef WIN3264
8833 FindClose(hFind);
8834 # ifdef FEAT_MBYTE
8835 vim_free(wn);
8836 # endif
8837 #endif
8838 vim_free(buf);
8839 vim_free(regmatch.regprog);
8840 vim_free(matchname);
8842 matches = gap->ga_len - start_len;
8843 if (matches > 0)
8844 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
8845 sizeof(char_u *), pstrcmp);
8846 return matches;
8850 mch_expandpath(
8851 garray_T *gap,
8852 char_u *path,
8853 int flags) /* EW_* flags */
8855 return dos_expandpath(gap, path, 0, flags, FALSE);
8857 # endif /* MSDOS || FEAT_GUI_W16 || WIN3264 */
8859 #if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
8860 || defined(PROTO)
8862 * Unix style wildcard expansion code.
8863 * It's here because it's used both for Unix and Mac.
8865 static int pstrcmp __ARGS((const void *, const void *));
8867 static int
8868 pstrcmp(a, b)
8869 const void *a, *b;
8871 return (pathcmp(*(char **)a, *(char **)b, -1));
8875 * Recursively expand one path component into all matching files and/or
8876 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8877 * "path" has backslashes before chars that are not to be expanded, starting
8878 * at "path + wildoff".
8879 * Return the number of matches found.
8880 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
8883 unix_expandpath(gap, path, wildoff, flags, didstar)
8884 garray_T *gap;
8885 char_u *path;
8886 int wildoff;
8887 int flags; /* EW_* flags */
8888 int didstar; /* expanded "**" once already */
8890 char_u *buf;
8891 char_u *path_end;
8892 char_u *p, *s, *e;
8893 int start_len = gap->ga_len;
8894 char_u *pat;
8895 regmatch_T regmatch;
8896 int starts_with_dot;
8897 int matches;
8898 int len;
8899 int starstar = FALSE;
8900 static int stardepth = 0; /* depth for "**" expansion */
8902 DIR *dirp;
8903 struct dirent *dp;
8905 /* Expanding "**" may take a long time, check for CTRL-C. */
8906 if (stardepth > 0)
8908 ui_breakcheck();
8909 if (got_int)
8910 return 0;
8913 /* make room for file name */
8914 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8915 if (buf == NULL)
8916 return 0;
8919 * Find the first part in the path name that contains a wildcard.
8920 * Copy it into "buf", including the preceding characters.
8922 p = buf;
8923 s = buf;
8924 e = NULL;
8925 path_end = path;
8926 while (*path_end != NUL)
8928 /* May ignore a wildcard that has a backslash before it; it will
8929 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8930 if (path_end >= path + wildoff && rem_backslash(path_end))
8931 *p++ = *path_end++;
8932 else if (*path_end == '/')
8934 if (e != NULL)
8935 break;
8936 s = p + 1;
8938 else if (path_end >= path + wildoff
8939 && vim_strchr((char_u *)"*?[{~$", *path_end) != NULL)
8940 e = p;
8941 #ifdef FEAT_MBYTE
8942 if (has_mbyte)
8944 len = (*mb_ptr2len)(path_end);
8945 STRNCPY(p, path_end, len);
8946 p += len;
8947 path_end += len;
8949 else
8950 #endif
8951 *p++ = *path_end++;
8953 e = p;
8954 *e = NUL;
8956 /* now we have one wildcard component between "s" and "e" */
8957 /* Remove backslashes between "wildoff" and the start of the wildcard
8958 * component. */
8959 for (p = buf + wildoff; p < s; ++p)
8960 if (rem_backslash(p))
8962 mch_memmove(p, p + 1, STRLEN(p));
8963 --e;
8964 --s;
8967 /* Check for "**" between "s" and "e". */
8968 for (p = s; p < e; ++p)
8969 if (p[0] == '*' && p[1] == '*')
8970 starstar = TRUE;
8972 /* convert the file pattern to a regexp pattern */
8973 starts_with_dot = (*s == '.');
8974 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8975 if (pat == NULL)
8977 vim_free(buf);
8978 return 0;
8981 /* compile the regexp into a program */
8982 #ifdef CASE_INSENSITIVE_FILENAME
8983 regmatch.rm_ic = TRUE; /* Behave like Terminal.app */
8984 #else
8985 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
8986 #endif
8987 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8988 vim_free(pat);
8990 if (regmatch.regprog == NULL)
8992 vim_free(buf);
8993 return 0;
8996 /* If "**" is by itself, this is the first time we encounter it and more
8997 * is following then find matches without any directory. */
8998 if (!didstar && stardepth < 100 && starstar && e - s == 2
8999 && *path_end == '/')
9001 STRCPY(s, path_end + 1);
9002 ++stardepth;
9003 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
9004 --stardepth;
9007 /* open the directory for scanning */
9008 *s = NUL;
9009 dirp = opendir(*buf == NUL ? "." : (char *)buf);
9011 /* Find all matching entries */
9012 if (dirp != NULL)
9014 for (;;)
9016 dp = readdir(dirp);
9017 if (dp == NULL)
9018 break;
9019 if ((dp->d_name[0] != '.' || starts_with_dot)
9020 && vim_regexec(&regmatch, (char_u *)dp->d_name, (colnr_T)0))
9022 STRCPY(s, dp->d_name);
9023 len = STRLEN(buf);
9025 if (starstar && stardepth < 100)
9027 /* For "**" in the pattern first go deeper in the tree to
9028 * find matches. */
9029 STRCPY(buf + len, "/**");
9030 STRCPY(buf + len + 3, path_end);
9031 ++stardepth;
9032 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
9033 --stardepth;
9036 STRCPY(buf + len, path_end);
9037 if (mch_has_exp_wildcard(path_end)) /* handle more wildcards */
9039 /* need to expand another component of the path */
9040 /* remove backslashes for the remaining components only */
9041 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
9043 else
9045 /* no more wildcards, check if there is a match */
9046 /* remove backslashes for the remaining components only */
9047 if (*path_end != NUL)
9048 backslash_halve(buf + len + 1);
9049 if (mch_getperm(buf) >= 0) /* add existing file */
9051 #ifdef MACOS_CONVERT
9052 size_t precomp_len = STRLEN(buf)+1;
9053 char_u *precomp_buf =
9054 mac_precompose_path(buf, precomp_len, &precomp_len);
9056 if (precomp_buf)
9058 mch_memmove(buf, precomp_buf, precomp_len);
9059 vim_free(precomp_buf);
9061 #endif
9062 addfile(gap, buf, flags);
9068 closedir(dirp);
9071 vim_free(buf);
9072 vim_free(regmatch.regprog);
9074 matches = gap->ga_len - start_len;
9075 if (matches > 0)
9076 qsort(((char_u **)gap->ga_data) + start_len, matches,
9077 sizeof(char_u *), pstrcmp);
9078 return matches;
9080 #endif
9083 * Generic wildcard expansion code.
9085 * Characters in "pat" that should not be expanded must be preceded with a
9086 * backslash. E.g., "/path\ with\ spaces/my\*star*"
9088 * Return FAIL when no single file was found. In this case "num_file" is not
9089 * set, and "file" may contain an error message.
9090 * Return OK when some files found. "num_file" is set to the number of
9091 * matches, "file" to the array of matches. Call FreeWild() later.
9094 gen_expand_wildcards(num_pat, pat, num_file, file, flags)
9095 int num_pat; /* number of input patterns */
9096 char_u **pat; /* array of input patterns */
9097 int *num_file; /* resulting number of files */
9098 char_u ***file; /* array of resulting files */
9099 int flags; /* EW_* flags */
9101 int i;
9102 garray_T ga;
9103 char_u *p;
9104 static int recursive = FALSE;
9105 int add_pat;
9108 * expand_env() is called to expand things like "~user". If this fails,
9109 * it calls ExpandOne(), which brings us back here. In this case, always
9110 * call the machine specific expansion function, if possible. Otherwise,
9111 * return FAIL.
9113 if (recursive)
9114 #ifdef SPECIAL_WILDCHAR
9115 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9116 #else
9117 return FAIL;
9118 #endif
9120 #ifdef SPECIAL_WILDCHAR
9122 * If there are any special wildcard characters which we cannot handle
9123 * here, call machine specific function for all the expansion. This
9124 * avoids starting the shell for each argument separately.
9125 * For `=expr` do use the internal function.
9127 for (i = 0; i < num_pat; i++)
9129 if (vim_strpbrk(pat[i], (char_u *)SPECIAL_WILDCHAR) != NULL
9130 # ifdef VIM_BACKTICK
9131 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
9132 # endif
9134 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9136 #endif
9138 recursive = TRUE;
9141 * The matching file names are stored in a growarray. Init it empty.
9143 ga_init2(&ga, (int)sizeof(char_u *), 30);
9145 for (i = 0; i < num_pat; ++i)
9147 add_pat = -1;
9148 p = pat[i];
9150 #ifdef VIM_BACKTICK
9151 if (vim_backtick(p))
9152 add_pat = expand_backtick(&ga, p, flags);
9153 else
9154 #endif
9157 * First expand environment variables, "~/" and "~user/".
9159 if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9161 p = expand_env_save_opt(p, TRUE);
9162 if (p == NULL)
9163 p = pat[i];
9164 #ifdef UNIX
9166 * On Unix, if expand_env() can't expand an environment
9167 * variable, use the shell to do that. Discard previously
9168 * found file names and start all over again.
9170 else if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9172 vim_free(p);
9173 ga_clear(&ga);
9174 i = mch_expand_wildcards(num_pat, pat, num_file, file,
9175 flags);
9176 recursive = FALSE;
9177 return i;
9179 #endif
9183 * If there are wildcards: Expand file names and add each match to
9184 * the list. If there is no match, and EW_NOTFOUND is given, add
9185 * the pattern.
9186 * If there are no wildcards: Add the file name if it exists or
9187 * when EW_NOTFOUND is given.
9189 if (mch_has_exp_wildcard(p))
9190 add_pat = mch_expandpath(&ga, p, flags);
9193 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
9195 char_u *t = backslash_halve_save(p);
9197 #if defined(MACOS_CLASSIC)
9198 slash_to_colon(t);
9199 #endif
9200 /* When EW_NOTFOUND is used, always add files and dirs. Makes
9201 * "vim c:/" work. */
9202 if (flags & EW_NOTFOUND)
9203 addfile(&ga, t, flags | EW_DIR | EW_FILE);
9204 else if (mch_getperm(t) >= 0)
9205 addfile(&ga, t, flags);
9206 vim_free(t);
9209 if (p != pat[i])
9210 vim_free(p);
9213 *num_file = ga.ga_len;
9214 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data : (char_u **)"";
9216 recursive = FALSE;
9218 return (ga.ga_data != NULL) ? OK : FAIL;
9221 # ifdef VIM_BACKTICK
9224 * Return TRUE if we can expand this backtick thing here.
9226 static int
9227 vim_backtick(p)
9228 char_u *p;
9230 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
9234 * Expand an item in `backticks` by executing it as a command.
9235 * Currently only works when pat[] starts and ends with a `.
9236 * Returns number of file names found.
9238 static int
9239 expand_backtick(gap, pat, flags)
9240 garray_T *gap;
9241 char_u *pat;
9242 int flags; /* EW_* flags */
9244 char_u *p;
9245 char_u *cmd;
9246 char_u *buffer;
9247 int cnt = 0;
9248 int i;
9250 /* Create the command: lop off the backticks. */
9251 cmd = vim_strnsave(pat + 1, (int)STRLEN(pat) - 2);
9252 if (cmd == NULL)
9253 return 0;
9255 #ifdef FEAT_EVAL
9256 if (*cmd == '=') /* `={expr}`: Expand expression */
9257 buffer = eval_to_string(cmd + 1, &p, TRUE);
9258 else
9259 #endif
9260 buffer = get_cmd_output(cmd, NULL,
9261 (flags & EW_SILENT) ? SHELL_SILENT : 0);
9262 vim_free(cmd);
9263 if (buffer == NULL)
9264 return 0;
9266 cmd = buffer;
9267 while (*cmd != NUL)
9269 cmd = skipwhite(cmd); /* skip over white space */
9270 p = cmd;
9271 while (*p != NUL && *p != '\r' && *p != '\n') /* skip over entry */
9272 ++p;
9273 /* add an entry if it is not empty */
9274 if (p > cmd)
9276 i = *p;
9277 *p = NUL;
9278 addfile(gap, cmd, flags);
9279 *p = i;
9280 ++cnt;
9282 cmd = p;
9283 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
9284 ++cmd;
9287 vim_free(buffer);
9288 return cnt;
9290 # endif /* VIM_BACKTICK */
9293 * Add a file to a file list. Accepted flags:
9294 * EW_DIR add directories
9295 * EW_FILE add files
9296 * EW_EXEC add executable files
9297 * EW_NOTFOUND add even when it doesn't exist
9298 * EW_ADDSLASH add slash after directory name
9300 void
9301 addfile(gap, f, flags)
9302 garray_T *gap;
9303 char_u *f; /* filename */
9304 int flags;
9306 char_u *p;
9307 int isdir;
9309 /* if the file/dir doesn't exist, may not add it */
9310 if (!(flags & EW_NOTFOUND) && mch_getperm(f) < 0)
9311 return;
9313 #ifdef FNAME_ILLEGAL
9314 /* if the file/dir contains illegal characters, don't add it */
9315 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
9316 return;
9317 #endif
9319 isdir = mch_isdir(f);
9320 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
9321 return;
9323 /* If the file isn't executable, may not add it. Do accept directories. */
9324 if (!isdir && (flags & EW_EXEC) && !mch_can_exe(f))
9325 return;
9327 /* Make room for another item in the file list. */
9328 if (ga_grow(gap, 1) == FAIL)
9329 return;
9331 p = alloc((unsigned)(STRLEN(f) + 1 + isdir));
9332 if (p == NULL)
9333 return;
9335 STRCPY(p, f);
9336 #ifdef BACKSLASH_IN_FILENAME
9337 slash_adjust(p);
9338 #endif
9340 * Append a slash or backslash after directory names if none is present.
9342 #ifndef DONT_ADD_PATHSEP_TO_DIR
9343 if (isdir && (flags & EW_ADDSLASH))
9344 add_pathsep(p);
9345 #endif
9346 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
9348 #endif /* !NO_EXPANDPATH */
9350 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) || defined(PROTO)
9352 #ifndef SEEK_SET
9353 # define SEEK_SET 0
9354 #endif
9355 #ifndef SEEK_END
9356 # define SEEK_END 2
9357 #endif
9360 * Get the stdout of an external command.
9361 * Returns an allocated string, or NULL for error.
9363 char_u *
9364 get_cmd_output(cmd, infile, flags)
9365 char_u *cmd;
9366 char_u *infile; /* optional input file name */
9367 int flags; /* can be SHELL_SILENT */
9369 char_u *tempname;
9370 char_u *command;
9371 char_u *buffer = NULL;
9372 int len;
9373 int i = 0;
9374 FILE *fd;
9376 if (check_restricted() || check_secure())
9377 return NULL;
9379 /* get a name for the temp file */
9380 if ((tempname = vim_tempname('o')) == NULL)
9382 EMSG(_(e_notmp));
9383 return NULL;
9386 /* Add the redirection stuff */
9387 command = make_filter_cmd(cmd, infile, tempname);
9388 if (command == NULL)
9389 goto done;
9392 * Call the shell to execute the command (errors are ignored).
9393 * Don't check timestamps here.
9395 ++no_check_timestamps;
9396 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
9397 --no_check_timestamps;
9399 vim_free(command);
9402 * read the names from the file into memory
9404 # ifdef VMS
9405 /* created temporary file is not always readable as binary */
9406 fd = mch_fopen((char *)tempname, "r");
9407 # else
9408 fd = mch_fopen((char *)tempname, READBIN);
9409 # endif
9411 if (fd == NULL)
9413 EMSG2(_(e_notopen), tempname);
9414 goto done;
9417 fseek(fd, 0L, SEEK_END);
9418 len = ftell(fd); /* get size of temp file */
9419 fseek(fd, 0L, SEEK_SET);
9421 buffer = alloc(len + 1);
9422 if (buffer != NULL)
9423 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
9424 fclose(fd);
9425 mch_remove(tempname);
9426 if (buffer == NULL)
9427 goto done;
9428 #ifdef VMS
9429 len = i; /* VMS doesn't give us what we asked for... */
9430 #endif
9431 if (i != len)
9433 EMSG2(_(e_notread), tempname);
9434 vim_free(buffer);
9435 buffer = NULL;
9437 else
9438 buffer[len] = '\0'; /* make sure the buffer is terminated */
9440 done:
9441 vim_free(tempname);
9442 return buffer;
9444 #endif
9447 * Free the list of files returned by expand_wildcards() or other expansion
9448 * functions.
9450 void
9451 FreeWild(count, files)
9452 int count;
9453 char_u **files;
9455 if (count <= 0 || files == NULL)
9456 return;
9457 #if defined(__EMX__) && defined(__ALWAYS_HAS_TRAILING_NULL_POINTER) /* XXX */
9459 * Is this still OK for when other functions than expand_wildcards() have
9460 * been used???
9462 _fnexplodefree((char **)files);
9463 #else
9464 while (count--)
9465 vim_free(files[count]);
9466 vim_free(files);
9467 #endif
9471 * return TRUE when need to go to Insert mode because of 'insertmode'.
9472 * Don't do this when still processing a command or a mapping.
9473 * Don't do this when inside a ":normal" command.
9476 goto_im()
9478 return (p_im && stuff_empty() && typebuf_typed());