blob: 8cadd43277b076e84be324dee60da27d3edbdeb7 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 * vim600:fdm=marker fdl=1 fdc=3:
3 *
4 * VIM - Vi IMproved by Bram Moolenaar
5 *
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 */
10
11/*
12 * fold.c: code for folding
13 */
14
15#include "vim.h"
16
17#if defined(FEAT_FOLDING) || defined(PROTO)
18
19/* local declarations. {{{1 */
20/* typedef fold_T {{{2 */
21/*
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.
26 */
27typedef struct
28{
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;
38
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) */
42
43#define MAX_LEVEL 20 /* maximum fold depth */
44
45/* static functions {{{2 */
Bram Moolenaard25c16e2016-01-29 22:13:30 +010046static void newFoldLevelWin(win_T *wp);
47static int checkCloseRec(garray_T *gap, linenr_T lnum, int level);
48static int foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp);
49static int foldLevelWin(win_T *wp, linenr_T lnum);
50static void checkupdate(win_T *wp);
51static void setFoldRepeat(linenr_T lnum, long count, int do_open);
52static linenr_T setManualFold(linenr_T lnum, int opening, int recurse, int *donep);
53static linenr_T setManualFoldWin(win_T *wp, linenr_T lnum, int opening, int recurse, int *donep);
54static void foldOpenNested(fold_T *fpr);
55static void deleteFoldEntry(garray_T *gap, int idx, int recursive);
56static void foldMarkAdjustRecurse(garray_T *gap, linenr_T line1, linenr_T line2, long amount, long amount_after);
57static int getDeepestNestingRecurse(garray_T *gap);
58static int check_closed(win_T *win, fold_T *fp, int *use_levelp, int level, int *maybe_smallp, linenr_T lnum_off);
59static void checkSmall(win_T *wp, fold_T *fp, linenr_T lnum_off);
60static void setSmallMaybe(garray_T *gap);
61static void foldCreateMarkers(linenr_T start, linenr_T end);
62static void foldAddMarker(linenr_T lnum, char_u *marker, int markerlen);
63static void deleteFoldMarkers(fold_T *fp, int recursive, linenr_T lnum_off);
64static void foldDelMarker(linenr_T lnum, char_u *marker, int markerlen);
65static void foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot);
66static void parseMarker(win_T *wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +000067
68static char *e_nofold = N_("E490: No fold found");
69
70/*
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.
73 */
74static linenr_T invalid_top = (linenr_T)0;
75static linenr_T invalid_bot = (linenr_T)0;
76
77/*
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.
83 */
84static linenr_T prev_lnum = 0;
85static int prev_lnum_lvl = -1;
86
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 */
91
92static int foldstartmarkerlen;
93static char_u *foldendmarker;
94static int foldendmarkerlen;
95
96/* Exported folding functions. {{{1 */
97/* copyFoldingState() {{{2 */
Bram Moolenaar4033c552017-09-16 20:54:51 +020098
Bram Moolenaar071d4272004-06-13 20:20:40 +000099/*
100 * Copy that folding state from window "wp_from" to window "wp_to".
101 */
102 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100103copyFoldingState(win_T *wp_from, win_T *wp_to)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104{
105 wp_to->w_fold_manual = wp_from->w_fold_manual;
106 wp_to->w_foldinvalid = wp_from->w_foldinvalid;
107 cloneFoldGrowArray(&wp_from->w_folds, &wp_to->w_folds);
108}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110/* hasAnyFolding() {{{2 */
111/*
112 * Return TRUE if there may be folded lines in the current window.
113 */
114 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100115hasAnyFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116{
117 /* very simple now, but can become more complex later */
118 return (win->w_p_fen
119 && (!foldmethodIsManual(win) || win->w_folds.ga_len > 0));
120}
121
122/* hasFolding() {{{2 */
123/*
124 * Return TRUE if line "lnum" in the current window is part of a closed
125 * fold.
126 * When returning TRUE, *firstp and *lastp are set to the first and last
127 * lnum of the sequence of folded lines (skipped when NULL).
128 */
129 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100130hasFolding(linenr_T lnum, linenr_T *firstp, linenr_T *lastp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131{
132 return hasFoldingWin(curwin, lnum, firstp, lastp, TRUE, NULL);
133}
134
135/* hasFoldingWin() {{{2 */
136 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100137hasFoldingWin(
138 win_T *win,
139 linenr_T lnum,
140 linenr_T *firstp,
141 linenr_T *lastp,
142 int cache, /* when TRUE: use cached values of window */
143 foldinfo_T *infop) /* where to store fold info */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 int had_folded = FALSE;
146 linenr_T first = 0;
147 linenr_T last = 0;
148 linenr_T lnum_rel = lnum;
149 int x;
150 fold_T *fp;
151 int level = 0;
152 int use_level = FALSE;
153 int maybe_small = FALSE;
154 garray_T *gap;
Bram Moolenaar945ec092016-06-08 21:17:43 +0200155 int low_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156
157 checkupdate(win);
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +0100158
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 /*
160 * Return quickly when there is no folding at all in this window.
161 */
162 if (!hasAnyFolding(win))
163 {
164 if (infop != NULL)
165 infop->fi_level = 0;
166 return FALSE;
167 }
168
169 if (cache)
170 {
171 /*
172 * First look in cached info for displayed lines. This is probably
173 * the fastest, but it can only be used if the entry is still valid.
174 */
175 x = find_wl_entry(win, lnum);
176 if (x >= 0)
177 {
178 first = win->w_lines[x].wl_lnum;
179 last = win->w_lines[x].wl_lastlnum;
180 had_folded = win->w_lines[x].wl_folded;
181 }
182 }
183
184 if (first == 0)
185 {
186 /*
187 * Recursively search for a fold that contains "lnum".
188 */
189 gap = &win->w_folds;
190 for (;;)
191 {
192 if (!foldFind(gap, lnum_rel, &fp))
193 break;
194
195 /* Remember lowest level of fold that starts in "lnum". */
196 if (lnum_rel == fp->fd_top && low_level == 0)
197 low_level = level + 1;
198
199 first += fp->fd_top;
200 last += fp->fd_top;
201
202 /* is this fold closed? */
203 had_folded = check_closed(win, fp, &use_level, level,
204 &maybe_small, lnum - lnum_rel);
205 if (had_folded)
206 {
207 /* Fold closed: Set last and quit loop. */
208 last += fp->fd_len - 1;
209 break;
210 }
211
212 /* Fold found, but it's open: Check nested folds. Line number is
213 * relative to containing fold. */
214 gap = &fp->fd_nested;
215 lnum_rel -= fp->fd_top;
216 ++level;
217 }
218 }
219
220 if (!had_folded)
221 {
222 if (infop != NULL)
223 {
224 infop->fi_level = level;
225 infop->fi_lnum = lnum - lnum_rel;
226 infop->fi_low_level = low_level == 0 ? level : low_level;
227 }
228 return FALSE;
229 }
230
Bram Moolenaar05b20fb2015-04-13 20:52:36 +0200231 if (last > win->w_buffer->b_ml.ml_line_count)
232 last = win->w_buffer->b_ml.ml_line_count;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 if (lastp != NULL)
234 *lastp = last;
235 if (firstp != NULL)
236 *firstp = first;
237 if (infop != NULL)
238 {
239 infop->fi_level = level + 1;
240 infop->fi_lnum = first;
241 infop->fi_low_level = low_level == 0 ? level + 1 : low_level;
242 }
243 return TRUE;
244}
245
246/* foldLevel() {{{2 */
Bram Moolenaardb022f32019-09-01 17:52:32 +0200247#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248/*
249 * Return fold level at line number "lnum" in the current window.
250 */
Bram Moolenaardb022f32019-09-01 17:52:32 +0200251 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100252foldLevel(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253{
254 /* While updating the folds lines between invalid_top and invalid_bot have
255 * an undefined fold level. Otherwise update the folds first. */
256 if (invalid_top == (linenr_T)0)
257 checkupdate(curwin);
258 else if (lnum == prev_lnum && prev_lnum_lvl >= 0)
259 return prev_lnum_lvl;
260 else if (lnum >= invalid_top && lnum <= invalid_bot)
261 return -1;
262
263 /* Return quickly when there is no folding at all in this window. */
264 if (!hasAnyFolding(curwin))
265 return 0;
266
267 return foldLevelWin(curwin, lnum);
268}
Bram Moolenaardb022f32019-09-01 17:52:32 +0200269#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271/* lineFolded() {{{2 */
272/*
273 * Low level function to check if a line is folded. Doesn't use any caching.
274 * Return TRUE if line is folded.
275 * Return FALSE if line is not folded.
276 * Return MAYBE if the line is folded when next to a folded line.
277 */
278 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100279lineFolded(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280{
281 return foldedCount(win, lnum, NULL) != 0;
282}
283
284/* foldedCount() {{{2 */
285/*
286 * Count the number of lines that are folded at line number "lnum".
287 * Normally "lnum" is the first line of a possible fold, and the returned
288 * number is the number of lines in the fold.
289 * Doesn't use caching from the displayed window.
290 * Returns number of folded lines from "lnum", or 0 if line is not folded.
291 * When "infop" is not NULL, fills *infop with the fold level info.
292 */
293 long
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100294foldedCount(win_T *win, linenr_T lnum, foldinfo_T *infop)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295{
296 linenr_T last;
297
298 if (hasFoldingWin(win, lnum, NULL, &last, FALSE, infop))
299 return (long)(last - lnum + 1);
300 return 0;
301}
302
303/* foldmethodIsManual() {{{2 */
304/*
305 * Return TRUE if 'foldmethod' is "manual"
306 */
307 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100308foldmethodIsManual(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309{
310 return (wp->w_p_fdm[3] == 'u');
311}
312
313/* foldmethodIsIndent() {{{2 */
314/*
315 * Return TRUE if 'foldmethod' is "indent"
316 */
317 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100318foldmethodIsIndent(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319{
320 return (wp->w_p_fdm[0] == 'i');
321}
322
323/* foldmethodIsExpr() {{{2 */
324/*
325 * Return TRUE if 'foldmethod' is "expr"
326 */
327 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100328foldmethodIsExpr(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329{
330 return (wp->w_p_fdm[1] == 'x');
331}
332
333/* foldmethodIsMarker() {{{2 */
334/*
335 * Return TRUE if 'foldmethod' is "marker"
336 */
337 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100338foldmethodIsMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339{
340 return (wp->w_p_fdm[2] == 'r');
341}
342
343/* foldmethodIsSyntax() {{{2 */
344/*
345 * Return TRUE if 'foldmethod' is "syntax"
346 */
347 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100348foldmethodIsSyntax(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349{
350 return (wp->w_p_fdm[0] == 's');
351}
352
353/* foldmethodIsDiff() {{{2 */
354/*
355 * Return TRUE if 'foldmethod' is "diff"
356 */
357 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100358foldmethodIsDiff(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359{
360 return (wp->w_p_fdm[0] == 'd');
361}
362
363/* closeFold() {{{2 */
364/*
365 * Close fold for current window at line "lnum".
366 * Repeat "count" times.
367 */
368 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100369closeFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370{
371 setFoldRepeat(lnum, count, FALSE);
372}
373
374/* closeFoldRecurse() {{{2 */
375/*
376 * Close fold for current window at line "lnum" recursively.
377 */
378 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100379closeFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380{
381 (void)setManualFold(lnum, FALSE, TRUE, NULL);
382}
383
384/* opFoldRange() {{{2 */
385/*
386 * Open or Close folds for current window in lines "first" to "last".
387 * Used for "zo", "zO", "zc" and "zC" in Visual mode.
388 */
389 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100390opFoldRange(
391 linenr_T first,
392 linenr_T last,
393 int opening, /* TRUE to open, FALSE to close */
394 int recurse, /* TRUE to do it recursively */
395 int had_visual) /* TRUE when Visual selection used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396{
397 int done = DONE_NOTHING; /* avoid error messages */
398 linenr_T lnum;
399 linenr_T lnum_next;
400
401 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
402 {
403 lnum_next = lnum;
404 /* Opening one level only: next fold to open is after the one going to
405 * be opened. */
406 if (opening && !recurse)
407 (void)hasFolding(lnum, NULL, &lnum_next);
408 (void)setManualFold(lnum, opening, recurse, &done);
409 /* Closing one level only: next line to close a fold is after just
410 * closed fold. */
411 if (!opening && !recurse)
412 (void)hasFolding(lnum, NULL, &lnum_next);
413 }
414 if (done == DONE_NOTHING)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100415 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 /* Force a redraw to remove the Visual highlighting. */
417 if (had_visual)
418 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419}
420
421/* openFold() {{{2 */
422/*
423 * Open fold for current window at line "lnum".
424 * Repeat "count" times.
425 */
426 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100427openFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428{
429 setFoldRepeat(lnum, count, TRUE);
430}
431
432/* openFoldRecurse() {{{2 */
433/*
434 * Open fold for current window at line "lnum" recursively.
435 */
436 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100437openFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438{
439 (void)setManualFold(lnum, TRUE, TRUE, NULL);
440}
441
442/* foldOpenCursor() {{{2 */
443/*
444 * Open folds until the cursor line is not in a closed fold.
445 */
446 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100447foldOpenCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448{
449 int done;
450
451 checkupdate(curwin);
452 if (hasAnyFolding(curwin))
453 for (;;)
454 {
455 done = DONE_NOTHING;
456 (void)setManualFold(curwin->w_cursor.lnum, TRUE, FALSE, &done);
457 if (!(done & DONE_ACTION))
458 break;
459 }
460}
461
462/* newFoldLevel() {{{2 */
463/*
464 * Set new foldlevel for current window.
465 */
466 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100467newFoldLevel(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468{
469 newFoldLevelWin(curwin);
470
471#ifdef FEAT_DIFF
472 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
473 {
474 win_T *wp;
475
476 /*
477 * Set the same foldlevel in other windows in diff mode.
478 */
479 FOR_ALL_WINDOWS(wp)
480 {
481 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
482 {
483 wp->w_p_fdl = curwin->w_p_fdl;
484 newFoldLevelWin(wp);
485 }
486 }
487 }
488#endif
489}
490
491 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100492newFoldLevelWin(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493{
494 fold_T *fp;
495 int i;
496
497 checkupdate(wp);
498 if (wp->w_fold_manual)
499 {
500 /* Set all flags for the first level of folds to FD_LEVEL. Following
501 * manual open/close will then change the flags to FD_OPEN or
502 * FD_CLOSED for those folds that don't use 'foldlevel'. */
503 fp = (fold_T *)wp->w_folds.ga_data;
504 for (i = 0; i < wp->w_folds.ga_len; ++i)
505 fp[i].fd_flags = FD_LEVEL;
506 wp->w_fold_manual = FALSE;
507 }
508 changed_window_setting_win(wp);
509}
510
511/* foldCheckClose() {{{2 */
512/*
513 * Apply 'foldlevel' to all folds that don't contain the cursor.
514 */
515 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100516foldCheckClose(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517{
518 if (*p_fcl != NUL) /* can only be "all" right now */
519 {
520 checkupdate(curwin);
521 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
522 (int)curwin->w_p_fdl))
523 changed_window_setting();
524 }
525}
526
527/* checkCloseRec() {{{2 */
528 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100529checkCloseRec(garray_T *gap, linenr_T lnum, int level)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530{
531 fold_T *fp;
532 int retval = FALSE;
533 int i;
534
535 fp = (fold_T *)gap->ga_data;
536 for (i = 0; i < gap->ga_len; ++i)
537 {
538 /* Only manually opened folds may need to be closed. */
539 if (fp[i].fd_flags == FD_OPEN)
540 {
541 if (level <= 0 && (lnum < fp[i].fd_top
542 || lnum >= fp[i].fd_top + fp[i].fd_len))
543 {
544 fp[i].fd_flags = FD_LEVEL;
545 retval = TRUE;
546 }
547 else
548 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
549 level - 1);
550 }
551 }
552 return retval;
553}
554
555/* foldCreateAllowed() {{{2 */
556/*
557 * Return TRUE if it's allowed to manually create or delete a fold.
558 * Give an error message and return FALSE if not.
559 */
560 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100561foldManualAllowed(int create)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562{
563 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
564 return TRUE;
565 if (create)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100566 emsg(_("E350: Cannot create fold with current 'foldmethod'"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100568 emsg(_("E351: Cannot delete fold with current 'foldmethod'"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569 return FALSE;
570}
571
572/* foldCreate() {{{2 */
573/*
574 * Create a fold from line "start" to line "end" (inclusive) in the current
575 * window.
576 */
577 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100578foldCreate(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579{
580 fold_T *fp;
581 garray_T *gap;
582 garray_T fold_ga;
583 int i, j;
584 int cont;
585 int use_level = FALSE;
586 int closed = FALSE;
587 int level = 0;
588 linenr_T start_rel = start;
589 linenr_T end_rel = end;
590
591 if (start > end)
592 {
593 /* reverse the range */
594 end = start_rel;
595 start = end_rel;
596 start_rel = start;
597 end_rel = end;
598 }
599
600 /* When 'foldmethod' is "marker" add markers, which creates the folds. */
601 if (foldmethodIsMarker(curwin))
602 {
603 foldCreateMarkers(start, end);
604 return;
605 }
606
607 checkupdate(curwin);
608
609 /* Find the place to insert the new fold. */
610 gap = &curwin->w_folds;
611 for (;;)
612 {
613 if (!foldFind(gap, start_rel, &fp))
614 break;
615 if (fp->fd_top + fp->fd_len > end_rel)
616 {
617 /* New fold is completely inside this fold: Go one level deeper. */
618 gap = &fp->fd_nested;
619 start_rel -= fp->fd_top;
620 end_rel -= fp->fd_top;
621 if (use_level || fp->fd_flags == FD_LEVEL)
622 {
623 use_level = TRUE;
624 if (level >= curwin->w_p_fdl)
625 closed = TRUE;
626 }
627 else if (fp->fd_flags == FD_CLOSED)
628 closed = TRUE;
629 ++level;
630 }
631 else
632 {
633 /* This fold and new fold overlap: Insert here and move some folds
634 * inside the new fold. */
635 break;
636 }
637 }
638
639 i = (int)(fp - (fold_T *)gap->ga_data);
640 if (ga_grow(gap, 1) == OK)
641 {
642 fp = (fold_T *)gap->ga_data + i;
643 ga_init2(&fold_ga, (int)sizeof(fold_T), 10);
644
645 /* Count number of folds that will be contained in the new fold. */
646 for (cont = 0; i + cont < gap->ga_len; ++cont)
647 if (fp[cont].fd_top > end_rel)
648 break;
649 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
650 {
651 /* If the first fold starts before the new fold, let the new fold
652 * start there. Otherwise the existing fold would change. */
653 if (start_rel > fp->fd_top)
654 start_rel = fp->fd_top;
655
656 /* When last contained fold isn't completely contained, adjust end
657 * of new fold. */
658 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
659 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
660 /* Move contained folds to inside new fold. */
661 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
662 fold_ga.ga_len += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 i += cont;
664
665 /* Adjust line numbers in contained folds to be relative to the
666 * new fold. */
667 for (j = 0; j < cont; ++j)
668 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
669 }
670 /* Move remaining entries to after the new fold. */
671 if (i < gap->ga_len)
672 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
673 sizeof(fold_T) * (gap->ga_len - i));
674 gap->ga_len = gap->ga_len + 1 - cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
676 /* insert new fold */
677 fp->fd_nested = fold_ga;
678 fp->fd_top = start_rel;
679 fp->fd_len = end_rel - start_rel + 1;
680
681 /* We want the new fold to be closed. If it would remain open because
682 * of using 'foldlevel', need to adjust fd_flags of containing folds.
683 */
684 if (use_level && !closed && level < curwin->w_p_fdl)
685 closeFold(start, 1L);
686 if (!use_level)
687 curwin->w_fold_manual = TRUE;
688 fp->fd_flags = FD_CLOSED;
689 fp->fd_small = MAYBE;
690
691 /* redraw */
692 changed_window_setting();
693 }
694}
695
696/* deleteFold() {{{2 */
697/*
698 * Delete a fold at line "start" in the current window.
699 * When "end" is not 0, delete all folds from "start" to "end".
700 * When "recursive" is TRUE delete recursively.
701 */
702 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100703deleteFold(
704 linenr_T start,
705 linenr_T end,
706 int recursive,
707 int had_visual) /* TRUE when Visual selection used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708{
709 garray_T *gap;
710 fold_T *fp;
711 garray_T *found_ga;
712 fold_T *found_fp = NULL;
713 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000714 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 int maybe_small = FALSE;
716 int level = 0;
717 linenr_T lnum = start;
718 linenr_T lnum_off;
719 int did_one = FALSE;
720 linenr_T first_lnum = MAXLNUM;
721 linenr_T last_lnum = 0;
722
723 checkupdate(curwin);
724
725 while (lnum <= end)
726 {
727 /* Find the deepest fold for "start". */
728 gap = &curwin->w_folds;
729 found_ga = NULL;
730 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000731 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 for (;;)
733 {
734 if (!foldFind(gap, lnum - lnum_off, &fp))
735 break;
736 /* lnum is inside this fold, remember info */
737 found_ga = gap;
738 found_fp = fp;
739 found_off = lnum_off;
740
741 /* if "lnum" is folded, don't check nesting */
742 if (check_closed(curwin, fp, &use_level, level,
743 &maybe_small, lnum_off))
744 break;
745
746 /* check nested folds */
747 gap = &fp->fd_nested;
748 lnum_off += fp->fd_top;
749 ++level;
750 }
751 if (found_ga == NULL)
752 {
753 ++lnum;
754 }
755 else
756 {
757 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758
759 if (foldmethodIsManual(curwin))
760 deleteFoldEntry(found_ga,
761 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
762 else
763 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000764 if (first_lnum > found_fp->fd_top + found_off)
765 first_lnum = found_fp->fd_top + found_off;
766 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000768 if (!did_one)
769 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 deleteFoldMarkers(found_fp, recursive, found_off);
771 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000772 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773
774 /* redraw window */
775 changed_window_setting();
776 }
777 }
778 if (!did_one)
779 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100780 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 /* Force a redraw to remove the Visual highlighting. */
782 if (had_visual)
783 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000785 else
786 /* Deleting markers may make cursor column invalid. */
787 check_cursor_col();
788
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 if (last_lnum > 0)
790 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
791}
792
793/* clearFolding() {{{2 */
794/*
795 * Remove all folding for window "win".
796 */
797 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100798clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799{
800 deleteFoldRecurse(&win->w_folds);
801 win->w_foldinvalid = FALSE;
802}
803
804/* foldUpdate() {{{2 */
805/*
806 * Update folds for changes in the buffer of a window.
807 * Note that inserted/deleted lines must have already been taken care of by
808 * calling foldMarkAdjust().
809 * The changes in lines from top to bot (inclusive).
810 */
811 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100812foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813{
814 fold_T *fp;
815
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200816 if (disable_fold_update > 0)
817 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200818#ifdef FEAT_DIFF
819 if (need_diff_redraw)
820 // will update later
821 return;
822#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200823
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 /* Mark all folds from top to bot as maybe-small. */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200825 (void)foldFind(&wp->w_folds, top, &fp);
826 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 && fp->fd_top < bot)
828 {
829 fp->fd_small = MAYBE;
830 ++fp;
831 }
832
833 if (foldmethodIsIndent(wp)
834 || foldmethodIsExpr(wp)
835 || foldmethodIsMarker(wp)
836#ifdef FEAT_DIFF
837 || foldmethodIsDiff(wp)
838#endif
839 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000840 {
841 int save_got_int = got_int;
842
843 /* reset got_int here, otherwise it won't work */
844 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000846 got_int |= save_got_int;
847 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848}
849
850/* foldUpdateAll() {{{2 */
851/*
852 * Update all lines in a window for folding.
853 * Used when a fold setting changes or after reloading the buffer.
854 * The actual updating is postponed until fold info is used, to avoid doing
855 * every time a setting is changed or a syntax item is added.
856 */
857 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100858foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859{
860 win->w_foldinvalid = TRUE;
861 redraw_win_later(win, NOT_VALID);
862}
863
864/* foldMoveTo() {{{2 */
865/*
866 * If "updown" is FALSE: Move to the start or end of the fold.
867 * If "updown" is TRUE: move to fold at the same level.
868 * If not moved return FAIL.
869 */
870 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100871foldMoveTo(
872 int updown,
873 int dir, /* FORWARD or BACKWARD */
874 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875{
876 long n;
877 int retval = FAIL;
878 linenr_T lnum_off;
879 linenr_T lnum_found;
880 linenr_T lnum;
881 int use_level;
882 int maybe_small;
883 garray_T *gap;
884 fold_T *fp;
885 int level;
886 int last;
887
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000888 checkupdate(curwin);
889
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 /* Repeat "count" times. */
891 for (n = 0; n < count; ++n)
892 {
893 /* Find nested folds. Stop when a fold is closed. The deepest fold
894 * that moves the cursor is used. */
895 lnum_off = 0;
896 gap = &curwin->w_folds;
897 use_level = FALSE;
898 maybe_small = FALSE;
899 lnum_found = curwin->w_cursor.lnum;
900 level = 0;
901 last = FALSE;
902 for (;;)
903 {
904 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
905 {
906 if (!updown)
907 break;
908
909 /* When moving up, consider a fold above the cursor; when
910 * moving down consider a fold below the cursor. */
911 if (dir == FORWARD)
912 {
913 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
914 break;
915 --fp;
916 }
917 else
918 {
919 if (fp == (fold_T *)gap->ga_data)
920 break;
921 }
922 /* don't look for contained folds, they will always move
923 * the cursor too far. */
924 last = TRUE;
925 }
926
927 if (!last)
928 {
929 /* Check if this fold is closed. */
930 if (check_closed(curwin, fp, &use_level, level,
931 &maybe_small, lnum_off))
932 last = TRUE;
933
934 /* "[z" and "]z" stop at closed fold */
935 if (last && !updown)
936 break;
937 }
938
939 if (updown)
940 {
941 if (dir == FORWARD)
942 {
943 /* to start of next fold if there is one */
944 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
945 {
946 lnum = fp[1].fd_top + lnum_off;
947 if (lnum > curwin->w_cursor.lnum)
948 lnum_found = lnum;
949 }
950 }
951 else
952 {
953 /* to end of previous fold if there is one */
954 if (fp > (fold_T *)gap->ga_data)
955 {
956 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
957 if (lnum < curwin->w_cursor.lnum)
958 lnum_found = lnum;
959 }
960 }
961 }
962 else
963 {
964 /* Open fold found, set cursor to its start/end and then check
965 * nested folds. */
966 if (dir == FORWARD)
967 {
968 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
969 if (lnum > curwin->w_cursor.lnum)
970 lnum_found = lnum;
971 }
972 else
973 {
974 lnum = fp->fd_top + lnum_off;
975 if (lnum < curwin->w_cursor.lnum)
976 lnum_found = lnum;
977 }
978 }
979
980 if (last)
981 break;
982
983 /* Check nested folds (if any). */
984 gap = &fp->fd_nested;
985 lnum_off += fp->fd_top;
986 ++level;
987 }
988 if (lnum_found != curwin->w_cursor.lnum)
989 {
990 if (retval == FAIL)
991 setpcmark();
992 curwin->w_cursor.lnum = lnum_found;
993 curwin->w_cursor.col = 0;
994 retval = OK;
995 }
996 else
997 break;
998 }
999
1000 return retval;
1001}
1002
1003/* foldInitWin() {{{2 */
1004/*
1005 * Init the fold info in a new window.
1006 */
1007 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001008foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009{
Bram Moolenaar70b2a562012-01-10 22:26:17 +01001010 ga_init2(&new_win->w_folds, (int)sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011}
1012
1013/* find_wl_entry() {{{2 */
1014/*
1015 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1016 * Only valid entries are considered (for entries where wl_valid is FALSE the
1017 * line number can be wrong).
1018 * Returns index of entry or -1 if not found.
1019 */
1020 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001021find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022{
1023 int i;
1024
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001025 for (i = 0; i < win->w_lines_valid; ++i)
1026 if (win->w_lines[i].wl_valid)
1027 {
1028 if (lnum < win->w_lines[i].wl_lnum)
1029 return -1;
1030 if (lnum <= win->w_lines[i].wl_lastlnum)
1031 return i;
1032 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033 return -1;
1034}
1035
1036/* foldAdjustVisual() {{{2 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037/*
1038 * Adjust the Visual area to include any fold at the start or end completely.
1039 */
1040 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001041foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042{
1043 pos_T *start, *end;
1044 char_u *ptr;
1045
1046 if (!VIsual_active || !hasAnyFolding(curwin))
1047 return;
1048
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01001049 if (LTOREQ_POS(VIsual, curwin->w_cursor))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 {
1051 start = &VIsual;
1052 end = &curwin->w_cursor;
1053 }
1054 else
1055 {
1056 start = &curwin->w_cursor;
1057 end = &VIsual;
1058 }
1059 if (hasFolding(start->lnum, &start->lnum, NULL))
1060 start->col = 0;
1061 if (hasFolding(end->lnum, NULL, &end->lnum))
1062 {
1063 ptr = ml_get(end->lnum);
1064 end->col = (colnr_T)STRLEN(ptr);
1065 if (end->col > 0 && *p_sel == 'o')
1066 --end->col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 /* prevent cursor from moving on the trail byte */
1068 if (has_mbyte)
1069 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 }
1071}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072
1073/* cursor_foldstart() {{{2 */
1074/*
1075 * Move the cursor to the first line of a closed fold.
1076 */
1077 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001078foldAdjustCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079{
1080 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1081}
1082
1083/* Internal functions for "fold_T" {{{1 */
1084/* cloneFoldGrowArray() {{{2 */
1085/*
1086 * Will "clone" (i.e deep copy) a garray_T of folds.
1087 *
1088 * Return FAIL if the operation cannot be completed, otherwise OK.
1089 */
1090 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001091cloneFoldGrowArray(garray_T *from, garray_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092{
1093 int i;
1094 fold_T *from_p;
1095 fold_T *to_p;
1096
1097 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1098 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1099 return;
1100
1101 from_p = (fold_T *)from->ga_data;
1102 to_p = (fold_T *)to->ga_data;
1103
1104 for (i = 0; i < from->ga_len; i++)
1105 {
1106 to_p->fd_top = from_p->fd_top;
1107 to_p->fd_len = from_p->fd_len;
1108 to_p->fd_flags = from_p->fd_flags;
1109 to_p->fd_small = from_p->fd_small;
1110 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1111 ++to->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 ++from_p;
1113 ++to_p;
1114 }
1115}
1116
1117/* foldFind() {{{2 */
1118/*
1119 * Search for line "lnum" in folds of growarray "gap".
1120 * Set *fpp to the fold struct for the fold that contains "lnum" or
1121 * the first fold below it (careful: it can be beyond the end of the array!).
1122 * Returns FALSE when there is no fold that contains "lnum".
1123 */
1124 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001125foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126{
1127 linenr_T low, high;
1128 fold_T *fp;
1129 int i;
1130
1131 /*
1132 * Perform a binary search.
1133 * "low" is lowest index of possible match.
1134 * "high" is highest index of possible match.
1135 */
1136 fp = (fold_T *)gap->ga_data;
1137 low = 0;
1138 high = gap->ga_len - 1;
1139 while (low <= high)
1140 {
1141 i = (low + high) / 2;
1142 if (fp[i].fd_top > lnum)
1143 /* fold below lnum, adjust high */
1144 high = i - 1;
1145 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
1146 /* fold above lnum, adjust low */
1147 low = i + 1;
1148 else
1149 {
1150 /* lnum is inside this fold */
1151 *fpp = fp + i;
1152 return TRUE;
1153 }
1154 }
1155 *fpp = fp + low;
1156 return FALSE;
1157}
1158
1159/* foldLevelWin() {{{2 */
1160/*
1161 * Return fold level at line number "lnum" in window "wp".
1162 */
1163 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001164foldLevelWin(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165{
1166 fold_T *fp;
1167 linenr_T lnum_rel = lnum;
1168 int level = 0;
1169 garray_T *gap;
1170
1171 /* Recursively search for a fold that contains "lnum". */
1172 gap = &wp->w_folds;
1173 for (;;)
1174 {
1175 if (!foldFind(gap, lnum_rel, &fp))
1176 break;
1177 /* Check nested folds. Line number is relative to containing fold. */
1178 gap = &fp->fd_nested;
1179 lnum_rel -= fp->fd_top;
1180 ++level;
1181 }
1182
1183 return level;
1184}
1185
1186/* checkupdate() {{{2 */
1187/*
1188 * Check if the folds in window "wp" are invalid and update them if needed.
1189 */
1190 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001191checkupdate(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192{
1193 if (wp->w_foldinvalid)
1194 {
1195 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); /* will update all */
1196 wp->w_foldinvalid = FALSE;
1197 }
1198}
1199
1200/* setFoldRepeat() {{{2 */
1201/*
1202 * Open or close fold for current window at line "lnum".
1203 * Repeat "count" times.
1204 */
1205 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001206setFoldRepeat(linenr_T lnum, long count, int do_open)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207{
1208 int done;
1209 long n;
1210
1211 for (n = 0; n < count; ++n)
1212 {
1213 done = DONE_NOTHING;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001214 (void)setManualFold(lnum, do_open, FALSE, &done);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 if (!(done & DONE_ACTION))
1216 {
1217 /* Only give an error message when no fold could be opened. */
1218 if (n == 0 && !(done & DONE_FOLD))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001219 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 break;
1221 }
1222 }
1223}
1224
1225/* setManualFold() {{{2 */
1226/*
1227 * Open or close the fold in the current window which contains "lnum".
1228 * Also does this for other windows in diff mode when needed.
1229 */
1230 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001231setManualFold(
1232 linenr_T lnum,
1233 int opening, /* TRUE when opening, FALSE when closing */
1234 int recurse, /* TRUE when closing/opening recursive */
1235 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236{
1237#ifdef FEAT_DIFF
1238 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1239 {
1240 win_T *wp;
1241 linenr_T dlnum;
1242
1243 /*
1244 * Do the same operation in other windows in diff mode. Calculate the
1245 * line number from the diffs.
1246 */
1247 FOR_ALL_WINDOWS(wp)
1248 {
1249 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1250 {
1251 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1252 if (dlnum != 0)
1253 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1254 }
1255 }
1256 }
1257#endif
1258
1259 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1260}
1261
1262/* setManualFoldWin() {{{2 */
1263/*
1264 * Open or close the fold in window "wp" which contains "lnum".
1265 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1266 * fold was found and to DONE_ACTION when some fold was opened or closed.
1267 * When "donep" is NULL give an error message when no fold was found for
1268 * "lnum", but only if "wp" is "curwin".
1269 * Return the line number of the next line that could be closed.
1270 * It's only valid when "opening" is TRUE!
1271 */
1272 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001273setManualFoldWin(
1274 win_T *wp,
1275 linenr_T lnum,
1276 int opening, /* TRUE when opening, FALSE when closing */
1277 int recurse, /* TRUE when closing/opening recursive */
1278 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279{
1280 fold_T *fp;
1281 fold_T *fp2;
1282 fold_T *found = NULL;
1283 int j;
1284 int level = 0;
1285 int use_level = FALSE;
1286 int found_fold = FALSE;
1287 garray_T *gap;
1288 linenr_T next = MAXLNUM;
1289 linenr_T off = 0;
1290 int done = 0;
1291
1292 checkupdate(wp);
1293
1294 /*
1295 * Find the fold, open or close it.
1296 */
1297 gap = &wp->w_folds;
1298 for (;;)
1299 {
1300 if (!foldFind(gap, lnum, &fp))
1301 {
1302 /* If there is a following fold, continue there next time. */
1303 if (fp < (fold_T *)gap->ga_data + gap->ga_len)
1304 next = fp->fd_top + off;
1305 break;
1306 }
1307
1308 /* lnum is inside this fold */
1309 found_fold = TRUE;
1310
1311 /* If there is a following fold, continue there next time. */
1312 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1313 next = fp[1].fd_top + off;
1314
1315 /* Change from level-dependent folding to manual. */
1316 if (use_level || fp->fd_flags == FD_LEVEL)
1317 {
1318 use_level = TRUE;
1319 if (level >= wp->w_p_fdl)
1320 fp->fd_flags = FD_CLOSED;
1321 else
1322 fp->fd_flags = FD_OPEN;
1323 fp2 = (fold_T *)fp->fd_nested.ga_data;
1324 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1325 fp2[j].fd_flags = FD_LEVEL;
1326 }
1327
1328 /* Simple case: Close recursively means closing the fold. */
1329 if (!opening && recurse)
1330 {
1331 if (fp->fd_flags != FD_CLOSED)
1332 {
1333 done |= DONE_ACTION;
1334 fp->fd_flags = FD_CLOSED;
1335 }
1336 }
1337 else if (fp->fd_flags == FD_CLOSED)
1338 {
1339 /* When opening, open topmost closed fold. */
1340 if (opening)
1341 {
1342 fp->fd_flags = FD_OPEN;
1343 done |= DONE_ACTION;
1344 if (recurse)
1345 foldOpenNested(fp);
1346 }
1347 break;
1348 }
1349
1350 /* fold is open, check nested folds */
1351 found = fp;
1352 gap = &fp->fd_nested;
1353 lnum -= fp->fd_top;
1354 off += fp->fd_top;
1355 ++level;
1356 }
1357 if (found_fold)
1358 {
1359 /* When closing and not recurse, close deepest open fold. */
1360 if (!opening && found != NULL)
1361 {
1362 found->fd_flags = FD_CLOSED;
1363 done |= DONE_ACTION;
1364 }
1365 wp->w_fold_manual = TRUE;
1366 if (done & DONE_ACTION)
1367 changed_window_setting_win(wp);
1368 done |= DONE_FOLD;
1369 }
1370 else if (donep == NULL && wp == curwin)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001371 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 if (donep != NULL)
1374 *donep |= done;
1375
1376 return next;
1377}
1378
1379/* foldOpenNested() {{{2 */
1380/*
1381 * Open all nested folds in fold "fpr" recursively.
1382 */
1383 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001384foldOpenNested(fold_T *fpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385{
1386 int i;
1387 fold_T *fp;
1388
1389 fp = (fold_T *)fpr->fd_nested.ga_data;
1390 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1391 {
1392 foldOpenNested(&fp[i]);
1393 fp[i].fd_flags = FD_OPEN;
1394 }
1395}
1396
1397/* deleteFoldEntry() {{{2 */
1398/*
1399 * Delete fold "idx" from growarray "gap".
1400 * When "recursive" is TRUE also delete all the folds contained in it.
1401 * When "recursive" is FALSE contained folds are moved one level up.
1402 */
1403 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001404deleteFoldEntry(garray_T *gap, int idx, int recursive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405{
1406 fold_T *fp;
1407 int i;
1408 long moved;
1409 fold_T *nfp;
1410
1411 fp = (fold_T *)gap->ga_data + idx;
1412 if (recursive || fp->fd_nested.ga_len == 0)
1413 {
1414 /* recursively delete the contained folds */
1415 deleteFoldRecurse(&fp->fd_nested);
1416 --gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 if (idx < gap->ga_len)
1418 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1419 }
1420 else
1421 {
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001422 /* Move nested folds one level up, to overwrite the fold that is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 * deleted. */
1424 moved = fp->fd_nested.ga_len;
1425 if (ga_grow(gap, (int)(moved - 1)) == OK)
1426 {
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001427 /* Get "fp" again, the array may have been reallocated. */
1428 fp = (fold_T *)gap->ga_data + idx;
1429
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 /* adjust fd_top and fd_flags for the moved folds */
1431 nfp = (fold_T *)fp->fd_nested.ga_data;
1432 for (i = 0; i < moved; ++i)
1433 {
1434 nfp[i].fd_top += fp->fd_top;
1435 if (fp->fd_flags == FD_LEVEL)
1436 nfp[i].fd_flags = FD_LEVEL;
1437 if (fp->fd_small == MAYBE)
1438 nfp[i].fd_small = MAYBE;
1439 }
1440
1441 /* move the existing folds down to make room */
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001442 if (idx + 1 < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 mch_memmove(fp + moved, fp + 1,
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001444 sizeof(fold_T) * (gap->ga_len - (idx + 1)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 /* move the contained folds one level up */
1446 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1447 vim_free(nfp);
1448 gap->ga_len += moved - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 }
1450 }
1451}
1452
1453/* deleteFoldRecurse() {{{2 */
1454/*
1455 * Delete nested folds in a fold.
1456 */
1457 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001458deleteFoldRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459{
1460 int i;
1461
1462 for (i = 0; i < gap->ga_len; ++i)
1463 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1464 ga_clear(gap);
1465}
1466
1467/* foldMarkAdjust() {{{2 */
1468/*
1469 * Update line numbers of folds for inserted/deleted lines.
1470 */
1471 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001472foldMarkAdjust(
1473 win_T *wp,
1474 linenr_T line1,
1475 linenr_T line2,
1476 long amount,
1477 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478{
1479 /* If deleting marks from line1 to line2, but not deleting all those
1480 * lines, set line2 so that only deleted lines have their folds removed. */
1481 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1482 line2 = line1 - amount_after - 1;
1483 /* If appending a line in Insert mode, it should be included in the fold
1484 * just above the line. */
1485 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1486 --line1;
1487 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1488}
1489
1490/* foldMarkAdjustRecurse() {{{2 */
1491 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001492foldMarkAdjustRecurse(
1493 garray_T *gap,
1494 linenr_T line1,
1495 linenr_T line2,
1496 long amount,
1497 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498{
1499 fold_T *fp;
1500 int i;
1501 linenr_T last;
1502 linenr_T top;
1503
1504 /* In Insert mode an inserted line at the top of a fold is considered part
1505 * of the fold, otherwise it isn't. */
1506 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1507 top = line1 + 1;
1508 else
1509 top = line1;
1510
1511 /* Find the fold containing or just below "line1". */
1512 (void)foldFind(gap, line1, &fp);
1513
1514 /*
1515 * Adjust all folds below "line1" that are affected.
1516 */
1517 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1518 {
1519 /*
1520 * Check for these situations:
1521 * 1 2 3
1522 * 1 2 3
1523 * line1 2 3 4 5
1524 * 2 3 4 5
1525 * 2 3 4 5
1526 * line2 2 3 4 5
1527 * 3 5 6
1528 * 3 5 6
1529 */
1530
1531 last = fp->fd_top + fp->fd_len - 1; /* last line of fold */
1532
1533 /* 1. fold completely above line1: nothing to do */
1534 if (last < line1)
1535 continue;
1536
1537 /* 6. fold below line2: only adjust for amount_after */
1538 if (fp->fd_top > line2)
1539 {
1540 if (amount_after == 0)
1541 break;
1542 fp->fd_top += amount_after;
1543 }
1544 else
1545 {
1546 if (fp->fd_top >= top && last <= line2)
1547 {
1548 /* 4. fold completely contained in range */
1549 if (amount == MAXLNUM)
1550 {
1551 /* Deleting lines: delete the fold completely */
1552 deleteFoldEntry(gap, i, TRUE);
1553 --i; /* adjust index for deletion */
1554 --fp;
1555 }
1556 else
1557 fp->fd_top += amount;
1558 }
1559 else
1560 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 if (fp->fd_top < top)
1562 {
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001563 /* 2 or 3: need to correct nested folds too */
1564 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1565 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 if (last <= line2)
1567 {
1568 /* 2. fold contains line1, line2 is below fold */
1569 if (amount == MAXLNUM)
1570 fp->fd_len = line1 - fp->fd_top;
1571 else
1572 fp->fd_len += amount;
1573 }
1574 else
1575 {
1576 /* 3. fold contains line1 and line2 */
1577 fp->fd_len += amount_after;
1578 }
1579 }
1580 else
1581 {
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001582 /* 5. fold is below line1 and contains line2; need to
1583 * correct nested folds too */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 if (amount == MAXLNUM)
1585 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001586 foldMarkAdjustRecurse(&fp->fd_nested,
1587 line1 - fp->fd_top,
1588 line2 - fp->fd_top,
1589 amount,
1590 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 fp->fd_len -= line2 - fp->fd_top + 1;
1592 fp->fd_top = line1;
1593 }
1594 else
1595 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001596 foldMarkAdjustRecurse(&fp->fd_nested,
1597 line1 - fp->fd_top,
1598 line2 - fp->fd_top,
1599 amount,
1600 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 fp->fd_len += amount_after - amount;
1602 fp->fd_top += amount;
1603 }
1604 }
1605 }
1606 }
1607 }
1608}
1609
1610/* getDeepestNesting() {{{2 */
1611/*
1612 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1613 * current window open.
1614 */
1615 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001616getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617{
1618 checkupdate(curwin);
1619 return getDeepestNestingRecurse(&curwin->w_folds);
1620}
1621
1622 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001623getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624{
1625 int i;
1626 int level;
1627 int maxlevel = 0;
1628 fold_T *fp;
1629
1630 fp = (fold_T *)gap->ga_data;
1631 for (i = 0; i < gap->ga_len; ++i)
1632 {
1633 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1634 if (level > maxlevel)
1635 maxlevel = level;
1636 }
1637
1638 return maxlevel;
1639}
1640
1641/* check_closed() {{{2 */
1642/*
1643 * Check if a fold is closed and update the info needed to check nested folds.
1644 */
1645 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001646check_closed(
1647 win_T *win,
1648 fold_T *fp,
1649 int *use_levelp, /* TRUE: outer fold had FD_LEVEL */
1650 int level, /* folding depth */
1651 int *maybe_smallp, /* TRUE: outer this had fd_small == MAYBE */
1652 linenr_T lnum_off) /* line number offset for fp->fd_top */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653{
1654 int closed = FALSE;
1655
1656 /* Check if this fold is closed. If the flag is FD_LEVEL this
1657 * fold and all folds it contains depend on 'foldlevel'. */
1658 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1659 {
1660 *use_levelp = TRUE;
1661 if (level >= win->w_p_fdl)
1662 closed = TRUE;
1663 }
1664 else if (fp->fd_flags == FD_CLOSED)
1665 closed = TRUE;
1666
1667 /* Small fold isn't closed anyway. */
1668 if (fp->fd_small == MAYBE)
1669 *maybe_smallp = TRUE;
1670 if (closed)
1671 {
1672 if (*maybe_smallp)
1673 fp->fd_small = MAYBE;
1674 checkSmall(win, fp, lnum_off);
1675 if (fp->fd_small == TRUE)
1676 closed = FALSE;
1677 }
1678 return closed;
1679}
1680
1681/* checkSmall() {{{2 */
1682/*
1683 * Update fd_small field of fold "fp".
1684 */
1685 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001686checkSmall(
1687 win_T *wp,
1688 fold_T *fp,
1689 linenr_T lnum_off) /* offset for fp->fd_top */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690{
1691 int count;
1692 int n;
1693
1694 if (fp->fd_small == MAYBE)
1695 {
1696 /* Mark any nested folds to maybe-small */
1697 setSmallMaybe(&fp->fd_nested);
1698
1699 if (fp->fd_len > curwin->w_p_fml)
1700 fp->fd_small = FALSE;
1701 else
1702 {
1703 count = 0;
1704 for (n = 0; n < fp->fd_len; ++n)
1705 {
1706 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1707 if (count > curwin->w_p_fml)
1708 {
1709 fp->fd_small = FALSE;
1710 return;
1711 }
1712 }
1713 fp->fd_small = TRUE;
1714 }
1715 }
1716}
1717
1718/* setSmallMaybe() {{{2 */
1719/*
1720 * Set small flags in "gap" to MAYBE.
1721 */
1722 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001723setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724{
1725 int i;
1726 fold_T *fp;
1727
1728 fp = (fold_T *)gap->ga_data;
1729 for (i = 0; i < gap->ga_len; ++i)
1730 fp[i].fd_small = MAYBE;
1731}
1732
1733/* foldCreateMarkers() {{{2 */
1734/*
1735 * Create a fold from line "start" to line "end" (inclusive) in the current
1736 * window by adding markers.
1737 */
1738 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001739foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740{
1741 if (!curbuf->b_p_ma)
1742 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001743 emsg(_(e_modifiable));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 return;
1745 }
1746 parseMarker(curwin);
1747
1748 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1749 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1750
1751 /* Update both changes here, to avoid all folds after the start are
1752 * changed when the start marker is inserted and the end isn't. */
1753 changed_lines(start, (colnr_T)0, end, 0L);
1754}
1755
1756/* foldAddMarker() {{{2 */
1757/*
1758 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1759 */
1760 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001761foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762{
1763 char_u *cms = curbuf->b_p_cms;
1764 char_u *line;
1765 int line_len;
1766 char_u *newline;
1767 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001768 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769
1770 /* Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end */
1771 line = ml_get(lnum);
1772 line_len = (int)STRLEN(line);
1773
1774 if (u_save(lnum - 1, lnum + 1) == OK)
1775 {
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001776 /* Check if the line ends with an unclosed comment */
1777 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
Bram Moolenaar964b3742019-05-24 18:54:09 +02001778 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 if (newline == NULL)
1780 return;
1781 STRCPY(newline, line);
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001782 /* Append the marker to the end of the line */
1783 if (p == NULL || line_is_comment)
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001784 vim_strncpy(newline + line_len, marker, markerlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 else
1786 {
1787 STRCPY(newline + line_len, cms);
1788 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1789 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1790 }
1791
1792 ml_replace(lnum, newline, FALSE);
1793 }
1794}
1795
1796/* deleteFoldMarkers() {{{2 */
1797/*
1798 * Delete the markers for a fold, causing it to be deleted.
1799 */
1800 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001801deleteFoldMarkers(
1802 fold_T *fp,
1803 int recursive,
1804 linenr_T lnum_off) /* offset for fp->fd_top */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805{
1806 int i;
1807
1808 if (recursive)
1809 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1810 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1811 lnum_off + fp->fd_top);
1812 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1813 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1814 foldendmarker, foldendmarkerlen);
1815}
1816
1817/* foldDelMarker() {{{2 */
1818/*
1819 * Delete marker "marker[markerlen]" at the end of line "lnum".
1820 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001821 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 * close-marker.
1823 */
1824 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001825foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826{
1827 char_u *line;
1828 char_u *newline;
1829 char_u *p;
1830 int len;
1831 char_u *cms = curbuf->b_p_cms;
1832 char_u *cms2;
1833
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001834 // end marker may be missing and fold extends below the last line
1835 if (lnum > curbuf->b_ml.ml_line_count)
1836 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 line = ml_get(lnum);
1838 for (p = line; *p != NUL; ++p)
1839 if (STRNCMP(p, marker, markerlen) == 0)
1840 {
1841 /* Found the marker, include a digit if it's there. */
1842 len = markerlen;
1843 if (VIM_ISDIGIT(p[len]))
1844 ++len;
1845 if (*cms != NUL)
1846 {
1847 /* Also delete 'commentstring' if it matches. */
1848 cms2 = (char_u *)strstr((char *)cms, "%s");
1849 if (p - line >= cms2 - cms
1850 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1851 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1852 {
1853 p -= cms2 - cms;
1854 len += (int)STRLEN(cms) - 2;
1855 }
1856 }
1857 if (u_save(lnum - 1, lnum + 1) == OK)
1858 {
1859 /* Make new line: text-before-marker + text-after-marker */
Bram Moolenaar964b3742019-05-24 18:54:09 +02001860 newline = alloc(STRLEN(line) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 if (newline != NULL)
1862 {
1863 STRNCPY(newline, line, p - line);
1864 STRCPY(newline + (p - line), p + len);
1865 ml_replace(lnum, newline, FALSE);
1866 }
1867 }
1868 break;
1869 }
1870}
1871
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001872/* get_foldtext() {{{2 */
1873/*
1874 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001875 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1876 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001877 */
1878 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001879get_foldtext(
1880 win_T *wp,
1881 linenr_T lnum,
1882 linenr_T lnume,
1883 foldinfo_T *foldinfo,
1884 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001885{
1886 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001887#ifdef FEAT_EVAL
Bram Moolenaardab38d52013-06-15 17:06:36 +02001888 /* an error occurred when evaluating 'fdt' setting */
1889 static int got_fdt_error = FALSE;
1890 int save_did_emsg = did_emsg;
1891 static win_T *last_wp = NULL;
1892 static linenr_T last_lnum = 0;
1893
1894 if (last_wp != wp || last_wp == NULL
1895 || last_lnum > lnum || last_lnum == 0)
1896 /* window changed, try evaluating foldtext setting once again */
1897 got_fdt_error = FALSE;
1898
1899 if (!got_fdt_error)
1900 /* a previous error should not abort evaluating 'foldexpr' */
1901 did_emsg = FALSE;
1902
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001903 if (*wp->w_p_fdt != NUL)
1904 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001905 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001906 win_T *save_curwin;
1907 int level;
1908 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001909
1910 /* Set "v:foldstart" and "v:foldend". */
1911 set_vim_var_nr(VV_FOLDSTART, lnum);
1912 set_vim_var_nr(VV_FOLDEND, lnume);
1913
1914 /* Set "v:folddashes" to a string of "level" dashes. */
1915 /* Set "v:foldlevel" to "level". */
1916 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001917 if (level > (int)sizeof(dashes) - 1)
1918 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001919 vim_memset(dashes, '-', (size_t)level);
1920 dashes[level] = NUL;
1921 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1922 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001923
Bram Moolenaardab38d52013-06-15 17:06:36 +02001924 /* skip evaluating foldtext on errors */
1925 if (!got_fdt_error)
1926 {
1927 save_curwin = curwin;
1928 curwin = wp;
1929 curbuf = wp->w_buffer;
1930
1931 ++emsg_silent; /* handle exceptions, but don't display errors */
1932 text = eval_to_string_safe(wp->w_p_fdt, NULL,
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001933 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
Bram Moolenaardab38d52013-06-15 17:06:36 +02001934 --emsg_silent;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001935
Bram Moolenaardab38d52013-06-15 17:06:36 +02001936 if (text == NULL || did_emsg)
1937 got_fdt_error = TRUE;
1938
1939 curwin = save_curwin;
1940 curbuf = curwin->w_buffer;
1941 }
1942 last_lnum = lnum;
1943 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001944 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1945
Bram Moolenaardab38d52013-06-15 17:06:36 +02001946 if (!did_emsg && save_did_emsg)
1947 did_emsg = save_did_emsg;
1948
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001949 if (text != NULL)
1950 {
1951 /* Replace unprintable characters, if there are any. But
1952 * replace a TAB with a space. */
1953 for (p = text; *p != NUL; ++p)
1954 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001955 int len;
1956
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001957 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001958 {
1959 if (!vim_isprintc((*mb_ptr2char)(p)))
1960 break;
1961 p += len - 1;
1962 }
1963 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001964 if (*p == TAB)
1965 *p = ' ';
1966 else if (ptr2cells(p) > 1)
1967 break;
1968 }
1969 if (*p != NUL)
1970 {
1971 p = transstr(text);
1972 vim_free(text);
1973 text = p;
1974 }
1975 }
1976 }
1977 if (text == NULL)
1978#endif
1979 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02001980 long count = (long)(lnume - lnum + 1);
1981
1982 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01001983 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02001984 "+--%3ld lines folded ", count),
1985 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001986 text = buf;
1987 }
1988 return text;
1989}
1990
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991/* foldtext_cleanup() {{{2 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02001992#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993/*
1994 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
1995 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02001996 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001997foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998{
1999 char_u *cms_start; /* first part or the whole comment */
2000 int cms_slen = 0; /* length of cms_start */
2001 char_u *cms_end; /* last part of the comment or NULL */
2002 int cms_elen = 0; /* length of cms_end */
2003 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002004 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 int len;
2006 int did1 = FALSE;
2007 int did2 = FALSE;
2008
2009 /* Ignore leading and trailing white space in 'commentstring'. */
2010 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002011 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002012 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 --cms_slen;
2014
2015 /* locate "%s" in 'commentstring', use the part before and after it. */
2016 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2017 if (cms_end != NULL)
2018 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002019 cms_elen = cms_slen - (int)(cms_end - cms_start);
2020 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
2022 /* exclude white space before "%s" */
Bram Moolenaar1c465442017-03-12 20:10:05 +01002023 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 --cms_slen;
2025
2026 /* skip "%s" and white space after it */
2027 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002028 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 cms_end = s;
2030 }
2031 parseMarker(curwin);
2032
2033 for (s = str; *s != NUL; )
2034 {
2035 len = 0;
2036 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002040 if (len > 0)
2041 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 if (VIM_ISDIGIT(s[len]))
2043 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002044
2045 /* May remove 'commentstring' start. Useful when it's a double
2046 * quote and we already removed a double quote. */
Bram Moolenaar1c465442017-03-12 20:10:05 +01002047 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002048 ;
2049 if (p >= str + cms_slen
2050 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2051 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002052 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002053 s = p - cms_slen;
2054 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 }
2056 else if (cms_end != NULL)
2057 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002058 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 {
2060 len = cms_slen;
2061 did1 = TRUE;
2062 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002063 else if (!did2 && cms_elen > 0
2064 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 {
2066 len = cms_elen;
2067 did2 = TRUE;
2068 }
2069 }
2070 if (len != 0)
2071 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002072 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002074 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 }
2076 else
2077 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002078 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 }
2080 }
2081}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002082#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083
2084/* Folding by indent, expr, marker and syntax. {{{1 */
2085/* Define "fline_T", passed to get fold level for a line. {{{2 */
2086typedef struct
2087{
2088 win_T *wp; /* window */
2089 linenr_T lnum; /* current line number */
2090 linenr_T off; /* offset between lnum and real line number */
2091 linenr_T lnum_save; /* line nr used by foldUpdateIEMSRecurse() */
2092 int lvl; /* current level (-1 for undefined) */
2093 int lvl_next; /* level used for next line */
2094 int start; /* number of folds that are forced to start at
2095 this line. */
2096 int end; /* level of fold that is forced to end below
2097 this line */
2098 int had_end; /* level of fold that is forced to end above
2099 this line (copy of "end" of prev. line) */
2100} fline_T;
2101
2102/* Flag is set when redrawing is needed. */
2103static int fold_changed;
2104
2105/* Function declarations. {{{2 */
Bram Moolenaard99df422016-01-29 23:20:40 +01002106static linenr_T foldUpdateIEMSRecurse(garray_T *gap, int level, linenr_T startlnum, fline_T *flp, void (*getlevel)(fline_T *), linenr_T bot, int topflags);
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002107static int foldInsert(garray_T *gap, int i);
2108static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2109static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2110static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2111static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002113static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002115static void foldlevelExpr(fline_T *flp);
2116static void foldlevelMarker(fline_T *flp);
2117static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118
2119/* foldUpdateIEMS() {{{2 */
2120/*
2121 * Update the folding for window "wp", at least from lines "top" to "bot".
2122 * Return TRUE if any folds did change.
2123 */
2124 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002125foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126{
2127 linenr_T start;
2128 linenr_T end;
2129 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002130 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 int level;
2132 fold_T *fp;
2133
2134 /* Avoid problems when being called recursively. */
2135 if (invalid_top != (linenr_T)0)
2136 return;
2137
2138 if (wp->w_foldinvalid)
2139 {
2140 /* Need to update all folds. */
2141 top = 1;
2142 bot = wp->w_buffer->b_ml.ml_line_count;
2143 wp->w_foldinvalid = FALSE;
2144
2145 /* Mark all folds a maybe-small. */
2146 setSmallMaybe(&wp->w_folds);
2147 }
2148
2149#ifdef FEAT_DIFF
2150 /* add the context for "diff" folding */
2151 if (foldmethodIsDiff(wp))
2152 {
2153 if (top > diff_context)
2154 top -= diff_context;
2155 else
2156 top = 1;
2157 bot += diff_context;
2158 }
2159#endif
2160
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;
2165
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;
2174
2175 invalid_top = top;
2176 invalid_bot = bot;
2177
2178 if (foldmethodIsMarker(wp))
2179 {
2180 getlevel = foldlevelMarker;
2181
2182 /* Init marker variables to speed up foldlevelMarker(). */
2183 parseMarker(wp);
2184
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)
2188 {
2189 /* Get the fold level at top - 1. */
2190 level = foldLevelWin(wp, top - 1);
2191
2192 /* The fold may end just above the top, check for that. */
2193 fline.lnum = top - 1;
2194 fline.lvl = level;
2195 getlevel(&fline);
2196
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;
2204 }
2205 fline.lnum = top;
2206 getlevel(&fline);
2207 }
2208 else
2209 {
2210 fline.lnum = top;
2211 if (foldmethodIsExpr(wp))
2212 {
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;
2218 }
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;
2227
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)
2232 {
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;
2239 }
2240 }
2241
Bram Moolenaarec986472009-11-03 13:46:54 +00002242 /*
2243 * If folding is defined by the syntax, it is possible that a change in
2244 * one line will cause all sub-folds of the current fold to change (e.g.,
2245 * closing a C-style comment can cause folds in the subsequent lines to
2246 * appear). To take that into account we should adjust the value of "bot"
2247 * to point to the end of the current fold:
2248 */
2249 if (foldlevelSyntax == getlevel)
2250 {
2251 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002252 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002253 int current_fdl = 0;
2254 linenr_T fold_start_lnum = 0;
2255 linenr_T lnum_rel = fline.lnum;
2256
2257 while (current_fdl < fline.lvl)
2258 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002259 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002260 break;
2261 ++current_fdl;
2262
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002263 fold_start_lnum += fpn->fd_top;
2264 gap = &fpn->fd_nested;
2265 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002266 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002267 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002268 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002269 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002270
2271 if (fold_end_lnum > bot)
2272 bot = fold_end_lnum;
2273 }
2274 }
2275
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 start = fline.lnum;
2277 end = bot;
2278 /* Do at least one line. */
2279 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2280 end = start;
2281 while (!got_int)
2282 {
2283 /* Always stop at the end of the file ("end" can be past the end of
2284 * the file). */
2285 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2286 break;
2287 if (fline.lnum > end)
2288 {
2289 /* For "marker", "expr" and "syntax" methods: If a change caused
2290 * a fold to be removed, we need to continue at least until where
2291 * it ended. */
2292 if (getlevel != foldlevelMarker
2293 && getlevel != foldlevelSyntax
2294 && getlevel != foldlevelExpr)
2295 break;
2296 if ((start <= end
2297 && foldFind(&wp->w_folds, end, &fp)
2298 && fp->fd_top + fp->fd_len - 1 > end)
2299 || (fline.lvl == 0
2300 && foldFind(&wp->w_folds, fline.lnum, &fp)
2301 && fp->fd_top < fline.lnum))
2302 end = fp->fd_top + fp->fd_len - 1;
2303 else if (getlevel == foldlevelSyntax
2304 && foldLevelWin(wp, fline.lnum) != fline.lvl)
2305 /* For "syntax" method: Compare the foldlevel that the syntax
2306 * tells us to the foldlevel from the existing folds. If they
2307 * don't match continue updating folds. */
2308 end = fline.lnum;
2309 else
2310 break;
2311 }
2312
2313 /* A level 1 fold starts at a line with foldlevel > 0. */
2314 if (fline.lvl > 0)
2315 {
2316 invalid_top = fline.lnum;
2317 invalid_bot = end;
2318 end = foldUpdateIEMSRecurse(&wp->w_folds,
2319 1, start, &fline, getlevel, end, FD_LEVEL);
2320 start = fline.lnum;
2321 }
2322 else
2323 {
2324 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2325 break;
2326 ++fline.lnum;
2327 fline.lvl = fline.lvl_next;
2328 getlevel(&fline);
2329 }
2330 }
2331
2332 /* There can't be any folds from start until end now. */
2333 foldRemove(&wp->w_folds, start, end);
2334
2335 /* If some fold changed, need to redraw and position cursor. */
2336 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002337 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338
2339 /* If we updated folds past "bot", need to redraw more lines. Don't do
2340 * this in other situations, the changed lines will be redrawn anyway and
2341 * this method can cause the whole window to be updated. */
2342 if (end != bot)
2343 {
2344 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2345 wp->w_redraw_top = top;
2346 if (wp->w_redraw_bot < end)
2347 wp->w_redraw_bot = end;
2348 }
2349
2350 invalid_top = (linenr_T)0;
2351}
2352
2353/* foldUpdateIEMSRecurse() {{{2 */
2354/*
2355 * Update a fold that starts at "flp->lnum". At this line there is always a
2356 * valid foldlevel, and its level >= "level".
2357 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2358 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2359 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2360 * the marker method and a text change made following folds to change.
2361 * When returning, "flp->lnum_save" is the line number that was used to get
2362 * the level when the level at "flp->lnum" is invalid.
2363 * Remove any folds from "startlnum" up to here at this level.
2364 * Recursively update nested folds.
2365 * Below line "bot" there are no changes in the text.
2366 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2367 * outer fold.
2368 * "flp->off" is the offset to the real line number in the buffer.
2369 *
2370 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002371 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2373 *
2374 * Returns bot, which may have been increased for lines that also need to be
2375 * updated as a result of a detected change in the fold.
2376 */
2377 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002378foldUpdateIEMSRecurse(
2379 garray_T *gap,
2380 int level,
2381 linenr_T startlnum,
2382 fline_T *flp,
2383 void (*getlevel)(fline_T *),
2384 linenr_T bot,
2385 int topflags) /* flags used by containing fold */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386{
2387 linenr_T ll;
2388 fold_T *fp = NULL;
2389 fold_T *fp2;
2390 int lvl = level;
2391 linenr_T startlnum2 = startlnum;
2392 linenr_T firstlnum = flp->lnum; /* first lnum we got */
2393 int i;
2394 int finish = FALSE;
2395 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2396 int concat;
2397
2398 /*
2399 * If using the marker method, the start line is not the start of a fold
2400 * at the level we're dealing with and the level is non-zero, we must use
2401 * the previous fold. But ignore a fold that starts at or below
2402 * startlnum, it must be deleted.
2403 */
2404 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2405 && flp->lvl > 0)
2406 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002407 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 if (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2409 || fp->fd_top >= startlnum)
2410 fp = NULL;
2411 }
2412
2413 /*
2414 * Loop over all lines in this fold, or until "bot" is hit.
2415 * Handle nested folds inside of this fold.
2416 * "flp->lnum" is the current line. When finding the end of the fold, it
2417 * is just below the end of the fold.
2418 * "*flp" contains the level of the line "flp->lnum" or a following one if
2419 * there are lines with an invalid fold level. "flp->lnum_save" is the
2420 * line number that was used to get the fold level (below "flp->lnum" when
2421 * it has an invalid fold level). When called the fold level is always
2422 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2423 */
2424 flp->lnum_save = flp->lnum;
2425 while (!got_int)
2426 {
2427 /* Updating folds can be slow, check for CTRL-C. */
2428 line_breakcheck();
2429
2430 /* Set "lvl" to the level of line "flp->lnum". When flp->start is set
2431 * and after the first line of the fold, set the level to zero to
2432 * force the fold to end. Do the same when had_end is set: Previous
2433 * line was marked as end of a fold. */
2434 lvl = flp->lvl;
2435 if (lvl > MAX_LEVEL)
2436 lvl = MAX_LEVEL;
2437 if (flp->lnum > firstlnum
2438 && (level > lvl - flp->start || level >= flp->had_end))
2439 lvl = 0;
2440
2441 if (flp->lnum > bot && !finish && fp != NULL)
2442 {
2443 /* For "marker" and "syntax" methods:
2444 * - If a change caused a nested fold to be removed, we need to
2445 * delete it and continue at least until where it ended.
2446 * - If a change caused a nested fold to be created, or this fold
2447 * to continue below its original end, need to finish this fold.
2448 */
2449 if (getlevel != foldlevelMarker
2450 && getlevel != foldlevelExpr
2451 && getlevel != foldlevelSyntax)
2452 break;
2453 i = 0;
2454 fp2 = fp;
2455 if (lvl >= level)
2456 {
2457 /* Compute how deep the folds currently are, if it's deeper
2458 * than "lvl" then some must be deleted, need to update
2459 * at least one nested fold. */
2460 ll = flp->lnum - fp->fd_top;
2461 while (foldFind(&fp2->fd_nested, ll, &fp2))
2462 {
2463 ++i;
2464 ll -= fp2->fd_top;
2465 }
2466 }
2467 if (lvl < level + i)
2468 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002469 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 if (fp2 != NULL)
2471 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2472 }
2473 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2474 finish = TRUE;
2475 else
2476 break;
2477 }
2478
2479 /* At the start of the first nested fold and at the end of the current
2480 * fold: check if existing folds at this level, before the current
2481 * one, need to be deleted or truncated. */
2482 if (fp == NULL
2483 && (lvl != level
2484 || flp->lnum_save >= bot
2485 || flp->start != 0
2486 || flp->had_end <= MAX_LEVEL
2487 || flp->lnum == linecount))
2488 {
2489 /*
2490 * Remove or update folds that have lines between startlnum and
2491 * firstlnum.
2492 */
2493 while (!got_int)
2494 {
2495 /* set concat to 1 if it's allowed to concatenated this fold
2496 * with a previous one that touches it. */
2497 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2498 concat = 0;
2499 else
2500 concat = 1;
2501
2502 /* Find an existing fold to re-use. Preferably one that
2503 * includes startlnum, otherwise one that ends just before
2504 * startlnum or starts after it. */
2505 if (foldFind(gap, startlnum, &fp)
2506 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2507 && fp->fd_top <= firstlnum)
2508 || foldFind(gap, firstlnum - concat, &fp)
2509 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2510 && ((lvl < level && fp->fd_top < flp->lnum)
2511 || (lvl >= level
2512 && fp->fd_top <= flp->lnum_save))))
2513 {
2514 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2515 {
2516 /* Use existing fold for the new fold. If it starts
2517 * before where we started looking, extend it. If it
2518 * starts at another line, update nested folds to keep
2519 * their position, compensating for the new fd_top. */
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002520 if (fp->fd_top == firstlnum)
2521 {
2522 /* have found a fold beginning where we want */
2523 }
2524 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 {
2526 if (fp->fd_top > firstlnum)
2527 /* like lines are inserted */
2528 foldMarkAdjustRecurse(&fp->fd_nested,
2529 (linenr_T)0, (linenr_T)MAXLNUM,
2530 (long)(fp->fd_top - firstlnum), 0L);
2531 else
2532 /* like lines are deleted */
2533 foldMarkAdjustRecurse(&fp->fd_nested,
2534 (linenr_T)0,
2535 (long)(firstlnum - fp->fd_top - 1),
2536 (linenr_T)MAXLNUM,
2537 (long)(fp->fd_top - firstlnum));
2538 fp->fd_len += fp->fd_top - firstlnum;
2539 fp->fd_top = firstlnum;
2540 fold_changed = TRUE;
2541 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002542 else if ((flp->start != 0 && lvl == level)
2543 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002545 linenr_T breakstart;
2546 linenr_T breakend;
2547
2548 /*
2549 * Before there was a fold spanning from above
2550 * startlnum to below firstlnum. This fold is valid
2551 * above startlnum (because we are not updating
2552 * that range), but there should now be a break in
2553 * it.
2554 * If the break is because we are now forced to
2555 * start a new fold at the level "level" at line
2556 * fline->lnum, then we need to split the fold at
2557 * fline->lnum.
2558 * If the break is because the range
2559 * [startlnum, firstlnum) is now at a lower indent
2560 * than "level", we need to split the fold in this
2561 * range.
2562 * Any splits have to be done recursively.
2563 */
2564 if (firstlnum != startlnum)
2565 {
2566 breakstart = startlnum;
2567 breakend = firstlnum;
2568 }
2569 else
2570 {
2571 breakstart = flp->lnum;
2572 breakend = flp->lnum;
2573 }
2574 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2575 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002577 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002579
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 /* If using the "marker" or "syntax" method, we
2581 * need to continue until the end of the fold is
2582 * found. */
2583 if (getlevel == foldlevelMarker
2584 || getlevel == foldlevelExpr
2585 || getlevel == foldlevelSyntax)
2586 finish = TRUE;
2587 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002588
2589 if (fp->fd_top == startlnum && concat)
2590 {
2591 i = (int)(fp - (fold_T *)gap->ga_data);
2592 if (i != 0)
2593 {
2594 fp2 = fp - 1;
2595 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2596 {
2597 foldMerge(fp2, gap, fp);
2598 fp = fp2;
2599 }
2600 }
2601 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 break;
2603 }
2604 if (fp->fd_top >= startlnum)
2605 {
2606 /* A fold that starts at or after startlnum and stops
2607 * before the new fold must be deleted. Continue
2608 * looking for the next one. */
2609 deleteFoldEntry(gap,
2610 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2611 }
2612 else
2613 {
2614 /* A fold has some lines above startlnum, truncate it
2615 * to stop just above startlnum. */
2616 fp->fd_len = startlnum - fp->fd_top;
2617 foldMarkAdjustRecurse(&fp->fd_nested,
2618 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2619 (linenr_T)MAXLNUM, 0L);
2620 fold_changed = TRUE;
2621 }
2622 }
2623 else
2624 {
2625 /* Insert new fold. Careful: ga_data may be NULL and it
2626 * may change! */
2627 i = (int)(fp - (fold_T *)gap->ga_data);
2628 if (foldInsert(gap, i) != OK)
2629 return bot;
2630 fp = (fold_T *)gap->ga_data + i;
2631 /* The new fold continues until bot, unless we find the
2632 * end earlier. */
2633 fp->fd_top = firstlnum;
2634 fp->fd_len = bot - firstlnum + 1;
2635 /* When the containing fold is open, the new fold is open.
2636 * The new fold is closed if the fold above it is closed.
2637 * The first fold depends on the containing fold. */
2638 if (topflags == FD_OPEN)
2639 {
2640 flp->wp->w_fold_manual = TRUE;
2641 fp->fd_flags = FD_OPEN;
2642 }
2643 else if (i <= 0)
2644 {
2645 fp->fd_flags = topflags;
2646 if (topflags != FD_LEVEL)
2647 flp->wp->w_fold_manual = TRUE;
2648 }
2649 else
2650 fp->fd_flags = (fp - 1)->fd_flags;
2651 fp->fd_small = MAYBE;
2652 /* If using the "marker", "expr" or "syntax" method, we
2653 * need to continue until the end of the fold is found. */
2654 if (getlevel == foldlevelMarker
2655 || getlevel == foldlevelExpr
2656 || getlevel == foldlevelSyntax)
2657 finish = TRUE;
2658 fold_changed = TRUE;
2659 break;
2660 }
2661 }
2662 }
2663
2664 if (lvl < level || flp->lnum > linecount)
2665 {
2666 /*
2667 * Found a line with a lower foldlevel, this fold ends just above
2668 * "flp->lnum".
2669 */
2670 break;
2671 }
2672
2673 /*
2674 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002675 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002677 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 {
2679 /*
2680 * There is a nested fold, handle it recursively.
2681 */
2682 /* At least do one line (can happen when finish is TRUE). */
2683 if (bot < flp->lnum)
2684 bot = flp->lnum;
2685
2686 /* Line numbers in the nested fold are relative to the start of
2687 * this fold. */
2688 flp->lnum = flp->lnum_save - fp->fd_top;
2689 flp->off += fp->fd_top;
2690 i = (int)(fp - (fold_T *)gap->ga_data);
2691 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2692 startlnum2 - fp->fd_top, flp, getlevel,
2693 bot - fp->fd_top, fp->fd_flags);
2694 fp = (fold_T *)gap->ga_data + i;
2695 flp->lnum += fp->fd_top;
2696 flp->lnum_save += fp->fd_top;
2697 flp->off -= fp->fd_top;
2698 bot += fp->fd_top;
2699 startlnum2 = flp->lnum;
2700
2701 /* This fold may end at the same line, don't incr. flp->lnum. */
2702 }
2703 else
2704 {
2705 /*
2706 * Get the level of the next line, then continue the loop to check
2707 * if it ends there.
2708 * Skip over undefined lines, to find the foldlevel after it.
2709 * For the last line in the file the foldlevel is always valid.
2710 */
2711 flp->lnum = flp->lnum_save;
2712 ll = flp->lnum + 1;
2713 while (!got_int)
2714 {
2715 /* Make the previous level available to foldlevel(). */
2716 prev_lnum = flp->lnum;
2717 prev_lnum_lvl = flp->lvl;
2718
2719 if (++flp->lnum > linecount)
2720 break;
2721 flp->lvl = flp->lvl_next;
2722 getlevel(flp);
2723 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2724 break;
2725 }
2726 prev_lnum = 0;
2727 if (flp->lnum > linecount)
2728 break;
2729
2730 /* leave flp->lnum_save to lnum of the line that was used to get
2731 * the level, flp->lnum to the lnum of the next line. */
2732 flp->lnum_save = flp->lnum;
2733 flp->lnum = ll;
2734 }
2735 }
2736
2737 if (fp == NULL) /* only happens when got_int is set */
2738 return bot;
2739
2740 /*
2741 * Get here when:
2742 * lvl < level: the folds ends just above "flp->lnum"
2743 * lvl >= level: fold continues below "bot"
2744 */
2745
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002746 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 if (fp->fd_len < flp->lnum - fp->fd_top)
2748 {
2749 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002750 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 fold_changed = TRUE;
2752 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002753 else if (fp->fd_top + fp->fd_len > linecount)
2754 // running into the end of the buffer (deleted last line)
2755 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002757 // Delete contained folds from the end of the last one found until where
2758 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2760 flp->lnum - 1 - fp->fd_top);
2761
2762 if (lvl < level)
2763 {
2764 /* End of fold found, update the length when it got shorter. */
2765 if (fp->fd_len != flp->lnum - fp->fd_top)
2766 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002767 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 {
Bram Moolenaar25394022007-05-10 19:06:20 +00002769 /* fold continued below bot */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 if (getlevel == foldlevelMarker
2771 || getlevel == foldlevelExpr
2772 || getlevel == foldlevelSyntax)
2773 {
2774 /* marker method: truncate the fold and make sure the
2775 * previously included lines are processed again */
2776 bot = fp->fd_top + fp->fd_len - 1;
2777 fp->fd_len = flp->lnum - fp->fd_top;
2778 }
2779 else
2780 {
2781 /* indent or expr method: split fold to create a new one
2782 * below bot */
2783 i = (int)(fp - (fold_T *)gap->ga_data);
2784 foldSplit(gap, i, flp->lnum, bot);
2785 fp = (fold_T *)gap->ga_data + i;
2786 }
2787 }
2788 else
2789 fp->fd_len = flp->lnum - fp->fd_top;
2790 fold_changed = TRUE;
2791 }
2792 }
2793
2794 /* delete following folds that end before the current line */
2795 for (;;)
2796 {
2797 fp2 = fp + 1;
2798 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2799 || fp2->fd_top > flp->lnum)
2800 break;
2801 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2802 {
2803 if (fp2->fd_top < flp->lnum)
2804 {
2805 /* Make fold that includes lnum start at lnum. */
2806 foldMarkAdjustRecurse(&fp2->fd_nested,
2807 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2808 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2809 fp2->fd_len -= flp->lnum - fp2->fd_top;
2810 fp2->fd_top = flp->lnum;
2811 fold_changed = TRUE;
2812 }
2813
2814 if (lvl >= level)
2815 {
2816 /* merge new fold with existing fold that follows */
2817 foldMerge(fp, gap, fp2);
2818 }
2819 break;
2820 }
2821 fold_changed = TRUE;
2822 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2823 }
2824
2825 /* Need to redraw the lines we inspected, which might be further down than
2826 * was asked for. */
2827 if (bot < flp->lnum - 1)
2828 bot = flp->lnum - 1;
2829
2830 return bot;
2831}
2832
2833/* foldInsert() {{{2 */
2834/*
2835 * Insert a new fold in "gap" at position "i".
2836 * Returns OK for success, FAIL for failure.
2837 */
2838 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002839foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840{
2841 fold_T *fp;
2842
2843 if (ga_grow(gap, 1) != OK)
2844 return FAIL;
2845 fp = (fold_T *)gap->ga_data + i;
2846 if (i < gap->ga_len)
2847 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2848 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 ga_init2(&fp->fd_nested, (int)sizeof(fold_T), 10);
2850 return OK;
2851}
2852
2853/* foldSplit() {{{2 */
2854/*
2855 * Split the "i"th fold in "gap", which starts before "top" and ends below
2856 * "bot" in two pieces, one ending above "top" and the other starting below
2857 * "bot".
2858 * The caller must first have taken care of any nested folds from "top" to
2859 * "bot"!
2860 */
2861 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002862foldSplit(
2863 garray_T *gap,
2864 int i,
2865 linenr_T top,
2866 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867{
2868 fold_T *fp;
2869 fold_T *fp2;
2870 garray_T *gap1;
2871 garray_T *gap2;
2872 int idx;
2873 int len;
2874
2875 /* The fold continues below bot, need to split it. */
2876 if (foldInsert(gap, i + 1) == FAIL)
2877 return;
2878 fp = (fold_T *)gap->ga_data + i;
2879 fp[1].fd_top = bot + 1;
2880 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2881 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002882 fp[1].fd_small = MAYBE;
2883 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884
2885 /* Move nested folds below bot to new fold. There can't be
2886 * any between top and bot, they have been removed by the caller. */
2887 gap1 = &fp->fd_nested;
2888 gap2 = &fp[1].fd_nested;
2889 (void)(foldFind(gap1, bot + 1 - fp->fd_top, &fp2));
2890 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2891 if (len > 0 && ga_grow(gap2, len) == OK)
2892 {
2893 for (idx = 0; idx < len; ++idx)
2894 {
2895 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2896 ((fold_T *)gap2->ga_data)[idx].fd_top
2897 -= fp[1].fd_top - fp->fd_top;
2898 }
2899 gap2->ga_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 }
2902 fp->fd_len = top - fp->fd_top;
2903 fold_changed = TRUE;
2904}
2905
2906/* foldRemove() {{{2 */
2907/*
2908 * Remove folds within the range "top" to and including "bot".
2909 * Check for these situations:
2910 * 1 2 3
2911 * 1 2 3
2912 * top 2 3 4 5
2913 * 2 3 4 5
2914 * bot 2 3 4 5
2915 * 3 5 6
2916 * 3 5 6
2917 *
2918 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002919 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 * 3: split in two parts, one stops above "top", other starts below "bot".
2921 * 4: deleted
2922 * 5: made to start below "bot".
2923 * 6: not changed
2924 */
2925 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002926foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927{
2928 fold_T *fp = NULL;
2929
2930 if (bot < top)
2931 return; /* nothing to do */
2932
2933 for (;;)
2934 {
2935 /* Find fold that includes top or a following one. */
2936 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2937 {
2938 /* 2: or 3: need to delete nested folds */
2939 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002940 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 {
2942 /* 3: need to split it. */
2943 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2944 }
2945 else
2946 {
2947 /* 2: truncate fold at "top". */
2948 fp->fd_len = top - fp->fd_top;
2949 }
2950 fold_changed = TRUE;
2951 continue;
2952 }
2953 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2954 || fp->fd_top > bot)
2955 {
2956 /* 6: Found a fold below bot, can stop looking. */
2957 break;
2958 }
2959 if (fp->fd_top >= top)
2960 {
2961 /* Found an entry below top. */
2962 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002963 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 {
2965 /* 5: Make fold that includes bot start below bot. */
2966 foldMarkAdjustRecurse(&fp->fd_nested,
2967 (linenr_T)0, (long)(bot - fp->fd_top),
2968 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2969 fp->fd_len -= bot - fp->fd_top + 1;
2970 fp->fd_top = bot + 1;
2971 break;
2972 }
2973
2974 /* 4: Delete completely contained fold. */
2975 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
2976 }
2977 }
2978}
2979
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002980/* foldReverseOrder() {{{2 */
2981 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002982foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002983{
2984 fold_T *left, *right;
2985 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002986 linenr_T start = start_arg;
2987 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002988
2989 for (; start < end; start++, end--)
2990 {
2991 left = (fold_T *)gap->ga_data + start;
2992 right = (fold_T *)gap->ga_data + end;
2993 tmp = *left;
2994 *left = *right;
2995 *right = tmp;
2996 }
2997}
2998
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01002999/* foldMoveRange() {{{2 */
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003000/*
3001 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3002 * requires "line1" <= "line2" <= "dest"
3003 *
3004 * There are the following situations for the first fold at or below line1 - 1.
3005 * 1 2 3 4
3006 * 1 2 3 4
3007 * line1 2 3 4
3008 * 2 3 4 5 6 7
3009 * line2 3 4 5 6 7
3010 * 3 4 6 7 8 9
3011 * dest 4 7 8 9
3012 * 4 7 8 10
3013 * 4 7 8 10
3014 *
3015 * In the following descriptions, "moved" means moving in the buffer, *and* in
3016 * the fold array.
3017 * Meanwhile, "shifted" just means moving in the buffer.
3018 * 1. not changed
3019 * 2. truncated above line1
3020 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3021 * dest are truncated and shifted up
3022 * 4. internal folds moved (from [line1, line2] to dest)
3023 * 5. moved to dest.
3024 * 6. truncated below line2 and moved.
3025 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3026 * removed, top is moved down by move_len.
3027 * 8. truncated below dest and shifted up.
3028 * 9. shifted up
3029 * 10. not changed
3030 */
3031
3032 static void
3033truncate_fold(fold_T *fp, linenr_T end)
3034{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003035 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003036 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003037 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003038}
3039
3040#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
3041#define valid_fold(fp, gap) ((fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
3042#define fold_index(fp, gap) ((size_t)(fp - ((fold_T *)(gap)->ga_data)))
3043
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003044 void
3045foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003046{
3047 fold_T *fp;
3048 linenr_T range_len = line2 - line1 + 1;
3049 linenr_T move_len = dest - line2;
3050 int at_start = foldFind(gap, line1 - 1, &fp);
3051 size_t move_start = 0, move_end = 0, dest_index = 0;
3052
3053 if (at_start)
3054 {
3055 if (fold_end(fp) > dest)
3056 {
3057 /* Case 4
3058 * don't have to change this fold, but have to move nested folds.
3059 */
3060 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3061 fp->fd_top, dest - fp->fd_top);
3062 return;
3063 }
3064 else if (fold_end(fp) > line2)
3065 {
3066 /* Case 3
3067 * Remove nested folds between line1 and line2 & reduce the
3068 * length of fold by "range_len".
3069 * Folds after this one must be dealt with.
3070 */
3071 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3072 fp->fd_top, MAXLNUM, -range_len);
3073 fp->fd_len -= range_len;
3074 }
3075 else
3076 /* Case 2 truncate fold, folds after this one must be dealt with. */
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003077 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003078
3079 /* Look at the next fold, and treat that one as if it were the first
3080 * after "line1" (because now it is). */
3081 fp = fp + 1;
3082 }
3083
3084 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3085 {
3086 /* Case 10
3087 * No folds after "line1" and before "dest"
3088 */
3089 return;
3090 }
3091 else if (fp->fd_top > line2)
3092 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003093 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003094 /* Case 9. (for all case 9's) -- shift up. */
3095 fp->fd_top -= range_len;
3096
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003097 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003098 {
3099 /* Case 8. -- ensure truncated at dest, shift up */
3100 truncate_fold(fp, dest);
3101 fp->fd_top -= range_len;
3102 }
3103 return;
3104 }
3105 else if (fold_end(fp) > dest)
3106 {
3107 /* Case 7 -- remove nested folds and shrink */
3108 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3109 fp->fd_top, MAXLNUM, -move_len);
3110 fp->fd_len -= move_len;
3111 fp->fd_top += move_len;
3112 return;
3113 }
3114
3115 /* Case 5 or 6
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003116 * changes rely on whether there are folds between the end of
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003117 * this fold and "dest".
3118 */
3119 move_start = fold_index(fp, gap);
3120
3121 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3122 {
3123 if (fp->fd_top <= line2)
3124 {
3125 /* 1. 2. or 3. */
3126 if (fold_end(fp) > line2)
3127 /* 2. or 3., truncate before moving */
3128 truncate_fold(fp, line2);
3129
3130 fp->fd_top += move_len;
3131 continue;
3132 }
3133
3134 /* Record index of the first fold after the moved range. */
3135 if (move_end == 0)
3136 move_end = fold_index(fp, gap);
3137
3138 if (fold_end(fp) > dest)
3139 truncate_fold(fp, dest);
3140
3141 fp->fd_top -= range_len;
3142 }
3143
3144 dest_index = fold_index(fp, gap);
3145
3146 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003147 * All folds are now correct, but not necessarily in the correct order. We
3148 * must swap folds in the range [move_end, dest_index) with those in the
3149 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003150 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003151 if (move_end == 0)
3152 /* There are no folds after those moved, hence no folds have been moved
3153 * out of order. */
3154 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003155 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3156 foldReverseOrder(gap, (linenr_T)move_start,
3157 (linenr_T)(move_start + dest_index - move_end - 1));
3158 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3159 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003160}
3161#undef fold_end
3162#undef valid_fold
3163#undef fold_index
3164
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165/* foldMerge() {{{2 */
3166/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003167 * Merge two adjacent folds (and the nested ones in them).
3168 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 * must end just above "fp2".
3170 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3171 * Fold entry "fp2" in "gap" is deleted.
3172 */
3173 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003174foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175{
3176 fold_T *fp3;
3177 fold_T *fp4;
3178 int idx;
3179 garray_T *gap1 = &fp1->fd_nested;
3180 garray_T *gap2 = &fp2->fd_nested;
3181
3182 /* If the last nested fold in fp1 touches the first nested fold in fp2,
3183 * merge them recursively. */
3184 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3185 foldMerge(fp3, gap2, fp4);
3186
3187 /* Move nested folds in fp2 to the end of fp1. */
3188 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3189 {
3190 for (idx = 0; idx < gap2->ga_len; ++idx)
3191 {
3192 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3193 = ((fold_T *)gap2->ga_data)[idx];
3194 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3195 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 }
3197 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 }
3199
3200 fp1->fd_len += fp2->fd_len;
3201 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3202 fold_changed = TRUE;
3203}
3204
3205/* foldlevelIndent() {{{2 */
3206/*
3207 * Low level function to get the foldlevel for the "indent" method.
3208 * Doesn't use any caching.
3209 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3210 */
3211 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003212foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213{
3214 char_u *s;
3215 buf_T *buf;
3216 linenr_T lnum = flp->lnum + flp->off;
3217
3218 buf = flp->wp->w_buffer;
3219 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3220
3221 /* empty line or lines starting with a character in 'foldignore': level
3222 * depends on surrounding lines */
3223 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3224 {
3225 /* first and last line can't be undefined, use level 0 */
3226 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3227 flp->lvl = 0;
3228 else
3229 flp->lvl = -1;
3230 }
3231 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003232 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003234 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003236 if (flp->lvl < 0)
3237 flp->lvl = 0;
3238 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239}
3240
3241/* foldlevelDiff() {{{2 */
3242#ifdef FEAT_DIFF
3243/*
3244 * Low level function to get the foldlevel for the "diff" method.
3245 * Doesn't use any caching.
3246 */
3247 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003248foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249{
3250 if (diff_infold(flp->wp, flp->lnum + flp->off))
3251 flp->lvl = 1;
3252 else
3253 flp->lvl = 0;
3254}
3255#endif
3256
3257/* foldlevelExpr() {{{2 */
3258/*
3259 * Low level function to get the foldlevel for the "expr" method.
3260 * Doesn't use any caching.
3261 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3262 */
3263 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003264foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265{
3266#ifndef FEAT_EVAL
3267 flp->start = FALSE;
3268 flp->lvl = 0;
3269#else
3270 win_T *win;
3271 int n;
3272 int c;
3273 linenr_T lnum = flp->lnum + flp->off;
3274 int save_keytyped;
3275
3276 win = curwin;
3277 curwin = flp->wp;
3278 curbuf = flp->wp->w_buffer;
3279 set_vim_var_nr(VV_LNUM, lnum);
3280
3281 flp->start = 0;
3282 flp->had_end = flp->end;
3283 flp->end = MAX_LEVEL + 1;
3284 if (lnum <= 1)
3285 flp->lvl = 0;
3286
3287 /* KeyTyped may be reset to 0 when calling a function which invokes
3288 * do_cmdline(). To make 'foldopen' work correctly restore KeyTyped. */
3289 save_keytyped = KeyTyped;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003290 n = (int)eval_foldexpr(flp->wp->w_p_fde, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 KeyTyped = save_keytyped;
3292
3293 switch (c)
3294 {
3295 /* "a1", "a2", .. : add to the fold level */
3296 case 'a': if (flp->lvl >= 0)
3297 {
3298 flp->lvl += n;
3299 flp->lvl_next = flp->lvl;
3300 }
3301 flp->start = n;
3302 break;
3303
3304 /* "s1", "s2", .. : subtract from the fold level */
3305 case 's': if (flp->lvl >= 0)
3306 {
3307 if (n > flp->lvl)
3308 flp->lvl_next = 0;
3309 else
3310 flp->lvl_next = flp->lvl - n;
3311 flp->end = flp->lvl_next + 1;
3312 }
3313 break;
3314
3315 /* ">1", ">2", .. : start a fold with a certain level */
3316 case '>': flp->lvl = n;
3317 flp->lvl_next = n;
3318 flp->start = 1;
3319 break;
3320
3321 /* "<1", "<2", .. : end a fold with a certain level */
3322 case '<': flp->lvl_next = n - 1;
3323 flp->end = n;
3324 break;
3325
3326 /* "=": No change in level */
3327 case '=': flp->lvl_next = flp->lvl;
3328 break;
3329
3330 /* "-1", "0", "1", ..: set fold level */
3331 default: if (n < 0)
3332 /* Use the current level for the next line, so that "a1"
3333 * will work there. */
3334 flp->lvl_next = flp->lvl;
3335 else
3336 flp->lvl_next = n;
3337 flp->lvl = n;
3338 break;
3339 }
3340
3341 /* If the level is unknown for the first or the last line in the file, use
3342 * level 0. */
3343 if (flp->lvl < 0)
3344 {
3345 if (lnum <= 1)
3346 {
3347 flp->lvl = 0;
3348 flp->lvl_next = 0;
3349 }
3350 if (lnum == curbuf->b_ml.ml_line_count)
3351 flp->lvl_next = 0;
3352 }
3353
3354 curwin = win;
3355 curbuf = curwin->w_buffer;
3356#endif
3357}
3358
3359/* parseMarker() {{{2 */
3360/*
3361 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3362 * "foldendmarkerlen".
3363 * Relies on the option value to have been checked for correctness already.
3364 */
3365 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003366parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367{
3368 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3369 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3370 foldendmarkerlen = (int)STRLEN(foldendmarker);
3371}
3372
3373/* foldlevelMarker() {{{2 */
3374/*
3375 * Low level function to get the foldlevel for the "marker" method.
3376 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3377 * set before calling this.
3378 * Requires that flp->lvl is set to the fold level of the previous line!
3379 * Careful: This means you can't call this function twice on the same line.
3380 * Doesn't use any caching.
3381 * Sets flp->start when a start marker was found.
3382 */
3383 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003384foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385{
3386 char_u *startmarker;
3387 int cstart;
3388 int cend;
3389 int start_lvl = flp->lvl;
3390 char_u *s;
3391 int n;
3392
3393 /* cache a few values for speed */
3394 startmarker = flp->wp->w_p_fmr;
3395 cstart = *startmarker;
3396 ++startmarker;
3397 cend = *foldendmarker;
3398
3399 /* Default: no start found, next level is same as current level */
3400 flp->start = 0;
3401 flp->lvl_next = flp->lvl;
3402
3403 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3404 while (*s)
3405 {
3406 if (*s == cstart
3407 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3408 {
3409 /* found startmarker: set flp->lvl */
3410 s += foldstartmarkerlen;
3411 if (VIM_ISDIGIT(*s))
3412 {
3413 n = atoi((char *)s);
3414 if (n > 0)
3415 {
3416 flp->lvl = n;
3417 flp->lvl_next = n;
3418 if (n <= start_lvl)
3419 flp->start = 1;
3420 else
3421 flp->start = n - start_lvl;
3422 }
3423 }
3424 else
3425 {
3426 ++flp->lvl;
3427 ++flp->lvl_next;
3428 ++flp->start;
3429 }
3430 }
3431 else if (*s == cend
3432 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3433 {
3434 /* found endmarker: set flp->lvl_next */
3435 s += foldendmarkerlen;
3436 if (VIM_ISDIGIT(*s))
3437 {
3438 n = atoi((char *)s);
3439 if (n > 0)
3440 {
3441 flp->lvl = n;
3442 flp->lvl_next = n - 1;
3443 /* never start a fold with an end marker */
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003444 if (flp->lvl_next > start_lvl)
3445 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 }
3447 }
3448 else
3449 --flp->lvl_next;
3450 }
3451 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003452 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 }
3454
3455 /* The level can't go negative, must be missing a start marker. */
3456 if (flp->lvl_next < 0)
3457 flp->lvl_next = 0;
3458}
3459
3460/* foldlevelSyntax() {{{2 */
3461/*
3462 * Low level function to get the foldlevel for the "syntax" method.
3463 * Doesn't use any caching.
3464 */
3465 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003466foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467{
3468#ifndef FEAT_SYN_HL
3469 flp->start = 0;
3470 flp->lvl = 0;
3471#else
3472 linenr_T lnum = flp->lnum + flp->off;
3473 int n;
3474
3475 /* Use the maximum fold level at the start of this line and the next. */
3476 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3477 flp->start = 0;
3478 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3479 {
3480 n = syn_get_foldlevel(flp->wp, lnum + 1);
3481 if (n > flp->lvl)
3482 {
3483 flp->start = n - flp->lvl; /* fold(s) start here */
3484 flp->lvl = n;
3485 }
3486 }
3487#endif
3488}
3489
3490/* functions for storing the fold state in a View {{{1 */
3491/* put_folds() {{{2 */
3492#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003493static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3494static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3495static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496
3497/*
3498 * Write commands to "fd" to restore the manual folds in window "wp".
3499 * Return FAIL if writing fails.
3500 */
3501 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003502put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503{
3504 if (foldmethodIsManual(wp))
3505 {
3506 if (put_line(fd, "silent! normal! zE") == FAIL
3507 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL)
3508 return FAIL;
3509 }
3510
3511 /* If some folds are manually opened/closed, need to restore that. */
3512 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003513 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514
3515 return OK;
3516}
3517
3518/* put_folds_recurse() {{{2 */
3519/*
3520 * Write commands to "fd" to recreate manually created folds.
3521 * Returns FAIL when writing failed.
3522 */
3523 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003524put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525{
3526 int i;
3527 fold_T *fp;
3528
3529 fp = (fold_T *)gap->ga_data;
3530 for (i = 0; i < gap->ga_len; i++)
3531 {
3532 /* Do nested folds first, they will be created closed. */
3533 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3534 return FAIL;
3535 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3536 fp->fd_top + off + fp->fd_len - 1) < 0
3537 || put_eol(fd) == FAIL)
3538 return FAIL;
3539 ++fp;
3540 }
3541 return OK;
3542}
3543
3544/* put_foldopen_recurse() {{{2 */
3545/*
3546 * Write commands to "fd" to open and close manually opened/closed folds.
3547 * Returns FAIL when writing failed.
3548 */
3549 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003550put_foldopen_recurse(
3551 FILE *fd,
3552 win_T *wp,
3553 garray_T *gap,
3554 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555{
3556 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003557 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 fold_T *fp;
3559
3560 fp = (fold_T *)gap->ga_data;
3561 for (i = 0; i < gap->ga_len; i++)
3562 {
3563 if (fp->fd_flags != FD_LEVEL)
3564 {
3565 if (fp->fd_nested.ga_len > 0)
3566 {
Bram Moolenaard25ad652012-02-29 19:20:02 +01003567 /* open nested folds while this fold is open */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3569 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003570 || put_line(fd, "normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003572 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3573 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 == FAIL)
3575 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003576 /* close the parent when needed */
3577 if (fp->fd_flags == FD_CLOSED)
3578 {
3579 if (put_fold_open_close(fd, fp, off) == FAIL)
3580 return FAIL;
3581 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003583 else
3584 {
3585 /* Open or close the leaf according to the window foldlevel.
3586 * Do not close a leaf that is already closed, as it will close
3587 * the parent. */
3588 level = foldLevelWin(wp, off + fp->fd_top);
3589 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3590 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3591 if (put_fold_open_close(fd, fp, off) == FAIL)
3592 return FAIL;
3593 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 }
3595 ++fp;
3596 }
3597
3598 return OK;
3599}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003600
3601/* put_fold_open_close() {{{2 */
3602/*
3603 * Write the open or close command to "fd".
3604 * Returns FAIL when writing failed.
3605 */
3606 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003607put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003608{
3609 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3610 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003611 || fprintf(fd, "normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003612 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3613 || put_eol(fd) == FAIL)
3614 return FAIL;
3615
3616 return OK;
3617}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618#endif /* FEAT_SESSION */
3619
3620/* }}}1 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02003621#endif // defined(FEAT_FOLDING) || defined(PROTO)
3622
3623#if defined(FEAT_EVAL) || defined(PROTO)
3624
3625/*
3626 * "foldclosed()" and "foldclosedend()" functions
3627 */
3628 static void
3629foldclosed_both(
3630 typval_T *argvars UNUSED,
3631 typval_T *rettv,
3632 int end UNUSED)
3633{
3634# ifdef FEAT_FOLDING
3635 linenr_T lnum;
3636 linenr_T first, last;
3637
3638 lnum = tv_get_lnum(argvars);
3639 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3640 {
3641 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3642 {
3643 if (end)
3644 rettv->vval.v_number = (varnumber_T)last;
3645 else
3646 rettv->vval.v_number = (varnumber_T)first;
3647 return;
3648 }
3649 }
3650#endif
3651 rettv->vval.v_number = -1;
3652}
3653
3654/*
3655 * "foldclosed()" function
3656 */
3657 void
3658f_foldclosed(typval_T *argvars, typval_T *rettv)
3659{
3660 foldclosed_both(argvars, rettv, FALSE);
3661}
3662
3663/*
3664 * "foldclosedend()" function
3665 */
3666 void
3667f_foldclosedend(typval_T *argvars, typval_T *rettv)
3668{
3669 foldclosed_both(argvars, rettv, TRUE);
3670}
3671
3672/*
3673 * "foldlevel()" function
3674 */
3675 void
3676f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3677{
3678# ifdef FEAT_FOLDING
3679 linenr_T lnum;
3680
3681 lnum = tv_get_lnum(argvars);
3682 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3683 rettv->vval.v_number = foldLevel(lnum);
3684# endif
3685}
3686
3687/*
3688 * "foldtext()" function
3689 */
3690 void
3691f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3692{
3693# ifdef FEAT_FOLDING
3694 linenr_T foldstart;
3695 linenr_T foldend;
3696 char_u *dashes;
3697 linenr_T lnum;
3698 char_u *s;
3699 char_u *r;
3700 int len;
3701 char *txt;
3702 long count;
3703# endif
3704
3705 rettv->v_type = VAR_STRING;
3706 rettv->vval.v_string = NULL;
3707# ifdef FEAT_FOLDING
3708 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3709 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3710 dashes = get_vim_var_str(VV_FOLDDASHES);
3711 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3712 && dashes != NULL)
3713 {
3714 // Find first non-empty line in the fold.
3715 for (lnum = foldstart; lnum < foldend; ++lnum)
3716 if (!linewhite(lnum))
3717 break;
3718
3719 // Find interesting text in this line.
3720 s = skipwhite(ml_get(lnum));
3721 // skip C comment-start
3722 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3723 {
3724 s = skipwhite(s + 2);
3725 if (*skipwhite(s) == NUL
3726 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3727 {
3728 s = skipwhite(ml_get(lnum + 1));
3729 if (*s == '*')
3730 s = skipwhite(s + 1);
3731 }
3732 }
3733 count = (long)(foldend - foldstart + 1);
3734 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3735 r = alloc(STRLEN(txt)
3736 + STRLEN(dashes) // for %s
3737 + 20 // for %3ld
3738 + STRLEN(s)); // concatenated
3739 if (r != NULL)
3740 {
3741 sprintf((char *)r, txt, dashes, count);
3742 len = (int)STRLEN(r);
3743 STRCAT(r, s);
3744 // remove 'foldmarker' and 'commentstring'
3745 foldtext_cleanup(r + len);
3746 rettv->vval.v_string = r;
3747 }
3748 }
3749# endif
3750}
3751
3752/*
3753 * "foldtextresult(lnum)" function
3754 */
3755 void
3756f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3757{
3758# ifdef FEAT_FOLDING
3759 linenr_T lnum;
3760 char_u *text;
3761 char_u buf[FOLD_TEXT_LEN];
3762 foldinfo_T foldinfo;
3763 int fold_count;
3764 static int entered = FALSE;
3765# endif
3766
3767 rettv->v_type = VAR_STRING;
3768 rettv->vval.v_string = NULL;
3769# ifdef FEAT_FOLDING
3770 if (entered)
3771 return; // reject recursive use
3772 entered = TRUE;
3773
3774 lnum = tv_get_lnum(argvars);
3775 // treat illegal types and illegal string values for {lnum} the same
3776 if (lnum < 0)
3777 lnum = 0;
3778 fold_count = foldedCount(curwin, lnum, &foldinfo);
3779 if (fold_count > 0)
3780 {
3781 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3782 &foldinfo, buf);
3783 if (text == buf)
3784 text = vim_strsave(text);
3785 rettv->vval.v_string = text;
3786 }
3787
3788 entered = FALSE;
3789# endif
3790}
3791
3792#endif // FEAT_EVAL