Merged from the latest developing branch.
[MacVim.git] / src / misc1.c
bloba1278f628333120535b8ee982c3cdad321e6bc44
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 = 0; /* 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 == 0)
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 != 0)
211 newline = alloc(orig_char_len + size - ind_done + line_len);
212 if (newline == NULL)
213 return FALSE;
214 p = oldline;
215 s = newline;
216 while (orig_char_len > 0)
218 *s++ = *p++;
219 orig_char_len--;
221 /* Skip over any additional white space (useful when newindent is less
222 * than old) */
223 while (vim_iswhite(*p))
224 (void)*p++;
225 todo = size-ind_done;
227 else
229 todo = size;
230 newline = alloc(ind_len + line_len);
231 if (newline == NULL)
232 return FALSE;
233 s = newline;
236 /* Put the characters in the new line. */
237 /* if 'expandtab' isn't set: use TABs */
238 if (!curbuf->b_p_et)
240 /* If 'preserveindent' is set then reuse as much as possible of
241 * the existing indent structure for the new indent */
242 if (!(flags & SIN_INSERT) && curbuf->b_p_pi)
244 p = oldline;
245 ind_done = 0;
247 while (todo > 0 && vim_iswhite(*p))
249 if (*p == TAB)
251 tab_pad = (int)curbuf->b_p_ts
252 - (ind_done % (int)curbuf->b_p_ts);
253 /* stop if this tab will overshoot the target */
254 if (todo < tab_pad)
255 break;
256 todo -= tab_pad;
257 ind_done += tab_pad;
259 else
261 --todo;
262 ++ind_done;
264 *s++ = *p++;
267 /* Fill to next tabstop with a tab, if possible */
268 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
269 if (todo >= tab_pad)
271 *s++ = TAB;
272 todo -= tab_pad;
275 p = skipwhite(p);
278 while (todo >= (int)curbuf->b_p_ts)
280 *s++ = TAB;
281 todo -= (int)curbuf->b_p_ts;
284 while (todo > 0)
286 *s++ = ' ';
287 --todo;
289 mch_memmove(s, p, (size_t)line_len);
291 /* Replace the line (unless undo fails). */
292 if (!(flags & SIN_UNDO) || u_savesub(curwin->w_cursor.lnum) == OK)
294 ml_replace(curwin->w_cursor.lnum, newline, FALSE);
295 if (flags & SIN_CHANGED)
296 changed_bytes(curwin->w_cursor.lnum, 0);
297 /* Correct saved cursor position if it's after the indent. */
298 if (saved_cursor.lnum == curwin->w_cursor.lnum
299 && saved_cursor.col >= (colnr_T)(p - oldline))
300 saved_cursor.col += ind_len - (colnr_T)(p - oldline);
301 retval = TRUE;
303 else
304 vim_free(newline);
306 curwin->w_cursor.col = ind_len;
307 return retval;
311 * Copy the indent from ptr to the current line (and fill to size)
312 * Leaves the cursor on the first non-blank in the line.
313 * Returns TRUE if the line was changed.
315 static int
316 copy_indent(size, src)
317 int size;
318 char_u *src;
320 char_u *p = NULL;
321 char_u *line = NULL;
322 char_u *s;
323 int todo;
324 int ind_len;
325 int line_len = 0;
326 int tab_pad;
327 int ind_done;
328 int round;
330 /* Round 1: compute the number of characters needed for the indent
331 * Round 2: copy the characters. */
332 for (round = 1; round <= 2; ++round)
334 todo = size;
335 ind_len = 0;
336 ind_done = 0;
337 s = src;
339 /* Count/copy the usable portion of the source line */
340 while (todo > 0 && vim_iswhite(*s))
342 if (*s == TAB)
344 tab_pad = (int)curbuf->b_p_ts
345 - (ind_done % (int)curbuf->b_p_ts);
346 /* Stop if this tab will overshoot the target */
347 if (todo < tab_pad)
348 break;
349 todo -= tab_pad;
350 ind_done += tab_pad;
352 else
354 --todo;
355 ++ind_done;
357 ++ind_len;
358 if (p != NULL)
359 *p++ = *s;
360 ++s;
363 /* Fill to next tabstop with a tab, if possible */
364 tab_pad = (int)curbuf->b_p_ts - (ind_done % (int)curbuf->b_p_ts);
365 if (todo >= tab_pad)
367 todo -= tab_pad;
368 ++ind_len;
369 if (p != NULL)
370 *p++ = TAB;
373 /* Add tabs required for indent */
374 while (todo >= (int)curbuf->b_p_ts)
376 todo -= (int)curbuf->b_p_ts;
377 ++ind_len;
378 if (p != NULL)
379 *p++ = TAB;
382 /* Count/add spaces required for indent */
383 while (todo > 0)
385 --todo;
386 ++ind_len;
387 if (p != NULL)
388 *p++ = ' ';
391 if (p == NULL)
393 /* Allocate memory for the result: the copied indent, new indent
394 * and the rest of the line. */
395 line_len = (int)STRLEN(ml_get_curline()) + 1;
396 line = alloc(ind_len + line_len);
397 if (line == NULL)
398 return FALSE;
399 p = line;
403 /* Append the original line */
404 mch_memmove(p, ml_get_curline(), (size_t)line_len);
406 /* Replace the line */
407 ml_replace(curwin->w_cursor.lnum, line, FALSE);
409 /* Put the cursor after the indent. */
410 curwin->w_cursor.col = ind_len;
411 return TRUE;
415 * Return the indent of the current line after a number. Return -1 if no
416 * number was found. Used for 'n' in 'formatoptions': numbered list.
417 * Since a pattern is used it can actually handle more than numbers.
420 get_number_indent(lnum)
421 linenr_T lnum;
423 colnr_T col;
424 pos_T pos;
425 regmmatch_T regmatch;
427 if (lnum > curbuf->b_ml.ml_line_count)
428 return -1;
429 pos.lnum = 0;
430 regmatch.regprog = vim_regcomp(curbuf->b_p_flp, RE_MAGIC);
431 if (regmatch.regprog != NULL)
433 regmatch.rmm_ic = FALSE;
434 regmatch.rmm_maxcol = 0;
435 if (vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0))
437 pos.lnum = regmatch.endpos[0].lnum + lnum;
438 pos.col = regmatch.endpos[0].col;
439 #ifdef FEAT_VIRTUALEDIT
440 pos.coladd = 0;
441 #endif
443 vim_free(regmatch.regprog);
446 if (pos.lnum == 0 || *ml_get_pos(&pos) == NUL)
447 return -1;
448 getvcol(curwin, &pos, &col, NULL, NULL);
449 return (int)col;
452 #if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
454 static int cin_is_cinword __ARGS((char_u *line));
457 * Return TRUE if the string "line" starts with a word from 'cinwords'.
459 static int
460 cin_is_cinword(line)
461 char_u *line;
463 char_u *cinw;
464 char_u *cinw_buf;
465 int cinw_len;
466 int retval = FALSE;
467 int len;
469 cinw_len = (int)STRLEN(curbuf->b_p_cinw) + 1;
470 cinw_buf = alloc((unsigned)cinw_len);
471 if (cinw_buf != NULL)
473 line = skipwhite(line);
474 for (cinw = curbuf->b_p_cinw; *cinw; )
476 len = copy_option_part(&cinw, cinw_buf, cinw_len, ",");
477 if (STRNCMP(line, cinw_buf, len) == 0
478 && (!vim_iswordc(line[len]) || !vim_iswordc(line[len - 1])))
480 retval = TRUE;
481 break;
484 vim_free(cinw_buf);
486 return retval;
488 #endif
491 * open_line: Add a new line below or above the current line.
493 * For VREPLACE mode, we only add a new line when we get to the end of the
494 * file, otherwise we just start replacing the next line.
496 * Caller must take care of undo. Since VREPLACE may affect any number of
497 * lines however, it may call u_save_cursor() again when starting to change a
498 * new line.
499 * "flags": OPENLINE_DELSPACES delete spaces after cursor
500 * OPENLINE_DO_COM format comments
501 * OPENLINE_KEEPTRAIL keep trailing spaces
502 * OPENLINE_MARKFIX adjust mark positions after the line break
504 * Return TRUE for success, FALSE for failure
507 open_line(dir, flags, old_indent)
508 int dir; /* FORWARD or BACKWARD */
509 int flags;
510 int old_indent; /* indent for after ^^D in Insert mode */
512 char_u *saved_line; /* copy of the original line */
513 char_u *next_line = NULL; /* copy of the next line */
514 char_u *p_extra = NULL; /* what goes to next line */
515 int less_cols = 0; /* less columns for mark in new line */
516 int less_cols_off = 0; /* columns to skip for mark adjust */
517 pos_T old_cursor; /* old cursor position */
518 int newcol = 0; /* new cursor column */
519 int newindent = 0; /* auto-indent of the new line */
520 int n;
521 int trunc_line = FALSE; /* truncate current line afterwards */
522 int retval = FALSE; /* return value, default is FAIL */
523 #ifdef FEAT_COMMENTS
524 int extra_len = 0; /* length of p_extra string */
525 int lead_len; /* length of comment leader */
526 char_u *lead_flags; /* position in 'comments' for comment leader */
527 char_u *leader = NULL; /* copy of comment leader */
528 #endif
529 char_u *allocated = NULL; /* allocated memory */
530 #if defined(FEAT_SMARTINDENT) || defined(FEAT_VREPLACE) || defined(FEAT_LISP) \
531 || defined(FEAT_CINDENT) || defined(FEAT_COMMENTS)
532 char_u *p;
533 #endif
534 int saved_char = NUL; /* init for GCC */
535 #if defined(FEAT_SMARTINDENT) || defined(FEAT_COMMENTS)
536 pos_T *pos;
537 #endif
538 #ifdef FEAT_SMARTINDENT
539 int do_si = (!p_paste && curbuf->b_p_si
540 # ifdef FEAT_CINDENT
541 && !curbuf->b_p_cin
542 # endif
544 int no_si = FALSE; /* reset did_si afterwards */
545 int first_char = NUL; /* init for GCC */
546 #endif
547 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
548 int vreplace_mode;
549 #endif
550 int did_append; /* appended a new line */
551 int saved_pi = curbuf->b_p_pi; /* copy of preserveindent setting */
554 * make a copy of the current line so we can mess with it
556 saved_line = vim_strsave(ml_get_curline());
557 if (saved_line == NULL) /* out of memory! */
558 return FALSE;
560 #ifdef FEAT_VREPLACE
561 if (State & VREPLACE_FLAG)
564 * With VREPLACE we make a copy of the next line, which we will be
565 * starting to replace. First make the new line empty and let vim play
566 * with the indenting and comment leader to its heart's content. Then
567 * we grab what it ended up putting on the new line, put back the
568 * original line, and call ins_char() to put each new character onto
569 * the line, replacing what was there before and pushing the right
570 * stuff onto the replace stack. -- webb.
572 if (curwin->w_cursor.lnum < orig_line_count)
573 next_line = vim_strsave(ml_get(curwin->w_cursor.lnum + 1));
574 else
575 next_line = vim_strsave((char_u *)"");
576 if (next_line == NULL) /* out of memory! */
577 goto theend;
580 * In VREPLACE mode, a NL replaces the rest of the line, and starts
581 * replacing the next line, so push all of the characters left on the
582 * line onto the replace stack. We'll push any other characters that
583 * might be replaced at the start of the next line (due to autoindent
584 * etc) a bit later.
586 replace_push(NUL); /* Call twice because BS over NL expects it */
587 replace_push(NUL);
588 p = saved_line + curwin->w_cursor.col;
589 while (*p != NUL)
590 replace_push(*p++);
591 saved_line[curwin->w_cursor.col] = NUL;
593 #endif
595 if ((State & INSERT)
596 #ifdef FEAT_VREPLACE
597 && !(State & VREPLACE_FLAG)
598 #endif
601 p_extra = saved_line + curwin->w_cursor.col;
602 #ifdef FEAT_SMARTINDENT
603 if (do_si) /* need first char after new line break */
605 p = skipwhite(p_extra);
606 first_char = *p;
608 #endif
609 #ifdef FEAT_COMMENTS
610 extra_len = (int)STRLEN(p_extra);
611 #endif
612 saved_char = *p_extra;
613 *p_extra = NUL;
616 u_clearline(); /* cannot do "U" command when adding lines */
617 #ifdef FEAT_SMARTINDENT
618 did_si = FALSE;
619 #endif
620 ai_col = 0;
623 * If we just did an auto-indent, then we didn't type anything on
624 * the prior line, and it should be truncated. Do this even if 'ai' is not
625 * set because automatically inserting a comment leader also sets did_ai.
627 if (dir == FORWARD && did_ai)
628 trunc_line = TRUE;
631 * If 'autoindent' and/or 'smartindent' is set, try to figure out what
632 * indent to use for the new line.
634 if (curbuf->b_p_ai
635 #ifdef FEAT_SMARTINDENT
636 || do_si
637 #endif
641 * count white space on current line
643 newindent = get_indent_str(saved_line, (int)curbuf->b_p_ts);
644 if (newindent == 0)
645 newindent = old_indent; /* for ^^D command in insert mode */
647 #ifdef FEAT_SMARTINDENT
649 * Do smart indenting.
650 * In insert/replace mode (only when dir == FORWARD)
651 * we may move some text to the next line. If it starts with '{'
652 * don't add an indent. Fixes inserting a NL before '{' in line
653 * "if (condition) {"
655 if (!trunc_line && do_si && *saved_line != NUL
656 && (p_extra == NULL || first_char != '{'))
658 char_u *ptr;
659 char_u last_char;
661 old_cursor = curwin->w_cursor;
662 ptr = saved_line;
663 # ifdef FEAT_COMMENTS
664 if (flags & OPENLINE_DO_COM)
665 lead_len = get_leader_len(ptr, NULL, FALSE);
666 else
667 lead_len = 0;
668 # endif
669 if (dir == FORWARD)
672 * Skip preprocessor directives, unless they are
673 * recognised as comments.
675 if (
676 # ifdef FEAT_COMMENTS
677 lead_len == 0 &&
678 # endif
679 ptr[0] == '#')
681 while (ptr[0] == '#' && curwin->w_cursor.lnum > 1)
682 ptr = ml_get(--curwin->w_cursor.lnum);
683 newindent = get_indent();
685 # ifdef FEAT_COMMENTS
686 if (flags & OPENLINE_DO_COM)
687 lead_len = get_leader_len(ptr, NULL, FALSE);
688 else
689 lead_len = 0;
690 if (lead_len > 0)
693 * This case gets the following right:
694 * \*
695 * * A comment (read '\' as '/').
696 * *\
697 * #define IN_THE_WAY
698 * This should line up here;
700 p = skipwhite(ptr);
701 if (p[0] == '/' && p[1] == '*')
702 p++;
703 if (p[0] == '*')
705 for (p++; *p; p++)
707 if (p[0] == '/' && p[-1] == '*')
710 * End of C comment, indent should line up
711 * with the line containing the start of
712 * the comment
714 curwin->w_cursor.col = (colnr_T)(p - ptr);
715 if ((pos = findmatch(NULL, NUL)) != NULL)
717 curwin->w_cursor.lnum = pos->lnum;
718 newindent = get_indent();
724 else /* Not a comment line */
725 # endif
727 /* Find last non-blank in line */
728 p = ptr + STRLEN(ptr) - 1;
729 while (p > ptr && vim_iswhite(*p))
730 --p;
731 last_char = *p;
734 * find the character just before the '{' or ';'
736 if (last_char == '{' || last_char == ';')
738 if (p > ptr)
739 --p;
740 while (p > ptr && vim_iswhite(*p))
741 --p;
744 * Try to catch lines that are split over multiple
745 * lines. eg:
746 * if (condition &&
747 * condition) {
748 * Should line up here!
751 if (*p == ')')
753 curwin->w_cursor.col = (colnr_T)(p - ptr);
754 if ((pos = findmatch(NULL, '(')) != NULL)
756 curwin->w_cursor.lnum = pos->lnum;
757 newindent = get_indent();
758 ptr = ml_get_curline();
762 * If last character is '{' do indent, without
763 * checking for "if" and the like.
765 if (last_char == '{')
767 did_si = TRUE; /* do indent */
768 no_si = TRUE; /* don't delete it when '{' typed */
771 * Look for "if" and the like, use 'cinwords'.
772 * Don't do this if the previous line ended in ';' or
773 * '}'.
775 else if (last_char != ';' && last_char != '}'
776 && cin_is_cinword(ptr))
777 did_si = TRUE;
780 else /* dir == BACKWARD */
783 * Skip preprocessor directives, unless they are
784 * recognised as comments.
786 if (
787 # ifdef FEAT_COMMENTS
788 lead_len == 0 &&
789 # endif
790 ptr[0] == '#')
792 int was_backslashed = FALSE;
794 while ((ptr[0] == '#' || was_backslashed) &&
795 curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count)
797 if (*ptr && ptr[STRLEN(ptr) - 1] == '\\')
798 was_backslashed = TRUE;
799 else
800 was_backslashed = FALSE;
801 ptr = ml_get(++curwin->w_cursor.lnum);
803 if (was_backslashed)
804 newindent = 0; /* Got to end of file */
805 else
806 newindent = get_indent();
808 p = skipwhite(ptr);
809 if (*p == '}') /* if line starts with '}': do indent */
810 did_si = TRUE;
811 else /* can delete indent when '{' typed */
812 can_si_back = TRUE;
814 curwin->w_cursor = old_cursor;
816 if (do_si)
817 can_si = TRUE;
818 #endif /* FEAT_SMARTINDENT */
820 did_ai = TRUE;
823 #ifdef FEAT_COMMENTS
825 * Find out if the current line starts with a comment leader.
826 * This may then be inserted in front of the new line.
828 end_comment_pending = NUL;
829 if (flags & OPENLINE_DO_COM)
830 lead_len = get_leader_len(saved_line, &lead_flags, dir == BACKWARD);
831 else
832 lead_len = 0;
833 if (lead_len > 0)
835 char_u *lead_repl = NULL; /* replaces comment leader */
836 int lead_repl_len = 0; /* length of *lead_repl */
837 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
838 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
839 char_u *comment_end = NULL; /* where lead_end has been found */
840 int extra_space = FALSE; /* append extra space */
841 int current_flag;
842 int require_blank = FALSE; /* requires blank after middle */
843 char_u *p2;
846 * If the comment leader has the start, middle or end flag, it may not
847 * be used or may be replaced with the middle leader.
849 for (p = lead_flags; *p && *p != ':'; ++p)
851 if (*p == COM_BLANK)
853 require_blank = TRUE;
854 continue;
856 if (*p == COM_START || *p == COM_MIDDLE)
858 current_flag = *p;
859 if (*p == COM_START)
862 * Doing "O" on a start of comment does not insert leader.
864 if (dir == BACKWARD)
866 lead_len = 0;
867 break;
870 /* find start of middle part */
871 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
872 require_blank = FALSE;
876 * Isolate the strings of the middle and end leader.
878 while (*p && p[-1] != ':') /* find end of middle flags */
880 if (*p == COM_BLANK)
881 require_blank = TRUE;
882 ++p;
884 (void)copy_option_part(&p, lead_middle, COM_MAX_LEN, ",");
886 while (*p && p[-1] != ':') /* find end of end flags */
888 /* Check whether we allow automatic ending of comments */
889 if (*p == COM_AUTO_END)
890 end_comment_pending = -1; /* means we want to set it */
891 ++p;
893 n = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
895 if (end_comment_pending == -1) /* we can set it now */
896 end_comment_pending = lead_end[n - 1];
899 * If the end of the comment is in the same line, don't use
900 * the comment leader.
902 if (dir == FORWARD)
904 for (p = saved_line + lead_len; *p; ++p)
905 if (STRNCMP(p, lead_end, n) == 0)
907 comment_end = p;
908 lead_len = 0;
909 break;
914 * Doing "o" on a start of comment inserts the middle leader.
916 if (lead_len > 0)
918 if (current_flag == COM_START)
920 lead_repl = lead_middle;
921 lead_repl_len = (int)STRLEN(lead_middle);
925 * If we have hit RETURN immediately after the start
926 * comment leader, then put a space after the middle
927 * comment leader on the next line.
929 if (!vim_iswhite(saved_line[lead_len - 1])
930 && ((p_extra != NULL
931 && (int)curwin->w_cursor.col == lead_len)
932 || (p_extra == NULL
933 && saved_line[lead_len] == NUL)
934 || require_blank))
935 extra_space = TRUE;
937 break;
939 if (*p == COM_END)
942 * Doing "o" on the end of a comment does not insert leader.
943 * Remember where the end is, might want to use it to find the
944 * start (for C-comments).
946 if (dir == FORWARD)
948 comment_end = skipwhite(saved_line);
949 lead_len = 0;
950 break;
954 * Doing "O" on the end of a comment inserts the middle leader.
955 * Find the string for the middle leader, searching backwards.
957 while (p > curbuf->b_p_com && *p != ',')
958 --p;
959 for (lead_repl = p; lead_repl > curbuf->b_p_com
960 && lead_repl[-1] != ':'; --lead_repl)
962 lead_repl_len = (int)(p - lead_repl);
964 /* We can probably always add an extra space when doing "O" on
965 * the comment-end */
966 extra_space = TRUE;
968 /* Check whether we allow automatic ending of comments */
969 for (p2 = p; *p2 && *p2 != ':'; p2++)
971 if (*p2 == COM_AUTO_END)
972 end_comment_pending = -1; /* means we want to set it */
974 if (end_comment_pending == -1)
976 /* Find last character in end-comment string */
977 while (*p2 && *p2 != ',')
978 p2++;
979 end_comment_pending = p2[-1];
981 break;
983 if (*p == COM_FIRST)
986 * Comment leader for first line only: Don't repeat leader
987 * when using "O", blank out leader when using "o".
989 if (dir == BACKWARD)
990 lead_len = 0;
991 else
993 lead_repl = (char_u *)"";
994 lead_repl_len = 0;
996 break;
999 if (lead_len)
1001 /* allocate buffer (may concatenate p_exta later) */
1002 leader = alloc(lead_len + lead_repl_len + extra_space +
1003 extra_len + 1);
1004 allocated = leader; /* remember to free it later */
1006 if (leader == NULL)
1007 lead_len = 0;
1008 else
1010 vim_strncpy(leader, saved_line, lead_len);
1013 * Replace leader with lead_repl, right or left adjusted
1015 if (lead_repl != NULL)
1017 int c = 0;
1018 int off = 0;
1020 for (p = lead_flags; *p && *p != ':'; ++p)
1022 if (*p == COM_RIGHT || *p == COM_LEFT)
1023 c = *p;
1024 else if (VIM_ISDIGIT(*p) || *p == '-')
1025 off = getdigits(&p);
1027 if (c == COM_RIGHT) /* right adjusted leader */
1029 /* find last non-white in the leader to line up with */
1030 for (p = leader + lead_len - 1; p > leader
1031 && vim_iswhite(*p); --p)
1033 ++p;
1035 #ifdef FEAT_MBYTE
1036 /* Compute the length of the replaced characters in
1037 * screen characters, not bytes. */
1039 int repl_size = vim_strnsize(lead_repl,
1040 lead_repl_len);
1041 int old_size = 0;
1042 char_u *endp = p;
1043 int l;
1045 while (old_size < repl_size && p > leader)
1047 mb_ptr_back(leader, p);
1048 old_size += ptr2cells(p);
1050 l = lead_repl_len - (int)(endp - p);
1051 if (l != 0)
1052 mch_memmove(endp + l, endp,
1053 (size_t)((leader + lead_len) - endp));
1054 lead_len += l;
1056 #else
1057 if (p < leader + lead_repl_len)
1058 p = leader;
1059 else
1060 p -= lead_repl_len;
1061 #endif
1062 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1063 if (p + lead_repl_len > leader + lead_len)
1064 p[lead_repl_len] = NUL;
1066 /* blank-out any other chars from the old leader. */
1067 while (--p >= leader)
1069 #ifdef FEAT_MBYTE
1070 int l = mb_head_off(leader, p);
1072 if (l > 1)
1074 p -= l;
1075 if (ptr2cells(p) > 1)
1077 p[1] = ' ';
1078 --l;
1080 mch_memmove(p + 1, p + l + 1,
1081 (size_t)((leader + lead_len) - (p + l + 1)));
1082 lead_len -= l;
1083 *p = ' ';
1085 else
1086 #endif
1087 if (!vim_iswhite(*p))
1088 *p = ' ';
1091 else /* left adjusted leader */
1093 p = skipwhite(leader);
1094 #ifdef FEAT_MBYTE
1095 /* Compute the length of the replaced characters in
1096 * screen characters, not bytes. Move the part that is
1097 * not to be overwritten. */
1099 int repl_size = vim_strnsize(lead_repl,
1100 lead_repl_len);
1101 int i;
1102 int l;
1104 for (i = 0; p[i] != NUL && i < lead_len; i += l)
1106 l = (*mb_ptr2len)(p + i);
1107 if (vim_strnsize(p, i + l) > repl_size)
1108 break;
1110 if (i != lead_repl_len)
1112 mch_memmove(p + lead_repl_len, p + i,
1113 (size_t)(lead_len - i - (leader - p)));
1114 lead_len += lead_repl_len - i;
1117 #endif
1118 mch_memmove(p, lead_repl, (size_t)lead_repl_len);
1120 /* Replace any remaining non-white chars in the old
1121 * leader by spaces. Keep Tabs, the indent must
1122 * remain the same. */
1123 for (p += lead_repl_len; p < leader + lead_len; ++p)
1124 if (!vim_iswhite(*p))
1126 /* Don't put a space before a TAB. */
1127 if (p + 1 < leader + lead_len && p[1] == TAB)
1129 --lead_len;
1130 mch_memmove(p, p + 1,
1131 (leader + lead_len) - p);
1133 else
1135 #ifdef FEAT_MBYTE
1136 int l = (*mb_ptr2len)(p);
1138 if (l > 1)
1140 if (ptr2cells(p) > 1)
1142 /* Replace a double-wide char with
1143 * two spaces */
1144 --l;
1145 *p++ = ' ';
1147 mch_memmove(p + 1, p + l,
1148 (leader + lead_len) - p);
1149 lead_len -= l - 1;
1151 #endif
1152 *p = ' ';
1155 *p = NUL;
1158 /* Recompute the indent, it may have changed. */
1159 if (curbuf->b_p_ai
1160 #ifdef FEAT_SMARTINDENT
1161 || do_si
1162 #endif
1164 newindent = get_indent_str(leader, (int)curbuf->b_p_ts);
1166 /* Add the indent offset */
1167 if (newindent + off < 0)
1169 off = -newindent;
1170 newindent = 0;
1172 else
1173 newindent += off;
1175 /* Correct trailing spaces for the shift, so that
1176 * alignment remains equal. */
1177 while (off > 0 && lead_len > 0
1178 && leader[lead_len - 1] == ' ')
1180 /* Don't do it when there is a tab before the space */
1181 if (vim_strchr(skipwhite(leader), '\t') != NULL)
1182 break;
1183 --lead_len;
1184 --off;
1187 /* If the leader ends in white space, don't add an
1188 * extra space */
1189 if (lead_len > 0 && vim_iswhite(leader[lead_len - 1]))
1190 extra_space = FALSE;
1191 leader[lead_len] = NUL;
1194 if (extra_space)
1196 leader[lead_len++] = ' ';
1197 leader[lead_len] = NUL;
1200 newcol = lead_len;
1203 * if a new indent will be set below, remove the indent that
1204 * is in the comment leader
1206 if (newindent
1207 #ifdef FEAT_SMARTINDENT
1208 || did_si
1209 #endif
1212 while (lead_len && vim_iswhite(*leader))
1214 --lead_len;
1215 --newcol;
1216 ++leader;
1221 #ifdef FEAT_SMARTINDENT
1222 did_si = can_si = FALSE;
1223 #endif
1225 else if (comment_end != NULL)
1228 * We have finished a comment, so we don't use the leader.
1229 * If this was a C-comment and 'ai' or 'si' is set do a normal
1230 * indent to align with the line containing the start of the
1231 * comment.
1233 if (comment_end[0] == '*' && comment_end[1] == '/' &&
1234 (curbuf->b_p_ai
1235 #ifdef FEAT_SMARTINDENT
1236 || do_si
1237 #endif
1240 old_cursor = curwin->w_cursor;
1241 curwin->w_cursor.col = (colnr_T)(comment_end - saved_line);
1242 if ((pos = findmatch(NULL, NUL)) != NULL)
1244 curwin->w_cursor.lnum = pos->lnum;
1245 newindent = get_indent();
1247 curwin->w_cursor = old_cursor;
1251 #endif
1253 /* (State == INSERT || State == REPLACE), only when dir == FORWARD */
1254 if (p_extra != NULL)
1256 *p_extra = saved_char; /* restore char that NUL replaced */
1259 * When 'ai' set or "flags" has OPENLINE_DELSPACES, skip to the first
1260 * non-blank.
1262 * When in REPLACE mode, put the deleted blanks on the replace stack,
1263 * preceded by a NUL, so they can be put back when a BS is entered.
1265 if (REPLACE_NORMAL(State))
1266 replace_push(NUL); /* end of extra blanks */
1267 if (curbuf->b_p_ai || (flags & OPENLINE_DELSPACES))
1269 while ((*p_extra == ' ' || *p_extra == '\t')
1270 #ifdef FEAT_MBYTE
1271 && (!enc_utf8
1272 || !utf_iscomposing(utf_ptr2char(p_extra + 1)))
1273 #endif
1276 if (REPLACE_NORMAL(State))
1277 replace_push(*p_extra);
1278 ++p_extra;
1279 ++less_cols_off;
1282 if (*p_extra != NUL)
1283 did_ai = FALSE; /* append some text, don't truncate now */
1285 /* columns for marks adjusted for removed columns */
1286 less_cols = (int)(p_extra - saved_line);
1289 if (p_extra == NULL)
1290 p_extra = (char_u *)""; /* append empty line */
1292 #ifdef FEAT_COMMENTS
1293 /* concatenate leader and p_extra, if there is a leader */
1294 if (lead_len)
1296 STRCAT(leader, p_extra);
1297 p_extra = leader;
1298 did_ai = TRUE; /* So truncating blanks works with comments */
1299 less_cols -= lead_len;
1301 else
1302 end_comment_pending = NUL; /* turns out there was no leader */
1303 #endif
1305 old_cursor = curwin->w_cursor;
1306 if (dir == BACKWARD)
1307 --curwin->w_cursor.lnum;
1308 #ifdef FEAT_VREPLACE
1309 if (!(State & VREPLACE_FLAG) || old_cursor.lnum >= orig_line_count)
1310 #endif
1312 if (ml_append(curwin->w_cursor.lnum, p_extra, (colnr_T)0, FALSE)
1313 == FAIL)
1314 goto theend;
1315 /* Postpone calling changed_lines(), because it would mess up folding
1316 * with markers. */
1317 mark_adjust(curwin->w_cursor.lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
1318 did_append = TRUE;
1320 #ifdef FEAT_VREPLACE
1321 else
1324 * In VREPLACE mode we are starting to replace the next line.
1326 curwin->w_cursor.lnum++;
1327 if (curwin->w_cursor.lnum >= Insstart.lnum + vr_lines_changed)
1329 /* In case we NL to a new line, BS to the previous one, and NL
1330 * again, we don't want to save the new line for undo twice.
1332 (void)u_save_cursor(); /* errors are ignored! */
1333 vr_lines_changed++;
1335 ml_replace(curwin->w_cursor.lnum, p_extra, TRUE);
1336 changed_bytes(curwin->w_cursor.lnum, 0);
1337 curwin->w_cursor.lnum--;
1338 did_append = FALSE;
1340 #endif
1342 if (newindent
1343 #ifdef FEAT_SMARTINDENT
1344 || did_si
1345 #endif
1348 ++curwin->w_cursor.lnum;
1349 #ifdef FEAT_SMARTINDENT
1350 if (did_si)
1352 if (p_sr)
1353 newindent -= newindent % (int)curbuf->b_p_sw;
1354 newindent += (int)curbuf->b_p_sw;
1356 #endif
1357 /* Copy the indent */
1358 if (curbuf->b_p_ci)
1360 (void)copy_indent(newindent, saved_line);
1363 * Set the 'preserveindent' option so that any further screwing
1364 * with the line doesn't entirely destroy our efforts to preserve
1365 * it. It gets restored at the function end.
1367 curbuf->b_p_pi = TRUE;
1369 else
1370 (void)set_indent(newindent, SIN_INSERT);
1371 less_cols -= curwin->w_cursor.col;
1373 ai_col = curwin->w_cursor.col;
1376 * In REPLACE mode, for each character in the new indent, there must
1377 * be a NUL on the replace stack, for when it is deleted with BS
1379 if (REPLACE_NORMAL(State))
1380 for (n = 0; n < (int)curwin->w_cursor.col; ++n)
1381 replace_push(NUL);
1382 newcol += curwin->w_cursor.col;
1383 #ifdef FEAT_SMARTINDENT
1384 if (no_si)
1385 did_si = FALSE;
1386 #endif
1389 #ifdef FEAT_COMMENTS
1391 * In REPLACE mode, for each character in the extra leader, there must be
1392 * a NUL on the replace stack, for when it is deleted with BS.
1394 if (REPLACE_NORMAL(State))
1395 while (lead_len-- > 0)
1396 replace_push(NUL);
1397 #endif
1399 curwin->w_cursor = old_cursor;
1401 if (dir == FORWARD)
1403 if (trunc_line || (State & INSERT))
1405 /* truncate current line at cursor */
1406 saved_line[curwin->w_cursor.col] = NUL;
1407 /* Remove trailing white space, unless OPENLINE_KEEPTRAIL used. */
1408 if (trunc_line && !(flags & OPENLINE_KEEPTRAIL))
1409 truncate_spaces(saved_line);
1410 ml_replace(curwin->w_cursor.lnum, saved_line, FALSE);
1411 saved_line = NULL;
1412 if (did_append)
1414 changed_lines(curwin->w_cursor.lnum, curwin->w_cursor.col,
1415 curwin->w_cursor.lnum + 1, 1L);
1416 did_append = FALSE;
1418 /* Move marks after the line break to the new line. */
1419 if (flags & OPENLINE_MARKFIX)
1420 mark_col_adjust(curwin->w_cursor.lnum,
1421 curwin->w_cursor.col + less_cols_off,
1422 1L, (long)-less_cols);
1424 else
1425 changed_bytes(curwin->w_cursor.lnum, curwin->w_cursor.col);
1429 * Put the cursor on the new line. Careful: the scrollup() above may
1430 * have moved w_cursor, we must use old_cursor.
1432 curwin->w_cursor.lnum = old_cursor.lnum + 1;
1434 if (did_append)
1435 changed_lines(curwin->w_cursor.lnum, 0, curwin->w_cursor.lnum, 1L);
1437 curwin->w_cursor.col = newcol;
1438 #ifdef FEAT_VIRTUALEDIT
1439 curwin->w_cursor.coladd = 0;
1440 #endif
1442 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1444 * In VREPLACE mode, we are handling the replace stack ourselves, so stop
1445 * fixthisline() from doing it (via change_indent()) by telling it we're in
1446 * normal INSERT mode.
1448 if (State & VREPLACE_FLAG)
1450 vreplace_mode = State; /* So we know to put things right later */
1451 State = INSERT;
1453 else
1454 vreplace_mode = 0;
1455 #endif
1456 #ifdef FEAT_LISP
1458 * May do lisp indenting.
1460 if (!p_paste
1461 # ifdef FEAT_COMMENTS
1462 && leader == NULL
1463 # endif
1464 && curbuf->b_p_lisp
1465 && curbuf->b_p_ai)
1467 fixthisline(get_lisp_indent);
1468 p = ml_get_curline();
1469 ai_col = (colnr_T)(skipwhite(p) - p);
1471 #endif
1472 #ifdef FEAT_CINDENT
1474 * May do indenting after opening a new line.
1476 if (!p_paste
1477 && (curbuf->b_p_cin
1478 # ifdef FEAT_EVAL
1479 || *curbuf->b_p_inde != NUL
1480 # endif
1482 && in_cinkeys(dir == FORWARD
1483 ? KEY_OPEN_FORW
1484 : KEY_OPEN_BACK, ' ', linewhite(curwin->w_cursor.lnum)))
1486 do_c_expr_indent();
1487 p = ml_get_curline();
1488 ai_col = (colnr_T)(skipwhite(p) - p);
1490 #endif
1491 #if defined(FEAT_VREPLACE) && (defined(FEAT_LISP) || defined(FEAT_CINDENT))
1492 if (vreplace_mode != 0)
1493 State = vreplace_mode;
1494 #endif
1496 #ifdef FEAT_VREPLACE
1498 * Finally, VREPLACE gets the stuff on the new line, then puts back the
1499 * original line, and inserts the new stuff char by char, pushing old stuff
1500 * onto the replace stack (via ins_char()).
1502 if (State & VREPLACE_FLAG)
1504 /* Put new line in p_extra */
1505 p_extra = vim_strsave(ml_get_curline());
1506 if (p_extra == NULL)
1507 goto theend;
1509 /* Put back original line */
1510 ml_replace(curwin->w_cursor.lnum, next_line, FALSE);
1512 /* Insert new stuff into line again */
1513 curwin->w_cursor.col = 0;
1514 #ifdef FEAT_VIRTUALEDIT
1515 curwin->w_cursor.coladd = 0;
1516 #endif
1517 ins_bytes(p_extra); /* will call changed_bytes() */
1518 vim_free(p_extra);
1519 next_line = NULL;
1521 #endif
1523 retval = TRUE; /* success! */
1524 theend:
1525 curbuf->b_p_pi = saved_pi;
1526 vim_free(saved_line);
1527 vim_free(next_line);
1528 vim_free(allocated);
1529 return retval;
1532 #if defined(FEAT_COMMENTS) || defined(PROTO)
1534 * get_leader_len() returns the length of the prefix of the given string
1535 * which introduces a comment. If this string is not a comment then 0 is
1536 * returned.
1537 * When "flags" is not NULL, it is set to point to the flags of the recognized
1538 * comment leader.
1539 * "backward" must be true for the "O" command.
1542 get_leader_len(line, flags, backward)
1543 char_u *line;
1544 char_u **flags;
1545 int backward;
1547 int i, j;
1548 int got_com = FALSE;
1549 int found_one;
1550 char_u part_buf[COM_MAX_LEN]; /* buffer for one option part */
1551 char_u *string; /* pointer to comment string */
1552 char_u *list;
1554 i = 0;
1555 while (vim_iswhite(line[i])) /* leading white space is ignored */
1556 ++i;
1559 * Repeat to match several nested comment strings.
1561 while (line[i])
1564 * scan through the 'comments' option for a match
1566 found_one = FALSE;
1567 for (list = curbuf->b_p_com; *list; )
1570 * Get one option part into part_buf[]. Advance list to next one.
1571 * put string at start of string.
1573 if (!got_com && flags != NULL) /* remember where flags started */
1574 *flags = list;
1575 (void)copy_option_part(&list, part_buf, COM_MAX_LEN, ",");
1576 string = vim_strchr(part_buf, ':');
1577 if (string == NULL) /* missing ':', ignore this part */
1578 continue;
1579 *string++ = NUL; /* isolate flags from string */
1582 * When already found a nested comment, only accept further
1583 * nested comments.
1585 if (got_com && vim_strchr(part_buf, COM_NEST) == NULL)
1586 continue;
1588 /* When 'O' flag used don't use for "O" command */
1589 if (backward && vim_strchr(part_buf, COM_NOBACK) != NULL)
1590 continue;
1593 * Line contents and string must match.
1594 * When string starts with white space, must have some white space
1595 * (but the amount does not need to match, there might be a mix of
1596 * TABs and spaces).
1598 if (vim_iswhite(string[0]))
1600 if (i == 0 || !vim_iswhite(line[i - 1]))
1601 continue;
1602 while (vim_iswhite(string[0]))
1603 ++string;
1605 for (j = 0; string[j] != NUL && string[j] == line[i + j]; ++j)
1607 if (string[j] != NUL)
1608 continue;
1611 * When 'b' flag used, there must be white space or an
1612 * end-of-line after the string in the line.
1614 if (vim_strchr(part_buf, COM_BLANK) != NULL
1615 && !vim_iswhite(line[i + j]) && line[i + j] != NUL)
1616 continue;
1619 * We have found a match, stop searching.
1621 i += j;
1622 got_com = TRUE;
1623 found_one = TRUE;
1624 break;
1628 * No match found, stop scanning.
1630 if (!found_one)
1631 break;
1634 * Include any trailing white space.
1636 while (vim_iswhite(line[i]))
1637 ++i;
1640 * If this comment doesn't nest, stop here.
1642 if (vim_strchr(part_buf, COM_NEST) == NULL)
1643 break;
1645 return (got_com ? i : 0);
1647 #endif
1650 * Return the number of window lines occupied by buffer line "lnum".
1653 plines(lnum)
1654 linenr_T lnum;
1656 return plines_win(curwin, lnum, TRUE);
1660 plines_win(wp, lnum, winheight)
1661 win_T *wp;
1662 linenr_T lnum;
1663 int winheight; /* when TRUE limit to window height */
1665 #if defined(FEAT_DIFF) || defined(PROTO)
1666 /* Check for filler lines above this buffer line. When folded the result
1667 * is one line anyway. */
1668 return plines_win_nofill(wp, lnum, winheight) + diff_check_fill(wp, lnum);
1672 plines_nofill(lnum)
1673 linenr_T lnum;
1675 return plines_win_nofill(curwin, lnum, TRUE);
1679 plines_win_nofill(wp, lnum, winheight)
1680 win_T *wp;
1681 linenr_T lnum;
1682 int winheight; /* when TRUE limit to window height */
1684 #endif
1685 int lines;
1687 if (!wp->w_p_wrap)
1688 return 1;
1690 #ifdef FEAT_VERTSPLIT
1691 if (wp->w_width == 0)
1692 return 1;
1693 #endif
1695 #ifdef FEAT_FOLDING
1696 /* A folded lines is handled just like an empty line. */
1697 /* NOTE: Caller must handle lines that are MAYBE folded. */
1698 if (lineFolded(wp, lnum) == TRUE)
1699 return 1;
1700 #endif
1702 lines = plines_win_nofold(wp, lnum);
1703 if (winheight > 0 && lines > wp->w_height)
1704 return (int)wp->w_height;
1705 return lines;
1709 * Return number of window lines physical line "lnum" will occupy in window
1710 * "wp". Does not care about folding, 'wrap' or 'diff'.
1713 plines_win_nofold(wp, lnum)
1714 win_T *wp;
1715 linenr_T lnum;
1717 char_u *s;
1718 long col;
1719 int width;
1721 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1722 if (*s == NUL) /* empty line */
1723 return 1;
1724 col = win_linetabsize(wp, s, (colnr_T)MAXCOL);
1727 * If list mode is on, then the '$' at the end of the line may take up one
1728 * extra column.
1730 if (wp->w_p_list && lcs_eol != NUL)
1731 col += 1;
1734 * Add column offset for 'number' and 'foldcolumn'.
1736 width = W_WIDTH(wp) - win_col_off(wp);
1737 if (width <= 0)
1738 return 32000;
1739 if (col <= width)
1740 return 1;
1741 col -= width;
1742 width += win_col_off2(wp);
1743 return (col + (width - 1)) / width + 1;
1747 * Like plines_win(), but only reports the number of physical screen lines
1748 * used from the start of the line to the given column number.
1751 plines_win_col(wp, lnum, column)
1752 win_T *wp;
1753 linenr_T lnum;
1754 long column;
1756 long col;
1757 char_u *s;
1758 int lines = 0;
1759 int width;
1761 #ifdef FEAT_DIFF
1762 /* Check for filler lines above this buffer line. When folded the result
1763 * is one line anyway. */
1764 lines = diff_check_fill(wp, lnum);
1765 #endif
1767 if (!wp->w_p_wrap)
1768 return lines + 1;
1770 #ifdef FEAT_VERTSPLIT
1771 if (wp->w_width == 0)
1772 return lines + 1;
1773 #endif
1775 s = ml_get_buf(wp->w_buffer, lnum, FALSE);
1777 col = 0;
1778 while (*s != NUL && --column >= 0)
1780 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL);
1781 mb_ptr_adv(s);
1785 * If *s is a TAB, and the TAB is not displayed as ^I, and we're not in
1786 * INSERT mode, then col must be adjusted so that it represents the last
1787 * screen position of the TAB. This only fixes an error when the TAB wraps
1788 * from one screen line to the next (when 'columns' is not a multiple of
1789 * 'ts') -- webb.
1791 if (*s == TAB && (State & NORMAL) && (!wp->w_p_list || lcs_tab1))
1792 col += win_lbr_chartabsize(wp, s, (colnr_T)col, NULL) - 1;
1795 * Add column offset for 'number', 'foldcolumn', etc.
1797 width = W_WIDTH(wp) - win_col_off(wp);
1798 if (width <= 0)
1799 return 9999;
1801 lines += 1;
1802 if (col > width)
1803 lines += (col - width) / (width + win_col_off2(wp)) + 1;
1804 return lines;
1808 plines_m_win(wp, first, last)
1809 win_T *wp;
1810 linenr_T first, last;
1812 int count = 0;
1814 while (first <= last)
1816 #ifdef FEAT_FOLDING
1817 int x;
1819 /* Check if there are any really folded lines, but also included lines
1820 * that are maybe folded. */
1821 x = foldedCount(wp, first, NULL);
1822 if (x > 0)
1824 ++count; /* count 1 for "+-- folded" line */
1825 first += x;
1827 else
1828 #endif
1830 #ifdef FEAT_DIFF
1831 if (first == wp->w_topline)
1832 count += plines_win_nofill(wp, first, TRUE) + wp->w_topfill;
1833 else
1834 #endif
1835 count += plines_win(wp, first, TRUE);
1836 ++first;
1839 return (count);
1842 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) || defined(PROTO)
1844 * Insert string "p" at the cursor position. Stops at a NUL byte.
1845 * Handles Replace mode and multi-byte characters.
1847 void
1848 ins_bytes(p)
1849 char_u *p;
1851 ins_bytes_len(p, (int)STRLEN(p));
1853 #endif
1855 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) \
1856 || defined(FEAT_COMMENTS) || defined(FEAT_MBYTE) || defined(PROTO)
1858 * Insert string "p" with length "len" at the cursor position.
1859 * Handles Replace mode and multi-byte characters.
1861 void
1862 ins_bytes_len(p, len)
1863 char_u *p;
1864 int len;
1866 int i;
1867 # ifdef FEAT_MBYTE
1868 int n;
1870 for (i = 0; i < len; i += n)
1872 n = (*mb_ptr2len)(p + i);
1873 ins_char_bytes(p + i, n);
1875 # else
1876 for (i = 0; i < len; ++i)
1877 ins_char(p[i]);
1878 # endif
1880 #endif
1883 * Insert or replace a single character at the cursor position.
1884 * When in REPLACE or VREPLACE mode, replace any existing character.
1885 * Caller must have prepared for undo.
1886 * For multi-byte characters we get the whole character, the caller must
1887 * convert bytes to a character.
1889 void
1890 ins_char(c)
1891 int c;
1893 #if defined(FEAT_MBYTE) || defined(PROTO)
1894 char_u buf[MB_MAXBYTES];
1895 int n;
1897 n = (*mb_char2bytes)(c, buf);
1899 /* When "c" is 0x100, 0x200, etc. we don't want to insert a NUL byte.
1900 * Happens for CTRL-Vu9900. */
1901 if (buf[0] == 0)
1902 buf[0] = '\n';
1904 ins_char_bytes(buf, n);
1907 void
1908 ins_char_bytes(buf, charlen)
1909 char_u *buf;
1910 int charlen;
1912 int c = buf[0];
1913 int l, j;
1914 #endif
1915 int newlen; /* nr of bytes inserted */
1916 int oldlen; /* nr of bytes deleted (0 when not replacing) */
1917 char_u *p;
1918 char_u *newp;
1919 char_u *oldp;
1920 int linelen; /* length of old line including NUL */
1921 colnr_T col;
1922 linenr_T lnum = curwin->w_cursor.lnum;
1923 int i;
1925 #ifdef FEAT_VIRTUALEDIT
1926 /* Break tabs if needed. */
1927 if (virtual_active() && curwin->w_cursor.coladd > 0)
1928 coladvance_force(getviscol());
1929 #endif
1931 col = curwin->w_cursor.col;
1932 oldp = ml_get(lnum);
1933 linelen = (int)STRLEN(oldp) + 1;
1935 /* The lengths default to the values for when not replacing. */
1936 oldlen = 0;
1937 #ifdef FEAT_MBYTE
1938 newlen = charlen;
1939 #else
1940 newlen = 1;
1941 #endif
1943 if (State & REPLACE_FLAG)
1945 #ifdef FEAT_VREPLACE
1946 if (State & VREPLACE_FLAG)
1948 colnr_T new_vcol = 0; /* init for GCC */
1949 colnr_T vcol;
1950 int old_list;
1951 #ifndef FEAT_MBYTE
1952 char_u buf[2];
1953 #endif
1956 * Disable 'list' temporarily, unless 'cpo' contains the 'L' flag.
1957 * Returns the old value of list, so when finished,
1958 * curwin->w_p_list should be set back to this.
1960 old_list = curwin->w_p_list;
1961 if (old_list && vim_strchr(p_cpo, CPO_LISTWM) == NULL)
1962 curwin->w_p_list = FALSE;
1965 * In virtual replace mode each character may replace one or more
1966 * characters (zero if it's a TAB). Count the number of bytes to
1967 * be deleted to make room for the new character, counting screen
1968 * cells. May result in adding spaces to fill a gap.
1970 getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL);
1971 #ifndef FEAT_MBYTE
1972 buf[0] = c;
1973 buf[1] = NUL;
1974 #endif
1975 new_vcol = vcol + chartabsize(buf, vcol);
1976 while (oldp[col + oldlen] != NUL && vcol < new_vcol)
1978 vcol += chartabsize(oldp + col + oldlen, vcol);
1979 /* Don't need to remove a TAB that takes us to the right
1980 * position. */
1981 if (vcol > new_vcol && oldp[col + oldlen] == TAB)
1982 break;
1983 #ifdef FEAT_MBYTE
1984 oldlen += (*mb_ptr2len)(oldp + col + oldlen);
1985 #else
1986 ++oldlen;
1987 #endif
1988 /* Deleted a bit too much, insert spaces. */
1989 if (vcol > new_vcol)
1990 newlen += vcol - new_vcol;
1992 curwin->w_p_list = old_list;
1994 else
1995 #endif
1996 if (oldp[col] != NUL)
1998 /* normal replace */
1999 #ifdef FEAT_MBYTE
2000 oldlen = (*mb_ptr2len)(oldp + col);
2001 #else
2002 oldlen = 1;
2003 #endif
2007 /* Push the replaced bytes onto the replace stack, so that they can be
2008 * put back when BS is used. The bytes of a multi-byte character are
2009 * done the other way around, so that the first byte is popped off
2010 * first (it tells the byte length of the character). */
2011 replace_push(NUL);
2012 for (i = 0; i < oldlen; ++i)
2014 #ifdef FEAT_MBYTE
2015 l = (*mb_ptr2len)(oldp + col + i) - 1;
2016 for (j = l; j >= 0; --j)
2017 replace_push(oldp[col + i + j]);
2018 i += l;
2019 #else
2020 replace_push(oldp[col + i]);
2021 #endif
2025 newp = alloc_check((unsigned)(linelen + newlen - oldlen));
2026 if (newp == NULL)
2027 return;
2029 /* Copy bytes before the cursor. */
2030 if (col > 0)
2031 mch_memmove(newp, oldp, (size_t)col);
2033 /* Copy bytes after the changed character(s). */
2034 p = newp + col;
2035 mch_memmove(p + newlen, oldp + col + oldlen,
2036 (size_t)(linelen - col - oldlen));
2038 /* Insert or overwrite the new character. */
2039 #ifdef FEAT_MBYTE
2040 mch_memmove(p, buf, charlen);
2041 i = charlen;
2042 #else
2043 *p = c;
2044 i = 1;
2045 #endif
2047 /* Fill with spaces when necessary. */
2048 while (i < newlen)
2049 p[i++] = ' ';
2051 /* Replace the line in the buffer. */
2052 ml_replace(lnum, newp, FALSE);
2054 /* mark the buffer as changed and prepare for displaying */
2055 changed_bytes(lnum, col);
2058 * If we're in Insert or Replace mode and 'showmatch' is set, then briefly
2059 * show the match for right parens and braces.
2061 if (p_sm && (State & INSERT)
2062 && msg_silent == 0
2063 #ifdef FEAT_MBYTE
2064 && charlen == 1
2065 #endif
2066 #ifdef FEAT_INS_EXPAND
2067 && !ins_compl_active()
2068 #endif
2070 showmatch(c);
2072 #ifdef FEAT_RIGHTLEFT
2073 if (!p_ri || (State & REPLACE_FLAG))
2074 #endif
2076 /* Normal insert: move cursor right */
2077 #ifdef FEAT_MBYTE
2078 curwin->w_cursor.col += charlen;
2079 #else
2080 ++curwin->w_cursor.col;
2081 #endif
2084 * TODO: should try to update w_row here, to avoid recomputing it later.
2089 * Insert a string at the cursor position.
2090 * Note: Does NOT handle Replace mode.
2091 * Caller must have prepared for undo.
2093 void
2094 ins_str(s)
2095 char_u *s;
2097 char_u *oldp, *newp;
2098 int newlen = (int)STRLEN(s);
2099 int oldlen;
2100 colnr_T col;
2101 linenr_T lnum = curwin->w_cursor.lnum;
2103 #ifdef FEAT_VIRTUALEDIT
2104 if (virtual_active() && curwin->w_cursor.coladd > 0)
2105 coladvance_force(getviscol());
2106 #endif
2108 col = curwin->w_cursor.col;
2109 oldp = ml_get(lnum);
2110 oldlen = (int)STRLEN(oldp);
2112 newp = alloc_check((unsigned)(oldlen + newlen + 1));
2113 if (newp == NULL)
2114 return;
2115 if (col > 0)
2116 mch_memmove(newp, oldp, (size_t)col);
2117 mch_memmove(newp + col, s, (size_t)newlen);
2118 mch_memmove(newp + col + newlen, oldp + col, (size_t)(oldlen - col + 1));
2119 ml_replace(lnum, newp, FALSE);
2120 changed_bytes(lnum, col);
2121 curwin->w_cursor.col += newlen;
2125 * Delete one character under the cursor.
2126 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2127 * Caller must have prepared for undo.
2129 * return FAIL for failure, OK otherwise
2132 del_char(fixpos)
2133 int fixpos;
2135 #ifdef FEAT_MBYTE
2136 if (has_mbyte)
2138 /* Make sure the cursor is at the start of a character. */
2139 mb_adjust_cursor();
2140 if (*ml_get_cursor() == NUL)
2141 return FAIL;
2142 return del_chars(1L, fixpos);
2144 #endif
2145 return del_bytes(1L, fixpos, TRUE);
2148 #if defined(FEAT_MBYTE) || defined(PROTO)
2150 * Like del_bytes(), but delete characters instead of bytes.
2153 del_chars(count, fixpos)
2154 long count;
2155 int fixpos;
2157 long bytes = 0;
2158 long i;
2159 char_u *p;
2160 int l;
2162 p = ml_get_cursor();
2163 for (i = 0; i < count && *p != NUL; ++i)
2165 l = (*mb_ptr2len)(p);
2166 bytes += l;
2167 p += l;
2169 return del_bytes(bytes, fixpos, TRUE);
2171 #endif
2174 * Delete "count" bytes under the cursor.
2175 * If "fixpos" is TRUE, don't leave the cursor on the NUL after the line.
2176 * Caller must have prepared for undo.
2178 * return FAIL for failure, OK otherwise
2180 /*ARGSUSED*/
2182 del_bytes(count, fixpos_arg, use_delcombine)
2183 long count;
2184 int fixpos_arg;
2185 int use_delcombine; /* 'delcombine' option applies */
2187 char_u *oldp, *newp;
2188 colnr_T oldlen;
2189 linenr_T lnum = curwin->w_cursor.lnum;
2190 colnr_T col = curwin->w_cursor.col;
2191 int was_alloced;
2192 long movelen;
2193 int fixpos = fixpos_arg;
2195 oldp = ml_get(lnum);
2196 oldlen = (int)STRLEN(oldp);
2199 * Can't do anything when the cursor is on the NUL after the line.
2201 if (col >= oldlen)
2202 return FAIL;
2204 #ifdef FEAT_MBYTE
2205 /* If 'delcombine' is set and deleting (less than) one character, only
2206 * delete the last combining character. */
2207 if (p_deco && use_delcombine && enc_utf8
2208 && utfc_ptr2len(oldp + col) >= count)
2210 int cc[MAX_MCO];
2211 int n;
2213 (void)utfc_ptr2char(oldp + col, cc);
2214 if (cc[0] != NUL)
2216 /* Find the last composing char, there can be several. */
2217 n = col;
2220 col = n;
2221 count = utf_ptr2len(oldp + n);
2222 n += count;
2223 } while (UTF_COMPOSINGLIKE(oldp + col, oldp + n));
2224 fixpos = 0;
2227 #endif
2230 * When count is too big, reduce it.
2232 movelen = (long)oldlen - (long)col - count + 1; /* includes trailing NUL */
2233 if (movelen <= 1)
2236 * If we just took off the last character of a non-blank line, and
2237 * fixpos is TRUE, we don't want to end up positioned at the NUL,
2238 * unless "restart_edit" is set or 'virtualedit' contains "onemore".
2240 if (col > 0 && fixpos && restart_edit == 0
2241 #ifdef FEAT_VIRTUALEDIT
2242 && (ve_flags & VE_ONEMORE) == 0
2243 #endif
2246 --curwin->w_cursor.col;
2247 #ifdef FEAT_VIRTUALEDIT
2248 curwin->w_cursor.coladd = 0;
2249 #endif
2250 #ifdef FEAT_MBYTE
2251 if (has_mbyte)
2252 curwin->w_cursor.col -=
2253 (*mb_head_off)(oldp, oldp + curwin->w_cursor.col);
2254 #endif
2256 count = oldlen - col;
2257 movelen = 1;
2261 * If the old line has been allocated the deletion can be done in the
2262 * existing line. Otherwise a new line has to be allocated
2264 was_alloced = ml_line_alloced(); /* check if oldp was allocated */
2265 #ifdef FEAT_NETBEANS_INTG
2266 if (was_alloced && usingNetbeans)
2267 netbeans_removed(curbuf, lnum, col, count);
2268 /* else is handled by ml_replace() */
2269 #endif
2270 if (was_alloced)
2271 newp = oldp; /* use same allocated memory */
2272 else
2273 { /* need to allocate a new line */
2274 newp = alloc((unsigned)(oldlen + 1 - count));
2275 if (newp == NULL)
2276 return FAIL;
2277 mch_memmove(newp, oldp, (size_t)col);
2279 mch_memmove(newp + col, oldp + col + count, (size_t)movelen);
2280 if (!was_alloced)
2281 ml_replace(lnum, newp, FALSE);
2283 /* mark the buffer as changed and prepare for displaying */
2284 changed_bytes(lnum, curwin->w_cursor.col);
2286 return OK;
2290 * Delete from cursor to end of line.
2291 * Caller must have prepared for undo.
2293 * return FAIL for failure, OK otherwise
2296 truncate_line(fixpos)
2297 int fixpos; /* if TRUE fix the cursor position when done */
2299 char_u *newp;
2300 linenr_T lnum = curwin->w_cursor.lnum;
2301 colnr_T col = curwin->w_cursor.col;
2303 if (col == 0)
2304 newp = vim_strsave((char_u *)"");
2305 else
2306 newp = vim_strnsave(ml_get(lnum), col);
2308 if (newp == NULL)
2309 return FAIL;
2311 ml_replace(lnum, newp, FALSE);
2313 /* mark the buffer as changed and prepare for displaying */
2314 changed_bytes(lnum, curwin->w_cursor.col);
2317 * If "fixpos" is TRUE we don't want to end up positioned at the NUL.
2319 if (fixpos && curwin->w_cursor.col > 0)
2320 --curwin->w_cursor.col;
2322 return OK;
2326 * Delete "nlines" lines at the cursor.
2327 * Saves the lines for undo first if "undo" is TRUE.
2329 void
2330 del_lines(nlines, undo)
2331 long nlines; /* number of lines to delete */
2332 int undo; /* if TRUE, prepare for undo */
2334 long n;
2336 if (nlines <= 0)
2337 return;
2339 /* save the deleted lines for undo */
2340 if (undo && u_savedel(curwin->w_cursor.lnum, nlines) == FAIL)
2341 return;
2343 for (n = 0; n < nlines; )
2345 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
2346 break;
2348 ml_delete(curwin->w_cursor.lnum, TRUE);
2349 ++n;
2351 /* If we delete the last line in the file, stop */
2352 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
2353 break;
2355 /* adjust marks, mark the buffer as changed and prepare for displaying */
2356 deleted_lines_mark(curwin->w_cursor.lnum, n);
2358 curwin->w_cursor.col = 0;
2359 check_cursor_lnum();
2363 gchar_pos(pos)
2364 pos_T *pos;
2366 char_u *ptr = ml_get_pos(pos);
2368 #ifdef FEAT_MBYTE
2369 if (has_mbyte)
2370 return (*mb_ptr2char)(ptr);
2371 #endif
2372 return (int)*ptr;
2376 gchar_cursor()
2378 #ifdef FEAT_MBYTE
2379 if (has_mbyte)
2380 return (*mb_ptr2char)(ml_get_cursor());
2381 #endif
2382 return (int)*ml_get_cursor();
2386 * Write a character at the current cursor position.
2387 * It is directly written into the block.
2389 void
2390 pchar_cursor(c)
2391 int c;
2393 *(ml_get_buf(curbuf, curwin->w_cursor.lnum, TRUE)
2394 + curwin->w_cursor.col) = c;
2397 #if 0 /* not used */
2399 * Put *pos at end of current buffer
2401 void
2402 goto_endofbuf(pos)
2403 pos_T *pos;
2405 char_u *p;
2407 pos->lnum = curbuf->b_ml.ml_line_count;
2408 pos->col = 0;
2409 p = ml_get(pos->lnum);
2410 while (*p++)
2411 ++pos->col;
2413 #endif
2416 * When extra == 0: Return TRUE if the cursor is before or on the first
2417 * non-blank in the line.
2418 * When extra == 1: Return TRUE if the cursor is before the first non-blank in
2419 * the line.
2422 inindent(extra)
2423 int extra;
2425 char_u *ptr;
2426 colnr_T col;
2428 for (col = 0, ptr = ml_get_curline(); vim_iswhite(*ptr); ++col)
2429 ++ptr;
2430 if (col >= curwin->w_cursor.col + extra)
2431 return TRUE;
2432 else
2433 return FALSE;
2437 * Skip to next part of an option argument: Skip space and comma.
2439 char_u *
2440 skip_to_option_part(p)
2441 char_u *p;
2443 if (*p == ',')
2444 ++p;
2445 while (*p == ' ')
2446 ++p;
2447 return p;
2451 * changed() is called when something in the current buffer is changed.
2453 * Most often called through changed_bytes() and changed_lines(), which also
2454 * mark the area of the display to be redrawn.
2456 void
2457 changed()
2459 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2460 /* The text of the preediting area is inserted, but this doesn't
2461 * mean a change of the buffer yet. That is delayed until the
2462 * text is committed. (this means preedit becomes empty) */
2463 if (im_is_preediting() && !xim_changed_while_preediting)
2464 return;
2465 xim_changed_while_preediting = FALSE;
2466 #endif
2468 if (!curbuf->b_changed)
2470 int save_msg_scroll = msg_scroll;
2472 /* Give a warning about changing a read-only file. This may also
2473 * check-out the file, thus change "curbuf"! */
2474 change_warning(0);
2476 /* Create a swap file if that is wanted.
2477 * Don't do this for "nofile" and "nowrite" buffer types. */
2478 if (curbuf->b_may_swap
2479 #ifdef FEAT_QUICKFIX
2480 && !bt_dontwrite(curbuf)
2481 #endif
2484 ml_open_file(curbuf);
2486 /* The ml_open_file() can cause an ATTENTION message.
2487 * Wait two seconds, to make sure the user reads this unexpected
2488 * message. Since we could be anywhere, call wait_return() now,
2489 * and don't let the emsg() set msg_scroll. */
2490 if (need_wait_return && emsg_silent == 0)
2492 out_flush();
2493 ui_delay(2000L, TRUE);
2494 wait_return(TRUE);
2495 msg_scroll = save_msg_scroll;
2498 curbuf->b_changed = TRUE;
2499 ml_setflags(curbuf);
2500 #ifdef FEAT_WINDOWS
2501 check_status(curbuf);
2502 redraw_tabline = TRUE;
2503 #endif
2504 #ifdef FEAT_TITLE
2505 need_maketitle = TRUE; /* set window title later */
2506 #endif
2508 ++curbuf->b_changedtick;
2511 static void changedOneline __ARGS((buf_T *buf, linenr_T lnum));
2512 static void changed_lines_buf __ARGS((buf_T *buf, linenr_T lnum, linenr_T lnume, long xtra));
2513 static void changed_common __ARGS((linenr_T lnum, colnr_T col, linenr_T lnume, long xtra));
2516 * Changed bytes within a single line for the current buffer.
2517 * - marks the windows on this buffer to be redisplayed
2518 * - marks the buffer changed by calling changed()
2519 * - invalidates cached values
2521 void
2522 changed_bytes(lnum, col)
2523 linenr_T lnum;
2524 colnr_T col;
2526 changedOneline(curbuf, lnum);
2527 changed_common(lnum, col, lnum + 1, 0L);
2529 #ifdef FEAT_DIFF
2530 /* Diff highlighting in other diff windows may need to be updated too. */
2531 if (curwin->w_p_diff)
2533 win_T *wp;
2534 linenr_T wlnum;
2536 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2537 if (wp->w_p_diff && wp != curwin)
2539 redraw_win_later(wp, VALID);
2540 wlnum = diff_lnum_win(lnum, wp);
2541 if (wlnum > 0)
2542 changedOneline(wp->w_buffer, wlnum);
2545 #endif
2548 static void
2549 changedOneline(buf, lnum)
2550 buf_T *buf;
2551 linenr_T lnum;
2553 if (buf->b_mod_set)
2555 /* find the maximum area that must be redisplayed */
2556 if (lnum < buf->b_mod_top)
2557 buf->b_mod_top = lnum;
2558 else if (lnum >= buf->b_mod_bot)
2559 buf->b_mod_bot = lnum + 1;
2561 else
2563 /* set the area that must be redisplayed to one line */
2564 buf->b_mod_set = TRUE;
2565 buf->b_mod_top = lnum;
2566 buf->b_mod_bot = lnum + 1;
2567 buf->b_mod_xlines = 0;
2572 * Appended "count" lines below line "lnum" in the current buffer.
2573 * Must be called AFTER the change and after mark_adjust().
2574 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2576 void
2577 appended_lines(lnum, count)
2578 linenr_T lnum;
2579 long count;
2581 changed_lines(lnum + 1, 0, lnum + 1, count);
2585 * Like appended_lines(), but adjust marks first.
2587 void
2588 appended_lines_mark(lnum, count)
2589 linenr_T lnum;
2590 long count;
2592 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, count, 0L);
2593 changed_lines(lnum + 1, 0, lnum + 1, count);
2597 * Deleted "count" lines at line "lnum" in the current buffer.
2598 * Must be called AFTER the change and after mark_adjust().
2599 * Takes care of marking the buffer to be redrawn and sets the changed flag.
2601 void
2602 deleted_lines(lnum, count)
2603 linenr_T lnum;
2604 long count;
2606 changed_lines(lnum, 0, lnum + count, -count);
2610 * Like deleted_lines(), but adjust marks first.
2612 void
2613 deleted_lines_mark(lnum, count)
2614 linenr_T lnum;
2615 long count;
2617 mark_adjust(lnum, (linenr_T)(lnum + count - 1), (long)MAXLNUM, -count);
2618 changed_lines(lnum, 0, lnum + count, -count);
2622 * Changed lines for the current buffer.
2623 * Must be called AFTER the change and after mark_adjust().
2624 * - mark the buffer changed by calling changed()
2625 * - mark the windows on this buffer to be redisplayed
2626 * - invalidate cached values
2627 * "lnum" is the first line that needs displaying, "lnume" the first line
2628 * below the changed lines (BEFORE the change).
2629 * When only inserting lines, "lnum" and "lnume" are equal.
2630 * Takes care of calling changed() and updating b_mod_*.
2632 void
2633 changed_lines(lnum, col, lnume, xtra)
2634 linenr_T lnum; /* first line with change */
2635 colnr_T col; /* column in first line with change */
2636 linenr_T lnume; /* line below last changed line */
2637 long xtra; /* number of extra lines (negative when deleting) */
2639 changed_lines_buf(curbuf, lnum, lnume, xtra);
2641 #ifdef FEAT_DIFF
2642 if (xtra == 0 && curwin->w_p_diff)
2644 /* When the number of lines doesn't change then mark_adjust() isn't
2645 * called and other diff buffers still need to be marked for
2646 * displaying. */
2647 win_T *wp;
2648 linenr_T wlnum;
2650 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2651 if (wp->w_p_diff && wp != curwin)
2653 redraw_win_later(wp, VALID);
2654 wlnum = diff_lnum_win(lnum, wp);
2655 if (wlnum > 0)
2656 changed_lines_buf(wp->w_buffer, wlnum,
2657 lnume - lnum + wlnum, 0L);
2660 #endif
2662 changed_common(lnum, col, lnume, xtra);
2665 static void
2666 changed_lines_buf(buf, lnum, lnume, xtra)
2667 buf_T *buf;
2668 linenr_T lnum; /* first line with change */
2669 linenr_T lnume; /* line below last changed line */
2670 long xtra; /* number of extra lines (negative when deleting) */
2672 if (buf->b_mod_set)
2674 /* find the maximum area that must be redisplayed */
2675 if (lnum < buf->b_mod_top)
2676 buf->b_mod_top = lnum;
2677 if (lnum < buf->b_mod_bot)
2679 /* adjust old bot position for xtra lines */
2680 buf->b_mod_bot += xtra;
2681 if (buf->b_mod_bot < lnum)
2682 buf->b_mod_bot = lnum;
2684 if (lnume + xtra > buf->b_mod_bot)
2685 buf->b_mod_bot = lnume + xtra;
2686 buf->b_mod_xlines += xtra;
2688 else
2690 /* set the area that must be redisplayed */
2691 buf->b_mod_set = TRUE;
2692 buf->b_mod_top = lnum;
2693 buf->b_mod_bot = lnume + xtra;
2694 buf->b_mod_xlines = xtra;
2698 static void
2699 changed_common(lnum, col, lnume, xtra)
2700 linenr_T lnum;
2701 colnr_T col;
2702 linenr_T lnume;
2703 long xtra;
2705 win_T *wp;
2706 int i;
2707 #ifdef FEAT_JUMPLIST
2708 int cols;
2709 pos_T *p;
2710 int add;
2711 #endif
2713 /* mark the buffer as modified */
2714 changed();
2716 /* set the '. mark */
2717 if (!cmdmod.keepjumps)
2719 curbuf->b_last_change.lnum = lnum;
2720 curbuf->b_last_change.col = col;
2722 #ifdef FEAT_JUMPLIST
2723 /* Create a new entry if a new undo-able change was started or we
2724 * don't have an entry yet. */
2725 if (curbuf->b_new_change || curbuf->b_changelistlen == 0)
2727 if (curbuf->b_changelistlen == 0)
2728 add = TRUE;
2729 else
2731 /* Don't create a new entry when the line number is the same
2732 * as the last one and the column is not too far away. Avoids
2733 * creating many entries for typing "xxxxx". */
2734 p = &curbuf->b_changelist[curbuf->b_changelistlen - 1];
2735 if (p->lnum != lnum)
2736 add = TRUE;
2737 else
2739 cols = comp_textwidth(FALSE);
2740 if (cols == 0)
2741 cols = 79;
2742 add = (p->col + cols < col || col + cols < p->col);
2745 if (add)
2747 /* This is the first of a new sequence of undo-able changes
2748 * and it's at some distance of the last change. Use a new
2749 * position in the changelist. */
2750 curbuf->b_new_change = FALSE;
2752 if (curbuf->b_changelistlen == JUMPLISTSIZE)
2754 /* changelist is full: remove oldest entry */
2755 curbuf->b_changelistlen = JUMPLISTSIZE - 1;
2756 mch_memmove(curbuf->b_changelist, curbuf->b_changelist + 1,
2757 sizeof(pos_T) * (JUMPLISTSIZE - 1));
2758 FOR_ALL_WINDOWS(wp)
2760 /* Correct position in changelist for other windows on
2761 * this buffer. */
2762 if (wp->w_buffer == curbuf && wp->w_changelistidx > 0)
2763 --wp->w_changelistidx;
2766 FOR_ALL_WINDOWS(wp)
2768 /* For other windows, if the position in the changelist is
2769 * at the end it stays at the end. */
2770 if (wp->w_buffer == curbuf
2771 && wp->w_changelistidx == curbuf->b_changelistlen)
2772 ++wp->w_changelistidx;
2774 ++curbuf->b_changelistlen;
2777 curbuf->b_changelist[curbuf->b_changelistlen - 1] =
2778 curbuf->b_last_change;
2779 /* The current window is always after the last change, so that "g,"
2780 * takes you back to it. */
2781 curwin->w_changelistidx = curbuf->b_changelistlen;
2782 #endif
2785 FOR_ALL_WINDOWS(wp)
2787 if (wp->w_buffer == curbuf)
2789 /* Mark this window to be redrawn later. */
2790 if (wp->w_redr_type < VALID)
2791 wp->w_redr_type = VALID;
2793 /* Check if a change in the buffer has invalidated the cached
2794 * values for the cursor. */
2795 #ifdef FEAT_FOLDING
2797 * Update the folds for this window. Can't postpone this, because
2798 * a following operator might work on the whole fold: ">>dd".
2800 foldUpdate(wp, lnum, lnume + xtra - 1);
2802 /* The change may cause lines above or below the change to become
2803 * included in a fold. Set lnum/lnume to the first/last line that
2804 * might be displayed differently.
2805 * Set w_cline_folded here as an efficient way to update it when
2806 * inserting lines just above a closed fold. */
2807 i = hasFoldingWin(wp, lnum, &lnum, NULL, FALSE, NULL);
2808 if (wp->w_cursor.lnum == lnum)
2809 wp->w_cline_folded = i;
2810 i = hasFoldingWin(wp, lnume, NULL, &lnume, FALSE, NULL);
2811 if (wp->w_cursor.lnum == lnume)
2812 wp->w_cline_folded = i;
2814 /* If the changed line is in a range of previously folded lines,
2815 * compare with the first line in that range. */
2816 if (wp->w_cursor.lnum <= lnum)
2818 i = find_wl_entry(wp, lnum);
2819 if (i >= 0 && wp->w_cursor.lnum > wp->w_lines[i].wl_lnum)
2820 changed_line_abv_curs_win(wp);
2822 #endif
2824 if (wp->w_cursor.lnum > lnum)
2825 changed_line_abv_curs_win(wp);
2826 else if (wp->w_cursor.lnum == lnum && wp->w_cursor.col >= col)
2827 changed_cline_bef_curs_win(wp);
2828 if (wp->w_botline >= lnum)
2830 /* Assume that botline doesn't change (inserted lines make
2831 * other lines scroll down below botline). */
2832 approximate_botline_win(wp);
2835 /* Check if any w_lines[] entries have become invalid.
2836 * For entries below the change: Correct the lnums for
2837 * inserted/deleted lines. Makes it possible to stop displaying
2838 * after the change. */
2839 for (i = 0; i < wp->w_lines_valid; ++i)
2840 if (wp->w_lines[i].wl_valid)
2842 if (wp->w_lines[i].wl_lnum >= lnum)
2844 if (wp->w_lines[i].wl_lnum < lnume)
2846 /* line included in change */
2847 wp->w_lines[i].wl_valid = FALSE;
2849 else if (xtra != 0)
2851 /* line below change */
2852 wp->w_lines[i].wl_lnum += xtra;
2853 #ifdef FEAT_FOLDING
2854 wp->w_lines[i].wl_lastlnum += xtra;
2855 #endif
2858 #ifdef FEAT_FOLDING
2859 else if (wp->w_lines[i].wl_lastlnum >= lnum)
2861 /* change somewhere inside this range of folded lines,
2862 * may need to be redrawn */
2863 wp->w_lines[i].wl_valid = FALSE;
2865 #endif
2870 /* Call update_screen() later, which checks out what needs to be redrawn,
2871 * since it notices b_mod_set and then uses b_mod_*. */
2872 if (must_redraw < VALID)
2873 must_redraw = VALID;
2875 #ifdef FEAT_AUTOCMD
2876 /* when the cursor line is changed always trigger CursorMoved */
2877 if (lnum <= curwin->w_cursor.lnum
2878 && lnume + (xtra < 0 ? -xtra : xtra) > curwin->w_cursor.lnum)
2879 last_cursormoved.lnum = 0;
2880 #endif
2884 * unchanged() is called when the changed flag must be reset for buffer 'buf'
2886 void
2887 unchanged(buf, ff)
2888 buf_T *buf;
2889 int ff; /* also reset 'fileformat' */
2891 if (buf->b_changed || (ff && file_ff_differs(buf)))
2893 buf->b_changed = 0;
2894 ml_setflags(buf);
2895 if (ff)
2896 save_file_ff(buf);
2897 #ifdef FEAT_WINDOWS
2898 check_status(buf);
2899 redraw_tabline = TRUE;
2900 #endif
2901 #ifdef FEAT_TITLE
2902 need_maketitle = TRUE; /* set window title later */
2903 #endif
2905 ++buf->b_changedtick;
2906 #ifdef FEAT_NETBEANS_INTG
2907 netbeans_unmodified(buf);
2908 #endif
2911 #if defined(FEAT_WINDOWS) || defined(PROTO)
2913 * check_status: called when the status bars for the buffer 'buf'
2914 * need to be updated
2916 void
2917 check_status(buf)
2918 buf_T *buf;
2920 win_T *wp;
2922 for (wp = firstwin; wp != NULL; wp = wp->w_next)
2923 if (wp->w_buffer == buf && wp->w_status_height)
2925 wp->w_redr_status = TRUE;
2926 if (must_redraw < VALID)
2927 must_redraw = VALID;
2930 #endif
2933 * If the file is readonly, give a warning message with the first change.
2934 * Don't do this for autocommands.
2935 * Don't use emsg(), because it flushes the macro buffer.
2936 * If we have undone all changes b_changed will be FALSE, but "b_did_warn"
2937 * will be TRUE.
2939 void
2940 change_warning(col)
2941 int col; /* column for message; non-zero when in insert
2942 mode and 'showmode' is on */
2944 if (curbuf->b_did_warn == FALSE
2945 && curbufIsChanged() == 0
2946 #ifdef FEAT_AUTOCMD
2947 && !autocmd_busy
2948 #endif
2949 && curbuf->b_p_ro)
2951 #ifdef FEAT_AUTOCMD
2952 ++curbuf_lock;
2953 apply_autocmds(EVENT_FILECHANGEDRO, NULL, NULL, FALSE, curbuf);
2954 --curbuf_lock;
2955 if (!curbuf->b_p_ro)
2956 return;
2957 #endif
2959 * Do what msg() does, but with a column offset if the warning should
2960 * be after the mode message.
2962 msg_start();
2963 if (msg_row == Rows - 1)
2964 msg_col = col;
2965 msg_source(hl_attr(HLF_W));
2966 MSG_PUTS_ATTR(_("W10: Warning: Changing a readonly file"),
2967 hl_attr(HLF_W) | MSG_HIST);
2968 msg_clr_eos();
2969 (void)msg_end();
2970 if (msg_silent == 0 && !silent_mode)
2972 out_flush();
2973 ui_delay(1000L, TRUE); /* give the user time to think about it */
2975 curbuf->b_did_warn = TRUE;
2976 redraw_cmdline = FALSE; /* don't redraw and erase the message */
2977 if (msg_row < Rows - 1)
2978 showmode();
2983 * Ask for a reply from the user, a 'y' or a 'n'.
2984 * No other characters are accepted, the message is repeated until a valid
2985 * reply is entered or CTRL-C is hit.
2986 * If direct is TRUE, don't use vgetc() but ui_inchar(), don't get characters
2987 * from any buffers but directly from the user.
2989 * return the 'y' or 'n'
2992 ask_yesno(str, direct)
2993 char_u *str;
2994 int direct;
2996 int r = ' ';
2997 int save_State = State;
2999 if (exiting) /* put terminal in raw mode for this question */
3000 settmode(TMODE_RAW);
3001 ++no_wait_return;
3002 #ifdef USE_ON_FLY_SCROLL
3003 dont_scroll = TRUE; /* disallow scrolling here */
3004 #endif
3005 State = CONFIRM; /* mouse behaves like with :confirm */
3006 #ifdef FEAT_MOUSE
3007 setmouse(); /* disables mouse for xterm */
3008 #endif
3009 ++no_mapping;
3010 ++allow_keys; /* no mapping here, but recognize keys */
3012 while (r != 'y' && r != 'n')
3014 /* same highlighting as for wait_return */
3015 smsg_attr(hl_attr(HLF_R), (char_u *)"%s (y/n)?", str);
3016 if (direct)
3017 r = get_keystroke();
3018 else
3019 r = safe_vgetc();
3020 if (r == Ctrl_C || r == ESC)
3021 r = 'n';
3022 msg_putchar(r); /* show what you typed */
3023 out_flush();
3025 --no_wait_return;
3026 State = save_State;
3027 #ifdef FEAT_MOUSE
3028 setmouse();
3029 #endif
3030 --no_mapping;
3031 --allow_keys;
3033 return r;
3037 * Get a key stroke directly from the user.
3038 * Ignores mouse clicks and scrollbar events, except a click for the left
3039 * button (used at the more prompt).
3040 * Doesn't use vgetc(), because it syncs undo and eats mapped characters.
3041 * Disadvantage: typeahead is ignored.
3042 * Translates the interrupt character for unix to ESC.
3045 get_keystroke()
3047 #define CBUFLEN 151
3048 char_u buf[CBUFLEN];
3049 int len = 0;
3050 int n;
3051 int save_mapped_ctrl_c = mapped_ctrl_c;
3052 int waited = 0;
3054 mapped_ctrl_c = FALSE; /* mappings are not used here */
3055 for (;;)
3057 cursor_on();
3058 out_flush();
3060 /* First time: blocking wait. Second time: wait up to 100ms for a
3061 * terminal code to complete. Leave some room for check_termcode() to
3062 * insert a key code into (max 5 chars plus NUL). And
3063 * fix_input_buffer() can triple the number of bytes. */
3064 n = ui_inchar(buf + len, (CBUFLEN - 6 - len) / 3,
3065 len == 0 ? -1L : 100L, 0);
3066 if (n > 0)
3068 /* Replace zero and CSI by a special key code. */
3069 n = fix_input_buffer(buf + len, n, FALSE);
3070 len += n;
3071 waited = 0;
3073 else if (len > 0)
3074 ++waited; /* keep track of the waiting time */
3076 /* Incomplete termcode and not timed out yet: get more characters */
3077 if ((n = check_termcode(1, buf, len)) < 0
3078 && (!p_ttimeout || waited * 100L < (p_ttm < 0 ? p_tm : p_ttm)))
3079 continue;
3081 /* found a termcode: adjust length */
3082 if (n > 0)
3083 len = n;
3084 if (len == 0) /* nothing typed yet */
3085 continue;
3087 /* Handle modifier and/or special key code. */
3088 n = buf[0];
3089 if (n == K_SPECIAL)
3091 n = TO_SPECIAL(buf[1], buf[2]);
3092 if (buf[1] == KS_MODIFIER
3093 || n == K_IGNORE
3094 #ifdef FEAT_MOUSE
3095 || n == K_LEFTMOUSE_NM
3096 || n == K_LEFTDRAG
3097 || n == K_LEFTRELEASE
3098 || n == K_LEFTRELEASE_NM
3099 || n == K_MIDDLEMOUSE
3100 || n == K_MIDDLEDRAG
3101 || n == K_MIDDLERELEASE
3102 || n == K_RIGHTMOUSE
3103 || n == K_RIGHTDRAG
3104 || n == K_RIGHTRELEASE
3105 || n == K_MOUSEDOWN
3106 || n == K_MOUSEUP
3107 || n == K_X1MOUSE
3108 || n == K_X1DRAG
3109 || n == K_X1RELEASE
3110 || n == K_X2MOUSE
3111 || n == K_X2DRAG
3112 || n == K_X2RELEASE
3113 # ifdef FEAT_GUI
3114 || n == K_VER_SCROLLBAR
3115 || n == K_HOR_SCROLLBAR
3116 # endif
3117 #endif
3120 if (buf[1] == KS_MODIFIER)
3121 mod_mask = buf[2];
3122 len -= 3;
3123 if (len > 0)
3124 mch_memmove(buf, buf + 3, (size_t)len);
3125 continue;
3127 break;
3129 #ifdef FEAT_MBYTE
3130 if (has_mbyte)
3132 if (MB_BYTE2LEN(n) > len)
3133 continue; /* more bytes to get */
3134 buf[len >= CBUFLEN ? CBUFLEN - 1 : len] = NUL;
3135 n = (*mb_ptr2char)(buf);
3137 #endif
3138 #ifdef UNIX
3139 if (n == intr_char)
3140 n = ESC;
3141 #endif
3142 break;
3145 mapped_ctrl_c = save_mapped_ctrl_c;
3146 return n;
3150 * Get a number from the user.
3151 * When "mouse_used" is not NULL allow using the mouse.
3154 get_number(colon, mouse_used)
3155 int colon; /* allow colon to abort */
3156 int *mouse_used;
3158 int n = 0;
3159 int c;
3160 int typed = 0;
3162 if (mouse_used != NULL)
3163 *mouse_used = FALSE;
3165 /* When not printing messages, the user won't know what to type, return a
3166 * zero (as if CR was hit). */
3167 if (msg_silent != 0)
3168 return 0;
3170 #ifdef USE_ON_FLY_SCROLL
3171 dont_scroll = TRUE; /* disallow scrolling here */
3172 #endif
3173 ++no_mapping;
3174 ++allow_keys; /* no mapping here, but recognize keys */
3175 for (;;)
3177 windgoto(msg_row, msg_col);
3178 c = safe_vgetc();
3179 if (VIM_ISDIGIT(c))
3181 n = n * 10 + c - '0';
3182 msg_putchar(c);
3183 ++typed;
3185 else if (c == K_DEL || c == K_KDEL || c == K_BS || c == Ctrl_H)
3187 if (typed > 0)
3189 MSG_PUTS("\b \b");
3190 --typed;
3192 n /= 10;
3194 #ifdef FEAT_MOUSE
3195 else if (mouse_used != NULL && c == K_LEFTMOUSE)
3197 *mouse_used = TRUE;
3198 n = mouse_row + 1;
3199 break;
3201 #endif
3202 else if (n == 0 && c == ':' && colon)
3204 stuffcharReadbuff(':');
3205 if (!exmode_active)
3206 cmdline_row = msg_row;
3207 skip_redraw = TRUE; /* skip redraw once */
3208 do_redraw = FALSE;
3209 break;
3211 else if (c == CAR || c == NL || c == Ctrl_C || c == ESC)
3212 break;
3214 --no_mapping;
3215 --allow_keys;
3216 return n;
3220 * Ask the user to enter a number.
3221 * When "mouse_used" is not NULL allow using the mouse and in that case return
3222 * the line number.
3225 prompt_for_number(mouse_used)
3226 int *mouse_used;
3228 int i;
3229 int save_cmdline_row;
3230 int save_State;
3232 /* When using ":silent" assume that <CR> was entered. */
3233 if (mouse_used != NULL)
3234 MSG_PUTS(_("Type number or click with mouse (<Enter> cancels): "));
3235 else
3236 MSG_PUTS(_("Choice number (<Enter> cancels): "));
3238 /* Set the state such that text can be selected/copied/pasted and we still
3239 * get mouse events. */
3240 save_cmdline_row = cmdline_row;
3241 cmdline_row = 0;
3242 save_State = State;
3243 State = CMDLINE;
3245 i = get_number(TRUE, mouse_used);
3246 if (KeyTyped)
3248 /* don't call wait_return() now */
3249 /* msg_putchar('\n'); */
3250 cmdline_row = msg_row - 1;
3251 need_wait_return = FALSE;
3252 msg_didany = FALSE;
3254 else
3255 cmdline_row = save_cmdline_row;
3256 State = save_State;
3258 return i;
3261 void
3262 msgmore(n)
3263 long n;
3265 long pn;
3267 if (global_busy /* no messages now, wait until global is finished */
3268 || !messaging()) /* 'lazyredraw' set, don't do messages now */
3269 return;
3271 /* We don't want to overwrite another important message, but do overwrite
3272 * a previous "more lines" or "fewer lines" message, so that "5dd" and
3273 * then "put" reports the last action. */
3274 if (keep_msg != NULL && !keep_msg_more)
3275 return;
3277 if (n > 0)
3278 pn = n;
3279 else
3280 pn = -n;
3282 if (pn > p_report)
3284 if (pn == 1)
3286 if (n > 0)
3287 STRCPY(msg_buf, _("1 more line"));
3288 else
3289 STRCPY(msg_buf, _("1 line less"));
3291 else
3293 if (n > 0)
3294 sprintf((char *)msg_buf, _("%ld more lines"), pn);
3295 else
3296 sprintf((char *)msg_buf, _("%ld fewer lines"), pn);
3298 if (got_int)
3299 STRCAT(msg_buf, _(" (Interrupted)"));
3300 if (msg(msg_buf))
3302 set_keep_msg(msg_buf, 0);
3303 keep_msg_more = TRUE;
3309 * flush map and typeahead buffers and give a warning for an error
3311 void
3312 beep_flush()
3314 if (emsg_silent == 0)
3316 flush_buffers(FALSE);
3317 vim_beep();
3322 * give a warning for an error
3324 void
3325 vim_beep()
3327 if (emsg_silent == 0)
3329 if (p_vb
3330 #ifdef FEAT_GUI
3331 /* While the GUI is starting up the termcap is set for the GUI
3332 * but the output still goes to a terminal. */
3333 && !(gui.in_use && gui.starting)
3334 #endif
3337 out_str(T_VB);
3339 else
3341 #ifdef MSDOS
3343 * The number of beeps outputted is reduced to avoid having to wait
3344 * for all the beeps to finish. This is only a problem on systems
3345 * where the beeps don't overlap.
3347 if (beep_count == 0 || beep_count == 10)
3349 out_char(BELL);
3350 beep_count = 1;
3352 else
3353 ++beep_count;
3354 #else
3355 out_char(BELL);
3356 #endif
3359 /* When 'verbose' is set and we are sourcing a script or executing a
3360 * function give the user a hint where the beep comes from. */
3361 if (vim_strchr(p_debug, 'e') != NULL)
3363 msg_source(hl_attr(HLF_W));
3364 msg_attr((char_u *)_("Beep!"), hl_attr(HLF_W));
3370 * To get the "real" home directory:
3371 * - get value of $HOME
3372 * For Unix:
3373 * - go to that directory
3374 * - do mch_dirname() to get the real name of that directory.
3375 * This also works with mounts and links.
3376 * Don't do this for MS-DOS, it will change the "current dir" for a drive.
3378 static char_u *homedir = NULL;
3380 void
3381 init_homedir()
3383 char_u *var;
3385 /* In case we are called a second time (when 'encoding' changes). */
3386 vim_free(homedir);
3387 homedir = NULL;
3389 #ifdef VMS
3390 var = mch_getenv((char_u *)"SYS$LOGIN");
3391 #else
3392 var = mch_getenv((char_u *)"HOME");
3393 #endif
3395 if (var != NULL && *var == NUL) /* empty is same as not set */
3396 var = NULL;
3398 #ifdef WIN3264
3400 * Weird but true: $HOME may contain an indirect reference to another
3401 * variable, esp. "%USERPROFILE%". Happens when $USERPROFILE isn't set
3402 * when $HOME is being set.
3404 if (var != NULL && *var == '%')
3406 char_u *p;
3407 char_u *exp;
3409 p = vim_strchr(var + 1, '%');
3410 if (p != NULL)
3412 vim_strncpy(NameBuff, var + 1, p - (var + 1));
3413 exp = mch_getenv(NameBuff);
3414 if (exp != NULL && *exp != NUL
3415 && STRLEN(exp) + STRLEN(p) < MAXPATHL)
3417 vim_snprintf((char *)NameBuff, MAXPATHL, "%s%s", exp, p + 1);
3418 var = NameBuff;
3419 /* Also set $HOME, it's needed for _viminfo. */
3420 vim_setenv((char_u *)"HOME", NameBuff);
3426 * Typically, $HOME is not defined on Windows, unless the user has
3427 * specifically defined it for Vim's sake. However, on Windows NT
3428 * platforms, $HOMEDRIVE and $HOMEPATH are automatically defined for
3429 * each user. Try constructing $HOME from these.
3431 if (var == NULL)
3433 char_u *homedrive, *homepath;
3435 homedrive = mch_getenv((char_u *)"HOMEDRIVE");
3436 homepath = mch_getenv((char_u *)"HOMEPATH");
3437 if (homedrive != NULL && homepath != NULL
3438 && STRLEN(homedrive) + STRLEN(homepath) < MAXPATHL)
3440 sprintf((char *)NameBuff, "%s%s", homedrive, homepath);
3441 if (NameBuff[0] != NUL)
3443 var = NameBuff;
3444 /* Also set $HOME, it's needed for _viminfo. */
3445 vim_setenv((char_u *)"HOME", NameBuff);
3450 # if defined(FEAT_MBYTE)
3451 if (enc_utf8 && var != NULL)
3453 int len;
3454 char_u *pp;
3456 /* Convert from active codepage to UTF-8. Other conversions are
3457 * not done, because they would fail for non-ASCII characters. */
3458 acp_to_enc(var, (int)STRLEN(var), &pp, &len);
3459 if (pp != NULL)
3461 homedir = pp;
3462 return;
3465 # endif
3466 #endif
3468 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3470 * Default home dir is C:/
3471 * Best assumption we can make in such a situation.
3473 if (var == NULL)
3474 var = "C:/";
3475 #endif
3476 if (var != NULL)
3478 #ifdef UNIX
3480 * Change to the directory and get the actual path. This resolves
3481 * links. Don't do it when we can't return.
3483 if (mch_dirname(NameBuff, MAXPATHL) == OK
3484 && mch_chdir((char *)NameBuff) == 0)
3486 if (!mch_chdir((char *)var) && mch_dirname(IObuff, IOSIZE) == OK)
3487 var = IObuff;
3488 if (mch_chdir((char *)NameBuff) != 0)
3489 EMSG(_(e_prev_dir));
3491 #endif
3492 homedir = vim_strsave(var);
3496 #if defined(EXITFREE) || defined(PROTO)
3497 void
3498 free_homedir()
3500 vim_free(homedir);
3502 #endif
3505 * Expand environment variable with path name.
3506 * "~/" is also expanded, using $HOME. For Unix "~user/" is expanded.
3507 * Skips over "\ ", "\~" and "\$".
3508 * If anything fails no expansion is done and dst equals src.
3510 void
3511 expand_env(src, dst, dstlen)
3512 char_u *src; /* input string e.g. "$HOME/vim.hlp" */
3513 char_u *dst; /* where to put the result */
3514 int dstlen; /* maximum length of the result */
3516 expand_env_esc(src, dst, dstlen, FALSE, NULL);
3519 void
3520 expand_env_esc(srcp, dst, dstlen, esc, startstr)
3521 char_u *srcp; /* input string e.g. "$HOME/vim.hlp" */
3522 char_u *dst; /* where to put the result */
3523 int dstlen; /* maximum length of the result */
3524 int esc; /* escape spaces in expanded variables */
3525 char_u *startstr; /* start again after this (can be NULL) */
3527 char_u *src;
3528 char_u *tail;
3529 int c;
3530 char_u *var;
3531 int copy_char;
3532 int mustfree; /* var was allocated, need to free it later */
3533 int at_start = TRUE; /* at start of a name */
3534 int startstr_len = 0;
3536 if (startstr != NULL)
3537 startstr_len = (int)STRLEN(startstr);
3539 src = skipwhite(srcp);
3540 --dstlen; /* leave one char space for "\," */
3541 while (*src && dstlen > 0)
3543 copy_char = TRUE;
3544 if ((*src == '$'
3545 #ifdef VMS
3546 && at_start
3547 #endif
3549 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3550 || *src == '%'
3551 #endif
3552 || (*src == '~' && at_start))
3554 mustfree = FALSE;
3557 * The variable name is copied into dst temporarily, because it may
3558 * be a string in read-only memory and a NUL needs to be appended.
3560 if (*src != '~') /* environment var */
3562 tail = src + 1;
3563 var = dst;
3564 c = dstlen - 1;
3566 #ifdef UNIX
3567 /* Unix has ${var-name} type environment vars */
3568 if (*tail == '{' && !vim_isIDc('{'))
3570 tail++; /* ignore '{' */
3571 while (c-- > 0 && *tail && *tail != '}')
3572 *var++ = *tail++;
3574 else
3575 #endif
3577 while (c-- > 0 && *tail != NUL && ((vim_isIDc(*tail))
3578 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3579 || (*src == '%' && *tail != '%')
3580 #endif
3583 #ifdef OS2 /* env vars only in uppercase */
3584 *var++ = TOUPPER_LOC(*tail);
3585 tail++; /* toupper() may be a macro! */
3586 #else
3587 *var++ = *tail++;
3588 #endif
3592 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3593 # ifdef UNIX
3594 if (src[1] == '{' && *tail != '}')
3595 # else
3596 if (*src == '%' && *tail != '%')
3597 # endif
3598 var = NULL;
3599 else
3601 # ifdef UNIX
3602 if (src[1] == '{')
3603 # else
3604 if (*src == '%')
3605 #endif
3606 ++tail;
3607 #endif
3608 *var = NUL;
3609 var = vim_getenv(dst, &mustfree);
3610 #if defined(MSDOS) || defined(MSWIN) || defined(OS2) || defined(UNIX)
3612 #endif
3614 /* home directory */
3615 else if ( src[1] == NUL
3616 || vim_ispathsep(src[1])
3617 || vim_strchr((char_u *)" ,\t\n", src[1]) != NULL)
3619 var = homedir;
3620 tail = src + 1;
3622 else /* user directory */
3624 #if defined(UNIX) || (defined(VMS) && defined(USER_HOME))
3626 * Copy ~user to dst[], so we can put a NUL after it.
3628 tail = src;
3629 var = dst;
3630 c = dstlen - 1;
3631 while ( c-- > 0
3632 && *tail
3633 && vim_isfilec(*tail)
3634 && !vim_ispathsep(*tail))
3635 *var++ = *tail++;
3636 *var = NUL;
3637 # ifdef UNIX
3639 * If the system supports getpwnam(), use it.
3640 * Otherwise, or if getpwnam() fails, the shell is used to
3641 * expand ~user. This is slower and may fail if the shell
3642 * does not support ~user (old versions of /bin/sh).
3644 # if defined(HAVE_GETPWNAM) && defined(HAVE_PWD_H)
3646 struct passwd *pw;
3648 /* Note: memory allocated by getpwnam() is never freed.
3649 * Calling endpwent() apparently doesn't help. */
3650 pw = getpwnam((char *)dst + 1);
3651 if (pw != NULL)
3652 var = (char_u *)pw->pw_dir;
3653 else
3654 var = NULL;
3656 if (var == NULL)
3657 # endif
3659 expand_T xpc;
3661 ExpandInit(&xpc);
3662 xpc.xp_context = EXPAND_FILES;
3663 var = ExpandOne(&xpc, dst, NULL,
3664 WILD_ADD_SLASH|WILD_SILENT, WILD_EXPAND_FREE);
3665 mustfree = TRUE;
3668 # else /* !UNIX, thus VMS */
3670 * USER_HOME is a comma-separated list of
3671 * directories to search for the user account in.
3674 char_u test[MAXPATHL], paths[MAXPATHL];
3675 char_u *path, *next_path, *ptr;
3676 struct stat st;
3678 STRCPY(paths, USER_HOME);
3679 next_path = paths;
3680 while (*next_path)
3682 for (path = next_path; *next_path && *next_path != ',';
3683 next_path++);
3684 if (*next_path)
3685 *next_path++ = NUL;
3686 STRCPY(test, path);
3687 STRCAT(test, "/");
3688 STRCAT(test, dst + 1);
3689 if (mch_stat(test, &st) == 0)
3691 var = alloc(STRLEN(test) + 1);
3692 STRCPY(var, test);
3693 mustfree = TRUE;
3694 break;
3698 # endif /* UNIX */
3699 #else
3700 /* cannot expand user's home directory, so don't try */
3701 var = NULL;
3702 tail = (char_u *)""; /* for gcc */
3703 #endif /* UNIX || VMS */
3706 #ifdef BACKSLASH_IN_FILENAME
3707 /* If 'shellslash' is set change backslashes to forward slashes.
3708 * Can't use slash_adjust(), p_ssl may be set temporarily. */
3709 if (p_ssl && var != NULL && vim_strchr(var, '\\') != NULL)
3711 char_u *p = vim_strsave(var);
3713 if (p != NULL)
3715 if (mustfree)
3716 vim_free(var);
3717 var = p;
3718 mustfree = TRUE;
3719 forward_slash(var);
3722 #endif
3724 /* If "var" contains white space, escape it with a backslash.
3725 * Required for ":e ~/tt" when $HOME includes a space. */
3726 if (esc && var != NULL && vim_strpbrk(var, (char_u *)" \t") != NULL)
3728 char_u *p = vim_strsave_escaped(var, (char_u *)" \t");
3730 if (p != NULL)
3732 if (mustfree)
3733 vim_free(var);
3734 var = p;
3735 mustfree = TRUE;
3739 if (var != NULL && *var != NUL
3740 && (STRLEN(var) + STRLEN(tail) + 1 < (unsigned)dstlen))
3742 STRCPY(dst, var);
3743 dstlen -= (int)STRLEN(var);
3744 c = (int)STRLEN(var);
3745 /* if var[] ends in a path separator and tail[] starts
3746 * with it, skip a character */
3747 if (*var != NUL && after_pathsep(dst, dst + c)
3748 #if defined(BACKSLASH_IN_FILENAME) || defined(AMIGA)
3749 && dst[-1] != ':'
3750 #endif
3751 && vim_ispathsep(*tail))
3752 ++tail;
3753 dst += c;
3754 src = tail;
3755 copy_char = FALSE;
3757 if (mustfree)
3758 vim_free(var);
3761 if (copy_char) /* copy at least one char */
3764 * Recognize the start of a new name, for '~'.
3766 at_start = FALSE;
3767 if (src[0] == '\\' && src[1] != NUL)
3769 *dst++ = *src++;
3770 --dstlen;
3772 else if (src[0] == ' ' || src[0] == ',')
3773 at_start = TRUE;
3774 *dst++ = *src++;
3775 --dstlen;
3777 if (startstr != NULL && src - startstr_len >= srcp
3778 && STRNCMP(src - startstr_len, startstr, startstr_len) == 0)
3779 at_start = TRUE;
3782 *dst = NUL;
3786 * Vim's version of getenv().
3787 * Special handling of $HOME, $VIM and $VIMRUNTIME.
3788 * Also does ACP to 'enc' conversion for Win32.
3790 char_u *
3791 vim_getenv(name, mustfree)
3792 char_u *name;
3793 int *mustfree; /* set to TRUE when returned is allocated */
3795 char_u *p;
3796 char_u *pend;
3797 int vimruntime;
3799 #if defined(OS2) || defined(MSDOS) || defined(MSWIN)
3800 /* use "C:/" when $HOME is not set */
3801 if (STRCMP(name, "HOME") == 0)
3802 return homedir;
3803 #endif
3805 p = mch_getenv(name);
3806 if (p != NULL && *p == NUL) /* empty is the same as not set */
3807 p = NULL;
3809 if (p != NULL)
3811 #if defined(FEAT_MBYTE) && defined(WIN3264)
3812 if (enc_utf8)
3814 int len;
3815 char_u *pp;
3817 /* Convert from active codepage to UTF-8. Other conversions are
3818 * not done, because they would fail for non-ASCII characters. */
3819 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3820 if (pp != NULL)
3822 p = pp;
3823 *mustfree = TRUE;
3826 #endif
3827 return p;
3830 vimruntime = (STRCMP(name, "VIMRUNTIME") == 0);
3831 if (!vimruntime && STRCMP(name, "VIM") != 0)
3832 return NULL;
3835 * When expanding $VIMRUNTIME fails, try using $VIM/vim<version> or $VIM.
3836 * Don't do this when default_vimruntime_dir is non-empty.
3838 if (vimruntime
3839 #ifdef HAVE_PATHDEF
3840 && *default_vimruntime_dir == NUL
3841 #endif
3844 p = mch_getenv((char_u *)"VIM");
3845 if (p != NULL && *p == NUL) /* empty is the same as not set */
3846 p = NULL;
3847 if (p != NULL)
3849 p = vim_version_dir(p);
3850 if (p != NULL)
3851 *mustfree = TRUE;
3852 else
3853 p = mch_getenv((char_u *)"VIM");
3855 #if defined(FEAT_MBYTE) && defined(WIN3264)
3856 if (enc_utf8)
3858 int len;
3859 char_u *pp;
3861 /* Convert from active codepage to UTF-8. Other conversions
3862 * are not done, because they would fail for non-ASCII
3863 * characters. */
3864 acp_to_enc(p, (int)STRLEN(p), &pp, &len);
3865 if (pp != NULL)
3867 if (mustfree)
3868 vim_free(p);
3869 p = pp;
3870 *mustfree = TRUE;
3873 #endif
3878 * When expanding $VIM or $VIMRUNTIME fails, try using:
3879 * - the directory name from 'helpfile' (unless it contains '$')
3880 * - the executable name from argv[0]
3882 if (p == NULL)
3884 if (p_hf != NULL && vim_strchr(p_hf, '$') == NULL)
3885 p = p_hf;
3886 #ifdef USE_EXE_NAME
3888 * Use the name of the executable, obtained from argv[0].
3890 else
3891 p = exe_name;
3892 #endif
3893 if (p != NULL)
3895 /* remove the file name */
3896 pend = gettail(p);
3898 /* remove "doc/" from 'helpfile', if present */
3899 if (p == p_hf)
3900 pend = remove_tail(p, pend, (char_u *)"doc");
3902 #ifdef USE_EXE_NAME
3903 # ifdef MACOS_X
3904 /* remove "MacOS" from exe_name and add "Resources/vim" */
3905 if (p == exe_name)
3907 char_u *pend1;
3908 char_u *pnew;
3910 pend1 = remove_tail(p, pend, (char_u *)"MacOS");
3911 if (pend1 != pend)
3913 pnew = alloc((unsigned)(pend1 - p) + 15);
3914 if (pnew != NULL)
3916 STRNCPY(pnew, p, (pend1 - p));
3917 STRCPY(pnew + (pend1 - p), "Resources/vim");
3918 p = pnew;
3919 pend = p + STRLEN(p);
3923 # endif
3924 /* remove "src/" from exe_name, if present */
3925 if (p == exe_name)
3926 pend = remove_tail(p, pend, (char_u *)"src");
3927 #endif
3929 /* for $VIM, remove "runtime/" or "vim54/", if present */
3930 if (!vimruntime)
3932 pend = remove_tail(p, pend, (char_u *)RUNTIME_DIRNAME);
3933 pend = remove_tail(p, pend, (char_u *)VIM_VERSION_NODOT);
3936 /* remove trailing path separator */
3937 #ifndef MACOS_CLASSIC
3938 /* With MacOS path (with colons) the final colon is required */
3939 /* to avoid confusion between absoulute and relative path */
3940 if (pend > p && after_pathsep(p, pend))
3941 --pend;
3942 #endif
3944 #ifdef MACOS_X
3945 if (p == exe_name || p == p_hf)
3946 #endif
3947 /* check that the result is a directory name */
3948 p = vim_strnsave(p, (int)(pend - p));
3950 if (p != NULL && !mch_isdir(p))
3952 vim_free(p);
3953 p = NULL;
3955 else
3957 #ifdef USE_EXE_NAME
3958 /* may add "/vim54" or "/runtime" if it exists */
3959 if (vimruntime && (pend = vim_version_dir(p)) != NULL)
3961 vim_free(p);
3962 p = pend;
3964 #endif
3965 *mustfree = TRUE;
3970 #ifdef HAVE_PATHDEF
3971 /* When there is a pathdef.c file we can use default_vim_dir and
3972 * default_vimruntime_dir */
3973 if (p == NULL)
3975 /* Only use default_vimruntime_dir when it is not empty */
3976 if (vimruntime && *default_vimruntime_dir != NUL)
3978 p = default_vimruntime_dir;
3979 *mustfree = FALSE;
3981 else if (*default_vim_dir != NUL)
3983 if (vimruntime && (p = vim_version_dir(default_vim_dir)) != NULL)
3984 *mustfree = TRUE;
3985 else
3987 p = default_vim_dir;
3988 *mustfree = FALSE;
3992 #endif
3995 * Set the environment variable, so that the new value can be found fast
3996 * next time, and others can also use it (e.g. Perl).
3998 if (p != NULL)
4000 if (vimruntime)
4002 vim_setenv((char_u *)"VIMRUNTIME", p);
4003 didset_vimruntime = TRUE;
4004 #ifdef FEAT_GETTEXT
4006 char_u *buf = concat_str(p, (char_u *)"/lang");
4008 if (buf != NULL)
4010 bindtextdomain(VIMPACKAGE, (char *)buf);
4011 vim_free(buf);
4014 #endif
4016 else
4018 vim_setenv((char_u *)"VIM", p);
4019 didset_vim = TRUE;
4022 return p;
4026 * Check if the directory "vimdir/<version>" or "vimdir/runtime" exists.
4027 * Return NULL if not, return its name in allocated memory otherwise.
4029 static char_u *
4030 vim_version_dir(vimdir)
4031 char_u *vimdir;
4033 char_u *p;
4035 if (vimdir == NULL || *vimdir == NUL)
4036 return NULL;
4037 p = concat_fnames(vimdir, (char_u *)VIM_VERSION_NODOT, TRUE);
4038 if (p != NULL && mch_isdir(p))
4039 return p;
4040 vim_free(p);
4041 p = concat_fnames(vimdir, (char_u *)RUNTIME_DIRNAME, TRUE);
4042 if (p != NULL && mch_isdir(p))
4043 return p;
4044 vim_free(p);
4045 return NULL;
4049 * If the string between "p" and "pend" ends in "name/", return "pend" minus
4050 * the length of "name/". Otherwise return "pend".
4052 static char_u *
4053 remove_tail(p, pend, name)
4054 char_u *p;
4055 char_u *pend;
4056 char_u *name;
4058 int len = (int)STRLEN(name) + 1;
4059 char_u *newend = pend - len;
4061 if (newend >= p
4062 && fnamencmp(newend, name, len - 1) == 0
4063 && (newend == p || after_pathsep(p, newend)))
4064 return newend;
4065 return pend;
4069 * Call expand_env() and store the result in an allocated string.
4070 * This is not very memory efficient, this expects the result to be freed
4071 * again soon.
4073 char_u *
4074 expand_env_save(src)
4075 char_u *src;
4077 char_u *p;
4079 p = alloc(MAXPATHL);
4080 if (p != NULL)
4081 expand_env(src, p, MAXPATHL);
4082 return p;
4086 * Our portable version of setenv.
4088 void
4089 vim_setenv(name, val)
4090 char_u *name;
4091 char_u *val;
4093 #ifdef HAVE_SETENV
4094 mch_setenv((char *)name, (char *)val, 1);
4095 #else
4096 char_u *envbuf;
4099 * Putenv does not copy the string, it has to remain
4100 * valid. The allocated memory will never be freed.
4102 envbuf = alloc((unsigned)(STRLEN(name) + STRLEN(val) + 2));
4103 if (envbuf != NULL)
4105 sprintf((char *)envbuf, "%s=%s", name, val);
4106 putenv((char *)envbuf);
4108 #endif
4111 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4113 * Function given to ExpandGeneric() to obtain an environment variable name.
4115 /*ARGSUSED*/
4116 char_u *
4117 get_env_name(xp, idx)
4118 expand_T *xp;
4119 int idx;
4121 # if defined(AMIGA) || defined(__MRC__) || defined(__SC__)
4123 * No environ[] on the Amiga and on the Mac (using MPW).
4125 return NULL;
4126 # else
4127 # ifndef __WIN32__
4128 /* Borland C++ 5.2 has this in a header file. */
4129 extern char **environ;
4130 # endif
4131 # define ENVNAMELEN 100
4132 static char_u name[ENVNAMELEN];
4133 char_u *str;
4134 int n;
4136 str = (char_u *)environ[idx];
4137 if (str == NULL)
4138 return NULL;
4140 for (n = 0; n < ENVNAMELEN - 1; ++n)
4142 if (str[n] == '=' || str[n] == NUL)
4143 break;
4144 name[n] = str[n];
4146 name[n] = NUL;
4147 return name;
4148 # endif
4150 #endif
4153 * Replace home directory by "~" in each space or comma separated file name in
4154 * 'src'.
4155 * If anything fails (except when out of space) dst equals src.
4157 void
4158 home_replace(buf, src, dst, dstlen, one)
4159 buf_T *buf; /* when not NULL, check for help files */
4160 char_u *src; /* input file name */
4161 char_u *dst; /* where to put the result */
4162 int dstlen; /* maximum length of the result */
4163 int one; /* if TRUE, only replace one file name, include
4164 spaces and commas in the file name. */
4166 size_t dirlen = 0, envlen = 0;
4167 size_t len;
4168 char_u *homedir_env;
4169 char_u *p;
4171 if (src == NULL)
4173 *dst = NUL;
4174 return;
4178 * If the file is a help file, remove the path completely.
4180 if (buf != NULL && buf->b_help)
4182 STRCPY(dst, gettail(src));
4183 return;
4187 * We check both the value of the $HOME environment variable and the
4188 * "real" home directory.
4190 if (homedir != NULL)
4191 dirlen = STRLEN(homedir);
4193 #ifdef VMS
4194 homedir_env = mch_getenv((char_u *)"SYS$LOGIN");
4195 #else
4196 homedir_env = mch_getenv((char_u *)"HOME");
4197 #endif
4199 if (homedir_env != NULL && *homedir_env == NUL)
4200 homedir_env = NULL;
4201 if (homedir_env != NULL)
4202 envlen = STRLEN(homedir_env);
4204 if (!one)
4205 src = skipwhite(src);
4206 while (*src && dstlen > 0)
4209 * Here we are at the beginning of a file name.
4210 * First, check to see if the beginning of the file name matches
4211 * $HOME or the "real" home directory. Check that there is a '/'
4212 * after the match (so that if e.g. the file is "/home/pieter/bla",
4213 * and the home directory is "/home/piet", the file does not end up
4214 * as "~er/bla" (which would seem to indicate the file "bla" in user
4215 * er's home directory)).
4217 p = homedir;
4218 len = dirlen;
4219 for (;;)
4221 if ( len
4222 && fnamencmp(src, p, len) == 0
4223 && (vim_ispathsep(src[len])
4224 || (!one && (src[len] == ',' || src[len] == ' '))
4225 || src[len] == NUL))
4227 src += len;
4228 if (--dstlen > 0)
4229 *dst++ = '~';
4232 * If it's just the home directory, add "/".
4234 if (!vim_ispathsep(src[0]) && --dstlen > 0)
4235 *dst++ = '/';
4236 break;
4238 if (p == homedir_env)
4239 break;
4240 p = homedir_env;
4241 len = envlen;
4244 /* if (!one) skip to separator: space or comma */
4245 while (*src && (one || (*src != ',' && *src != ' ')) && --dstlen > 0)
4246 *dst++ = *src++;
4247 /* skip separator */
4248 while ((*src == ' ' || *src == ',') && --dstlen > 0)
4249 *dst++ = *src++;
4251 /* if (dstlen == 0) out of space, what to do??? */
4253 *dst = NUL;
4257 * Like home_replace, store the replaced string in allocated memory.
4258 * When something fails, NULL is returned.
4260 char_u *
4261 home_replace_save(buf, src)
4262 buf_T *buf; /* when not NULL, check for help files */
4263 char_u *src; /* input file name */
4265 char_u *dst;
4266 unsigned len;
4268 len = 3; /* space for "~/" and trailing NUL */
4269 if (src != NULL) /* just in case */
4270 len += (unsigned)STRLEN(src);
4271 dst = alloc(len);
4272 if (dst != NULL)
4273 home_replace(buf, src, dst, len, TRUE);
4274 return dst;
4278 * Compare two file names and return:
4279 * FPC_SAME if they both exist and are the same file.
4280 * FPC_SAMEX if they both don't exist and have the same file name.
4281 * FPC_DIFF if they both exist and are different files.
4282 * FPC_NOTX if they both don't exist.
4283 * FPC_DIFFX if one of them doesn't exist.
4284 * For the first name environment variables are expanded
4287 fullpathcmp(s1, s2, checkname)
4288 char_u *s1, *s2;
4289 int checkname; /* when both don't exist, check file names */
4291 #ifdef UNIX
4292 char_u exp1[MAXPATHL];
4293 char_u full1[MAXPATHL];
4294 char_u full2[MAXPATHL];
4295 struct stat st1, st2;
4296 int r1, r2;
4298 expand_env(s1, exp1, MAXPATHL);
4299 r1 = mch_stat((char *)exp1, &st1);
4300 r2 = mch_stat((char *)s2, &st2);
4301 if (r1 != 0 && r2 != 0)
4303 /* if mch_stat() doesn't work, may compare the names */
4304 if (checkname)
4306 if (fnamecmp(exp1, s2) == 0)
4307 return FPC_SAMEX;
4308 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4309 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4310 if (r1 == OK && r2 == OK && fnamecmp(full1, full2) == 0)
4311 return FPC_SAMEX;
4313 return FPC_NOTX;
4315 if (r1 != 0 || r2 != 0)
4316 return FPC_DIFFX;
4317 if (st1.st_dev == st2.st_dev && st1.st_ino == st2.st_ino)
4318 return FPC_SAME;
4319 return FPC_DIFF;
4320 #else
4321 char_u *exp1; /* expanded s1 */
4322 char_u *full1; /* full path of s1 */
4323 char_u *full2; /* full path of s2 */
4324 int retval = FPC_DIFF;
4325 int r1, r2;
4327 /* allocate one buffer to store three paths (alloc()/free() is slow!) */
4328 if ((exp1 = alloc(MAXPATHL * 3)) != NULL)
4330 full1 = exp1 + MAXPATHL;
4331 full2 = full1 + MAXPATHL;
4333 expand_env(s1, exp1, MAXPATHL);
4334 r1 = vim_FullName(exp1, full1, MAXPATHL, FALSE);
4335 r2 = vim_FullName(s2, full2, MAXPATHL, FALSE);
4337 /* If vim_FullName() fails, the file probably doesn't exist. */
4338 if (r1 != OK && r2 != OK)
4340 if (checkname && fnamecmp(exp1, s2) == 0)
4341 retval = FPC_SAMEX;
4342 else
4343 retval = FPC_NOTX;
4345 else if (r1 != OK || r2 != OK)
4346 retval = FPC_DIFFX;
4347 else if (fnamecmp(full1, full2))
4348 retval = FPC_DIFF;
4349 else
4350 retval = FPC_SAME;
4351 vim_free(exp1);
4353 return retval;
4354 #endif
4358 * Get the tail of a path: the file name.
4359 * Fail safe: never returns NULL.
4361 char_u *
4362 gettail(fname)
4363 char_u *fname;
4365 char_u *p1, *p2;
4367 if (fname == NULL)
4368 return (char_u *)"";
4369 for (p1 = p2 = fname; *p2; ) /* find last part of path */
4371 if (vim_ispathsep(*p2))
4372 p1 = p2 + 1;
4373 mb_ptr_adv(p2);
4375 return p1;
4379 * Get pointer to tail of "fname", including path separators. Putting a NUL
4380 * here leaves the directory name. Takes care of "c:/" and "//".
4381 * Always returns a valid pointer.
4383 char_u *
4384 gettail_sep(fname)
4385 char_u *fname;
4387 char_u *p;
4388 char_u *t;
4390 p = get_past_head(fname); /* don't remove the '/' from "c:/file" */
4391 t = gettail(fname);
4392 while (t > p && after_pathsep(fname, t))
4393 --t;
4394 #ifdef VMS
4395 /* path separator is part of the path */
4396 ++t;
4397 #endif
4398 return t;
4402 * get the next path component (just after the next path separator).
4404 char_u *
4405 getnextcomp(fname)
4406 char_u *fname;
4408 while (*fname && !vim_ispathsep(*fname))
4409 mb_ptr_adv(fname);
4410 if (*fname)
4411 ++fname;
4412 return fname;
4416 * Get a pointer to one character past the head of a path name.
4417 * Unix: after "/"; DOS: after "c:\"; Amiga: after "disk:/"; Mac: no head.
4418 * If there is no head, path is returned.
4420 char_u *
4421 get_past_head(path)
4422 char_u *path;
4424 char_u *retval;
4426 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4427 /* may skip "c:" */
4428 if (isalpha(path[0]) && path[1] == ':')
4429 retval = path + 2;
4430 else
4431 retval = path;
4432 #else
4433 # if defined(AMIGA)
4434 /* may skip "label:" */
4435 retval = vim_strchr(path, ':');
4436 if (retval == NULL)
4437 retval = path;
4438 # else /* Unix */
4439 retval = path;
4440 # endif
4441 #endif
4443 while (vim_ispathsep(*retval))
4444 ++retval;
4446 return retval;
4450 * return TRUE if 'c' is a path separator.
4453 vim_ispathsep(c)
4454 int c;
4456 #ifdef RISCOS
4457 return (c == '.' || c == ':');
4458 #else
4459 # ifdef UNIX
4460 return (c == '/'); /* UNIX has ':' inside file names */
4461 # else
4462 # ifdef BACKSLASH_IN_FILENAME
4463 return (c == ':' || c == '/' || c == '\\');
4464 # else
4465 # ifdef VMS
4466 /* server"user passwd"::device:[full.path.name]fname.extension;version" */
4467 return (c == ':' || c == '[' || c == ']' || c == '/'
4468 || c == '<' || c == '>' || c == '"' );
4469 # else /* Amiga */
4470 return (c == ':' || c == '/');
4471 # endif /* VMS */
4472 # endif
4473 # endif
4474 #endif /* RISC OS */
4477 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
4479 * return TRUE if 'c' is a path list separator.
4482 vim_ispathlistsep(c)
4483 int c;
4485 #ifdef UNIX
4486 return (c == ':');
4487 #else
4488 return (c == ';'); /* might not be right for every system... */
4489 #endif
4491 #endif
4493 #if defined(FEAT_GUI_TABLINE) || defined(FEAT_WINDOWS) \
4494 || defined(FEAT_EVAL) || defined(PROTO)
4496 * Shorten the path of a file from "~/foo/../.bar/fname" to "~/f/../.b/fname"
4497 * It's done in-place.
4499 void
4500 shorten_dir(str)
4501 char_u *str;
4503 char_u *tail, *s, *d;
4504 int skip = FALSE;
4506 tail = gettail(str);
4507 d = str;
4508 for (s = str; ; ++s)
4510 if (s >= tail) /* copy the whole tail */
4512 *d++ = *s;
4513 if (*s == NUL)
4514 break;
4516 else if (vim_ispathsep(*s)) /* copy '/' and next char */
4518 *d++ = *s;
4519 skip = FALSE;
4521 else if (!skip)
4523 *d++ = *s; /* copy next char */
4524 if (*s != '~' && *s != '.') /* and leading "~" and "." */
4525 skip = TRUE;
4526 # ifdef FEAT_MBYTE
4527 if (has_mbyte)
4529 int l = mb_ptr2len(s);
4531 while (--l > 0)
4532 *d++ = *++s;
4534 # endif
4538 #endif
4541 * Return TRUE if the directory of "fname" exists, FALSE otherwise.
4542 * Also returns TRUE if there is no directory name.
4543 * "fname" must be writable!.
4546 dir_of_file_exists(fname)
4547 char_u *fname;
4549 char_u *p;
4550 int c;
4551 int retval;
4553 p = gettail_sep(fname);
4554 if (p == fname)
4555 return TRUE;
4556 c = *p;
4557 *p = NUL;
4558 retval = mch_isdir(fname);
4559 *p = c;
4560 return retval;
4563 #if (defined(CASE_INSENSITIVE_FILENAME) && defined(BACKSLASH_IN_FILENAME)) \
4564 || defined(PROTO)
4566 * Versions of fnamecmp() and fnamencmp() that handle '/' and '\' equally.
4569 vim_fnamecmp(x, y)
4570 char_u *x, *y;
4572 return vim_fnamencmp(x, y, MAXPATHL);
4576 vim_fnamencmp(x, y, len)
4577 char_u *x, *y;
4578 size_t len;
4580 while (len > 0 && *x && *y)
4582 if (TOLOWER_LOC(*x) != TOLOWER_LOC(*y)
4583 && !(*x == '/' && *y == '\\')
4584 && !(*x == '\\' && *y == '/'))
4585 break;
4586 ++x;
4587 ++y;
4588 --len;
4590 if (len == 0)
4591 return 0;
4592 return (*x - *y);
4594 #endif
4597 * Concatenate file names fname1 and fname2 into allocated memory.
4598 * Only add a '/' or '\\' when 'sep' is TRUE and it is necessary.
4600 char_u *
4601 concat_fnames(fname1, fname2, sep)
4602 char_u *fname1;
4603 char_u *fname2;
4604 int sep;
4606 char_u *dest;
4608 dest = alloc((unsigned)(STRLEN(fname1) + STRLEN(fname2) + 3));
4609 if (dest != NULL)
4611 STRCPY(dest, fname1);
4612 if (sep)
4613 add_pathsep(dest);
4614 STRCAT(dest, fname2);
4616 return dest;
4619 #if defined(FEAT_EVAL) || defined(FEAT_GETTEXT) || defined(PROTO)
4621 * Concatenate two strings and return the result in allocated memory.
4622 * Returns NULL when out of memory.
4624 char_u *
4625 concat_str(str1, str2)
4626 char_u *str1;
4627 char_u *str2;
4629 char_u *dest;
4630 size_t l = STRLEN(str1);
4632 dest = alloc((unsigned)(l + STRLEN(str2) + 1L));
4633 if (dest != NULL)
4635 STRCPY(dest, str1);
4636 STRCPY(dest + l, str2);
4638 return dest;
4640 #endif
4643 * Add a path separator to a file name, unless it already ends in a path
4644 * separator.
4646 void
4647 add_pathsep(p)
4648 char_u *p;
4650 if (*p != NUL && !after_pathsep(p, p + STRLEN(p)))
4651 STRCAT(p, PATHSEPSTR);
4655 * FullName_save - Make an allocated copy of a full file name.
4656 * Returns NULL when out of memory.
4658 char_u *
4659 FullName_save(fname, force)
4660 char_u *fname;
4661 int force; /* force expansion, even when it already looks
4662 like a full path name */
4664 char_u *buf;
4665 char_u *new_fname = NULL;
4667 if (fname == NULL)
4668 return NULL;
4670 buf = alloc((unsigned)MAXPATHL);
4671 if (buf != NULL)
4673 if (vim_FullName(fname, buf, MAXPATHL, force) != FAIL)
4674 new_fname = vim_strsave(buf);
4675 else
4676 new_fname = vim_strsave(fname);
4677 vim_free(buf);
4679 return new_fname;
4682 #if defined(FEAT_CINDENT) || defined(FEAT_SYN_HL)
4684 static char_u *skip_string __ARGS((char_u *p));
4687 * Find the start of a comment, not knowing if we are in a comment right now.
4688 * Search starts at w_cursor.lnum and goes backwards.
4690 pos_T *
4691 find_start_comment(ind_maxcomment) /* XXX */
4692 int ind_maxcomment;
4694 pos_T *pos;
4695 char_u *line;
4696 char_u *p;
4697 int cur_maxcomment = ind_maxcomment;
4699 for (;;)
4701 pos = findmatchlimit(NULL, '*', FM_BACKWARD, cur_maxcomment);
4702 if (pos == NULL)
4703 break;
4706 * Check if the comment start we found is inside a string.
4707 * If it is then restrict the search to below this line and try again.
4709 line = ml_get(pos->lnum);
4710 for (p = line; *p && (unsigned)(p - line) < pos->col; ++p)
4711 p = skip_string(p);
4712 if ((unsigned)(p - line) <= pos->col)
4713 break;
4714 cur_maxcomment = curwin->w_cursor.lnum - pos->lnum - 1;
4715 if (cur_maxcomment <= 0)
4717 pos = NULL;
4718 break;
4721 return pos;
4725 * Skip to the end of a "string" and a 'c' character.
4726 * If there is no string or character, return argument unmodified.
4728 static char_u *
4729 skip_string(p)
4730 char_u *p;
4732 int i;
4735 * We loop, because strings may be concatenated: "date""time".
4737 for ( ; ; ++p)
4739 if (p[0] == '\'') /* 'c' or '\n' or '\000' */
4741 if (!p[1]) /* ' at end of line */
4742 break;
4743 i = 2;
4744 if (p[1] == '\\') /* '\n' or '\000' */
4746 ++i;
4747 while (vim_isdigit(p[i - 1])) /* '\000' */
4748 ++i;
4750 if (p[i] == '\'') /* check for trailing ' */
4752 p += i;
4753 continue;
4756 else if (p[0] == '"') /* start of string */
4758 for (++p; p[0]; ++p)
4760 if (p[0] == '\\' && p[1] != NUL)
4761 ++p;
4762 else if (p[0] == '"') /* end of string */
4763 break;
4765 if (p[0] == '"')
4766 continue;
4768 break; /* no string found */
4770 if (!*p)
4771 --p; /* backup from NUL */
4772 return p;
4774 #endif /* FEAT_CINDENT || FEAT_SYN_HL */
4776 #if defined(FEAT_CINDENT) || defined(PROTO)
4779 * Do C or expression indenting on the current line.
4781 void
4782 do_c_expr_indent()
4784 # ifdef FEAT_EVAL
4785 if (*curbuf->b_p_inde != NUL)
4786 fixthisline(get_expr_indent);
4787 else
4788 # endif
4789 fixthisline(get_c_indent);
4793 * Functions for C-indenting.
4794 * Most of this originally comes from Eric Fischer.
4797 * Below "XXX" means that this function may unlock the current line.
4800 static char_u *cin_skipcomment __ARGS((char_u *));
4801 static int cin_nocode __ARGS((char_u *));
4802 static pos_T *find_line_comment __ARGS((void));
4803 static int cin_islabel_skip __ARGS((char_u **));
4804 static int cin_isdefault __ARGS((char_u *));
4805 static char_u *after_label __ARGS((char_u *l));
4806 static int get_indent_nolabel __ARGS((linenr_T lnum));
4807 static int skip_label __ARGS((linenr_T, char_u **pp, int ind_maxcomment));
4808 static int cin_first_id_amount __ARGS((void));
4809 static int cin_get_equal_amount __ARGS((linenr_T lnum));
4810 static int cin_ispreproc __ARGS((char_u *));
4811 static int cin_ispreproc_cont __ARGS((char_u **pp, linenr_T *lnump));
4812 static int cin_iscomment __ARGS((char_u *));
4813 static int cin_islinecomment __ARGS((char_u *));
4814 static int cin_isterminated __ARGS((char_u *, int, int));
4815 static int cin_isinit __ARGS((void));
4816 static int cin_isfuncdecl __ARGS((char_u **, linenr_T));
4817 static int cin_isif __ARGS((char_u *));
4818 static int cin_iselse __ARGS((char_u *));
4819 static int cin_isdo __ARGS((char_u *));
4820 static int cin_iswhileofdo __ARGS((char_u *, linenr_T, int));
4821 static int cin_iswhileofdo_end __ARGS((int terminated, int ind_maxparen, int ind_maxcomment));
4822 static int cin_isbreak __ARGS((char_u *));
4823 static int cin_is_cpp_baseclass __ARGS((char_u *line, colnr_T *col));
4824 static int get_baseclass_amount __ARGS((int col, int ind_maxparen, int ind_maxcomment, int ind_cpp_baseclass));
4825 static int cin_ends_in __ARGS((char_u *, char_u *, char_u *));
4826 static int cin_skip2pos __ARGS((pos_T *trypos));
4827 static pos_T *find_start_brace __ARGS((int));
4828 static pos_T *find_match_paren __ARGS((int, int));
4829 static int corr_ind_maxparen __ARGS((int ind_maxparen, pos_T *startpos));
4830 static int find_last_paren __ARGS((char_u *l, int start, int end));
4831 static int find_match __ARGS((int lookfor, linenr_T ourscope, int ind_maxparen, int ind_maxcomment));
4833 static int ind_hash_comment = 0; /* # starts a comment */
4836 * Skip over white space and C comments within the line.
4837 * Also skip over Perl/shell comments if desired.
4839 static char_u *
4840 cin_skipcomment(s)
4841 char_u *s;
4843 while (*s)
4845 char_u *prev_s = s;
4847 s = skipwhite(s);
4849 /* Perl/shell # comment comment continues until eol. Require a space
4850 * before # to avoid recognizing $#array. */
4851 if (ind_hash_comment != 0 && s != prev_s && *s == '#')
4853 s += STRLEN(s);
4854 break;
4856 if (*s != '/')
4857 break;
4858 ++s;
4859 if (*s == '/') /* slash-slash comment continues till eol */
4861 s += STRLEN(s);
4862 break;
4864 if (*s != '*')
4865 break;
4866 for (++s; *s; ++s) /* skip slash-star comment */
4867 if (s[0] == '*' && s[1] == '/')
4869 s += 2;
4870 break;
4873 return s;
4877 * Return TRUE if there there is no code at *s. White space and comments are
4878 * not considered code.
4880 static int
4881 cin_nocode(s)
4882 char_u *s;
4884 return *cin_skipcomment(s) == NUL;
4888 * Check previous lines for a "//" line comment, skipping over blank lines.
4890 static pos_T *
4891 find_line_comment() /* XXX */
4893 static pos_T pos;
4894 char_u *line;
4895 char_u *p;
4897 pos = curwin->w_cursor;
4898 while (--pos.lnum > 0)
4900 line = ml_get(pos.lnum);
4901 p = skipwhite(line);
4902 if (cin_islinecomment(p))
4904 pos.col = (int)(p - line);
4905 return &pos;
4907 if (*p != NUL)
4908 break;
4910 return NULL;
4914 * Check if string matches "label:"; move to character after ':' if true.
4916 static int
4917 cin_islabel_skip(s)
4918 char_u **s;
4920 if (!vim_isIDc(**s)) /* need at least one ID character */
4921 return FALSE;
4923 while (vim_isIDc(**s))
4924 (*s)++;
4926 *s = cin_skipcomment(*s);
4928 /* "::" is not a label, it's C++ */
4929 return (**s == ':' && *++*s != ':');
4933 * Recognize a label: "label:".
4934 * Note: curwin->w_cursor must be where we are looking for the label.
4937 cin_islabel(ind_maxcomment) /* XXX */
4938 int ind_maxcomment;
4940 char_u *s;
4942 s = cin_skipcomment(ml_get_curline());
4945 * Exclude "default" from labels, since it should be indented
4946 * like a switch label. Same for C++ scope declarations.
4948 if (cin_isdefault(s))
4949 return FALSE;
4950 if (cin_isscopedecl(s))
4951 return FALSE;
4953 if (cin_islabel_skip(&s))
4956 * Only accept a label if the previous line is terminated or is a case
4957 * label.
4959 pos_T cursor_save;
4960 pos_T *trypos;
4961 char_u *line;
4963 cursor_save = curwin->w_cursor;
4964 while (curwin->w_cursor.lnum > 1)
4966 --curwin->w_cursor.lnum;
4969 * If we're in a comment now, skip to the start of the comment.
4971 curwin->w_cursor.col = 0;
4972 if ((trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
4973 curwin->w_cursor = *trypos;
4975 line = ml_get_curline();
4976 if (cin_ispreproc(line)) /* ignore #defines, #if, etc. */
4977 continue;
4978 if (*(line = cin_skipcomment(line)) == NUL)
4979 continue;
4981 curwin->w_cursor = cursor_save;
4982 if (cin_isterminated(line, TRUE, FALSE)
4983 || cin_isscopedecl(line)
4984 || cin_iscase(line)
4985 || (cin_islabel_skip(&line) && cin_nocode(line)))
4986 return TRUE;
4987 return FALSE;
4989 curwin->w_cursor = cursor_save;
4990 return TRUE; /* label at start of file??? */
4992 return FALSE;
4996 * Recognize structure initialization and enumerations.
4997 * Q&D-Implementation:
4998 * check for "=" at end or "[typedef] enum" at beginning of line.
5000 static int
5001 cin_isinit(void)
5003 char_u *s;
5005 s = cin_skipcomment(ml_get_curline());
5007 if (STRNCMP(s, "typedef", 7) == 0 && !vim_isIDc(s[7]))
5008 s = cin_skipcomment(s + 7);
5010 if (STRNCMP(s, "enum", 4) == 0 && !vim_isIDc(s[4]))
5011 return TRUE;
5013 if (cin_ends_in(s, (char_u *)"=", (char_u *)"{"))
5014 return TRUE;
5016 return FALSE;
5020 * Recognize a switch label: "case .*:" or "default:".
5023 cin_iscase(s)
5024 char_u *s;
5026 s = cin_skipcomment(s);
5027 if (STRNCMP(s, "case", 4) == 0 && !vim_isIDc(s[4]))
5029 for (s += 4; *s; ++s)
5031 s = cin_skipcomment(s);
5032 if (*s == ':')
5034 if (s[1] == ':') /* skip over "::" for C++ */
5035 ++s;
5036 else
5037 return TRUE;
5039 if (*s == '\'' && s[1] && s[2] == '\'')
5040 s += 2; /* skip over '.' */
5041 else if (*s == '/' && (s[1] == '*' || s[1] == '/'))
5042 return FALSE; /* stop at comment */
5043 else if (*s == '"')
5044 return FALSE; /* stop at string */
5046 return FALSE;
5049 if (cin_isdefault(s))
5050 return TRUE;
5051 return FALSE;
5055 * Recognize a "default" switch label.
5057 static int
5058 cin_isdefault(s)
5059 char_u *s;
5061 return (STRNCMP(s, "default", 7) == 0
5062 && *(s = cin_skipcomment(s + 7)) == ':'
5063 && s[1] != ':');
5067 * Recognize a "public/private/proctected" scope declaration label.
5070 cin_isscopedecl(s)
5071 char_u *s;
5073 int i;
5075 s = cin_skipcomment(s);
5076 if (STRNCMP(s, "public", 6) == 0)
5077 i = 6;
5078 else if (STRNCMP(s, "protected", 9) == 0)
5079 i = 9;
5080 else if (STRNCMP(s, "private", 7) == 0)
5081 i = 7;
5082 else
5083 return FALSE;
5084 return (*(s = cin_skipcomment(s + i)) == ':' && s[1] != ':');
5088 * Return a pointer to the first non-empty non-comment character after a ':'.
5089 * Return NULL if not found.
5090 * case 234: a = b;
5093 static char_u *
5094 after_label(l)
5095 char_u *l;
5097 for ( ; *l; ++l)
5099 if (*l == ':')
5101 if (l[1] == ':') /* skip over "::" for C++ */
5102 ++l;
5103 else if (!cin_iscase(l + 1))
5104 break;
5106 else if (*l == '\'' && l[1] && l[2] == '\'')
5107 l += 2; /* skip over 'x' */
5109 if (*l == NUL)
5110 return NULL;
5111 l = cin_skipcomment(l + 1);
5112 if (*l == NUL)
5113 return NULL;
5114 return l;
5118 * Get indent of line "lnum", skipping a label.
5119 * Return 0 if there is nothing after the label.
5121 static int
5122 get_indent_nolabel(lnum) /* XXX */
5123 linenr_T lnum;
5125 char_u *l;
5126 pos_T fp;
5127 colnr_T col;
5128 char_u *p;
5130 l = ml_get(lnum);
5131 p = after_label(l);
5132 if (p == NULL)
5133 return 0;
5135 fp.col = (colnr_T)(p - l);
5136 fp.lnum = lnum;
5137 getvcol(curwin, &fp, &col, NULL, NULL);
5138 return (int)col;
5142 * Find indent for line "lnum", ignoring any case or jump label.
5143 * Also return a pointer to the text (after the label) in "pp".
5144 * label: if (asdf && asdfasdf)
5147 static int
5148 skip_label(lnum, pp, ind_maxcomment)
5149 linenr_T lnum;
5150 char_u **pp;
5151 int ind_maxcomment;
5153 char_u *l;
5154 int amount;
5155 pos_T cursor_save;
5157 cursor_save = curwin->w_cursor;
5158 curwin->w_cursor.lnum = lnum;
5159 l = ml_get_curline();
5160 /* XXX */
5161 if (cin_iscase(l) || cin_isscopedecl(l) || cin_islabel(ind_maxcomment))
5163 amount = get_indent_nolabel(lnum);
5164 l = after_label(ml_get_curline());
5165 if (l == NULL) /* just in case */
5166 l = ml_get_curline();
5168 else
5170 amount = get_indent();
5171 l = ml_get_curline();
5173 *pp = l;
5175 curwin->w_cursor = cursor_save;
5176 return amount;
5180 * Return the indent of the first variable name after a type in a declaration.
5181 * int a, indent of "a"
5182 * static struct foo b, indent of "b"
5183 * enum bla c, indent of "c"
5184 * Returns zero when it doesn't look like a declaration.
5186 static int
5187 cin_first_id_amount()
5189 char_u *line, *p, *s;
5190 int len;
5191 pos_T fp;
5192 colnr_T col;
5194 line = ml_get_curline();
5195 p = skipwhite(line);
5196 len = (int)(skiptowhite(p) - p);
5197 if (len == 6 && STRNCMP(p, "static", 6) == 0)
5199 p = skipwhite(p + 6);
5200 len = (int)(skiptowhite(p) - p);
5202 if (len == 6 && STRNCMP(p, "struct", 6) == 0)
5203 p = skipwhite(p + 6);
5204 else if (len == 4 && STRNCMP(p, "enum", 4) == 0)
5205 p = skipwhite(p + 4);
5206 else if ((len == 8 && STRNCMP(p, "unsigned", 8) == 0)
5207 || (len == 6 && STRNCMP(p, "signed", 6) == 0))
5209 s = skipwhite(p + len);
5210 if ((STRNCMP(s, "int", 3) == 0 && vim_iswhite(s[3]))
5211 || (STRNCMP(s, "long", 4) == 0 && vim_iswhite(s[4]))
5212 || (STRNCMP(s, "short", 5) == 0 && vim_iswhite(s[5]))
5213 || (STRNCMP(s, "char", 4) == 0 && vim_iswhite(s[4])))
5214 p = s;
5216 for (len = 0; vim_isIDc(p[len]); ++len)
5218 if (len == 0 || !vim_iswhite(p[len]) || cin_nocode(p))
5219 return 0;
5221 p = skipwhite(p + len);
5222 fp.lnum = curwin->w_cursor.lnum;
5223 fp.col = (colnr_T)(p - line);
5224 getvcol(curwin, &fp, &col, NULL, NULL);
5225 return (int)col;
5229 * Return the indent of the first non-blank after an equal sign.
5230 * char *foo = "here";
5231 * Return zero if no (useful) equal sign found.
5232 * Return -1 if the line above "lnum" ends in a backslash.
5233 * foo = "asdf\
5234 * asdf\
5235 * here";
5237 static int
5238 cin_get_equal_amount(lnum)
5239 linenr_T lnum;
5241 char_u *line;
5242 char_u *s;
5243 colnr_T col;
5244 pos_T fp;
5246 if (lnum > 1)
5248 line = ml_get(lnum - 1);
5249 if (*line != NUL && line[STRLEN(line) - 1] == '\\')
5250 return -1;
5253 line = s = ml_get(lnum);
5254 while (*s != NUL && vim_strchr((char_u *)"=;{}\"'", *s) == NULL)
5256 if (cin_iscomment(s)) /* ignore comments */
5257 s = cin_skipcomment(s);
5258 else
5259 ++s;
5261 if (*s != '=')
5262 return 0;
5264 s = skipwhite(s + 1);
5265 if (cin_nocode(s))
5266 return 0;
5268 if (*s == '"') /* nice alignment for continued strings */
5269 ++s;
5271 fp.lnum = lnum;
5272 fp.col = (colnr_T)(s - line);
5273 getvcol(curwin, &fp, &col, NULL, NULL);
5274 return (int)col;
5278 * Recognize a preprocessor statement: Any line that starts with '#'.
5280 static int
5281 cin_ispreproc(s)
5282 char_u *s;
5284 s = skipwhite(s);
5285 if (*s == '#')
5286 return TRUE;
5287 return FALSE;
5291 * Return TRUE if line "*pp" at "*lnump" is a preprocessor statement or a
5292 * continuation line of a preprocessor statement. Decrease "*lnump" to the
5293 * start and return the line in "*pp".
5295 static int
5296 cin_ispreproc_cont(pp, lnump)
5297 char_u **pp;
5298 linenr_T *lnump;
5300 char_u *line = *pp;
5301 linenr_T lnum = *lnump;
5302 int retval = FALSE;
5304 for (;;)
5306 if (cin_ispreproc(line))
5308 retval = TRUE;
5309 *lnump = lnum;
5310 break;
5312 if (lnum == 1)
5313 break;
5314 line = ml_get(--lnum);
5315 if (*line == NUL || line[STRLEN(line) - 1] != '\\')
5316 break;
5319 if (lnum != *lnump)
5320 *pp = ml_get(*lnump);
5321 return retval;
5325 * Recognize the start of a C or C++ comment.
5327 static int
5328 cin_iscomment(p)
5329 char_u *p;
5331 return (p[0] == '/' && (p[1] == '*' || p[1] == '/'));
5335 * Recognize the start of a "//" comment.
5337 static int
5338 cin_islinecomment(p)
5339 char_u *p;
5341 return (p[0] == '/' && p[1] == '/');
5345 * Recognize a line that starts with '{' or '}', or ends with ';', '{' or '}'.
5346 * Don't consider "} else" a terminated line.
5347 * Return the character terminating the line (ending char's have precedence if
5348 * both apply in order to determine initializations).
5350 static int
5351 cin_isterminated(s, incl_open, incl_comma)
5352 char_u *s;
5353 int incl_open; /* include '{' at the end as terminator */
5354 int incl_comma; /* recognize a trailing comma */
5356 char_u found_start = 0;
5358 s = cin_skipcomment(s);
5360 if (*s == '{' || (*s == '}' && !cin_iselse(s)))
5361 found_start = *s;
5363 while (*s)
5365 /* skip over comments, "" strings and 'c'haracters */
5366 s = skip_string(cin_skipcomment(s));
5367 if ((*s == ';' || (incl_open && *s == '{') || *s == '}'
5368 || (incl_comma && *s == ','))
5369 && cin_nocode(s + 1))
5370 return *s;
5372 if (*s)
5373 s++;
5375 return found_start;
5379 * Recognize the basic picture of a function declaration -- it needs to
5380 * have an open paren somewhere and a close paren at the end of the line and
5381 * no semicolons anywhere.
5382 * When a line ends in a comma we continue looking in the next line.
5383 * "sp" points to a string with the line. When looking at other lines it must
5384 * be restored to the line. When it's NULL fetch lines here.
5385 * "lnum" is where we start looking.
5387 static int
5388 cin_isfuncdecl(sp, first_lnum)
5389 char_u **sp;
5390 linenr_T first_lnum;
5392 char_u *s;
5393 linenr_T lnum = first_lnum;
5394 int retval = FALSE;
5396 if (sp == NULL)
5397 s = ml_get(lnum);
5398 else
5399 s = *sp;
5401 while (*s && *s != '(' && *s != ';' && *s != '\'' && *s != '"')
5403 if (cin_iscomment(s)) /* ignore comments */
5404 s = cin_skipcomment(s);
5405 else
5406 ++s;
5408 if (*s != '(')
5409 return FALSE; /* ';', ' or " before any () or no '(' */
5411 while (*s && *s != ';' && *s != '\'' && *s != '"')
5413 if (*s == ')' && cin_nocode(s + 1))
5415 /* ')' at the end: may have found a match
5416 * Check for he previous line not to end in a backslash:
5417 * #if defined(x) && \
5418 * defined(y)
5420 lnum = first_lnum - 1;
5421 s = ml_get(lnum);
5422 if (*s == NUL || s[STRLEN(s) - 1] != '\\')
5423 retval = TRUE;
5424 goto done;
5426 if (*s == ',' && cin_nocode(s + 1))
5428 /* ',' at the end: continue looking in the next line */
5429 if (lnum >= curbuf->b_ml.ml_line_count)
5430 break;
5432 s = ml_get(++lnum);
5434 else if (cin_iscomment(s)) /* ignore comments */
5435 s = cin_skipcomment(s);
5436 else
5437 ++s;
5440 done:
5441 if (lnum != first_lnum && sp != NULL)
5442 *sp = ml_get(first_lnum);
5444 return retval;
5447 static int
5448 cin_isif(p)
5449 char_u *p;
5451 return (STRNCMP(p, "if", 2) == 0 && !vim_isIDc(p[2]));
5454 static int
5455 cin_iselse(p)
5456 char_u *p;
5458 if (*p == '}') /* accept "} else" */
5459 p = cin_skipcomment(p + 1);
5460 return (STRNCMP(p, "else", 4) == 0 && !vim_isIDc(p[4]));
5463 static int
5464 cin_isdo(p)
5465 char_u *p;
5467 return (STRNCMP(p, "do", 2) == 0 && !vim_isIDc(p[2]));
5471 * Check if this is a "while" that should have a matching "do".
5472 * We only accept a "while (condition) ;", with only white space between the
5473 * ')' and ';'. The condition may be spread over several lines.
5475 static int
5476 cin_iswhileofdo(p, lnum, ind_maxparen) /* XXX */
5477 char_u *p;
5478 linenr_T lnum;
5479 int ind_maxparen;
5481 pos_T cursor_save;
5482 pos_T *trypos;
5483 int retval = FALSE;
5485 p = cin_skipcomment(p);
5486 if (*p == '}') /* accept "} while (cond);" */
5487 p = cin_skipcomment(p + 1);
5488 if (STRNCMP(p, "while", 5) == 0 && !vim_isIDc(p[5]))
5490 cursor_save = curwin->w_cursor;
5491 curwin->w_cursor.lnum = lnum;
5492 curwin->w_cursor.col = 0;
5493 p = ml_get_curline();
5494 while (*p && *p != 'w') /* skip any '}', until the 'w' of the "while" */
5496 ++p;
5497 ++curwin->w_cursor.col;
5499 if ((trypos = findmatchlimit(NULL, 0, 0, ind_maxparen)) != NULL
5500 && *cin_skipcomment(ml_get_pos(trypos) + 1) == ';')
5501 retval = TRUE;
5502 curwin->w_cursor = cursor_save;
5504 return retval;
5508 * Return TRUE if we are at the end of a do-while.
5509 * do
5510 * nothing;
5511 * while (foo
5512 * && bar); <-- here
5513 * Adjust the cursor to the line with "while".
5515 static int
5516 cin_iswhileofdo_end(terminated, ind_maxparen, ind_maxcomment)
5517 int terminated;
5518 int ind_maxparen;
5519 int ind_maxcomment;
5521 char_u *line;
5522 char_u *p;
5523 char_u *s;
5524 pos_T *trypos;
5525 int i;
5527 if (terminated != ';') /* there must be a ';' at the end */
5528 return FALSE;
5530 p = line = ml_get_curline();
5531 while (*p != NUL)
5533 p = cin_skipcomment(p);
5534 if (*p == ')')
5536 s = skipwhite(p + 1);
5537 if (*s == ';' && cin_nocode(s + 1))
5539 /* Found ");" at end of the line, now check there is "while"
5540 * before the matching '('. XXX */
5541 i = (int)(p - line);
5542 curwin->w_cursor.col = i;
5543 trypos = find_match_paren(ind_maxparen, ind_maxcomment);
5544 if (trypos != NULL)
5546 s = cin_skipcomment(ml_get(trypos->lnum));
5547 if (*s == '}') /* accept "} while (cond);" */
5548 s = cin_skipcomment(s + 1);
5549 if (STRNCMP(s, "while", 5) == 0 && !vim_isIDc(s[5]))
5551 curwin->w_cursor.lnum = trypos->lnum;
5552 return TRUE;
5556 /* Searching may have made "line" invalid, get it again. */
5557 line = ml_get_curline();
5558 p = line + i;
5561 if (*p != NUL)
5562 ++p;
5564 return FALSE;
5567 static int
5568 cin_isbreak(p)
5569 char_u *p;
5571 return (STRNCMP(p, "break", 5) == 0 && !vim_isIDc(p[5]));
5575 * Find the position of a C++ base-class declaration or
5576 * constructor-initialization. eg:
5578 * class MyClass :
5579 * baseClass <-- here
5580 * class MyClass : public baseClass,
5581 * anotherBaseClass <-- here (should probably lineup ??)
5582 * MyClass::MyClass(...) :
5583 * baseClass(...) <-- here (constructor-initialization)
5585 * This is a lot of guessing. Watch out for "cond ? func() : foo".
5587 static int
5588 cin_is_cpp_baseclass(line, col)
5589 char_u *line;
5590 colnr_T *col; /* return: column to align with */
5592 char_u *s;
5593 int class_or_struct, lookfor_ctor_init, cpp_base_class;
5594 linenr_T lnum = curwin->w_cursor.lnum;
5596 *col = 0;
5598 s = skipwhite(line);
5599 if (*s == '#') /* skip #define FOO x ? (x) : x */
5600 return FALSE;
5601 s = cin_skipcomment(s);
5602 if (*s == NUL)
5603 return FALSE;
5605 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5607 /* Search for a line starting with '#', empty, ending in ';' or containing
5608 * '{' or '}' and start below it. This handles the following situations:
5609 * a = cond ?
5610 * func() :
5611 * asdf;
5612 * func::foo()
5613 * : something
5614 * {}
5615 * Foo::Foo (int one, int two)
5616 * : something(4),
5617 * somethingelse(3)
5618 * {}
5620 while (lnum > 1)
5622 s = skipwhite(ml_get(lnum - 1));
5623 if (*s == '#' || *s == NUL)
5624 break;
5625 while (*s != NUL)
5627 s = cin_skipcomment(s);
5628 if (*s == '{' || *s == '}'
5629 || (*s == ';' && cin_nocode(s + 1)))
5630 break;
5631 if (*s != NUL)
5632 ++s;
5634 if (*s != NUL)
5635 break;
5636 --lnum;
5639 s = cin_skipcomment(ml_get(lnum));
5640 for (;;)
5642 if (*s == NUL)
5644 if (lnum == curwin->w_cursor.lnum)
5645 break;
5646 /* Continue in the cursor line. */
5647 s = cin_skipcomment(ml_get(++lnum));
5650 if (s[0] == ':')
5652 if (s[1] == ':')
5654 /* skip double colon. It can't be a constructor
5655 * initialization any more */
5656 lookfor_ctor_init = FALSE;
5657 s = cin_skipcomment(s + 2);
5659 else if (lookfor_ctor_init || class_or_struct)
5661 /* we have something found, that looks like the start of
5662 * cpp-base-class-declaration or contructor-initialization */
5663 cpp_base_class = TRUE;
5664 lookfor_ctor_init = class_or_struct = FALSE;
5665 *col = 0;
5666 s = cin_skipcomment(s + 1);
5668 else
5669 s = cin_skipcomment(s + 1);
5671 else if ((STRNCMP(s, "class", 5) == 0 && !vim_isIDc(s[5]))
5672 || (STRNCMP(s, "struct", 6) == 0 && !vim_isIDc(s[6])))
5674 class_or_struct = TRUE;
5675 lookfor_ctor_init = FALSE;
5677 if (*s == 'c')
5678 s = cin_skipcomment(s + 5);
5679 else
5680 s = cin_skipcomment(s + 6);
5682 else
5684 if (s[0] == '{' || s[0] == '}' || s[0] == ';')
5686 cpp_base_class = lookfor_ctor_init = class_or_struct = FALSE;
5688 else if (s[0] == ')')
5690 /* Constructor-initialization is assumed if we come across
5691 * something like "):" */
5692 class_or_struct = FALSE;
5693 lookfor_ctor_init = TRUE;
5695 else if (s[0] == '?')
5697 /* Avoid seeing '() :' after '?' as constructor init. */
5698 return FALSE;
5700 else if (!vim_isIDc(s[0]))
5702 /* if it is not an identifier, we are wrong */
5703 class_or_struct = FALSE;
5704 lookfor_ctor_init = FALSE;
5706 else if (*col == 0)
5708 /* it can't be a constructor-initialization any more */
5709 lookfor_ctor_init = FALSE;
5711 /* the first statement starts here: lineup with this one... */
5712 if (cpp_base_class)
5713 *col = (colnr_T)(s - line);
5716 /* When the line ends in a comma don't align with it. */
5717 if (lnum == curwin->w_cursor.lnum && *s == ',' && cin_nocode(s + 1))
5718 *col = 0;
5720 s = cin_skipcomment(s + 1);
5724 return cpp_base_class;
5727 static int
5728 get_baseclass_amount(col, ind_maxparen, ind_maxcomment, ind_cpp_baseclass)
5729 int col;
5730 int ind_maxparen;
5731 int ind_maxcomment;
5732 int ind_cpp_baseclass;
5734 int amount;
5735 colnr_T vcol;
5736 pos_T *trypos;
5738 if (col == 0)
5740 amount = get_indent();
5741 if (find_last_paren(ml_get_curline(), '(', ')')
5742 && (trypos = find_match_paren(ind_maxparen,
5743 ind_maxcomment)) != NULL)
5744 amount = get_indent_lnum(trypos->lnum); /* XXX */
5745 if (!cin_ends_in(ml_get_curline(), (char_u *)",", NULL))
5746 amount += ind_cpp_baseclass;
5748 else
5750 curwin->w_cursor.col = col;
5751 getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
5752 amount = (int)vcol;
5754 if (amount < ind_cpp_baseclass)
5755 amount = ind_cpp_baseclass;
5756 return amount;
5760 * Return TRUE if string "s" ends with the string "find", possibly followed by
5761 * white space and comments. Skip strings and comments.
5762 * Ignore "ignore" after "find" if it's not NULL.
5764 static int
5765 cin_ends_in(s, find, ignore)
5766 char_u *s;
5767 char_u *find;
5768 char_u *ignore;
5770 char_u *p = s;
5771 char_u *r;
5772 int len = (int)STRLEN(find);
5774 while (*p != NUL)
5776 p = cin_skipcomment(p);
5777 if (STRNCMP(p, find, len) == 0)
5779 r = skipwhite(p + len);
5780 if (ignore != NULL && STRNCMP(r, ignore, STRLEN(ignore)) == 0)
5781 r = skipwhite(r + STRLEN(ignore));
5782 if (cin_nocode(r))
5783 return TRUE;
5785 if (*p != NUL)
5786 ++p;
5788 return FALSE;
5792 * Skip strings, chars and comments until at or past "trypos".
5793 * Return the column found.
5795 static int
5796 cin_skip2pos(trypos)
5797 pos_T *trypos;
5799 char_u *line;
5800 char_u *p;
5802 p = line = ml_get(trypos->lnum);
5803 while (*p && (colnr_T)(p - line) < trypos->col)
5805 if (cin_iscomment(p))
5806 p = cin_skipcomment(p);
5807 else
5809 p = skip_string(p);
5810 ++p;
5813 return (int)(p - line);
5817 * Find the '{' at the start of the block we are in.
5818 * Return NULL if no match found.
5819 * Ignore a '{' that is in a comment, makes indenting the next three lines
5820 * work. */
5821 /* foo() */
5822 /* { */
5823 /* } */
5825 static pos_T *
5826 find_start_brace(ind_maxcomment) /* XXX */
5827 int ind_maxcomment;
5829 pos_T cursor_save;
5830 pos_T *trypos;
5831 pos_T *pos;
5832 static pos_T pos_copy;
5834 cursor_save = curwin->w_cursor;
5835 while ((trypos = findmatchlimit(NULL, '{', FM_BLOCKSTOP, 0)) != NULL)
5837 pos_copy = *trypos; /* copy pos_T, next findmatch will change it */
5838 trypos = &pos_copy;
5839 curwin->w_cursor = *trypos;
5840 pos = NULL;
5841 /* ignore the { if it's in a // or / * * / comment */
5842 if ((colnr_T)cin_skip2pos(trypos) == trypos->col
5843 && (pos = find_start_comment(ind_maxcomment)) == NULL) /* XXX */
5844 break;
5845 if (pos != NULL)
5846 curwin->w_cursor.lnum = pos->lnum;
5848 curwin->w_cursor = cursor_save;
5849 return trypos;
5853 * Find the matching '(', failing if it is in a comment.
5854 * Return NULL of no match found.
5856 static pos_T *
5857 find_match_paren(ind_maxparen, ind_maxcomment) /* XXX */
5858 int ind_maxparen;
5859 int ind_maxcomment;
5861 pos_T cursor_save;
5862 pos_T *trypos;
5863 static pos_T pos_copy;
5865 cursor_save = curwin->w_cursor;
5866 if ((trypos = findmatchlimit(NULL, '(', 0, ind_maxparen)) != NULL)
5868 /* check if the ( is in a // comment */
5869 if ((colnr_T)cin_skip2pos(trypos) > trypos->col)
5870 trypos = NULL;
5871 else
5873 pos_copy = *trypos; /* copy trypos, findmatch will change it */
5874 trypos = &pos_copy;
5875 curwin->w_cursor = *trypos;
5876 if (find_start_comment(ind_maxcomment) != NULL) /* XXX */
5877 trypos = NULL;
5880 curwin->w_cursor = cursor_save;
5881 return trypos;
5885 * Return ind_maxparen corrected for the difference in line number between the
5886 * cursor position and "startpos". This makes sure that searching for a
5887 * matching paren above the cursor line doesn't find a match because of
5888 * looking a few lines further.
5890 static int
5891 corr_ind_maxparen(ind_maxparen, startpos)
5892 int ind_maxparen;
5893 pos_T *startpos;
5895 long n = (long)startpos->lnum - (long)curwin->w_cursor.lnum;
5897 if (n > 0 && n < ind_maxparen / 2)
5898 return ind_maxparen - (int)n;
5899 return ind_maxparen;
5903 * Set w_cursor.col to the column number of the last unmatched ')' or '{' in
5904 * line "l".
5906 static int
5907 find_last_paren(l, start, end)
5908 char_u *l;
5909 int start, end;
5911 int i;
5912 int retval = FALSE;
5913 int open_count = 0;
5915 curwin->w_cursor.col = 0; /* default is start of line */
5917 for (i = 0; l[i]; i++)
5919 i = (int)(cin_skipcomment(l + i) - l); /* ignore parens in comments */
5920 i = (int)(skip_string(l + i) - l); /* ignore parens in quotes */
5921 if (l[i] == start)
5922 ++open_count;
5923 else if (l[i] == end)
5925 if (open_count > 0)
5926 --open_count;
5927 else
5929 curwin->w_cursor.col = i;
5930 retval = TRUE;
5934 return retval;
5938 get_c_indent()
5941 * spaces from a block's opening brace the prevailing indent for that
5942 * block should be
5944 int ind_level = curbuf->b_p_sw;
5947 * spaces from the edge of the line an open brace that's at the end of a
5948 * line is imagined to be.
5950 int ind_open_imag = 0;
5953 * spaces from the prevailing indent for a line that is not precededof by
5954 * an opening brace.
5956 int ind_no_brace = 0;
5959 * column where the first { of a function should be located }
5961 int ind_first_open = 0;
5964 * spaces from the prevailing indent a leftmost open brace should be
5965 * located
5967 int ind_open_extra = 0;
5970 * spaces from the matching open brace (real location for one at the left
5971 * edge; imaginary location from one that ends a line) the matching close
5972 * brace should be located
5974 int ind_close_extra = 0;
5977 * spaces from the edge of the line an open brace sitting in the leftmost
5978 * column is imagined to be
5980 int ind_open_left_imag = 0;
5983 * spaces from the switch() indent a "case xx" label should be located
5985 int ind_case = curbuf->b_p_sw;
5988 * spaces from the "case xx:" code after a switch() should be located
5990 int ind_case_code = curbuf->b_p_sw;
5993 * lineup break at end of case in switch() with case label
5995 int ind_case_break = 0;
5998 * spaces from the class declaration indent a scope declaration label
5999 * should be located
6001 int ind_scopedecl = curbuf->b_p_sw;
6004 * spaces from the scope declaration label code should be located
6006 int ind_scopedecl_code = curbuf->b_p_sw;
6009 * amount K&R-style parameters should be indented
6011 int ind_param = curbuf->b_p_sw;
6014 * amount a function type spec should be indented
6016 int ind_func_type = curbuf->b_p_sw;
6019 * amount a cpp base class declaration or constructor initialization
6020 * should be indented
6022 int ind_cpp_baseclass = curbuf->b_p_sw;
6025 * additional spaces beyond the prevailing indent a continuation line
6026 * should be located
6028 int ind_continuation = curbuf->b_p_sw;
6031 * spaces from the indent of the line with an unclosed parentheses
6033 int ind_unclosed = curbuf->b_p_sw * 2;
6036 * spaces from the indent of the line with an unclosed parentheses, which
6037 * itself is also unclosed
6039 int ind_unclosed2 = curbuf->b_p_sw;
6042 * suppress ignoring spaces from the indent of a line starting with an
6043 * unclosed parentheses.
6045 int ind_unclosed_noignore = 0;
6048 * If the opening paren is the last nonwhite character on the line, and
6049 * ind_unclosed_wrapped is nonzero, use this indent relative to the outer
6050 * context (for very long lines).
6052 int ind_unclosed_wrapped = 0;
6055 * suppress ignoring white space when lining up with the character after
6056 * an unclosed parentheses.
6058 int ind_unclosed_whiteok = 0;
6061 * indent a closing parentheses under the line start of the matching
6062 * opening parentheses.
6064 int ind_matching_paren = 0;
6067 * indent a closing parentheses under the previous line.
6069 int ind_paren_prev = 0;
6072 * Extra indent for comments.
6074 int ind_comment = 0;
6077 * spaces from the comment opener when there is nothing after it.
6079 int ind_in_comment = 3;
6082 * boolean: if non-zero, use ind_in_comment even if there is something
6083 * after the comment opener.
6085 int ind_in_comment2 = 0;
6088 * max lines to search for an open paren
6090 int ind_maxparen = 20;
6093 * max lines to search for an open comment
6095 int ind_maxcomment = 70;
6098 * handle braces for java code
6100 int ind_java = 0;
6103 * handle blocked cases correctly
6105 int ind_keep_case_label = 0;
6107 pos_T cur_curpos;
6108 int amount;
6109 int scope_amount;
6110 int cur_amount = MAXCOL;
6111 colnr_T col;
6112 char_u *theline;
6113 char_u *linecopy;
6114 pos_T *trypos;
6115 pos_T *tryposBrace = NULL;
6116 pos_T our_paren_pos;
6117 char_u *start;
6118 int start_brace;
6119 #define BRACE_IN_COL0 1 /* '{' is in comumn 0 */
6120 #define BRACE_AT_START 2 /* '{' is at start of line */
6121 #define BRACE_AT_END 3 /* '{' is at end of line */
6122 linenr_T ourscope;
6123 char_u *l;
6124 char_u *look;
6125 char_u terminated;
6126 int lookfor;
6127 #define LOOKFOR_INITIAL 0
6128 #define LOOKFOR_IF 1
6129 #define LOOKFOR_DO 2
6130 #define LOOKFOR_CASE 3
6131 #define LOOKFOR_ANY 4
6132 #define LOOKFOR_TERM 5
6133 #define LOOKFOR_UNTERM 6
6134 #define LOOKFOR_SCOPEDECL 7
6135 #define LOOKFOR_NOBREAK 8
6136 #define LOOKFOR_CPP_BASECLASS 9
6137 #define LOOKFOR_ENUM_OR_INIT 10
6139 int whilelevel;
6140 linenr_T lnum;
6141 char_u *options;
6142 int fraction = 0; /* init for GCC */
6143 int divider;
6144 int n;
6145 int iscase;
6146 int lookfor_break;
6147 int cont_amount = 0; /* amount for continuation line */
6149 for (options = curbuf->b_p_cino; *options; )
6151 l = options++;
6152 if (*options == '-')
6153 ++options;
6154 n = getdigits(&options);
6155 divider = 0;
6156 if (*options == '.') /* ".5s" means a fraction */
6158 fraction = atol((char *)++options);
6159 while (VIM_ISDIGIT(*options))
6161 ++options;
6162 if (divider)
6163 divider *= 10;
6164 else
6165 divider = 10;
6168 if (*options == 's') /* "2s" means two times 'shiftwidth' */
6170 if (n == 0 && fraction == 0)
6171 n = curbuf->b_p_sw; /* just "s" is one 'shiftwidth' */
6172 else
6174 n *= curbuf->b_p_sw;
6175 if (divider)
6176 n += (curbuf->b_p_sw * fraction + divider / 2) / divider;
6178 ++options;
6180 if (l[1] == '-')
6181 n = -n;
6182 /* When adding an entry here, also update the default 'cinoptions' in
6183 * doc/indent.txt, and add explanation for it! */
6184 switch (*l)
6186 case '>': ind_level = n; break;
6187 case 'e': ind_open_imag = n; break;
6188 case 'n': ind_no_brace = n; break;
6189 case 'f': ind_first_open = n; break;
6190 case '{': ind_open_extra = n; break;
6191 case '}': ind_close_extra = n; break;
6192 case '^': ind_open_left_imag = n; break;
6193 case ':': ind_case = n; break;
6194 case '=': ind_case_code = n; break;
6195 case 'b': ind_case_break = n; break;
6196 case 'p': ind_param = n; break;
6197 case 't': ind_func_type = n; break;
6198 case '/': ind_comment = n; break;
6199 case 'c': ind_in_comment = n; break;
6200 case 'C': ind_in_comment2 = n; break;
6201 case 'i': ind_cpp_baseclass = n; break;
6202 case '+': ind_continuation = n; break;
6203 case '(': ind_unclosed = n; break;
6204 case 'u': ind_unclosed2 = n; break;
6205 case 'U': ind_unclosed_noignore = n; break;
6206 case 'W': ind_unclosed_wrapped = n; break;
6207 case 'w': ind_unclosed_whiteok = n; break;
6208 case 'm': ind_matching_paren = n; break;
6209 case 'M': ind_paren_prev = n; break;
6210 case ')': ind_maxparen = n; break;
6211 case '*': ind_maxcomment = n; break;
6212 case 'g': ind_scopedecl = n; break;
6213 case 'h': ind_scopedecl_code = n; break;
6214 case 'j': ind_java = n; break;
6215 case 'l': ind_keep_case_label = n; break;
6216 case '#': ind_hash_comment = n; break;
6220 /* remember where the cursor was when we started */
6221 cur_curpos = curwin->w_cursor;
6223 /* Get a copy of the current contents of the line.
6224 * This is required, because only the most recent line obtained with
6225 * ml_get is valid! */
6226 linecopy = vim_strsave(ml_get(cur_curpos.lnum));
6227 if (linecopy == NULL)
6228 return 0;
6231 * In insert mode and the cursor is on a ')' truncate the line at the
6232 * cursor position. We don't want to line up with the matching '(' when
6233 * inserting new stuff.
6234 * For unknown reasons the cursor might be past the end of the line, thus
6235 * check for that.
6237 if ((State & INSERT)
6238 && curwin->w_cursor.col < STRLEN(linecopy)
6239 && linecopy[curwin->w_cursor.col] == ')')
6240 linecopy[curwin->w_cursor.col] = NUL;
6242 theline = skipwhite(linecopy);
6244 /* move the cursor to the start of the line */
6246 curwin->w_cursor.col = 0;
6249 * #defines and so on always go at the left when included in 'cinkeys'.
6251 if (*theline == '#' && (*linecopy == '#' || in_cinkeys('#', ' ', TRUE)))
6253 amount = 0;
6257 * Is it a non-case label? Then that goes at the left margin too.
6259 else if (cin_islabel(ind_maxcomment)) /* XXX */
6261 amount = 0;
6265 * If we're inside a "//" comment and there is a "//" comment in a
6266 * previous line, lineup with that one.
6268 else if (cin_islinecomment(theline)
6269 && (trypos = find_line_comment()) != NULL) /* XXX */
6271 /* find how indented the line beginning the comment is */
6272 getvcol(curwin, trypos, &col, NULL, NULL);
6273 amount = col;
6277 * If we're inside a comment and not looking at the start of the
6278 * comment, try using the 'comments' option.
6280 else if (!cin_iscomment(theline)
6281 && (trypos = find_start_comment(ind_maxcomment)) != NULL) /* XXX */
6283 int lead_start_len = 2;
6284 int lead_middle_len = 1;
6285 char_u lead_start[COM_MAX_LEN]; /* start-comment string */
6286 char_u lead_middle[COM_MAX_LEN]; /* middle-comment string */
6287 char_u lead_end[COM_MAX_LEN]; /* end-comment string */
6288 char_u *p;
6289 int start_align = 0;
6290 int start_off = 0;
6291 int done = FALSE;
6293 /* find how indented the line beginning the comment is */
6294 getvcol(curwin, trypos, &col, NULL, NULL);
6295 amount = col;
6297 p = curbuf->b_p_com;
6298 while (*p != NUL)
6300 int align = 0;
6301 int off = 0;
6302 int what = 0;
6304 while (*p != NUL && *p != ':')
6306 if (*p == COM_START || *p == COM_END || *p == COM_MIDDLE)
6307 what = *p++;
6308 else if (*p == COM_LEFT || *p == COM_RIGHT)
6309 align = *p++;
6310 else if (VIM_ISDIGIT(*p) || *p == '-')
6311 off = getdigits(&p);
6312 else
6313 ++p;
6316 if (*p == ':')
6317 ++p;
6318 (void)copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6319 if (what == COM_START)
6321 STRCPY(lead_start, lead_end);
6322 lead_start_len = (int)STRLEN(lead_start);
6323 start_off = off;
6324 start_align = align;
6326 else if (what == COM_MIDDLE)
6328 STRCPY(lead_middle, lead_end);
6329 lead_middle_len = (int)STRLEN(lead_middle);
6331 else if (what == COM_END)
6333 /* If our line starts with the middle comment string, line it
6334 * up with the comment opener per the 'comments' option. */
6335 if (STRNCMP(theline, lead_middle, lead_middle_len) == 0
6336 && STRNCMP(theline, lead_end, STRLEN(lead_end)) != 0)
6338 done = TRUE;
6339 if (curwin->w_cursor.lnum > 1)
6341 /* If the start comment string matches in the previous
6342 * line, use the indent of that line pluss offset. If
6343 * the middle comment string matches in the previous
6344 * line, use the indent of that line. XXX */
6345 look = skipwhite(ml_get(curwin->w_cursor.lnum - 1));
6346 if (STRNCMP(look, lead_start, lead_start_len) == 0)
6347 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6348 else if (STRNCMP(look, lead_middle,
6349 lead_middle_len) == 0)
6351 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6352 break;
6354 /* If the start comment string doesn't match with the
6355 * start of the comment, skip this entry. XXX */
6356 else if (STRNCMP(ml_get(trypos->lnum) + trypos->col,
6357 lead_start, lead_start_len) != 0)
6358 continue;
6360 if (start_off != 0)
6361 amount += start_off;
6362 else if (start_align == COM_RIGHT)
6363 amount += vim_strsize(lead_start)
6364 - vim_strsize(lead_middle);
6365 break;
6368 /* If our line starts with the end comment string, line it up
6369 * with the middle comment */
6370 if (STRNCMP(theline, lead_middle, lead_middle_len) != 0
6371 && STRNCMP(theline, lead_end, STRLEN(lead_end)) == 0)
6373 amount = get_indent_lnum(curwin->w_cursor.lnum - 1);
6374 /* XXX */
6375 if (off != 0)
6376 amount += off;
6377 else if (align == COM_RIGHT)
6378 amount += vim_strsize(lead_start)
6379 - vim_strsize(lead_middle);
6380 done = TRUE;
6381 break;
6386 /* If our line starts with an asterisk, line up with the
6387 * asterisk in the comment opener; otherwise, line up
6388 * with the first character of the comment text.
6390 if (done)
6392 else if (theline[0] == '*')
6393 amount += 1;
6394 else
6397 * If we are more than one line away from the comment opener, take
6398 * the indent of the previous non-empty line. If 'cino' has "CO"
6399 * and we are just below the comment opener and there are any
6400 * white characters after it line up with the text after it;
6401 * otherwise, add the amount specified by "c" in 'cino'
6403 amount = -1;
6404 for (lnum = cur_curpos.lnum - 1; lnum > trypos->lnum; --lnum)
6406 if (linewhite(lnum)) /* skip blank lines */
6407 continue;
6408 amount = get_indent_lnum(lnum); /* XXX */
6409 break;
6411 if (amount == -1) /* use the comment opener */
6413 if (!ind_in_comment2)
6415 start = ml_get(trypos->lnum);
6416 look = start + trypos->col + 2; /* skip / and * */
6417 if (*look != NUL) /* if something after it */
6418 trypos->col = (colnr_T)(skipwhite(look) - start);
6420 getvcol(curwin, trypos, &col, NULL, NULL);
6421 amount = col;
6422 if (ind_in_comment2 || *look == NUL)
6423 amount += ind_in_comment;
6429 * Are we inside parentheses or braces?
6430 */ /* XXX */
6431 else if (((trypos = find_match_paren(ind_maxparen, ind_maxcomment)) != NULL
6432 && ind_java == 0)
6433 || (tryposBrace = find_start_brace(ind_maxcomment)) != NULL
6434 || trypos != NULL)
6436 if (trypos != NULL && tryposBrace != NULL)
6438 /* Both an unmatched '(' and '{' is found. Use the one which is
6439 * closer to the current cursor position, set the other to NULL. */
6440 if (trypos->lnum != tryposBrace->lnum
6441 ? trypos->lnum < tryposBrace->lnum
6442 : trypos->col < tryposBrace->col)
6443 trypos = NULL;
6444 else
6445 tryposBrace = NULL;
6448 if (trypos != NULL)
6451 * If the matching paren is more than one line away, use the indent of
6452 * a previous non-empty line that matches the same paren.
6454 if (theline[0] == ')' && ind_paren_prev)
6456 /* Line up with the start of the matching paren line. */
6457 amount = get_indent_lnum(curwin->w_cursor.lnum - 1); /* XXX */
6459 else
6461 amount = -1;
6462 our_paren_pos = *trypos;
6463 for (lnum = cur_curpos.lnum - 1; lnum > our_paren_pos.lnum; --lnum)
6465 l = skipwhite(ml_get(lnum));
6466 if (cin_nocode(l)) /* skip comment lines */
6467 continue;
6468 if (cin_ispreproc_cont(&l, &lnum))
6469 continue; /* ignore #define, #if, etc. */
6470 curwin->w_cursor.lnum = lnum;
6472 /* Skip a comment. XXX */
6473 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6475 lnum = trypos->lnum + 1;
6476 continue;
6479 /* XXX */
6480 if ((trypos = find_match_paren(
6481 corr_ind_maxparen(ind_maxparen, &cur_curpos),
6482 ind_maxcomment)) != NULL
6483 && trypos->lnum == our_paren_pos.lnum
6484 && trypos->col == our_paren_pos.col)
6486 amount = get_indent_lnum(lnum); /* XXX */
6488 if (theline[0] == ')')
6490 if (our_paren_pos.lnum != lnum
6491 && cur_amount > amount)
6492 cur_amount = amount;
6493 amount = -1;
6495 break;
6501 * Line up with line where the matching paren is. XXX
6502 * If the line starts with a '(' or the indent for unclosed
6503 * parentheses is zero, line up with the unclosed parentheses.
6505 if (amount == -1)
6507 int ignore_paren_col = 0;
6509 amount = skip_label(our_paren_pos.lnum, &look, ind_maxcomment);
6510 look = skipwhite(look);
6511 if (*look == '(')
6513 linenr_T save_lnum = curwin->w_cursor.lnum;
6514 char_u *line;
6515 int look_col;
6517 /* Ignore a '(' in front of the line that has a match before
6518 * our matching '('. */
6519 curwin->w_cursor.lnum = our_paren_pos.lnum;
6520 line = ml_get_curline();
6521 look_col = (int)(look - line);
6522 curwin->w_cursor.col = look_col + 1;
6523 if ((trypos = findmatchlimit(NULL, ')', 0, ind_maxparen))
6524 != NULL
6525 && trypos->lnum == our_paren_pos.lnum
6526 && trypos->col < our_paren_pos.col)
6527 ignore_paren_col = trypos->col + 1;
6529 curwin->w_cursor.lnum = save_lnum;
6530 look = ml_get(our_paren_pos.lnum) + look_col;
6532 if (theline[0] == ')' || ind_unclosed == 0
6533 || (!ind_unclosed_noignore && *look == '('
6534 && ignore_paren_col == 0))
6537 * If we're looking at a close paren, line up right there;
6538 * otherwise, line up with the next (non-white) character.
6539 * When ind_unclosed_wrapped is set and the matching paren is
6540 * the last nonwhite character of the line, use either the
6541 * indent of the current line or the indentation of the next
6542 * outer paren and add ind_unclosed_wrapped (for very long
6543 * lines).
6545 if (theline[0] != ')')
6547 cur_amount = MAXCOL;
6548 l = ml_get(our_paren_pos.lnum);
6549 if (ind_unclosed_wrapped
6550 && cin_ends_in(l, (char_u *)"(", NULL))
6552 /* look for opening unmatched paren, indent one level
6553 * for each additional level */
6554 n = 1;
6555 for (col = 0; col < our_paren_pos.col; ++col)
6557 switch (l[col])
6559 case '(':
6560 case '{': ++n;
6561 break;
6563 case ')':
6564 case '}': if (n > 1)
6565 --n;
6566 break;
6570 our_paren_pos.col = 0;
6571 amount += n * ind_unclosed_wrapped;
6573 else if (ind_unclosed_whiteok)
6574 our_paren_pos.col++;
6575 else
6577 col = our_paren_pos.col + 1;
6578 while (vim_iswhite(l[col]))
6579 col++;
6580 if (l[col] != NUL) /* In case of trailing space */
6581 our_paren_pos.col = col;
6582 else
6583 our_paren_pos.col++;
6588 * Find how indented the paren is, or the character after it
6589 * if we did the above "if".
6591 if (our_paren_pos.col > 0)
6593 getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
6594 if (cur_amount > (int)col)
6595 cur_amount = col;
6599 if (theline[0] == ')' && ind_matching_paren)
6601 /* Line up with the start of the matching paren line. */
6603 else if (ind_unclosed == 0 || (!ind_unclosed_noignore
6604 && *look == '(' && ignore_paren_col == 0))
6606 if (cur_amount != MAXCOL)
6607 amount = cur_amount;
6609 else
6611 /* Add ind_unclosed2 for each '(' before our matching one, but
6612 * ignore (void) before the line (ignore_paren_col). */
6613 col = our_paren_pos.col;
6614 while ((int)our_paren_pos.col > ignore_paren_col)
6616 --our_paren_pos.col;
6617 switch (*ml_get_pos(&our_paren_pos))
6619 case '(': amount += ind_unclosed2;
6620 col = our_paren_pos.col;
6621 break;
6622 case ')': amount -= ind_unclosed2;
6623 col = MAXCOL;
6624 break;
6628 /* Use ind_unclosed once, when the first '(' is not inside
6629 * braces */
6630 if (col == MAXCOL)
6631 amount += ind_unclosed;
6632 else
6634 curwin->w_cursor.lnum = our_paren_pos.lnum;
6635 curwin->w_cursor.col = col;
6636 if ((trypos = find_match_paren(ind_maxparen,
6637 ind_maxcomment)) != NULL)
6638 amount += ind_unclosed2;
6639 else
6640 amount += ind_unclosed;
6643 * For a line starting with ')' use the minimum of the two
6644 * positions, to avoid giving it more indent than the previous
6645 * lines:
6646 * func_long_name( if (x
6647 * arg && yy
6648 * ) ^ not here ) ^ not here
6650 if (cur_amount < amount)
6651 amount = cur_amount;
6655 /* add extra indent for a comment */
6656 if (cin_iscomment(theline))
6657 amount += ind_comment;
6661 * Are we at least inside braces, then?
6663 else
6665 trypos = tryposBrace;
6667 ourscope = trypos->lnum;
6668 start = ml_get(ourscope);
6671 * Now figure out how indented the line is in general.
6672 * If the brace was at the start of the line, we use that;
6673 * otherwise, check out the indentation of the line as
6674 * a whole and then add the "imaginary indent" to that.
6676 look = skipwhite(start);
6677 if (*look == '{')
6679 getvcol(curwin, trypos, &col, NULL, NULL);
6680 amount = col;
6681 if (*start == '{')
6682 start_brace = BRACE_IN_COL0;
6683 else
6684 start_brace = BRACE_AT_START;
6686 else
6689 * that opening brace might have been on a continuation
6690 * line. if so, find the start of the line.
6692 curwin->w_cursor.lnum = ourscope;
6695 * position the cursor over the rightmost paren, so that
6696 * matching it will take us back to the start of the line.
6698 lnum = ourscope;
6699 if (find_last_paren(start, '(', ')')
6700 && (trypos = find_match_paren(ind_maxparen,
6701 ind_maxcomment)) != NULL)
6702 lnum = trypos->lnum;
6705 * It could have been something like
6706 * case 1: if (asdf &&
6707 * ldfd) {
6710 if (ind_keep_case_label && cin_iscase(skipwhite(ml_get_curline())))
6711 amount = get_indent();
6712 else
6713 amount = skip_label(lnum, &l, ind_maxcomment);
6715 start_brace = BRACE_AT_END;
6719 * if we're looking at a closing brace, that's where
6720 * we want to be. otherwise, add the amount of room
6721 * that an indent is supposed to be.
6723 if (theline[0] == '}')
6726 * they may want closing braces to line up with something
6727 * other than the open brace. indulge them, if so.
6729 amount += ind_close_extra;
6731 else
6734 * If we're looking at an "else", try to find an "if"
6735 * to match it with.
6736 * If we're looking at a "while", try to find a "do"
6737 * to match it with.
6739 lookfor = LOOKFOR_INITIAL;
6740 if (cin_iselse(theline))
6741 lookfor = LOOKFOR_IF;
6742 else if (cin_iswhileofdo(theline, cur_curpos.lnum, ind_maxparen))
6743 /* XXX */
6744 lookfor = LOOKFOR_DO;
6745 if (lookfor != LOOKFOR_INITIAL)
6747 curwin->w_cursor.lnum = cur_curpos.lnum;
6748 if (find_match(lookfor, ourscope, ind_maxparen,
6749 ind_maxcomment) == OK)
6751 amount = get_indent(); /* XXX */
6752 goto theend;
6757 * We get here if we are not on an "while-of-do" or "else" (or
6758 * failed to find a matching "if").
6759 * Search backwards for something to line up with.
6760 * First set amount for when we don't find anything.
6764 * if the '{' is _really_ at the left margin, use the imaginary
6765 * location of a left-margin brace. Otherwise, correct the
6766 * location for ind_open_extra.
6769 if (start_brace == BRACE_IN_COL0) /* '{' is in column 0 */
6771 amount = ind_open_left_imag;
6773 else
6775 if (start_brace == BRACE_AT_END) /* '{' is at end of line */
6776 amount += ind_open_imag;
6777 else
6779 /* Compensate for adding ind_open_extra later. */
6780 amount -= ind_open_extra;
6781 if (amount < 0)
6782 amount = 0;
6786 lookfor_break = FALSE;
6788 if (cin_iscase(theline)) /* it's a switch() label */
6790 lookfor = LOOKFOR_CASE; /* find a previous switch() label */
6791 amount += ind_case;
6793 else if (cin_isscopedecl(theline)) /* private:, ... */
6795 lookfor = LOOKFOR_SCOPEDECL; /* class decl is this block */
6796 amount += ind_scopedecl;
6798 else
6800 if (ind_case_break && cin_isbreak(theline)) /* break; ... */
6801 lookfor_break = TRUE;
6803 lookfor = LOOKFOR_INITIAL;
6804 amount += ind_level; /* ind_level from start of block */
6806 scope_amount = amount;
6807 whilelevel = 0;
6810 * Search backwards. If we find something we recognize, line up
6811 * with that.
6813 * if we're looking at an open brace, indent
6814 * the usual amount relative to the conditional
6815 * that opens the block.
6817 curwin->w_cursor = cur_curpos;
6818 for (;;)
6820 curwin->w_cursor.lnum--;
6821 curwin->w_cursor.col = 0;
6824 * If we went all the way back to the start of our scope, line
6825 * up with it.
6827 if (curwin->w_cursor.lnum <= ourscope)
6829 /* we reached end of scope:
6830 * if looking for a enum or structure initialization
6831 * go further back:
6832 * if it is an initializer (enum xxx or xxx =), then
6833 * don't add ind_continuation, otherwise it is a variable
6834 * declaration:
6835 * int x,
6836 * here; <-- add ind_continuation
6838 if (lookfor == LOOKFOR_ENUM_OR_INIT)
6840 if (curwin->w_cursor.lnum == 0
6841 || curwin->w_cursor.lnum
6842 < ourscope - ind_maxparen)
6844 /* nothing found (abuse ind_maxparen as limit)
6845 * assume terminated line (i.e. a variable
6846 * initialization) */
6847 if (cont_amount > 0)
6848 amount = cont_amount;
6849 else
6850 amount += ind_continuation;
6851 break;
6854 l = ml_get_curline();
6857 * If we're in a comment now, skip to the start of the
6858 * comment.
6860 trypos = find_start_comment(ind_maxcomment);
6861 if (trypos != NULL)
6863 curwin->w_cursor.lnum = trypos->lnum + 1;
6864 continue;
6868 * Skip preprocessor directives and blank lines.
6870 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
6871 continue;
6873 if (cin_nocode(l))
6874 continue;
6876 terminated = cin_isterminated(l, FALSE, TRUE);
6879 * If we are at top level and the line looks like a
6880 * function declaration, we are done
6881 * (it's a variable declaration).
6883 if (start_brace != BRACE_IN_COL0
6884 || !cin_isfuncdecl(&l, curwin->w_cursor.lnum))
6886 /* if the line is terminated with another ','
6887 * it is a continued variable initialization.
6888 * don't add extra indent.
6889 * TODO: does not work, if a function
6890 * declaration is split over multiple lines:
6891 * cin_isfuncdecl returns FALSE then.
6893 if (terminated == ',')
6894 break;
6896 /* if it es a enum declaration or an assignment,
6897 * we are done.
6899 if (terminated != ';' && cin_isinit())
6900 break;
6902 /* nothing useful found */
6903 if (terminated == 0 || terminated == '{')
6904 continue;
6907 if (terminated != ';')
6909 /* Skip parens and braces. Position the cursor
6910 * over the rightmost paren, so that matching it
6911 * will take us back to the start of the line.
6912 */ /* XXX */
6913 trypos = NULL;
6914 if (find_last_paren(l, '(', ')'))
6915 trypos = find_match_paren(ind_maxparen,
6916 ind_maxcomment);
6918 if (trypos == NULL && find_last_paren(l, '{', '}'))
6919 trypos = find_start_brace(ind_maxcomment);
6921 if (trypos != NULL)
6923 curwin->w_cursor.lnum = trypos->lnum + 1;
6924 continue;
6928 /* it's a variable declaration, add indentation
6929 * like in
6930 * int a,
6931 * b;
6933 if (cont_amount > 0)
6934 amount = cont_amount;
6935 else
6936 amount += ind_continuation;
6938 else if (lookfor == LOOKFOR_UNTERM)
6940 if (cont_amount > 0)
6941 amount = cont_amount;
6942 else
6943 amount += ind_continuation;
6945 else if (lookfor != LOOKFOR_TERM
6946 && lookfor != LOOKFOR_CPP_BASECLASS)
6948 amount = scope_amount;
6949 if (theline[0] == '{')
6950 amount += ind_open_extra;
6952 break;
6956 * If we're in a comment now, skip to the start of the comment.
6957 */ /* XXX */
6958 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
6960 curwin->w_cursor.lnum = trypos->lnum + 1;
6961 continue;
6964 l = ml_get_curline();
6967 * If this is a switch() label, may line up relative to that.
6968 * If this is a C++ scope declaration, do the same.
6970 iscase = cin_iscase(l);
6971 if (iscase || cin_isscopedecl(l))
6973 /* we are only looking for cpp base class
6974 * declaration/initialization any longer */
6975 if (lookfor == LOOKFOR_CPP_BASECLASS)
6976 break;
6978 /* When looking for a "do" we are not interested in
6979 * labels. */
6980 if (whilelevel > 0)
6981 continue;
6984 * case xx:
6985 * c = 99 + <- this indent plus continuation
6986 *-> here;
6988 if (lookfor == LOOKFOR_UNTERM
6989 || lookfor == LOOKFOR_ENUM_OR_INIT)
6991 if (cont_amount > 0)
6992 amount = cont_amount;
6993 else
6994 amount += ind_continuation;
6995 break;
6999 * case xx: <- line up with this case
7000 * x = 333;
7001 * case yy:
7003 if ( (iscase && lookfor == LOOKFOR_CASE)
7004 || (iscase && lookfor_break)
7005 || (!iscase && lookfor == LOOKFOR_SCOPEDECL))
7008 * Check that this case label is not for another
7009 * switch()
7010 */ /* XXX */
7011 if ((trypos = find_start_brace(ind_maxcomment)) ==
7012 NULL || trypos->lnum == ourscope)
7014 amount = get_indent(); /* XXX */
7015 break;
7017 continue;
7020 n = get_indent_nolabel(curwin->w_cursor.lnum); /* XXX */
7023 * case xx: if (cond) <- line up with this if
7024 * y = y + 1;
7025 * -> s = 99;
7027 * case xx:
7028 * if (cond) <- line up with this line
7029 * y = y + 1;
7030 * -> s = 99;
7032 if (lookfor == LOOKFOR_TERM)
7034 if (n)
7035 amount = n;
7037 if (!lookfor_break)
7038 break;
7042 * case xx: x = x + 1; <- line up with this x
7043 * -> y = y + 1;
7045 * case xx: if (cond) <- line up with this if
7046 * -> y = y + 1;
7048 if (n)
7050 amount = n;
7051 l = after_label(ml_get_curline());
7052 if (l != NULL && cin_is_cinword(l))
7054 if (theline[0] == '{')
7055 amount += ind_open_extra;
7056 else
7057 amount += ind_level + ind_no_brace;
7059 break;
7063 * Try to get the indent of a statement before the switch
7064 * label. If nothing is found, line up relative to the
7065 * switch label.
7066 * break; <- may line up with this line
7067 * case xx:
7068 * -> y = 1;
7070 scope_amount = get_indent() + (iscase /* XXX */
7071 ? ind_case_code : ind_scopedecl_code);
7072 lookfor = ind_case_break ? LOOKFOR_NOBREAK : LOOKFOR_ANY;
7073 continue;
7077 * Looking for a switch() label or C++ scope declaration,
7078 * ignore other lines, skip {}-blocks.
7080 if (lookfor == LOOKFOR_CASE || lookfor == LOOKFOR_SCOPEDECL)
7082 if (find_last_paren(l, '{', '}') && (trypos =
7083 find_start_brace(ind_maxcomment)) != NULL)
7084 curwin->w_cursor.lnum = trypos->lnum + 1;
7085 continue;
7089 * Ignore jump labels with nothing after them.
7091 if (cin_islabel(ind_maxcomment))
7093 l = after_label(ml_get_curline());
7094 if (l == NULL || cin_nocode(l))
7095 continue;
7099 * Ignore #defines, #if, etc.
7100 * Ignore comment and empty lines.
7101 * (need to get the line again, cin_islabel() may have
7102 * unlocked it)
7104 l = ml_get_curline();
7105 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum)
7106 || cin_nocode(l))
7107 continue;
7110 * Are we at the start of a cpp base class declaration or
7111 * constructor initialization?
7112 */ /* XXX */
7113 n = FALSE;
7114 if (lookfor != LOOKFOR_TERM && ind_cpp_baseclass > 0)
7116 n = cin_is_cpp_baseclass(l, &col);
7117 l = ml_get_curline();
7119 if (n)
7121 if (lookfor == LOOKFOR_UNTERM)
7123 if (cont_amount > 0)
7124 amount = cont_amount;
7125 else
7126 amount += ind_continuation;
7128 else if (theline[0] == '{')
7130 /* Need to find start of the declaration. */
7131 lookfor = LOOKFOR_UNTERM;
7132 ind_continuation = 0;
7133 continue;
7135 else
7136 /* XXX */
7137 amount = get_baseclass_amount(col, ind_maxparen,
7138 ind_maxcomment, ind_cpp_baseclass);
7139 break;
7141 else if (lookfor == LOOKFOR_CPP_BASECLASS)
7143 /* only look, whether there is a cpp base class
7144 * declaration or initialization before the opening brace.
7146 if (cin_isterminated(l, TRUE, FALSE))
7147 break;
7148 else
7149 continue;
7153 * What happens next depends on the line being terminated.
7154 * If terminated with a ',' only consider it terminating if
7155 * there is another unterminated statement behind, eg:
7156 * 123,
7157 * sizeof
7158 * here
7159 * Otherwise check whether it is a enumeration or structure
7160 * initialisation (not indented) or a variable declaration
7161 * (indented).
7163 terminated = cin_isterminated(l, FALSE, TRUE);
7165 if (terminated == 0 || (lookfor != LOOKFOR_UNTERM
7166 && terminated == ','))
7169 * if we're in the middle of a paren thing,
7170 * go back to the line that starts it so
7171 * we can get the right prevailing indent
7172 * if ( foo &&
7173 * bar )
7176 * position the cursor over the rightmost paren, so that
7177 * matching it will take us back to the start of the line.
7179 (void)find_last_paren(l, '(', ')');
7180 trypos = find_match_paren(
7181 corr_ind_maxparen(ind_maxparen, &cur_curpos),
7182 ind_maxcomment);
7185 * If we are looking for ',', we also look for matching
7186 * braces.
7188 if (trypos == NULL && terminated == ','
7189 && find_last_paren(l, '{', '}'))
7190 trypos = find_start_brace(ind_maxcomment);
7192 if (trypos != NULL)
7195 * Check if we are on a case label now. This is
7196 * handled above.
7197 * case xx: if ( asdf &&
7198 * asdf)
7200 curwin->w_cursor.lnum = trypos->lnum;
7201 l = ml_get_curline();
7202 if (cin_iscase(l) || cin_isscopedecl(l))
7204 ++curwin->w_cursor.lnum;
7205 continue;
7210 * Skip over continuation lines to find the one to get the
7211 * indent from
7212 * char *usethis = "bla\
7213 * bla",
7214 * here;
7216 if (terminated == ',')
7218 while (curwin->w_cursor.lnum > 1)
7220 l = ml_get(curwin->w_cursor.lnum - 1);
7221 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7222 break;
7223 --curwin->w_cursor.lnum;
7228 * Get indent and pointer to text for current line,
7229 * ignoring any jump label. XXX
7231 cur_amount = skip_label(curwin->w_cursor.lnum,
7232 &l, ind_maxcomment);
7235 * If this is just above the line we are indenting, and it
7236 * starts with a '{', line it up with this line.
7237 * while (not)
7238 * -> {
7241 if (terminated != ',' && lookfor != LOOKFOR_TERM
7242 && theline[0] == '{')
7244 amount = cur_amount;
7246 * Only add ind_open_extra when the current line
7247 * doesn't start with a '{', which must have a match
7248 * in the same line (scope is the same). Probably:
7249 * { 1, 2 },
7250 * -> { 3, 4 }
7252 if (*skipwhite(l) != '{')
7253 amount += ind_open_extra;
7255 if (ind_cpp_baseclass)
7257 /* have to look back, whether it is a cpp base
7258 * class declaration or initialization */
7259 lookfor = LOOKFOR_CPP_BASECLASS;
7260 continue;
7262 break;
7266 * Check if we are after an "if", "while", etc.
7267 * Also allow " } else".
7269 if (cin_is_cinword(l) || cin_iselse(skipwhite(l)))
7272 * Found an unterminated line after an if (), line up
7273 * with the last one.
7274 * if (cond)
7275 * 100 +
7276 * -> here;
7278 if (lookfor == LOOKFOR_UNTERM
7279 || lookfor == LOOKFOR_ENUM_OR_INIT)
7281 if (cont_amount > 0)
7282 amount = cont_amount;
7283 else
7284 amount += ind_continuation;
7285 break;
7289 * If this is just above the line we are indenting, we
7290 * are finished.
7291 * while (not)
7292 * -> here;
7293 * Otherwise this indent can be used when the line
7294 * before this is terminated.
7295 * yyy;
7296 * if (stat)
7297 * while (not)
7298 * xxx;
7299 * -> here;
7301 amount = cur_amount;
7302 if (theline[0] == '{')
7303 amount += ind_open_extra;
7304 if (lookfor != LOOKFOR_TERM)
7306 amount += ind_level + ind_no_brace;
7307 break;
7311 * Special trick: when expecting the while () after a
7312 * do, line up with the while()
7313 * do
7314 * x = 1;
7315 * -> here
7317 l = skipwhite(ml_get_curline());
7318 if (cin_isdo(l))
7320 if (whilelevel == 0)
7321 break;
7322 --whilelevel;
7326 * When searching for a terminated line, don't use the
7327 * one between the "if" and the "else".
7328 * Need to use the scope of this "else". XXX
7329 * If whilelevel != 0 continue looking for a "do {".
7331 if (cin_iselse(l)
7332 && whilelevel == 0
7333 && ((trypos = find_start_brace(ind_maxcomment))
7334 == NULL
7335 || find_match(LOOKFOR_IF, trypos->lnum,
7336 ind_maxparen, ind_maxcomment) == FAIL))
7337 break;
7341 * If we're below an unterminated line that is not an
7342 * "if" or something, we may line up with this line or
7343 * add something for a continuation line, depending on
7344 * the line before this one.
7346 else
7349 * Found two unterminated lines on a row, line up with
7350 * the last one.
7351 * c = 99 +
7352 * 100 +
7353 * -> here;
7355 if (lookfor == LOOKFOR_UNTERM)
7357 /* When line ends in a comma add extra indent */
7358 if (terminated == ',')
7359 amount += ind_continuation;
7360 break;
7363 if (lookfor == LOOKFOR_ENUM_OR_INIT)
7365 /* Found two lines ending in ',', lineup with the
7366 * lowest one, but check for cpp base class
7367 * declaration/initialization, if it is an
7368 * opening brace or we are looking just for
7369 * enumerations/initializations. */
7370 if (terminated == ',')
7372 if (ind_cpp_baseclass == 0)
7373 break;
7375 lookfor = LOOKFOR_CPP_BASECLASS;
7376 continue;
7379 /* Ignore unterminated lines in between, but
7380 * reduce indent. */
7381 if (amount > cur_amount)
7382 amount = cur_amount;
7384 else
7387 * Found first unterminated line on a row, may
7388 * line up with this line, remember its indent
7389 * 100 +
7390 * -> here;
7392 amount = cur_amount;
7395 * If previous line ends in ',', check whether we
7396 * are in an initialization or enum
7397 * struct xxx =
7399 * sizeof a,
7400 * 124 };
7401 * or a normal possible continuation line.
7402 * but only, of no other statement has been found
7403 * yet.
7405 if (lookfor == LOOKFOR_INITIAL && terminated == ',')
7407 lookfor = LOOKFOR_ENUM_OR_INIT;
7408 cont_amount = cin_first_id_amount();
7410 else
7412 if (lookfor == LOOKFOR_INITIAL
7413 && *l != NUL
7414 && l[STRLEN(l) - 1] == '\\')
7415 /* XXX */
7416 cont_amount = cin_get_equal_amount(
7417 curwin->w_cursor.lnum);
7418 if (lookfor != LOOKFOR_TERM)
7419 lookfor = LOOKFOR_UNTERM;
7426 * Check if we are after a while (cond);
7427 * If so: Ignore until the matching "do".
7429 /* XXX */
7430 else if (cin_iswhileofdo_end(terminated, ind_maxparen,
7431 ind_maxcomment))
7434 * Found an unterminated line after a while ();, line up
7435 * with the last one.
7436 * while (cond);
7437 * 100 + <- line up with this one
7438 * -> here;
7440 if (lookfor == LOOKFOR_UNTERM
7441 || lookfor == LOOKFOR_ENUM_OR_INIT)
7443 if (cont_amount > 0)
7444 amount = cont_amount;
7445 else
7446 amount += ind_continuation;
7447 break;
7450 if (whilelevel == 0)
7452 lookfor = LOOKFOR_TERM;
7453 amount = get_indent(); /* XXX */
7454 if (theline[0] == '{')
7455 amount += ind_open_extra;
7457 ++whilelevel;
7461 * We are after a "normal" statement.
7462 * If we had another statement we can stop now and use the
7463 * indent of that other statement.
7464 * Otherwise the indent of the current statement may be used,
7465 * search backwards for the next "normal" statement.
7467 else
7470 * Skip single break line, if before a switch label. It
7471 * may be lined up with the case label.
7473 if (lookfor == LOOKFOR_NOBREAK
7474 && cin_isbreak(skipwhite(ml_get_curline())))
7476 lookfor = LOOKFOR_ANY;
7477 continue;
7481 * Handle "do {" line.
7483 if (whilelevel > 0)
7485 l = cin_skipcomment(ml_get_curline());
7486 if (cin_isdo(l))
7488 amount = get_indent(); /* XXX */
7489 --whilelevel;
7490 continue;
7495 * Found a terminated line above an unterminated line. Add
7496 * the amount for a continuation line.
7497 * x = 1;
7498 * y = foo +
7499 * -> here;
7500 * or
7501 * int x = 1;
7502 * int foo,
7503 * -> here;
7505 if (lookfor == LOOKFOR_UNTERM
7506 || lookfor == LOOKFOR_ENUM_OR_INIT)
7508 if (cont_amount > 0)
7509 amount = cont_amount;
7510 else
7511 amount += ind_continuation;
7512 break;
7516 * Found a terminated line above a terminated line or "if"
7517 * etc. line. Use the amount of the line below us.
7518 * x = 1; x = 1;
7519 * if (asdf) y = 2;
7520 * while (asdf) ->here;
7521 * here;
7522 * ->foo;
7524 if (lookfor == LOOKFOR_TERM)
7526 if (!lookfor_break && whilelevel == 0)
7527 break;
7531 * First line above the one we're indenting is terminated.
7532 * To know what needs to be done look further backward for
7533 * a terminated line.
7535 else
7538 * position the cursor over the rightmost paren, so
7539 * that matching it will take us back to the start of
7540 * the line. Helps for:
7541 * func(asdr,
7542 * asdfasdf);
7543 * here;
7545 term_again:
7546 l = ml_get_curline();
7547 if (find_last_paren(l, '(', ')')
7548 && (trypos = find_match_paren(ind_maxparen,
7549 ind_maxcomment)) != NULL)
7552 * Check if we are on a case label now. This is
7553 * handled above.
7554 * case xx: if ( asdf &&
7555 * asdf)
7557 curwin->w_cursor.lnum = trypos->lnum;
7558 l = ml_get_curline();
7559 if (cin_iscase(l) || cin_isscopedecl(l))
7561 ++curwin->w_cursor.lnum;
7562 continue;
7566 /* When aligning with the case statement, don't align
7567 * with a statement after it.
7568 * case 1: { <-- don't use this { position
7569 * stat;
7571 * case 2:
7572 * stat;
7575 iscase = (ind_keep_case_label && cin_iscase(l));
7578 * Get indent and pointer to text for current line,
7579 * ignoring any jump label.
7581 amount = skip_label(curwin->w_cursor.lnum,
7582 &l, ind_maxcomment);
7584 if (theline[0] == '{')
7585 amount += ind_open_extra;
7586 /* See remark above: "Only add ind_open_extra.." */
7587 l = skipwhite(l);
7588 if (*l == '{')
7589 amount -= ind_open_extra;
7590 lookfor = iscase ? LOOKFOR_ANY : LOOKFOR_TERM;
7593 * When a terminated line starts with "else" skip to
7594 * the matching "if":
7595 * else 3;
7596 * indent this;
7597 * Need to use the scope of this "else". XXX
7598 * If whilelevel != 0 continue looking for a "do {".
7600 if (lookfor == LOOKFOR_TERM
7601 && *l != '}'
7602 && cin_iselse(l)
7603 && whilelevel == 0)
7605 if ((trypos = find_start_brace(ind_maxcomment))
7606 == NULL
7607 || find_match(LOOKFOR_IF, trypos->lnum,
7608 ind_maxparen, ind_maxcomment) == FAIL)
7609 break;
7610 continue;
7614 * If we're at the end of a block, skip to the start of
7615 * that block.
7617 curwin->w_cursor.col = 0;
7618 if (*cin_skipcomment(l) == '}'
7619 && (trypos = find_start_brace(ind_maxcomment))
7620 != NULL) /* XXX */
7622 curwin->w_cursor.lnum = trypos->lnum;
7623 /* if not "else {" check for terminated again */
7624 /* but skip block for "} else {" */
7625 l = cin_skipcomment(ml_get_curline());
7626 if (*l == '}' || !cin_iselse(l))
7627 goto term_again;
7628 ++curwin->w_cursor.lnum;
7636 /* add extra indent for a comment */
7637 if (cin_iscomment(theline))
7638 amount += ind_comment;
7642 * ok -- we're not inside any sort of structure at all!
7644 * this means we're at the top level, and everything should
7645 * basically just match where the previous line is, except
7646 * for the lines immediately following a function declaration,
7647 * which are K&R-style parameters and need to be indented.
7649 else
7652 * if our line starts with an open brace, forget about any
7653 * prevailing indent and make sure it looks like the start
7654 * of a function
7657 if (theline[0] == '{')
7659 amount = ind_first_open;
7663 * If the NEXT line is a function declaration, the current
7664 * line needs to be indented as a function type spec.
7665 * Don't do this if the current line looks like a comment
7666 * or if the current line is terminated, ie. ends in ';'.
7668 else if (cur_curpos.lnum < curbuf->b_ml.ml_line_count
7669 && !cin_nocode(theline)
7670 && !cin_ends_in(theline, (char_u *)":", NULL)
7671 && !cin_ends_in(theline, (char_u *)",", NULL)
7672 && cin_isfuncdecl(NULL, cur_curpos.lnum + 1)
7673 && !cin_isterminated(theline, FALSE, TRUE))
7675 amount = ind_func_type;
7677 else
7679 amount = 0;
7680 curwin->w_cursor = cur_curpos;
7682 /* search backwards until we find something we recognize */
7684 while (curwin->w_cursor.lnum > 1)
7686 curwin->w_cursor.lnum--;
7687 curwin->w_cursor.col = 0;
7689 l = ml_get_curline();
7692 * If we're in a comment now, skip to the start of the comment.
7693 */ /* XXX */
7694 if ((trypos = find_start_comment(ind_maxcomment)) != NULL)
7696 curwin->w_cursor.lnum = trypos->lnum + 1;
7697 continue;
7701 * Are we at the start of a cpp base class declaration or
7702 * constructor initialization?
7703 */ /* XXX */
7704 n = FALSE;
7705 if (ind_cpp_baseclass != 0 && theline[0] != '{')
7707 n = cin_is_cpp_baseclass(l, &col);
7708 l = ml_get_curline();
7710 if (n)
7712 /* XXX */
7713 amount = get_baseclass_amount(col, ind_maxparen,
7714 ind_maxcomment, ind_cpp_baseclass);
7715 break;
7719 * Skip preprocessor directives and blank lines.
7721 if (cin_ispreproc_cont(&l, &curwin->w_cursor.lnum))
7722 continue;
7724 if (cin_nocode(l))
7725 continue;
7728 * If the previous line ends in ',', use one level of
7729 * indentation:
7730 * int foo,
7731 * bar;
7732 * do this before checking for '}' in case of eg.
7733 * enum foobar
7735 * ...
7736 * } foo,
7737 * bar;
7739 n = 0;
7740 if (cin_ends_in(l, (char_u *)",", NULL)
7741 || (*l != NUL && (n = l[STRLEN(l) - 1]) == '\\'))
7743 /* take us back to opening paren */
7744 if (find_last_paren(l, '(', ')')
7745 && (trypos = find_match_paren(ind_maxparen,
7746 ind_maxcomment)) != NULL)
7747 curwin->w_cursor.lnum = trypos->lnum;
7749 /* For a line ending in ',' that is a continuation line go
7750 * back to the first line with a backslash:
7751 * char *foo = "bla\
7752 * bla",
7753 * here;
7755 while (n == 0 && curwin->w_cursor.lnum > 1)
7757 l = ml_get(curwin->w_cursor.lnum - 1);
7758 if (*l == NUL || l[STRLEN(l) - 1] != '\\')
7759 break;
7760 --curwin->w_cursor.lnum;
7763 amount = get_indent(); /* XXX */
7765 if (amount == 0)
7766 amount = cin_first_id_amount();
7767 if (amount == 0)
7768 amount = ind_continuation;
7769 break;
7773 * If the line looks like a function declaration, and we're
7774 * not in a comment, put it the left margin.
7776 if (cin_isfuncdecl(NULL, cur_curpos.lnum)) /* XXX */
7777 break;
7778 l = ml_get_curline();
7781 * Finding the closing '}' of a previous function. Put
7782 * current line at the left margin. For when 'cino' has "fs".
7784 if (*skipwhite(l) == '}')
7785 break;
7787 /* (matching {)
7788 * If the previous line ends on '};' (maybe followed by
7789 * comments) align at column 0. For example:
7790 * char *string_array[] = { "foo",
7791 * / * x * / "b};ar" }; / * foobar * /
7793 if (cin_ends_in(l, (char_u *)"};", NULL))
7794 break;
7797 * If the PREVIOUS line is a function declaration, the current
7798 * line (and the ones that follow) needs to be indented as
7799 * parameters.
7801 if (cin_isfuncdecl(&l, curwin->w_cursor.lnum))
7803 amount = ind_param;
7804 break;
7808 * If the previous line ends in ';' and the line before the
7809 * previous line ends in ',' or '\', ident to column zero:
7810 * int foo,
7811 * bar;
7812 * indent_to_0 here;
7814 if (cin_ends_in(l, (char_u *)";", NULL))
7816 l = ml_get(curwin->w_cursor.lnum - 1);
7817 if (cin_ends_in(l, (char_u *)",", NULL)
7818 || (*l != NUL && l[STRLEN(l) - 1] == '\\'))
7819 break;
7820 l = ml_get_curline();
7824 * Doesn't look like anything interesting -- so just
7825 * use the indent of this line.
7827 * Position the cursor over the rightmost paren, so that
7828 * matching it will take us back to the start of the line.
7830 find_last_paren(l, '(', ')');
7832 if ((trypos = find_match_paren(ind_maxparen,
7833 ind_maxcomment)) != NULL)
7834 curwin->w_cursor.lnum = trypos->lnum;
7835 amount = get_indent(); /* XXX */
7836 break;
7839 /* add extra indent for a comment */
7840 if (cin_iscomment(theline))
7841 amount += ind_comment;
7843 /* add extra indent if the previous line ended in a backslash:
7844 * "asdfasdf\
7845 * here";
7846 * char *foo = "asdf\
7847 * here";
7849 if (cur_curpos.lnum > 1)
7851 l = ml_get(cur_curpos.lnum - 1);
7852 if (*l != NUL && l[STRLEN(l) - 1] == '\\')
7854 cur_amount = cin_get_equal_amount(cur_curpos.lnum - 1);
7855 if (cur_amount > 0)
7856 amount = cur_amount;
7857 else if (cur_amount == 0)
7858 amount += ind_continuation;
7864 theend:
7865 /* put the cursor back where it belongs */
7866 curwin->w_cursor = cur_curpos;
7868 vim_free(linecopy);
7870 if (amount < 0)
7871 return 0;
7872 return amount;
7875 static int
7876 find_match(lookfor, ourscope, ind_maxparen, ind_maxcomment)
7877 int lookfor;
7878 linenr_T ourscope;
7879 int ind_maxparen;
7880 int ind_maxcomment;
7882 char_u *look;
7883 pos_T *theirscope;
7884 char_u *mightbeif;
7885 int elselevel;
7886 int whilelevel;
7888 if (lookfor == LOOKFOR_IF)
7890 elselevel = 1;
7891 whilelevel = 0;
7893 else
7895 elselevel = 0;
7896 whilelevel = 1;
7899 curwin->w_cursor.col = 0;
7901 while (curwin->w_cursor.lnum > ourscope + 1)
7903 curwin->w_cursor.lnum--;
7904 curwin->w_cursor.col = 0;
7906 look = cin_skipcomment(ml_get_curline());
7907 if (cin_iselse(look)
7908 || cin_isif(look)
7909 || cin_isdo(look) /* XXX */
7910 || cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7913 * if we've gone outside the braces entirely,
7914 * we must be out of scope...
7916 theirscope = find_start_brace(ind_maxcomment); /* XXX */
7917 if (theirscope == NULL)
7918 break;
7921 * and if the brace enclosing this is further
7922 * back than the one enclosing the else, we're
7923 * out of luck too.
7925 if (theirscope->lnum < ourscope)
7926 break;
7929 * and if they're enclosed in a *deeper* brace,
7930 * then we can ignore it because it's in a
7931 * different scope...
7933 if (theirscope->lnum > ourscope)
7934 continue;
7937 * if it was an "else" (that's not an "else if")
7938 * then we need to go back to another if, so
7939 * increment elselevel
7941 look = cin_skipcomment(ml_get_curline());
7942 if (cin_iselse(look))
7944 mightbeif = cin_skipcomment(look + 4);
7945 if (!cin_isif(mightbeif))
7946 ++elselevel;
7947 continue;
7951 * if it was a "while" then we need to go back to
7952 * another "do", so increment whilelevel. XXX
7954 if (cin_iswhileofdo(look, curwin->w_cursor.lnum, ind_maxparen))
7956 ++whilelevel;
7957 continue;
7960 /* If it's an "if" decrement elselevel */
7961 look = cin_skipcomment(ml_get_curline());
7962 if (cin_isif(look))
7964 elselevel--;
7966 * When looking for an "if" ignore "while"s that
7967 * get in the way.
7969 if (elselevel == 0 && lookfor == LOOKFOR_IF)
7970 whilelevel = 0;
7973 /* If it's a "do" decrement whilelevel */
7974 if (cin_isdo(look))
7975 whilelevel--;
7978 * if we've used up all the elses, then
7979 * this must be the if that we want!
7980 * match the indent level of that if.
7982 if (elselevel <= 0 && whilelevel <= 0)
7984 return OK;
7988 return FAIL;
7991 # if defined(FEAT_EVAL) || defined(PROTO)
7993 * Get indent level from 'indentexpr'.
7996 get_expr_indent()
7998 int indent;
7999 pos_T pos;
8000 int save_State;
8001 int use_sandbox = was_set_insecurely((char_u *)"indentexpr",
8002 OPT_LOCAL);
8004 pos = curwin->w_cursor;
8005 set_vim_var_nr(VV_LNUM, curwin->w_cursor.lnum);
8006 if (use_sandbox)
8007 ++sandbox;
8008 ++textlock;
8009 indent = eval_to_number(curbuf->b_p_inde);
8010 if (use_sandbox)
8011 --sandbox;
8012 --textlock;
8014 /* Restore the cursor position so that 'indentexpr' doesn't need to.
8015 * Pretend to be in Insert mode, allow cursor past end of line for "o"
8016 * command. */
8017 save_State = State;
8018 State = INSERT;
8019 curwin->w_cursor = pos;
8020 check_cursor();
8021 State = save_State;
8023 /* If there is an error, just keep the current indent. */
8024 if (indent < 0)
8025 indent = get_indent();
8027 return indent;
8029 # endif
8031 #endif /* FEAT_CINDENT */
8033 #if defined(FEAT_LISP) || defined(PROTO)
8035 static int lisp_match __ARGS((char_u *p));
8037 static int
8038 lisp_match(p)
8039 char_u *p;
8041 char_u buf[LSIZE];
8042 int len;
8043 char_u *word = p_lispwords;
8045 while (*word != NUL)
8047 (void)copy_option_part(&word, buf, LSIZE, ",");
8048 len = (int)STRLEN(buf);
8049 if (STRNCMP(buf, p, len) == 0 && p[len] == ' ')
8050 return TRUE;
8052 return FALSE;
8056 * When 'p' is present in 'cpoptions, a Vi compatible method is used.
8057 * The incompatible newer method is quite a bit better at indenting
8058 * code in lisp-like languages than the traditional one; it's still
8059 * mostly heuristics however -- Dirk van Deun, dirk@rave.org
8061 * TODO:
8062 * Findmatch() should be adapted for lisp, also to make showmatch
8063 * work correctly: now (v5.3) it seems all C/C++ oriented:
8064 * - it does not recognize the #\( and #\) notations as character literals
8065 * - it doesn't know about comments starting with a semicolon
8066 * - it incorrectly interprets '(' as a character literal
8067 * All this messes up get_lisp_indent in some rare cases.
8068 * Update from Sergey Khorev:
8069 * I tried to fix the first two issues.
8072 get_lisp_indent()
8074 pos_T *pos, realpos, paren;
8075 int amount;
8076 char_u *that;
8077 colnr_T col;
8078 colnr_T firsttry;
8079 int parencount, quotecount;
8080 int vi_lisp;
8082 /* Set vi_lisp to use the vi-compatible method */
8083 vi_lisp = (vim_strchr(p_cpo, CPO_LISP) != NULL);
8085 realpos = curwin->w_cursor;
8086 curwin->w_cursor.col = 0;
8088 if ((pos = findmatch(NULL, '(')) == NULL)
8089 pos = findmatch(NULL, '[');
8090 else
8092 paren = *pos;
8093 pos = findmatch(NULL, '[');
8094 if (pos == NULL || ltp(pos, &paren))
8095 pos = &paren;
8097 if (pos != NULL)
8099 /* Extra trick: Take the indent of the first previous non-white
8100 * line that is at the same () level. */
8101 amount = -1;
8102 parencount = 0;
8104 while (--curwin->w_cursor.lnum >= pos->lnum)
8106 if (linewhite(curwin->w_cursor.lnum))
8107 continue;
8108 for (that = ml_get_curline(); *that != NUL; ++that)
8110 if (*that == ';')
8112 while (*(that + 1) != NUL)
8113 ++that;
8114 continue;
8116 if (*that == '\\')
8118 if (*(that + 1) != NUL)
8119 ++that;
8120 continue;
8122 if (*that == '"' && *(that + 1) != NUL)
8124 while (*++that && *that != '"')
8126 /* skipping escaped characters in the string */
8127 if (*that == '\\')
8129 if (*++that == NUL)
8130 break;
8131 if (that[1] == NUL)
8133 ++that;
8134 break;
8139 if (*that == '(' || *that == '[')
8140 ++parencount;
8141 else if (*that == ')' || *that == ']')
8142 --parencount;
8144 if (parencount == 0)
8146 amount = get_indent();
8147 break;
8151 if (amount == -1)
8153 curwin->w_cursor.lnum = pos->lnum;
8154 curwin->w_cursor.col = pos->col;
8155 col = pos->col;
8157 that = ml_get_curline();
8159 if (vi_lisp && get_indent() == 0)
8160 amount = 2;
8161 else
8163 amount = 0;
8164 while (*that && col)
8166 amount += lbr_chartabsize_adv(&that, (colnr_T)amount);
8167 col--;
8171 * Some keywords require "body" indenting rules (the
8172 * non-standard-lisp ones are Scheme special forms):
8174 * (let ((a 1)) instead (let ((a 1))
8175 * (...)) of (...))
8178 if (!vi_lisp && (*that == '(' || *that == '[')
8179 && lisp_match(that + 1))
8180 amount += 2;
8181 else
8183 that++;
8184 amount++;
8185 firsttry = amount;
8187 while (vim_iswhite(*that))
8189 amount += lbr_chartabsize(that, (colnr_T)amount);
8190 ++that;
8193 if (*that && *that != ';') /* not a comment line */
8195 /* test *that != '(' to accomodate first let/do
8196 * argument if it is more than one line */
8197 if (!vi_lisp && *that != '(' && *that != '[')
8198 firsttry++;
8200 parencount = 0;
8201 quotecount = 0;
8203 if (vi_lisp
8204 || (*that != '"'
8205 && *that != '\''
8206 && *that != '#'
8207 && (*that < '0' || *that > '9')))
8209 while (*that
8210 && (!vim_iswhite(*that)
8211 || quotecount
8212 || parencount)
8213 && (!((*that == '(' || *that == '[')
8214 && !quotecount
8215 && !parencount
8216 && vi_lisp)))
8218 if (*that == '"')
8219 quotecount = !quotecount;
8220 if ((*that == '(' || *that == '[')
8221 && !quotecount)
8222 ++parencount;
8223 if ((*that == ')' || *that == ']')
8224 && !quotecount)
8225 --parencount;
8226 if (*that == '\\' && *(that+1) != NUL)
8227 amount += lbr_chartabsize_adv(&that,
8228 (colnr_T)amount);
8229 amount += lbr_chartabsize_adv(&that,
8230 (colnr_T)amount);
8233 while (vim_iswhite(*that))
8235 amount += lbr_chartabsize(that, (colnr_T)amount);
8236 that++;
8238 if (!*that || *that == ';')
8239 amount = firsttry;
8245 else
8246 amount = 0; /* no matching '(' or '[' found, use zero indent */
8248 curwin->w_cursor = realpos;
8250 return amount;
8252 #endif /* FEAT_LISP */
8254 void
8255 prepare_to_exit()
8257 #if defined(SIGHUP) && defined(SIG_IGN)
8258 /* Ignore SIGHUP, because a dropped connection causes a read error, which
8259 * makes Vim exit and then handling SIGHUP causes various reentrance
8260 * problems. */
8261 signal(SIGHUP, SIG_IGN);
8262 #endif
8264 #ifdef FEAT_GUI
8265 if (gui.in_use)
8267 gui.dying = TRUE;
8268 out_trash(); /* trash any pending output */
8270 else
8271 #endif
8273 windgoto((int)Rows - 1, 0);
8276 * Switch terminal mode back now, so messages end up on the "normal"
8277 * screen (if there are two screens).
8279 settmode(TMODE_COOK);
8280 #ifdef WIN3264
8281 if (can_end_termcap_mode(FALSE) == TRUE)
8282 #endif
8283 stoptermcap();
8284 out_flush();
8289 * Preserve files and exit.
8290 * When called IObuff must contain a message.
8292 void
8293 preserve_exit()
8295 buf_T *buf;
8297 prepare_to_exit();
8299 /* Setting this will prevent free() calls. That avoids calling free()
8300 * recursively when free() was invoked with a bad pointer. */
8301 really_exiting = TRUE;
8303 out_str(IObuff);
8304 screen_start(); /* don't know where cursor is now */
8305 out_flush();
8307 ml_close_notmod(); /* close all not-modified buffers */
8309 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8311 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
8313 OUT_STR(_("Vim: preserving files...\n"));
8314 screen_start(); /* don't know where cursor is now */
8315 out_flush();
8316 ml_sync_all(FALSE, FALSE); /* preserve all swap files */
8317 break;
8321 ml_close_all(FALSE); /* close all memfiles, without deleting */
8323 OUT_STR(_("Vim: Finished.\n"));
8325 getout(1);
8329 * return TRUE if "fname" exists.
8332 vim_fexists(fname)
8333 char_u *fname;
8335 struct stat st;
8337 if (mch_stat((char *)fname, &st))
8338 return FALSE;
8339 return TRUE;
8343 * Check for CTRL-C pressed, but only once in a while.
8344 * Should be used instead of ui_breakcheck() for functions that check for
8345 * each line in the file. Calling ui_breakcheck() each time takes too much
8346 * time, because it can be a system call.
8349 #ifndef BREAKCHECK_SKIP
8350 # ifdef FEAT_GUI /* assume the GUI only runs on fast computers */
8351 # define BREAKCHECK_SKIP 200
8352 # else
8353 # define BREAKCHECK_SKIP 32
8354 # endif
8355 #endif
8357 static int breakcheck_count = 0;
8359 void
8360 line_breakcheck()
8362 if (++breakcheck_count >= BREAKCHECK_SKIP)
8364 breakcheck_count = 0;
8365 ui_breakcheck();
8370 * Like line_breakcheck() but check 10 times less often.
8372 void
8373 fast_breakcheck()
8375 if (++breakcheck_count >= BREAKCHECK_SKIP * 10)
8377 breakcheck_count = 0;
8378 ui_breakcheck();
8383 * Expand wildcards. Calls gen_expand_wildcards() and removes files matching
8384 * 'wildignore'.
8385 * Returns OK or FAIL.
8388 expand_wildcards(num_pat, pat, num_file, file, flags)
8389 int num_pat; /* number of input patterns */
8390 char_u **pat; /* array of input patterns */
8391 int *num_file; /* resulting number of files */
8392 char_u ***file; /* array of resulting files */
8393 int flags; /* EW_DIR, etc. */
8395 int retval;
8396 int i, j;
8397 char_u *p;
8398 int non_suf_match; /* number without matching suffix */
8400 retval = gen_expand_wildcards(num_pat, pat, num_file, file, flags);
8402 /* When keeping all matches, return here */
8403 if (flags & EW_KEEPALL)
8404 return retval;
8406 #ifdef FEAT_WILDIGN
8408 * Remove names that match 'wildignore'.
8410 if (*p_wig)
8412 char_u *ffname;
8414 /* check all files in (*file)[] */
8415 for (i = 0; i < *num_file; ++i)
8417 ffname = FullName_save((*file)[i], FALSE);
8418 if (ffname == NULL) /* out of memory */
8419 break;
8420 # ifdef VMS
8421 vms_remove_version(ffname);
8422 # endif
8423 if (match_file_list(p_wig, (*file)[i], ffname))
8425 /* remove this matching file from the list */
8426 vim_free((*file)[i]);
8427 for (j = i; j + 1 < *num_file; ++j)
8428 (*file)[j] = (*file)[j + 1];
8429 --*num_file;
8430 --i;
8432 vim_free(ffname);
8435 #endif
8438 * Move the names where 'suffixes' match to the end.
8440 if (*num_file > 1)
8442 non_suf_match = 0;
8443 for (i = 0; i < *num_file; ++i)
8445 if (!match_suffix((*file)[i]))
8448 * Move the name without matching suffix to the front
8449 * of the list.
8451 p = (*file)[i];
8452 for (j = i; j > non_suf_match; --j)
8453 (*file)[j] = (*file)[j - 1];
8454 (*file)[non_suf_match++] = p;
8459 return retval;
8463 * Return TRUE if "fname" matches with an entry in 'suffixes'.
8466 match_suffix(fname)
8467 char_u *fname;
8469 int fnamelen, setsuflen;
8470 char_u *setsuf;
8471 #define MAXSUFLEN 30 /* maximum length of a file suffix */
8472 char_u suf_buf[MAXSUFLEN];
8474 fnamelen = (int)STRLEN(fname);
8475 setsuflen = 0;
8476 for (setsuf = p_su; *setsuf; )
8478 setsuflen = copy_option_part(&setsuf, suf_buf, MAXSUFLEN, ".,");
8479 if (fnamelen >= setsuflen
8480 && fnamencmp(suf_buf, fname + fnamelen - setsuflen,
8481 (size_t)setsuflen) == 0)
8482 break;
8483 setsuflen = 0;
8485 return (setsuflen != 0);
8488 #if !defined(NO_EXPANDPATH) || defined(PROTO)
8490 # ifdef VIM_BACKTICK
8491 static int vim_backtick __ARGS((char_u *p));
8492 static int expand_backtick __ARGS((garray_T *gap, char_u *pat, int flags));
8493 # endif
8495 # if defined(MSDOS) || defined(FEAT_GUI_W16) || defined(WIN3264)
8497 * File name expansion code for MS-DOS, Win16 and Win32. It's here because
8498 * it's shared between these systems.
8500 # if defined(DJGPP) || defined(PROTO)
8501 # define _cdecl /* DJGPP doesn't have this */
8502 # else
8503 # ifdef __BORLANDC__
8504 # define _cdecl _RTLENTRYF
8505 # endif
8506 # endif
8509 * comparison function for qsort in dos_expandpath()
8511 static int _cdecl
8512 pstrcmp(const void *a, const void *b)
8514 return (pathcmp(*(char **)a, *(char **)b, -1));
8517 # ifndef WIN3264
8518 static void
8519 namelowcpy(
8520 char_u *d,
8521 char_u *s)
8523 # ifdef DJGPP
8524 if (USE_LONG_FNAME) /* don't lower case on Windows 95/NT systems */
8525 while (*s)
8526 *d++ = *s++;
8527 else
8528 # endif
8529 while (*s)
8530 *d++ = TOLOWER_LOC(*s++);
8531 *d = NUL;
8533 # endif
8536 * Recursively expand one path component into all matching files and/or
8537 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8538 * Return the number of matches found.
8539 * "path" has backslashes before chars that are not to be expanded, starting
8540 * at "path[wildoff]".
8541 * Return the number of matches found.
8542 * NOTE: much of this is identical to unix_expandpath(), keep in sync!
8544 static int
8545 dos_expandpath(
8546 garray_T *gap,
8547 char_u *path,
8548 int wildoff,
8549 int flags, /* EW_* flags */
8550 int didstar) /* expanded "**" once already */
8552 char_u *buf;
8553 char_u *path_end;
8554 char_u *p, *s, *e;
8555 int start_len = gap->ga_len;
8556 char_u *pat;
8557 regmatch_T regmatch;
8558 int starts_with_dot;
8559 int matches;
8560 int len;
8561 int starstar = FALSE;
8562 static int stardepth = 0; /* depth for "**" expansion */
8563 #ifdef WIN3264
8564 WIN32_FIND_DATA fb;
8565 HANDLE hFind = (HANDLE)0;
8566 # ifdef FEAT_MBYTE
8567 WIN32_FIND_DATAW wfb;
8568 WCHAR *wn = NULL; /* UCS-2 name, NULL when not used. */
8569 # endif
8570 #else
8571 struct ffblk fb;
8572 #endif
8573 char_u *matchname;
8574 int ok;
8576 /* Expanding "**" may take a long time, check for CTRL-C. */
8577 if (stardepth > 0)
8579 ui_breakcheck();
8580 if (got_int)
8581 return 0;
8584 /* make room for file name */
8585 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8586 if (buf == NULL)
8587 return 0;
8590 * Find the first part in the path name that contains a wildcard or a ~1.
8591 * Copy it into buf, including the preceding characters.
8593 p = buf;
8594 s = buf;
8595 e = NULL;
8596 path_end = path;
8597 while (*path_end != NUL)
8599 /* May ignore a wildcard that has a backslash before it; it will
8600 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8601 if (path_end >= path + wildoff && rem_backslash(path_end))
8602 *p++ = *path_end++;
8603 else if (*path_end == '\\' || *path_end == ':' || *path_end == '/')
8605 if (e != NULL)
8606 break;
8607 s = p + 1;
8609 else if (path_end >= path + wildoff
8610 && vim_strchr((char_u *)"*?[~", *path_end) != NULL)
8611 e = p;
8612 #ifdef FEAT_MBYTE
8613 if (has_mbyte)
8615 len = (*mb_ptr2len)(path_end);
8616 STRNCPY(p, path_end, len);
8617 p += len;
8618 path_end += len;
8620 else
8621 #endif
8622 *p++ = *path_end++;
8624 e = p;
8625 *e = NUL;
8627 /* now we have one wildcard component between s and e */
8628 /* Remove backslashes between "wildoff" and the start of the wildcard
8629 * component. */
8630 for (p = buf + wildoff; p < s; ++p)
8631 if (rem_backslash(p))
8633 STRCPY(p, p + 1);
8634 --e;
8635 --s;
8638 /* Check for "**" between "s" and "e". */
8639 for (p = s; p < e; ++p)
8640 if (p[0] == '*' && p[1] == '*')
8641 starstar = TRUE;
8643 starts_with_dot = (*s == '.');
8644 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8645 if (pat == NULL)
8647 vim_free(buf);
8648 return 0;
8651 /* compile the regexp into a program */
8652 regmatch.rm_ic = TRUE; /* Always ignore case */
8653 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8654 vim_free(pat);
8656 if (regmatch.regprog == NULL)
8658 vim_free(buf);
8659 return 0;
8662 /* remember the pattern or file name being looked for */
8663 matchname = vim_strsave(s);
8665 /* If "**" is by itself, this is the first time we encounter it and more
8666 * is following then find matches without any directory. */
8667 if (!didstar && stardepth < 100 && starstar && e - s == 2
8668 && *path_end == '/')
8670 STRCPY(s, path_end + 1);
8671 ++stardepth;
8672 (void)dos_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8673 --stardepth;
8676 /* Scan all files in the directory with "dir/ *.*" */
8677 STRCPY(s, "*.*");
8678 #ifdef WIN3264
8679 # ifdef FEAT_MBYTE
8680 if (enc_codepage >= 0 && (int)GetACP() != enc_codepage)
8682 /* The active codepage differs from 'encoding'. Attempt using the
8683 * wide function. If it fails because it is not implemented fall back
8684 * to the non-wide version (for Windows 98) */
8685 wn = enc_to_ucs2(buf, NULL);
8686 if (wn != NULL)
8688 hFind = FindFirstFileW(wn, &wfb);
8689 if (hFind == INVALID_HANDLE_VALUE
8690 && GetLastError() == ERROR_CALL_NOT_IMPLEMENTED)
8692 vim_free(wn);
8693 wn = NULL;
8698 if (wn == NULL)
8699 # endif
8700 hFind = FindFirstFile(buf, &fb);
8701 ok = (hFind != INVALID_HANDLE_VALUE);
8702 #else
8703 /* If we are expanding wildcards we try both files and directories */
8704 ok = (findfirst((char *)buf, &fb,
8705 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8706 #endif
8708 while (ok)
8710 #ifdef WIN3264
8711 # ifdef FEAT_MBYTE
8712 if (wn != NULL)
8713 p = ucs2_to_enc(wfb.cFileName, NULL); /* p is allocated here */
8714 else
8715 # endif
8716 p = (char_u *)fb.cFileName;
8717 #else
8718 p = (char_u *)fb.ff_name;
8719 #endif
8720 /* Ignore entries starting with a dot, unless when asked for. Accept
8721 * all entries found with "matchname". */
8722 if ((p[0] != '.' || starts_with_dot)
8723 && (matchname == NULL
8724 || vim_regexec(&regmatch, p, (colnr_T)0)))
8726 #ifdef WIN3264
8727 STRCPY(s, p);
8728 #else
8729 namelowcpy(s, p);
8730 #endif
8731 len = (int)STRLEN(buf);
8733 if (starstar && stardepth < 100)
8735 /* For "**" in the pattern first go deeper in the tree to
8736 * find matches. */
8737 STRCPY(buf + len, "/**");
8738 STRCPY(buf + len + 3, path_end);
8739 ++stardepth;
8740 (void)dos_expandpath(gap, buf, len + 1, flags, TRUE);
8741 --stardepth;
8744 STRCPY(buf + len, path_end);
8745 if (mch_has_exp_wildcard(path_end))
8747 /* need to expand another component of the path */
8748 /* remove backslashes for the remaining components only */
8749 (void)dos_expandpath(gap, buf, len + 1, flags, FALSE);
8751 else
8753 /* no more wildcards, check if there is a match */
8754 /* remove backslashes for the remaining components only */
8755 if (*path_end != 0)
8756 backslash_halve(buf + len + 1);
8757 if (mch_getperm(buf) >= 0) /* add existing file */
8758 addfile(gap, buf, flags);
8762 #ifdef WIN3264
8763 # ifdef FEAT_MBYTE
8764 if (wn != NULL)
8766 vim_free(p);
8767 ok = FindNextFileW(hFind, &wfb);
8769 else
8770 # endif
8771 ok = FindNextFile(hFind, &fb);
8772 #else
8773 ok = (findnext(&fb) == 0);
8774 #endif
8776 /* If no more matches and no match was used, try expanding the name
8777 * itself. Finds the long name of a short filename. */
8778 if (!ok && matchname != NULL && gap->ga_len == start_len)
8780 STRCPY(s, matchname);
8781 #ifdef WIN3264
8782 FindClose(hFind);
8783 # ifdef FEAT_MBYTE
8784 if (wn != NULL)
8786 vim_free(wn);
8787 wn = enc_to_ucs2(buf, NULL);
8788 if (wn != NULL)
8789 hFind = FindFirstFileW(wn, &wfb);
8791 if (wn == NULL)
8792 # endif
8793 hFind = FindFirstFile(buf, &fb);
8794 ok = (hFind != INVALID_HANDLE_VALUE);
8795 #else
8796 ok = (findfirst((char *)buf, &fb,
8797 (*path_end != NUL || (flags & EW_DIR)) ? FA_DIREC : 0) == 0);
8798 #endif
8799 vim_free(matchname);
8800 matchname = NULL;
8804 #ifdef WIN3264
8805 FindClose(hFind);
8806 # ifdef FEAT_MBYTE
8807 vim_free(wn);
8808 # endif
8809 #endif
8810 vim_free(buf);
8811 vim_free(regmatch.regprog);
8812 vim_free(matchname);
8814 matches = gap->ga_len - start_len;
8815 if (matches > 0)
8816 qsort(((char_u **)gap->ga_data) + start_len, (size_t)matches,
8817 sizeof(char_u *), pstrcmp);
8818 return matches;
8822 mch_expandpath(
8823 garray_T *gap,
8824 char_u *path,
8825 int flags) /* EW_* flags */
8827 return dos_expandpath(gap, path, 0, flags, FALSE);
8829 # endif /* MSDOS || FEAT_GUI_W16 || WIN3264 */
8831 #if (defined(UNIX) && !defined(VMS)) || defined(USE_UNIXFILENAME) \
8832 || defined(PROTO)
8834 * Unix style wildcard expansion code.
8835 * It's here because it's used both for Unix and Mac.
8837 static int pstrcmp __ARGS((const void *, const void *));
8839 static int
8840 pstrcmp(a, b)
8841 const void *a, *b;
8843 return (pathcmp(*(char **)a, *(char **)b, -1));
8847 * Recursively expand one path component into all matching files and/or
8848 * directories. Adds matches to "gap". Handles "*", "?", "[a-z]", "**", etc.
8849 * "path" has backslashes before chars that are not to be expanded, starting
8850 * at "path + wildoff".
8851 * Return the number of matches found.
8852 * NOTE: much of this is identical to dos_expandpath(), keep in sync!
8855 unix_expandpath(gap, path, wildoff, flags, didstar)
8856 garray_T *gap;
8857 char_u *path;
8858 int wildoff;
8859 int flags; /* EW_* flags */
8860 int didstar; /* expanded "**" once already */
8862 char_u *buf;
8863 char_u *path_end;
8864 char_u *p, *s, *e;
8865 int start_len = gap->ga_len;
8866 char_u *pat;
8867 regmatch_T regmatch;
8868 int starts_with_dot;
8869 int matches;
8870 int len;
8871 int starstar = FALSE;
8872 static int stardepth = 0; /* depth for "**" expansion */
8874 DIR *dirp;
8875 struct dirent *dp;
8877 /* Expanding "**" may take a long time, check for CTRL-C. */
8878 if (stardepth > 0)
8880 ui_breakcheck();
8881 if (got_int)
8882 return 0;
8885 /* make room for file name */
8886 buf = alloc((int)STRLEN(path) + BASENAMELEN + 5);
8887 if (buf == NULL)
8888 return 0;
8891 * Find the first part in the path name that contains a wildcard.
8892 * Copy it into "buf", including the preceding characters.
8894 p = buf;
8895 s = buf;
8896 e = NULL;
8897 path_end = path;
8898 while (*path_end != NUL)
8900 /* May ignore a wildcard that has a backslash before it; it will
8901 * be removed by rem_backslash() or file_pat_to_reg_pat() below. */
8902 if (path_end >= path + wildoff && rem_backslash(path_end))
8903 *p++ = *path_end++;
8904 else if (*path_end == '/')
8906 if (e != NULL)
8907 break;
8908 s = p + 1;
8910 else if (path_end >= path + wildoff
8911 && vim_strchr((char_u *)"*?[{~$", *path_end) != NULL)
8912 e = p;
8913 #ifdef FEAT_MBYTE
8914 if (has_mbyte)
8916 len = (*mb_ptr2len)(path_end);
8917 STRNCPY(p, path_end, len);
8918 p += len;
8919 path_end += len;
8921 else
8922 #endif
8923 *p++ = *path_end++;
8925 e = p;
8926 *e = NUL;
8928 /* now we have one wildcard component between "s" and "e" */
8929 /* Remove backslashes between "wildoff" and the start of the wildcard
8930 * component. */
8931 for (p = buf + wildoff; p < s; ++p)
8932 if (rem_backslash(p))
8934 STRCPY(p, p + 1);
8935 --e;
8936 --s;
8939 /* Check for "**" between "s" and "e". */
8940 for (p = s; p < e; ++p)
8941 if (p[0] == '*' && p[1] == '*')
8942 starstar = TRUE;
8944 /* convert the file pattern to a regexp pattern */
8945 starts_with_dot = (*s == '.');
8946 pat = file_pat_to_reg_pat(s, e, NULL, FALSE);
8947 if (pat == NULL)
8949 vim_free(buf);
8950 return 0;
8953 /* compile the regexp into a program */
8954 #ifdef CASE_INSENSITIVE_FILENAME
8955 regmatch.rm_ic = TRUE; /* Behave like Terminal.app */
8956 #else
8957 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
8958 #endif
8959 regmatch.regprog = vim_regcomp(pat, RE_MAGIC);
8960 vim_free(pat);
8962 if (regmatch.regprog == NULL)
8964 vim_free(buf);
8965 return 0;
8968 /* If "**" is by itself, this is the first time we encounter it and more
8969 * is following then find matches without any directory. */
8970 if (!didstar && stardepth < 100 && starstar && e - s == 2
8971 && *path_end == '/')
8973 STRCPY(s, path_end + 1);
8974 ++stardepth;
8975 (void)unix_expandpath(gap, buf, (int)(s - buf), flags, TRUE);
8976 --stardepth;
8979 /* open the directory for scanning */
8980 *s = NUL;
8981 dirp = opendir(*buf == NUL ? "." : (char *)buf);
8983 /* Find all matching entries */
8984 if (dirp != NULL)
8986 for (;;)
8988 dp = readdir(dirp);
8989 if (dp == NULL)
8990 break;
8991 if ((dp->d_name[0] != '.' || starts_with_dot)
8992 && vim_regexec(&regmatch, (char_u *)dp->d_name, (colnr_T)0))
8994 STRCPY(s, dp->d_name);
8995 len = STRLEN(buf);
8997 if (starstar && stardepth < 100)
8999 /* For "**" in the pattern first go deeper in the tree to
9000 * find matches. */
9001 STRCPY(buf + len, "/**");
9002 STRCPY(buf + len + 3, path_end);
9003 ++stardepth;
9004 (void)unix_expandpath(gap, buf, len + 1, flags, TRUE);
9005 --stardepth;
9008 STRCPY(buf + len, path_end);
9009 if (mch_has_exp_wildcard(path_end)) /* handle more wildcards */
9011 /* need to expand another component of the path */
9012 /* remove backslashes for the remaining components only */
9013 (void)unix_expandpath(gap, buf, len + 1, flags, FALSE);
9015 else
9017 /* no more wildcards, check if there is a match */
9018 /* remove backslashes for the remaining components only */
9019 if (*path_end != NUL)
9020 backslash_halve(buf + len + 1);
9021 if (mch_getperm(buf) >= 0) /* add existing file */
9023 #ifdef MACOS_CONVERT
9024 size_t precomp_len = STRLEN(buf)+1;
9025 char_u *precomp_buf =
9026 mac_precompose_path(buf, precomp_len, &precomp_len);
9028 if (precomp_buf)
9030 mch_memmove(buf, precomp_buf, precomp_len);
9031 vim_free(precomp_buf);
9033 #endif
9034 addfile(gap, buf, flags);
9040 closedir(dirp);
9043 vim_free(buf);
9044 vim_free(regmatch.regprog);
9046 matches = gap->ga_len - start_len;
9047 if (matches > 0)
9048 qsort(((char_u **)gap->ga_data) + start_len, matches,
9049 sizeof(char_u *), pstrcmp);
9050 return matches;
9052 #endif
9055 * Generic wildcard expansion code.
9057 * Characters in "pat" that should not be expanded must be preceded with a
9058 * backslash. E.g., "/path\ with\ spaces/my\*star*"
9060 * Return FAIL when no single file was found. In this case "num_file" is not
9061 * set, and "file" may contain an error message.
9062 * Return OK when some files found. "num_file" is set to the number of
9063 * matches, "file" to the array of matches. Call FreeWild() later.
9066 gen_expand_wildcards(num_pat, pat, num_file, file, flags)
9067 int num_pat; /* number of input patterns */
9068 char_u **pat; /* array of input patterns */
9069 int *num_file; /* resulting number of files */
9070 char_u ***file; /* array of resulting files */
9071 int flags; /* EW_* flags */
9073 int i;
9074 garray_T ga;
9075 char_u *p;
9076 static int recursive = FALSE;
9077 int add_pat;
9080 * expand_env() is called to expand things like "~user". If this fails,
9081 * it calls ExpandOne(), which brings us back here. In this case, always
9082 * call the machine specific expansion function, if possible. Otherwise,
9083 * return FAIL.
9085 if (recursive)
9086 #ifdef SPECIAL_WILDCHAR
9087 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9088 #else
9089 return FAIL;
9090 #endif
9092 #ifdef SPECIAL_WILDCHAR
9094 * If there are any special wildcard characters which we cannot handle
9095 * here, call machine specific function for all the expansion. This
9096 * avoids starting the shell for each argument separately.
9097 * For `=expr` do use the internal function.
9099 for (i = 0; i < num_pat; i++)
9101 if (vim_strpbrk(pat[i], (char_u *)SPECIAL_WILDCHAR) != NULL
9102 # ifdef VIM_BACKTICK
9103 && !(vim_backtick(pat[i]) && pat[i][1] == '=')
9104 # endif
9106 return mch_expand_wildcards(num_pat, pat, num_file, file, flags);
9108 #endif
9110 recursive = TRUE;
9113 * The matching file names are stored in a growarray. Init it empty.
9115 ga_init2(&ga, (int)sizeof(char_u *), 30);
9117 for (i = 0; i < num_pat; ++i)
9119 add_pat = -1;
9120 p = pat[i];
9122 #ifdef VIM_BACKTICK
9123 if (vim_backtick(p))
9124 add_pat = expand_backtick(&ga, p, flags);
9125 else
9126 #endif
9129 * First expand environment variables, "~/" and "~user/".
9131 if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9133 p = expand_env_save(p);
9134 if (p == NULL)
9135 p = pat[i];
9136 #ifdef UNIX
9138 * On Unix, if expand_env() can't expand an environment
9139 * variable, use the shell to do that. Discard previously
9140 * found file names and start all over again.
9142 else if (vim_strpbrk(p, (char_u *)"$~") != NULL)
9144 vim_free(p);
9145 ga_clear(&ga);
9146 i = mch_expand_wildcards(num_pat, pat, num_file, file,
9147 flags);
9148 recursive = FALSE;
9149 return i;
9151 #endif
9155 * If there are wildcards: Expand file names and add each match to
9156 * the list. If there is no match, and EW_NOTFOUND is given, add
9157 * the pattern.
9158 * If there are no wildcards: Add the file name if it exists or
9159 * when EW_NOTFOUND is given.
9161 if (mch_has_exp_wildcard(p))
9162 add_pat = mch_expandpath(&ga, p, flags);
9165 if (add_pat == -1 || (add_pat == 0 && (flags & EW_NOTFOUND)))
9167 char_u *t = backslash_halve_save(p);
9169 #if defined(MACOS_CLASSIC)
9170 slash_to_colon(t);
9171 #endif
9172 /* When EW_NOTFOUND is used, always add files and dirs. Makes
9173 * "vim c:/" work. */
9174 if (flags & EW_NOTFOUND)
9175 addfile(&ga, t, flags | EW_DIR | EW_FILE);
9176 else if (mch_getperm(t) >= 0)
9177 addfile(&ga, t, flags);
9178 vim_free(t);
9181 if (p != pat[i])
9182 vim_free(p);
9185 *num_file = ga.ga_len;
9186 *file = (ga.ga_data != NULL) ? (char_u **)ga.ga_data : (char_u **)"";
9188 recursive = FALSE;
9190 return (ga.ga_data != NULL) ? OK : FAIL;
9193 # ifdef VIM_BACKTICK
9196 * Return TRUE if we can expand this backtick thing here.
9198 static int
9199 vim_backtick(p)
9200 char_u *p;
9202 return (*p == '`' && *(p + 1) != NUL && *(p + STRLEN(p) - 1) == '`');
9206 * Expand an item in `backticks` by executing it as a command.
9207 * Currently only works when pat[] starts and ends with a `.
9208 * Returns number of file names found.
9210 static int
9211 expand_backtick(gap, pat, flags)
9212 garray_T *gap;
9213 char_u *pat;
9214 int flags; /* EW_* flags */
9216 char_u *p;
9217 char_u *cmd;
9218 char_u *buffer;
9219 int cnt = 0;
9220 int i;
9222 /* Create the command: lop off the backticks. */
9223 cmd = vim_strnsave(pat + 1, (int)STRLEN(pat) - 2);
9224 if (cmd == NULL)
9225 return 0;
9227 #ifdef FEAT_EVAL
9228 if (*cmd == '=') /* `={expr}`: Expand expression */
9229 buffer = eval_to_string(cmd + 1, &p, TRUE);
9230 else
9231 #endif
9232 buffer = get_cmd_output(cmd, NULL,
9233 (flags & EW_SILENT) ? SHELL_SILENT : 0);
9234 vim_free(cmd);
9235 if (buffer == NULL)
9236 return 0;
9238 cmd = buffer;
9239 while (*cmd != NUL)
9241 cmd = skipwhite(cmd); /* skip over white space */
9242 p = cmd;
9243 while (*p != NUL && *p != '\r' && *p != '\n') /* skip over entry */
9244 ++p;
9245 /* add an entry if it is not empty */
9246 if (p > cmd)
9248 i = *p;
9249 *p = NUL;
9250 addfile(gap, cmd, flags);
9251 *p = i;
9252 ++cnt;
9254 cmd = p;
9255 while (*cmd != NUL && (*cmd == '\r' || *cmd == '\n'))
9256 ++cmd;
9259 vim_free(buffer);
9260 return cnt;
9262 # endif /* VIM_BACKTICK */
9265 * Add a file to a file list. Accepted flags:
9266 * EW_DIR add directories
9267 * EW_FILE add files
9268 * EW_EXEC add executable files
9269 * EW_NOTFOUND add even when it doesn't exist
9270 * EW_ADDSLASH add slash after directory name
9272 void
9273 addfile(gap, f, flags)
9274 garray_T *gap;
9275 char_u *f; /* filename */
9276 int flags;
9278 char_u *p;
9279 int isdir;
9281 /* if the file/dir doesn't exist, may not add it */
9282 if (!(flags & EW_NOTFOUND) && mch_getperm(f) < 0)
9283 return;
9285 #ifdef FNAME_ILLEGAL
9286 /* if the file/dir contains illegal characters, don't add it */
9287 if (vim_strpbrk(f, (char_u *)FNAME_ILLEGAL) != NULL)
9288 return;
9289 #endif
9291 isdir = mch_isdir(f);
9292 if ((isdir && !(flags & EW_DIR)) || (!isdir && !(flags & EW_FILE)))
9293 return;
9295 /* If the file isn't executable, may not add it. Do accept directories. */
9296 if (!isdir && (flags & EW_EXEC) && !mch_can_exe(f))
9297 return;
9299 /* Make room for another item in the file list. */
9300 if (ga_grow(gap, 1) == FAIL)
9301 return;
9303 p = alloc((unsigned)(STRLEN(f) + 1 + isdir));
9304 if (p == NULL)
9305 return;
9307 STRCPY(p, f);
9308 #ifdef BACKSLASH_IN_FILENAME
9309 slash_adjust(p);
9310 #endif
9312 * Append a slash or backslash after directory names if none is present.
9314 #ifndef DONT_ADD_PATHSEP_TO_DIR
9315 if (isdir && (flags & EW_ADDSLASH))
9316 add_pathsep(p);
9317 #endif
9318 ((char_u **)gap->ga_data)[gap->ga_len++] = p;
9320 #endif /* !NO_EXPANDPATH */
9322 #if defined(VIM_BACKTICK) || defined(FEAT_EVAL) || defined(PROTO)
9324 #ifndef SEEK_SET
9325 # define SEEK_SET 0
9326 #endif
9327 #ifndef SEEK_END
9328 # define SEEK_END 2
9329 #endif
9332 * Get the stdout of an external command.
9333 * Returns an allocated string, or NULL for error.
9335 char_u *
9336 get_cmd_output(cmd, infile, flags)
9337 char_u *cmd;
9338 char_u *infile; /* optional input file name */
9339 int flags; /* can be SHELL_SILENT */
9341 char_u *tempname;
9342 char_u *command;
9343 char_u *buffer = NULL;
9344 int len;
9345 int i = 0;
9346 FILE *fd;
9348 if (check_restricted() || check_secure())
9349 return NULL;
9351 /* get a name for the temp file */
9352 if ((tempname = vim_tempname('o')) == NULL)
9354 EMSG(_(e_notmp));
9355 return NULL;
9358 /* Add the redirection stuff */
9359 command = make_filter_cmd(cmd, infile, tempname);
9360 if (command == NULL)
9361 goto done;
9364 * Call the shell to execute the command (errors are ignored).
9365 * Don't check timestamps here.
9367 ++no_check_timestamps;
9368 call_shell(command, SHELL_DOOUT | SHELL_EXPAND | flags);
9369 --no_check_timestamps;
9371 vim_free(command);
9374 * read the names from the file into memory
9376 # ifdef VMS
9377 /* created temporary file is not always readable as binary */
9378 fd = mch_fopen((char *)tempname, "r");
9379 # else
9380 fd = mch_fopen((char *)tempname, READBIN);
9381 # endif
9383 if (fd == NULL)
9385 EMSG2(_(e_notopen), tempname);
9386 goto done;
9389 fseek(fd, 0L, SEEK_END);
9390 len = ftell(fd); /* get size of temp file */
9391 fseek(fd, 0L, SEEK_SET);
9393 buffer = alloc(len + 1);
9394 if (buffer != NULL)
9395 i = (int)fread((char *)buffer, (size_t)1, (size_t)len, fd);
9396 fclose(fd);
9397 mch_remove(tempname);
9398 if (buffer == NULL)
9399 goto done;
9400 #ifdef VMS
9401 len = i; /* VMS doesn't give us what we asked for... */
9402 #endif
9403 if (i != len)
9405 EMSG2(_(e_notread), tempname);
9406 vim_free(buffer);
9407 buffer = NULL;
9409 else
9410 buffer[len] = '\0'; /* make sure the buffer is terminated */
9412 done:
9413 vim_free(tempname);
9414 return buffer;
9416 #endif
9419 * Free the list of files returned by expand_wildcards() or other expansion
9420 * functions.
9422 void
9423 FreeWild(count, files)
9424 int count;
9425 char_u **files;
9427 if (count <= 0 || files == NULL)
9428 return;
9429 #if defined(__EMX__) && defined(__ALWAYS_HAS_TRAILING_NULL_POINTER) /* XXX */
9431 * Is this still OK for when other functions than expand_wildcards() have
9432 * been used???
9434 _fnexplodefree((char **)files);
9435 #else
9436 while (count--)
9437 vim_free(files[count]);
9438 vim_free(files);
9439 #endif
9443 * return TRUE when need to go to Insert mode because of 'insertmode'.
9444 * Don't do this when still processing a command or a mapping.
9445 * Don't do this when inside a ":normal" command.
9448 goto_im()
9450 return (p_im && stuff_empty() && typebuf_typed());