Patch 7.0.167
[MacVim/jjgod.git] / src / fold.c
bloba28a8747c5b3f8fa0fe0acf6299e9601f40b8e04
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))
861 foldUpdateIEMS(wp, top, bot);
864 /* foldUpdateAll() {{{2 */
866 * Update all lines in a window for folding.
867 * Used when a fold setting changes or after reloading the buffer.
868 * The actual updating is postponed until fold info is used, to avoid doing
869 * every time a setting is changed or a syntax item is added.
871 void
872 foldUpdateAll(win)
873 win_T *win;
875 win->w_foldinvalid = TRUE;
876 redraw_win_later(win, NOT_VALID);
879 /* foldMoveTo() {{{2 */
881 * If "updown" is FALSE: Move to the start or end of the fold.
882 * If "updown" is TRUE: move to fold at the same level.
883 * If not moved return FAIL.
886 foldMoveTo(updown, dir, count)
887 int updown;
888 int dir; /* FORWARD or BACKWARD */
889 long count;
891 long n;
892 int retval = FAIL;
893 linenr_T lnum_off;
894 linenr_T lnum_found;
895 linenr_T lnum;
896 int use_level;
897 int maybe_small;
898 garray_T *gap;
899 fold_T *fp;
900 int level;
901 int last;
903 checkupdate(curwin);
905 /* Repeat "count" times. */
906 for (n = 0; n < count; ++n)
908 /* Find nested folds. Stop when a fold is closed. The deepest fold
909 * that moves the cursor is used. */
910 lnum_off = 0;
911 gap = &curwin->w_folds;
912 use_level = FALSE;
913 maybe_small = FALSE;
914 lnum_found = curwin->w_cursor.lnum;
915 level = 0;
916 last = FALSE;
917 for (;;)
919 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
921 if (!updown)
922 break;
924 /* When moving up, consider a fold above the cursor; when
925 * moving down consider a fold below the cursor. */
926 if (dir == FORWARD)
928 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
929 break;
930 --fp;
932 else
934 if (fp == (fold_T *)gap->ga_data)
935 break;
937 /* don't look for contained folds, they will always move
938 * the cursor too far. */
939 last = TRUE;
942 if (!last)
944 /* Check if this fold is closed. */
945 if (check_closed(curwin, fp, &use_level, level,
946 &maybe_small, lnum_off))
947 last = TRUE;
949 /* "[z" and "]z" stop at closed fold */
950 if (last && !updown)
951 break;
954 if (updown)
956 if (dir == FORWARD)
958 /* to start of next fold if there is one */
959 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
961 lnum = fp[1].fd_top + lnum_off;
962 if (lnum > curwin->w_cursor.lnum)
963 lnum_found = lnum;
966 else
968 /* to end of previous fold if there is one */
969 if (fp > (fold_T *)gap->ga_data)
971 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
972 if (lnum < curwin->w_cursor.lnum)
973 lnum_found = lnum;
977 else
979 /* Open fold found, set cursor to its start/end and then check
980 * nested folds. */
981 if (dir == FORWARD)
983 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
984 if (lnum > curwin->w_cursor.lnum)
985 lnum_found = lnum;
987 else
989 lnum = fp->fd_top + lnum_off;
990 if (lnum < curwin->w_cursor.lnum)
991 lnum_found = lnum;
995 if (last)
996 break;
998 /* Check nested folds (if any). */
999 gap = &fp->fd_nested;
1000 lnum_off += fp->fd_top;
1001 ++level;
1003 if (lnum_found != curwin->w_cursor.lnum)
1005 if (retval == FAIL)
1006 setpcmark();
1007 curwin->w_cursor.lnum = lnum_found;
1008 curwin->w_cursor.col = 0;
1009 retval = OK;
1011 else
1012 break;
1015 return retval;
1018 /* foldInitWin() {{{2 */
1020 * Init the fold info in a new window.
1022 void
1023 foldInitWin(newwin)
1024 win_T *newwin;
1026 ga_init2(&newwin->w_folds, (int)sizeof(fold_T), 10);
1029 /* find_wl_entry() {{{2 */
1031 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1032 * Only valid entries are considered (for entries where wl_valid is FALSE the
1033 * line number can be wrong).
1034 * Returns index of entry or -1 if not found.
1037 find_wl_entry(win, lnum)
1038 win_T *win;
1039 linenr_T lnum;
1041 int i;
1043 if (win->w_lines_valid > 0)
1044 for (i = 0; i < win->w_lines_valid; ++i)
1045 if (win->w_lines[i].wl_valid)
1047 if (lnum < win->w_lines[i].wl_lnum)
1048 return -1;
1049 if (lnum <= win->w_lines[i].wl_lastlnum)
1050 return i;
1052 return -1;
1055 /* foldAdjustVisual() {{{2 */
1056 #ifdef FEAT_VISUAL
1058 * Adjust the Visual area to include any fold at the start or end completely.
1060 void
1061 foldAdjustVisual()
1063 pos_T *start, *end;
1064 char_u *ptr;
1066 if (!VIsual_active || !hasAnyFolding(curwin))
1067 return;
1069 if (ltoreq(VIsual, curwin->w_cursor))
1071 start = &VIsual;
1072 end = &curwin->w_cursor;
1074 else
1076 start = &curwin->w_cursor;
1077 end = &VIsual;
1079 if (hasFolding(start->lnum, &start->lnum, NULL))
1080 start->col = 0;
1081 if (hasFolding(end->lnum, NULL, &end->lnum))
1083 ptr = ml_get(end->lnum);
1084 end->col = (colnr_T)STRLEN(ptr);
1085 if (end->col > 0 && *p_sel == 'o')
1086 --end->col;
1087 #ifdef FEAT_MBYTE
1088 /* prevent cursor from moving on the trail byte */
1089 if (has_mbyte)
1090 mb_adjust_cursor();
1091 #endif
1094 #endif
1096 /* cursor_foldstart() {{{2 */
1098 * Move the cursor to the first line of a closed fold.
1100 void
1101 foldAdjustCursor()
1103 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1106 /* Internal functions for "fold_T" {{{1 */
1107 /* cloneFoldGrowArray() {{{2 */
1109 * Will "clone" (i.e deep copy) a garray_T of folds.
1111 * Return FAIL if the operation cannot be completed, otherwise OK.
1113 void
1114 cloneFoldGrowArray(from, to)
1115 garray_T *from;
1116 garray_T *to;
1118 int i;
1119 fold_T *from_p;
1120 fold_T *to_p;
1122 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1123 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1124 return;
1126 from_p = (fold_T *)from->ga_data;
1127 to_p = (fold_T *)to->ga_data;
1129 for (i = 0; i < from->ga_len; i++)
1131 to_p->fd_top = from_p->fd_top;
1132 to_p->fd_len = from_p->fd_len;
1133 to_p->fd_flags = from_p->fd_flags;
1134 to_p->fd_small = from_p->fd_small;
1135 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1136 ++to->ga_len;
1137 ++from_p;
1138 ++to_p;
1142 /* foldFind() {{{2 */
1144 * Search for line "lnum" in folds of growarray "gap".
1145 * Set *fpp to the fold struct for the fold that contains "lnum" or
1146 * the first fold below it (careful: it can be beyond the end of the array!).
1147 * Returns FALSE when there is no fold that contains "lnum".
1149 static int
1150 foldFind(gap, lnum, fpp)
1151 garray_T *gap;
1152 linenr_T lnum;
1153 fold_T **fpp;
1155 linenr_T low, high;
1156 fold_T *fp;
1157 int i;
1160 * Perform a binary search.
1161 * "low" is lowest index of possible match.
1162 * "high" is highest index of possible match.
1164 fp = (fold_T *)gap->ga_data;
1165 low = 0;
1166 high = gap->ga_len - 1;
1167 while (low <= high)
1169 i = (low + high) / 2;
1170 if (fp[i].fd_top > lnum)
1171 /* fold below lnum, adjust high */
1172 high = i - 1;
1173 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
1174 /* fold above lnum, adjust low */
1175 low = i + 1;
1176 else
1178 /* lnum is inside this fold */
1179 *fpp = fp + i;
1180 return TRUE;
1183 *fpp = fp + low;
1184 return FALSE;
1187 /* foldLevelWin() {{{2 */
1189 * Return fold level at line number "lnum" in window "wp".
1191 static int
1192 foldLevelWin(wp, lnum)
1193 win_T *wp;
1194 linenr_T lnum;
1196 fold_T *fp;
1197 linenr_T lnum_rel = lnum;
1198 int level = 0;
1199 garray_T *gap;
1201 /* Recursively search for a fold that contains "lnum". */
1202 gap = &wp->w_folds;
1203 for (;;)
1205 if (!foldFind(gap, lnum_rel, &fp))
1206 break;
1207 /* Check nested folds. Line number is relative to containing fold. */
1208 gap = &fp->fd_nested;
1209 lnum_rel -= fp->fd_top;
1210 ++level;
1213 return level;
1216 /* checkupdate() {{{2 */
1218 * Check if the folds in window "wp" are invalid and update them if needed.
1220 static void
1221 checkupdate(wp)
1222 win_T *wp;
1224 if (wp->w_foldinvalid)
1226 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); /* will update all */
1227 wp->w_foldinvalid = FALSE;
1231 /* setFoldRepeat() {{{2 */
1233 * Open or close fold for current window at line "lnum".
1234 * Repeat "count" times.
1236 static void
1237 setFoldRepeat(lnum, count, open)
1238 linenr_T lnum;
1239 long count;
1240 int open;
1242 int done;
1243 long n;
1245 for (n = 0; n < count; ++n)
1247 done = DONE_NOTHING;
1248 (void)setManualFold(lnum, open, FALSE, &done);
1249 if (!(done & DONE_ACTION))
1251 /* Only give an error message when no fold could be opened. */
1252 if (n == 0 && !(done & DONE_FOLD))
1253 EMSG(_(e_nofold));
1254 break;
1259 /* setManualFold() {{{2 */
1261 * Open or close the fold in the current window which contains "lnum".
1262 * Also does this for other windows in diff mode when needed.
1264 static linenr_T
1265 setManualFold(lnum, opening, recurse, donep)
1266 linenr_T lnum;
1267 int opening; /* TRUE when opening, FALSE when closing */
1268 int recurse; /* TRUE when closing/opening recursive */
1269 int *donep;
1271 #ifdef FEAT_DIFF
1272 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1274 win_T *wp;
1275 linenr_T dlnum;
1278 * Do the same operation in other windows in diff mode. Calculate the
1279 * line number from the diffs.
1281 FOR_ALL_WINDOWS(wp)
1283 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1285 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1286 if (dlnum != 0)
1287 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1291 #endif
1293 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1296 /* setManualFoldWin() {{{2 */
1298 * Open or close the fold in window "wp" which contains "lnum".
1299 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1300 * fold was found and to DONE_ACTION when some fold was opened or closed.
1301 * When "donep" is NULL give an error message when no fold was found for
1302 * "lnum", but only if "wp" is "curwin".
1303 * Return the line number of the next line that could be closed.
1304 * It's only valid when "opening" is TRUE!
1306 static linenr_T
1307 setManualFoldWin(wp, lnum, opening, recurse, donep)
1308 win_T *wp;
1309 linenr_T lnum;
1310 int opening; /* TRUE when opening, FALSE when closing */
1311 int recurse; /* TRUE when closing/opening recursive */
1312 int *donep;
1314 fold_T *fp;
1315 fold_T *fp2;
1316 fold_T *found = NULL;
1317 int j;
1318 int level = 0;
1319 int use_level = FALSE;
1320 int found_fold = FALSE;
1321 garray_T *gap;
1322 linenr_T next = MAXLNUM;
1323 linenr_T off = 0;
1324 int done = 0;
1326 checkupdate(wp);
1329 * Find the fold, open or close it.
1331 gap = &wp->w_folds;
1332 for (;;)
1334 if (!foldFind(gap, lnum, &fp))
1336 /* If there is a following fold, continue there next time. */
1337 if (fp < (fold_T *)gap->ga_data + gap->ga_len)
1338 next = fp->fd_top + off;
1339 break;
1342 /* lnum is inside this fold */
1343 found_fold = TRUE;
1345 /* If there is a following fold, continue there next time. */
1346 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1347 next = fp[1].fd_top + off;
1349 /* Change from level-dependent folding to manual. */
1350 if (use_level || fp->fd_flags == FD_LEVEL)
1352 use_level = TRUE;
1353 if (level >= wp->w_p_fdl)
1354 fp->fd_flags = FD_CLOSED;
1355 else
1356 fp->fd_flags = FD_OPEN;
1357 fp2 = (fold_T *)fp->fd_nested.ga_data;
1358 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1359 fp2[j].fd_flags = FD_LEVEL;
1362 /* Simple case: Close recursively means closing the fold. */
1363 if (!opening && recurse)
1365 if (fp->fd_flags != FD_CLOSED)
1367 done |= DONE_ACTION;
1368 fp->fd_flags = FD_CLOSED;
1371 else if (fp->fd_flags == FD_CLOSED)
1373 /* When opening, open topmost closed fold. */
1374 if (opening)
1376 fp->fd_flags = FD_OPEN;
1377 done |= DONE_ACTION;
1378 if (recurse)
1379 foldOpenNested(fp);
1381 break;
1384 /* fold is open, check nested folds */
1385 found = fp;
1386 gap = &fp->fd_nested;
1387 lnum -= fp->fd_top;
1388 off += fp->fd_top;
1389 ++level;
1391 if (found_fold)
1393 /* When closing and not recurse, close deepest open fold. */
1394 if (!opening && found != NULL)
1396 found->fd_flags = FD_CLOSED;
1397 done |= DONE_ACTION;
1399 wp->w_fold_manual = TRUE;
1400 if (done & DONE_ACTION)
1401 changed_window_setting_win(wp);
1402 done |= DONE_FOLD;
1404 else if (donep == NULL && wp == curwin)
1405 EMSG(_(e_nofold));
1407 if (donep != NULL)
1408 *donep |= done;
1410 return next;
1413 /* foldOpenNested() {{{2 */
1415 * Open all nested folds in fold "fpr" recursively.
1417 static void
1418 foldOpenNested(fpr)
1419 fold_T *fpr;
1421 int i;
1422 fold_T *fp;
1424 fp = (fold_T *)fpr->fd_nested.ga_data;
1425 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1427 foldOpenNested(&fp[i]);
1428 fp[i].fd_flags = FD_OPEN;
1432 /* deleteFoldEntry() {{{2 */
1434 * Delete fold "idx" from growarray "gap".
1435 * When "recursive" is TRUE also delete all the folds contained in it.
1436 * When "recursive" is FALSE contained folds are moved one level up.
1438 static void
1439 deleteFoldEntry(gap, idx, recursive)
1440 garray_T *gap;
1441 int idx;
1442 int recursive;
1444 fold_T *fp;
1445 int i;
1446 long moved;
1447 fold_T *nfp;
1449 fp = (fold_T *)gap->ga_data + idx;
1450 if (recursive || fp->fd_nested.ga_len == 0)
1452 /* recursively delete the contained folds */
1453 deleteFoldRecurse(&fp->fd_nested);
1454 --gap->ga_len;
1455 if (idx < gap->ga_len)
1456 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1458 else
1460 /* move nested folds one level up, to overwrite the fold that is
1461 * deleted. */
1462 moved = fp->fd_nested.ga_len;
1463 if (ga_grow(gap, (int)(moved - 1)) == OK)
1465 /* adjust fd_top and fd_flags for the moved folds */
1466 nfp = (fold_T *)fp->fd_nested.ga_data;
1467 for (i = 0; i < moved; ++i)
1469 nfp[i].fd_top += fp->fd_top;
1470 if (fp->fd_flags == FD_LEVEL)
1471 nfp[i].fd_flags = FD_LEVEL;
1472 if (fp->fd_small == MAYBE)
1473 nfp[i].fd_small = MAYBE;
1476 /* move the existing folds down to make room */
1477 if (idx < gap->ga_len)
1478 mch_memmove(fp + moved, fp + 1,
1479 sizeof(fold_T) * (gap->ga_len - idx));
1480 /* move the contained folds one level up */
1481 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1482 vim_free(nfp);
1483 gap->ga_len += moved - 1;
1488 /* deleteFoldRecurse() {{{2 */
1490 * Delete nested folds in a fold.
1492 void
1493 deleteFoldRecurse(gap)
1494 garray_T *gap;
1496 int i;
1498 for (i = 0; i < gap->ga_len; ++i)
1499 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1500 ga_clear(gap);
1503 /* foldMarkAdjust() {{{2 */
1505 * Update line numbers of folds for inserted/deleted lines.
1507 void
1508 foldMarkAdjust(wp, line1, line2, amount, amount_after)
1509 win_T *wp;
1510 linenr_T line1;
1511 linenr_T line2;
1512 long amount;
1513 long amount_after;
1515 /* If deleting marks from line1 to line2, but not deleting all those
1516 * lines, set line2 so that only deleted lines have their folds removed. */
1517 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1518 line2 = line1 - amount_after - 1;
1519 /* If appending a line in Insert mode, it should be included in the fold
1520 * just above the line. */
1521 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1522 --line1;
1523 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1526 /* foldMarkAdjustRecurse() {{{2 */
1527 static void
1528 foldMarkAdjustRecurse(gap, line1, line2, amount, amount_after)
1529 garray_T *gap;
1530 linenr_T line1;
1531 linenr_T line2;
1532 long amount;
1533 long amount_after;
1535 fold_T *fp;
1536 int i;
1537 linenr_T last;
1538 linenr_T top;
1540 /* In Insert mode an inserted line at the top of a fold is considered part
1541 * of the fold, otherwise it isn't. */
1542 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1543 top = line1 + 1;
1544 else
1545 top = line1;
1547 /* Find the fold containing or just below "line1". */
1548 (void)foldFind(gap, line1, &fp);
1551 * Adjust all folds below "line1" that are affected.
1553 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1556 * Check for these situations:
1557 * 1 2 3
1558 * 1 2 3
1559 * line1 2 3 4 5
1560 * 2 3 4 5
1561 * 2 3 4 5
1562 * line2 2 3 4 5
1563 * 3 5 6
1564 * 3 5 6
1567 last = fp->fd_top + fp->fd_len - 1; /* last line of fold */
1569 /* 1. fold completely above line1: nothing to do */
1570 if (last < line1)
1571 continue;
1573 /* 6. fold below line2: only adjust for amount_after */
1574 if (fp->fd_top > line2)
1576 if (amount_after == 0)
1577 break;
1578 fp->fd_top += amount_after;
1580 else
1582 if (fp->fd_top >= top && last <= line2)
1584 /* 4. fold completely contained in range */
1585 if (amount == MAXLNUM)
1587 /* Deleting lines: delete the fold completely */
1588 deleteFoldEntry(gap, i, TRUE);
1589 --i; /* adjust index for deletion */
1590 --fp;
1592 else
1593 fp->fd_top += amount;
1595 else
1597 /* 2, 3, or 5: need to correct nested folds too */
1598 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1599 line2 - fp->fd_top, amount, amount_after);
1600 if (fp->fd_top < top)
1602 if (last <= line2)
1604 /* 2. fold contains line1, line2 is below fold */
1605 if (amount == MAXLNUM)
1606 fp->fd_len = line1 - fp->fd_top;
1607 else
1608 fp->fd_len += amount;
1610 else
1612 /* 3. fold contains line1 and line2 */
1613 fp->fd_len += amount_after;
1616 else
1618 /* 5. fold is below line1 and contains line2 */
1619 if (amount == MAXLNUM)
1621 fp->fd_len -= line2 - fp->fd_top + 1;
1622 fp->fd_top = line1;
1624 else
1626 fp->fd_len += amount_after - amount;
1627 fp->fd_top += amount;
1635 /* getDeepestNesting() {{{2 */
1637 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1638 * current window open.
1641 getDeepestNesting()
1643 checkupdate(curwin);
1644 return getDeepestNestingRecurse(&curwin->w_folds);
1647 static int
1648 getDeepestNestingRecurse(gap)
1649 garray_T *gap;
1651 int i;
1652 int level;
1653 int maxlevel = 0;
1654 fold_T *fp;
1656 fp = (fold_T *)gap->ga_data;
1657 for (i = 0; i < gap->ga_len; ++i)
1659 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1660 if (level > maxlevel)
1661 maxlevel = level;
1664 return maxlevel;
1667 /* check_closed() {{{2 */
1669 * Check if a fold is closed and update the info needed to check nested folds.
1671 static int
1672 check_closed(win, fp, use_levelp, level, maybe_smallp, lnum_off)
1673 win_T *win;
1674 fold_T *fp;
1675 int *use_levelp; /* TRUE: outer fold had FD_LEVEL */
1676 int level; /* folding depth */
1677 int *maybe_smallp; /* TRUE: outer this had fd_small == MAYBE */
1678 linenr_T lnum_off; /* line number offset for fp->fd_top */
1680 int closed = FALSE;
1682 /* Check if this fold is closed. If the flag is FD_LEVEL this
1683 * fold and all folds it contains depend on 'foldlevel'. */
1684 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1686 *use_levelp = TRUE;
1687 if (level >= win->w_p_fdl)
1688 closed = TRUE;
1690 else if (fp->fd_flags == FD_CLOSED)
1691 closed = TRUE;
1693 /* Small fold isn't closed anyway. */
1694 if (fp->fd_small == MAYBE)
1695 *maybe_smallp = TRUE;
1696 if (closed)
1698 if (*maybe_smallp)
1699 fp->fd_small = MAYBE;
1700 checkSmall(win, fp, lnum_off);
1701 if (fp->fd_small == TRUE)
1702 closed = FALSE;
1704 return closed;
1707 /* checkSmall() {{{2 */
1709 * Update fd_small field of fold "fp".
1711 static void
1712 checkSmall(wp, fp, lnum_off)
1713 win_T *wp;
1714 fold_T *fp;
1715 linenr_T lnum_off; /* offset for fp->fd_top */
1717 int count;
1718 int n;
1720 if (fp->fd_small == MAYBE)
1722 /* Mark any nested folds to maybe-small */
1723 setSmallMaybe(&fp->fd_nested);
1725 if (fp->fd_len > curwin->w_p_fml)
1726 fp->fd_small = FALSE;
1727 else
1729 count = 0;
1730 for (n = 0; n < fp->fd_len; ++n)
1732 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1733 if (count > curwin->w_p_fml)
1735 fp->fd_small = FALSE;
1736 return;
1739 fp->fd_small = TRUE;
1744 /* setSmallMaybe() {{{2 */
1746 * Set small flags in "gap" to MAYBE.
1748 static void
1749 setSmallMaybe(gap)
1750 garray_T *gap;
1752 int i;
1753 fold_T *fp;
1755 fp = (fold_T *)gap->ga_data;
1756 for (i = 0; i < gap->ga_len; ++i)
1757 fp[i].fd_small = MAYBE;
1760 /* foldCreateMarkers() {{{2 */
1762 * Create a fold from line "start" to line "end" (inclusive) in the current
1763 * window by adding markers.
1765 static void
1766 foldCreateMarkers(start, end)
1767 linenr_T start;
1768 linenr_T end;
1770 if (!curbuf->b_p_ma)
1772 EMSG(_(e_modifiable));
1773 return;
1775 parseMarker(curwin);
1777 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1778 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1780 /* Update both changes here, to avoid all folds after the start are
1781 * changed when the start marker is inserted and the end isn't. */
1782 changed_lines(start, (colnr_T)0, end, 0L);
1785 /* foldAddMarker() {{{2 */
1787 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1789 static void
1790 foldAddMarker(lnum, marker, markerlen)
1791 linenr_T lnum;
1792 char_u *marker;
1793 int markerlen;
1795 char_u *cms = curbuf->b_p_cms;
1796 char_u *line;
1797 int line_len;
1798 char_u *newline;
1799 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
1801 /* Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end */
1802 line = ml_get(lnum);
1803 line_len = (int)STRLEN(line);
1805 if (u_save(lnum - 1, lnum + 1) == OK)
1807 newline = alloc((unsigned)(line_len + markerlen + STRLEN(cms) + 1));
1808 if (newline == NULL)
1809 return;
1810 STRCPY(newline, line);
1811 if (p == NULL)
1812 vim_strncpy(newline + line_len, marker, markerlen);
1813 else
1815 STRCPY(newline + line_len, cms);
1816 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1817 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1820 ml_replace(lnum, newline, FALSE);
1824 /* deleteFoldMarkers() {{{2 */
1826 * Delete the markers for a fold, causing it to be deleted.
1828 static void
1829 deleteFoldMarkers(fp, recursive, lnum_off)
1830 fold_T *fp;
1831 int recursive;
1832 linenr_T lnum_off; /* offset for fp->fd_top */
1834 int i;
1836 if (recursive)
1837 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1838 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1839 lnum_off + fp->fd_top);
1840 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1841 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1842 foldendmarker, foldendmarkerlen);
1845 /* foldDelMarker() {{{2 */
1847 * Delete marker "marker[markerlen]" at the end of line "lnum".
1848 * Delete 'commentstring' if it matches.
1849 * If the marker is not found, there is no error message. Could a missing
1850 * close-marker.
1852 static void
1853 foldDelMarker(lnum, marker, markerlen)
1854 linenr_T lnum;
1855 char_u *marker;
1856 int markerlen;
1858 char_u *line;
1859 char_u *newline;
1860 char_u *p;
1861 int len;
1862 char_u *cms = curbuf->b_p_cms;
1863 char_u *cms2;
1865 line = ml_get(lnum);
1866 for (p = line; *p != NUL; ++p)
1867 if (STRNCMP(p, marker, markerlen) == 0)
1869 /* Found the marker, include a digit if it's there. */
1870 len = markerlen;
1871 if (VIM_ISDIGIT(p[len]))
1872 ++len;
1873 if (*cms != NUL)
1875 /* Also delete 'commentstring' if it matches. */
1876 cms2 = (char_u *)strstr((char *)cms, "%s");
1877 if (p - line >= cms2 - cms
1878 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1879 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1881 p -= cms2 - cms;
1882 len += (int)STRLEN(cms) - 2;
1885 if (u_save(lnum - 1, lnum + 1) == OK)
1887 /* Make new line: text-before-marker + text-after-marker */
1888 newline = alloc((unsigned)(STRLEN(line) - len + 1));
1889 if (newline != NULL)
1891 STRNCPY(newline, line, p - line);
1892 STRCPY(newline + (p - line), p + len);
1893 ml_replace(lnum, newline, FALSE);
1896 break;
1900 /* get_foldtext() {{{2 */
1902 * Return the text for a closed fold at line "lnum", with last line "lnume".
1903 * When 'foldtext' isn't set puts the result in "buf[51]". Otherwise the
1904 * result is in allocated memory.
1906 char_u *
1907 get_foldtext(wp, lnum, lnume, foldinfo, buf)
1908 win_T *wp;
1909 linenr_T lnum, lnume;
1910 foldinfo_T *foldinfo;
1911 char_u *buf;
1913 char_u *text = NULL;
1915 #ifdef FEAT_EVAL
1916 if (*wp->w_p_fdt != NUL)
1918 char_u dashes[51];
1919 win_T *save_curwin;
1920 int level;
1921 char_u *p;
1923 /* Set "v:foldstart" and "v:foldend". */
1924 set_vim_var_nr(VV_FOLDSTART, lnum);
1925 set_vim_var_nr(VV_FOLDEND, lnume);
1927 /* Set "v:folddashes" to a string of "level" dashes. */
1928 /* Set "v:foldlevel" to "level". */
1929 level = foldinfo->fi_level;
1930 if (level > 50)
1931 level = 50;
1932 vim_memset(dashes, '-', (size_t)level);
1933 dashes[level] = NUL;
1934 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1935 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
1936 save_curwin = curwin;
1937 curwin = wp;
1938 curbuf = wp->w_buffer;
1940 ++emsg_off;
1941 text = eval_to_string_safe(wp->w_p_fdt, NULL,
1942 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
1943 --emsg_off;
1945 curwin = save_curwin;
1946 curbuf = curwin->w_buffer;
1947 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1949 if (text != NULL)
1951 /* Replace unprintable characters, if there are any. But
1952 * replace a TAB with a space. */
1953 for (p = text; *p != NUL; ++p)
1955 # ifdef FEAT_MBYTE
1956 int len;
1958 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
1960 if (!vim_isprintc((*mb_ptr2char)(p)))
1961 break;
1962 p += len - 1;
1964 else
1965 # endif
1966 if (*p == TAB)
1967 *p = ' ';
1968 else if (ptr2cells(p) > 1)
1969 break;
1971 if (*p != NUL)
1973 p = transstr(text);
1974 vim_free(text);
1975 text = p;
1979 if (text == NULL)
1980 #endif
1982 sprintf((char *)buf, _("+--%3ld lines folded "),
1983 (long)(lnume - lnum + 1));
1984 text = buf;
1986 return text;
1989 /* foldtext_cleanup() {{{2 */
1991 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
1993 void
1994 foldtext_cleanup(str)
1995 char_u *str;
1997 char_u *cms_start; /* first part or the whole comment */
1998 int cms_slen = 0; /* length of cms_start */
1999 char_u *cms_end; /* last part of the comment or NULL */
2000 int cms_elen = 0; /* length of cms_end */
2001 char_u *s;
2002 char_u *p;
2003 int len;
2004 int did1 = FALSE;
2005 int did2 = FALSE;
2007 /* Ignore leading and trailing white space in 'commentstring'. */
2008 cms_start = skipwhite(curbuf->b_p_cms);
2009 cms_slen = (int)STRLEN(cms_start);
2010 while (cms_slen > 0 && vim_iswhite(cms_start[cms_slen - 1]))
2011 --cms_slen;
2013 /* locate "%s" in 'commentstring', use the part before and after it. */
2014 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2015 if (cms_end != NULL)
2017 cms_elen = cms_slen - (int)(cms_end - cms_start);
2018 cms_slen = (int)(cms_end - cms_start);
2020 /* exclude white space before "%s" */
2021 while (cms_slen > 0 && vim_iswhite(cms_start[cms_slen - 1]))
2022 --cms_slen;
2024 /* skip "%s" and white space after it */
2025 s = skipwhite(cms_end + 2);
2026 cms_elen -= (int)(s - cms_end);
2027 cms_end = s;
2029 parseMarker(curwin);
2031 for (s = str; *s != NUL; )
2033 len = 0;
2034 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
2035 len = foldstartmarkerlen;
2036 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
2037 len = foldendmarkerlen;
2038 if (len > 0)
2040 if (VIM_ISDIGIT(s[len]))
2041 ++len;
2043 /* May remove 'commentstring' start. Useful when it's a double
2044 * quote and we already removed a double quote. */
2045 for (p = s; p > str && vim_iswhite(p[-1]); --p)
2047 if (p >= str + cms_slen
2048 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2050 len += (int)(s - p) + cms_slen;
2051 s = p - cms_slen;
2054 else if (cms_end != NULL)
2056 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
2058 len = cms_slen;
2059 did1 = TRUE;
2061 else if (!did2 && cms_elen > 0
2062 && STRNCMP(s, cms_end, cms_elen) == 0)
2064 len = cms_elen;
2065 did2 = TRUE;
2068 if (len != 0)
2070 while (vim_iswhite(s[len]))
2071 ++len;
2072 mch_memmove(s, s + len, STRLEN(s + len) + 1);
2074 else
2076 mb_ptr_adv(s);
2081 /* Folding by indent, expr, marker and syntax. {{{1 */
2082 /* Define "fline_T", passed to get fold level for a line. {{{2 */
2083 typedef struct
2085 win_T *wp; /* window */
2086 linenr_T lnum; /* current line number */
2087 linenr_T off; /* offset between lnum and real line number */
2088 linenr_T lnum_save; /* line nr used by foldUpdateIEMSRecurse() */
2089 int lvl; /* current level (-1 for undefined) */
2090 int lvl_next; /* level used for next line */
2091 int start; /* number of folds that are forced to start at
2092 this line. */
2093 int end; /* level of fold that is forced to end below
2094 this line */
2095 int had_end; /* level of fold that is forced to end above
2096 this line (copy of "end" of prev. line) */
2097 } fline_T;
2099 /* Flag is set when redrawing is needed. */
2100 static int fold_changed;
2102 /* Function declarations. {{{2 */
2103 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));
2104 static int foldInsert __ARGS((garray_T *gap, int i));
2105 static void foldSplit __ARGS((garray_T *gap, int i, linenr_T top, linenr_T bot));
2106 static void foldRemove __ARGS((garray_T *gap, linenr_T top, linenr_T bot));
2107 static void foldMerge __ARGS((fold_T *fp1, garray_T *gap, fold_T *fp2));
2108 static void foldlevelIndent __ARGS((fline_T *flp));
2109 #ifdef FEAT_DIFF
2110 static void foldlevelDiff __ARGS((fline_T *flp));
2111 #endif
2112 static void foldlevelExpr __ARGS((fline_T *flp));
2113 static void foldlevelMarker __ARGS((fline_T *flp));
2114 static void foldlevelSyntax __ARGS((fline_T *flp));
2116 /* foldUpdateIEMS() {{{2 */
2118 * Update the folding for window "wp", at least from lines "top" to "bot".
2119 * Return TRUE if any folds did change.
2121 static void
2122 foldUpdateIEMS(wp, top, bot)
2123 win_T *wp;
2124 linenr_T top;
2125 linenr_T bot;
2127 linenr_T start;
2128 linenr_T end;
2129 fline_T fline;
2130 void (*getlevel)__ARGS((fline_T *));
2131 int level;
2132 fold_T *fp;
2134 /* Avoid problems when being called recursively. */
2135 if (invalid_top != (linenr_T)0)
2136 return;
2138 if (wp->w_foldinvalid)
2140 /* Need to update all folds. */
2141 top = 1;
2142 bot = wp->w_buffer->b_ml.ml_line_count;
2143 wp->w_foldinvalid = FALSE;
2145 /* Mark all folds a maybe-small. */
2146 setSmallMaybe(&wp->w_folds);
2149 #ifdef FEAT_DIFF
2150 /* add the context for "diff" folding */
2151 if (foldmethodIsDiff(wp))
2153 if (top > diff_context)
2154 top -= diff_context;
2155 else
2156 top = 1;
2157 bot += diff_context;
2159 #endif
2161 /* When deleting lines at the end of the buffer "top" can be past the end
2162 * of the buffer. */
2163 if (top > wp->w_buffer->b_ml.ml_line_count)
2164 top = wp->w_buffer->b_ml.ml_line_count;
2166 fold_changed = FALSE;
2167 fline.wp = wp;
2168 fline.off = 0;
2169 fline.lvl = 0;
2170 fline.lvl_next = -1;
2171 fline.start = 0;
2172 fline.end = MAX_LEVEL + 1;
2173 fline.had_end = MAX_LEVEL + 1;
2175 invalid_top = top;
2176 invalid_bot = bot;
2178 if (foldmethodIsMarker(wp))
2180 getlevel = foldlevelMarker;
2182 /* Init marker variables to speed up foldlevelMarker(). */
2183 parseMarker(wp);
2185 /* Need to get the level of the line above top, it is used if there is
2186 * no marker at the top. */
2187 if (top > 1)
2189 /* Get the fold level at top - 1. */
2190 level = foldLevelWin(wp, top - 1);
2192 /* The fold may end just above the top, check for that. */
2193 fline.lnum = top - 1;
2194 fline.lvl = level;
2195 getlevel(&fline);
2197 /* If a fold started here, we already had the level, if it stops
2198 * here, we need to use lvl_next. Could also start and end a fold
2199 * in the same line. */
2200 if (fline.lvl > level)
2201 fline.lvl = level - (fline.lvl - fline.lvl_next);
2202 else
2203 fline.lvl = fline.lvl_next;
2205 fline.lnum = top;
2206 getlevel(&fline);
2208 else
2210 fline.lnum = top;
2211 if (foldmethodIsExpr(wp))
2213 getlevel = foldlevelExpr;
2214 /* start one line back, because a "<1" may indicate the end of a
2215 * fold in the topline */
2216 if (top > 1)
2217 --fline.lnum;
2219 else if (foldmethodIsSyntax(wp))
2220 getlevel = foldlevelSyntax;
2221 #ifdef FEAT_DIFF
2222 else if (foldmethodIsDiff(wp))
2223 getlevel = foldlevelDiff;
2224 #endif
2225 else
2226 getlevel = foldlevelIndent;
2228 /* Backup to a line for which the fold level is defined. Since it's
2229 * always defined for line one, we will stop there. */
2230 fline.lvl = -1;
2231 for ( ; !got_int; --fline.lnum)
2233 /* Reset lvl_next each time, because it will be set to a value for
2234 * the next line, but we search backwards here. */
2235 fline.lvl_next = -1;
2236 getlevel(&fline);
2237 if (fline.lvl >= 0)
2238 break;
2242 start = fline.lnum;
2243 end = bot;
2244 /* Do at least one line. */
2245 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2246 end = start;
2247 while (!got_int)
2249 /* Always stop at the end of the file ("end" can be past the end of
2250 * the file). */
2251 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2252 break;
2253 if (fline.lnum > end)
2255 /* For "marker", "expr" and "syntax" methods: If a change caused
2256 * a fold to be removed, we need to continue at least until where
2257 * it ended. */
2258 if (getlevel != foldlevelMarker
2259 && getlevel != foldlevelSyntax
2260 && getlevel != foldlevelExpr)
2261 break;
2262 if ((start <= end
2263 && foldFind(&wp->w_folds, end, &fp)
2264 && fp->fd_top + fp->fd_len - 1 > end)
2265 || (fline.lvl == 0
2266 && foldFind(&wp->w_folds, fline.lnum, &fp)
2267 && fp->fd_top < fline.lnum))
2268 end = fp->fd_top + fp->fd_len - 1;
2269 else if (getlevel == foldlevelSyntax
2270 && foldLevelWin(wp, fline.lnum) != fline.lvl)
2271 /* For "syntax" method: Compare the foldlevel that the syntax
2272 * tells us to the foldlevel from the existing folds. If they
2273 * don't match continue updating folds. */
2274 end = fline.lnum;
2275 else
2276 break;
2279 /* A level 1 fold starts at a line with foldlevel > 0. */
2280 if (fline.lvl > 0)
2282 invalid_top = fline.lnum;
2283 invalid_bot = end;
2284 end = foldUpdateIEMSRecurse(&wp->w_folds,
2285 1, start, &fline, getlevel, end, FD_LEVEL);
2286 start = fline.lnum;
2288 else
2290 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2291 break;
2292 ++fline.lnum;
2293 fline.lvl = fline.lvl_next;
2294 getlevel(&fline);
2298 /* There can't be any folds from start until end now. */
2299 foldRemove(&wp->w_folds, start, end);
2301 /* If some fold changed, need to redraw and position cursor. */
2302 if (fold_changed && wp->w_p_fen)
2303 changed_window_setting();
2305 /* If we updated folds past "bot", need to redraw more lines. Don't do
2306 * this in other situations, the changed lines will be redrawn anyway and
2307 * this method can cause the whole window to be updated. */
2308 if (end != bot)
2310 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2311 wp->w_redraw_top = top;
2312 if (wp->w_redraw_bot < end)
2313 wp->w_redraw_bot = end;
2316 invalid_top = (linenr_T)0;
2319 /* foldUpdateIEMSRecurse() {{{2 */
2321 * Update a fold that starts at "flp->lnum". At this line there is always a
2322 * valid foldlevel, and its level >= "level".
2323 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2324 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2325 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2326 * the marker method and a text change made following folds to change.
2327 * When returning, "flp->lnum_save" is the line number that was used to get
2328 * the level when the level at "flp->lnum" is invalid.
2329 * Remove any folds from "startlnum" up to here at this level.
2330 * Recursively update nested folds.
2331 * Below line "bot" there are no changes in the text.
2332 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2333 * outer fold.
2334 * "flp->off" is the offset to the real line number in the buffer.
2336 * All this would be a lot simpler if all folds in the range would be deleted
2337 * and then created again. But we would loose all information about the
2338 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2340 * Returns bot, which may have been increased for lines that also need to be
2341 * updated as a result of a detected change in the fold.
2343 static linenr_T
2344 foldUpdateIEMSRecurse(gap, level, startlnum, flp, getlevel, bot, topflags)
2345 garray_T *gap;
2346 int level;
2347 linenr_T startlnum;
2348 fline_T *flp;
2349 void (*getlevel)__ARGS((fline_T *));
2350 linenr_T bot;
2351 int topflags; /* flags used by containing fold */
2353 linenr_T ll;
2354 fold_T *fp = NULL;
2355 fold_T *fp2;
2356 int lvl = level;
2357 linenr_T startlnum2 = startlnum;
2358 linenr_T firstlnum = flp->lnum; /* first lnum we got */
2359 int i;
2360 int finish = FALSE;
2361 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2362 int concat;
2365 * If using the marker method, the start line is not the start of a fold
2366 * at the level we're dealing with and the level is non-zero, we must use
2367 * the previous fold. But ignore a fold that starts at or below
2368 * startlnum, it must be deleted.
2370 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2371 && flp->lvl > 0)
2373 foldFind(gap, startlnum - 1, &fp);
2374 if (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2375 || fp->fd_top >= startlnum)
2376 fp = NULL;
2380 * Loop over all lines in this fold, or until "bot" is hit.
2381 * Handle nested folds inside of this fold.
2382 * "flp->lnum" is the current line. When finding the end of the fold, it
2383 * is just below the end of the fold.
2384 * "*flp" contains the level of the line "flp->lnum" or a following one if
2385 * there are lines with an invalid fold level. "flp->lnum_save" is the
2386 * line number that was used to get the fold level (below "flp->lnum" when
2387 * it has an invalid fold level). When called the fold level is always
2388 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2390 flp->lnum_save = flp->lnum;
2391 while (!got_int)
2393 /* Updating folds can be slow, check for CTRL-C. */
2394 line_breakcheck();
2396 /* Set "lvl" to the level of line "flp->lnum". When flp->start is set
2397 * and after the first line of the fold, set the level to zero to
2398 * force the fold to end. Do the same when had_end is set: Previous
2399 * line was marked as end of a fold. */
2400 lvl = flp->lvl;
2401 if (lvl > MAX_LEVEL)
2402 lvl = MAX_LEVEL;
2403 if (flp->lnum > firstlnum
2404 && (level > lvl - flp->start || level >= flp->had_end))
2405 lvl = 0;
2407 if (flp->lnum > bot && !finish && fp != NULL)
2409 /* For "marker" and "syntax" methods:
2410 * - If a change caused a nested fold to be removed, we need to
2411 * delete it and continue at least until where it ended.
2412 * - If a change caused a nested fold to be created, or this fold
2413 * to continue below its original end, need to finish this fold.
2415 if (getlevel != foldlevelMarker
2416 && getlevel != foldlevelExpr
2417 && getlevel != foldlevelSyntax)
2418 break;
2419 i = 0;
2420 fp2 = fp;
2421 if (lvl >= level)
2423 /* Compute how deep the folds currently are, if it's deeper
2424 * than "lvl" then some must be deleted, need to update
2425 * at least one nested fold. */
2426 ll = flp->lnum - fp->fd_top;
2427 while (foldFind(&fp2->fd_nested, ll, &fp2))
2429 ++i;
2430 ll -= fp2->fd_top;
2433 if (lvl < level + i)
2435 foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
2436 if (fp2 != NULL)
2437 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2439 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2440 finish = TRUE;
2441 else
2442 break;
2445 /* At the start of the first nested fold and at the end of the current
2446 * fold: check if existing folds at this level, before the current
2447 * one, need to be deleted or truncated. */
2448 if (fp == NULL
2449 && (lvl != level
2450 || flp->lnum_save >= bot
2451 || flp->start != 0
2452 || flp->had_end <= MAX_LEVEL
2453 || flp->lnum == linecount))
2456 * Remove or update folds that have lines between startlnum and
2457 * firstlnum.
2459 while (!got_int)
2461 /* set concat to 1 if it's allowed to concatenated this fold
2462 * with a previous one that touches it. */
2463 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2464 concat = 0;
2465 else
2466 concat = 1;
2468 /* Find an existing fold to re-use. Preferably one that
2469 * includes startlnum, otherwise one that ends just before
2470 * startlnum or starts after it. */
2471 if (foldFind(gap, startlnum, &fp)
2472 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2473 && fp->fd_top <= firstlnum)
2474 || foldFind(gap, firstlnum - concat, &fp)
2475 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2476 && ((lvl < level && fp->fd_top < flp->lnum)
2477 || (lvl >= level
2478 && fp->fd_top <= flp->lnum_save))))
2480 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2482 /* Use existing fold for the new fold. If it starts
2483 * before where we started looking, extend it. If it
2484 * starts at another line, update nested folds to keep
2485 * their position, compensating for the new fd_top. */
2486 if (fp->fd_top >= startlnum && fp->fd_top != firstlnum)
2488 if (fp->fd_top > firstlnum)
2489 /* like lines are inserted */
2490 foldMarkAdjustRecurse(&fp->fd_nested,
2491 (linenr_T)0, (linenr_T)MAXLNUM,
2492 (long)(fp->fd_top - firstlnum), 0L);
2493 else
2494 /* like lines are deleted */
2495 foldMarkAdjustRecurse(&fp->fd_nested,
2496 (linenr_T)0,
2497 (long)(firstlnum - fp->fd_top - 1),
2498 (linenr_T)MAXLNUM,
2499 (long)(fp->fd_top - firstlnum));
2500 fp->fd_len += fp->fd_top - firstlnum;
2501 fp->fd_top = firstlnum;
2502 fold_changed = TRUE;
2504 else if (flp->start != 0 && lvl == level
2505 && fp->fd_top != firstlnum)
2507 /* Existing fold that includes startlnum must stop
2508 * if we find the start of a new fold at the same
2509 * level. Split it. Delete contained folds at
2510 * this point to split them too. */
2511 foldRemove(&fp->fd_nested, flp->lnum - fp->fd_top,
2512 flp->lnum - fp->fd_top);
2513 i = (int)(fp - (fold_T *)gap->ga_data);
2514 foldSplit(gap, i, flp->lnum, flp->lnum - 1);
2515 fp = (fold_T *)gap->ga_data + i + 1;
2516 /* If using the "marker" or "syntax" method, we
2517 * need to continue until the end of the fold is
2518 * found. */
2519 if (getlevel == foldlevelMarker
2520 || getlevel == foldlevelExpr
2521 || getlevel == foldlevelSyntax)
2522 finish = TRUE;
2524 break;
2526 if (fp->fd_top >= startlnum)
2528 /* A fold that starts at or after startlnum and stops
2529 * before the new fold must be deleted. Continue
2530 * looking for the next one. */
2531 deleteFoldEntry(gap,
2532 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2534 else
2536 /* A fold has some lines above startlnum, truncate it
2537 * to stop just above startlnum. */
2538 fp->fd_len = startlnum - fp->fd_top;
2539 foldMarkAdjustRecurse(&fp->fd_nested,
2540 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2541 (linenr_T)MAXLNUM, 0L);
2542 fold_changed = TRUE;
2545 else
2547 /* Insert new fold. Careful: ga_data may be NULL and it
2548 * may change! */
2549 i = (int)(fp - (fold_T *)gap->ga_data);
2550 if (foldInsert(gap, i) != OK)
2551 return bot;
2552 fp = (fold_T *)gap->ga_data + i;
2553 /* The new fold continues until bot, unless we find the
2554 * end earlier. */
2555 fp->fd_top = firstlnum;
2556 fp->fd_len = bot - firstlnum + 1;
2557 /* When the containing fold is open, the new fold is open.
2558 * The new fold is closed if the fold above it is closed.
2559 * The first fold depends on the containing fold. */
2560 if (topflags == FD_OPEN)
2562 flp->wp->w_fold_manual = TRUE;
2563 fp->fd_flags = FD_OPEN;
2565 else if (i <= 0)
2567 fp->fd_flags = topflags;
2568 if (topflags != FD_LEVEL)
2569 flp->wp->w_fold_manual = TRUE;
2571 else
2572 fp->fd_flags = (fp - 1)->fd_flags;
2573 fp->fd_small = MAYBE;
2574 /* If using the "marker", "expr" or "syntax" method, we
2575 * need to continue until the end of the fold is found. */
2576 if (getlevel == foldlevelMarker
2577 || getlevel == foldlevelExpr
2578 || getlevel == foldlevelSyntax)
2579 finish = TRUE;
2580 fold_changed = TRUE;
2581 break;
2586 if (lvl < level || flp->lnum > linecount)
2589 * Found a line with a lower foldlevel, this fold ends just above
2590 * "flp->lnum".
2592 break;
2596 * The fold includes the line "flp->lnum" and "flp->lnum_save".
2597 * Check "fp" for safety.
2599 if (lvl > level && fp != NULL)
2602 * There is a nested fold, handle it recursively.
2604 /* At least do one line (can happen when finish is TRUE). */
2605 if (bot < flp->lnum)
2606 bot = flp->lnum;
2608 /* Line numbers in the nested fold are relative to the start of
2609 * this fold. */
2610 flp->lnum = flp->lnum_save - fp->fd_top;
2611 flp->off += fp->fd_top;
2612 i = (int)(fp - (fold_T *)gap->ga_data);
2613 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2614 startlnum2 - fp->fd_top, flp, getlevel,
2615 bot - fp->fd_top, fp->fd_flags);
2616 fp = (fold_T *)gap->ga_data + i;
2617 flp->lnum += fp->fd_top;
2618 flp->lnum_save += fp->fd_top;
2619 flp->off -= fp->fd_top;
2620 bot += fp->fd_top;
2621 startlnum2 = flp->lnum;
2623 /* This fold may end at the same line, don't incr. flp->lnum. */
2625 else
2628 * Get the level of the next line, then continue the loop to check
2629 * if it ends there.
2630 * Skip over undefined lines, to find the foldlevel after it.
2631 * For the last line in the file the foldlevel is always valid.
2633 flp->lnum = flp->lnum_save;
2634 ll = flp->lnum + 1;
2635 while (!got_int)
2637 /* Make the previous level available to foldlevel(). */
2638 prev_lnum = flp->lnum;
2639 prev_lnum_lvl = flp->lvl;
2641 if (++flp->lnum > linecount)
2642 break;
2643 flp->lvl = flp->lvl_next;
2644 getlevel(flp);
2645 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2646 break;
2648 prev_lnum = 0;
2649 if (flp->lnum > linecount)
2650 break;
2652 /* leave flp->lnum_save to lnum of the line that was used to get
2653 * the level, flp->lnum to the lnum of the next line. */
2654 flp->lnum_save = flp->lnum;
2655 flp->lnum = ll;
2659 if (fp == NULL) /* only happens when got_int is set */
2660 return bot;
2663 * Get here when:
2664 * lvl < level: the folds ends just above "flp->lnum"
2665 * lvl >= level: fold continues below "bot"
2668 /* Current fold at least extends until lnum. */
2669 if (fp->fd_len < flp->lnum - fp->fd_top)
2671 fp->fd_len = flp->lnum - fp->fd_top;
2672 fold_changed = TRUE;
2675 /* Delete contained folds from the end of the last one found until where
2676 * we stopped looking. */
2677 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2678 flp->lnum - 1 - fp->fd_top);
2680 if (lvl < level)
2682 /* End of fold found, update the length when it got shorter. */
2683 if (fp->fd_len != flp->lnum - fp->fd_top)
2685 if (fp->fd_top + fp->fd_len > bot + 1)
2687 /* fold coninued below bot */
2688 if (getlevel == foldlevelMarker
2689 || getlevel == foldlevelExpr
2690 || getlevel == foldlevelSyntax)
2692 /* marker method: truncate the fold and make sure the
2693 * previously included lines are processed again */
2694 bot = fp->fd_top + fp->fd_len - 1;
2695 fp->fd_len = flp->lnum - fp->fd_top;
2697 else
2699 /* indent or expr method: split fold to create a new one
2700 * below bot */
2701 i = (int)(fp - (fold_T *)gap->ga_data);
2702 foldSplit(gap, i, flp->lnum, bot);
2703 fp = (fold_T *)gap->ga_data + i;
2706 else
2707 fp->fd_len = flp->lnum - fp->fd_top;
2708 fold_changed = TRUE;
2712 /* delete following folds that end before the current line */
2713 for (;;)
2715 fp2 = fp + 1;
2716 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2717 || fp2->fd_top > flp->lnum)
2718 break;
2719 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2721 if (fp2->fd_top < flp->lnum)
2723 /* Make fold that includes lnum start at lnum. */
2724 foldMarkAdjustRecurse(&fp2->fd_nested,
2725 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2726 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2727 fp2->fd_len -= flp->lnum - fp2->fd_top;
2728 fp2->fd_top = flp->lnum;
2729 fold_changed = TRUE;
2732 if (lvl >= level)
2734 /* merge new fold with existing fold that follows */
2735 foldMerge(fp, gap, fp2);
2737 break;
2739 fold_changed = TRUE;
2740 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2743 /* Need to redraw the lines we inspected, which might be further down than
2744 * was asked for. */
2745 if (bot < flp->lnum - 1)
2746 bot = flp->lnum - 1;
2748 return bot;
2751 /* foldInsert() {{{2 */
2753 * Insert a new fold in "gap" at position "i".
2754 * Returns OK for success, FAIL for failure.
2756 static int
2757 foldInsert(gap, i)
2758 garray_T *gap;
2759 int i;
2761 fold_T *fp;
2763 if (ga_grow(gap, 1) != OK)
2764 return FAIL;
2765 fp = (fold_T *)gap->ga_data + i;
2766 if (i < gap->ga_len)
2767 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2768 ++gap->ga_len;
2769 ga_init2(&fp->fd_nested, (int)sizeof(fold_T), 10);
2770 return OK;
2773 /* foldSplit() {{{2 */
2775 * Split the "i"th fold in "gap", which starts before "top" and ends below
2776 * "bot" in two pieces, one ending above "top" and the other starting below
2777 * "bot".
2778 * The caller must first have taken care of any nested folds from "top" to
2779 * "bot"!
2781 static void
2782 foldSplit(gap, i, top, bot)
2783 garray_T *gap;
2784 int i;
2785 linenr_T top;
2786 linenr_T bot;
2788 fold_T *fp;
2789 fold_T *fp2;
2790 garray_T *gap1;
2791 garray_T *gap2;
2792 int idx;
2793 int len;
2795 /* The fold continues below bot, need to split it. */
2796 if (foldInsert(gap, i + 1) == FAIL)
2797 return;
2798 fp = (fold_T *)gap->ga_data + i;
2799 fp[1].fd_top = bot + 1;
2800 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2801 fp[1].fd_flags = fp->fd_flags;
2803 /* Move nested folds below bot to new fold. There can't be
2804 * any between top and bot, they have been removed by the caller. */
2805 gap1 = &fp->fd_nested;
2806 gap2 = &fp[1].fd_nested;
2807 (void)(foldFind(gap1, bot + 1 - fp->fd_top, &fp2));
2808 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2809 if (len > 0 && ga_grow(gap2, len) == OK)
2811 for (idx = 0; idx < len; ++idx)
2813 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2814 ((fold_T *)gap2->ga_data)[idx].fd_top
2815 -= fp[1].fd_top - fp->fd_top;
2817 gap2->ga_len = len;
2818 gap1->ga_len -= len;
2820 fp->fd_len = top - fp->fd_top;
2821 fold_changed = TRUE;
2824 /* foldRemove() {{{2 */
2826 * Remove folds within the range "top" to and including "bot".
2827 * Check for these situations:
2828 * 1 2 3
2829 * 1 2 3
2830 * top 2 3 4 5
2831 * 2 3 4 5
2832 * bot 2 3 4 5
2833 * 3 5 6
2834 * 3 5 6
2836 * 1: not changed
2837 * 2: trunate to stop above "top"
2838 * 3: split in two parts, one stops above "top", other starts below "bot".
2839 * 4: deleted
2840 * 5: made to start below "bot".
2841 * 6: not changed
2843 static void
2844 foldRemove(gap, top, bot)
2845 garray_T *gap;
2846 linenr_T top;
2847 linenr_T bot;
2849 fold_T *fp = NULL;
2851 if (bot < top)
2852 return; /* nothing to do */
2854 for (;;)
2856 /* Find fold that includes top or a following one. */
2857 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2859 /* 2: or 3: need to delete nested folds */
2860 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
2861 if (fp->fd_top + fp->fd_len > bot + 1)
2863 /* 3: need to split it. */
2864 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2866 else
2868 /* 2: truncate fold at "top". */
2869 fp->fd_len = top - fp->fd_top;
2871 fold_changed = TRUE;
2872 continue;
2874 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2875 || fp->fd_top > bot)
2877 /* 6: Found a fold below bot, can stop looking. */
2878 break;
2880 if (fp->fd_top >= top)
2882 /* Found an entry below top. */
2883 fold_changed = TRUE;
2884 if (fp->fd_top + fp->fd_len - 1 > bot)
2886 /* 5: Make fold that includes bot start below bot. */
2887 foldMarkAdjustRecurse(&fp->fd_nested,
2888 (linenr_T)0, (long)(bot - fp->fd_top),
2889 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2890 fp->fd_len -= bot - fp->fd_top + 1;
2891 fp->fd_top = bot + 1;
2892 break;
2895 /* 4: Delete completely contained fold. */
2896 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
2901 /* foldMerge() {{{2 */
2903 * Merge two adjecent folds (and the nested ones in them).
2904 * This only works correctly when the folds are really adjecent! Thus "fp1"
2905 * must end just above "fp2".
2906 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
2907 * Fold entry "fp2" in "gap" is deleted.
2909 static void
2910 foldMerge(fp1, gap, fp2)
2911 fold_T *fp1;
2912 garray_T *gap;
2913 fold_T *fp2;
2915 fold_T *fp3;
2916 fold_T *fp4;
2917 int idx;
2918 garray_T *gap1 = &fp1->fd_nested;
2919 garray_T *gap2 = &fp2->fd_nested;
2921 /* If the last nested fold in fp1 touches the first nested fold in fp2,
2922 * merge them recursively. */
2923 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
2924 foldMerge(fp3, gap2, fp4);
2926 /* Move nested folds in fp2 to the end of fp1. */
2927 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
2929 for (idx = 0; idx < gap2->ga_len; ++idx)
2931 ((fold_T *)gap1->ga_data)[gap1->ga_len]
2932 = ((fold_T *)gap2->ga_data)[idx];
2933 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
2934 ++gap1->ga_len;
2936 gap2->ga_len = 0;
2939 fp1->fd_len += fp2->fd_len;
2940 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2941 fold_changed = TRUE;
2944 /* foldlevelIndent() {{{2 */
2946 * Low level function to get the foldlevel for the "indent" method.
2947 * Doesn't use any caching.
2948 * Returns a level of -1 if the foldlevel depends on surrounding lines.
2950 static void
2951 foldlevelIndent(flp)
2952 fline_T *flp;
2954 char_u *s;
2955 buf_T *buf;
2956 linenr_T lnum = flp->lnum + flp->off;
2958 buf = flp->wp->w_buffer;
2959 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
2961 /* empty line or lines starting with a character in 'foldignore': level
2962 * depends on surrounding lines */
2963 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
2965 /* first and last line can't be undefined, use level 0 */
2966 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
2967 flp->lvl = 0;
2968 else
2969 flp->lvl = -1;
2971 else
2972 flp->lvl = get_indent_buf(buf, lnum) / buf->b_p_sw;
2973 if (flp->lvl > flp->wp->w_p_fdn)
2975 flp->lvl = flp->wp->w_p_fdn;
2976 if (flp->lvl < 0)
2977 flp->lvl = 0;
2981 /* foldlevelDiff() {{{2 */
2982 #ifdef FEAT_DIFF
2984 * Low level function to get the foldlevel for the "diff" method.
2985 * Doesn't use any caching.
2987 static void
2988 foldlevelDiff(flp)
2989 fline_T *flp;
2991 if (diff_infold(flp->wp, flp->lnum + flp->off))
2992 flp->lvl = 1;
2993 else
2994 flp->lvl = 0;
2996 #endif
2998 /* foldlevelExpr() {{{2 */
3000 * Low level function to get the foldlevel for the "expr" method.
3001 * Doesn't use any caching.
3002 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3004 static void
3005 foldlevelExpr(flp)
3006 fline_T *flp;
3008 #ifndef FEAT_EVAL
3009 flp->start = FALSE;
3010 flp->lvl = 0;
3011 #else
3012 win_T *win;
3013 int n;
3014 int c;
3015 linenr_T lnum = flp->lnum + flp->off;
3016 int save_keytyped;
3018 win = curwin;
3019 curwin = flp->wp;
3020 curbuf = flp->wp->w_buffer;
3021 set_vim_var_nr(VV_LNUM, lnum);
3023 flp->start = 0;
3024 flp->had_end = flp->end;
3025 flp->end = MAX_LEVEL + 1;
3026 if (lnum <= 1)
3027 flp->lvl = 0;
3029 /* KeyTyped may be reset to 0 when calling a function which invokes
3030 * do_cmdline(). To make 'foldopen' work correctly restore KeyTyped. */
3031 save_keytyped = KeyTyped;
3032 n = eval_foldexpr(flp->wp->w_p_fde, &c);
3033 KeyTyped = save_keytyped;
3035 switch (c)
3037 /* "a1", "a2", .. : add to the fold level */
3038 case 'a': if (flp->lvl >= 0)
3040 flp->lvl += n;
3041 flp->lvl_next = flp->lvl;
3043 flp->start = n;
3044 break;
3046 /* "s1", "s2", .. : subtract from the fold level */
3047 case 's': if (flp->lvl >= 0)
3049 if (n > flp->lvl)
3050 flp->lvl_next = 0;
3051 else
3052 flp->lvl_next = flp->lvl - n;
3053 flp->end = flp->lvl_next + 1;
3055 break;
3057 /* ">1", ">2", .. : start a fold with a certain level */
3058 case '>': flp->lvl = n;
3059 flp->lvl_next = n;
3060 flp->start = 1;
3061 break;
3063 /* "<1", "<2", .. : end a fold with a certain level */
3064 case '<': flp->lvl_next = n - 1;
3065 flp->end = n;
3066 break;
3068 /* "=": No change in level */
3069 case '=': flp->lvl_next = flp->lvl;
3070 break;
3072 /* "-1", "0", "1", ..: set fold level */
3073 default: if (n < 0)
3074 /* Use the current level for the next line, so that "a1"
3075 * will work there. */
3076 flp->lvl_next = flp->lvl;
3077 else
3078 flp->lvl_next = n;
3079 flp->lvl = n;
3080 break;
3083 /* If the level is unknown for the first or the last line in the file, use
3084 * level 0. */
3085 if (flp->lvl < 0)
3087 if (lnum <= 1)
3089 flp->lvl = 0;
3090 flp->lvl_next = 0;
3092 if (lnum == curbuf->b_ml.ml_line_count)
3093 flp->lvl_next = 0;
3096 curwin = win;
3097 curbuf = curwin->w_buffer;
3098 #endif
3101 /* parseMarker() {{{2 */
3103 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3104 * "foldendmarkerlen".
3105 * Relies on the option value to have been checked for correctness already.
3107 static void
3108 parseMarker(wp)
3109 win_T *wp;
3111 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3112 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3113 foldendmarkerlen = (int)STRLEN(foldendmarker);
3116 /* foldlevelMarker() {{{2 */
3118 * Low level function to get the foldlevel for the "marker" method.
3119 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3120 * set before calling this.
3121 * Requires that flp->lvl is set to the fold level of the previous line!
3122 * Careful: This means you can't call this function twice on the same line.
3123 * Doesn't use any caching.
3124 * Sets flp->start when a start marker was found.
3126 static void
3127 foldlevelMarker(flp)
3128 fline_T *flp;
3130 char_u *startmarker;
3131 int cstart;
3132 int cend;
3133 int start_lvl = flp->lvl;
3134 char_u *s;
3135 int n;
3137 /* cache a few values for speed */
3138 startmarker = flp->wp->w_p_fmr;
3139 cstart = *startmarker;
3140 ++startmarker;
3141 cend = *foldendmarker;
3143 /* Default: no start found, next level is same as current level */
3144 flp->start = 0;
3145 flp->lvl_next = flp->lvl;
3147 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3148 while (*s)
3150 if (*s == cstart
3151 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3153 /* found startmarker: set flp->lvl */
3154 s += foldstartmarkerlen;
3155 if (VIM_ISDIGIT(*s))
3157 n = atoi((char *)s);
3158 if (n > 0)
3160 flp->lvl = n;
3161 flp->lvl_next = n;
3162 if (n <= start_lvl)
3163 flp->start = 1;
3164 else
3165 flp->start = n - start_lvl;
3168 else
3170 ++flp->lvl;
3171 ++flp->lvl_next;
3172 ++flp->start;
3175 else if (*s == cend
3176 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3178 /* found endmarker: set flp->lvl_next */
3179 s += foldendmarkerlen;
3180 if (VIM_ISDIGIT(*s))
3182 n = atoi((char *)s);
3183 if (n > 0)
3185 flp->lvl = n;
3186 flp->lvl_next = n - 1;
3187 /* never start a fold with an end marker */
3188 if (flp->lvl_next > flp->lvl)
3189 flp->lvl_next = flp->lvl;
3192 else
3193 --flp->lvl_next;
3195 else
3196 mb_ptr_adv(s);
3199 /* The level can't go negative, must be missing a start marker. */
3200 if (flp->lvl_next < 0)
3201 flp->lvl_next = 0;
3204 /* foldlevelSyntax() {{{2 */
3206 * Low level function to get the foldlevel for the "syntax" method.
3207 * Doesn't use any caching.
3209 static void
3210 foldlevelSyntax(flp)
3211 fline_T *flp;
3213 #ifndef FEAT_SYN_HL
3214 flp->start = 0;
3215 flp->lvl = 0;
3216 #else
3217 linenr_T lnum = flp->lnum + flp->off;
3218 int n;
3220 /* Use the maximum fold level at the start of this line and the next. */
3221 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3222 flp->start = 0;
3223 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3225 n = syn_get_foldlevel(flp->wp, lnum + 1);
3226 if (n > flp->lvl)
3228 flp->start = n - flp->lvl; /* fold(s) start here */
3229 flp->lvl = n;
3232 #endif
3235 /* functions for storing the fold state in a View {{{1 */
3236 /* put_folds() {{{2 */
3237 #if defined(FEAT_SESSION) || defined(PROTO)
3238 static int put_folds_recurse __ARGS((FILE *fd, garray_T *gap, linenr_T off));
3239 static int put_foldopen_recurse __ARGS((FILE *fd, garray_T *gap, linenr_T off));
3242 * Write commands to "fd" to restore the manual folds in window "wp".
3243 * Return FAIL if writing fails.
3246 put_folds(fd, wp)
3247 FILE *fd;
3248 win_T *wp;
3250 if (foldmethodIsManual(wp))
3252 if (put_line(fd, "silent! normal! zE") == FAIL
3253 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL)
3254 return FAIL;
3257 /* If some folds are manually opened/closed, need to restore that. */
3258 if (wp->w_fold_manual)
3259 return put_foldopen_recurse(fd, &wp->w_folds, (linenr_T)0);
3261 return OK;
3264 /* put_folds_recurse() {{{2 */
3266 * Write commands to "fd" to recreate manually created folds.
3267 * Returns FAIL when writing failed.
3269 static int
3270 put_folds_recurse(fd, gap, off)
3271 FILE *fd;
3272 garray_T *gap;
3273 linenr_T off;
3275 int i;
3276 fold_T *fp;
3278 fp = (fold_T *)gap->ga_data;
3279 for (i = 0; i < gap->ga_len; i++)
3281 /* Do nested folds first, they will be created closed. */
3282 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3283 return FAIL;
3284 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3285 fp->fd_top + off + fp->fd_len - 1) < 0
3286 || put_eol(fd) == FAIL)
3287 return FAIL;
3288 ++fp;
3290 return OK;
3293 /* put_foldopen_recurse() {{{2 */
3295 * Write commands to "fd" to open and close manually opened/closed folds.
3296 * Returns FAIL when writing failed.
3298 static int
3299 put_foldopen_recurse(fd, gap, off)
3300 FILE *fd;
3301 garray_T *gap;
3302 linenr_T off;
3304 int i;
3305 fold_T *fp;
3307 fp = (fold_T *)gap->ga_data;
3308 for (i = 0; i < gap->ga_len; i++)
3310 if (fp->fd_flags != FD_LEVEL)
3312 if (fp->fd_nested.ga_len > 0)
3314 /* open/close nested folds while this fold is open */
3315 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3316 || put_eol(fd) == FAIL
3317 || put_line(fd, "normal zo") == FAIL)
3318 return FAIL;
3319 if (put_foldopen_recurse(fd, &fp->fd_nested, off + fp->fd_top)
3320 == FAIL)
3321 return FAIL;
3323 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3324 || put_eol(fd) == FAIL
3325 || fprintf(fd, "normal z%c",
3326 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3327 || put_eol(fd) == FAIL)
3328 return FAIL;
3330 ++fp;
3333 return OK;
3335 #endif /* FEAT_SESSION */
3337 /* }}}1 */
3338 #endif /* defined(FEAT_FOLDING) || defined(PROTO) */