blob: 3c106d25cfb342e0e30366248e9b4a647d486332 [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
Bram Moolenaar217e1b82019-12-01 21:41:28 +010019// local declarations. {{{1
20// typedef fold_T {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +000021/*
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{
Bram Moolenaar217e1b82019-12-01 21:41:28 +010029 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000037} fold_T;
38
Bram Moolenaar217e1b82019-12-01 21:41:28 +010039#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)
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
Bram Moolenaar217e1b82019-12-01 21:41:28 +010043#define MAX_LEVEL 20 // maximum fold depth
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
Bram Moolenaar217e1b82019-12-01 21:41:28 +010045// 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +010087// Flags used for "done" argument of setManualFold.
Bram Moolenaar071d4272004-06-13 20:20:40 +000088#define DONE_NOTHING 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010089#define DONE_ACTION 1 // did close or open a fold
90#define DONE_FOLD 2 // did find a fold
Bram Moolenaar071d4272004-06-13 20:20:40 +000091
92static int foldstartmarkerlen;
93static char_u *foldendmarker;
94static int foldendmarkerlen;
95
Bram Moolenaar217e1b82019-12-01 21:41:28 +010096// 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100110// hasAnyFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111/*
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{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100117 // very simple now, but can become more complex later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118 return (win->w_p_fen
119 && (!foldmethodIsManual(win) || win->w_folds.ga_len > 0));
120}
121
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100122// hasFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100135// hasFoldingWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136 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,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100142 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100195 // Remember lowest level of fold that starts in "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100202 // is this fold closed?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 had_folded = check_closed(win, fp, &use_level, level,
204 &maybe_small, lnum - lnum_rel);
205 if (had_folded)
206 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100207 // Fold closed: Set last and quit loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208 last += fp->fd_len - 1;
209 break;
210 }
211
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100212 // Fold found, but it's open: Check nested folds. Line number is
213 // relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100246// 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{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100254 // While updating the folds lines between invalid_top and invalid_bot have
255 // an undefined fold level. Otherwise update the folds first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100263 // Return quickly when there is no folding at all in this window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100271// lineFolded() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100284// foldedCount() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100303// foldmethodIsManual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100313// foldmethodIsIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100323// foldmethodIsExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100333// foldmethodIsMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100343// foldmethodIsSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100353// foldmethodIsDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100363// closeFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100374// closeFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100384// opFoldRange() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385/*
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,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100393 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{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100397 int done = DONE_NOTHING; // avoid error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 linenr_T lnum;
399 linenr_T lnum_next;
400
401 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
402 {
403 lnum_next = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100404 // Opening one level only: next fold to open is after the one going to
405 // be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 if (opening && !recurse)
407 (void)hasFolding(lnum, NULL, &lnum_next);
408 (void)setManualFold(lnum, opening, recurse, &done);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100409 // Closing one level only: next line to close a fold is after just
410 // closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 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 Moolenaar217e1b82019-12-01 21:41:28 +0100416 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417 if (had_visual)
418 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419}
420
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100421// openFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100432// openFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100442// foldOpenCursor() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100462// newFoldLevel() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463/*
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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100500 // 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'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100511// foldCheckClose() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512/*
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{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100518 if (*p_fcl != NUL) // can only be "all" right now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 {
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100527// checkCloseRec() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100538 // Only manually opened folds may need to be closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100555// foldCreateAllowed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556/*
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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100572// foldCreate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573/*
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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100593 // reverse the range
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 end = start_rel;
595 start = end_rel;
596 start_rel = start;
597 end_rel = end;
598 }
599
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100600 // When 'foldmethod' is "marker" add markers, which creates the folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 if (foldmethodIsMarker(curwin))
602 {
603 foldCreateMarkers(start, end);
604 return;
605 }
606
607 checkupdate(curwin);
608
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100609 // Find the place to insert the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 gap = &curwin->w_folds;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200611 if (gap->ga_len == 0)
612 i = 0;
613 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200615 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200617 if (!foldFind(gap, start_rel, &fp))
618 break;
619 if (fp->fd_top + fp->fd_len > end_rel)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200621 // New fold is completely inside this fold: Go one level
622 // deeper.
623 gap = &fp->fd_nested;
624 start_rel -= fp->fd_top;
625 end_rel -= fp->fd_top;
626 if (use_level || fp->fd_flags == FD_LEVEL)
627 {
628 use_level = TRUE;
629 if (level >= curwin->w_p_fdl)
630 closed = TRUE;
631 }
632 else if (fp->fd_flags == FD_CLOSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 closed = TRUE;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200634 ++level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 }
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200636 else
637 {
638 // This fold and new fold overlap: Insert here and move some
639 // folds inside the new fold.
640 break;
641 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 }
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200643 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 }
645
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 if (ga_grow(gap, 1) == OK)
647 {
648 fp = (fold_T *)gap->ga_data + i;
649 ga_init2(&fold_ga, (int)sizeof(fold_T), 10);
650
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100651 // Count number of folds that will be contained in the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 for (cont = 0; i + cont < gap->ga_len; ++cont)
653 if (fp[cont].fd_top > end_rel)
654 break;
655 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
656 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100657 // If the first fold starts before the new fold, let the new fold
658 // start there. Otherwise the existing fold would change.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 if (start_rel > fp->fd_top)
660 start_rel = fp->fd_top;
661
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100662 // When last contained fold isn't completely contained, adjust end
663 // of new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
665 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100666 // Move contained folds to inside new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
668 fold_ga.ga_len += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 i += cont;
670
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100671 // Adjust line numbers in contained folds to be relative to the
672 // new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 for (j = 0; j < cont; ++j)
674 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
675 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100676 // Move remaining entries to after the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 if (i < gap->ga_len)
678 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
679 sizeof(fold_T) * (gap->ga_len - i));
680 gap->ga_len = gap->ga_len + 1 - cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100682 // insert new fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 fp->fd_nested = fold_ga;
684 fp->fd_top = start_rel;
685 fp->fd_len = end_rel - start_rel + 1;
686
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100687 // We want the new fold to be closed. If it would remain open because
688 // of using 'foldlevel', need to adjust fd_flags of containing folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 if (use_level && !closed && level < curwin->w_p_fdl)
690 closeFold(start, 1L);
691 if (!use_level)
692 curwin->w_fold_manual = TRUE;
693 fp->fd_flags = FD_CLOSED;
694 fp->fd_small = MAYBE;
695
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100696 // redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 changed_window_setting();
698 }
699}
700
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100701// deleteFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702/*
703 * Delete a fold at line "start" in the current window.
704 * When "end" is not 0, delete all folds from "start" to "end".
705 * When "recursive" is TRUE delete recursively.
706 */
707 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100708deleteFold(
709 linenr_T start,
710 linenr_T end,
711 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100712 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713{
714 garray_T *gap;
715 fold_T *fp;
716 garray_T *found_ga;
717 fold_T *found_fp = NULL;
718 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000719 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 int maybe_small = FALSE;
721 int level = 0;
722 linenr_T lnum = start;
723 linenr_T lnum_off;
724 int did_one = FALSE;
725 linenr_T first_lnum = MAXLNUM;
726 linenr_T last_lnum = 0;
727
728 checkupdate(curwin);
729
730 while (lnum <= end)
731 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100732 // Find the deepest fold for "start".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 gap = &curwin->w_folds;
734 found_ga = NULL;
735 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000736 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 for (;;)
738 {
739 if (!foldFind(gap, lnum - lnum_off, &fp))
740 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100741 // lnum is inside this fold, remember info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 found_ga = gap;
743 found_fp = fp;
744 found_off = lnum_off;
745
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100746 // if "lnum" is folded, don't check nesting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 if (check_closed(curwin, fp, &use_level, level,
748 &maybe_small, lnum_off))
749 break;
750
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100751 // check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 gap = &fp->fd_nested;
753 lnum_off += fp->fd_top;
754 ++level;
755 }
756 if (found_ga == NULL)
757 {
758 ++lnum;
759 }
760 else
761 {
762 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763
764 if (foldmethodIsManual(curwin))
765 deleteFoldEntry(found_ga,
766 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
767 else
768 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000769 if (first_lnum > found_fp->fd_top + found_off)
770 first_lnum = found_fp->fd_top + found_off;
771 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000773 if (!did_one)
774 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 deleteFoldMarkers(found_fp, recursive, found_off);
776 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000777 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100779 // redraw window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 changed_window_setting();
781 }
782 }
783 if (!did_one)
784 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100785 emsg(_(e_nofold));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100786 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 if (had_visual)
788 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000790 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100791 // Deleting markers may make cursor column invalid.
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000792 check_cursor_col();
793
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 if (last_lnum > 0)
795 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
796}
797
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100798// clearFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799/*
800 * Remove all folding for window "win".
801 */
802 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100803clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804{
805 deleteFoldRecurse(&win->w_folds);
806 win->w_foldinvalid = FALSE;
807}
808
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100809// foldUpdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810/*
811 * Update folds for changes in the buffer of a window.
812 * Note that inserted/deleted lines must have already been taken care of by
813 * calling foldMarkAdjust().
814 * The changes in lines from top to bot (inclusive).
815 */
816 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100817foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818{
819 fold_T *fp;
820
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200821 if (disable_fold_update > 0)
822 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200823#ifdef FEAT_DIFF
824 if (need_diff_redraw)
825 // will update later
826 return;
827#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200828
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200829 if (wp->w_folds.ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 {
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200831 // Mark all folds from top to bot as maybe-small.
832 (void)foldFind(&wp->w_folds, top, &fp);
833 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
834 && fp->fd_top < bot)
835 {
836 fp->fd_small = MAYBE;
837 ++fp;
838 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 }
840
841 if (foldmethodIsIndent(wp)
842 || foldmethodIsExpr(wp)
843 || foldmethodIsMarker(wp)
844#ifdef FEAT_DIFF
845 || foldmethodIsDiff(wp)
846#endif
847 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000848 {
849 int save_got_int = got_int;
850
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100851 // reset got_int here, otherwise it won't work
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000852 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000854 got_int |= save_got_int;
855 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856}
857
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100858// foldUpdateAll() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859/*
860 * Update all lines in a window for folding.
861 * Used when a fold setting changes or after reloading the buffer.
862 * The actual updating is postponed until fold info is used, to avoid doing
863 * every time a setting is changed or a syntax item is added.
864 */
865 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100866foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867{
868 win->w_foldinvalid = TRUE;
869 redraw_win_later(win, NOT_VALID);
870}
871
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100872// foldMoveTo() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873/*
874 * If "updown" is FALSE: Move to the start or end of the fold.
875 * If "updown" is TRUE: move to fold at the same level.
876 * If not moved return FAIL.
877 */
878 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100879foldMoveTo(
880 int updown,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100881 int dir, // FORWARD or BACKWARD
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100882 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883{
884 long n;
885 int retval = FAIL;
886 linenr_T lnum_off;
887 linenr_T lnum_found;
888 linenr_T lnum;
889 int use_level;
890 int maybe_small;
891 garray_T *gap;
892 fold_T *fp;
893 int level;
894 int last;
895
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000896 checkupdate(curwin);
897
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100898 // Repeat "count" times.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 for (n = 0; n < count; ++n)
900 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100901 // Find nested folds. Stop when a fold is closed. The deepest fold
902 // that moves the cursor is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 lnum_off = 0;
904 gap = &curwin->w_folds;
905 use_level = FALSE;
906 maybe_small = FALSE;
907 lnum_found = curwin->w_cursor.lnum;
908 level = 0;
909 last = FALSE;
910 for (;;)
911 {
912 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
913 {
914 if (!updown)
915 break;
916
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100917 // When moving up, consider a fold above the cursor; when
918 // moving down consider a fold below the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919 if (dir == FORWARD)
920 {
921 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
922 break;
923 --fp;
924 }
925 else
926 {
927 if (fp == (fold_T *)gap->ga_data)
928 break;
929 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100930 // don't look for contained folds, they will always move
931 // the cursor too far.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 last = TRUE;
933 }
934
935 if (!last)
936 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100937 // Check if this fold is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 if (check_closed(curwin, fp, &use_level, level,
939 &maybe_small, lnum_off))
940 last = TRUE;
941
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100942 // "[z" and "]z" stop at closed fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 if (last && !updown)
944 break;
945 }
946
947 if (updown)
948 {
949 if (dir == FORWARD)
950 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100951 // to start of next fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
953 {
954 lnum = fp[1].fd_top + lnum_off;
955 if (lnum > curwin->w_cursor.lnum)
956 lnum_found = lnum;
957 }
958 }
959 else
960 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100961 // to end of previous fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 if (fp > (fold_T *)gap->ga_data)
963 {
964 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
965 if (lnum < curwin->w_cursor.lnum)
966 lnum_found = lnum;
967 }
968 }
969 }
970 else
971 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100972 // Open fold found, set cursor to its start/end and then check
973 // nested folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 if (dir == FORWARD)
975 {
976 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
977 if (lnum > curwin->w_cursor.lnum)
978 lnum_found = lnum;
979 }
980 else
981 {
982 lnum = fp->fd_top + lnum_off;
983 if (lnum < curwin->w_cursor.lnum)
984 lnum_found = lnum;
985 }
986 }
987
988 if (last)
989 break;
990
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100991 // Check nested folds (if any).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 gap = &fp->fd_nested;
993 lnum_off += fp->fd_top;
994 ++level;
995 }
996 if (lnum_found != curwin->w_cursor.lnum)
997 {
998 if (retval == FAIL)
999 setpcmark();
1000 curwin->w_cursor.lnum = lnum_found;
1001 curwin->w_cursor.col = 0;
1002 retval = OK;
1003 }
1004 else
1005 break;
1006 }
1007
1008 return retval;
1009}
1010
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001011// foldInitWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012/*
1013 * Init the fold info in a new window.
1014 */
1015 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001016foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017{
Bram Moolenaar70b2a562012-01-10 22:26:17 +01001018 ga_init2(&new_win->w_folds, (int)sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019}
1020
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001021// find_wl_entry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022/*
1023 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1024 * Only valid entries are considered (for entries where wl_valid is FALSE the
1025 * line number can be wrong).
1026 * Returns index of entry or -1 if not found.
1027 */
1028 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001029find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030{
1031 int i;
1032
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001033 for (i = 0; i < win->w_lines_valid; ++i)
1034 if (win->w_lines[i].wl_valid)
1035 {
1036 if (lnum < win->w_lines[i].wl_lnum)
1037 return -1;
1038 if (lnum <= win->w_lines[i].wl_lastlnum)
1039 return i;
1040 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 return -1;
1042}
1043
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001044// foldAdjustVisual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045/*
1046 * Adjust the Visual area to include any fold at the start or end completely.
1047 */
1048 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001049foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050{
1051 pos_T *start, *end;
1052 char_u *ptr;
1053
1054 if (!VIsual_active || !hasAnyFolding(curwin))
1055 return;
1056
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01001057 if (LTOREQ_POS(VIsual, curwin->w_cursor))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 {
1059 start = &VIsual;
1060 end = &curwin->w_cursor;
1061 }
1062 else
1063 {
1064 start = &curwin->w_cursor;
1065 end = &VIsual;
1066 }
1067 if (hasFolding(start->lnum, &start->lnum, NULL))
1068 start->col = 0;
1069 if (hasFolding(end->lnum, NULL, &end->lnum))
1070 {
1071 ptr = ml_get(end->lnum);
1072 end->col = (colnr_T)STRLEN(ptr);
1073 if (end->col > 0 && *p_sel == 'o')
1074 --end->col;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001075 // prevent cursor from moving on the trail byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 if (has_mbyte)
1077 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 }
1079}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001081// cursor_foldstart() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082/*
1083 * Move the cursor to the first line of a closed fold.
1084 */
1085 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001086foldAdjustCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087{
1088 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1089}
1090
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001091// Internal functions for "fold_T" {{{1
1092// cloneFoldGrowArray() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093/*
1094 * Will "clone" (i.e deep copy) a garray_T of folds.
1095 *
1096 * Return FAIL if the operation cannot be completed, otherwise OK.
1097 */
1098 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001099cloneFoldGrowArray(garray_T *from, garray_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100{
1101 int i;
1102 fold_T *from_p;
1103 fold_T *to_p;
1104
1105 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1106 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1107 return;
1108
1109 from_p = (fold_T *)from->ga_data;
1110 to_p = (fold_T *)to->ga_data;
1111
1112 for (i = 0; i < from->ga_len; i++)
1113 {
1114 to_p->fd_top = from_p->fd_top;
1115 to_p->fd_len = from_p->fd_len;
1116 to_p->fd_flags = from_p->fd_flags;
1117 to_p->fd_small = from_p->fd_small;
1118 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1119 ++to->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 ++from_p;
1121 ++to_p;
1122 }
1123}
1124
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001125// foldFind() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126/*
1127 * Search for line "lnum" in folds of growarray "gap".
1128 * Set *fpp to the fold struct for the fold that contains "lnum" or
1129 * the first fold below it (careful: it can be beyond the end of the array!).
1130 * Returns FALSE when there is no fold that contains "lnum".
1131 */
1132 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001133foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134{
1135 linenr_T low, high;
1136 fold_T *fp;
1137 int i;
1138
Bram Moolenaar64f37d32020-08-31 19:58:13 +02001139 if (gap->ga_len == 0)
1140 {
1141 *fpp = NULL;
1142 return FALSE;
1143 }
1144
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 /*
1146 * Perform a binary search.
1147 * "low" is lowest index of possible match.
1148 * "high" is highest index of possible match.
1149 */
1150 fp = (fold_T *)gap->ga_data;
1151 low = 0;
1152 high = gap->ga_len - 1;
1153 while (low <= high)
1154 {
1155 i = (low + high) / 2;
1156 if (fp[i].fd_top > lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001157 // fold below lnum, adjust high
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 high = i - 1;
1159 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001160 // fold above lnum, adjust low
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 low = i + 1;
1162 else
1163 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001164 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 *fpp = fp + i;
1166 return TRUE;
1167 }
1168 }
1169 *fpp = fp + low;
1170 return FALSE;
1171}
1172
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001173// foldLevelWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174/*
1175 * Return fold level at line number "lnum" in window "wp".
1176 */
1177 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001178foldLevelWin(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179{
1180 fold_T *fp;
1181 linenr_T lnum_rel = lnum;
1182 int level = 0;
1183 garray_T *gap;
1184
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001185 // Recursively search for a fold that contains "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 gap = &wp->w_folds;
1187 for (;;)
1188 {
1189 if (!foldFind(gap, lnum_rel, &fp))
1190 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001191 // Check nested folds. Line number is relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 gap = &fp->fd_nested;
1193 lnum_rel -= fp->fd_top;
1194 ++level;
1195 }
1196
1197 return level;
1198}
1199
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001200// checkupdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201/*
1202 * Check if the folds in window "wp" are invalid and update them if needed.
1203 */
1204 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001205checkupdate(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206{
1207 if (wp->w_foldinvalid)
1208 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001209 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); // will update all
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 wp->w_foldinvalid = FALSE;
1211 }
1212}
1213
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001214// setFoldRepeat() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215/*
1216 * Open or close fold for current window at line "lnum".
1217 * Repeat "count" times.
1218 */
1219 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001220setFoldRepeat(linenr_T lnum, long count, int do_open)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221{
1222 int done;
1223 long n;
1224
1225 for (n = 0; n < count; ++n)
1226 {
1227 done = DONE_NOTHING;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001228 (void)setManualFold(lnum, do_open, FALSE, &done);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 if (!(done & DONE_ACTION))
1230 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001231 // Only give an error message when no fold could be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 if (n == 0 && !(done & DONE_FOLD))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001233 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 break;
1235 }
1236 }
1237}
1238
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001239// setManualFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240/*
1241 * Open or close the fold in the current window which contains "lnum".
1242 * Also does this for other windows in diff mode when needed.
1243 */
1244 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001245setManualFold(
1246 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001247 int opening, // TRUE when opening, FALSE when closing
1248 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001249 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250{
1251#ifdef FEAT_DIFF
1252 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1253 {
1254 win_T *wp;
1255 linenr_T dlnum;
1256
1257 /*
1258 * Do the same operation in other windows in diff mode. Calculate the
1259 * line number from the diffs.
1260 */
1261 FOR_ALL_WINDOWS(wp)
1262 {
1263 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1264 {
1265 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1266 if (dlnum != 0)
1267 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1268 }
1269 }
1270 }
1271#endif
1272
1273 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1274}
1275
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001276// setManualFoldWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277/*
1278 * Open or close the fold in window "wp" which contains "lnum".
1279 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1280 * fold was found and to DONE_ACTION when some fold was opened or closed.
1281 * When "donep" is NULL give an error message when no fold was found for
1282 * "lnum", but only if "wp" is "curwin".
1283 * Return the line number of the next line that could be closed.
1284 * It's only valid when "opening" is TRUE!
1285 */
1286 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001287setManualFoldWin(
1288 win_T *wp,
1289 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001290 int opening, // TRUE when opening, FALSE when closing
1291 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001292 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293{
1294 fold_T *fp;
1295 fold_T *fp2;
1296 fold_T *found = NULL;
1297 int j;
1298 int level = 0;
1299 int use_level = FALSE;
1300 int found_fold = FALSE;
1301 garray_T *gap;
1302 linenr_T next = MAXLNUM;
1303 linenr_T off = 0;
1304 int done = 0;
1305
1306 checkupdate(wp);
1307
1308 /*
1309 * Find the fold, open or close it.
1310 */
1311 gap = &wp->w_folds;
1312 for (;;)
1313 {
1314 if (!foldFind(gap, lnum, &fp))
1315 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001316 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 if (fp < (fold_T *)gap->ga_data + gap->ga_len)
1318 next = fp->fd_top + off;
1319 break;
1320 }
1321
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001322 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 found_fold = TRUE;
1324
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001325 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1327 next = fp[1].fd_top + off;
1328
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001329 // Change from level-dependent folding to manual.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 if (use_level || fp->fd_flags == FD_LEVEL)
1331 {
1332 use_level = TRUE;
1333 if (level >= wp->w_p_fdl)
1334 fp->fd_flags = FD_CLOSED;
1335 else
1336 fp->fd_flags = FD_OPEN;
1337 fp2 = (fold_T *)fp->fd_nested.ga_data;
1338 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1339 fp2[j].fd_flags = FD_LEVEL;
1340 }
1341
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001342 // Simple case: Close recursively means closing the fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 if (!opening && recurse)
1344 {
1345 if (fp->fd_flags != FD_CLOSED)
1346 {
1347 done |= DONE_ACTION;
1348 fp->fd_flags = FD_CLOSED;
1349 }
1350 }
1351 else if (fp->fd_flags == FD_CLOSED)
1352 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001353 // When opening, open topmost closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 if (opening)
1355 {
1356 fp->fd_flags = FD_OPEN;
1357 done |= DONE_ACTION;
1358 if (recurse)
1359 foldOpenNested(fp);
1360 }
1361 break;
1362 }
1363
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001364 // fold is open, check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 found = fp;
1366 gap = &fp->fd_nested;
1367 lnum -= fp->fd_top;
1368 off += fp->fd_top;
1369 ++level;
1370 }
1371 if (found_fold)
1372 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001373 // When closing and not recurse, close deepest open fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 if (!opening && found != NULL)
1375 {
1376 found->fd_flags = FD_CLOSED;
1377 done |= DONE_ACTION;
1378 }
1379 wp->w_fold_manual = TRUE;
1380 if (done & DONE_ACTION)
1381 changed_window_setting_win(wp);
1382 done |= DONE_FOLD;
1383 }
1384 else if (donep == NULL && wp == curwin)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001385 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386
1387 if (donep != NULL)
1388 *donep |= done;
1389
1390 return next;
1391}
1392
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001393// foldOpenNested() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394/*
1395 * Open all nested folds in fold "fpr" recursively.
1396 */
1397 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001398foldOpenNested(fold_T *fpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399{
1400 int i;
1401 fold_T *fp;
1402
1403 fp = (fold_T *)fpr->fd_nested.ga_data;
1404 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1405 {
1406 foldOpenNested(&fp[i]);
1407 fp[i].fd_flags = FD_OPEN;
1408 }
1409}
1410
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001411// deleteFoldEntry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412/*
1413 * Delete fold "idx" from growarray "gap".
1414 * When "recursive" is TRUE also delete all the folds contained in it.
1415 * When "recursive" is FALSE contained folds are moved one level up.
1416 */
1417 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001418deleteFoldEntry(garray_T *gap, int idx, int recursive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419{
1420 fold_T *fp;
1421 int i;
1422 long moved;
1423 fold_T *nfp;
1424
1425 fp = (fold_T *)gap->ga_data + idx;
1426 if (recursive || fp->fd_nested.ga_len == 0)
1427 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001428 // recursively delete the contained folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 deleteFoldRecurse(&fp->fd_nested);
1430 --gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 if (idx < gap->ga_len)
1432 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1433 }
1434 else
1435 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001436 // Move nested folds one level up, to overwrite the fold that is
1437 // deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 moved = fp->fd_nested.ga_len;
1439 if (ga_grow(gap, (int)(moved - 1)) == OK)
1440 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001441 // Get "fp" again, the array may have been reallocated.
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001442 fp = (fold_T *)gap->ga_data + idx;
1443
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001444 // adjust fd_top and fd_flags for the moved folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 nfp = (fold_T *)fp->fd_nested.ga_data;
1446 for (i = 0; i < moved; ++i)
1447 {
1448 nfp[i].fd_top += fp->fd_top;
1449 if (fp->fd_flags == FD_LEVEL)
1450 nfp[i].fd_flags = FD_LEVEL;
1451 if (fp->fd_small == MAYBE)
1452 nfp[i].fd_small = MAYBE;
1453 }
1454
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001455 // move the existing folds down to make room
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001456 if (idx + 1 < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 mch_memmove(fp + moved, fp + 1,
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001458 sizeof(fold_T) * (gap->ga_len - (idx + 1)));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001459 // move the contained folds one level up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1461 vim_free(nfp);
1462 gap->ga_len += moved - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 }
1464 }
1465}
1466
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001467// deleteFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468/*
1469 * Delete nested folds in a fold.
1470 */
1471 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001472deleteFoldRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473{
1474 int i;
1475
1476 for (i = 0; i < gap->ga_len; ++i)
1477 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1478 ga_clear(gap);
1479}
1480
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001481// foldMarkAdjust() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482/*
1483 * Update line numbers of folds for inserted/deleted lines.
1484 */
1485 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001486foldMarkAdjust(
1487 win_T *wp,
1488 linenr_T line1,
1489 linenr_T line2,
1490 long amount,
1491 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001493 // If deleting marks from line1 to line2, but not deleting all those
1494 // lines, set line2 so that only deleted lines have their folds removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1496 line2 = line1 - amount_after - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001497 // If appending a line in Insert mode, it should be included in the fold
1498 // just above the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1500 --line1;
1501 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1502}
1503
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001504// foldMarkAdjustRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001506foldMarkAdjustRecurse(
1507 garray_T *gap,
1508 linenr_T line1,
1509 linenr_T line2,
1510 long amount,
1511 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512{
1513 fold_T *fp;
1514 int i;
1515 linenr_T last;
1516 linenr_T top;
1517
Bram Moolenaar07e87e92020-08-31 21:22:40 +02001518 if (gap->ga_len == 0)
1519 return;
1520
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001521 // In Insert mode an inserted line at the top of a fold is considered part
1522 // of the fold, otherwise it isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1524 top = line1 + 1;
1525 else
1526 top = line1;
1527
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001528 // Find the fold containing or just below "line1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 (void)foldFind(gap, line1, &fp);
1530
1531 /*
1532 * Adjust all folds below "line1" that are affected.
1533 */
1534 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1535 {
1536 /*
1537 * Check for these situations:
1538 * 1 2 3
1539 * 1 2 3
1540 * line1 2 3 4 5
1541 * 2 3 4 5
1542 * 2 3 4 5
1543 * line2 2 3 4 5
1544 * 3 5 6
1545 * 3 5 6
1546 */
1547
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001548 last = fp->fd_top + fp->fd_len - 1; // last line of fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001550 // 1. fold completely above line1: nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 if (last < line1)
1552 continue;
1553
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001554 // 6. fold below line2: only adjust for amount_after
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 if (fp->fd_top > line2)
1556 {
1557 if (amount_after == 0)
1558 break;
1559 fp->fd_top += amount_after;
1560 }
1561 else
1562 {
1563 if (fp->fd_top >= top && last <= line2)
1564 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001565 // 4. fold completely contained in range
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 if (amount == MAXLNUM)
1567 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001568 // Deleting lines: delete the fold completely
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 deleteFoldEntry(gap, i, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001570 --i; // adjust index for deletion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 --fp;
1572 }
1573 else
1574 fp->fd_top += amount;
1575 }
1576 else
1577 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 if (fp->fd_top < top)
1579 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001580 // 2 or 3: need to correct nested folds too
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001581 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1582 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 if (last <= line2)
1584 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001585 // 2. fold contains line1, line2 is below fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 if (amount == MAXLNUM)
1587 fp->fd_len = line1 - fp->fd_top;
1588 else
1589 fp->fd_len += amount;
1590 }
1591 else
1592 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001593 // 3. fold contains line1 and line2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 fp->fd_len += amount_after;
1595 }
1596 }
1597 else
1598 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001599 // 5. fold is below line1 and contains line2; need to
1600 // correct nested folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 if (amount == MAXLNUM)
1602 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001603 foldMarkAdjustRecurse(&fp->fd_nested,
1604 line1 - fp->fd_top,
1605 line2 - fp->fd_top,
1606 amount,
1607 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 fp->fd_len -= line2 - fp->fd_top + 1;
1609 fp->fd_top = line1;
1610 }
1611 else
1612 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001613 foldMarkAdjustRecurse(&fp->fd_nested,
1614 line1 - fp->fd_top,
1615 line2 - fp->fd_top,
1616 amount,
1617 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 fp->fd_len += amount_after - amount;
1619 fp->fd_top += amount;
1620 }
1621 }
1622 }
1623 }
1624 }
1625}
1626
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001627// getDeepestNesting() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628/*
1629 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1630 * current window open.
1631 */
1632 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001633getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634{
1635 checkupdate(curwin);
1636 return getDeepestNestingRecurse(&curwin->w_folds);
1637}
1638
1639 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001640getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641{
1642 int i;
1643 int level;
1644 int maxlevel = 0;
1645 fold_T *fp;
1646
1647 fp = (fold_T *)gap->ga_data;
1648 for (i = 0; i < gap->ga_len; ++i)
1649 {
1650 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1651 if (level > maxlevel)
1652 maxlevel = level;
1653 }
1654
1655 return maxlevel;
1656}
1657
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001658// check_closed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659/*
1660 * Check if a fold is closed and update the info needed to check nested folds.
1661 */
1662 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001663check_closed(
1664 win_T *win,
1665 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001666 int *use_levelp, // TRUE: outer fold had FD_LEVEL
1667 int level, // folding depth
1668 int *maybe_smallp, // TRUE: outer this had fd_small == MAYBE
1669 linenr_T lnum_off) // line number offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670{
1671 int closed = FALSE;
1672
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001673 // Check if this fold is closed. If the flag is FD_LEVEL this
1674 // fold and all folds it contains depend on 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1676 {
1677 *use_levelp = TRUE;
1678 if (level >= win->w_p_fdl)
1679 closed = TRUE;
1680 }
1681 else if (fp->fd_flags == FD_CLOSED)
1682 closed = TRUE;
1683
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001684 // Small fold isn't closed anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 if (fp->fd_small == MAYBE)
1686 *maybe_smallp = TRUE;
1687 if (closed)
1688 {
1689 if (*maybe_smallp)
1690 fp->fd_small = MAYBE;
1691 checkSmall(win, fp, lnum_off);
1692 if (fp->fd_small == TRUE)
1693 closed = FALSE;
1694 }
1695 return closed;
1696}
1697
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001698// checkSmall() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699/*
1700 * Update fd_small field of fold "fp".
1701 */
1702 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001703checkSmall(
1704 win_T *wp,
1705 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001706 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707{
1708 int count;
1709 int n;
1710
1711 if (fp->fd_small == MAYBE)
1712 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001713 // Mark any nested folds to maybe-small
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 setSmallMaybe(&fp->fd_nested);
1715
1716 if (fp->fd_len > curwin->w_p_fml)
1717 fp->fd_small = FALSE;
1718 else
1719 {
1720 count = 0;
1721 for (n = 0; n < fp->fd_len; ++n)
1722 {
1723 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1724 if (count > curwin->w_p_fml)
1725 {
1726 fp->fd_small = FALSE;
1727 return;
1728 }
1729 }
1730 fp->fd_small = TRUE;
1731 }
1732 }
1733}
1734
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001735// setSmallMaybe() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736/*
1737 * Set small flags in "gap" to MAYBE.
1738 */
1739 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001740setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741{
1742 int i;
1743 fold_T *fp;
1744
1745 fp = (fold_T *)gap->ga_data;
1746 for (i = 0; i < gap->ga_len; ++i)
1747 fp[i].fd_small = MAYBE;
1748}
1749
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001750// foldCreateMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751/*
1752 * Create a fold from line "start" to line "end" (inclusive) in the current
1753 * window by adding markers.
1754 */
1755 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001756foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757{
1758 if (!curbuf->b_p_ma)
1759 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001760 emsg(_(e_modifiable));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 return;
1762 }
1763 parseMarker(curwin);
1764
1765 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1766 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1767
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001768 // Update both changes here, to avoid all folds after the start are
1769 // changed when the start marker is inserted and the end isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 changed_lines(start, (colnr_T)0, end, 0L);
1771}
1772
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001773// foldAddMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774/*
1775 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1776 */
1777 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001778foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779{
1780 char_u *cms = curbuf->b_p_cms;
1781 char_u *line;
1782 int line_len;
1783 char_u *newline;
1784 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001785 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001787 // Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 line = ml_get(lnum);
1789 line_len = (int)STRLEN(line);
1790
1791 if (u_save(lnum - 1, lnum + 1) == OK)
1792 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001793 // Check if the line ends with an unclosed comment
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001794 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
Bram Moolenaar964b3742019-05-24 18:54:09 +02001795 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 if (newline == NULL)
1797 return;
1798 STRCPY(newline, line);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001799 // Append the marker to the end of the line
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001800 if (p == NULL || line_is_comment)
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001801 vim_strncpy(newline + line_len, marker, markerlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 else
1803 {
1804 STRCPY(newline + line_len, cms);
1805 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1806 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1807 }
1808
1809 ml_replace(lnum, newline, FALSE);
1810 }
1811}
1812
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001813// deleteFoldMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814/*
1815 * Delete the markers for a fold, causing it to be deleted.
1816 */
1817 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001818deleteFoldMarkers(
1819 fold_T *fp,
1820 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001821 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822{
1823 int i;
1824
1825 if (recursive)
1826 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1827 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1828 lnum_off + fp->fd_top);
1829 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1830 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1831 foldendmarker, foldendmarkerlen);
1832}
1833
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001834// foldDelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835/*
1836 * Delete marker "marker[markerlen]" at the end of line "lnum".
1837 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001838 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 * close-marker.
1840 */
1841 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001842foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843{
1844 char_u *line;
1845 char_u *newline;
1846 char_u *p;
1847 int len;
1848 char_u *cms = curbuf->b_p_cms;
1849 char_u *cms2;
1850
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001851 // end marker may be missing and fold extends below the last line
1852 if (lnum > curbuf->b_ml.ml_line_count)
1853 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 line = ml_get(lnum);
1855 for (p = line; *p != NUL; ++p)
1856 if (STRNCMP(p, marker, markerlen) == 0)
1857 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001858 // Found the marker, include a digit if it's there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 len = markerlen;
1860 if (VIM_ISDIGIT(p[len]))
1861 ++len;
1862 if (*cms != NUL)
1863 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001864 // Also delete 'commentstring' if it matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 cms2 = (char_u *)strstr((char *)cms, "%s");
1866 if (p - line >= cms2 - cms
1867 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1868 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1869 {
1870 p -= cms2 - cms;
1871 len += (int)STRLEN(cms) - 2;
1872 }
1873 }
1874 if (u_save(lnum - 1, lnum + 1) == OK)
1875 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001876 // Make new line: text-before-marker + text-after-marker
Bram Moolenaar964b3742019-05-24 18:54:09 +02001877 newline = alloc(STRLEN(line) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 if (newline != NULL)
1879 {
1880 STRNCPY(newline, line, p - line);
1881 STRCPY(newline + (p - line), p + len);
1882 ml_replace(lnum, newline, FALSE);
1883 }
1884 }
1885 break;
1886 }
1887}
1888
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001889// get_foldtext() {{{2
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001890/*
1891 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001892 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1893 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001894 */
1895 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001896get_foldtext(
1897 win_T *wp,
1898 linenr_T lnum,
1899 linenr_T lnume,
1900 foldinfo_T *foldinfo,
1901 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001902{
1903 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001904#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001905 // an error occurred when evaluating 'fdt' setting
Bram Moolenaardab38d52013-06-15 17:06:36 +02001906 static int got_fdt_error = FALSE;
1907 int save_did_emsg = did_emsg;
1908 static win_T *last_wp = NULL;
1909 static linenr_T last_lnum = 0;
1910
1911 if (last_wp != wp || last_wp == NULL
1912 || last_lnum > lnum || last_lnum == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001913 // window changed, try evaluating foldtext setting once again
Bram Moolenaardab38d52013-06-15 17:06:36 +02001914 got_fdt_error = FALSE;
1915
1916 if (!got_fdt_error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001917 // a previous error should not abort evaluating 'foldexpr'
Bram Moolenaardab38d52013-06-15 17:06:36 +02001918 did_emsg = FALSE;
1919
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001920 if (*wp->w_p_fdt != NUL)
1921 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001922 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001923 win_T *save_curwin;
1924 int level;
1925 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001926
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001927 // Set "v:foldstart" and "v:foldend".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001928 set_vim_var_nr(VV_FOLDSTART, lnum);
1929 set_vim_var_nr(VV_FOLDEND, lnume);
1930
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001931 // Set "v:folddashes" to a string of "level" dashes.
1932 // Set "v:foldlevel" to "level".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001933 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001934 if (level > (int)sizeof(dashes) - 1)
1935 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001936 vim_memset(dashes, '-', (size_t)level);
1937 dashes[level] = NUL;
1938 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1939 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001940
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001941 // skip evaluating foldtext on errors
Bram Moolenaardab38d52013-06-15 17:06:36 +02001942 if (!got_fdt_error)
1943 {
1944 save_curwin = curwin;
1945 curwin = wp;
1946 curbuf = wp->w_buffer;
1947
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001948 ++emsg_silent; // handle exceptions, but don't display errors
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001949 text = eval_to_string_safe(wp->w_p_fdt,
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001950 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
Bram Moolenaardab38d52013-06-15 17:06:36 +02001951 --emsg_silent;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001952
Bram Moolenaardab38d52013-06-15 17:06:36 +02001953 if (text == NULL || did_emsg)
1954 got_fdt_error = TRUE;
1955
1956 curwin = save_curwin;
1957 curbuf = curwin->w_buffer;
1958 }
1959 last_lnum = lnum;
1960 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001961 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1962
Bram Moolenaardab38d52013-06-15 17:06:36 +02001963 if (!did_emsg && save_did_emsg)
1964 did_emsg = save_did_emsg;
1965
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001966 if (text != NULL)
1967 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001968 // Replace unprintable characters, if there are any. But
1969 // replace a TAB with a space.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001970 for (p = text; *p != NUL; ++p)
1971 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001972 int len;
1973
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001974 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001975 {
1976 if (!vim_isprintc((*mb_ptr2char)(p)))
1977 break;
1978 p += len - 1;
1979 }
1980 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001981 if (*p == TAB)
1982 *p = ' ';
1983 else if (ptr2cells(p) > 1)
1984 break;
1985 }
1986 if (*p != NUL)
1987 {
1988 p = transstr(text);
1989 vim_free(text);
1990 text = p;
1991 }
1992 }
1993 }
1994 if (text == NULL)
1995#endif
1996 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02001997 long count = (long)(lnume - lnum + 1);
1998
1999 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01002000 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02002001 "+--%3ld lines folded ", count),
2002 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002003 text = buf;
2004 }
2005 return text;
2006}
2007
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002008// foldtext_cleanup() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +02002009#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010/*
2011 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2012 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02002013 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002014foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002016 char_u *cms_start; // first part or the whole comment
2017 int cms_slen = 0; // length of cms_start
2018 char_u *cms_end; // last part of the comment or NULL
2019 int cms_elen = 0; // length of cms_end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002021 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 int len;
2023 int did1 = FALSE;
2024 int did2 = FALSE;
2025
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002026 // Ignore leading and trailing white space in 'commentstring'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002028 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002029 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 --cms_slen;
2031
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002032 // locate "%s" in 'commentstring', use the part before and after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2034 if (cms_end != NULL)
2035 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002036 cms_elen = cms_slen - (int)(cms_end - cms_start);
2037 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002039 // exclude white space before "%s"
Bram Moolenaar1c465442017-03-12 20:10:05 +01002040 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 --cms_slen;
2042
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002043 // skip "%s" and white space after it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002045 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 cms_end = s;
2047 }
2048 parseMarker(curwin);
2049
2050 for (s = str; *s != NUL; )
2051 {
2052 len = 0;
2053 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002057 if (len > 0)
2058 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 if (VIM_ISDIGIT(s[len]))
2060 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002061
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002062 // May remove 'commentstring' start. Useful when it's a double
2063 // quote and we already removed a double quote.
Bram Moolenaar1c465442017-03-12 20:10:05 +01002064 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002065 ;
2066 if (p >= str + cms_slen
2067 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2068 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002069 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002070 s = p - cms_slen;
2071 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 }
2073 else if (cms_end != NULL)
2074 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002075 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 {
2077 len = cms_slen;
2078 did1 = TRUE;
2079 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002080 else if (!did2 && cms_elen > 0
2081 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 {
2083 len = cms_elen;
2084 did2 = TRUE;
2085 }
2086 }
2087 if (len != 0)
2088 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002089 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002091 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 }
2093 else
2094 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002095 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 }
2097 }
2098}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002099#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002101// Folding by indent, expr, marker and syntax. {{{1
2102// Define "fline_T", passed to get fold level for a line. {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103typedef struct
2104{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002105 win_T *wp; // window
2106 linenr_T lnum; // current line number
2107 linenr_T off; // offset between lnum and real line number
2108 linenr_T lnum_save; // line nr used by foldUpdateIEMSRecurse()
2109 int lvl; // current level (-1 for undefined)
2110 int lvl_next; // level used for next line
2111 int start; // number of folds that are forced to start at
2112 // this line.
2113 int end; // level of fold that is forced to end below
2114 // this line
2115 int had_end; // level of fold that is forced to end above
2116 // this line (copy of "end" of prev. line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117} fline_T;
2118
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002119// Flag is set when redrawing is needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120static int fold_changed;
2121
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002122// Function declarations. {{{2
Bram Moolenaard99df422016-01-29 23:20:40 +01002123static 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 +01002124static int foldInsert(garray_T *gap, int i);
2125static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2126static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2127static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2128static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002130static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002132static void foldlevelExpr(fline_T *flp);
2133static void foldlevelMarker(fline_T *flp);
2134static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002136// foldUpdateIEMS() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137/*
2138 * Update the folding for window "wp", at least from lines "top" to "bot".
2139 * Return TRUE if any folds did change.
2140 */
2141 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002142foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143{
2144 linenr_T start;
2145 linenr_T end;
2146 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002147 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 int level;
2149 fold_T *fp;
2150
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002151 // Avoid problems when being called recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 if (invalid_top != (linenr_T)0)
2153 return;
2154
2155 if (wp->w_foldinvalid)
2156 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002157 // Need to update all folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 top = 1;
2159 bot = wp->w_buffer->b_ml.ml_line_count;
2160 wp->w_foldinvalid = FALSE;
2161
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002162 // Mark all folds a maybe-small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 setSmallMaybe(&wp->w_folds);
2164 }
2165
2166#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002167 // add the context for "diff" folding
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 if (foldmethodIsDiff(wp))
2169 {
2170 if (top > diff_context)
2171 top -= diff_context;
2172 else
2173 top = 1;
2174 bot += diff_context;
2175 }
2176#endif
2177
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002178 // When deleting lines at the end of the buffer "top" can be past the end
2179 // of the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 if (top > wp->w_buffer->b_ml.ml_line_count)
2181 top = wp->w_buffer->b_ml.ml_line_count;
2182
2183 fold_changed = FALSE;
2184 fline.wp = wp;
2185 fline.off = 0;
2186 fline.lvl = 0;
2187 fline.lvl_next = -1;
2188 fline.start = 0;
2189 fline.end = MAX_LEVEL + 1;
2190 fline.had_end = MAX_LEVEL + 1;
2191
2192 invalid_top = top;
2193 invalid_bot = bot;
2194
2195 if (foldmethodIsMarker(wp))
2196 {
2197 getlevel = foldlevelMarker;
2198
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002199 // Init marker variables to speed up foldlevelMarker().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 parseMarker(wp);
2201
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002202 // Need to get the level of the line above top, it is used if there is
2203 // no marker at the top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 if (top > 1)
2205 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002206 // Get the fold level at top - 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 level = foldLevelWin(wp, top - 1);
2208
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002209 // The fold may end just above the top, check for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 fline.lnum = top - 1;
2211 fline.lvl = level;
2212 getlevel(&fline);
2213
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002214 // If a fold started here, we already had the level, if it stops
2215 // here, we need to use lvl_next. Could also start and end a fold
2216 // in the same line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 if (fline.lvl > level)
2218 fline.lvl = level - (fline.lvl - fline.lvl_next);
2219 else
2220 fline.lvl = fline.lvl_next;
2221 }
2222 fline.lnum = top;
2223 getlevel(&fline);
2224 }
2225 else
2226 {
2227 fline.lnum = top;
2228 if (foldmethodIsExpr(wp))
2229 {
2230 getlevel = foldlevelExpr;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002231 // start one line back, because a "<1" may indicate the end of a
2232 // fold in the topline
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 if (top > 1)
2234 --fline.lnum;
2235 }
2236 else if (foldmethodIsSyntax(wp))
2237 getlevel = foldlevelSyntax;
2238#ifdef FEAT_DIFF
2239 else if (foldmethodIsDiff(wp))
2240 getlevel = foldlevelDiff;
2241#endif
2242 else
2243 getlevel = foldlevelIndent;
2244
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002245 // Backup to a line for which the fold level is defined. Since it's
2246 // always defined for line one, we will stop there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 fline.lvl = -1;
2248 for ( ; !got_int; --fline.lnum)
2249 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002250 // Reset lvl_next each time, because it will be set to a value for
2251 // the next line, but we search backwards here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 fline.lvl_next = -1;
2253 getlevel(&fline);
2254 if (fline.lvl >= 0)
2255 break;
2256 }
2257 }
2258
Bram Moolenaarec986472009-11-03 13:46:54 +00002259 /*
2260 * If folding is defined by the syntax, it is possible that a change in
2261 * one line will cause all sub-folds of the current fold to change (e.g.,
2262 * closing a C-style comment can cause folds in the subsequent lines to
2263 * appear). To take that into account we should adjust the value of "bot"
2264 * to point to the end of the current fold:
2265 */
2266 if (foldlevelSyntax == getlevel)
2267 {
2268 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002269 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002270 int current_fdl = 0;
2271 linenr_T fold_start_lnum = 0;
2272 linenr_T lnum_rel = fline.lnum;
2273
2274 while (current_fdl < fline.lvl)
2275 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002276 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002277 break;
2278 ++current_fdl;
2279
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002280 fold_start_lnum += fpn->fd_top;
2281 gap = &fpn->fd_nested;
2282 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002283 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002284 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002285 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002286 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002287
2288 if (fold_end_lnum > bot)
2289 bot = fold_end_lnum;
2290 }
2291 }
2292
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 start = fline.lnum;
2294 end = bot;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002295 // Do at least one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2297 end = start;
2298 while (!got_int)
2299 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002300 // Always stop at the end of the file ("end" can be past the end of
2301 // the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2303 break;
2304 if (fline.lnum > end)
2305 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002306 // For "marker", "expr" and "syntax" methods: If a change caused
2307 // a fold to be removed, we need to continue at least until where
2308 // it ended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 if (getlevel != foldlevelMarker
2310 && getlevel != foldlevelSyntax
2311 && getlevel != foldlevelExpr)
2312 break;
2313 if ((start <= end
2314 && foldFind(&wp->w_folds, end, &fp)
2315 && fp->fd_top + fp->fd_len - 1 > end)
2316 || (fline.lvl == 0
2317 && foldFind(&wp->w_folds, fline.lnum, &fp)
2318 && fp->fd_top < fline.lnum))
2319 end = fp->fd_top + fp->fd_len - 1;
2320 else if (getlevel == foldlevelSyntax
2321 && foldLevelWin(wp, fline.lnum) != fline.lvl)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002322 // For "syntax" method: Compare the foldlevel that the syntax
2323 // tells us to the foldlevel from the existing folds. If they
2324 // don't match continue updating folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 end = fline.lnum;
2326 else
2327 break;
2328 }
2329
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002330 // A level 1 fold starts at a line with foldlevel > 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 if (fline.lvl > 0)
2332 {
2333 invalid_top = fline.lnum;
2334 invalid_bot = end;
2335 end = foldUpdateIEMSRecurse(&wp->w_folds,
2336 1, start, &fline, getlevel, end, FD_LEVEL);
2337 start = fline.lnum;
2338 }
2339 else
2340 {
2341 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2342 break;
2343 ++fline.lnum;
2344 fline.lvl = fline.lvl_next;
2345 getlevel(&fline);
2346 }
2347 }
2348
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002349 // There can't be any folds from start until end now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 foldRemove(&wp->w_folds, start, end);
2351
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002352 // If some fold changed, need to redraw and position cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002354 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002356 // If we updated folds past "bot", need to redraw more lines. Don't do
2357 // this in other situations, the changed lines will be redrawn anyway and
2358 // this method can cause the whole window to be updated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 if (end != bot)
2360 {
2361 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2362 wp->w_redraw_top = top;
2363 if (wp->w_redraw_bot < end)
2364 wp->w_redraw_bot = end;
2365 }
2366
2367 invalid_top = (linenr_T)0;
2368}
2369
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002370// foldUpdateIEMSRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371/*
2372 * Update a fold that starts at "flp->lnum". At this line there is always a
2373 * valid foldlevel, and its level >= "level".
2374 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2375 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2376 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2377 * the marker method and a text change made following folds to change.
2378 * When returning, "flp->lnum_save" is the line number that was used to get
2379 * the level when the level at "flp->lnum" is invalid.
2380 * Remove any folds from "startlnum" up to here at this level.
2381 * Recursively update nested folds.
2382 * Below line "bot" there are no changes in the text.
2383 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2384 * outer fold.
2385 * "flp->off" is the offset to the real line number in the buffer.
2386 *
2387 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002388 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2390 *
2391 * Returns bot, which may have been increased for lines that also need to be
2392 * updated as a result of a detected change in the fold.
2393 */
2394 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002395foldUpdateIEMSRecurse(
2396 garray_T *gap,
2397 int level,
2398 linenr_T startlnum,
2399 fline_T *flp,
2400 void (*getlevel)(fline_T *),
2401 linenr_T bot,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002402 int topflags) // flags used by containing fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403{
2404 linenr_T ll;
2405 fold_T *fp = NULL;
2406 fold_T *fp2;
2407 int lvl = level;
2408 linenr_T startlnum2 = startlnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002409 linenr_T firstlnum = flp->lnum; // first lnum we got
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 int i;
2411 int finish = FALSE;
2412 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2413 int concat;
2414
2415 /*
2416 * If using the marker method, the start line is not the start of a fold
2417 * at the level we're dealing with and the level is non-zero, we must use
2418 * the previous fold. But ignore a fold that starts at or below
2419 * startlnum, it must be deleted.
2420 */
2421 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2422 && flp->lvl > 0)
2423 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002424 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 if (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2426 || fp->fd_top >= startlnum)
2427 fp = NULL;
2428 }
2429
2430 /*
2431 * Loop over all lines in this fold, or until "bot" is hit.
2432 * Handle nested folds inside of this fold.
2433 * "flp->lnum" is the current line. When finding the end of the fold, it
2434 * is just below the end of the fold.
2435 * "*flp" contains the level of the line "flp->lnum" or a following one if
2436 * there are lines with an invalid fold level. "flp->lnum_save" is the
2437 * line number that was used to get the fold level (below "flp->lnum" when
2438 * it has an invalid fold level). When called the fold level is always
2439 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2440 */
2441 flp->lnum_save = flp->lnum;
2442 while (!got_int)
2443 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002444 // Updating folds can be slow, check for CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 line_breakcheck();
2446
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002447 // Set "lvl" to the level of line "flp->lnum". When flp->start is set
2448 // and after the first line of the fold, set the level to zero to
2449 // force the fold to end. Do the same when had_end is set: Previous
2450 // line was marked as end of a fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 lvl = flp->lvl;
2452 if (lvl > MAX_LEVEL)
2453 lvl = MAX_LEVEL;
2454 if (flp->lnum > firstlnum
2455 && (level > lvl - flp->start || level >= flp->had_end))
2456 lvl = 0;
2457
2458 if (flp->lnum > bot && !finish && fp != NULL)
2459 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002460 // For "marker" and "syntax" methods:
2461 // - If a change caused a nested fold to be removed, we need to
2462 // delete it and continue at least until where it ended.
2463 // - If a change caused a nested fold to be created, or this fold
2464 // to continue below its original end, need to finish this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 if (getlevel != foldlevelMarker
2466 && getlevel != foldlevelExpr
2467 && getlevel != foldlevelSyntax)
2468 break;
2469 i = 0;
2470 fp2 = fp;
2471 if (lvl >= level)
2472 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002473 // Compute how deep the folds currently are, if it's deeper
2474 // than "lvl" then some must be deleted, need to update
2475 // at least one nested fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 ll = flp->lnum - fp->fd_top;
2477 while (foldFind(&fp2->fd_nested, ll, &fp2))
2478 {
2479 ++i;
2480 ll -= fp2->fd_top;
2481 }
2482 }
2483 if (lvl < level + i)
2484 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002485 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 if (fp2 != NULL)
2487 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2488 }
2489 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2490 finish = TRUE;
2491 else
2492 break;
2493 }
2494
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002495 // At the start of the first nested fold and at the end of the current
2496 // fold: check if existing folds at this level, before the current
2497 // one, need to be deleted or truncated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 if (fp == NULL
2499 && (lvl != level
2500 || flp->lnum_save >= bot
2501 || flp->start != 0
2502 || flp->had_end <= MAX_LEVEL
2503 || flp->lnum == linecount))
2504 {
2505 /*
2506 * Remove or update folds that have lines between startlnum and
2507 * firstlnum.
2508 */
2509 while (!got_int)
2510 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002511 // set concat to 1 if it's allowed to concatenated this fold
2512 // with a previous one that touches it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2514 concat = 0;
2515 else
2516 concat = 1;
2517
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002518 // Find an existing fold to re-use. Preferably one that
2519 // includes startlnum, otherwise one that ends just before
2520 // startlnum or starts after it.
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002521 if (gap->ga_len > 0 && (foldFind(gap, startlnum, &fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2523 && fp->fd_top <= firstlnum)
2524 || foldFind(gap, firstlnum - concat, &fp)
2525 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2526 && ((lvl < level && fp->fd_top < flp->lnum)
2527 || (lvl >= level
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002528 && fp->fd_top <= flp->lnum_save)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 {
2530 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2531 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002532 // Use existing fold for the new fold. If it starts
2533 // before where we started looking, extend it. If it
2534 // starts at another line, update nested folds to keep
2535 // their position, compensating for the new fd_top.
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002536 if (fp->fd_top == firstlnum)
2537 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002538 // have found a fold beginning where we want
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002539 }
2540 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 {
2542 if (fp->fd_top > firstlnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002543 // like lines are inserted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 foldMarkAdjustRecurse(&fp->fd_nested,
2545 (linenr_T)0, (linenr_T)MAXLNUM,
2546 (long)(fp->fd_top - firstlnum), 0L);
2547 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002548 // like lines are deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 foldMarkAdjustRecurse(&fp->fd_nested,
2550 (linenr_T)0,
2551 (long)(firstlnum - fp->fd_top - 1),
2552 (linenr_T)MAXLNUM,
2553 (long)(fp->fd_top - firstlnum));
2554 fp->fd_len += fp->fd_top - firstlnum;
2555 fp->fd_top = firstlnum;
2556 fold_changed = TRUE;
2557 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002558 else if ((flp->start != 0 && lvl == level)
2559 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002561 linenr_T breakstart;
2562 linenr_T breakend;
2563
2564 /*
2565 * Before there was a fold spanning from above
2566 * startlnum to below firstlnum. This fold is valid
2567 * above startlnum (because we are not updating
2568 * that range), but there should now be a break in
2569 * it.
2570 * If the break is because we are now forced to
2571 * start a new fold at the level "level" at line
2572 * fline->lnum, then we need to split the fold at
2573 * fline->lnum.
2574 * If the break is because the range
2575 * [startlnum, firstlnum) is now at a lower indent
2576 * than "level", we need to split the fold in this
2577 * range.
2578 * Any splits have to be done recursively.
2579 */
2580 if (firstlnum != startlnum)
2581 {
2582 breakstart = startlnum;
2583 breakend = firstlnum;
2584 }
2585 else
2586 {
2587 breakstart = flp->lnum;
2588 breakend = flp->lnum;
2589 }
2590 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2591 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002593 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002595
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002596 // If using the "marker" or "syntax" method, we
2597 // need to continue until the end of the fold is
2598 // found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 if (getlevel == foldlevelMarker
2600 || getlevel == foldlevelExpr
2601 || getlevel == foldlevelSyntax)
2602 finish = TRUE;
2603 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002604
2605 if (fp->fd_top == startlnum && concat)
2606 {
2607 i = (int)(fp - (fold_T *)gap->ga_data);
2608 if (i != 0)
2609 {
2610 fp2 = fp - 1;
2611 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2612 {
2613 foldMerge(fp2, gap, fp);
2614 fp = fp2;
2615 }
2616 }
2617 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 break;
2619 }
2620 if (fp->fd_top >= startlnum)
2621 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002622 // A fold that starts at or after startlnum and stops
2623 // before the new fold must be deleted. Continue
2624 // looking for the next one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 deleteFoldEntry(gap,
2626 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2627 }
2628 else
2629 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002630 // A fold has some lines above startlnum, truncate it
2631 // to stop just above startlnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 fp->fd_len = startlnum - fp->fd_top;
2633 foldMarkAdjustRecurse(&fp->fd_nested,
2634 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2635 (linenr_T)MAXLNUM, 0L);
2636 fold_changed = TRUE;
2637 }
2638 }
2639 else
2640 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002641 // Insert new fold. Careful: ga_data may be NULL and it
2642 // may change!
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002643 if (gap->ga_len == 0)
2644 i = 0;
2645 else
2646 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 if (foldInsert(gap, i) != OK)
2648 return bot;
2649 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002650 // The new fold continues until bot, unless we find the
2651 // end earlier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 fp->fd_top = firstlnum;
2653 fp->fd_len = bot - firstlnum + 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002654 // When the containing fold is open, the new fold is open.
2655 // The new fold is closed if the fold above it is closed.
2656 // The first fold depends on the containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 if (topflags == FD_OPEN)
2658 {
2659 flp->wp->w_fold_manual = TRUE;
2660 fp->fd_flags = FD_OPEN;
2661 }
2662 else if (i <= 0)
2663 {
2664 fp->fd_flags = topflags;
2665 if (topflags != FD_LEVEL)
2666 flp->wp->w_fold_manual = TRUE;
2667 }
2668 else
2669 fp->fd_flags = (fp - 1)->fd_flags;
2670 fp->fd_small = MAYBE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002671 // If using the "marker", "expr" or "syntax" method, we
2672 // need to continue until the end of the fold is found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 if (getlevel == foldlevelMarker
2674 || getlevel == foldlevelExpr
2675 || getlevel == foldlevelSyntax)
2676 finish = TRUE;
2677 fold_changed = TRUE;
2678 break;
2679 }
2680 }
2681 }
2682
2683 if (lvl < level || flp->lnum > linecount)
2684 {
2685 /*
2686 * Found a line with a lower foldlevel, this fold ends just above
2687 * "flp->lnum".
2688 */
2689 break;
2690 }
2691
2692 /*
2693 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002694 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002696 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 {
2698 /*
2699 * There is a nested fold, handle it recursively.
2700 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002701 // At least do one line (can happen when finish is TRUE).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 if (bot < flp->lnum)
2703 bot = flp->lnum;
2704
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002705 // Line numbers in the nested fold are relative to the start of
2706 // this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 flp->lnum = flp->lnum_save - fp->fd_top;
2708 flp->off += fp->fd_top;
2709 i = (int)(fp - (fold_T *)gap->ga_data);
2710 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2711 startlnum2 - fp->fd_top, flp, getlevel,
2712 bot - fp->fd_top, fp->fd_flags);
2713 fp = (fold_T *)gap->ga_data + i;
2714 flp->lnum += fp->fd_top;
2715 flp->lnum_save += fp->fd_top;
2716 flp->off -= fp->fd_top;
2717 bot += fp->fd_top;
2718 startlnum2 = flp->lnum;
2719
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002720 // This fold may end at the same line, don't incr. flp->lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 }
2722 else
2723 {
2724 /*
2725 * Get the level of the next line, then continue the loop to check
2726 * if it ends there.
2727 * Skip over undefined lines, to find the foldlevel after it.
2728 * For the last line in the file the foldlevel is always valid.
2729 */
2730 flp->lnum = flp->lnum_save;
2731 ll = flp->lnum + 1;
2732 while (!got_int)
2733 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002734 // Make the previous level available to foldlevel().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 prev_lnum = flp->lnum;
2736 prev_lnum_lvl = flp->lvl;
2737
2738 if (++flp->lnum > linecount)
2739 break;
2740 flp->lvl = flp->lvl_next;
2741 getlevel(flp);
2742 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2743 break;
2744 }
2745 prev_lnum = 0;
2746 if (flp->lnum > linecount)
2747 break;
2748
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002749 // leave flp->lnum_save to lnum of the line that was used to get
2750 // the level, flp->lnum to the lnum of the next line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 flp->lnum_save = flp->lnum;
2752 flp->lnum = ll;
2753 }
2754 }
2755
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002756 if (fp == NULL) // only happens when got_int is set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 return bot;
2758
2759 /*
2760 * Get here when:
2761 * lvl < level: the folds ends just above "flp->lnum"
2762 * lvl >= level: fold continues below "bot"
2763 */
2764
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002765 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 if (fp->fd_len < flp->lnum - fp->fd_top)
2767 {
2768 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002769 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 fold_changed = TRUE;
2771 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002772 else if (fp->fd_top + fp->fd_len > linecount)
2773 // running into the end of the buffer (deleted last line)
2774 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002776 // Delete contained folds from the end of the last one found until where
2777 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2779 flp->lnum - 1 - fp->fd_top);
2780
2781 if (lvl < level)
2782 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002783 // End of fold found, update the length when it got shorter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 if (fp->fd_len != flp->lnum - fp->fd_top)
2785 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002786 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002788 // fold continued below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 if (getlevel == foldlevelMarker
2790 || getlevel == foldlevelExpr
2791 || getlevel == foldlevelSyntax)
2792 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002793 // marker method: truncate the fold and make sure the
2794 // previously included lines are processed again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 bot = fp->fd_top + fp->fd_len - 1;
2796 fp->fd_len = flp->lnum - fp->fd_top;
2797 }
2798 else
2799 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002800 // indent or expr method: split fold to create a new one
2801 // below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 i = (int)(fp - (fold_T *)gap->ga_data);
2803 foldSplit(gap, i, flp->lnum, bot);
2804 fp = (fold_T *)gap->ga_data + i;
2805 }
2806 }
2807 else
2808 fp->fd_len = flp->lnum - fp->fd_top;
2809 fold_changed = TRUE;
2810 }
2811 }
2812
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002813 // delete following folds that end before the current line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 for (;;)
2815 {
2816 fp2 = fp + 1;
2817 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2818 || fp2->fd_top > flp->lnum)
2819 break;
2820 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2821 {
2822 if (fp2->fd_top < flp->lnum)
2823 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002824 // Make fold that includes lnum start at lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 foldMarkAdjustRecurse(&fp2->fd_nested,
2826 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2827 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2828 fp2->fd_len -= flp->lnum - fp2->fd_top;
2829 fp2->fd_top = flp->lnum;
2830 fold_changed = TRUE;
2831 }
2832
2833 if (lvl >= level)
2834 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002835 // merge new fold with existing fold that follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 foldMerge(fp, gap, fp2);
2837 }
2838 break;
2839 }
2840 fold_changed = TRUE;
2841 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2842 }
2843
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002844 // Need to redraw the lines we inspected, which might be further down than
2845 // was asked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 if (bot < flp->lnum - 1)
2847 bot = flp->lnum - 1;
2848
2849 return bot;
2850}
2851
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002852// foldInsert() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853/*
2854 * Insert a new fold in "gap" at position "i".
2855 * Returns OK for success, FAIL for failure.
2856 */
2857 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002858foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859{
2860 fold_T *fp;
2861
2862 if (ga_grow(gap, 1) != OK)
2863 return FAIL;
2864 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002865 if (gap->ga_len > 0 && i < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2867 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 ga_init2(&fp->fd_nested, (int)sizeof(fold_T), 10);
2869 return OK;
2870}
2871
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002872// foldSplit() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873/*
2874 * Split the "i"th fold in "gap", which starts before "top" and ends below
2875 * "bot" in two pieces, one ending above "top" and the other starting below
2876 * "bot".
2877 * The caller must first have taken care of any nested folds from "top" to
2878 * "bot"!
2879 */
2880 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002881foldSplit(
2882 garray_T *gap,
2883 int i,
2884 linenr_T top,
2885 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886{
2887 fold_T *fp;
2888 fold_T *fp2;
2889 garray_T *gap1;
2890 garray_T *gap2;
2891 int idx;
2892 int len;
2893
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002894 // The fold continues below bot, need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 if (foldInsert(gap, i + 1) == FAIL)
2896 return;
2897 fp = (fold_T *)gap->ga_data + i;
2898 fp[1].fd_top = bot + 1;
2899 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2900 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002901 fp[1].fd_small = MAYBE;
2902 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002904 // Move nested folds below bot to new fold. There can't be
2905 // any between top and bot, they have been removed by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 gap1 = &fp->fd_nested;
2907 gap2 = &fp[1].fd_nested;
2908 (void)(foldFind(gap1, bot + 1 - fp->fd_top, &fp2));
2909 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2910 if (len > 0 && ga_grow(gap2, len) == OK)
2911 {
2912 for (idx = 0; idx < len; ++idx)
2913 {
2914 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2915 ((fold_T *)gap2->ga_data)[idx].fd_top
2916 -= fp[1].fd_top - fp->fd_top;
2917 }
2918 gap2->ga_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 }
2921 fp->fd_len = top - fp->fd_top;
2922 fold_changed = TRUE;
2923}
2924
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002925// foldRemove() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926/*
2927 * Remove folds within the range "top" to and including "bot".
2928 * Check for these situations:
2929 * 1 2 3
2930 * 1 2 3
2931 * top 2 3 4 5
2932 * 2 3 4 5
2933 * bot 2 3 4 5
2934 * 3 5 6
2935 * 3 5 6
2936 *
2937 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002938 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 * 3: split in two parts, one stops above "top", other starts below "bot".
2940 * 4: deleted
2941 * 5: made to start below "bot".
2942 * 6: not changed
2943 */
2944 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002945foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946{
2947 fold_T *fp = NULL;
2948
2949 if (bot < top)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002950 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002952 while (gap->ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002954 // Find fold that includes top or a following one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2956 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002957 // 2: or 3: need to delete nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002959 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002961 // 3: need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2963 }
2964 else
2965 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002966 // 2: truncate fold at "top".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 fp->fd_len = top - fp->fd_top;
2968 }
2969 fold_changed = TRUE;
2970 continue;
2971 }
2972 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2973 || fp->fd_top > bot)
2974 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002975 // 6: Found a fold below bot, can stop looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 break;
2977 }
2978 if (fp->fd_top >= top)
2979 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002980 // Found an entry below top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002982 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002984 // 5: Make fold that includes bot start below bot.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 foldMarkAdjustRecurse(&fp->fd_nested,
2986 (linenr_T)0, (long)(bot - fp->fd_top),
2987 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2988 fp->fd_len -= bot - fp->fd_top + 1;
2989 fp->fd_top = bot + 1;
2990 break;
2991 }
2992
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002993 // 4: Delete completely contained fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
2995 }
2996 }
2997}
2998
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002999// foldReverseOrder() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003000 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003001foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003002{
3003 fold_T *left, *right;
3004 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003005 linenr_T start = start_arg;
3006 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003007
3008 for (; start < end; start++, end--)
3009 {
3010 left = (fold_T *)gap->ga_data + start;
3011 right = (fold_T *)gap->ga_data + end;
3012 tmp = *left;
3013 *left = *right;
3014 *right = tmp;
3015 }
3016}
3017
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003018// foldMoveRange() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003019/*
3020 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3021 * requires "line1" <= "line2" <= "dest"
3022 *
3023 * There are the following situations for the first fold at or below line1 - 1.
3024 * 1 2 3 4
3025 * 1 2 3 4
3026 * line1 2 3 4
3027 * 2 3 4 5 6 7
3028 * line2 3 4 5 6 7
3029 * 3 4 6 7 8 9
3030 * dest 4 7 8 9
3031 * 4 7 8 10
3032 * 4 7 8 10
3033 *
3034 * In the following descriptions, "moved" means moving in the buffer, *and* in
3035 * the fold array.
3036 * Meanwhile, "shifted" just means moving in the buffer.
3037 * 1. not changed
3038 * 2. truncated above line1
3039 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3040 * dest are truncated and shifted up
3041 * 4. internal folds moved (from [line1, line2] to dest)
3042 * 5. moved to dest.
3043 * 6. truncated below line2 and moved.
3044 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3045 * removed, top is moved down by move_len.
3046 * 8. truncated below dest and shifted up.
3047 * 9. shifted up
3048 * 10. not changed
3049 */
3050
3051 static void
3052truncate_fold(fold_T *fp, linenr_T end)
3053{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003054 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003055 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003056 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003057}
3058
3059#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
3060#define valid_fold(fp, gap) ((fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
3061#define fold_index(fp, gap) ((size_t)(fp - ((fold_T *)(gap)->ga_data)))
3062
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003063 void
3064foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003065{
3066 fold_T *fp;
3067 linenr_T range_len = line2 - line1 + 1;
3068 linenr_T move_len = dest - line2;
3069 int at_start = foldFind(gap, line1 - 1, &fp);
3070 size_t move_start = 0, move_end = 0, dest_index = 0;
3071
3072 if (at_start)
3073 {
3074 if (fold_end(fp) > dest)
3075 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003076 // Case 4
3077 // don't have to change this fold, but have to move nested folds.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003078 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3079 fp->fd_top, dest - fp->fd_top);
3080 return;
3081 }
3082 else if (fold_end(fp) > line2)
3083 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003084 // Case 3
3085 // Remove nested folds between line1 and line2 & reduce the
3086 // length of fold by "range_len".
3087 // Folds after this one must be dealt with.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003088 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3089 fp->fd_top, MAXLNUM, -range_len);
3090 fp->fd_len -= range_len;
3091 }
3092 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003093 // Case 2 truncate fold, folds after this one must be dealt with.
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003094 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003095
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003096 // Look at the next fold, and treat that one as if it were the first
3097 // after "line1" (because now it is).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003098 fp = fp + 1;
3099 }
3100
3101 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3102 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003103 // Case 10
3104 // No folds after "line1" and before "dest"
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003105 return;
3106 }
3107 else if (fp->fd_top > line2)
3108 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003109 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003110 // Case 9. (for all case 9's) -- shift up.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003111 fp->fd_top -= range_len;
3112
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003113 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003114 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003115 // Case 8. -- ensure truncated at dest, shift up
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003116 truncate_fold(fp, dest);
3117 fp->fd_top -= range_len;
3118 }
3119 return;
3120 }
3121 else if (fold_end(fp) > dest)
3122 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003123 // Case 7 -- remove nested folds and shrink
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003124 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3125 fp->fd_top, MAXLNUM, -move_len);
3126 fp->fd_len -= move_len;
3127 fp->fd_top += move_len;
3128 return;
3129 }
3130
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003131 // Case 5 or 6
3132 // changes rely on whether there are folds between the end of
3133 // this fold and "dest".
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003134 move_start = fold_index(fp, gap);
3135
3136 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3137 {
3138 if (fp->fd_top <= line2)
3139 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003140 // 1. 2. or 3.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003141 if (fold_end(fp) > line2)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003142 // 2. or 3., truncate before moving
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003143 truncate_fold(fp, line2);
3144
3145 fp->fd_top += move_len;
3146 continue;
3147 }
3148
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003149 // Record index of the first fold after the moved range.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003150 if (move_end == 0)
3151 move_end = fold_index(fp, gap);
3152
3153 if (fold_end(fp) > dest)
3154 truncate_fold(fp, dest);
3155
3156 fp->fd_top -= range_len;
3157 }
3158
3159 dest_index = fold_index(fp, gap);
3160
3161 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003162 * All folds are now correct, but not necessarily in the correct order. We
3163 * must swap folds in the range [move_end, dest_index) with those in the
3164 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003165 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003166 if (move_end == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003167 // There are no folds after those moved, hence no folds have been moved
3168 // out of order.
Bram Moolenaar94be6192017-04-22 22:40:11 +02003169 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003170 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3171 foldReverseOrder(gap, (linenr_T)move_start,
3172 (linenr_T)(move_start + dest_index - move_end - 1));
3173 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3174 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003175}
3176#undef fold_end
3177#undef valid_fold
3178#undef fold_index
3179
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003180// foldMerge() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003182 * Merge two adjacent folds (and the nested ones in them).
3183 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 * must end just above "fp2".
3185 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3186 * Fold entry "fp2" in "gap" is deleted.
3187 */
3188 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003189foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190{
3191 fold_T *fp3;
3192 fold_T *fp4;
3193 int idx;
3194 garray_T *gap1 = &fp1->fd_nested;
3195 garray_T *gap2 = &fp2->fd_nested;
3196
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003197 // If the last nested fold in fp1 touches the first nested fold in fp2,
3198 // merge them recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3200 foldMerge(fp3, gap2, fp4);
3201
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003202 // Move nested folds in fp2 to the end of fp1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3204 {
3205 for (idx = 0; idx < gap2->ga_len; ++idx)
3206 {
3207 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3208 = ((fold_T *)gap2->ga_data)[idx];
3209 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3210 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 }
3212 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 }
3214
3215 fp1->fd_len += fp2->fd_len;
3216 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3217 fold_changed = TRUE;
3218}
3219
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003220// foldlevelIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221/*
3222 * Low level function to get the foldlevel for the "indent" method.
3223 * Doesn't use any caching.
3224 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3225 */
3226 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003227foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228{
3229 char_u *s;
3230 buf_T *buf;
3231 linenr_T lnum = flp->lnum + flp->off;
3232
3233 buf = flp->wp->w_buffer;
3234 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3235
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003236 // empty line or lines starting with a character in 'foldignore': level
3237 // depends on surrounding lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3239 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003240 // first and last line can't be undefined, use level 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3242 flp->lvl = 0;
3243 else
3244 flp->lvl = -1;
3245 }
3246 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003247 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003249 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003251 if (flp->lvl < 0)
3252 flp->lvl = 0;
3253 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254}
3255
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003256// foldlevelDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257#ifdef FEAT_DIFF
3258/*
3259 * Low level function to get the foldlevel for the "diff" method.
3260 * Doesn't use any caching.
3261 */
3262 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003263foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264{
3265 if (diff_infold(flp->wp, flp->lnum + flp->off))
3266 flp->lvl = 1;
3267 else
3268 flp->lvl = 0;
3269}
3270#endif
3271
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003272// foldlevelExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273/*
3274 * Low level function to get the foldlevel for the "expr" method.
3275 * Doesn't use any caching.
3276 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3277 */
3278 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003279foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280{
3281#ifndef FEAT_EVAL
3282 flp->start = FALSE;
3283 flp->lvl = 0;
3284#else
3285 win_T *win;
3286 int n;
3287 int c;
3288 linenr_T lnum = flp->lnum + flp->off;
3289 int save_keytyped;
3290
3291 win = curwin;
3292 curwin = flp->wp;
3293 curbuf = flp->wp->w_buffer;
3294 set_vim_var_nr(VV_LNUM, lnum);
3295
3296 flp->start = 0;
3297 flp->had_end = flp->end;
3298 flp->end = MAX_LEVEL + 1;
3299 if (lnum <= 1)
3300 flp->lvl = 0;
3301
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003302 // KeyTyped may be reset to 0 when calling a function which invokes
3303 // do_cmdline(). To make 'foldopen' work correctly restore KeyTyped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 save_keytyped = KeyTyped;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003305 n = (int)eval_foldexpr(flp->wp->w_p_fde, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 KeyTyped = save_keytyped;
3307
3308 switch (c)
3309 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003310 // "a1", "a2", .. : add to the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 case 'a': if (flp->lvl >= 0)
3312 {
3313 flp->lvl += n;
3314 flp->lvl_next = flp->lvl;
3315 }
3316 flp->start = n;
3317 break;
3318
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003319 // "s1", "s2", .. : subtract from the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 case 's': if (flp->lvl >= 0)
3321 {
3322 if (n > flp->lvl)
3323 flp->lvl_next = 0;
3324 else
3325 flp->lvl_next = flp->lvl - n;
3326 flp->end = flp->lvl_next + 1;
3327 }
3328 break;
3329
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003330 // ">1", ">2", .. : start a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 case '>': flp->lvl = n;
3332 flp->lvl_next = n;
3333 flp->start = 1;
3334 break;
3335
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003336 // "<1", "<2", .. : end a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 case '<': flp->lvl_next = n - 1;
3338 flp->end = n;
3339 break;
3340
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003341 // "=": No change in level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 case '=': flp->lvl_next = flp->lvl;
3343 break;
3344
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003345 // "-1", "0", "1", ..: set fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 default: if (n < 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003347 // Use the current level for the next line, so that "a1"
3348 // will work there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 flp->lvl_next = flp->lvl;
3350 else
3351 flp->lvl_next = n;
3352 flp->lvl = n;
3353 break;
3354 }
3355
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003356 // If the level is unknown for the first or the last line in the file, use
3357 // level 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 if (flp->lvl < 0)
3359 {
3360 if (lnum <= 1)
3361 {
3362 flp->lvl = 0;
3363 flp->lvl_next = 0;
3364 }
3365 if (lnum == curbuf->b_ml.ml_line_count)
3366 flp->lvl_next = 0;
3367 }
3368
3369 curwin = win;
3370 curbuf = curwin->w_buffer;
3371#endif
3372}
3373
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003374// parseMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375/*
3376 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3377 * "foldendmarkerlen".
3378 * Relies on the option value to have been checked for correctness already.
3379 */
3380 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003381parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382{
3383 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3384 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3385 foldendmarkerlen = (int)STRLEN(foldendmarker);
3386}
3387
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003388// foldlevelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389/*
3390 * Low level function to get the foldlevel for the "marker" method.
3391 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3392 * set before calling this.
3393 * Requires that flp->lvl is set to the fold level of the previous line!
3394 * Careful: This means you can't call this function twice on the same line.
3395 * Doesn't use any caching.
3396 * Sets flp->start when a start marker was found.
3397 */
3398 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003399foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400{
3401 char_u *startmarker;
3402 int cstart;
3403 int cend;
3404 int start_lvl = flp->lvl;
3405 char_u *s;
3406 int n;
3407
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003408 // cache a few values for speed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 startmarker = flp->wp->w_p_fmr;
3410 cstart = *startmarker;
3411 ++startmarker;
3412 cend = *foldendmarker;
3413
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003414 // Default: no start found, next level is same as current level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 flp->start = 0;
3416 flp->lvl_next = flp->lvl;
3417
3418 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3419 while (*s)
3420 {
3421 if (*s == cstart
3422 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3423 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003424 // found startmarker: set flp->lvl
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 s += foldstartmarkerlen;
3426 if (VIM_ISDIGIT(*s))
3427 {
3428 n = atoi((char *)s);
3429 if (n > 0)
3430 {
3431 flp->lvl = n;
3432 flp->lvl_next = n;
3433 if (n <= start_lvl)
3434 flp->start = 1;
3435 else
3436 flp->start = n - start_lvl;
3437 }
3438 }
3439 else
3440 {
3441 ++flp->lvl;
3442 ++flp->lvl_next;
3443 ++flp->start;
3444 }
3445 }
3446 else if (*s == cend
3447 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3448 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003449 // found endmarker: set flp->lvl_next
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 s += foldendmarkerlen;
3451 if (VIM_ISDIGIT(*s))
3452 {
3453 n = atoi((char *)s);
3454 if (n > 0)
3455 {
3456 flp->lvl = n;
3457 flp->lvl_next = n - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003458 // never start a fold with an end marker
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003459 if (flp->lvl_next > start_lvl)
3460 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 }
3462 }
3463 else
3464 --flp->lvl_next;
3465 }
3466 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003467 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 }
3469
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003470 // The level can't go negative, must be missing a start marker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 if (flp->lvl_next < 0)
3472 flp->lvl_next = 0;
3473}
3474
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003475// foldlevelSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476/*
3477 * Low level function to get the foldlevel for the "syntax" method.
3478 * Doesn't use any caching.
3479 */
3480 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003481foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482{
3483#ifndef FEAT_SYN_HL
3484 flp->start = 0;
3485 flp->lvl = 0;
3486#else
3487 linenr_T lnum = flp->lnum + flp->off;
3488 int n;
3489
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003490 // Use the maximum fold level at the start of this line and the next.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3492 flp->start = 0;
3493 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3494 {
3495 n = syn_get_foldlevel(flp->wp, lnum + 1);
3496 if (n > flp->lvl)
3497 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003498 flp->start = n - flp->lvl; // fold(s) start here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 flp->lvl = n;
3500 }
3501 }
3502#endif
3503}
3504
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003505// functions for storing the fold state in a View {{{1
3506// put_folds() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003508static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3509static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3510static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511
3512/*
3513 * Write commands to "fd" to restore the manual folds in window "wp".
3514 * Return FAIL if writing fails.
3515 */
3516 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003517put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518{
3519 if (foldmethodIsManual(wp))
3520 {
3521 if (put_line(fd, "silent! normal! zE") == FAIL
3522 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL)
3523 return FAIL;
3524 }
3525
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003526 // If some folds are manually opened/closed, need to restore that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003528 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529
3530 return OK;
3531}
3532
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003533// put_folds_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534/*
3535 * Write commands to "fd" to recreate manually created folds.
3536 * Returns FAIL when writing failed.
3537 */
3538 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003539put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540{
3541 int i;
3542 fold_T *fp;
3543
3544 fp = (fold_T *)gap->ga_data;
3545 for (i = 0; i < gap->ga_len; i++)
3546 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003547 // Do nested folds first, they will be created closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3549 return FAIL;
3550 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3551 fp->fd_top + off + fp->fd_len - 1) < 0
3552 || put_eol(fd) == FAIL)
3553 return FAIL;
3554 ++fp;
3555 }
3556 return OK;
3557}
3558
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003559// put_foldopen_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560/*
3561 * Write commands to "fd" to open and close manually opened/closed folds.
3562 * Returns FAIL when writing failed.
3563 */
3564 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003565put_foldopen_recurse(
3566 FILE *fd,
3567 win_T *wp,
3568 garray_T *gap,
3569 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570{
3571 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003572 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 fold_T *fp;
3574
3575 fp = (fold_T *)gap->ga_data;
3576 for (i = 0; i < gap->ga_len; i++)
3577 {
3578 if (fp->fd_flags != FD_LEVEL)
3579 {
3580 if (fp->fd_nested.ga_len > 0)
3581 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003582 // open nested folds while this fold is open
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3584 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003585 || put_line(fd, "normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003587 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3588 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 == FAIL)
3590 return FAIL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003591 // close the parent when needed
Bram Moolenaard25ad652012-02-29 19:20:02 +01003592 if (fp->fd_flags == FD_CLOSED)
3593 {
3594 if (put_fold_open_close(fd, fp, off) == FAIL)
3595 return FAIL;
3596 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003598 else
3599 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003600 // Open or close the leaf according to the window foldlevel.
3601 // Do not close a leaf that is already closed, as it will close
3602 // the parent.
Bram Moolenaard25ad652012-02-29 19:20:02 +01003603 level = foldLevelWin(wp, off + fp->fd_top);
3604 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3605 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3606 if (put_fold_open_close(fd, fp, off) == FAIL)
3607 return FAIL;
3608 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 }
3610 ++fp;
3611 }
3612
3613 return OK;
3614}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003615
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003616// put_fold_open_close() {{{2
Bram Moolenaard25ad652012-02-29 19:20:02 +01003617/*
3618 * Write the open or close command to "fd".
3619 * Returns FAIL when writing failed.
3620 */
3621 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003622put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003623{
3624 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3625 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003626 || fprintf(fd, "normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003627 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3628 || put_eol(fd) == FAIL)
3629 return FAIL;
3630
3631 return OK;
3632}
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003633#endif // FEAT_SESSION
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003635// }}}1
Bram Moolenaardb022f32019-09-01 17:52:32 +02003636#endif // defined(FEAT_FOLDING) || defined(PROTO)
3637
3638#if defined(FEAT_EVAL) || defined(PROTO)
3639
3640/*
3641 * "foldclosed()" and "foldclosedend()" functions
3642 */
3643 static void
3644foldclosed_both(
3645 typval_T *argvars UNUSED,
3646 typval_T *rettv,
3647 int end UNUSED)
3648{
3649# ifdef FEAT_FOLDING
3650 linenr_T lnum;
3651 linenr_T first, last;
3652
3653 lnum = tv_get_lnum(argvars);
3654 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3655 {
3656 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3657 {
3658 if (end)
3659 rettv->vval.v_number = (varnumber_T)last;
3660 else
3661 rettv->vval.v_number = (varnumber_T)first;
3662 return;
3663 }
3664 }
3665#endif
3666 rettv->vval.v_number = -1;
3667}
3668
3669/*
3670 * "foldclosed()" function
3671 */
3672 void
3673f_foldclosed(typval_T *argvars, typval_T *rettv)
3674{
3675 foldclosed_both(argvars, rettv, FALSE);
3676}
3677
3678/*
3679 * "foldclosedend()" function
3680 */
3681 void
3682f_foldclosedend(typval_T *argvars, typval_T *rettv)
3683{
3684 foldclosed_both(argvars, rettv, TRUE);
3685}
3686
3687/*
3688 * "foldlevel()" function
3689 */
3690 void
3691f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3692{
3693# ifdef FEAT_FOLDING
3694 linenr_T lnum;
3695
3696 lnum = tv_get_lnum(argvars);
3697 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3698 rettv->vval.v_number = foldLevel(lnum);
3699# endif
3700}
3701
3702/*
3703 * "foldtext()" function
3704 */
3705 void
3706f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3707{
3708# ifdef FEAT_FOLDING
3709 linenr_T foldstart;
3710 linenr_T foldend;
3711 char_u *dashes;
3712 linenr_T lnum;
3713 char_u *s;
3714 char_u *r;
3715 int len;
3716 char *txt;
3717 long count;
3718# endif
3719
3720 rettv->v_type = VAR_STRING;
3721 rettv->vval.v_string = NULL;
3722# ifdef FEAT_FOLDING
3723 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3724 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3725 dashes = get_vim_var_str(VV_FOLDDASHES);
3726 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3727 && dashes != NULL)
3728 {
3729 // Find first non-empty line in the fold.
3730 for (lnum = foldstart; lnum < foldend; ++lnum)
3731 if (!linewhite(lnum))
3732 break;
3733
3734 // Find interesting text in this line.
3735 s = skipwhite(ml_get(lnum));
3736 // skip C comment-start
3737 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3738 {
3739 s = skipwhite(s + 2);
3740 if (*skipwhite(s) == NUL
3741 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3742 {
3743 s = skipwhite(ml_get(lnum + 1));
3744 if (*s == '*')
3745 s = skipwhite(s + 1);
3746 }
3747 }
3748 count = (long)(foldend - foldstart + 1);
3749 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3750 r = alloc(STRLEN(txt)
3751 + STRLEN(dashes) // for %s
3752 + 20 // for %3ld
3753 + STRLEN(s)); // concatenated
3754 if (r != NULL)
3755 {
3756 sprintf((char *)r, txt, dashes, count);
3757 len = (int)STRLEN(r);
3758 STRCAT(r, s);
3759 // remove 'foldmarker' and 'commentstring'
3760 foldtext_cleanup(r + len);
3761 rettv->vval.v_string = r;
3762 }
3763 }
3764# endif
3765}
3766
3767/*
3768 * "foldtextresult(lnum)" function
3769 */
3770 void
3771f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3772{
3773# ifdef FEAT_FOLDING
3774 linenr_T lnum;
3775 char_u *text;
3776 char_u buf[FOLD_TEXT_LEN];
3777 foldinfo_T foldinfo;
3778 int fold_count;
3779 static int entered = FALSE;
3780# endif
3781
3782 rettv->v_type = VAR_STRING;
3783 rettv->vval.v_string = NULL;
3784# ifdef FEAT_FOLDING
3785 if (entered)
3786 return; // reject recursive use
3787 entered = TRUE;
3788
3789 lnum = tv_get_lnum(argvars);
3790 // treat illegal types and illegal string values for {lnum} the same
3791 if (lnum < 0)
3792 lnum = 0;
3793 fold_count = foldedCount(curwin, lnum, &foldinfo);
3794 if (fold_count > 0)
3795 {
3796 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3797 &foldinfo, buf);
3798 if (text == buf)
3799 text = vim_strsave(text);
3800 rettv->vval.v_string = text;
3801 }
3802
3803 entered = FALSE;
3804# endif
3805}
3806
3807#endif // FEAT_EVAL