1 /* vim:set ts=8 sts=4 sw=4:
2 * vim600:fdm=marker fdl=1 fdc=3:
4 * VIM - Vi IMproved by Bram Moolenaar
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
12 * fold.c: code for folding
17 #if defined(FEAT_FOLDING) || defined(PROTO)
19 /* local declarations. {{{1 */
20 /* typedef fold_T {{{2 */
22 * The toplevel folds for each window are stored in the w_folds growarray.
23 * Each toplevel fold can contain an array of second level folds in the
24 * fd_nested growarray.
25 * The info stored in both growarrays is the same: An array of fold_T.
29 linenr_T fd_top
; /* first line of fold; for nested fold
30 * relative to parent */
31 linenr_T fd_len
; /* number of lines in the fold */
32 garray_T fd_nested
; /* array of nested folds */
33 char fd_flags
; /* see below */
34 char fd_small
; /* TRUE, FALSE or MAYBE: fold smaller than
35 'foldminlines'; MAYBE applies to nested
39 #define FD_OPEN 0 /* fold is open (nested ones can be closed) */
40 #define FD_CLOSED 1 /* fold is closed */
41 #define FD_LEVEL 2 /* depends on 'foldlevel' (nested folds too) */
43 #define MAX_LEVEL 20 /* maximum fold depth */
45 /* static functions {{{2 */
46 static void newFoldLevelWin
__ARGS((win_T
*wp
));
47 static int checkCloseRec
__ARGS((garray_T
*gap
, linenr_T lnum
, int level
));
48 static int foldFind
__ARGS((garray_T
*gap
, linenr_T lnum
, fold_T
**fpp
));
49 static int foldLevelWin
__ARGS((win_T
*wp
, linenr_T lnum
));
50 static void checkupdate
__ARGS((win_T
*wp
));
51 static void setFoldRepeat
__ARGS((linenr_T lnum
, long count
, int do_open
));
52 static linenr_T setManualFold
__ARGS((linenr_T lnum
, int opening
, int recurse
, int *donep
));
53 static linenr_T setManualFoldWin
__ARGS((win_T
*wp
, linenr_T lnum
, int opening
, int recurse
, int *donep
));
54 static void foldOpenNested
__ARGS((fold_T
*fpr
));
55 static void deleteFoldEntry
__ARGS((garray_T
*gap
, int idx
, int recursive
));
56 static void foldMarkAdjustRecurse
__ARGS((garray_T
*gap
, linenr_T line1
, linenr_T line2
, long amount
, long amount_after
));
57 static int getDeepestNestingRecurse
__ARGS((garray_T
*gap
));
58 static int check_closed
__ARGS((win_T
*win
, fold_T
*fp
, int *use_levelp
, int level
, int *maybe_smallp
, linenr_T lnum_off
));
59 static void checkSmall
__ARGS((win_T
*wp
, fold_T
*fp
, linenr_T lnum_off
));
60 static void setSmallMaybe
__ARGS((garray_T
*gap
));
61 static void foldCreateMarkers
__ARGS((linenr_T start
, linenr_T end
));
62 static void foldAddMarker
__ARGS((linenr_T lnum
, char_u
*marker
, int markerlen
));
63 static void deleteFoldMarkers
__ARGS((fold_T
*fp
, int recursive
, linenr_T lnum_off
));
64 static void foldDelMarker
__ARGS((linenr_T lnum
, char_u
*marker
, int markerlen
));
65 static void foldUpdateIEMS
__ARGS((win_T
*wp
, linenr_T top
, linenr_T bot
));
66 static void parseMarker
__ARGS((win_T
*wp
));
68 static char *e_nofold
= N_("E490: No fold found");
71 * While updating the folds lines between invalid_top and invalid_bot have an
72 * undefined fold level. Only used for the window currently being updated.
74 static linenr_T invalid_top
= (linenr_T
)0;
75 static linenr_T invalid_bot
= (linenr_T
)0;
78 * When using 'foldexpr' we sometimes get the level of the next line, which
79 * calls foldlevel() to get the level of the current line, which hasn't been
80 * stored yet. To get around this chicken-egg problem the level of the
81 * previous line is stored here when available. prev_lnum is zero when the
82 * level is not available.
84 static linenr_T prev_lnum
= 0;
85 static int prev_lnum_lvl
= -1;
87 /* Flags used for "done" argument of setManualFold. */
88 #define DONE_NOTHING 0
89 #define DONE_ACTION 1 /* did close or open a fold */
90 #define DONE_FOLD 2 /* did find a fold */
92 static int foldstartmarkerlen
;
93 static char_u
*foldendmarker
;
94 static int foldendmarkerlen
;
96 /* Exported folding functions. {{{1 */
97 /* copyFoldingState() {{{2 */
98 #if defined(FEAT_WINDOWS) || defined(PROTO)
100 * Copy that folding state from window "wp_from" to window "wp_to".
103 copyFoldingState(wp_from
, wp_to
)
107 wp_to
->w_fold_manual
= wp_from
->w_fold_manual
;
108 wp_to
->w_foldinvalid
= wp_from
->w_foldinvalid
;
109 cloneFoldGrowArray(&wp_from
->w_folds
, &wp_to
->w_folds
);
113 /* hasAnyFolding() {{{2 */
115 * Return TRUE if there may be folded lines in the current window.
121 /* very simple now, but can become more complex later */
123 && (!foldmethodIsManual(win
) || win
->w_folds
.ga_len
> 0));
126 /* hasFolding() {{{2 */
128 * Return TRUE if line "lnum" in the current window is part of a closed
130 * When returning TRUE, *firstp and *lastp are set to the first and last
131 * lnum of the sequence of folded lines (skipped when NULL).
134 hasFolding(lnum
, firstp
, lastp
)
139 return hasFoldingWin(curwin
, lnum
, firstp
, lastp
, TRUE
, NULL
);
142 /* hasFoldingWin() {{{2 */
144 hasFoldingWin(win
, lnum
, firstp
, lastp
, cache
, infop
)
149 int cache
; /* when TRUE: use cached values of window */
150 foldinfo_T
*infop
; /* where to store fold info */
152 int had_folded
= FALSE
;
155 linenr_T lnum_rel
= lnum
;
159 int use_level
= FALSE
;
160 int maybe_small
= FALSE
;
166 * Return quickly when there is no folding at all in this window.
168 if (!hasAnyFolding(win
))
178 * First look in cached info for displayed lines. This is probably
179 * the fastest, but it can only be used if the entry is still valid.
181 x
= find_wl_entry(win
, lnum
);
184 first
= win
->w_lines
[x
].wl_lnum
;
185 last
= win
->w_lines
[x
].wl_lastlnum
;
186 had_folded
= win
->w_lines
[x
].wl_folded
;
193 * Recursively search for a fold that contains "lnum".
198 if (!foldFind(gap
, lnum_rel
, &fp
))
201 /* Remember lowest level of fold that starts in "lnum". */
202 if (lnum_rel
== fp
->fd_top
&& low_level
== 0)
203 low_level
= level
+ 1;
208 /* is this fold closed? */
209 had_folded
= check_closed(win
, fp
, &use_level
, level
,
210 &maybe_small
, lnum
- lnum_rel
);
213 /* Fold closed: Set last and quit loop. */
214 last
+= fp
->fd_len
- 1;
218 /* Fold found, but it's open: Check nested folds. Line number is
219 * relative to containing fold. */
220 gap
= &fp
->fd_nested
;
221 lnum_rel
-= fp
->fd_top
;
230 infop
->fi_level
= level
;
231 infop
->fi_lnum
= lnum
- lnum_rel
;
232 infop
->fi_low_level
= low_level
== 0 ? level
: low_level
;
243 infop
->fi_level
= level
+ 1;
244 infop
->fi_lnum
= first
;
245 infop
->fi_low_level
= low_level
== 0 ? level
+ 1 : low_level
;
250 /* foldLevel() {{{2 */
252 * Return fold level at line number "lnum" in the current window.
258 /* While updating the folds lines between invalid_top and invalid_bot have
259 * an undefined fold level. Otherwise update the folds first. */
260 if (invalid_top
== (linenr_T
)0)
262 else if (lnum
== prev_lnum
&& prev_lnum_lvl
>= 0)
263 return prev_lnum_lvl
;
264 else if (lnum
>= invalid_top
&& lnum
<= invalid_bot
)
267 /* Return quickly when there is no folding at all in this window. */
268 if (!hasAnyFolding(curwin
))
271 return foldLevelWin(curwin
, lnum
);
274 /* lineFolded() {{{2 */
276 * Low level function to check if a line is folded. Doesn't use any caching.
277 * Return TRUE if line is folded.
278 * Return FALSE if line is not folded.
279 * Return MAYBE if the line is folded when next to a folded line.
282 lineFolded(win
, lnum
)
286 return foldedCount(win
, lnum
, NULL
) != 0;
289 /* foldedCount() {{{2 */
291 * Count the number of lines that are folded at line number "lnum".
292 * Normally "lnum" is the first line of a possible fold, and the returned
293 * number is the number of lines in the fold.
294 * Doesn't use caching from the displayed window.
295 * Returns number of folded lines from "lnum", or 0 if line is not folded.
296 * When "infop" is not NULL, fills *infop with the fold level info.
299 foldedCount(win
, lnum
, infop
)
306 if (hasFoldingWin(win
, lnum
, NULL
, &last
, FALSE
, infop
))
307 return (long)(last
- lnum
+ 1);
311 /* foldmethodIsManual() {{{2 */
313 * Return TRUE if 'foldmethod' is "manual"
316 foldmethodIsManual(wp
)
319 return (wp
->w_p_fdm
[3] == 'u');
322 /* foldmethodIsIndent() {{{2 */
324 * Return TRUE if 'foldmethod' is "indent"
327 foldmethodIsIndent(wp
)
330 return (wp
->w_p_fdm
[0] == 'i');
333 /* foldmethodIsExpr() {{{2 */
335 * Return TRUE if 'foldmethod' is "expr"
341 return (wp
->w_p_fdm
[1] == 'x');
344 /* foldmethodIsMarker() {{{2 */
346 * Return TRUE if 'foldmethod' is "marker"
349 foldmethodIsMarker(wp
)
352 return (wp
->w_p_fdm
[2] == 'r');
355 /* foldmethodIsSyntax() {{{2 */
357 * Return TRUE if 'foldmethod' is "syntax"
360 foldmethodIsSyntax(wp
)
363 return (wp
->w_p_fdm
[0] == 's');
366 /* foldmethodIsDiff() {{{2 */
368 * Return TRUE if 'foldmethod' is "diff"
374 return (wp
->w_p_fdm
[0] == 'd');
377 /* closeFold() {{{2 */
379 * Close fold for current window at line "lnum".
380 * Repeat "count" times.
383 closeFold(lnum
, count
)
387 setFoldRepeat(lnum
, count
, FALSE
);
390 /* closeFoldRecurse() {{{2 */
392 * Close fold for current window at line "lnum" recursively.
395 closeFoldRecurse(lnum
)
398 (void)setManualFold(lnum
, FALSE
, TRUE
, NULL
);
401 /* opFoldRange() {{{2 */
403 * Open or Close folds for current window in lines "first" to "last".
404 * Used for "zo", "zO", "zc" and "zC" in Visual mode.
407 opFoldRange(first
, last
, opening
, recurse
, had_visual
)
410 int opening
; /* TRUE to open, FALSE to close */
411 int recurse
; /* TRUE to do it recursively */
412 int had_visual
; /* TRUE when Visual selection used */
414 int done
= DONE_NOTHING
; /* avoid error messages */
418 for (lnum
= first
; lnum
<= last
; lnum
= lnum_next
+ 1)
421 /* Opening one level only: next fold to open is after the one going to
423 if (opening
&& !recurse
)
424 (void)hasFolding(lnum
, NULL
, &lnum_next
);
425 (void)setManualFold(lnum
, opening
, recurse
, &done
);
426 /* Closing one level only: next line to close a fold is after just
428 if (!opening
&& !recurse
)
429 (void)hasFolding(lnum
, NULL
, &lnum_next
);
431 if (done
== DONE_NOTHING
)
434 /* Force a redraw to remove the Visual highlighting. */
436 redraw_curbuf_later(INVERTED
);
440 /* openFold() {{{2 */
442 * Open fold for current window at line "lnum".
443 * Repeat "count" times.
446 openFold(lnum
, count
)
450 setFoldRepeat(lnum
, count
, TRUE
);
453 /* openFoldRecurse() {{{2 */
455 * Open fold for current window at line "lnum" recursively.
458 openFoldRecurse(lnum
)
461 (void)setManualFold(lnum
, TRUE
, TRUE
, NULL
);
464 /* foldOpenCursor() {{{2 */
466 * Open folds until the cursor line is not in a closed fold.
474 if (hasAnyFolding(curwin
))
478 (void)setManualFold(curwin
->w_cursor
.lnum
, TRUE
, FALSE
, &done
);
479 if (!(done
& DONE_ACTION
))
484 /* newFoldLevel() {{{2 */
486 * Set new foldlevel for current window.
491 newFoldLevelWin(curwin
);
494 if (foldmethodIsDiff(curwin
) && curwin
->w_p_scb
)
499 * Set the same foldlevel in other windows in diff mode.
503 if (wp
!= curwin
&& foldmethodIsDiff(wp
) && wp
->w_p_scb
)
505 wp
->w_p_fdl
= curwin
->w_p_fdl
;
521 if (wp
->w_fold_manual
)
523 /* Set all flags for the first level of folds to FD_LEVEL. Following
524 * manual open/close will then change the flags to FD_OPEN or
525 * FD_CLOSED for those folds that don't use 'foldlevel'. */
526 fp
= (fold_T
*)wp
->w_folds
.ga_data
;
527 for (i
= 0; i
< wp
->w_folds
.ga_len
; ++i
)
528 fp
[i
].fd_flags
= FD_LEVEL
;
529 wp
->w_fold_manual
= FALSE
;
531 changed_window_setting_win(wp
);
534 /* foldCheckClose() {{{2 */
536 * Apply 'foldlevel' to all folds that don't contain the cursor.
541 if (*p_fcl
!= NUL
) /* can only be "all" right now */
544 if (checkCloseRec(&curwin
->w_folds
, curwin
->w_cursor
.lnum
,
545 (int)curwin
->w_p_fdl
))
546 changed_window_setting();
550 /* checkCloseRec() {{{2 */
552 checkCloseRec(gap
, lnum
, level
)
561 fp
= (fold_T
*)gap
->ga_data
;
562 for (i
= 0; i
< gap
->ga_len
; ++i
)
564 /* Only manually opened folds may need to be closed. */
565 if (fp
[i
].fd_flags
== FD_OPEN
)
567 if (level
<= 0 && (lnum
< fp
[i
].fd_top
568 || lnum
>= fp
[i
].fd_top
+ fp
[i
].fd_len
))
570 fp
[i
].fd_flags
= FD_LEVEL
;
574 retval
|= checkCloseRec(&fp
[i
].fd_nested
, lnum
- fp
[i
].fd_top
,
581 /* foldCreateAllowed() {{{2 */
583 * Return TRUE if it's allowed to manually create or delete a fold.
584 * Give an error message and return FALSE if not.
587 foldManualAllowed(create
)
590 if (foldmethodIsManual(curwin
) || foldmethodIsMarker(curwin
))
593 EMSG(_("E350: Cannot create fold with current 'foldmethod'"));
595 EMSG(_("E351: Cannot delete fold with current 'foldmethod'"));
599 /* foldCreate() {{{2 */
601 * Create a fold from line "start" to line "end" (inclusive) in the current
605 foldCreate(start
, end
)
614 int use_level
= FALSE
;
617 linenr_T start_rel
= start
;
618 linenr_T end_rel
= end
;
622 /* reverse the range */
629 /* When 'foldmethod' is "marker" add markers, which creates the folds. */
630 if (foldmethodIsMarker(curwin
))
632 foldCreateMarkers(start
, end
);
638 /* Find the place to insert the new fold. */
639 gap
= &curwin
->w_folds
;
642 if (!foldFind(gap
, start_rel
, &fp
))
644 if (fp
->fd_top
+ fp
->fd_len
> end_rel
)
646 /* New fold is completely inside this fold: Go one level deeper. */
647 gap
= &fp
->fd_nested
;
648 start_rel
-= fp
->fd_top
;
649 end_rel
-= fp
->fd_top
;
650 if (use_level
|| fp
->fd_flags
== FD_LEVEL
)
653 if (level
>= curwin
->w_p_fdl
)
656 else if (fp
->fd_flags
== FD_CLOSED
)
662 /* This fold and new fold overlap: Insert here and move some folds
663 * inside the new fold. */
668 i
= (int)(fp
- (fold_T
*)gap
->ga_data
);
669 if (ga_grow(gap
, 1) == OK
)
671 fp
= (fold_T
*)gap
->ga_data
+ i
;
672 ga_init2(&fold_ga
, (int)sizeof(fold_T
), 10);
674 /* Count number of folds that will be contained in the new fold. */
675 for (cont
= 0; i
+ cont
< gap
->ga_len
; ++cont
)
676 if (fp
[cont
].fd_top
> end_rel
)
678 if (cont
> 0 && ga_grow(&fold_ga
, cont
) == OK
)
680 /* If the first fold starts before the new fold, let the new fold
681 * start there. Otherwise the existing fold would change. */
682 if (start_rel
> fp
->fd_top
)
683 start_rel
= fp
->fd_top
;
685 /* When last contained fold isn't completely contained, adjust end
687 if (end_rel
< fp
[cont
- 1].fd_top
+ fp
[cont
- 1].fd_len
- 1)
688 end_rel
= fp
[cont
- 1].fd_top
+ fp
[cont
- 1].fd_len
- 1;
689 /* Move contained folds to inside new fold. */
690 mch_memmove(fold_ga
.ga_data
, fp
, sizeof(fold_T
) * cont
);
691 fold_ga
.ga_len
+= cont
;
694 /* Adjust line numbers in contained folds to be relative to the
696 for (j
= 0; j
< cont
; ++j
)
697 ((fold_T
*)fold_ga
.ga_data
)[j
].fd_top
-= start_rel
;
699 /* Move remaining entries to after the new fold. */
701 mch_memmove(fp
+ 1, (fold_T
*)gap
->ga_data
+ i
,
702 sizeof(fold_T
) * (gap
->ga_len
- i
));
703 gap
->ga_len
= gap
->ga_len
+ 1 - cont
;
705 /* insert new fold */
706 fp
->fd_nested
= fold_ga
;
707 fp
->fd_top
= start_rel
;
708 fp
->fd_len
= end_rel
- start_rel
+ 1;
710 /* We want the new fold to be closed. If it would remain open because
711 * of using 'foldlevel', need to adjust fd_flags of containing folds.
713 if (use_level
&& !closed
&& level
< curwin
->w_p_fdl
)
714 closeFold(start
, 1L);
716 curwin
->w_fold_manual
= TRUE
;
717 fp
->fd_flags
= FD_CLOSED
;
718 fp
->fd_small
= MAYBE
;
721 changed_window_setting();
725 /* deleteFold() {{{2 */
727 * Delete a fold at line "start" in the current window.
728 * When "end" is not 0, delete all folds from "start" to "end".
729 * When "recursive" is TRUE delete recursively.
732 deleteFold(start
, end
, recursive
, had_visual
)
736 int had_visual
; /* TRUE when Visual selection used */
741 fold_T
*found_fp
= NULL
;
742 linenr_T found_off
= 0;
744 int maybe_small
= FALSE
;
746 linenr_T lnum
= start
;
749 linenr_T first_lnum
= MAXLNUM
;
750 linenr_T last_lnum
= 0;
756 /* Find the deepest fold for "start". */
757 gap
= &curwin
->w_folds
;
763 if (!foldFind(gap
, lnum
- lnum_off
, &fp
))
765 /* lnum is inside this fold, remember info */
768 found_off
= lnum_off
;
770 /* if "lnum" is folded, don't check nesting */
771 if (check_closed(curwin
, fp
, &use_level
, level
,
772 &maybe_small
, lnum_off
))
775 /* check nested folds */
776 gap
= &fp
->fd_nested
;
777 lnum_off
+= fp
->fd_top
;
780 if (found_ga
== NULL
)
786 lnum
= found_fp
->fd_top
+ found_fp
->fd_len
+ found_off
;
788 if (foldmethodIsManual(curwin
))
789 deleteFoldEntry(found_ga
,
790 (int)(found_fp
- (fold_T
*)found_ga
->ga_data
), recursive
);
793 if (first_lnum
> found_fp
->fd_top
+ found_off
)
794 first_lnum
= found_fp
->fd_top
+ found_off
;
795 if (last_lnum
< lnum
)
799 deleteFoldMarkers(found_fp
, recursive
, found_off
);
804 changed_window_setting();
811 /* Force a redraw to remove the Visual highlighting. */
813 redraw_curbuf_later(INVERTED
);
817 /* Deleting markers may make cursor column invalid. */
821 changed_lines(first_lnum
, (colnr_T
)0, last_lnum
, 0L);
824 /* clearFolding() {{{2 */
826 * Remove all folding for window "win".
832 deleteFoldRecurse(&win
->w_folds
);
833 win
->w_foldinvalid
= FALSE
;
836 /* foldUpdate() {{{2 */
838 * Update folds for changes in the buffer of a window.
839 * Note that inserted/deleted lines must have already been taken care of by
840 * calling foldMarkAdjust().
841 * The changes in lines from top to bot (inclusive).
844 foldUpdate(wp
, top
, bot
)
851 /* Mark all folds from top to bot as maybe-small. */
852 (void)foldFind(&curwin
->w_folds
, top
, &fp
);
853 while (fp
< (fold_T
*)curwin
->w_folds
.ga_data
+ curwin
->w_folds
.ga_len
856 fp
->fd_small
= MAYBE
;
858 /* Not sure if this is the right place to reset fd_flags (suggested by
860 if (wp
->w_foldinvalid
)
861 fp
->fd_flags
= FD_LEVEL
;
866 if (foldmethodIsIndent(wp
)
867 || foldmethodIsExpr(wp
)
868 || foldmethodIsMarker(wp
)
870 || foldmethodIsDiff(wp
)
872 || foldmethodIsSyntax(wp
))
874 int save_got_int
= got_int
;
876 /* reset got_int here, otherwise it won't work */
878 foldUpdateIEMS(wp
, top
, bot
);
879 got_int
|= save_got_int
;
883 /* foldUpdateAll() {{{2 */
885 * Update all lines in a window for folding.
886 * Used when a fold setting changes or after reloading the buffer.
887 * The actual updating is postponed until fold info is used, to avoid doing
888 * every time a setting is changed or a syntax item is added.
894 win
->w_foldinvalid
= TRUE
;
895 redraw_win_later(win
, NOT_VALID
);
898 /* foldMoveTo() {{{2 */
900 * If "updown" is FALSE: Move to the start or end of the fold.
901 * If "updown" is TRUE: move to fold at the same level.
902 * If not moved return FAIL.
905 foldMoveTo(updown
, dir
, count
)
907 int dir
; /* FORWARD or BACKWARD */
924 /* Repeat "count" times. */
925 for (n
= 0; n
< count
; ++n
)
927 /* Find nested folds. Stop when a fold is closed. The deepest fold
928 * that moves the cursor is used. */
930 gap
= &curwin
->w_folds
;
933 lnum_found
= curwin
->w_cursor
.lnum
;
938 if (!foldFind(gap
, curwin
->w_cursor
.lnum
- lnum_off
, &fp
))
943 /* When moving up, consider a fold above the cursor; when
944 * moving down consider a fold below the cursor. */
947 if (fp
- (fold_T
*)gap
->ga_data
>= gap
->ga_len
)
953 if (fp
== (fold_T
*)gap
->ga_data
)
956 /* don't look for contained folds, they will always move
957 * the cursor too far. */
963 /* Check if this fold is closed. */
964 if (check_closed(curwin
, fp
, &use_level
, level
,
965 &maybe_small
, lnum_off
))
968 /* "[z" and "]z" stop at closed fold */
977 /* to start of next fold if there is one */
978 if (fp
+ 1 - (fold_T
*)gap
->ga_data
< gap
->ga_len
)
980 lnum
= fp
[1].fd_top
+ lnum_off
;
981 if (lnum
> curwin
->w_cursor
.lnum
)
987 /* to end of previous fold if there is one */
988 if (fp
> (fold_T
*)gap
->ga_data
)
990 lnum
= fp
[-1].fd_top
+ lnum_off
+ fp
[-1].fd_len
- 1;
991 if (lnum
< curwin
->w_cursor
.lnum
)
998 /* Open fold found, set cursor to its start/end and then check
1002 lnum
= fp
->fd_top
+ lnum_off
+ fp
->fd_len
- 1;
1003 if (lnum
> curwin
->w_cursor
.lnum
)
1008 lnum
= fp
->fd_top
+ lnum_off
;
1009 if (lnum
< curwin
->w_cursor
.lnum
)
1017 /* Check nested folds (if any). */
1018 gap
= &fp
->fd_nested
;
1019 lnum_off
+= fp
->fd_top
;
1022 if (lnum_found
!= curwin
->w_cursor
.lnum
)
1026 curwin
->w_cursor
.lnum
= lnum_found
;
1027 curwin
->w_cursor
.col
= 0;
1037 /* foldInitWin() {{{2 */
1039 * Init the fold info in a new window.
1045 ga_init2(&newwin
->w_folds
, (int)sizeof(fold_T
), 10);
1048 /* find_wl_entry() {{{2 */
1050 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1051 * Only valid entries are considered (for entries where wl_valid is FALSE the
1052 * line number can be wrong).
1053 * Returns index of entry or -1 if not found.
1056 find_wl_entry(win
, lnum
)
1062 if (win
->w_lines_valid
> 0)
1063 for (i
= 0; i
< win
->w_lines_valid
; ++i
)
1064 if (win
->w_lines
[i
].wl_valid
)
1066 if (lnum
< win
->w_lines
[i
].wl_lnum
)
1068 if (lnum
<= win
->w_lines
[i
].wl_lastlnum
)
1074 /* foldAdjustVisual() {{{2 */
1077 * Adjust the Visual area to include any fold at the start or end completely.
1085 if (!VIsual_active
|| !hasAnyFolding(curwin
))
1088 if (ltoreq(VIsual
, curwin
->w_cursor
))
1091 end
= &curwin
->w_cursor
;
1095 start
= &curwin
->w_cursor
;
1098 if (hasFolding(start
->lnum
, &start
->lnum
, NULL
))
1100 if (hasFolding(end
->lnum
, NULL
, &end
->lnum
))
1102 ptr
= ml_get(end
->lnum
);
1103 end
->col
= (colnr_T
)STRLEN(ptr
);
1104 if (end
->col
> 0 && *p_sel
== 'o')
1107 /* prevent cursor from moving on the trail byte */
1115 /* cursor_foldstart() {{{2 */
1117 * Move the cursor to the first line of a closed fold.
1122 (void)hasFolding(curwin
->w_cursor
.lnum
, &curwin
->w_cursor
.lnum
, NULL
);
1125 /* Internal functions for "fold_T" {{{1 */
1126 /* cloneFoldGrowArray() {{{2 */
1128 * Will "clone" (i.e deep copy) a garray_T of folds.
1130 * Return FAIL if the operation cannot be completed, otherwise OK.
1133 cloneFoldGrowArray(from
, to
)
1141 ga_init2(to
, from
->ga_itemsize
, from
->ga_growsize
);
1142 if (from
->ga_len
== 0 || ga_grow(to
, from
->ga_len
) == FAIL
)
1145 from_p
= (fold_T
*)from
->ga_data
;
1146 to_p
= (fold_T
*)to
->ga_data
;
1148 for (i
= 0; i
< from
->ga_len
; i
++)
1150 to_p
->fd_top
= from_p
->fd_top
;
1151 to_p
->fd_len
= from_p
->fd_len
;
1152 to_p
->fd_flags
= from_p
->fd_flags
;
1153 to_p
->fd_small
= from_p
->fd_small
;
1154 cloneFoldGrowArray(&from_p
->fd_nested
, &to_p
->fd_nested
);
1161 /* foldFind() {{{2 */
1163 * Search for line "lnum" in folds of growarray "gap".
1164 * Set *fpp to the fold struct for the fold that contains "lnum" or
1165 * the first fold below it (careful: it can be beyond the end of the array!).
1166 * Returns FALSE when there is no fold that contains "lnum".
1169 foldFind(gap
, lnum
, fpp
)
1179 * Perform a binary search.
1180 * "low" is lowest index of possible match.
1181 * "high" is highest index of possible match.
1183 fp
= (fold_T
*)gap
->ga_data
;
1185 high
= gap
->ga_len
- 1;
1188 i
= (low
+ high
) / 2;
1189 if (fp
[i
].fd_top
> lnum
)
1190 /* fold below lnum, adjust high */
1192 else if (fp
[i
].fd_top
+ fp
[i
].fd_len
<= lnum
)
1193 /* fold above lnum, adjust low */
1197 /* lnum is inside this fold */
1206 /* foldLevelWin() {{{2 */
1208 * Return fold level at line number "lnum" in window "wp".
1211 foldLevelWin(wp
, lnum
)
1216 linenr_T lnum_rel
= lnum
;
1220 /* Recursively search for a fold that contains "lnum". */
1224 if (!foldFind(gap
, lnum_rel
, &fp
))
1226 /* Check nested folds. Line number is relative to containing fold. */
1227 gap
= &fp
->fd_nested
;
1228 lnum_rel
-= fp
->fd_top
;
1235 /* checkupdate() {{{2 */
1237 * Check if the folds in window "wp" are invalid and update them if needed.
1243 if (wp
->w_foldinvalid
)
1245 foldUpdate(wp
, (linenr_T
)1, (linenr_T
)MAXLNUM
); /* will update all */
1246 wp
->w_foldinvalid
= FALSE
;
1250 /* setFoldRepeat() {{{2 */
1252 * Open or close fold for current window at line "lnum".
1253 * Repeat "count" times.
1256 setFoldRepeat(lnum
, count
, do_open
)
1264 for (n
= 0; n
< count
; ++n
)
1266 done
= DONE_NOTHING
;
1267 (void)setManualFold(lnum
, do_open
, FALSE
, &done
);
1268 if (!(done
& DONE_ACTION
))
1270 /* Only give an error message when no fold could be opened. */
1271 if (n
== 0 && !(done
& DONE_FOLD
))
1278 /* setManualFold() {{{2 */
1280 * Open or close the fold in the current window which contains "lnum".
1281 * Also does this for other windows in diff mode when needed.
1284 setManualFold(lnum
, opening
, recurse
, donep
)
1286 int opening
; /* TRUE when opening, FALSE when closing */
1287 int recurse
; /* TRUE when closing/opening recursive */
1291 if (foldmethodIsDiff(curwin
) && curwin
->w_p_scb
)
1297 * Do the same operation in other windows in diff mode. Calculate the
1298 * line number from the diffs.
1302 if (wp
!= curwin
&& foldmethodIsDiff(wp
) && wp
->w_p_scb
)
1304 dlnum
= diff_lnum_win(curwin
->w_cursor
.lnum
, wp
);
1306 (void)setManualFoldWin(wp
, dlnum
, opening
, recurse
, NULL
);
1312 return setManualFoldWin(curwin
, lnum
, opening
, recurse
, donep
);
1315 /* setManualFoldWin() {{{2 */
1317 * Open or close the fold in window "wp" which contains "lnum".
1318 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1319 * fold was found and to DONE_ACTION when some fold was opened or closed.
1320 * When "donep" is NULL give an error message when no fold was found for
1321 * "lnum", but only if "wp" is "curwin".
1322 * Return the line number of the next line that could be closed.
1323 * It's only valid when "opening" is TRUE!
1326 setManualFoldWin(wp
, lnum
, opening
, recurse
, donep
)
1329 int opening
; /* TRUE when opening, FALSE when closing */
1330 int recurse
; /* TRUE when closing/opening recursive */
1335 fold_T
*found
= NULL
;
1338 int use_level
= FALSE
;
1339 int found_fold
= FALSE
;
1341 linenr_T next
= MAXLNUM
;
1348 * Find the fold, open or close it.
1353 if (!foldFind(gap
, lnum
, &fp
))
1355 /* If there is a following fold, continue there next time. */
1356 if (fp
< (fold_T
*)gap
->ga_data
+ gap
->ga_len
)
1357 next
= fp
->fd_top
+ off
;
1361 /* lnum is inside this fold */
1364 /* If there is a following fold, continue there next time. */
1365 if (fp
+ 1 < (fold_T
*)gap
->ga_data
+ gap
->ga_len
)
1366 next
= fp
[1].fd_top
+ off
;
1368 /* Change from level-dependent folding to manual. */
1369 if (use_level
|| fp
->fd_flags
== FD_LEVEL
)
1372 if (level
>= wp
->w_p_fdl
)
1373 fp
->fd_flags
= FD_CLOSED
;
1375 fp
->fd_flags
= FD_OPEN
;
1376 fp2
= (fold_T
*)fp
->fd_nested
.ga_data
;
1377 for (j
= 0; j
< fp
->fd_nested
.ga_len
; ++j
)
1378 fp2
[j
].fd_flags
= FD_LEVEL
;
1381 /* Simple case: Close recursively means closing the fold. */
1382 if (!opening
&& recurse
)
1384 if (fp
->fd_flags
!= FD_CLOSED
)
1386 done
|= DONE_ACTION
;
1387 fp
->fd_flags
= FD_CLOSED
;
1390 else if (fp
->fd_flags
== FD_CLOSED
)
1392 /* When opening, open topmost closed fold. */
1395 fp
->fd_flags
= FD_OPEN
;
1396 done
|= DONE_ACTION
;
1403 /* fold is open, check nested folds */
1405 gap
= &fp
->fd_nested
;
1412 /* When closing and not recurse, close deepest open fold. */
1413 if (!opening
&& found
!= NULL
)
1415 found
->fd_flags
= FD_CLOSED
;
1416 done
|= DONE_ACTION
;
1418 wp
->w_fold_manual
= TRUE
;
1419 if (done
& DONE_ACTION
)
1420 changed_window_setting_win(wp
);
1423 else if (donep
== NULL
&& wp
== curwin
)
1432 /* foldOpenNested() {{{2 */
1434 * Open all nested folds in fold "fpr" recursively.
1443 fp
= (fold_T
*)fpr
->fd_nested
.ga_data
;
1444 for (i
= 0; i
< fpr
->fd_nested
.ga_len
; ++i
)
1446 foldOpenNested(&fp
[i
]);
1447 fp
[i
].fd_flags
= FD_OPEN
;
1451 /* deleteFoldEntry() {{{2 */
1453 * Delete fold "idx" from growarray "gap".
1454 * When "recursive" is TRUE also delete all the folds contained in it.
1455 * When "recursive" is FALSE contained folds are moved one level up.
1458 deleteFoldEntry(gap
, idx
, recursive
)
1468 fp
= (fold_T
*)gap
->ga_data
+ idx
;
1469 if (recursive
|| fp
->fd_nested
.ga_len
== 0)
1471 /* recursively delete the contained folds */
1472 deleteFoldRecurse(&fp
->fd_nested
);
1474 if (idx
< gap
->ga_len
)
1475 mch_memmove(fp
, fp
+ 1, sizeof(fold_T
) * (gap
->ga_len
- idx
));
1479 /* move nested folds one level up, to overwrite the fold that is
1481 moved
= fp
->fd_nested
.ga_len
;
1482 if (ga_grow(gap
, (int)(moved
- 1)) == OK
)
1484 /* adjust fd_top and fd_flags for the moved folds */
1485 nfp
= (fold_T
*)fp
->fd_nested
.ga_data
;
1486 for (i
= 0; i
< moved
; ++i
)
1488 nfp
[i
].fd_top
+= fp
->fd_top
;
1489 if (fp
->fd_flags
== FD_LEVEL
)
1490 nfp
[i
].fd_flags
= FD_LEVEL
;
1491 if (fp
->fd_small
== MAYBE
)
1492 nfp
[i
].fd_small
= MAYBE
;
1495 /* move the existing folds down to make room */
1496 if (idx
< gap
->ga_len
)
1497 mch_memmove(fp
+ moved
, fp
+ 1,
1498 sizeof(fold_T
) * (gap
->ga_len
- idx
));
1499 /* move the contained folds one level up */
1500 mch_memmove(fp
, nfp
, (size_t)(sizeof(fold_T
) * moved
));
1502 gap
->ga_len
+= moved
- 1;
1507 /* deleteFoldRecurse() {{{2 */
1509 * Delete nested folds in a fold.
1512 deleteFoldRecurse(gap
)
1517 for (i
= 0; i
< gap
->ga_len
; ++i
)
1518 deleteFoldRecurse(&(((fold_T
*)(gap
->ga_data
))[i
].fd_nested
));
1522 /* foldMarkAdjust() {{{2 */
1524 * Update line numbers of folds for inserted/deleted lines.
1527 foldMarkAdjust(wp
, line1
, line2
, amount
, amount_after
)
1534 /* If deleting marks from line1 to line2, but not deleting all those
1535 * lines, set line2 so that only deleted lines have their folds removed. */
1536 if (amount
== MAXLNUM
&& line2
>= line1
&& line2
- line1
>= -amount_after
)
1537 line2
= line1
- amount_after
- 1;
1538 /* If appending a line in Insert mode, it should be included in the fold
1539 * just above the line. */
1540 if ((State
& INSERT
) && amount
== (linenr_T
)1 && line2
== MAXLNUM
)
1542 foldMarkAdjustRecurse(&wp
->w_folds
, line1
, line2
, amount
, amount_after
);
1545 /* foldMarkAdjustRecurse() {{{2 */
1547 foldMarkAdjustRecurse(gap
, line1
, line2
, amount
, amount_after
)
1559 /* In Insert mode an inserted line at the top of a fold is considered part
1560 * of the fold, otherwise it isn't. */
1561 if ((State
& INSERT
) && amount
== (linenr_T
)1 && line2
== MAXLNUM
)
1566 /* Find the fold containing or just below "line1". */
1567 (void)foldFind(gap
, line1
, &fp
);
1570 * Adjust all folds below "line1" that are affected.
1572 for (i
= (int)(fp
- (fold_T
*)gap
->ga_data
); i
< gap
->ga_len
; ++i
, ++fp
)
1575 * Check for these situations:
1586 last
= fp
->fd_top
+ fp
->fd_len
- 1; /* last line of fold */
1588 /* 1. fold completely above line1: nothing to do */
1592 /* 6. fold below line2: only adjust for amount_after */
1593 if (fp
->fd_top
> line2
)
1595 if (amount_after
== 0)
1597 fp
->fd_top
+= amount_after
;
1601 if (fp
->fd_top
>= top
&& last
<= line2
)
1603 /* 4. fold completely contained in range */
1604 if (amount
== MAXLNUM
)
1606 /* Deleting lines: delete the fold completely */
1607 deleteFoldEntry(gap
, i
, TRUE
);
1608 --i
; /* adjust index for deletion */
1612 fp
->fd_top
+= amount
;
1616 if (fp
->fd_top
< top
)
1618 /* 2 or 3: need to correct nested folds too */
1619 foldMarkAdjustRecurse(&fp
->fd_nested
, line1
- fp
->fd_top
,
1620 line2
- fp
->fd_top
, amount
, amount_after
);
1623 /* 2. fold contains line1, line2 is below fold */
1624 if (amount
== MAXLNUM
)
1625 fp
->fd_len
= line1
- fp
->fd_top
;
1627 fp
->fd_len
+= amount
;
1631 /* 3. fold contains line1 and line2 */
1632 fp
->fd_len
+= amount_after
;
1637 /* 5. fold is below line1 and contains line2; need to
1638 * correct nested folds too */
1639 foldMarkAdjustRecurse(&fp
->fd_nested
, line1
- fp
->fd_top
,
1640 line2
- fp
->fd_top
, amount
,
1641 amount_after
+ (fp
->fd_top
- top
));
1642 if (amount
== MAXLNUM
)
1644 fp
->fd_len
-= line2
- fp
->fd_top
+ 1;
1649 fp
->fd_len
+= amount_after
- amount
;
1650 fp
->fd_top
+= amount
;
1658 /* getDeepestNesting() {{{2 */
1660 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1661 * current window open.
1666 checkupdate(curwin
);
1667 return getDeepestNestingRecurse(&curwin
->w_folds
);
1671 getDeepestNestingRecurse(gap
)
1679 fp
= (fold_T
*)gap
->ga_data
;
1680 for (i
= 0; i
< gap
->ga_len
; ++i
)
1682 level
= getDeepestNestingRecurse(&fp
[i
].fd_nested
) + 1;
1683 if (level
> maxlevel
)
1690 /* check_closed() {{{2 */
1692 * Check if a fold is closed and update the info needed to check nested folds.
1695 check_closed(win
, fp
, use_levelp
, level
, maybe_smallp
, lnum_off
)
1698 int *use_levelp
; /* TRUE: outer fold had FD_LEVEL */
1699 int level
; /* folding depth */
1700 int *maybe_smallp
; /* TRUE: outer this had fd_small == MAYBE */
1701 linenr_T lnum_off
; /* line number offset for fp->fd_top */
1705 /* Check if this fold is closed. If the flag is FD_LEVEL this
1706 * fold and all folds it contains depend on 'foldlevel'. */
1707 if (*use_levelp
|| fp
->fd_flags
== FD_LEVEL
)
1710 if (level
>= win
->w_p_fdl
)
1713 else if (fp
->fd_flags
== FD_CLOSED
)
1716 /* Small fold isn't closed anyway. */
1717 if (fp
->fd_small
== MAYBE
)
1718 *maybe_smallp
= TRUE
;
1722 fp
->fd_small
= MAYBE
;
1723 checkSmall(win
, fp
, lnum_off
);
1724 if (fp
->fd_small
== TRUE
)
1730 /* checkSmall() {{{2 */
1732 * Update fd_small field of fold "fp".
1735 checkSmall(wp
, fp
, lnum_off
)
1738 linenr_T lnum_off
; /* offset for fp->fd_top */
1743 if (fp
->fd_small
== MAYBE
)
1745 /* Mark any nested folds to maybe-small */
1746 setSmallMaybe(&fp
->fd_nested
);
1748 if (fp
->fd_len
> curwin
->w_p_fml
)
1749 fp
->fd_small
= FALSE
;
1753 for (n
= 0; n
< fp
->fd_len
; ++n
)
1755 count
+= plines_win_nofold(wp
, fp
->fd_top
+ lnum_off
+ n
);
1756 if (count
> curwin
->w_p_fml
)
1758 fp
->fd_small
= FALSE
;
1762 fp
->fd_small
= TRUE
;
1767 /* setSmallMaybe() {{{2 */
1769 * Set small flags in "gap" to MAYBE.
1778 fp
= (fold_T
*)gap
->ga_data
;
1779 for (i
= 0; i
< gap
->ga_len
; ++i
)
1780 fp
[i
].fd_small
= MAYBE
;
1783 /* foldCreateMarkers() {{{2 */
1785 * Create a fold from line "start" to line "end" (inclusive) in the current
1786 * window by adding markers.
1789 foldCreateMarkers(start
, end
)
1793 if (!curbuf
->b_p_ma
)
1795 EMSG(_(e_modifiable
));
1798 parseMarker(curwin
);
1800 foldAddMarker(start
, curwin
->w_p_fmr
, foldstartmarkerlen
);
1801 foldAddMarker(end
, foldendmarker
, foldendmarkerlen
);
1803 /* Update both changes here, to avoid all folds after the start are
1804 * changed when the start marker is inserted and the end isn't. */
1805 changed_lines(start
, (colnr_T
)0, end
, 0L);
1808 /* foldAddMarker() {{{2 */
1810 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1813 foldAddMarker(lnum
, marker
, markerlen
)
1818 char_u
*cms
= curbuf
->b_p_cms
;
1822 char_u
*p
= (char_u
*)strstr((char *)curbuf
->b_p_cms
, "%s");
1824 /* Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end */
1825 line
= ml_get(lnum
);
1826 line_len
= (int)STRLEN(line
);
1828 if (u_save(lnum
- 1, lnum
+ 1) == OK
)
1830 newline
= alloc((unsigned)(line_len
+ markerlen
+ STRLEN(cms
) + 1));
1831 if (newline
== NULL
)
1833 STRCPY(newline
, line
);
1835 vim_strncpy(newline
+ line_len
, marker
, markerlen
);
1838 STRCPY(newline
+ line_len
, cms
);
1839 STRNCPY(newline
+ line_len
+ (p
- cms
), marker
, markerlen
);
1840 STRCPY(newline
+ line_len
+ (p
- cms
) + markerlen
, p
+ 2);
1843 ml_replace(lnum
, newline
, FALSE
);
1847 /* deleteFoldMarkers() {{{2 */
1849 * Delete the markers for a fold, causing it to be deleted.
1852 deleteFoldMarkers(fp
, recursive
, lnum_off
)
1855 linenr_T lnum_off
; /* offset for fp->fd_top */
1860 for (i
= 0; i
< fp
->fd_nested
.ga_len
; ++i
)
1861 deleteFoldMarkers((fold_T
*)fp
->fd_nested
.ga_data
+ i
, TRUE
,
1862 lnum_off
+ fp
->fd_top
);
1863 foldDelMarker(fp
->fd_top
+ lnum_off
, curwin
->w_p_fmr
, foldstartmarkerlen
);
1864 foldDelMarker(fp
->fd_top
+ lnum_off
+ fp
->fd_len
- 1,
1865 foldendmarker
, foldendmarkerlen
);
1868 /* foldDelMarker() {{{2 */
1870 * Delete marker "marker[markerlen]" at the end of line "lnum".
1871 * Delete 'commentstring' if it matches.
1872 * If the marker is not found, there is no error message. Could a missing
1876 foldDelMarker(lnum
, marker
, markerlen
)
1885 char_u
*cms
= curbuf
->b_p_cms
;
1888 line
= ml_get(lnum
);
1889 for (p
= line
; *p
!= NUL
; ++p
)
1890 if (STRNCMP(p
, marker
, markerlen
) == 0)
1892 /* Found the marker, include a digit if it's there. */
1894 if (VIM_ISDIGIT(p
[len
]))
1898 /* Also delete 'commentstring' if it matches. */
1899 cms2
= (char_u
*)strstr((char *)cms
, "%s");
1900 if (p
- line
>= cms2
- cms
1901 && STRNCMP(p
- (cms2
- cms
), cms
, cms2
- cms
) == 0
1902 && STRNCMP(p
+ len
, cms2
+ 2, STRLEN(cms2
+ 2)) == 0)
1905 len
+= (int)STRLEN(cms
) - 2;
1908 if (u_save(lnum
- 1, lnum
+ 1) == OK
)
1910 /* Make new line: text-before-marker + text-after-marker */
1911 newline
= alloc((unsigned)(STRLEN(line
) - len
+ 1));
1912 if (newline
!= NULL
)
1914 STRNCPY(newline
, line
, p
- line
);
1915 STRCPY(newline
+ (p
- line
), p
+ len
);
1916 ml_replace(lnum
, newline
, FALSE
);
1923 /* get_foldtext() {{{2 */
1925 * Return the text for a closed fold at line "lnum", with last line "lnume".
1926 * When 'foldtext' isn't set puts the result in "buf[51]". Otherwise the
1927 * result is in allocated memory.
1930 get_foldtext(wp
, lnum
, lnume
, foldinfo
, buf
)
1932 linenr_T lnum
, lnume
;
1933 foldinfo_T
*foldinfo
;
1936 char_u
*text
= NULL
;
1939 if (*wp
->w_p_fdt
!= NUL
)
1941 char_u dashes
[MAX_LEVEL
+ 2];
1946 /* Set "v:foldstart" and "v:foldend". */
1947 set_vim_var_nr(VV_FOLDSTART
, lnum
);
1948 set_vim_var_nr(VV_FOLDEND
, lnume
);
1950 /* Set "v:folddashes" to a string of "level" dashes. */
1951 /* Set "v:foldlevel" to "level". */
1952 level
= foldinfo
->fi_level
;
1953 if (level
> (int)sizeof(dashes
) - 1)
1954 level
= (int)sizeof(dashes
) - 1;
1955 vim_memset(dashes
, '-', (size_t)level
);
1956 dashes
[level
] = NUL
;
1957 set_vim_var_string(VV_FOLDDASHES
, dashes
, -1);
1958 set_vim_var_nr(VV_FOLDLEVEL
, (long)level
);
1959 save_curwin
= curwin
;
1961 curbuf
= wp
->w_buffer
;
1964 text
= eval_to_string_safe(wp
->w_p_fdt
, NULL
,
1965 was_set_insecurely((char_u
*)"foldtext", OPT_LOCAL
));
1968 curwin
= save_curwin
;
1969 curbuf
= curwin
->w_buffer
;
1970 set_vim_var_string(VV_FOLDDASHES
, NULL
, -1);
1974 /* Replace unprintable characters, if there are any. But
1975 * replace a TAB with a space. */
1976 for (p
= text
; *p
!= NUL
; ++p
)
1981 if (has_mbyte
&& (len
= (*mb_ptr2len
)(p
)) > 1)
1983 if (!vim_isprintc((*mb_ptr2char
)(p
)))
1991 else if (ptr2cells(p
) > 1)
2005 sprintf((char *)buf
, _("+--%3ld lines folded "),
2006 (long)(lnume
- lnum
+ 1));
2012 /* foldtext_cleanup() {{{2 */
2014 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2017 foldtext_cleanup(str
)
2020 char_u
*cms_start
; /* first part or the whole comment */
2021 int cms_slen
= 0; /* length of cms_start */
2022 char_u
*cms_end
; /* last part of the comment or NULL */
2023 int cms_elen
= 0; /* length of cms_end */
2030 /* Ignore leading and trailing white space in 'commentstring'. */
2031 cms_start
= skipwhite(curbuf
->b_p_cms
);
2032 cms_slen
= (int)STRLEN(cms_start
);
2033 while (cms_slen
> 0 && vim_iswhite(cms_start
[cms_slen
- 1]))
2036 /* locate "%s" in 'commentstring', use the part before and after it. */
2037 cms_end
= (char_u
*)strstr((char *)cms_start
, "%s");
2038 if (cms_end
!= NULL
)
2040 cms_elen
= cms_slen
- (int)(cms_end
- cms_start
);
2041 cms_slen
= (int)(cms_end
- cms_start
);
2043 /* exclude white space before "%s" */
2044 while (cms_slen
> 0 && vim_iswhite(cms_start
[cms_slen
- 1]))
2047 /* skip "%s" and white space after it */
2048 s
= skipwhite(cms_end
+ 2);
2049 cms_elen
-= (int)(s
- cms_end
);
2052 parseMarker(curwin
);
2054 for (s
= str
; *s
!= NUL
; )
2057 if (STRNCMP(s
, curwin
->w_p_fmr
, foldstartmarkerlen
) == 0)
2058 len
= foldstartmarkerlen
;
2059 else if (STRNCMP(s
, foldendmarker
, foldendmarkerlen
) == 0)
2060 len
= foldendmarkerlen
;
2063 if (VIM_ISDIGIT(s
[len
]))
2066 /* May remove 'commentstring' start. Useful when it's a double
2067 * quote and we already removed a double quote. */
2068 for (p
= s
; p
> str
&& vim_iswhite(p
[-1]); --p
)
2070 if (p
>= str
+ cms_slen
2071 && STRNCMP(p
- cms_slen
, cms_start
, cms_slen
) == 0)
2073 len
+= (int)(s
- p
) + cms_slen
;
2077 else if (cms_end
!= NULL
)
2079 if (!did1
&& cms_slen
> 0 && STRNCMP(s
, cms_start
, cms_slen
) == 0)
2084 else if (!did2
&& cms_elen
> 0
2085 && STRNCMP(s
, cms_end
, cms_elen
) == 0)
2093 while (vim_iswhite(s
[len
]))
2095 STRMOVE(s
, s
+ len
);
2104 /* Folding by indent, expr, marker and syntax. {{{1 */
2105 /* Define "fline_T", passed to get fold level for a line. {{{2 */
2108 win_T
*wp
; /* window */
2109 linenr_T lnum
; /* current line number */
2110 linenr_T off
; /* offset between lnum and real line number */
2111 linenr_T lnum_save
; /* line nr used by foldUpdateIEMSRecurse() */
2112 int lvl
; /* current level (-1 for undefined) */
2113 int lvl_next
; /* level used for next line */
2114 int start
; /* number of folds that are forced to start at
2116 int end
; /* level of fold that is forced to end below
2118 int had_end
; /* level of fold that is forced to end above
2119 this line (copy of "end" of prev. line) */
2122 /* Flag is set when redrawing is needed. */
2123 static int fold_changed
;
2125 /* Function declarations. {{{2 */
2126 static linenr_T foldUpdateIEMSRecurse
__ARGS((garray_T
*gap
, int level
, linenr_T startlnum
, fline_T
*flp
, void (*getlevel
)__ARGS((fline_T
*)), linenr_T bot
, int topflags
));
2127 static int foldInsert
__ARGS((garray_T
*gap
, int i
));
2128 static void foldSplit
__ARGS((garray_T
*gap
, int i
, linenr_T top
, linenr_T bot
));
2129 static void foldRemove
__ARGS((garray_T
*gap
, linenr_T top
, linenr_T bot
));
2130 static void foldMerge
__ARGS((fold_T
*fp1
, garray_T
*gap
, fold_T
*fp2
));
2131 static void foldlevelIndent
__ARGS((fline_T
*flp
));
2133 static void foldlevelDiff
__ARGS((fline_T
*flp
));
2135 static void foldlevelExpr
__ARGS((fline_T
*flp
));
2136 static void foldlevelMarker
__ARGS((fline_T
*flp
));
2137 static void foldlevelSyntax
__ARGS((fline_T
*flp
));
2139 /* foldUpdateIEMS() {{{2 */
2141 * Update the folding for window "wp", at least from lines "top" to "bot".
2142 * Return TRUE if any folds did change.
2145 foldUpdateIEMS(wp
, top
, bot
)
2153 void (*getlevel
)__ARGS((fline_T
*));
2157 /* Avoid problems when being called recursively. */
2158 if (invalid_top
!= (linenr_T
)0)
2161 if (wp
->w_foldinvalid
)
2163 /* Need to update all folds. */
2165 bot
= wp
->w_buffer
->b_ml
.ml_line_count
;
2166 wp
->w_foldinvalid
= FALSE
;
2168 /* Mark all folds a maybe-small. */
2169 setSmallMaybe(&wp
->w_folds
);
2173 /* add the context for "diff" folding */
2174 if (foldmethodIsDiff(wp
))
2176 if (top
> diff_context
)
2177 top
-= diff_context
;
2180 bot
+= diff_context
;
2184 /* When deleting lines at the end of the buffer "top" can be past the end
2186 if (top
> wp
->w_buffer
->b_ml
.ml_line_count
)
2187 top
= wp
->w_buffer
->b_ml
.ml_line_count
;
2189 fold_changed
= FALSE
;
2193 fline
.lvl_next
= -1;
2195 fline
.end
= MAX_LEVEL
+ 1;
2196 fline
.had_end
= MAX_LEVEL
+ 1;
2201 if (foldmethodIsMarker(wp
))
2203 getlevel
= foldlevelMarker
;
2205 /* Init marker variables to speed up foldlevelMarker(). */
2208 /* Need to get the level of the line above top, it is used if there is
2209 * no marker at the top. */
2212 /* Get the fold level at top - 1. */
2213 level
= foldLevelWin(wp
, top
- 1);
2215 /* The fold may end just above the top, check for that. */
2216 fline
.lnum
= top
- 1;
2220 /* If a fold started here, we already had the level, if it stops
2221 * here, we need to use lvl_next. Could also start and end a fold
2222 * in the same line. */
2223 if (fline
.lvl
> level
)
2224 fline
.lvl
= level
- (fline
.lvl
- fline
.lvl_next
);
2226 fline
.lvl
= fline
.lvl_next
;
2234 if (foldmethodIsExpr(wp
))
2236 getlevel
= foldlevelExpr
;
2237 /* start one line back, because a "<1" may indicate the end of a
2238 * fold in the topline */
2242 else if (foldmethodIsSyntax(wp
))
2243 getlevel
= foldlevelSyntax
;
2245 else if (foldmethodIsDiff(wp
))
2246 getlevel
= foldlevelDiff
;
2249 getlevel
= foldlevelIndent
;
2251 /* Backup to a line for which the fold level is defined. Since it's
2252 * always defined for line one, we will stop there. */
2254 for ( ; !got_int
; --fline
.lnum
)
2256 /* Reset lvl_next each time, because it will be set to a value for
2257 * the next line, but we search backwards here. */
2258 fline
.lvl_next
= -1;
2266 * If folding is defined by the syntax, it is possible that a change in
2267 * one line will cause all sub-folds of the current fold to change (e.g.,
2268 * closing a C-style comment can cause folds in the subsequent lines to
2269 * appear). To take that into account we should adjust the value of "bot"
2270 * to point to the end of the current fold:
2272 if (foldlevelSyntax
== getlevel
)
2274 garray_T
*gap
= &wp
->w_folds
;
2276 int current_fdl
= 0;
2277 linenr_T fold_start_lnum
= 0;
2278 linenr_T lnum_rel
= fline
.lnum
;
2280 while (current_fdl
< fline
.lvl
)
2282 if (!foldFind(gap
, lnum_rel
, &fp
))
2286 fold_start_lnum
+= fp
->fd_top
;
2287 gap
= &fp
->fd_nested
;
2288 lnum_rel
-= fp
->fd_top
;
2290 if (fp
!= NULL
&& current_fdl
== fline
.lvl
)
2292 linenr_T fold_end_lnum
= fold_start_lnum
+ fp
->fd_len
;
2294 if (fold_end_lnum
> bot
)
2295 bot
= fold_end_lnum
;
2301 /* Do at least one line. */
2302 if (start
> end
&& end
< wp
->w_buffer
->b_ml
.ml_line_count
)
2306 /* Always stop at the end of the file ("end" can be past the end of
2308 if (fline
.lnum
> wp
->w_buffer
->b_ml
.ml_line_count
)
2310 if (fline
.lnum
> end
)
2312 /* For "marker", "expr" and "syntax" methods: If a change caused
2313 * a fold to be removed, we need to continue at least until where
2315 if (getlevel
!= foldlevelMarker
2316 && getlevel
!= foldlevelSyntax
2317 && getlevel
!= foldlevelExpr
)
2320 && foldFind(&wp
->w_folds
, end
, &fp
)
2321 && fp
->fd_top
+ fp
->fd_len
- 1 > end
)
2323 && foldFind(&wp
->w_folds
, fline
.lnum
, &fp
)
2324 && fp
->fd_top
< fline
.lnum
))
2325 end
= fp
->fd_top
+ fp
->fd_len
- 1;
2326 else if (getlevel
== foldlevelSyntax
2327 && foldLevelWin(wp
, fline
.lnum
) != fline
.lvl
)
2328 /* For "syntax" method: Compare the foldlevel that the syntax
2329 * tells us to the foldlevel from the existing folds. If they
2330 * don't match continue updating folds. */
2336 /* A level 1 fold starts at a line with foldlevel > 0. */
2339 invalid_top
= fline
.lnum
;
2341 end
= foldUpdateIEMSRecurse(&wp
->w_folds
,
2342 1, start
, &fline
, getlevel
, end
, FD_LEVEL
);
2347 if (fline
.lnum
== wp
->w_buffer
->b_ml
.ml_line_count
)
2350 fline
.lvl
= fline
.lvl_next
;
2355 /* There can't be any folds from start until end now. */
2356 foldRemove(&wp
->w_folds
, start
, end
);
2358 /* If some fold changed, need to redraw and position cursor. */
2359 if (fold_changed
&& wp
->w_p_fen
)
2360 changed_window_setting_win(wp
);
2362 /* If we updated folds past "bot", need to redraw more lines. Don't do
2363 * this in other situations, the changed lines will be redrawn anyway and
2364 * this method can cause the whole window to be updated. */
2367 if (wp
->w_redraw_top
== 0 || wp
->w_redraw_top
> top
)
2368 wp
->w_redraw_top
= top
;
2369 if (wp
->w_redraw_bot
< end
)
2370 wp
->w_redraw_bot
= end
;
2373 invalid_top
= (linenr_T
)0;
2376 /* foldUpdateIEMSRecurse() {{{2 */
2378 * Update a fold that starts at "flp->lnum". At this line there is always a
2379 * valid foldlevel, and its level >= "level".
2380 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2381 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2382 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2383 * the marker method and a text change made following folds to change.
2384 * When returning, "flp->lnum_save" is the line number that was used to get
2385 * the level when the level at "flp->lnum" is invalid.
2386 * Remove any folds from "startlnum" up to here at this level.
2387 * Recursively update nested folds.
2388 * Below line "bot" there are no changes in the text.
2389 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2391 * "flp->off" is the offset to the real line number in the buffer.
2393 * All this would be a lot simpler if all folds in the range would be deleted
2394 * and then created again. But we would lose all information about the
2395 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2397 * Returns bot, which may have been increased for lines that also need to be
2398 * updated as a result of a detected change in the fold.
2401 foldUpdateIEMSRecurse(gap
, level
, startlnum
, flp
, getlevel
, bot
, topflags
)
2406 void (*getlevel
)__ARGS((fline_T
*));
2408 int topflags
; /* flags used by containing fold */
2414 linenr_T startlnum2
= startlnum
;
2415 linenr_T firstlnum
= flp
->lnum
; /* first lnum we got */
2418 linenr_T linecount
= flp
->wp
->w_buffer
->b_ml
.ml_line_count
- flp
->off
;
2422 * If using the marker method, the start line is not the start of a fold
2423 * at the level we're dealing with and the level is non-zero, we must use
2424 * the previous fold. But ignore a fold that starts at or below
2425 * startlnum, it must be deleted.
2427 if (getlevel
== foldlevelMarker
&& flp
->start
<= flp
->lvl
- level
2430 foldFind(gap
, startlnum
- 1, &fp
);
2431 if (fp
>= ((fold_T
*)gap
->ga_data
) + gap
->ga_len
2432 || fp
->fd_top
>= startlnum
)
2437 * Loop over all lines in this fold, or until "bot" is hit.
2438 * Handle nested folds inside of this fold.
2439 * "flp->lnum" is the current line. When finding the end of the fold, it
2440 * is just below the end of the fold.
2441 * "*flp" contains the level of the line "flp->lnum" or a following one if
2442 * there are lines with an invalid fold level. "flp->lnum_save" is the
2443 * line number that was used to get the fold level (below "flp->lnum" when
2444 * it has an invalid fold level). When called the fold level is always
2445 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2447 flp
->lnum_save
= flp
->lnum
;
2450 /* Updating folds can be slow, check for CTRL-C. */
2453 /* Set "lvl" to the level of line "flp->lnum". When flp->start is set
2454 * and after the first line of the fold, set the level to zero to
2455 * force the fold to end. Do the same when had_end is set: Previous
2456 * line was marked as end of a fold. */
2458 if (lvl
> MAX_LEVEL
)
2460 if (flp
->lnum
> firstlnum
2461 && (level
> lvl
- flp
->start
|| level
>= flp
->had_end
))
2464 if (flp
->lnum
> bot
&& !finish
&& fp
!= NULL
)
2466 /* For "marker" and "syntax" methods:
2467 * - If a change caused a nested fold to be removed, we need to
2468 * delete it and continue at least until where it ended.
2469 * - If a change caused a nested fold to be created, or this fold
2470 * to continue below its original end, need to finish this fold.
2472 if (getlevel
!= foldlevelMarker
2473 && getlevel
!= foldlevelExpr
2474 && getlevel
!= foldlevelSyntax
)
2480 /* Compute how deep the folds currently are, if it's deeper
2481 * than "lvl" then some must be deleted, need to update
2482 * at least one nested fold. */
2483 ll
= flp
->lnum
- fp
->fd_top
;
2484 while (foldFind(&fp2
->fd_nested
, ll
, &fp2
))
2490 if (lvl
< level
+ i
)
2492 foldFind(&fp
->fd_nested
, flp
->lnum
- fp
->fd_top
, &fp2
);
2494 bot
= fp2
->fd_top
+ fp2
->fd_len
- 1 + fp
->fd_top
;
2496 else if (fp
->fd_top
+ fp
->fd_len
<= flp
->lnum
&& lvl
>= level
)
2502 /* At the start of the first nested fold and at the end of the current
2503 * fold: check if existing folds at this level, before the current
2504 * one, need to be deleted or truncated. */
2507 || flp
->lnum_save
>= bot
2509 || flp
->had_end
<= MAX_LEVEL
2510 || flp
->lnum
== linecount
))
2513 * Remove or update folds that have lines between startlnum and
2518 /* set concat to 1 if it's allowed to concatenated this fold
2519 * with a previous one that touches it. */
2520 if (flp
->start
!= 0 || flp
->had_end
<= MAX_LEVEL
)
2525 /* Find an existing fold to re-use. Preferably one that
2526 * includes startlnum, otherwise one that ends just before
2527 * startlnum or starts after it. */
2528 if (foldFind(gap
, startlnum
, &fp
)
2529 || (fp
< ((fold_T
*)gap
->ga_data
) + gap
->ga_len
2530 && fp
->fd_top
<= firstlnum
)
2531 || foldFind(gap
, firstlnum
- concat
, &fp
)
2532 || (fp
< ((fold_T
*)gap
->ga_data
) + gap
->ga_len
2533 && ((lvl
< level
&& fp
->fd_top
< flp
->lnum
)
2535 && fp
->fd_top
<= flp
->lnum_save
))))
2537 if (fp
->fd_top
+ fp
->fd_len
+ concat
> firstlnum
)
2539 /* Use existing fold for the new fold. If it starts
2540 * before where we started looking, extend it. If it
2541 * starts at another line, update nested folds to keep
2542 * their position, compensating for the new fd_top. */
2543 if (fp
->fd_top
>= startlnum
&& fp
->fd_top
!= firstlnum
)
2545 if (fp
->fd_top
> firstlnum
)
2546 /* like lines are inserted */
2547 foldMarkAdjustRecurse(&fp
->fd_nested
,
2548 (linenr_T
)0, (linenr_T
)MAXLNUM
,
2549 (long)(fp
->fd_top
- firstlnum
), 0L);
2551 /* like lines are deleted */
2552 foldMarkAdjustRecurse(&fp
->fd_nested
,
2554 (long)(firstlnum
- fp
->fd_top
- 1),
2556 (long)(fp
->fd_top
- firstlnum
));
2557 fp
->fd_len
+= fp
->fd_top
- firstlnum
;
2558 fp
->fd_top
= firstlnum
;
2559 fold_changed
= TRUE
;
2561 else if (flp
->start
!= 0 && lvl
== level
2562 && fp
->fd_top
!= firstlnum
)
2564 /* Existing fold that includes startlnum must stop
2565 * if we find the start of a new fold at the same
2566 * level. Split it. Delete contained folds at
2567 * this point to split them too. */
2568 foldRemove(&fp
->fd_nested
, flp
->lnum
- fp
->fd_top
,
2569 flp
->lnum
- fp
->fd_top
);
2570 i
= (int)(fp
- (fold_T
*)gap
->ga_data
);
2571 foldSplit(gap
, i
, flp
->lnum
, flp
->lnum
- 1);
2572 fp
= (fold_T
*)gap
->ga_data
+ i
+ 1;
2573 /* If using the "marker" or "syntax" method, we
2574 * need to continue until the end of the fold is
2576 if (getlevel
== foldlevelMarker
2577 || getlevel
== foldlevelExpr
2578 || getlevel
== foldlevelSyntax
)
2583 if (fp
->fd_top
>= startlnum
)
2585 /* A fold that starts at or after startlnum and stops
2586 * before the new fold must be deleted. Continue
2587 * looking for the next one. */
2588 deleteFoldEntry(gap
,
2589 (int)(fp
- (fold_T
*)gap
->ga_data
), TRUE
);
2593 /* A fold has some lines above startlnum, truncate it
2594 * to stop just above startlnum. */
2595 fp
->fd_len
= startlnum
- fp
->fd_top
;
2596 foldMarkAdjustRecurse(&fp
->fd_nested
,
2597 (linenr_T
)fp
->fd_len
, (linenr_T
)MAXLNUM
,
2598 (linenr_T
)MAXLNUM
, 0L);
2599 fold_changed
= TRUE
;
2604 /* Insert new fold. Careful: ga_data may be NULL and it
2606 i
= (int)(fp
- (fold_T
*)gap
->ga_data
);
2607 if (foldInsert(gap
, i
) != OK
)
2609 fp
= (fold_T
*)gap
->ga_data
+ i
;
2610 /* The new fold continues until bot, unless we find the
2612 fp
->fd_top
= firstlnum
;
2613 fp
->fd_len
= bot
- firstlnum
+ 1;
2614 /* When the containing fold is open, the new fold is open.
2615 * The new fold is closed if the fold above it is closed.
2616 * The first fold depends on the containing fold. */
2617 if (topflags
== FD_OPEN
)
2619 flp
->wp
->w_fold_manual
= TRUE
;
2620 fp
->fd_flags
= FD_OPEN
;
2624 fp
->fd_flags
= topflags
;
2625 if (topflags
!= FD_LEVEL
)
2626 flp
->wp
->w_fold_manual
= TRUE
;
2629 fp
->fd_flags
= (fp
- 1)->fd_flags
;
2630 fp
->fd_small
= MAYBE
;
2631 /* If using the "marker", "expr" or "syntax" method, we
2632 * need to continue until the end of the fold is found. */
2633 if (getlevel
== foldlevelMarker
2634 || getlevel
== foldlevelExpr
2635 || getlevel
== foldlevelSyntax
)
2637 fold_changed
= TRUE
;
2643 if (lvl
< level
|| flp
->lnum
> linecount
)
2646 * Found a line with a lower foldlevel, this fold ends just above
2653 * The fold includes the line "flp->lnum" and "flp->lnum_save".
2654 * Check "fp" for safety.
2656 if (lvl
> level
&& fp
!= NULL
)
2659 * There is a nested fold, handle it recursively.
2661 /* At least do one line (can happen when finish is TRUE). */
2662 if (bot
< flp
->lnum
)
2665 /* Line numbers in the nested fold are relative to the start of
2667 flp
->lnum
= flp
->lnum_save
- fp
->fd_top
;
2668 flp
->off
+= fp
->fd_top
;
2669 i
= (int)(fp
- (fold_T
*)gap
->ga_data
);
2670 bot
= foldUpdateIEMSRecurse(&fp
->fd_nested
, level
+ 1,
2671 startlnum2
- fp
->fd_top
, flp
, getlevel
,
2672 bot
- fp
->fd_top
, fp
->fd_flags
);
2673 fp
= (fold_T
*)gap
->ga_data
+ i
;
2674 flp
->lnum
+= fp
->fd_top
;
2675 flp
->lnum_save
+= fp
->fd_top
;
2676 flp
->off
-= fp
->fd_top
;
2678 startlnum2
= flp
->lnum
;
2680 /* This fold may end at the same line, don't incr. flp->lnum. */
2685 * Get the level of the next line, then continue the loop to check
2687 * Skip over undefined lines, to find the foldlevel after it.
2688 * For the last line in the file the foldlevel is always valid.
2690 flp
->lnum
= flp
->lnum_save
;
2694 /* Make the previous level available to foldlevel(). */
2695 prev_lnum
= flp
->lnum
;
2696 prev_lnum_lvl
= flp
->lvl
;
2698 if (++flp
->lnum
> linecount
)
2700 flp
->lvl
= flp
->lvl_next
;
2702 if (flp
->lvl
>= 0 || flp
->had_end
<= MAX_LEVEL
)
2706 if (flp
->lnum
> linecount
)
2709 /* leave flp->lnum_save to lnum of the line that was used to get
2710 * the level, flp->lnum to the lnum of the next line. */
2711 flp
->lnum_save
= flp
->lnum
;
2716 if (fp
== NULL
) /* only happens when got_int is set */
2721 * lvl < level: the folds ends just above "flp->lnum"
2722 * lvl >= level: fold continues below "bot"
2725 /* Current fold at least extends until lnum. */
2726 if (fp
->fd_len
< flp
->lnum
- fp
->fd_top
)
2728 fp
->fd_len
= flp
->lnum
- fp
->fd_top
;
2729 fp
->fd_small
= MAYBE
;
2730 fold_changed
= TRUE
;
2733 /* Delete contained folds from the end of the last one found until where
2734 * we stopped looking. */
2735 foldRemove(&fp
->fd_nested
, startlnum2
- fp
->fd_top
,
2736 flp
->lnum
- 1 - fp
->fd_top
);
2740 /* End of fold found, update the length when it got shorter. */
2741 if (fp
->fd_len
!= flp
->lnum
- fp
->fd_top
)
2743 if (fp
->fd_top
+ fp
->fd_len
> bot
+ 1)
2745 /* fold continued below bot */
2746 if (getlevel
== foldlevelMarker
2747 || getlevel
== foldlevelExpr
2748 || getlevel
== foldlevelSyntax
)
2750 /* marker method: truncate the fold and make sure the
2751 * previously included lines are processed again */
2752 bot
= fp
->fd_top
+ fp
->fd_len
- 1;
2753 fp
->fd_len
= flp
->lnum
- fp
->fd_top
;
2757 /* indent or expr method: split fold to create a new one
2759 i
= (int)(fp
- (fold_T
*)gap
->ga_data
);
2760 foldSplit(gap
, i
, flp
->lnum
, bot
);
2761 fp
= (fold_T
*)gap
->ga_data
+ i
;
2765 fp
->fd_len
= flp
->lnum
- fp
->fd_top
;
2766 fold_changed
= TRUE
;
2770 /* delete following folds that end before the current line */
2774 if (fp2
>= (fold_T
*)gap
->ga_data
+ gap
->ga_len
2775 || fp2
->fd_top
> flp
->lnum
)
2777 if (fp2
->fd_top
+ fp2
->fd_len
> flp
->lnum
)
2779 if (fp2
->fd_top
< flp
->lnum
)
2781 /* Make fold that includes lnum start at lnum. */
2782 foldMarkAdjustRecurse(&fp2
->fd_nested
,
2783 (linenr_T
)0, (long)(flp
->lnum
- fp2
->fd_top
- 1),
2784 (linenr_T
)MAXLNUM
, (long)(fp2
->fd_top
- flp
->lnum
));
2785 fp2
->fd_len
-= flp
->lnum
- fp2
->fd_top
;
2786 fp2
->fd_top
= flp
->lnum
;
2787 fold_changed
= TRUE
;
2792 /* merge new fold with existing fold that follows */
2793 foldMerge(fp
, gap
, fp2
);
2797 fold_changed
= TRUE
;
2798 deleteFoldEntry(gap
, (int)(fp2
- (fold_T
*)gap
->ga_data
), TRUE
);
2801 /* Need to redraw the lines we inspected, which might be further down than
2803 if (bot
< flp
->lnum
- 1)
2804 bot
= flp
->lnum
- 1;
2809 /* foldInsert() {{{2 */
2811 * Insert a new fold in "gap" at position "i".
2812 * Returns OK for success, FAIL for failure.
2821 if (ga_grow(gap
, 1) != OK
)
2823 fp
= (fold_T
*)gap
->ga_data
+ i
;
2824 if (i
< gap
->ga_len
)
2825 mch_memmove(fp
+ 1, fp
, sizeof(fold_T
) * (gap
->ga_len
- i
));
2827 ga_init2(&fp
->fd_nested
, (int)sizeof(fold_T
), 10);
2831 /* foldSplit() {{{2 */
2833 * Split the "i"th fold in "gap", which starts before "top" and ends below
2834 * "bot" in two pieces, one ending above "top" and the other starting below
2836 * The caller must first have taken care of any nested folds from "top" to
2840 foldSplit(gap
, i
, top
, bot
)
2853 /* The fold continues below bot, need to split it. */
2854 if (foldInsert(gap
, i
+ 1) == FAIL
)
2856 fp
= (fold_T
*)gap
->ga_data
+ i
;
2857 fp
[1].fd_top
= bot
+ 1;
2858 fp
[1].fd_len
= fp
->fd_len
- (fp
[1].fd_top
- fp
->fd_top
);
2859 fp
[1].fd_flags
= fp
->fd_flags
;
2860 fp
[1].fd_small
= MAYBE
;
2861 fp
->fd_small
= MAYBE
;
2863 /* Move nested folds below bot to new fold. There can't be
2864 * any between top and bot, they have been removed by the caller. */
2865 gap1
= &fp
->fd_nested
;
2866 gap2
= &fp
[1].fd_nested
;
2867 (void)(foldFind(gap1
, bot
+ 1 - fp
->fd_top
, &fp2
));
2868 len
= (int)((fold_T
*)gap1
->ga_data
+ gap1
->ga_len
- fp2
);
2869 if (len
> 0 && ga_grow(gap2
, len
) == OK
)
2871 for (idx
= 0; idx
< len
; ++idx
)
2873 ((fold_T
*)gap2
->ga_data
)[idx
] = fp2
[idx
];
2874 ((fold_T
*)gap2
->ga_data
)[idx
].fd_top
2875 -= fp
[1].fd_top
- fp
->fd_top
;
2878 gap1
->ga_len
-= len
;
2880 fp
->fd_len
= top
- fp
->fd_top
;
2881 fold_changed
= TRUE
;
2884 /* foldRemove() {{{2 */
2886 * Remove folds within the range "top" to and including "bot".
2887 * Check for these situations:
2897 * 2: truncate to stop above "top"
2898 * 3: split in two parts, one stops above "top", other starts below "bot".
2900 * 5: made to start below "bot".
2904 foldRemove(gap
, top
, bot
)
2912 return; /* nothing to do */
2916 /* Find fold that includes top or a following one. */
2917 if (foldFind(gap
, top
, &fp
) && fp
->fd_top
< top
)
2919 /* 2: or 3: need to delete nested folds */
2920 foldRemove(&fp
->fd_nested
, top
- fp
->fd_top
, bot
- fp
->fd_top
);
2921 if (fp
->fd_top
+ fp
->fd_len
> bot
+ 1)
2923 /* 3: need to split it. */
2924 foldSplit(gap
, (int)(fp
- (fold_T
*)gap
->ga_data
), top
, bot
);
2928 /* 2: truncate fold at "top". */
2929 fp
->fd_len
= top
- fp
->fd_top
;
2931 fold_changed
= TRUE
;
2934 if (fp
>= (fold_T
*)(gap
->ga_data
) + gap
->ga_len
2935 || fp
->fd_top
> bot
)
2937 /* 6: Found a fold below bot, can stop looking. */
2940 if (fp
->fd_top
>= top
)
2942 /* Found an entry below top. */
2943 fold_changed
= TRUE
;
2944 if (fp
->fd_top
+ fp
->fd_len
- 1 > bot
)
2946 /* 5: Make fold that includes bot start below bot. */
2947 foldMarkAdjustRecurse(&fp
->fd_nested
,
2948 (linenr_T
)0, (long)(bot
- fp
->fd_top
),
2949 (linenr_T
)MAXLNUM
, (long)(fp
->fd_top
- bot
- 1));
2950 fp
->fd_len
-= bot
- fp
->fd_top
+ 1;
2951 fp
->fd_top
= bot
+ 1;
2955 /* 4: Delete completely contained fold. */
2956 deleteFoldEntry(gap
, (int)(fp
- (fold_T
*)gap
->ga_data
), TRUE
);
2961 /* foldMerge() {{{2 */
2963 * Merge two adjacent folds (and the nested ones in them).
2964 * This only works correctly when the folds are really adjacent! Thus "fp1"
2965 * must end just above "fp2".
2966 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
2967 * Fold entry "fp2" in "gap" is deleted.
2970 foldMerge(fp1
, gap
, fp2
)
2978 garray_T
*gap1
= &fp1
->fd_nested
;
2979 garray_T
*gap2
= &fp2
->fd_nested
;
2981 /* If the last nested fold in fp1 touches the first nested fold in fp2,
2982 * merge them recursively. */
2983 if (foldFind(gap1
, fp1
->fd_len
- 1L, &fp3
) && foldFind(gap2
, 0L, &fp4
))
2984 foldMerge(fp3
, gap2
, fp4
);
2986 /* Move nested folds in fp2 to the end of fp1. */
2987 if (gap2
->ga_len
> 0 && ga_grow(gap1
, gap2
->ga_len
) == OK
)
2989 for (idx
= 0; idx
< gap2
->ga_len
; ++idx
)
2991 ((fold_T
*)gap1
->ga_data
)[gap1
->ga_len
]
2992 = ((fold_T
*)gap2
->ga_data
)[idx
];
2993 ((fold_T
*)gap1
->ga_data
)[gap1
->ga_len
].fd_top
+= fp1
->fd_len
;
2999 fp1
->fd_len
+= fp2
->fd_len
;
3000 deleteFoldEntry(gap
, (int)(fp2
- (fold_T
*)gap
->ga_data
), TRUE
);
3001 fold_changed
= TRUE
;
3004 /* foldlevelIndent() {{{2 */
3006 * Low level function to get the foldlevel for the "indent" method.
3007 * Doesn't use any caching.
3008 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3011 foldlevelIndent(flp
)
3016 linenr_T lnum
= flp
->lnum
+ flp
->off
;
3018 buf
= flp
->wp
->w_buffer
;
3019 s
= skipwhite(ml_get_buf(buf
, lnum
, FALSE
));
3021 /* empty line or lines starting with a character in 'foldignore': level
3022 * depends on surrounding lines */
3023 if (*s
== NUL
|| vim_strchr(flp
->wp
->w_p_fdi
, *s
) != NULL
)
3025 /* first and last line can't be undefined, use level 0 */
3026 if (lnum
== 1 || lnum
== buf
->b_ml
.ml_line_count
)
3032 flp
->lvl
= get_indent_buf(buf
, lnum
) / buf
->b_p_sw
;
3033 if (flp
->lvl
> flp
->wp
->w_p_fdn
)
3035 flp
->lvl
= flp
->wp
->w_p_fdn
;
3041 /* foldlevelDiff() {{{2 */
3044 * Low level function to get the foldlevel for the "diff" method.
3045 * Doesn't use any caching.
3051 if (diff_infold(flp
->wp
, flp
->lnum
+ flp
->off
))
3058 /* foldlevelExpr() {{{2 */
3060 * Low level function to get the foldlevel for the "expr" method.
3061 * Doesn't use any caching.
3062 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3075 linenr_T lnum
= flp
->lnum
+ flp
->off
;
3080 curbuf
= flp
->wp
->w_buffer
;
3081 set_vim_var_nr(VV_LNUM
, lnum
);
3084 flp
->had_end
= flp
->end
;
3085 flp
->end
= MAX_LEVEL
+ 1;
3089 /* KeyTyped may be reset to 0 when calling a function which invokes
3090 * do_cmdline(). To make 'foldopen' work correctly restore KeyTyped. */
3091 save_keytyped
= KeyTyped
;
3092 n
= eval_foldexpr(flp
->wp
->w_p_fde
, &c
);
3093 KeyTyped
= save_keytyped
;
3097 /* "a1", "a2", .. : add to the fold level */
3098 case 'a': if (flp
->lvl
>= 0)
3101 flp
->lvl_next
= flp
->lvl
;
3106 /* "s1", "s2", .. : subtract from the fold level */
3107 case 's': if (flp
->lvl
>= 0)
3112 flp
->lvl_next
= flp
->lvl
- n
;
3113 flp
->end
= flp
->lvl_next
+ 1;
3117 /* ">1", ">2", .. : start a fold with a certain level */
3118 case '>': flp
->lvl
= n
;
3123 /* "<1", "<2", .. : end a fold with a certain level */
3124 case '<': flp
->lvl_next
= n
- 1;
3128 /* "=": No change in level */
3129 case '=': flp
->lvl_next
= flp
->lvl
;
3132 /* "-1", "0", "1", ..: set fold level */
3134 /* Use the current level for the next line, so that "a1"
3135 * will work there. */
3136 flp
->lvl_next
= flp
->lvl
;
3143 /* If the level is unknown for the first or the last line in the file, use
3152 if (lnum
== curbuf
->b_ml
.ml_line_count
)
3157 curbuf
= curwin
->w_buffer
;
3161 /* parseMarker() {{{2 */
3163 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3164 * "foldendmarkerlen".
3165 * Relies on the option value to have been checked for correctness already.
3171 foldendmarker
= vim_strchr(wp
->w_p_fmr
, ',');
3172 foldstartmarkerlen
= (int)(foldendmarker
++ - wp
->w_p_fmr
);
3173 foldendmarkerlen
= (int)STRLEN(foldendmarker
);
3176 /* foldlevelMarker() {{{2 */
3178 * Low level function to get the foldlevel for the "marker" method.
3179 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3180 * set before calling this.
3181 * Requires that flp->lvl is set to the fold level of the previous line!
3182 * Careful: This means you can't call this function twice on the same line.
3183 * Doesn't use any caching.
3184 * Sets flp->start when a start marker was found.
3187 foldlevelMarker(flp
)
3190 char_u
*startmarker
;
3193 int start_lvl
= flp
->lvl
;
3197 /* cache a few values for speed */
3198 startmarker
= flp
->wp
->w_p_fmr
;
3199 cstart
= *startmarker
;
3201 cend
= *foldendmarker
;
3203 /* Default: no start found, next level is same as current level */
3205 flp
->lvl_next
= flp
->lvl
;
3207 s
= ml_get_buf(flp
->wp
->w_buffer
, flp
->lnum
+ flp
->off
, FALSE
);
3211 && STRNCMP(s
+ 1, startmarker
, foldstartmarkerlen
- 1) == 0)
3213 /* found startmarker: set flp->lvl */
3214 s
+= foldstartmarkerlen
;
3215 if (VIM_ISDIGIT(*s
))
3217 n
= atoi((char *)s
);
3225 flp
->start
= n
- start_lvl
;
3236 && STRNCMP(s
+ 1, foldendmarker
+ 1, foldendmarkerlen
- 1) == 0)
3238 /* found endmarker: set flp->lvl_next */
3239 s
+= foldendmarkerlen
;
3240 if (VIM_ISDIGIT(*s
))
3242 n
= atoi((char *)s
);
3246 flp
->lvl_next
= n
- 1;
3247 /* never start a fold with an end marker */
3248 if (flp
->lvl_next
> start_lvl
)
3249 flp
->lvl_next
= start_lvl
;
3259 /* The level can't go negative, must be missing a start marker. */
3260 if (flp
->lvl_next
< 0)
3264 /* foldlevelSyntax() {{{2 */
3266 * Low level function to get the foldlevel for the "syntax" method.
3267 * Doesn't use any caching.
3270 foldlevelSyntax(flp
)
3277 linenr_T lnum
= flp
->lnum
+ flp
->off
;
3280 /* Use the maximum fold level at the start of this line and the next. */
3281 flp
->lvl
= syn_get_foldlevel(flp
->wp
, lnum
);
3283 if (lnum
< flp
->wp
->w_buffer
->b_ml
.ml_line_count
)
3285 n
= syn_get_foldlevel(flp
->wp
, lnum
+ 1);
3288 flp
->start
= n
- flp
->lvl
; /* fold(s) start here */
3295 /* functions for storing the fold state in a View {{{1 */
3296 /* put_folds() {{{2 */
3297 #if defined(FEAT_SESSION) || defined(PROTO)
3298 static int put_folds_recurse
__ARGS((FILE *fd
, garray_T
*gap
, linenr_T off
));
3299 static int put_foldopen_recurse
__ARGS((FILE *fd
, garray_T
*gap
, linenr_T off
));
3302 * Write commands to "fd" to restore the manual folds in window "wp".
3303 * Return FAIL if writing fails.
3310 if (foldmethodIsManual(wp
))
3312 if (put_line(fd
, "silent! normal! zE") == FAIL
3313 || put_folds_recurse(fd
, &wp
->w_folds
, (linenr_T
)0) == FAIL
)
3317 /* If some folds are manually opened/closed, need to restore that. */
3318 if (wp
->w_fold_manual
)
3319 return put_foldopen_recurse(fd
, &wp
->w_folds
, (linenr_T
)0);
3324 /* put_folds_recurse() {{{2 */
3326 * Write commands to "fd" to recreate manually created folds.
3327 * Returns FAIL when writing failed.
3330 put_folds_recurse(fd
, gap
, off
)
3338 fp
= (fold_T
*)gap
->ga_data
;
3339 for (i
= 0; i
< gap
->ga_len
; i
++)
3341 /* Do nested folds first, they will be created closed. */
3342 if (put_folds_recurse(fd
, &fp
->fd_nested
, off
+ fp
->fd_top
) == FAIL
)
3344 if (fprintf(fd
, "%ld,%ldfold", fp
->fd_top
+ off
,
3345 fp
->fd_top
+ off
+ fp
->fd_len
- 1) < 0
3346 || put_eol(fd
) == FAIL
)
3353 /* put_foldopen_recurse() {{{2 */
3355 * Write commands to "fd" to open and close manually opened/closed folds.
3356 * Returns FAIL when writing failed.
3359 put_foldopen_recurse(fd
, gap
, off
)
3367 fp
= (fold_T
*)gap
->ga_data
;
3368 for (i
= 0; i
< gap
->ga_len
; i
++)
3370 if (fp
->fd_flags
!= FD_LEVEL
)
3372 if (fp
->fd_nested
.ga_len
> 0)
3374 /* open/close nested folds while this fold is open */
3375 if (fprintf(fd
, "%ld", fp
->fd_top
+ off
) < 0
3376 || put_eol(fd
) == FAIL
3377 || put_line(fd
, "normal zo") == FAIL
)
3379 if (put_foldopen_recurse(fd
, &fp
->fd_nested
, off
+ fp
->fd_top
)
3383 if (fprintf(fd
, "%ld", fp
->fd_top
+ off
) < 0
3384 || put_eol(fd
) == FAIL
3385 || fprintf(fd
, "normal z%c",
3386 fp
->fd_flags
== FD_CLOSED
? 'c' : 'o') < 0
3387 || put_eol(fd
) == FAIL
)
3395 #endif /* FEAT_SESSION */
3398 #endif /* defined(FEAT_FOLDING) || defined(PROTO) */