Synced with the latest branch.
[MacVim.git] / src / fold.c
blobb7b8ea744c165b8d9a7df217c4e6e9917b46d98c
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.
9 */
12 * fold.c: code for folding
15 #include "vim.h"
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.
27 typedef struct
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
36 folds too */
37 } fold_T;
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 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".
102 void
103 copyFoldingState(wp_from, wp_to)
104 win_T *wp_from;
105 win_T *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);
111 #endif
113 /* hasAnyFolding() {{{2 */
115 * Return TRUE if there may be folded lines in the current window.
118 hasAnyFolding(win)
119 win_T *win;
121 /* very simple now, but can become more complex later */
122 return (win->w_p_fen
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
129 * fold.
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)
135 linenr_T lnum;
136 linenr_T *firstp;
137 linenr_T *lastp;
139 return hasFoldingWin(curwin, lnum, firstp, lastp, TRUE, NULL);
142 /* hasFoldingWin() {{{2 */
144 hasFoldingWin(win, lnum, firstp, lastp, cache, infop)
145 win_T *win;
146 linenr_T lnum;
147 linenr_T *firstp;
148 linenr_T *lastp;
149 int cache; /* when TRUE: use cached values of window */
150 foldinfo_T *infop; /* where to store fold info */
152 int had_folded = FALSE;
153 linenr_T first = 0;
154 linenr_T last = 0;
155 linenr_T lnum_rel = lnum;
156 int x;
157 fold_T *fp;
158 int level = 0;
159 int use_level = FALSE;
160 int maybe_small = FALSE;
161 garray_T *gap;
162 int low_level = 0;;
164 checkupdate(win);
166 * Return quickly when there is no folding at all in this window.
168 if (!hasAnyFolding(win))
170 if (infop != NULL)
171 infop->fi_level = 0;
172 return FALSE;
175 if (cache)
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);
182 if (x >= 0)
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;
190 if (first == 0)
193 * Recursively search for a fold that contains "lnum".
195 gap = &win->w_folds;
196 for (;;)
198 if (!foldFind(gap, lnum_rel, &fp))
199 break;
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;
205 first += fp->fd_top;
206 last += fp->fd_top;
208 /* is this fold closed? */
209 had_folded = check_closed(win, fp, &use_level, level,
210 &maybe_small, lnum - lnum_rel);
211 if (had_folded)
213 /* Fold closed: Set last and quit loop. */
214 last += fp->fd_len - 1;
215 break;
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;
222 ++level;
226 if (!had_folded)
228 if (infop != NULL)
230 infop->fi_level = level;
231 infop->fi_lnum = lnum - lnum_rel;
232 infop->fi_low_level = low_level == 0 ? level : low_level;
234 return FALSE;
237 if (lastp != NULL)
238 *lastp = last;
239 if (firstp != NULL)
240 *firstp = first;
241 if (infop != NULL)
243 infop->fi_level = level + 1;
244 infop->fi_lnum = first;
245 infop->fi_low_level = low_level == 0 ? level + 1 : low_level;
247 return TRUE;
250 /* foldLevel() {{{2 */
252 * Return fold level at line number "lnum" in the current window.
255 foldLevel(lnum)
256 linenr_T lnum;
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)
261 checkupdate(curwin);
262 else if (lnum == prev_lnum && prev_lnum_lvl >= 0)
263 return prev_lnum_lvl;
264 else if (lnum >= invalid_top && lnum <= invalid_bot)
265 return -1;
267 /* Return quickly when there is no folding at all in this window. */
268 if (!hasAnyFolding(curwin))
269 return 0;
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)
283 win_T *win;
284 linenr_T 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.
298 long
299 foldedCount(win, lnum, infop)
300 win_T *win;
301 linenr_T lnum;
302 foldinfo_T *infop;
304 linenr_T last;
306 if (hasFoldingWin(win, lnum, NULL, &last, FALSE, infop))
307 return (long)(last - lnum + 1);
308 return 0;
311 /* foldmethodIsManual() {{{2 */
313 * Return TRUE if 'foldmethod' is "manual"
316 foldmethodIsManual(wp)
317 win_T *wp;
319 return (wp->w_p_fdm[3] == 'u');
322 /* foldmethodIsIndent() {{{2 */
324 * Return TRUE if 'foldmethod' is "indent"
327 foldmethodIsIndent(wp)
328 win_T *wp;
330 return (wp->w_p_fdm[0] == 'i');
333 /* foldmethodIsExpr() {{{2 */
335 * Return TRUE if 'foldmethod' is "expr"
338 foldmethodIsExpr(wp)
339 win_T *wp;
341 return (wp->w_p_fdm[1] == 'x');
344 /* foldmethodIsMarker() {{{2 */
346 * Return TRUE if 'foldmethod' is "marker"
349 foldmethodIsMarker(wp)
350 win_T *wp;
352 return (wp->w_p_fdm[2] == 'r');
355 /* foldmethodIsSyntax() {{{2 */
357 * Return TRUE if 'foldmethod' is "syntax"
360 foldmethodIsSyntax(wp)
361 win_T *wp;
363 return (wp->w_p_fdm[0] == 's');
366 /* foldmethodIsDiff() {{{2 */
368 * Return TRUE if 'foldmethod' is "diff"
371 foldmethodIsDiff(wp)
372 win_T *wp;
374 return (wp->w_p_fdm[0] == 'd');
377 /* closeFold() {{{2 */
379 * Close fold for current window at line "lnum".
380 * Repeat "count" times.
382 void
383 closeFold(lnum, count)
384 linenr_T lnum;
385 long count;
387 setFoldRepeat(lnum, count, FALSE);
390 /* closeFoldRecurse() {{{2 */
392 * Close fold for current window at line "lnum" recursively.
394 void
395 closeFoldRecurse(lnum)
396 linenr_T 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.
406 void
407 opFoldRange(first, last, opening, recurse, had_visual)
408 linenr_T first;
409 linenr_T last;
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 */
415 linenr_T lnum;
416 linenr_T lnum_next;
418 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
420 lnum_next = lnum;
421 /* Opening one level only: next fold to open is after the one going to
422 * be opened. */
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
427 * closed fold. */
428 if (!opening && !recurse)
429 (void)hasFolding(lnum, NULL, &lnum_next);
431 if (done == DONE_NOTHING)
432 EMSG(_(e_nofold));
433 #ifdef FEAT_VISUAL
434 /* Force a redraw to remove the Visual highlighting. */
435 if (had_visual)
436 redraw_curbuf_later(INVERTED);
437 #endif
440 /* openFold() {{{2 */
442 * Open fold for current window at line "lnum".
443 * Repeat "count" times.
445 void
446 openFold(lnum, count)
447 linenr_T lnum;
448 long count;
450 setFoldRepeat(lnum, count, TRUE);
453 /* openFoldRecurse() {{{2 */
455 * Open fold for current window at line "lnum" recursively.
457 void
458 openFoldRecurse(lnum)
459 linenr_T lnum;
461 (void)setManualFold(lnum, TRUE, TRUE, NULL);
464 /* foldOpenCursor() {{{2 */
466 * Open folds until the cursor line is not in a closed fold.
468 void
469 foldOpenCursor()
471 int done;
473 checkupdate(curwin);
474 if (hasAnyFolding(curwin))
475 for (;;)
477 done = DONE_NOTHING;
478 (void)setManualFold(curwin->w_cursor.lnum, TRUE, FALSE, &done);
479 if (!(done & DONE_ACTION))
480 break;
484 /* newFoldLevel() {{{2 */
486 * Set new foldlevel for current window.
488 void
489 newFoldLevel()
491 newFoldLevelWin(curwin);
493 #ifdef FEAT_DIFF
494 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
496 win_T *wp;
499 * Set the same foldlevel in other windows in diff mode.
501 FOR_ALL_WINDOWS(wp)
503 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
505 wp->w_p_fdl = curwin->w_p_fdl;
506 newFoldLevelWin(wp);
510 #endif
513 static void
514 newFoldLevelWin(wp)
515 win_T *wp;
517 fold_T *fp;
518 int i;
520 checkupdate(wp);
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.
538 void
539 foldCheckClose()
541 if (*p_fcl != NUL) /* can only be "all" right now */
543 checkupdate(curwin);
544 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
545 (int)curwin->w_p_fdl))
546 changed_window_setting();
550 /* checkCloseRec() {{{2 */
551 static int
552 checkCloseRec(gap, lnum, level)
553 garray_T *gap;
554 linenr_T lnum;
555 int level;
557 fold_T *fp;
558 int retval = FALSE;
559 int i;
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;
571 retval = TRUE;
573 else
574 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
575 level - 1);
578 return retval;
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)
588 int create;
590 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
591 return TRUE;
592 if (create)
593 EMSG(_("E350: Cannot create fold with current 'foldmethod'"));
594 else
595 EMSG(_("E351: Cannot delete fold with current 'foldmethod'"));
596 return FALSE;
599 /* foldCreate() {{{2 */
601 * Create a fold from line "start" to line "end" (inclusive) in the current
602 * window.
604 void
605 foldCreate(start, end)
606 linenr_T start;
607 linenr_T end;
609 fold_T *fp;
610 garray_T *gap;
611 garray_T fold_ga;
612 int i, j;
613 int cont;
614 int use_level = FALSE;
615 int closed = FALSE;
616 int level = 0;
617 linenr_T start_rel = start;
618 linenr_T end_rel = end;
620 if (start > end)
622 /* reverse the range */
623 end = start_rel;
624 start = end_rel;
625 start_rel = start;
626 end_rel = end;
629 /* When 'foldmethod' is "marker" add markers, which creates the folds. */
630 if (foldmethodIsMarker(curwin))
632 foldCreateMarkers(start, end);
633 return;
636 checkupdate(curwin);
638 /* Find the place to insert the new fold. */
639 gap = &curwin->w_folds;
640 for (;;)
642 if (!foldFind(gap, start_rel, &fp))
643 break;
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)
652 use_level = TRUE;
653 if (level >= curwin->w_p_fdl)
654 closed = TRUE;
656 else if (fp->fd_flags == FD_CLOSED)
657 closed = TRUE;
658 ++level;
660 else
662 /* This fold and new fold overlap: Insert here and move some folds
663 * inside the new fold. */
664 break;
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)
677 break;
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
686 * of new fold. */
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;
692 i += cont;
694 /* Adjust line numbers in contained folds to be relative to the
695 * new fold. */
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. */
700 if (i < gap->ga_len)
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);
715 if (!use_level)
716 curwin->w_fold_manual = TRUE;
717 fp->fd_flags = FD_CLOSED;
718 fp->fd_small = MAYBE;
720 /* redraw */
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.
731 void
732 deleteFold(start, end, recursive, had_visual)
733 linenr_T start;
734 linenr_T end;
735 int recursive;
736 int had_visual; /* TRUE when Visual selection used */
738 garray_T *gap;
739 fold_T *fp;
740 garray_T *found_ga;
741 fold_T *found_fp = NULL;
742 linenr_T found_off = 0;
743 int use_level = FALSE;
744 int maybe_small = FALSE;
745 int level = 0;
746 linenr_T lnum = start;
747 linenr_T lnum_off;
748 int did_one = FALSE;
749 linenr_T first_lnum = MAXLNUM;
750 linenr_T last_lnum = 0;
752 checkupdate(curwin);
754 while (lnum <= end)
756 /* Find the deepest fold for "start". */
757 gap = &curwin->w_folds;
758 found_ga = NULL;
759 lnum_off = 0;
760 for (;;)
762 if (!foldFind(gap, lnum - lnum_off, &fp))
763 break;
764 /* lnum is inside this fold, remember info */
765 found_ga = gap;
766 found_fp = fp;
767 found_off = lnum_off;
769 /* if "lnum" is folded, don't check nesting */
770 if (check_closed(curwin, fp, &use_level, level,
771 &maybe_small, lnum_off))
772 break;
774 /* check nested folds */
775 gap = &fp->fd_nested;
776 lnum_off += fp->fd_top;
777 ++level;
779 if (found_ga == NULL)
781 ++lnum;
783 else
785 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
786 did_one = TRUE;
788 if (foldmethodIsManual(curwin))
789 deleteFoldEntry(found_ga,
790 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
791 else
793 if (found_fp->fd_top + found_off < first_lnum)
794 first_lnum = found_fp->fd_top;
795 if (lnum > last_lnum)
796 last_lnum = lnum;
797 parseMarker(curwin);
798 deleteFoldMarkers(found_fp, recursive, found_off);
801 /* redraw window */
802 changed_window_setting();
805 if (!did_one)
807 EMSG(_(e_nofold));
808 #ifdef FEAT_VISUAL
809 /* Force a redraw to remove the Visual highlighting. */
810 if (had_visual)
811 redraw_curbuf_later(INVERTED);
812 #endif
814 if (last_lnum > 0)
815 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
818 /* clearFolding() {{{2 */
820 * Remove all folding for window "win".
822 void
823 clearFolding(win)
824 win_T *win;
826 deleteFoldRecurse(&win->w_folds);
827 win->w_foldinvalid = FALSE;
830 /* foldUpdate() {{{2 */
832 * Update folds for changes in the buffer of a window.
833 * Note that inserted/deleted lines must have already been taken care of by
834 * calling foldMarkAdjust().
835 * The changes in lines from top to bot (inclusive).
837 void
838 foldUpdate(wp, top, bot)
839 win_T *wp;
840 linenr_T top;
841 linenr_T bot;
843 fold_T *fp;
845 /* Mark all folds from top to bot as maybe-small. */
846 (void)foldFind(&curwin->w_folds, curwin->w_cursor.lnum, &fp);
847 while (fp < (fold_T *)curwin->w_folds.ga_data + curwin->w_folds.ga_len
848 && fp->fd_top < bot)
850 fp->fd_small = MAYBE;
851 ++fp;
854 if (foldmethodIsIndent(wp)
855 || foldmethodIsExpr(wp)
856 || foldmethodIsMarker(wp)
857 #ifdef FEAT_DIFF
858 || foldmethodIsDiff(wp)
859 #endif
860 || foldmethodIsSyntax(wp))
862 int save_got_int = got_int;
864 /* reset got_int here, otherwise it won't work */
865 got_int = FALSE;
866 foldUpdateIEMS(wp, top, bot);
867 got_int |= save_got_int;
871 /* foldUpdateAll() {{{2 */
873 * Update all lines in a window for folding.
874 * Used when a fold setting changes or after reloading the buffer.
875 * The actual updating is postponed until fold info is used, to avoid doing
876 * every time a setting is changed or a syntax item is added.
878 void
879 foldUpdateAll(win)
880 win_T *win;
882 win->w_foldinvalid = TRUE;
883 redraw_win_later(win, NOT_VALID);
886 /* foldMoveTo() {{{2 */
888 * If "updown" is FALSE: Move to the start or end of the fold.
889 * If "updown" is TRUE: move to fold at the same level.
890 * If not moved return FAIL.
893 foldMoveTo(updown, dir, count)
894 int updown;
895 int dir; /* FORWARD or BACKWARD */
896 long count;
898 long n;
899 int retval = FAIL;
900 linenr_T lnum_off;
901 linenr_T lnum_found;
902 linenr_T lnum;
903 int use_level;
904 int maybe_small;
905 garray_T *gap;
906 fold_T *fp;
907 int level;
908 int last;
910 checkupdate(curwin);
912 /* Repeat "count" times. */
913 for (n = 0; n < count; ++n)
915 /* Find nested folds. Stop when a fold is closed. The deepest fold
916 * that moves the cursor is used. */
917 lnum_off = 0;
918 gap = &curwin->w_folds;
919 use_level = FALSE;
920 maybe_small = FALSE;
921 lnum_found = curwin->w_cursor.lnum;
922 level = 0;
923 last = FALSE;
924 for (;;)
926 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
928 if (!updown)
929 break;
931 /* When moving up, consider a fold above the cursor; when
932 * moving down consider a fold below the cursor. */
933 if (dir == FORWARD)
935 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
936 break;
937 --fp;
939 else
941 if (fp == (fold_T *)gap->ga_data)
942 break;
944 /* don't look for contained folds, they will always move
945 * the cursor too far. */
946 last = TRUE;
949 if (!last)
951 /* Check if this fold is closed. */
952 if (check_closed(curwin, fp, &use_level, level,
953 &maybe_small, lnum_off))
954 last = TRUE;
956 /* "[z" and "]z" stop at closed fold */
957 if (last && !updown)
958 break;
961 if (updown)
963 if (dir == FORWARD)
965 /* to start of next fold if there is one */
966 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
968 lnum = fp[1].fd_top + lnum_off;
969 if (lnum > curwin->w_cursor.lnum)
970 lnum_found = lnum;
973 else
975 /* to end of previous fold if there is one */
976 if (fp > (fold_T *)gap->ga_data)
978 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
979 if (lnum < curwin->w_cursor.lnum)
980 lnum_found = lnum;
984 else
986 /* Open fold found, set cursor to its start/end and then check
987 * nested folds. */
988 if (dir == FORWARD)
990 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
991 if (lnum > curwin->w_cursor.lnum)
992 lnum_found = lnum;
994 else
996 lnum = fp->fd_top + lnum_off;
997 if (lnum < curwin->w_cursor.lnum)
998 lnum_found = lnum;
1002 if (last)
1003 break;
1005 /* Check nested folds (if any). */
1006 gap = &fp->fd_nested;
1007 lnum_off += fp->fd_top;
1008 ++level;
1010 if (lnum_found != curwin->w_cursor.lnum)
1012 if (retval == FAIL)
1013 setpcmark();
1014 curwin->w_cursor.lnum = lnum_found;
1015 curwin->w_cursor.col = 0;
1016 retval = OK;
1018 else
1019 break;
1022 return retval;
1025 /* foldInitWin() {{{2 */
1027 * Init the fold info in a new window.
1029 void
1030 foldInitWin(newwin)
1031 win_T *newwin;
1033 ga_init2(&newwin->w_folds, (int)sizeof(fold_T), 10);
1036 /* find_wl_entry() {{{2 */
1038 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1039 * Only valid entries are considered (for entries where wl_valid is FALSE the
1040 * line number can be wrong).
1041 * Returns index of entry or -1 if not found.
1044 find_wl_entry(win, lnum)
1045 win_T *win;
1046 linenr_T lnum;
1048 int i;
1050 if (win->w_lines_valid > 0)
1051 for (i = 0; i < win->w_lines_valid; ++i)
1052 if (win->w_lines[i].wl_valid)
1054 if (lnum < win->w_lines[i].wl_lnum)
1055 return -1;
1056 if (lnum <= win->w_lines[i].wl_lastlnum)
1057 return i;
1059 return -1;
1062 /* foldAdjustVisual() {{{2 */
1063 #ifdef FEAT_VISUAL
1065 * Adjust the Visual area to include any fold at the start or end completely.
1067 void
1068 foldAdjustVisual()
1070 pos_T *start, *end;
1071 char_u *ptr;
1073 if (!VIsual_active || !hasAnyFolding(curwin))
1074 return;
1076 if (ltoreq(VIsual, curwin->w_cursor))
1078 start = &VIsual;
1079 end = &curwin->w_cursor;
1081 else
1083 start = &curwin->w_cursor;
1084 end = &VIsual;
1086 if (hasFolding(start->lnum, &start->lnum, NULL))
1087 start->col = 0;
1088 if (hasFolding(end->lnum, NULL, &end->lnum))
1090 ptr = ml_get(end->lnum);
1091 end->col = (colnr_T)STRLEN(ptr);
1092 if (end->col > 0 && *p_sel == 'o')
1093 --end->col;
1094 #ifdef FEAT_MBYTE
1095 /* prevent cursor from moving on the trail byte */
1096 if (has_mbyte)
1097 mb_adjust_cursor();
1098 #endif
1101 #endif
1103 /* cursor_foldstart() {{{2 */
1105 * Move the cursor to the first line of a closed fold.
1107 void
1108 foldAdjustCursor()
1110 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1113 /* Internal functions for "fold_T" {{{1 */
1114 /* cloneFoldGrowArray() {{{2 */
1116 * Will "clone" (i.e deep copy) a garray_T of folds.
1118 * Return FAIL if the operation cannot be completed, otherwise OK.
1120 void
1121 cloneFoldGrowArray(from, to)
1122 garray_T *from;
1123 garray_T *to;
1125 int i;
1126 fold_T *from_p;
1127 fold_T *to_p;
1129 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1130 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1131 return;
1133 from_p = (fold_T *)from->ga_data;
1134 to_p = (fold_T *)to->ga_data;
1136 for (i = 0; i < from->ga_len; i++)
1138 to_p->fd_top = from_p->fd_top;
1139 to_p->fd_len = from_p->fd_len;
1140 to_p->fd_flags = from_p->fd_flags;
1141 to_p->fd_small = from_p->fd_small;
1142 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1143 ++to->ga_len;
1144 ++from_p;
1145 ++to_p;
1149 /* foldFind() {{{2 */
1151 * Search for line "lnum" in folds of growarray "gap".
1152 * Set *fpp to the fold struct for the fold that contains "lnum" or
1153 * the first fold below it (careful: it can be beyond the end of the array!).
1154 * Returns FALSE when there is no fold that contains "lnum".
1156 static int
1157 foldFind(gap, lnum, fpp)
1158 garray_T *gap;
1159 linenr_T lnum;
1160 fold_T **fpp;
1162 linenr_T low, high;
1163 fold_T *fp;
1164 int i;
1167 * Perform a binary search.
1168 * "low" is lowest index of possible match.
1169 * "high" is highest index of possible match.
1171 fp = (fold_T *)gap->ga_data;
1172 low = 0;
1173 high = gap->ga_len - 1;
1174 while (low <= high)
1176 i = (low + high) / 2;
1177 if (fp[i].fd_top > lnum)
1178 /* fold below lnum, adjust high */
1179 high = i - 1;
1180 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
1181 /* fold above lnum, adjust low */
1182 low = i + 1;
1183 else
1185 /* lnum is inside this fold */
1186 *fpp = fp + i;
1187 return TRUE;
1190 *fpp = fp + low;
1191 return FALSE;
1194 /* foldLevelWin() {{{2 */
1196 * Return fold level at line number "lnum" in window "wp".
1198 static int
1199 foldLevelWin(wp, lnum)
1200 win_T *wp;
1201 linenr_T lnum;
1203 fold_T *fp;
1204 linenr_T lnum_rel = lnum;
1205 int level = 0;
1206 garray_T *gap;
1208 /* Recursively search for a fold that contains "lnum". */
1209 gap = &wp->w_folds;
1210 for (;;)
1212 if (!foldFind(gap, lnum_rel, &fp))
1213 break;
1214 /* Check nested folds. Line number is relative to containing fold. */
1215 gap = &fp->fd_nested;
1216 lnum_rel -= fp->fd_top;
1217 ++level;
1220 return level;
1223 /* checkupdate() {{{2 */
1225 * Check if the folds in window "wp" are invalid and update them if needed.
1227 static void
1228 checkupdate(wp)
1229 win_T *wp;
1231 if (wp->w_foldinvalid)
1233 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); /* will update all */
1234 wp->w_foldinvalid = FALSE;
1238 /* setFoldRepeat() {{{2 */
1240 * Open or close fold for current window at line "lnum".
1241 * Repeat "count" times.
1243 static void
1244 setFoldRepeat(lnum, count, open)
1245 linenr_T lnum;
1246 long count;
1247 int open;
1249 int done;
1250 long n;
1252 for (n = 0; n < count; ++n)
1254 done = DONE_NOTHING;
1255 (void)setManualFold(lnum, open, FALSE, &done);
1256 if (!(done & DONE_ACTION))
1258 /* Only give an error message when no fold could be opened. */
1259 if (n == 0 && !(done & DONE_FOLD))
1260 EMSG(_(e_nofold));
1261 break;
1266 /* setManualFold() {{{2 */
1268 * Open or close the fold in the current window which contains "lnum".
1269 * Also does this for other windows in diff mode when needed.
1271 static linenr_T
1272 setManualFold(lnum, opening, recurse, donep)
1273 linenr_T lnum;
1274 int opening; /* TRUE when opening, FALSE when closing */
1275 int recurse; /* TRUE when closing/opening recursive */
1276 int *donep;
1278 #ifdef FEAT_DIFF
1279 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1281 win_T *wp;
1282 linenr_T dlnum;
1285 * Do the same operation in other windows in diff mode. Calculate the
1286 * line number from the diffs.
1288 FOR_ALL_WINDOWS(wp)
1290 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1292 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1293 if (dlnum != 0)
1294 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1298 #endif
1300 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1303 /* setManualFoldWin() {{{2 */
1305 * Open or close the fold in window "wp" which contains "lnum".
1306 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1307 * fold was found and to DONE_ACTION when some fold was opened or closed.
1308 * When "donep" is NULL give an error message when no fold was found for
1309 * "lnum", but only if "wp" is "curwin".
1310 * Return the line number of the next line that could be closed.
1311 * It's only valid when "opening" is TRUE!
1313 static linenr_T
1314 setManualFoldWin(wp, lnum, opening, recurse, donep)
1315 win_T *wp;
1316 linenr_T lnum;
1317 int opening; /* TRUE when opening, FALSE when closing */
1318 int recurse; /* TRUE when closing/opening recursive */
1319 int *donep;
1321 fold_T *fp;
1322 fold_T *fp2;
1323 fold_T *found = NULL;
1324 int j;
1325 int level = 0;
1326 int use_level = FALSE;
1327 int found_fold = FALSE;
1328 garray_T *gap;
1329 linenr_T next = MAXLNUM;
1330 linenr_T off = 0;
1331 int done = 0;
1333 checkupdate(wp);
1336 * Find the fold, open or close it.
1338 gap = &wp->w_folds;
1339 for (;;)
1341 if (!foldFind(gap, lnum, &fp))
1343 /* If there is a following fold, continue there next time. */
1344 if (fp < (fold_T *)gap->ga_data + gap->ga_len)
1345 next = fp->fd_top + off;
1346 break;
1349 /* lnum is inside this fold */
1350 found_fold = TRUE;
1352 /* If there is a following fold, continue there next time. */
1353 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1354 next = fp[1].fd_top + off;
1356 /* Change from level-dependent folding to manual. */
1357 if (use_level || fp->fd_flags == FD_LEVEL)
1359 use_level = TRUE;
1360 if (level >= wp->w_p_fdl)
1361 fp->fd_flags = FD_CLOSED;
1362 else
1363 fp->fd_flags = FD_OPEN;
1364 fp2 = (fold_T *)fp->fd_nested.ga_data;
1365 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1366 fp2[j].fd_flags = FD_LEVEL;
1369 /* Simple case: Close recursively means closing the fold. */
1370 if (!opening && recurse)
1372 if (fp->fd_flags != FD_CLOSED)
1374 done |= DONE_ACTION;
1375 fp->fd_flags = FD_CLOSED;
1378 else if (fp->fd_flags == FD_CLOSED)
1380 /* When opening, open topmost closed fold. */
1381 if (opening)
1383 fp->fd_flags = FD_OPEN;
1384 done |= DONE_ACTION;
1385 if (recurse)
1386 foldOpenNested(fp);
1388 break;
1391 /* fold is open, check nested folds */
1392 found = fp;
1393 gap = &fp->fd_nested;
1394 lnum -= fp->fd_top;
1395 off += fp->fd_top;
1396 ++level;
1398 if (found_fold)
1400 /* When closing and not recurse, close deepest open fold. */
1401 if (!opening && found != NULL)
1403 found->fd_flags = FD_CLOSED;
1404 done |= DONE_ACTION;
1406 wp->w_fold_manual = TRUE;
1407 if (done & DONE_ACTION)
1408 changed_window_setting_win(wp);
1409 done |= DONE_FOLD;
1411 else if (donep == NULL && wp == curwin)
1412 EMSG(_(e_nofold));
1414 if (donep != NULL)
1415 *donep |= done;
1417 return next;
1420 /* foldOpenNested() {{{2 */
1422 * Open all nested folds in fold "fpr" recursively.
1424 static void
1425 foldOpenNested(fpr)
1426 fold_T *fpr;
1428 int i;
1429 fold_T *fp;
1431 fp = (fold_T *)fpr->fd_nested.ga_data;
1432 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1434 foldOpenNested(&fp[i]);
1435 fp[i].fd_flags = FD_OPEN;
1439 /* deleteFoldEntry() {{{2 */
1441 * Delete fold "idx" from growarray "gap".
1442 * When "recursive" is TRUE also delete all the folds contained in it.
1443 * When "recursive" is FALSE contained folds are moved one level up.
1445 static void
1446 deleteFoldEntry(gap, idx, recursive)
1447 garray_T *gap;
1448 int idx;
1449 int recursive;
1451 fold_T *fp;
1452 int i;
1453 long moved;
1454 fold_T *nfp;
1456 fp = (fold_T *)gap->ga_data + idx;
1457 if (recursive || fp->fd_nested.ga_len == 0)
1459 /* recursively delete the contained folds */
1460 deleteFoldRecurse(&fp->fd_nested);
1461 --gap->ga_len;
1462 if (idx < gap->ga_len)
1463 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1465 else
1467 /* move nested folds one level up, to overwrite the fold that is
1468 * deleted. */
1469 moved = fp->fd_nested.ga_len;
1470 if (ga_grow(gap, (int)(moved - 1)) == OK)
1472 /* adjust fd_top and fd_flags for the moved folds */
1473 nfp = (fold_T *)fp->fd_nested.ga_data;
1474 for (i = 0; i < moved; ++i)
1476 nfp[i].fd_top += fp->fd_top;
1477 if (fp->fd_flags == FD_LEVEL)
1478 nfp[i].fd_flags = FD_LEVEL;
1479 if (fp->fd_small == MAYBE)
1480 nfp[i].fd_small = MAYBE;
1483 /* move the existing folds down to make room */
1484 if (idx < gap->ga_len)
1485 mch_memmove(fp + moved, fp + 1,
1486 sizeof(fold_T) * (gap->ga_len - idx));
1487 /* move the contained folds one level up */
1488 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1489 vim_free(nfp);
1490 gap->ga_len += moved - 1;
1495 /* deleteFoldRecurse() {{{2 */
1497 * Delete nested folds in a fold.
1499 void
1500 deleteFoldRecurse(gap)
1501 garray_T *gap;
1503 int i;
1505 for (i = 0; i < gap->ga_len; ++i)
1506 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1507 ga_clear(gap);
1510 /* foldMarkAdjust() {{{2 */
1512 * Update line numbers of folds for inserted/deleted lines.
1514 void
1515 foldMarkAdjust(wp, line1, line2, amount, amount_after)
1516 win_T *wp;
1517 linenr_T line1;
1518 linenr_T line2;
1519 long amount;
1520 long amount_after;
1522 /* If deleting marks from line1 to line2, but not deleting all those
1523 * lines, set line2 so that only deleted lines have their folds removed. */
1524 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1525 line2 = line1 - amount_after - 1;
1526 /* If appending a line in Insert mode, it should be included in the fold
1527 * just above the line. */
1528 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1529 --line1;
1530 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1533 /* foldMarkAdjustRecurse() {{{2 */
1534 static void
1535 foldMarkAdjustRecurse(gap, line1, line2, amount, amount_after)
1536 garray_T *gap;
1537 linenr_T line1;
1538 linenr_T line2;
1539 long amount;
1540 long amount_after;
1542 fold_T *fp;
1543 int i;
1544 linenr_T last;
1545 linenr_T top;
1547 /* In Insert mode an inserted line at the top of a fold is considered part
1548 * of the fold, otherwise it isn't. */
1549 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1550 top = line1 + 1;
1551 else
1552 top = line1;
1554 /* Find the fold containing or just below "line1". */
1555 (void)foldFind(gap, line1, &fp);
1558 * Adjust all folds below "line1" that are affected.
1560 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1563 * Check for these situations:
1564 * 1 2 3
1565 * 1 2 3
1566 * line1 2 3 4 5
1567 * 2 3 4 5
1568 * 2 3 4 5
1569 * line2 2 3 4 5
1570 * 3 5 6
1571 * 3 5 6
1574 last = fp->fd_top + fp->fd_len - 1; /* last line of fold */
1576 /* 1. fold completely above line1: nothing to do */
1577 if (last < line1)
1578 continue;
1580 /* 6. fold below line2: only adjust for amount_after */
1581 if (fp->fd_top > line2)
1583 if (amount_after == 0)
1584 break;
1585 fp->fd_top += amount_after;
1587 else
1589 if (fp->fd_top >= top && last <= line2)
1591 /* 4. fold completely contained in range */
1592 if (amount == MAXLNUM)
1594 /* Deleting lines: delete the fold completely */
1595 deleteFoldEntry(gap, i, TRUE);
1596 --i; /* adjust index for deletion */
1597 --fp;
1599 else
1600 fp->fd_top += amount;
1602 else
1604 /* 2, 3, or 5: need to correct nested folds too */
1605 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1606 line2 - fp->fd_top, amount, amount_after);
1607 if (fp->fd_top < top)
1609 if (last <= line2)
1611 /* 2. fold contains line1, line2 is below fold */
1612 if (amount == MAXLNUM)
1613 fp->fd_len = line1 - fp->fd_top;
1614 else
1615 fp->fd_len += amount;
1617 else
1619 /* 3. fold contains line1 and line2 */
1620 fp->fd_len += amount_after;
1623 else
1625 /* 5. fold is below line1 and contains line2 */
1626 if (amount == MAXLNUM)
1628 fp->fd_len -= line2 - fp->fd_top + 1;
1629 fp->fd_top = line1;
1631 else
1633 fp->fd_len += amount_after - amount;
1634 fp->fd_top += amount;
1642 /* getDeepestNesting() {{{2 */
1644 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1645 * current window open.
1648 getDeepestNesting()
1650 checkupdate(curwin);
1651 return getDeepestNestingRecurse(&curwin->w_folds);
1654 static int
1655 getDeepestNestingRecurse(gap)
1656 garray_T *gap;
1658 int i;
1659 int level;
1660 int maxlevel = 0;
1661 fold_T *fp;
1663 fp = (fold_T *)gap->ga_data;
1664 for (i = 0; i < gap->ga_len; ++i)
1666 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1667 if (level > maxlevel)
1668 maxlevel = level;
1671 return maxlevel;
1674 /* check_closed() {{{2 */
1676 * Check if a fold is closed and update the info needed to check nested folds.
1678 static int
1679 check_closed(win, fp, use_levelp, level, maybe_smallp, lnum_off)
1680 win_T *win;
1681 fold_T *fp;
1682 int *use_levelp; /* TRUE: outer fold had FD_LEVEL */
1683 int level; /* folding depth */
1684 int *maybe_smallp; /* TRUE: outer this had fd_small == MAYBE */
1685 linenr_T lnum_off; /* line number offset for fp->fd_top */
1687 int closed = FALSE;
1689 /* Check if this fold is closed. If the flag is FD_LEVEL this
1690 * fold and all folds it contains depend on 'foldlevel'. */
1691 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1693 *use_levelp = TRUE;
1694 if (level >= win->w_p_fdl)
1695 closed = TRUE;
1697 else if (fp->fd_flags == FD_CLOSED)
1698 closed = TRUE;
1700 /* Small fold isn't closed anyway. */
1701 if (fp->fd_small == MAYBE)
1702 *maybe_smallp = TRUE;
1703 if (closed)
1705 if (*maybe_smallp)
1706 fp->fd_small = MAYBE;
1707 checkSmall(win, fp, lnum_off);
1708 if (fp->fd_small == TRUE)
1709 closed = FALSE;
1711 return closed;
1714 /* checkSmall() {{{2 */
1716 * Update fd_small field of fold "fp".
1718 static void
1719 checkSmall(wp, fp, lnum_off)
1720 win_T *wp;
1721 fold_T *fp;
1722 linenr_T lnum_off; /* offset for fp->fd_top */
1724 int count;
1725 int n;
1727 if (fp->fd_small == MAYBE)
1729 /* Mark any nested folds to maybe-small */
1730 setSmallMaybe(&fp->fd_nested);
1732 if (fp->fd_len > curwin->w_p_fml)
1733 fp->fd_small = FALSE;
1734 else
1736 count = 0;
1737 for (n = 0; n < fp->fd_len; ++n)
1739 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1740 if (count > curwin->w_p_fml)
1742 fp->fd_small = FALSE;
1743 return;
1746 fp->fd_small = TRUE;
1751 /* setSmallMaybe() {{{2 */
1753 * Set small flags in "gap" to MAYBE.
1755 static void
1756 setSmallMaybe(gap)
1757 garray_T *gap;
1759 int i;
1760 fold_T *fp;
1762 fp = (fold_T *)gap->ga_data;
1763 for (i = 0; i < gap->ga_len; ++i)
1764 fp[i].fd_small = MAYBE;
1767 /* foldCreateMarkers() {{{2 */
1769 * Create a fold from line "start" to line "end" (inclusive) in the current
1770 * window by adding markers.
1772 static void
1773 foldCreateMarkers(start, end)
1774 linenr_T start;
1775 linenr_T end;
1777 if (!curbuf->b_p_ma)
1779 EMSG(_(e_modifiable));
1780 return;
1782 parseMarker(curwin);
1784 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1785 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1787 /* Update both changes here, to avoid all folds after the start are
1788 * changed when the start marker is inserted and the end isn't. */
1789 changed_lines(start, (colnr_T)0, end, 0L);
1792 /* foldAddMarker() {{{2 */
1794 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1796 static void
1797 foldAddMarker(lnum, marker, markerlen)
1798 linenr_T lnum;
1799 char_u *marker;
1800 int markerlen;
1802 char_u *cms = curbuf->b_p_cms;
1803 char_u *line;
1804 int line_len;
1805 char_u *newline;
1806 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
1808 /* Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end */
1809 line = ml_get(lnum);
1810 line_len = (int)STRLEN(line);
1812 if (u_save(lnum - 1, lnum + 1) == OK)
1814 newline = alloc((unsigned)(line_len + markerlen + STRLEN(cms) + 1));
1815 if (newline == NULL)
1816 return;
1817 STRCPY(newline, line);
1818 if (p == NULL)
1819 vim_strncpy(newline + line_len, marker, markerlen);
1820 else
1822 STRCPY(newline + line_len, cms);
1823 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1824 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1827 ml_replace(lnum, newline, FALSE);
1831 /* deleteFoldMarkers() {{{2 */
1833 * Delete the markers for a fold, causing it to be deleted.
1835 static void
1836 deleteFoldMarkers(fp, recursive, lnum_off)
1837 fold_T *fp;
1838 int recursive;
1839 linenr_T lnum_off; /* offset for fp->fd_top */
1841 int i;
1843 if (recursive)
1844 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1845 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1846 lnum_off + fp->fd_top);
1847 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1848 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1849 foldendmarker, foldendmarkerlen);
1852 /* foldDelMarker() {{{2 */
1854 * Delete marker "marker[markerlen]" at the end of line "lnum".
1855 * Delete 'commentstring' if it matches.
1856 * If the marker is not found, there is no error message. Could a missing
1857 * close-marker.
1859 static void
1860 foldDelMarker(lnum, marker, markerlen)
1861 linenr_T lnum;
1862 char_u *marker;
1863 int markerlen;
1865 char_u *line;
1866 char_u *newline;
1867 char_u *p;
1868 int len;
1869 char_u *cms = curbuf->b_p_cms;
1870 char_u *cms2;
1872 line = ml_get(lnum);
1873 for (p = line; *p != NUL; ++p)
1874 if (STRNCMP(p, marker, markerlen) == 0)
1876 /* Found the marker, include a digit if it's there. */
1877 len = markerlen;
1878 if (VIM_ISDIGIT(p[len]))
1879 ++len;
1880 if (*cms != NUL)
1882 /* Also delete 'commentstring' if it matches. */
1883 cms2 = (char_u *)strstr((char *)cms, "%s");
1884 if (p - line >= cms2 - cms
1885 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1886 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1888 p -= cms2 - cms;
1889 len += (int)STRLEN(cms) - 2;
1892 if (u_save(lnum - 1, lnum + 1) == OK)
1894 /* Make new line: text-before-marker + text-after-marker */
1895 newline = alloc((unsigned)(STRLEN(line) - len + 1));
1896 if (newline != NULL)
1898 STRNCPY(newline, line, p - line);
1899 STRCPY(newline + (p - line), p + len);
1900 ml_replace(lnum, newline, FALSE);
1903 break;
1907 /* get_foldtext() {{{2 */
1909 * Return the text for a closed fold at line "lnum", with last line "lnume".
1910 * When 'foldtext' isn't set puts the result in "buf[51]". Otherwise the
1911 * result is in allocated memory.
1913 char_u *
1914 get_foldtext(wp, lnum, lnume, foldinfo, buf)
1915 win_T *wp;
1916 linenr_T lnum, lnume;
1917 foldinfo_T *foldinfo;
1918 char_u *buf;
1920 char_u *text = NULL;
1922 #ifdef FEAT_EVAL
1923 if (*wp->w_p_fdt != NUL)
1925 char_u dashes[51];
1926 win_T *save_curwin;
1927 int level;
1928 char_u *p;
1930 /* Set "v:foldstart" and "v:foldend". */
1931 set_vim_var_nr(VV_FOLDSTART, lnum);
1932 set_vim_var_nr(VV_FOLDEND, lnume);
1934 /* Set "v:folddashes" to a string of "level" dashes. */
1935 /* Set "v:foldlevel" to "level". */
1936 level = foldinfo->fi_level;
1937 if (level > 50)
1938 level = 50;
1939 vim_memset(dashes, '-', (size_t)level);
1940 dashes[level] = NUL;
1941 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1942 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
1943 save_curwin = curwin;
1944 curwin = wp;
1945 curbuf = wp->w_buffer;
1947 ++emsg_off;
1948 text = eval_to_string_safe(wp->w_p_fdt, NULL,
1949 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
1950 --emsg_off;
1952 curwin = save_curwin;
1953 curbuf = curwin->w_buffer;
1954 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1956 if (text != NULL)
1958 /* Replace unprintable characters, if there are any. But
1959 * replace a TAB with a space. */
1960 for (p = text; *p != NUL; ++p)
1962 # ifdef FEAT_MBYTE
1963 int len;
1965 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
1967 if (!vim_isprintc((*mb_ptr2char)(p)))
1968 break;
1969 p += len - 1;
1971 else
1972 # endif
1973 if (*p == TAB)
1974 *p = ' ';
1975 else if (ptr2cells(p) > 1)
1976 break;
1978 if (*p != NUL)
1980 p = transstr(text);
1981 vim_free(text);
1982 text = p;
1986 if (text == NULL)
1987 #endif
1989 sprintf((char *)buf, _("+--%3ld lines folded "),
1990 (long)(lnume - lnum + 1));
1991 text = buf;
1993 return text;
1996 /* foldtext_cleanup() {{{2 */
1998 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2000 void
2001 foldtext_cleanup(str)
2002 char_u *str;
2004 char_u *cms_start; /* first part or the whole comment */
2005 int cms_slen = 0; /* length of cms_start */
2006 char_u *cms_end; /* last part of the comment or NULL */
2007 int cms_elen = 0; /* length of cms_end */
2008 char_u *s;
2009 char_u *p;
2010 int len;
2011 int did1 = FALSE;
2012 int did2 = FALSE;
2014 /* Ignore leading and trailing white space in 'commentstring'. */
2015 cms_start = skipwhite(curbuf->b_p_cms);
2016 cms_slen = (int)STRLEN(cms_start);
2017 while (cms_slen > 0 && vim_iswhite(cms_start[cms_slen - 1]))
2018 --cms_slen;
2020 /* locate "%s" in 'commentstring', use the part before and after it. */
2021 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2022 if (cms_end != NULL)
2024 cms_elen = cms_slen - (int)(cms_end - cms_start);
2025 cms_slen = (int)(cms_end - cms_start);
2027 /* exclude white space before "%s" */
2028 while (cms_slen > 0 && vim_iswhite(cms_start[cms_slen - 1]))
2029 --cms_slen;
2031 /* skip "%s" and white space after it */
2032 s = skipwhite(cms_end + 2);
2033 cms_elen -= (int)(s - cms_end);
2034 cms_end = s;
2036 parseMarker(curwin);
2038 for (s = str; *s != NUL; )
2040 len = 0;
2041 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
2042 len = foldstartmarkerlen;
2043 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
2044 len = foldendmarkerlen;
2045 if (len > 0)
2047 if (VIM_ISDIGIT(s[len]))
2048 ++len;
2050 /* May remove 'commentstring' start. Useful when it's a double
2051 * quote and we already removed a double quote. */
2052 for (p = s; p > str && vim_iswhite(p[-1]); --p)
2054 if (p >= str + cms_slen
2055 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2057 len += (int)(s - p) + cms_slen;
2058 s = p - cms_slen;
2061 else if (cms_end != NULL)
2063 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
2065 len = cms_slen;
2066 did1 = TRUE;
2068 else if (!did2 && cms_elen > 0
2069 && STRNCMP(s, cms_end, cms_elen) == 0)
2071 len = cms_elen;
2072 did2 = TRUE;
2075 if (len != 0)
2077 while (vim_iswhite(s[len]))
2078 ++len;
2079 STRMOVE(s, s + len);
2081 else
2083 mb_ptr_adv(s);
2088 /* Folding by indent, expr, marker and syntax. {{{1 */
2089 /* Define "fline_T", passed to get fold level for a line. {{{2 */
2090 typedef struct
2092 win_T *wp; /* window */
2093 linenr_T lnum; /* current line number */
2094 linenr_T off; /* offset between lnum and real line number */
2095 linenr_T lnum_save; /* line nr used by foldUpdateIEMSRecurse() */
2096 int lvl; /* current level (-1 for undefined) */
2097 int lvl_next; /* level used for next line */
2098 int start; /* number of folds that are forced to start at
2099 this line. */
2100 int end; /* level of fold that is forced to end below
2101 this line */
2102 int had_end; /* level of fold that is forced to end above
2103 this line (copy of "end" of prev. line) */
2104 } fline_T;
2106 /* Flag is set when redrawing is needed. */
2107 static int fold_changed;
2109 /* Function declarations. {{{2 */
2110 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));
2111 static int foldInsert __ARGS((garray_T *gap, int i));
2112 static void foldSplit __ARGS((garray_T *gap, int i, linenr_T top, linenr_T bot));
2113 static void foldRemove __ARGS((garray_T *gap, linenr_T top, linenr_T bot));
2114 static void foldMerge __ARGS((fold_T *fp1, garray_T *gap, fold_T *fp2));
2115 static void foldlevelIndent __ARGS((fline_T *flp));
2116 #ifdef FEAT_DIFF
2117 static void foldlevelDiff __ARGS((fline_T *flp));
2118 #endif
2119 static void foldlevelExpr __ARGS((fline_T *flp));
2120 static void foldlevelMarker __ARGS((fline_T *flp));
2121 static void foldlevelSyntax __ARGS((fline_T *flp));
2123 /* foldUpdateIEMS() {{{2 */
2125 * Update the folding for window "wp", at least from lines "top" to "bot".
2126 * Return TRUE if any folds did change.
2128 static void
2129 foldUpdateIEMS(wp, top, bot)
2130 win_T *wp;
2131 linenr_T top;
2132 linenr_T bot;
2134 linenr_T start;
2135 linenr_T end;
2136 fline_T fline;
2137 void (*getlevel)__ARGS((fline_T *));
2138 int level;
2139 fold_T *fp;
2141 /* Avoid problems when being called recursively. */
2142 if (invalid_top != (linenr_T)0)
2143 return;
2145 if (wp->w_foldinvalid)
2147 /* Need to update all folds. */
2148 top = 1;
2149 bot = wp->w_buffer->b_ml.ml_line_count;
2150 wp->w_foldinvalid = FALSE;
2152 /* Mark all folds a maybe-small. */
2153 setSmallMaybe(&wp->w_folds);
2156 #ifdef FEAT_DIFF
2157 /* add the context for "diff" folding */
2158 if (foldmethodIsDiff(wp))
2160 if (top > diff_context)
2161 top -= diff_context;
2162 else
2163 top = 1;
2164 bot += diff_context;
2166 #endif
2168 /* When deleting lines at the end of the buffer "top" can be past the end
2169 * of the buffer. */
2170 if (top > wp->w_buffer->b_ml.ml_line_count)
2171 top = wp->w_buffer->b_ml.ml_line_count;
2173 fold_changed = FALSE;
2174 fline.wp = wp;
2175 fline.off = 0;
2176 fline.lvl = 0;
2177 fline.lvl_next = -1;
2178 fline.start = 0;
2179 fline.end = MAX_LEVEL + 1;
2180 fline.had_end = MAX_LEVEL + 1;
2182 invalid_top = top;
2183 invalid_bot = bot;
2185 if (foldmethodIsMarker(wp))
2187 getlevel = foldlevelMarker;
2189 /* Init marker variables to speed up foldlevelMarker(). */
2190 parseMarker(wp);
2192 /* Need to get the level of the line above top, it is used if there is
2193 * no marker at the top. */
2194 if (top > 1)
2196 /* Get the fold level at top - 1. */
2197 level = foldLevelWin(wp, top - 1);
2199 /* The fold may end just above the top, check for that. */
2200 fline.lnum = top - 1;
2201 fline.lvl = level;
2202 getlevel(&fline);
2204 /* If a fold started here, we already had the level, if it stops
2205 * here, we need to use lvl_next. Could also start and end a fold
2206 * in the same line. */
2207 if (fline.lvl > level)
2208 fline.lvl = level - (fline.lvl - fline.lvl_next);
2209 else
2210 fline.lvl = fline.lvl_next;
2212 fline.lnum = top;
2213 getlevel(&fline);
2215 else
2217 fline.lnum = top;
2218 if (foldmethodIsExpr(wp))
2220 getlevel = foldlevelExpr;
2221 /* start one line back, because a "<1" may indicate the end of a
2222 * fold in the topline */
2223 if (top > 1)
2224 --fline.lnum;
2226 else if (foldmethodIsSyntax(wp))
2227 getlevel = foldlevelSyntax;
2228 #ifdef FEAT_DIFF
2229 else if (foldmethodIsDiff(wp))
2230 getlevel = foldlevelDiff;
2231 #endif
2232 else
2233 getlevel = foldlevelIndent;
2235 /* Backup to a line for which the fold level is defined. Since it's
2236 * always defined for line one, we will stop there. */
2237 fline.lvl = -1;
2238 for ( ; !got_int; --fline.lnum)
2240 /* Reset lvl_next each time, because it will be set to a value for
2241 * the next line, but we search backwards here. */
2242 fline.lvl_next = -1;
2243 getlevel(&fline);
2244 if (fline.lvl >= 0)
2245 break;
2249 start = fline.lnum;
2250 end = bot;
2251 /* Do at least one line. */
2252 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2253 end = start;
2254 while (!got_int)
2256 /* Always stop at the end of the file ("end" can be past the end of
2257 * the file). */
2258 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2259 break;
2260 if (fline.lnum > end)
2262 /* For "marker", "expr" and "syntax" methods: If a change caused
2263 * a fold to be removed, we need to continue at least until where
2264 * it ended. */
2265 if (getlevel != foldlevelMarker
2266 && getlevel != foldlevelSyntax
2267 && getlevel != foldlevelExpr)
2268 break;
2269 if ((start <= end
2270 && foldFind(&wp->w_folds, end, &fp)
2271 && fp->fd_top + fp->fd_len - 1 > end)
2272 || (fline.lvl == 0
2273 && foldFind(&wp->w_folds, fline.lnum, &fp)
2274 && fp->fd_top < fline.lnum))
2275 end = fp->fd_top + fp->fd_len - 1;
2276 else if (getlevel == foldlevelSyntax
2277 && foldLevelWin(wp, fline.lnum) != fline.lvl)
2278 /* For "syntax" method: Compare the foldlevel that the syntax
2279 * tells us to the foldlevel from the existing folds. If they
2280 * don't match continue updating folds. */
2281 end = fline.lnum;
2282 else
2283 break;
2286 /* A level 1 fold starts at a line with foldlevel > 0. */
2287 if (fline.lvl > 0)
2289 invalid_top = fline.lnum;
2290 invalid_bot = end;
2291 end = foldUpdateIEMSRecurse(&wp->w_folds,
2292 1, start, &fline, getlevel, end, FD_LEVEL);
2293 start = fline.lnum;
2295 else
2297 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2298 break;
2299 ++fline.lnum;
2300 fline.lvl = fline.lvl_next;
2301 getlevel(&fline);
2305 /* There can't be any folds from start until end now. */
2306 foldRemove(&wp->w_folds, start, end);
2308 /* If some fold changed, need to redraw and position cursor. */
2309 if (fold_changed && wp->w_p_fen)
2310 changed_window_setting_win(wp);
2312 /* If we updated folds past "bot", need to redraw more lines. Don't do
2313 * this in other situations, the changed lines will be redrawn anyway and
2314 * this method can cause the whole window to be updated. */
2315 if (end != bot)
2317 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2318 wp->w_redraw_top = top;
2319 if (wp->w_redraw_bot < end)
2320 wp->w_redraw_bot = end;
2323 invalid_top = (linenr_T)0;
2326 /* foldUpdateIEMSRecurse() {{{2 */
2328 * Update a fold that starts at "flp->lnum". At this line there is always a
2329 * valid foldlevel, and its level >= "level".
2330 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2331 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2332 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2333 * the marker method and a text change made following folds to change.
2334 * When returning, "flp->lnum_save" is the line number that was used to get
2335 * the level when the level at "flp->lnum" is invalid.
2336 * Remove any folds from "startlnum" up to here at this level.
2337 * Recursively update nested folds.
2338 * Below line "bot" there are no changes in the text.
2339 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2340 * outer fold.
2341 * "flp->off" is the offset to the real line number in the buffer.
2343 * All this would be a lot simpler if all folds in the range would be deleted
2344 * and then created again. But we would lose all information about the
2345 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2347 * Returns bot, which may have been increased for lines that also need to be
2348 * updated as a result of a detected change in the fold.
2350 static linenr_T
2351 foldUpdateIEMSRecurse(gap, level, startlnum, flp, getlevel, bot, topflags)
2352 garray_T *gap;
2353 int level;
2354 linenr_T startlnum;
2355 fline_T *flp;
2356 void (*getlevel)__ARGS((fline_T *));
2357 linenr_T bot;
2358 int topflags; /* flags used by containing fold */
2360 linenr_T ll;
2361 fold_T *fp = NULL;
2362 fold_T *fp2;
2363 int lvl = level;
2364 linenr_T startlnum2 = startlnum;
2365 linenr_T firstlnum = flp->lnum; /* first lnum we got */
2366 int i;
2367 int finish = FALSE;
2368 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2369 int concat;
2372 * If using the marker method, the start line is not the start of a fold
2373 * at the level we're dealing with and the level is non-zero, we must use
2374 * the previous fold. But ignore a fold that starts at or below
2375 * startlnum, it must be deleted.
2377 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2378 && flp->lvl > 0)
2380 foldFind(gap, startlnum - 1, &fp);
2381 if (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2382 || fp->fd_top >= startlnum)
2383 fp = NULL;
2387 * Loop over all lines in this fold, or until "bot" is hit.
2388 * Handle nested folds inside of this fold.
2389 * "flp->lnum" is the current line. When finding the end of the fold, it
2390 * is just below the end of the fold.
2391 * "*flp" contains the level of the line "flp->lnum" or a following one if
2392 * there are lines with an invalid fold level. "flp->lnum_save" is the
2393 * line number that was used to get the fold level (below "flp->lnum" when
2394 * it has an invalid fold level). When called the fold level is always
2395 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2397 flp->lnum_save = flp->lnum;
2398 while (!got_int)
2400 /* Updating folds can be slow, check for CTRL-C. */
2401 line_breakcheck();
2403 /* Set "lvl" to the level of line "flp->lnum". When flp->start is set
2404 * and after the first line of the fold, set the level to zero to
2405 * force the fold to end. Do the same when had_end is set: Previous
2406 * line was marked as end of a fold. */
2407 lvl = flp->lvl;
2408 if (lvl > MAX_LEVEL)
2409 lvl = MAX_LEVEL;
2410 if (flp->lnum > firstlnum
2411 && (level > lvl - flp->start || level >= flp->had_end))
2412 lvl = 0;
2414 if (flp->lnum > bot && !finish && fp != NULL)
2416 /* For "marker" and "syntax" methods:
2417 * - If a change caused a nested fold to be removed, we need to
2418 * delete it and continue at least until where it ended.
2419 * - If a change caused a nested fold to be created, or this fold
2420 * to continue below its original end, need to finish this fold.
2422 if (getlevel != foldlevelMarker
2423 && getlevel != foldlevelExpr
2424 && getlevel != foldlevelSyntax)
2425 break;
2426 i = 0;
2427 fp2 = fp;
2428 if (lvl >= level)
2430 /* Compute how deep the folds currently are, if it's deeper
2431 * than "lvl" then some must be deleted, need to update
2432 * at least one nested fold. */
2433 ll = flp->lnum - fp->fd_top;
2434 while (foldFind(&fp2->fd_nested, ll, &fp2))
2436 ++i;
2437 ll -= fp2->fd_top;
2440 if (lvl < level + i)
2442 foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
2443 if (fp2 != NULL)
2444 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2446 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2447 finish = TRUE;
2448 else
2449 break;
2452 /* At the start of the first nested fold and at the end of the current
2453 * fold: check if existing folds at this level, before the current
2454 * one, need to be deleted or truncated. */
2455 if (fp == NULL
2456 && (lvl != level
2457 || flp->lnum_save >= bot
2458 || flp->start != 0
2459 || flp->had_end <= MAX_LEVEL
2460 || flp->lnum == linecount))
2463 * Remove or update folds that have lines between startlnum and
2464 * firstlnum.
2466 while (!got_int)
2468 /* set concat to 1 if it's allowed to concatenated this fold
2469 * with a previous one that touches it. */
2470 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2471 concat = 0;
2472 else
2473 concat = 1;
2475 /* Find an existing fold to re-use. Preferably one that
2476 * includes startlnum, otherwise one that ends just before
2477 * startlnum or starts after it. */
2478 if (foldFind(gap, startlnum, &fp)
2479 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2480 && fp->fd_top <= firstlnum)
2481 || foldFind(gap, firstlnum - concat, &fp)
2482 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2483 && ((lvl < level && fp->fd_top < flp->lnum)
2484 || (lvl >= level
2485 && fp->fd_top <= flp->lnum_save))))
2487 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2489 /* Use existing fold for the new fold. If it starts
2490 * before where we started looking, extend it. If it
2491 * starts at another line, update nested folds to keep
2492 * their position, compensating for the new fd_top. */
2493 if (fp->fd_top >= startlnum && fp->fd_top != firstlnum)
2495 if (fp->fd_top > firstlnum)
2496 /* like lines are inserted */
2497 foldMarkAdjustRecurse(&fp->fd_nested,
2498 (linenr_T)0, (linenr_T)MAXLNUM,
2499 (long)(fp->fd_top - firstlnum), 0L);
2500 else
2501 /* like lines are deleted */
2502 foldMarkAdjustRecurse(&fp->fd_nested,
2503 (linenr_T)0,
2504 (long)(firstlnum - fp->fd_top - 1),
2505 (linenr_T)MAXLNUM,
2506 (long)(fp->fd_top - firstlnum));
2507 fp->fd_len += fp->fd_top - firstlnum;
2508 fp->fd_top = firstlnum;
2509 fold_changed = TRUE;
2511 else if (flp->start != 0 && lvl == level
2512 && fp->fd_top != firstlnum)
2514 /* Existing fold that includes startlnum must stop
2515 * if we find the start of a new fold at the same
2516 * level. Split it. Delete contained folds at
2517 * this point to split them too. */
2518 foldRemove(&fp->fd_nested, flp->lnum - fp->fd_top,
2519 flp->lnum - fp->fd_top);
2520 i = (int)(fp - (fold_T *)gap->ga_data);
2521 foldSplit(gap, i, flp->lnum, flp->lnum - 1);
2522 fp = (fold_T *)gap->ga_data + i + 1;
2523 /* If using the "marker" or "syntax" method, we
2524 * need to continue until the end of the fold is
2525 * found. */
2526 if (getlevel == foldlevelMarker
2527 || getlevel == foldlevelExpr
2528 || getlevel == foldlevelSyntax)
2529 finish = TRUE;
2531 break;
2533 if (fp->fd_top >= startlnum)
2535 /* A fold that starts at or after startlnum and stops
2536 * before the new fold must be deleted. Continue
2537 * looking for the next one. */
2538 deleteFoldEntry(gap,
2539 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2541 else
2543 /* A fold has some lines above startlnum, truncate it
2544 * to stop just above startlnum. */
2545 fp->fd_len = startlnum - fp->fd_top;
2546 foldMarkAdjustRecurse(&fp->fd_nested,
2547 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2548 (linenr_T)MAXLNUM, 0L);
2549 fold_changed = TRUE;
2552 else
2554 /* Insert new fold. Careful: ga_data may be NULL and it
2555 * may change! */
2556 i = (int)(fp - (fold_T *)gap->ga_data);
2557 if (foldInsert(gap, i) != OK)
2558 return bot;
2559 fp = (fold_T *)gap->ga_data + i;
2560 /* The new fold continues until bot, unless we find the
2561 * end earlier. */
2562 fp->fd_top = firstlnum;
2563 fp->fd_len = bot - firstlnum + 1;
2564 /* When the containing fold is open, the new fold is open.
2565 * The new fold is closed if the fold above it is closed.
2566 * The first fold depends on the containing fold. */
2567 if (topflags == FD_OPEN)
2569 flp->wp->w_fold_manual = TRUE;
2570 fp->fd_flags = FD_OPEN;
2572 else if (i <= 0)
2574 fp->fd_flags = topflags;
2575 if (topflags != FD_LEVEL)
2576 flp->wp->w_fold_manual = TRUE;
2578 else
2579 fp->fd_flags = (fp - 1)->fd_flags;
2580 fp->fd_small = MAYBE;
2581 /* If using the "marker", "expr" or "syntax" method, we
2582 * need to continue until the end of the fold is found. */
2583 if (getlevel == foldlevelMarker
2584 || getlevel == foldlevelExpr
2585 || getlevel == foldlevelSyntax)
2586 finish = TRUE;
2587 fold_changed = TRUE;
2588 break;
2593 if (lvl < level || flp->lnum > linecount)
2596 * Found a line with a lower foldlevel, this fold ends just above
2597 * "flp->lnum".
2599 break;
2603 * The fold includes the line "flp->lnum" and "flp->lnum_save".
2604 * Check "fp" for safety.
2606 if (lvl > level && fp != NULL)
2609 * There is a nested fold, handle it recursively.
2611 /* At least do one line (can happen when finish is TRUE). */
2612 if (bot < flp->lnum)
2613 bot = flp->lnum;
2615 /* Line numbers in the nested fold are relative to the start of
2616 * this fold. */
2617 flp->lnum = flp->lnum_save - fp->fd_top;
2618 flp->off += fp->fd_top;
2619 i = (int)(fp - (fold_T *)gap->ga_data);
2620 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2621 startlnum2 - fp->fd_top, flp, getlevel,
2622 bot - fp->fd_top, fp->fd_flags);
2623 fp = (fold_T *)gap->ga_data + i;
2624 flp->lnum += fp->fd_top;
2625 flp->lnum_save += fp->fd_top;
2626 flp->off -= fp->fd_top;
2627 bot += fp->fd_top;
2628 startlnum2 = flp->lnum;
2630 /* This fold may end at the same line, don't incr. flp->lnum. */
2632 else
2635 * Get the level of the next line, then continue the loop to check
2636 * if it ends there.
2637 * Skip over undefined lines, to find the foldlevel after it.
2638 * For the last line in the file the foldlevel is always valid.
2640 flp->lnum = flp->lnum_save;
2641 ll = flp->lnum + 1;
2642 while (!got_int)
2644 /* Make the previous level available to foldlevel(). */
2645 prev_lnum = flp->lnum;
2646 prev_lnum_lvl = flp->lvl;
2648 if (++flp->lnum > linecount)
2649 break;
2650 flp->lvl = flp->lvl_next;
2651 getlevel(flp);
2652 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2653 break;
2655 prev_lnum = 0;
2656 if (flp->lnum > linecount)
2657 break;
2659 /* leave flp->lnum_save to lnum of the line that was used to get
2660 * the level, flp->lnum to the lnum of the next line. */
2661 flp->lnum_save = flp->lnum;
2662 flp->lnum = ll;
2666 if (fp == NULL) /* only happens when got_int is set */
2667 return bot;
2670 * Get here when:
2671 * lvl < level: the folds ends just above "flp->lnum"
2672 * lvl >= level: fold continues below "bot"
2675 /* Current fold at least extends until lnum. */
2676 if (fp->fd_len < flp->lnum - fp->fd_top)
2678 fp->fd_len = flp->lnum - fp->fd_top;
2679 fp->fd_small = MAYBE;
2680 fold_changed = TRUE;
2683 /* Delete contained folds from the end of the last one found until where
2684 * we stopped looking. */
2685 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2686 flp->lnum - 1 - fp->fd_top);
2688 if (lvl < level)
2690 /* End of fold found, update the length when it got shorter. */
2691 if (fp->fd_len != flp->lnum - fp->fd_top)
2693 if (fp->fd_top + fp->fd_len > bot + 1)
2695 /* fold continued below bot */
2696 if (getlevel == foldlevelMarker
2697 || getlevel == foldlevelExpr
2698 || getlevel == foldlevelSyntax)
2700 /* marker method: truncate the fold and make sure the
2701 * previously included lines are processed again */
2702 bot = fp->fd_top + fp->fd_len - 1;
2703 fp->fd_len = flp->lnum - fp->fd_top;
2705 else
2707 /* indent or expr method: split fold to create a new one
2708 * below bot */
2709 i = (int)(fp - (fold_T *)gap->ga_data);
2710 foldSplit(gap, i, flp->lnum, bot);
2711 fp = (fold_T *)gap->ga_data + i;
2714 else
2715 fp->fd_len = flp->lnum - fp->fd_top;
2716 fold_changed = TRUE;
2720 /* delete following folds that end before the current line */
2721 for (;;)
2723 fp2 = fp + 1;
2724 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2725 || fp2->fd_top > flp->lnum)
2726 break;
2727 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2729 if (fp2->fd_top < flp->lnum)
2731 /* Make fold that includes lnum start at lnum. */
2732 foldMarkAdjustRecurse(&fp2->fd_nested,
2733 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2734 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2735 fp2->fd_len -= flp->lnum - fp2->fd_top;
2736 fp2->fd_top = flp->lnum;
2737 fold_changed = TRUE;
2740 if (lvl >= level)
2742 /* merge new fold with existing fold that follows */
2743 foldMerge(fp, gap, fp2);
2745 break;
2747 fold_changed = TRUE;
2748 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2751 /* Need to redraw the lines we inspected, which might be further down than
2752 * was asked for. */
2753 if (bot < flp->lnum - 1)
2754 bot = flp->lnum - 1;
2756 return bot;
2759 /* foldInsert() {{{2 */
2761 * Insert a new fold in "gap" at position "i".
2762 * Returns OK for success, FAIL for failure.
2764 static int
2765 foldInsert(gap, i)
2766 garray_T *gap;
2767 int i;
2769 fold_T *fp;
2771 if (ga_grow(gap, 1) != OK)
2772 return FAIL;
2773 fp = (fold_T *)gap->ga_data + i;
2774 if (i < gap->ga_len)
2775 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2776 ++gap->ga_len;
2777 ga_init2(&fp->fd_nested, (int)sizeof(fold_T), 10);
2778 return OK;
2781 /* foldSplit() {{{2 */
2783 * Split the "i"th fold in "gap", which starts before "top" and ends below
2784 * "bot" in two pieces, one ending above "top" and the other starting below
2785 * "bot".
2786 * The caller must first have taken care of any nested folds from "top" to
2787 * "bot"!
2789 static void
2790 foldSplit(gap, i, top, bot)
2791 garray_T *gap;
2792 int i;
2793 linenr_T top;
2794 linenr_T bot;
2796 fold_T *fp;
2797 fold_T *fp2;
2798 garray_T *gap1;
2799 garray_T *gap2;
2800 int idx;
2801 int len;
2803 /* The fold continues below bot, need to split it. */
2804 if (foldInsert(gap, i + 1) == FAIL)
2805 return;
2806 fp = (fold_T *)gap->ga_data + i;
2807 fp[1].fd_top = bot + 1;
2808 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2809 fp[1].fd_flags = fp->fd_flags;
2811 /* Move nested folds below bot to new fold. There can't be
2812 * any between top and bot, they have been removed by the caller. */
2813 gap1 = &fp->fd_nested;
2814 gap2 = &fp[1].fd_nested;
2815 (void)(foldFind(gap1, bot + 1 - fp->fd_top, &fp2));
2816 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2817 if (len > 0 && ga_grow(gap2, len) == OK)
2819 for (idx = 0; idx < len; ++idx)
2821 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2822 ((fold_T *)gap2->ga_data)[idx].fd_top
2823 -= fp[1].fd_top - fp->fd_top;
2825 gap2->ga_len = len;
2826 gap1->ga_len -= len;
2828 fp->fd_len = top - fp->fd_top;
2829 fold_changed = TRUE;
2832 /* foldRemove() {{{2 */
2834 * Remove folds within the range "top" to and including "bot".
2835 * Check for these situations:
2836 * 1 2 3
2837 * 1 2 3
2838 * top 2 3 4 5
2839 * 2 3 4 5
2840 * bot 2 3 4 5
2841 * 3 5 6
2842 * 3 5 6
2844 * 1: not changed
2845 * 2: truncate to stop above "top"
2846 * 3: split in two parts, one stops above "top", other starts below "bot".
2847 * 4: deleted
2848 * 5: made to start below "bot".
2849 * 6: not changed
2851 static void
2852 foldRemove(gap, top, bot)
2853 garray_T *gap;
2854 linenr_T top;
2855 linenr_T bot;
2857 fold_T *fp = NULL;
2859 if (bot < top)
2860 return; /* nothing to do */
2862 for (;;)
2864 /* Find fold that includes top or a following one. */
2865 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2867 /* 2: or 3: need to delete nested folds */
2868 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
2869 if (fp->fd_top + fp->fd_len > bot + 1)
2871 /* 3: need to split it. */
2872 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2874 else
2876 /* 2: truncate fold at "top". */
2877 fp->fd_len = top - fp->fd_top;
2879 fold_changed = TRUE;
2880 continue;
2882 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2883 || fp->fd_top > bot)
2885 /* 6: Found a fold below bot, can stop looking. */
2886 break;
2888 if (fp->fd_top >= top)
2890 /* Found an entry below top. */
2891 fold_changed = TRUE;
2892 if (fp->fd_top + fp->fd_len - 1 > bot)
2894 /* 5: Make fold that includes bot start below bot. */
2895 foldMarkAdjustRecurse(&fp->fd_nested,
2896 (linenr_T)0, (long)(bot - fp->fd_top),
2897 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2898 fp->fd_len -= bot - fp->fd_top + 1;
2899 fp->fd_top = bot + 1;
2900 break;
2903 /* 4: Delete completely contained fold. */
2904 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
2909 /* foldMerge() {{{2 */
2911 * Merge two adjacent folds (and the nested ones in them).
2912 * This only works correctly when the folds are really adjacent! Thus "fp1"
2913 * must end just above "fp2".
2914 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
2915 * Fold entry "fp2" in "gap" is deleted.
2917 static void
2918 foldMerge(fp1, gap, fp2)
2919 fold_T *fp1;
2920 garray_T *gap;
2921 fold_T *fp2;
2923 fold_T *fp3;
2924 fold_T *fp4;
2925 int idx;
2926 garray_T *gap1 = &fp1->fd_nested;
2927 garray_T *gap2 = &fp2->fd_nested;
2929 /* If the last nested fold in fp1 touches the first nested fold in fp2,
2930 * merge them recursively. */
2931 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
2932 foldMerge(fp3, gap2, fp4);
2934 /* Move nested folds in fp2 to the end of fp1. */
2935 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
2937 for (idx = 0; idx < gap2->ga_len; ++idx)
2939 ((fold_T *)gap1->ga_data)[gap1->ga_len]
2940 = ((fold_T *)gap2->ga_data)[idx];
2941 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
2942 ++gap1->ga_len;
2944 gap2->ga_len = 0;
2947 fp1->fd_len += fp2->fd_len;
2948 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2949 fold_changed = TRUE;
2952 /* foldlevelIndent() {{{2 */
2954 * Low level function to get the foldlevel for the "indent" method.
2955 * Doesn't use any caching.
2956 * Returns a level of -1 if the foldlevel depends on surrounding lines.
2958 static void
2959 foldlevelIndent(flp)
2960 fline_T *flp;
2962 char_u *s;
2963 buf_T *buf;
2964 linenr_T lnum = flp->lnum + flp->off;
2966 buf = flp->wp->w_buffer;
2967 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
2969 /* empty line or lines starting with a character in 'foldignore': level
2970 * depends on surrounding lines */
2971 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
2973 /* first and last line can't be undefined, use level 0 */
2974 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
2975 flp->lvl = 0;
2976 else
2977 flp->lvl = -1;
2979 else
2980 flp->lvl = get_indent_buf(buf, lnum) / buf->b_p_sw;
2981 if (flp->lvl > flp->wp->w_p_fdn)
2983 flp->lvl = flp->wp->w_p_fdn;
2984 if (flp->lvl < 0)
2985 flp->lvl = 0;
2989 /* foldlevelDiff() {{{2 */
2990 #ifdef FEAT_DIFF
2992 * Low level function to get the foldlevel for the "diff" method.
2993 * Doesn't use any caching.
2995 static void
2996 foldlevelDiff(flp)
2997 fline_T *flp;
2999 if (diff_infold(flp->wp, flp->lnum + flp->off))
3000 flp->lvl = 1;
3001 else
3002 flp->lvl = 0;
3004 #endif
3006 /* foldlevelExpr() {{{2 */
3008 * Low level function to get the foldlevel for the "expr" method.
3009 * Doesn't use any caching.
3010 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3012 static void
3013 foldlevelExpr(flp)
3014 fline_T *flp;
3016 #ifndef FEAT_EVAL
3017 flp->start = FALSE;
3018 flp->lvl = 0;
3019 #else
3020 win_T *win;
3021 int n;
3022 int c;
3023 linenr_T lnum = flp->lnum + flp->off;
3024 int save_keytyped;
3026 win = curwin;
3027 curwin = flp->wp;
3028 curbuf = flp->wp->w_buffer;
3029 set_vim_var_nr(VV_LNUM, lnum);
3031 flp->start = 0;
3032 flp->had_end = flp->end;
3033 flp->end = MAX_LEVEL + 1;
3034 if (lnum <= 1)
3035 flp->lvl = 0;
3037 /* KeyTyped may be reset to 0 when calling a function which invokes
3038 * do_cmdline(). To make 'foldopen' work correctly restore KeyTyped. */
3039 save_keytyped = KeyTyped;
3040 n = eval_foldexpr(flp->wp->w_p_fde, &c);
3041 KeyTyped = save_keytyped;
3043 switch (c)
3045 /* "a1", "a2", .. : add to the fold level */
3046 case 'a': if (flp->lvl >= 0)
3048 flp->lvl += n;
3049 flp->lvl_next = flp->lvl;
3051 flp->start = n;
3052 break;
3054 /* "s1", "s2", .. : subtract from the fold level */
3055 case 's': if (flp->lvl >= 0)
3057 if (n > flp->lvl)
3058 flp->lvl_next = 0;
3059 else
3060 flp->lvl_next = flp->lvl - n;
3061 flp->end = flp->lvl_next + 1;
3063 break;
3065 /* ">1", ">2", .. : start a fold with a certain level */
3066 case '>': flp->lvl = n;
3067 flp->lvl_next = n;
3068 flp->start = 1;
3069 break;
3071 /* "<1", "<2", .. : end a fold with a certain level */
3072 case '<': flp->lvl_next = n - 1;
3073 flp->end = n;
3074 break;
3076 /* "=": No change in level */
3077 case '=': flp->lvl_next = flp->lvl;
3078 break;
3080 /* "-1", "0", "1", ..: set fold level */
3081 default: if (n < 0)
3082 /* Use the current level for the next line, so that "a1"
3083 * will work there. */
3084 flp->lvl_next = flp->lvl;
3085 else
3086 flp->lvl_next = n;
3087 flp->lvl = n;
3088 break;
3091 /* If the level is unknown for the first or the last line in the file, use
3092 * level 0. */
3093 if (flp->lvl < 0)
3095 if (lnum <= 1)
3097 flp->lvl = 0;
3098 flp->lvl_next = 0;
3100 if (lnum == curbuf->b_ml.ml_line_count)
3101 flp->lvl_next = 0;
3104 curwin = win;
3105 curbuf = curwin->w_buffer;
3106 #endif
3109 /* parseMarker() {{{2 */
3111 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3112 * "foldendmarkerlen".
3113 * Relies on the option value to have been checked for correctness already.
3115 static void
3116 parseMarker(wp)
3117 win_T *wp;
3119 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3120 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3121 foldendmarkerlen = (int)STRLEN(foldendmarker);
3124 /* foldlevelMarker() {{{2 */
3126 * Low level function to get the foldlevel for the "marker" method.
3127 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3128 * set before calling this.
3129 * Requires that flp->lvl is set to the fold level of the previous line!
3130 * Careful: This means you can't call this function twice on the same line.
3131 * Doesn't use any caching.
3132 * Sets flp->start when a start marker was found.
3134 static void
3135 foldlevelMarker(flp)
3136 fline_T *flp;
3138 char_u *startmarker;
3139 int cstart;
3140 int cend;
3141 int start_lvl = flp->lvl;
3142 char_u *s;
3143 int n;
3145 /* cache a few values for speed */
3146 startmarker = flp->wp->w_p_fmr;
3147 cstart = *startmarker;
3148 ++startmarker;
3149 cend = *foldendmarker;
3151 /* Default: no start found, next level is same as current level */
3152 flp->start = 0;
3153 flp->lvl_next = flp->lvl;
3155 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3156 while (*s)
3158 if (*s == cstart
3159 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3161 /* found startmarker: set flp->lvl */
3162 s += foldstartmarkerlen;
3163 if (VIM_ISDIGIT(*s))
3165 n = atoi((char *)s);
3166 if (n > 0)
3168 flp->lvl = n;
3169 flp->lvl_next = n;
3170 if (n <= start_lvl)
3171 flp->start = 1;
3172 else
3173 flp->start = n - start_lvl;
3176 else
3178 ++flp->lvl;
3179 ++flp->lvl_next;
3180 ++flp->start;
3183 else if (*s == cend
3184 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3186 /* found endmarker: set flp->lvl_next */
3187 s += foldendmarkerlen;
3188 if (VIM_ISDIGIT(*s))
3190 n = atoi((char *)s);
3191 if (n > 0)
3193 flp->lvl = n;
3194 flp->lvl_next = n - 1;
3195 /* never start a fold with an end marker */
3196 if (flp->lvl_next > flp->lvl)
3197 flp->lvl_next = flp->lvl;
3200 else
3201 --flp->lvl_next;
3203 else
3204 mb_ptr_adv(s);
3207 /* The level can't go negative, must be missing a start marker. */
3208 if (flp->lvl_next < 0)
3209 flp->lvl_next = 0;
3212 /* foldlevelSyntax() {{{2 */
3214 * Low level function to get the foldlevel for the "syntax" method.
3215 * Doesn't use any caching.
3217 static void
3218 foldlevelSyntax(flp)
3219 fline_T *flp;
3221 #ifndef FEAT_SYN_HL
3222 flp->start = 0;
3223 flp->lvl = 0;
3224 #else
3225 linenr_T lnum = flp->lnum + flp->off;
3226 int n;
3228 /* Use the maximum fold level at the start of this line and the next. */
3229 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3230 flp->start = 0;
3231 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3233 n = syn_get_foldlevel(flp->wp, lnum + 1);
3234 if (n > flp->lvl)
3236 flp->start = n - flp->lvl; /* fold(s) start here */
3237 flp->lvl = n;
3240 #endif
3243 /* functions for storing the fold state in a View {{{1 */
3244 /* put_folds() {{{2 */
3245 #if defined(FEAT_SESSION) || defined(PROTO)
3246 static int put_folds_recurse __ARGS((FILE *fd, garray_T *gap, linenr_T off));
3247 static int put_foldopen_recurse __ARGS((FILE *fd, garray_T *gap, linenr_T off));
3250 * Write commands to "fd" to restore the manual folds in window "wp".
3251 * Return FAIL if writing fails.
3254 put_folds(fd, wp)
3255 FILE *fd;
3256 win_T *wp;
3258 if (foldmethodIsManual(wp))
3260 if (put_line(fd, "silent! normal! zE") == FAIL
3261 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL)
3262 return FAIL;
3265 /* If some folds are manually opened/closed, need to restore that. */
3266 if (wp->w_fold_manual)
3267 return put_foldopen_recurse(fd, &wp->w_folds, (linenr_T)0);
3269 return OK;
3272 /* put_folds_recurse() {{{2 */
3274 * Write commands to "fd" to recreate manually created folds.
3275 * Returns FAIL when writing failed.
3277 static int
3278 put_folds_recurse(fd, gap, off)
3279 FILE *fd;
3280 garray_T *gap;
3281 linenr_T off;
3283 int i;
3284 fold_T *fp;
3286 fp = (fold_T *)gap->ga_data;
3287 for (i = 0; i < gap->ga_len; i++)
3289 /* Do nested folds first, they will be created closed. */
3290 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3291 return FAIL;
3292 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3293 fp->fd_top + off + fp->fd_len - 1) < 0
3294 || put_eol(fd) == FAIL)
3295 return FAIL;
3296 ++fp;
3298 return OK;
3301 /* put_foldopen_recurse() {{{2 */
3303 * Write commands to "fd" to open and close manually opened/closed folds.
3304 * Returns FAIL when writing failed.
3306 static int
3307 put_foldopen_recurse(fd, gap, off)
3308 FILE *fd;
3309 garray_T *gap;
3310 linenr_T off;
3312 int i;
3313 fold_T *fp;
3315 fp = (fold_T *)gap->ga_data;
3316 for (i = 0; i < gap->ga_len; i++)
3318 if (fp->fd_flags != FD_LEVEL)
3320 if (fp->fd_nested.ga_len > 0)
3322 /* open/close nested folds while this fold is open */
3323 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3324 || put_eol(fd) == FAIL
3325 || put_line(fd, "normal zo") == FAIL)
3326 return FAIL;
3327 if (put_foldopen_recurse(fd, &fp->fd_nested, off + fp->fd_top)
3328 == FAIL)
3329 return FAIL;
3331 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3332 || put_eol(fd) == FAIL
3333 || fprintf(fd, "normal z%c",
3334 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3335 || put_eol(fd) == FAIL)
3336 return FAIL;
3338 ++fp;
3341 return OK;
3343 #endif /* FEAT_SESSION */
3345 /* }}}1 */
3346 #endif /* defined(FEAT_FOLDING) || defined(PROTO) */