blob: 26a4a98a76ca37a2c471933285d1f8d6f12282ad [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
Bram Moolenaar071d4272004-06-13 20:20:40 +000068/*
69 * While updating the folds lines between invalid_top and invalid_bot have an
70 * undefined fold level. Only used for the window currently being updated.
71 */
72static linenr_T invalid_top = (linenr_T)0;
73static linenr_T invalid_bot = (linenr_T)0;
74
75/*
76 * When using 'foldexpr' we sometimes get the level of the next line, which
77 * calls foldlevel() to get the level of the current line, which hasn't been
78 * stored yet. To get around this chicken-egg problem the level of the
79 * previous line is stored here when available. prev_lnum is zero when the
80 * level is not available.
81 */
82static linenr_T prev_lnum = 0;
83static int prev_lnum_lvl = -1;
84
Bram Moolenaar217e1b82019-12-01 21:41:28 +010085// Flags used for "done" argument of setManualFold.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086#define DONE_NOTHING 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010087#define DONE_ACTION 1 // did close or open a fold
88#define DONE_FOLD 2 // did find a fold
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90static int foldstartmarkerlen;
91static char_u *foldendmarker;
92static int foldendmarkerlen;
93
Bram Moolenaar217e1b82019-12-01 21:41:28 +010094// Exported folding functions. {{{1
95// copyFoldingState() {{{2
Bram Moolenaar4033c552017-09-16 20:54:51 +020096
Bram Moolenaar071d4272004-06-13 20:20:40 +000097/*
98 * Copy that folding state from window "wp_from" to window "wp_to".
99 */
100 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100101copyFoldingState(win_T *wp_from, win_T *wp_to)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102{
103 wp_to->w_fold_manual = wp_from->w_fold_manual;
104 wp_to->w_foldinvalid = wp_from->w_foldinvalid;
105 cloneFoldGrowArray(&wp_from->w_folds, &wp_to->w_folds);
106}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100108// hasAnyFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109/*
110 * Return TRUE if there may be folded lines in the current window.
111 */
112 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100113hasAnyFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100115 // very simple now, but can become more complex later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116 return (win->w_p_fen
117 && (!foldmethodIsManual(win) || win->w_folds.ga_len > 0));
118}
119
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100120// hasFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121/*
122 * Return TRUE if line "lnum" in the current window is part of a closed
123 * fold.
124 * When returning TRUE, *firstp and *lastp are set to the first and last
125 * lnum of the sequence of folded lines (skipped when NULL).
126 */
127 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100128hasFolding(linenr_T lnum, linenr_T *firstp, linenr_T *lastp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129{
130 return hasFoldingWin(curwin, lnum, firstp, lastp, TRUE, NULL);
131}
132
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100133// hasFoldingWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100135hasFoldingWin(
136 win_T *win,
137 linenr_T lnum,
138 linenr_T *firstp,
139 linenr_T *lastp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100140 int cache, // when TRUE: use cached values of window
141 foldinfo_T *infop) // where to store fold info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142{
143 int had_folded = FALSE;
144 linenr_T first = 0;
145 linenr_T last = 0;
146 linenr_T lnum_rel = lnum;
147 int x;
148 fold_T *fp;
149 int level = 0;
150 int use_level = FALSE;
151 int maybe_small = FALSE;
152 garray_T *gap;
Bram Moolenaar945ec092016-06-08 21:17:43 +0200153 int low_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154
155 checkupdate(win);
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +0100156
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 /*
158 * Return quickly when there is no folding at all in this window.
159 */
160 if (!hasAnyFolding(win))
161 {
162 if (infop != NULL)
163 infop->fi_level = 0;
164 return FALSE;
165 }
166
167 if (cache)
168 {
169 /*
170 * First look in cached info for displayed lines. This is probably
171 * the fastest, but it can only be used if the entry is still valid.
172 */
173 x = find_wl_entry(win, lnum);
174 if (x >= 0)
175 {
176 first = win->w_lines[x].wl_lnum;
177 last = win->w_lines[x].wl_lastlnum;
178 had_folded = win->w_lines[x].wl_folded;
179 }
180 }
181
182 if (first == 0)
183 {
184 /*
185 * Recursively search for a fold that contains "lnum".
186 */
187 gap = &win->w_folds;
188 for (;;)
189 {
190 if (!foldFind(gap, lnum_rel, &fp))
191 break;
192
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100193 // Remember lowest level of fold that starts in "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 if (lnum_rel == fp->fd_top && low_level == 0)
195 low_level = level + 1;
196
197 first += fp->fd_top;
198 last += fp->fd_top;
199
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100200 // is this fold closed?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 had_folded = check_closed(win, fp, &use_level, level,
202 &maybe_small, lnum - lnum_rel);
203 if (had_folded)
204 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100205 // Fold closed: Set last and quit loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 last += fp->fd_len - 1;
207 break;
208 }
209
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100210 // Fold found, but it's open: Check nested folds. Line number is
211 // relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 gap = &fp->fd_nested;
213 lnum_rel -= fp->fd_top;
214 ++level;
215 }
216 }
217
218 if (!had_folded)
219 {
220 if (infop != NULL)
221 {
222 infop->fi_level = level;
223 infop->fi_lnum = lnum - lnum_rel;
224 infop->fi_low_level = low_level == 0 ? level : low_level;
225 }
226 return FALSE;
227 }
228
Bram Moolenaar05b20fb2015-04-13 20:52:36 +0200229 if (last > win->w_buffer->b_ml.ml_line_count)
230 last = win->w_buffer->b_ml.ml_line_count;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 if (lastp != NULL)
232 *lastp = last;
233 if (firstp != NULL)
234 *firstp = first;
235 if (infop != NULL)
236 {
237 infop->fi_level = level + 1;
238 infop->fi_lnum = first;
239 infop->fi_low_level = low_level == 0 ? level + 1 : low_level;
240 }
241 return TRUE;
242}
243
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100244// foldLevel() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +0200245#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246/*
247 * Return fold level at line number "lnum" in the current window.
248 */
Bram Moolenaardb022f32019-09-01 17:52:32 +0200249 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100250foldLevel(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100252 // While updating the folds lines between invalid_top and invalid_bot have
253 // an undefined fold level. Otherwise update the folds first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 if (invalid_top == (linenr_T)0)
255 checkupdate(curwin);
256 else if (lnum == prev_lnum && prev_lnum_lvl >= 0)
257 return prev_lnum_lvl;
258 else if (lnum >= invalid_top && lnum <= invalid_bot)
259 return -1;
260
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100261 // Return quickly when there is no folding at all in this window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 if (!hasAnyFolding(curwin))
263 return 0;
264
265 return foldLevelWin(curwin, lnum);
266}
Bram Moolenaardb022f32019-09-01 17:52:32 +0200267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100269// lineFolded() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270/*
271 * Low level function to check if a line is folded. Doesn't use any caching.
272 * Return TRUE if line is folded.
273 * Return FALSE if line is not folded.
274 * Return MAYBE if the line is folded when next to a folded line.
275 */
276 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100277lineFolded(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278{
279 return foldedCount(win, lnum, NULL) != 0;
280}
281
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100282// foldedCount() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283/*
284 * Count the number of lines that are folded at line number "lnum".
285 * Normally "lnum" is the first line of a possible fold, and the returned
286 * number is the number of lines in the fold.
287 * Doesn't use caching from the displayed window.
288 * Returns number of folded lines from "lnum", or 0 if line is not folded.
289 * When "infop" is not NULL, fills *infop with the fold level info.
290 */
291 long
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100292foldedCount(win_T *win, linenr_T lnum, foldinfo_T *infop)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293{
294 linenr_T last;
295
296 if (hasFoldingWin(win, lnum, NULL, &last, FALSE, infop))
297 return (long)(last - lnum + 1);
298 return 0;
299}
300
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100301// foldmethodIsManual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302/*
303 * Return TRUE if 'foldmethod' is "manual"
304 */
305 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100306foldmethodIsManual(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000308 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[3] == 'u');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309}
310
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100311// foldmethodIsIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312/*
313 * Return TRUE if 'foldmethod' is "indent"
314 */
315 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100316foldmethodIsIndent(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317{
318 return (wp->w_p_fdm[0] == 'i');
319}
320
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100321// foldmethodIsExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322/*
323 * Return TRUE if 'foldmethod' is "expr"
324 */
325 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100326foldmethodIsExpr(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000328 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[1] == 'x');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329}
330
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100331// foldmethodIsMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332/*
333 * Return TRUE if 'foldmethod' is "marker"
334 */
335 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100336foldmethodIsMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000338 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[2] == 'r');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339}
340
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100341// foldmethodIsSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342/*
343 * Return TRUE if 'foldmethod' is "syntax"
344 */
345 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100346foldmethodIsSyntax(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347{
348 return (wp->w_p_fdm[0] == 's');
349}
350
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100351// foldmethodIsDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352/*
353 * Return TRUE if 'foldmethod' is "diff"
354 */
355 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100356foldmethodIsDiff(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357{
358 return (wp->w_p_fdm[0] == 'd');
359}
360
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100361// closeFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362/*
363 * Close fold for current window at line "lnum".
364 * Repeat "count" times.
365 */
366 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100367closeFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368{
369 setFoldRepeat(lnum, count, FALSE);
370}
371
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100372// closeFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373/*
374 * Close fold for current window at line "lnum" recursively.
375 */
376 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100377closeFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378{
379 (void)setManualFold(lnum, FALSE, TRUE, NULL);
380}
381
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100382// opFoldRange() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383/*
384 * Open or Close folds for current window in lines "first" to "last".
385 * Used for "zo", "zO", "zc" and "zC" in Visual mode.
386 */
387 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100388opFoldRange(
389 linenr_T first,
390 linenr_T last,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100391 int opening, // TRUE to open, FALSE to close
392 int recurse, // TRUE to do it recursively
393 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100395 int done = DONE_NOTHING; // avoid error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 linenr_T lnum;
397 linenr_T lnum_next;
398
399 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
400 {
401 lnum_next = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100402 // Opening one level only: next fold to open is after the one going to
403 // be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404 if (opening && !recurse)
405 (void)hasFolding(lnum, NULL, &lnum_next);
406 (void)setManualFold(lnum, opening, recurse, &done);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100407 // Closing one level only: next line to close a fold is after just
408 // closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 if (!opening && !recurse)
410 (void)hasFolding(lnum, NULL, &lnum_next);
411 }
412 if (done == DONE_NOTHING)
Bram Moolenaarb09feaa2022-01-02 20:20:45 +0000413 emsg(_(e_no_fold_found));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100414 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 if (had_visual)
416 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417}
418
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100419// openFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
421 * Open fold for current window at line "lnum".
422 * Repeat "count" times.
423 */
424 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100425openFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426{
427 setFoldRepeat(lnum, count, TRUE);
428}
429
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100430// openFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431/*
432 * Open fold for current window at line "lnum" recursively.
433 */
434 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100435openFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436{
437 (void)setManualFold(lnum, TRUE, TRUE, NULL);
438}
439
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100440// foldOpenCursor() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441/*
442 * Open folds until the cursor line is not in a closed fold.
443 */
444 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100445foldOpenCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446{
447 int done;
448
449 checkupdate(curwin);
450 if (hasAnyFolding(curwin))
451 for (;;)
452 {
453 done = DONE_NOTHING;
454 (void)setManualFold(curwin->w_cursor.lnum, TRUE, FALSE, &done);
455 if (!(done & DONE_ACTION))
456 break;
457 }
458}
459
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100460// newFoldLevel() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461/*
462 * Set new foldlevel for current window.
463 */
464 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100465newFoldLevel(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466{
467 newFoldLevelWin(curwin);
468
469#ifdef FEAT_DIFF
470 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
471 {
472 win_T *wp;
473
474 /*
475 * Set the same foldlevel in other windows in diff mode.
476 */
477 FOR_ALL_WINDOWS(wp)
478 {
479 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
480 {
481 wp->w_p_fdl = curwin->w_p_fdl;
482 newFoldLevelWin(wp);
483 }
484 }
485 }
486#endif
487}
488
489 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100490newFoldLevelWin(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491{
492 fold_T *fp;
493 int i;
494
495 checkupdate(wp);
496 if (wp->w_fold_manual)
497 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100498 // Set all flags for the first level of folds to FD_LEVEL. Following
499 // manual open/close will then change the flags to FD_OPEN or
500 // FD_CLOSED for those folds that don't use 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 fp = (fold_T *)wp->w_folds.ga_data;
502 for (i = 0; i < wp->w_folds.ga_len; ++i)
503 fp[i].fd_flags = FD_LEVEL;
504 wp->w_fold_manual = FALSE;
505 }
506 changed_window_setting_win(wp);
507}
508
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100509// foldCheckClose() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510/*
511 * Apply 'foldlevel' to all folds that don't contain the cursor.
512 */
513 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100514foldCheckClose(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100516 if (*p_fcl != NUL) // can only be "all" right now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517 {
518 checkupdate(curwin);
519 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
520 (int)curwin->w_p_fdl))
521 changed_window_setting();
522 }
523}
524
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100525// checkCloseRec() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100527checkCloseRec(garray_T *gap, linenr_T lnum, int level)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528{
529 fold_T *fp;
530 int retval = FALSE;
531 int i;
532
533 fp = (fold_T *)gap->ga_data;
534 for (i = 0; i < gap->ga_len; ++i)
535 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100536 // Only manually opened folds may need to be closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 if (fp[i].fd_flags == FD_OPEN)
538 {
539 if (level <= 0 && (lnum < fp[i].fd_top
540 || lnum >= fp[i].fd_top + fp[i].fd_len))
541 {
542 fp[i].fd_flags = FD_LEVEL;
543 retval = TRUE;
544 }
545 else
546 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
547 level - 1);
548 }
549 }
550 return retval;
551}
552
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100553// foldCreateAllowed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554/*
555 * Return TRUE if it's allowed to manually create or delete a fold.
556 * Give an error message and return FALSE if not.
557 */
558 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100559foldManualAllowed(int create)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560{
561 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
562 return TRUE;
563 if (create)
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000564 emsg(_(e_cannot_create_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 else
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000566 emsg(_(e_cannot_delete_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 return FALSE;
568}
569
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100570// foldCreate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571/*
572 * Create a fold from line "start" to line "end" (inclusive) in the current
573 * window.
574 */
575 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100576foldCreate(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577{
578 fold_T *fp;
579 garray_T *gap;
580 garray_T fold_ga;
581 int i, j;
582 int cont;
583 int use_level = FALSE;
584 int closed = FALSE;
585 int level = 0;
586 linenr_T start_rel = start;
587 linenr_T end_rel = end;
588
589 if (start > end)
590 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100591 // reverse the range
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 end = start_rel;
593 start = end_rel;
594 start_rel = start;
595 end_rel = end;
596 }
597
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100598 // When 'foldmethod' is "marker" add markers, which creates the folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599 if (foldmethodIsMarker(curwin))
600 {
601 foldCreateMarkers(start, end);
602 return;
603 }
604
605 checkupdate(curwin);
606
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100607 // Find the place to insert the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 gap = &curwin->w_folds;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200609 if (gap->ga_len == 0)
610 i = 0;
611 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200613 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200615 if (!foldFind(gap, start_rel, &fp))
616 break;
617 if (fp->fd_top + fp->fd_len > end_rel)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200619 // New fold is completely inside this fold: Go one level
620 // deeper.
621 gap = &fp->fd_nested;
622 start_rel -= fp->fd_top;
623 end_rel -= fp->fd_top;
624 if (use_level || fp->fd_flags == FD_LEVEL)
625 {
626 use_level = TRUE;
627 if (level >= curwin->w_p_fdl)
628 closed = TRUE;
629 }
630 else if (fp->fd_flags == FD_CLOSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 closed = TRUE;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200632 ++level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 }
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200634 else
635 {
636 // This fold and new fold overlap: Insert here and move some
637 // folds inside the new fold.
638 break;
639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 }
Bram Moolenaar5e1f22f2020-11-10 18:23:52 +0100641 if (gap->ga_len == 0)
642 i = 0;
643 else
644 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 }
646
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 if (ga_grow(gap, 1) == OK)
648 {
649 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000650 ga_init2(&fold_ga, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100652 // Count number of folds that will be contained in the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 for (cont = 0; i + cont < gap->ga_len; ++cont)
654 if (fp[cont].fd_top > end_rel)
655 break;
656 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
657 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100658 // If the first fold starts before the new fold, let the new fold
659 // start there. Otherwise the existing fold would change.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 if (start_rel > fp->fd_top)
661 start_rel = fp->fd_top;
662
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100663 // When last contained fold isn't completely contained, adjust end
664 // of new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
666 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100667 // Move contained folds to inside new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
669 fold_ga.ga_len += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 i += cont;
671
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100672 // Adjust line numbers in contained folds to be relative to the
673 // new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 for (j = 0; j < cont; ++j)
675 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
676 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100677 // Move remaining entries to after the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 if (i < gap->ga_len)
679 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
680 sizeof(fold_T) * (gap->ga_len - i));
681 gap->ga_len = gap->ga_len + 1 - cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100683 // insert new fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 fp->fd_nested = fold_ga;
685 fp->fd_top = start_rel;
686 fp->fd_len = end_rel - start_rel + 1;
687
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100688 // We want the new fold to be closed. If it would remain open because
689 // of using 'foldlevel', need to adjust fd_flags of containing folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 if (use_level && !closed && level < curwin->w_p_fdl)
691 closeFold(start, 1L);
692 if (!use_level)
693 curwin->w_fold_manual = TRUE;
694 fp->fd_flags = FD_CLOSED;
695 fp->fd_small = MAYBE;
696
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100697 // redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 changed_window_setting();
699 }
700}
701
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100702// deleteFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703/*
704 * Delete a fold at line "start" in the current window.
705 * When "end" is not 0, delete all folds from "start" to "end".
706 * When "recursive" is TRUE delete recursively.
707 */
708 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100709deleteFold(
710 linenr_T start,
711 linenr_T end,
712 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100713 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714{
715 garray_T *gap;
716 fold_T *fp;
717 garray_T *found_ga;
718 fold_T *found_fp = NULL;
719 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000720 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 int maybe_small = FALSE;
722 int level = 0;
723 linenr_T lnum = start;
724 linenr_T lnum_off;
725 int did_one = FALSE;
726 linenr_T first_lnum = MAXLNUM;
727 linenr_T last_lnum = 0;
728
729 checkupdate(curwin);
730
731 while (lnum <= end)
732 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100733 // Find the deepest fold for "start".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 gap = &curwin->w_folds;
735 found_ga = NULL;
736 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000737 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 for (;;)
739 {
740 if (!foldFind(gap, lnum - lnum_off, &fp))
741 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100742 // lnum is inside this fold, remember info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 found_ga = gap;
744 found_fp = fp;
745 found_off = lnum_off;
746
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100747 // if "lnum" is folded, don't check nesting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 if (check_closed(curwin, fp, &use_level, level,
749 &maybe_small, lnum_off))
750 break;
751
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100752 // check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 gap = &fp->fd_nested;
754 lnum_off += fp->fd_top;
755 ++level;
756 }
757 if (found_ga == NULL)
758 {
759 ++lnum;
760 }
761 else
762 {
763 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764
765 if (foldmethodIsManual(curwin))
766 deleteFoldEntry(found_ga,
767 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
768 else
769 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000770 if (first_lnum > found_fp->fd_top + found_off)
771 first_lnum = found_fp->fd_top + found_off;
772 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000774 if (!did_one)
775 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 deleteFoldMarkers(found_fp, recursive, found_off);
777 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000778 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // redraw window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 changed_window_setting();
782 }
783 }
784 if (!did_one)
785 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +0000786 emsg(_(e_no_fold_found));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100787 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 if (had_visual)
789 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000791 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100792 // Deleting markers may make cursor column invalid.
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000793 check_cursor_col();
794
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795 if (last_lnum > 0)
796 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
797}
798
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100799// clearFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800/*
801 * Remove all folding for window "win".
802 */
803 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100804clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805{
806 deleteFoldRecurse(&win->w_folds);
807 win->w_foldinvalid = FALSE;
808}
809
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100810// foldUpdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811/*
812 * Update folds for changes in the buffer of a window.
813 * Note that inserted/deleted lines must have already been taken care of by
814 * calling foldMarkAdjust().
815 * The changes in lines from top to bot (inclusive).
816 */
817 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100818foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819{
820 fold_T *fp;
821
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200822 if (disable_fold_update > 0)
823 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200824#ifdef FEAT_DIFF
825 if (need_diff_redraw)
826 // will update later
827 return;
828#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200829
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200830 if (wp->w_folds.ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 {
Brandon Simmons3fcccf92022-05-20 18:25:21 +0100832 linenr_T maybe_small_start = top;
833 linenr_T maybe_small_end = bot;
834
835 // Mark all folds from top to bot (or bot to top) as maybe-small.
836 if (top > bot)
837 {
838 maybe_small_start = bot;
839 maybe_small_end = top;
840 }
841 (void)foldFind(&wp->w_folds, maybe_small_start, &fp);
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200842 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
Brandon Simmons3fcccf92022-05-20 18:25:21 +0100843 && fp->fd_top <= maybe_small_end)
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200844 {
845 fp->fd_small = MAYBE;
846 ++fp;
847 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 }
849
850 if (foldmethodIsIndent(wp)
851 || foldmethodIsExpr(wp)
852 || foldmethodIsMarker(wp)
853#ifdef FEAT_DIFF
854 || foldmethodIsDiff(wp)
855#endif
856 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000857 {
858 int save_got_int = got_int;
859
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100860 // reset got_int here, otherwise it won't work
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000861 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000863 got_int |= save_got_int;
864 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865}
866
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100867// foldUpdateAll() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868/*
869 * Update all lines in a window for folding.
870 * Used when a fold setting changes or after reloading the buffer.
871 * The actual updating is postponed until fold info is used, to avoid doing
872 * every time a setting is changed or a syntax item is added.
873 */
874 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100875foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876{
877 win->w_foldinvalid = TRUE;
878 redraw_win_later(win, NOT_VALID);
879}
880
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100881// foldMoveTo() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882/*
883 * If "updown" is FALSE: Move to the start or end of the fold.
884 * If "updown" is TRUE: move to fold at the same level.
885 * If not moved return FAIL.
886 */
887 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100888foldMoveTo(
889 int updown,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100890 int dir, // FORWARD or BACKWARD
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100891 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892{
893 long n;
894 int retval = FAIL;
895 linenr_T lnum_off;
896 linenr_T lnum_found;
897 linenr_T lnum;
898 int use_level;
899 int maybe_small;
900 garray_T *gap;
901 fold_T *fp;
902 int level;
903 int last;
904
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000905 checkupdate(curwin);
906
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100907 // Repeat "count" times.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 for (n = 0; n < count; ++n)
909 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100910 // Find nested folds. Stop when a fold is closed. The deepest fold
911 // that moves the cursor is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 lnum_off = 0;
913 gap = &curwin->w_folds;
Bram Moolenaarc136a352020-11-03 20:05:40 +0100914 if (gap->ga_len == 0)
915 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 use_level = FALSE;
917 maybe_small = FALSE;
918 lnum_found = curwin->w_cursor.lnum;
919 level = 0;
920 last = FALSE;
921 for (;;)
922 {
923 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
924 {
Bram Moolenaar6a78f322020-12-21 14:01:41 +0100925 if (!updown || gap->ga_len == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 break;
927
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100928 // When moving up, consider a fold above the cursor; when
929 // moving down consider a fold below the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 if (dir == FORWARD)
931 {
932 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
933 break;
934 --fp;
935 }
936 else
937 {
938 if (fp == (fold_T *)gap->ga_data)
939 break;
940 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100941 // don't look for contained folds, they will always move
942 // the cursor too far.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 last = TRUE;
944 }
945
946 if (!last)
947 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100948 // Check if this fold is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 if (check_closed(curwin, fp, &use_level, level,
950 &maybe_small, lnum_off))
951 last = TRUE;
952
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100953 // "[z" and "]z" stop at closed fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 if (last && !updown)
955 break;
956 }
957
958 if (updown)
959 {
960 if (dir == FORWARD)
961 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100962 // to start of next fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
964 {
965 lnum = fp[1].fd_top + lnum_off;
966 if (lnum > curwin->w_cursor.lnum)
967 lnum_found = lnum;
968 }
969 }
970 else
971 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100972 // to end of previous fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 if (fp > (fold_T *)gap->ga_data)
974 {
975 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
976 if (lnum < curwin->w_cursor.lnum)
977 lnum_found = lnum;
978 }
979 }
980 }
981 else
982 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100983 // Open fold found, set cursor to its start/end and then check
984 // nested folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 if (dir == FORWARD)
986 {
987 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
988 if (lnum > curwin->w_cursor.lnum)
989 lnum_found = lnum;
990 }
991 else
992 {
993 lnum = fp->fd_top + lnum_off;
994 if (lnum < curwin->w_cursor.lnum)
995 lnum_found = lnum;
996 }
997 }
998
999 if (last)
1000 break;
1001
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001002 // Check nested folds (if any).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 gap = &fp->fd_nested;
1004 lnum_off += fp->fd_top;
1005 ++level;
1006 }
1007 if (lnum_found != curwin->w_cursor.lnum)
1008 {
1009 if (retval == FAIL)
1010 setpcmark();
1011 curwin->w_cursor.lnum = lnum_found;
1012 curwin->w_cursor.col = 0;
1013 retval = OK;
1014 }
1015 else
1016 break;
1017 }
1018
1019 return retval;
1020}
1021
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001022// foldInitWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023/*
1024 * Init the fold info in a new window.
1025 */
1026 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001027foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001029 ga_init2(&new_win->w_folds, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030}
1031
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001032// find_wl_entry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033/*
1034 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1035 * Only valid entries are considered (for entries where wl_valid is FALSE the
1036 * line number can be wrong).
1037 * Returns index of entry or -1 if not found.
1038 */
1039 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001040find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041{
1042 int i;
1043
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001044 for (i = 0; i < win->w_lines_valid; ++i)
1045 if (win->w_lines[i].wl_valid)
1046 {
1047 if (lnum < win->w_lines[i].wl_lnum)
1048 return -1;
1049 if (lnum <= win->w_lines[i].wl_lastlnum)
1050 return i;
1051 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 return -1;
1053}
1054
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001055// foldAdjustVisual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056/*
1057 * Adjust the Visual area to include any fold at the start or end completely.
1058 */
1059 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001060foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061{
1062 pos_T *start, *end;
1063 char_u *ptr;
1064
1065 if (!VIsual_active || !hasAnyFolding(curwin))
1066 return;
1067
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01001068 if (LTOREQ_POS(VIsual, curwin->w_cursor))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 {
1070 start = &VIsual;
1071 end = &curwin->w_cursor;
1072 }
1073 else
1074 {
1075 start = &curwin->w_cursor;
1076 end = &VIsual;
1077 }
1078 if (hasFolding(start->lnum, &start->lnum, NULL))
1079 start->col = 0;
1080 if (hasFolding(end->lnum, NULL, &end->lnum))
1081 {
1082 ptr = ml_get(end->lnum);
1083 end->col = (colnr_T)STRLEN(ptr);
1084 if (end->col > 0 && *p_sel == 'o')
1085 --end->col;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001086 // prevent cursor from moving on the trail byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 if (has_mbyte)
1088 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 }
1090}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001092// cursor_foldstart() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093/*
1094 * Move the cursor to the first line of a closed fold.
1095 */
1096 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001097foldAdjustCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098{
1099 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1100}
1101
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001102// Internal functions for "fold_T" {{{1
1103// cloneFoldGrowArray() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104/*
1105 * Will "clone" (i.e deep copy) a garray_T of folds.
1106 *
1107 * Return FAIL if the operation cannot be completed, otherwise OK.
1108 */
1109 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001110cloneFoldGrowArray(garray_T *from, garray_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111{
1112 int i;
1113 fold_T *from_p;
1114 fold_T *to_p;
1115
1116 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1117 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1118 return;
1119
1120 from_p = (fold_T *)from->ga_data;
1121 to_p = (fold_T *)to->ga_data;
1122
1123 for (i = 0; i < from->ga_len; i++)
1124 {
1125 to_p->fd_top = from_p->fd_top;
1126 to_p->fd_len = from_p->fd_len;
1127 to_p->fd_flags = from_p->fd_flags;
1128 to_p->fd_small = from_p->fd_small;
1129 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1130 ++to->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 ++from_p;
1132 ++to_p;
1133 }
1134}
1135
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001136// foldFind() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137/*
1138 * Search for line "lnum" in folds of growarray "gap".
Brandon Simmons2c407072022-04-23 13:50:17 +01001139 * Set "*fpp" to the fold struct for the fold that contains "lnum" or
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 * the first fold below it (careful: it can be beyond the end of the array!).
1141 * Returns FALSE when there is no fold that contains "lnum".
1142 */
1143 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001144foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145{
1146 linenr_T low, high;
1147 fold_T *fp;
1148 int i;
1149
Bram Moolenaar64f37d32020-08-31 19:58:13 +02001150 if (gap->ga_len == 0)
1151 {
1152 *fpp = NULL;
1153 return FALSE;
1154 }
1155
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 /*
1157 * Perform a binary search.
1158 * "low" is lowest index of possible match.
1159 * "high" is highest index of possible match.
1160 */
1161 fp = (fold_T *)gap->ga_data;
1162 low = 0;
1163 high = gap->ga_len - 1;
1164 while (low <= high)
1165 {
1166 i = (low + high) / 2;
1167 if (fp[i].fd_top > lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001168 // fold below lnum, adjust high
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 high = i - 1;
1170 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001171 // fold above lnum, adjust low
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 low = i + 1;
1173 else
1174 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001175 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 *fpp = fp + i;
1177 return TRUE;
1178 }
1179 }
1180 *fpp = fp + low;
1181 return FALSE;
1182}
1183
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001184// foldLevelWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185/*
1186 * Return fold level at line number "lnum" in window "wp".
1187 */
1188 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001189foldLevelWin(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190{
1191 fold_T *fp;
1192 linenr_T lnum_rel = lnum;
1193 int level = 0;
1194 garray_T *gap;
1195
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001196 // Recursively search for a fold that contains "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 gap = &wp->w_folds;
1198 for (;;)
1199 {
1200 if (!foldFind(gap, lnum_rel, &fp))
1201 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001202 // Check nested folds. Line number is relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 gap = &fp->fd_nested;
1204 lnum_rel -= fp->fd_top;
1205 ++level;
1206 }
1207
1208 return level;
1209}
1210
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001211// checkupdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212/*
1213 * Check if the folds in window "wp" are invalid and update them if needed.
1214 */
1215 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001216checkupdate(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217{
1218 if (wp->w_foldinvalid)
1219 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001220 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); // will update all
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 wp->w_foldinvalid = FALSE;
1222 }
1223}
1224
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001225// setFoldRepeat() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226/*
1227 * Open or close fold for current window at line "lnum".
1228 * Repeat "count" times.
1229 */
1230 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001231setFoldRepeat(linenr_T lnum, long count, int do_open)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232{
1233 int done;
1234 long n;
1235
1236 for (n = 0; n < count; ++n)
1237 {
1238 done = DONE_NOTHING;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001239 (void)setManualFold(lnum, do_open, FALSE, &done);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 if (!(done & DONE_ACTION))
1241 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001242 // Only give an error message when no fold could be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 if (n == 0 && !(done & DONE_FOLD))
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001244 emsg(_(e_no_fold_found));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 break;
1246 }
1247 }
1248}
1249
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001250// setManualFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251/*
1252 * Open or close the fold in the current window which contains "lnum".
1253 * Also does this for other windows in diff mode when needed.
1254 */
1255 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001256setManualFold(
1257 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001258 int opening, // TRUE when opening, FALSE when closing
1259 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001260 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261{
1262#ifdef FEAT_DIFF
1263 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1264 {
1265 win_T *wp;
1266 linenr_T dlnum;
1267
1268 /*
1269 * Do the same operation in other windows in diff mode. Calculate the
1270 * line number from the diffs.
1271 */
1272 FOR_ALL_WINDOWS(wp)
1273 {
1274 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1275 {
1276 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1277 if (dlnum != 0)
1278 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1279 }
1280 }
1281 }
1282#endif
1283
1284 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1285}
1286
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001287// setManualFoldWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288/*
1289 * Open or close the fold in window "wp" which contains "lnum".
1290 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1291 * fold was found and to DONE_ACTION when some fold was opened or closed.
1292 * When "donep" is NULL give an error message when no fold was found for
1293 * "lnum", but only if "wp" is "curwin".
1294 * Return the line number of the next line that could be closed.
1295 * It's only valid when "opening" is TRUE!
1296 */
1297 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001298setManualFoldWin(
1299 win_T *wp,
1300 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001301 int opening, // TRUE when opening, FALSE when closing
1302 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001303 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304{
1305 fold_T *fp;
1306 fold_T *fp2;
1307 fold_T *found = NULL;
1308 int j;
1309 int level = 0;
1310 int use_level = FALSE;
1311 int found_fold = FALSE;
1312 garray_T *gap;
1313 linenr_T next = MAXLNUM;
1314 linenr_T off = 0;
1315 int done = 0;
1316
1317 checkupdate(wp);
1318
1319 /*
1320 * Find the fold, open or close it.
1321 */
1322 gap = &wp->w_folds;
1323 for (;;)
1324 {
1325 if (!foldFind(gap, lnum, &fp))
1326 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001327 // If there is a following fold, continue there next time.
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02001328 if (fp != NULL && fp < (fold_T *)gap->ga_data + gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 next = fp->fd_top + off;
1330 break;
1331 }
1332
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001333 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 found_fold = TRUE;
1335
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001336 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1338 next = fp[1].fd_top + off;
1339
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001340 // Change from level-dependent folding to manual.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 if (use_level || fp->fd_flags == FD_LEVEL)
1342 {
1343 use_level = TRUE;
1344 if (level >= wp->w_p_fdl)
1345 fp->fd_flags = FD_CLOSED;
1346 else
1347 fp->fd_flags = FD_OPEN;
1348 fp2 = (fold_T *)fp->fd_nested.ga_data;
1349 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1350 fp2[j].fd_flags = FD_LEVEL;
1351 }
1352
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001353 // Simple case: Close recursively means closing the fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 if (!opening && recurse)
1355 {
1356 if (fp->fd_flags != FD_CLOSED)
1357 {
1358 done |= DONE_ACTION;
1359 fp->fd_flags = FD_CLOSED;
1360 }
1361 }
1362 else if (fp->fd_flags == FD_CLOSED)
1363 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001364 // When opening, open topmost closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 if (opening)
1366 {
1367 fp->fd_flags = FD_OPEN;
1368 done |= DONE_ACTION;
1369 if (recurse)
1370 foldOpenNested(fp);
1371 }
1372 break;
1373 }
1374
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001375 // fold is open, check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 found = fp;
1377 gap = &fp->fd_nested;
1378 lnum -= fp->fd_top;
1379 off += fp->fd_top;
1380 ++level;
1381 }
1382 if (found_fold)
1383 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001384 // When closing and not recurse, close deepest open fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 if (!opening && found != NULL)
1386 {
1387 found->fd_flags = FD_CLOSED;
1388 done |= DONE_ACTION;
1389 }
1390 wp->w_fold_manual = TRUE;
1391 if (done & DONE_ACTION)
1392 changed_window_setting_win(wp);
1393 done |= DONE_FOLD;
1394 }
1395 else if (donep == NULL && wp == curwin)
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001396 emsg(_(e_no_fold_found));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
1398 if (donep != NULL)
1399 *donep |= done;
1400
1401 return next;
1402}
1403
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001404// foldOpenNested() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405/*
1406 * Open all nested folds in fold "fpr" recursively.
1407 */
1408 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001409foldOpenNested(fold_T *fpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410{
1411 int i;
1412 fold_T *fp;
1413
1414 fp = (fold_T *)fpr->fd_nested.ga_data;
1415 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1416 {
1417 foldOpenNested(&fp[i]);
1418 fp[i].fd_flags = FD_OPEN;
1419 }
1420}
1421
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001422// deleteFoldEntry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423/*
1424 * Delete fold "idx" from growarray "gap".
1425 * When "recursive" is TRUE also delete all the folds contained in it.
1426 * When "recursive" is FALSE contained folds are moved one level up.
1427 */
1428 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001429deleteFoldEntry(garray_T *gap, int idx, int recursive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430{
1431 fold_T *fp;
1432 int i;
1433 long moved;
1434 fold_T *nfp;
1435
1436 fp = (fold_T *)gap->ga_data + idx;
1437 if (recursive || fp->fd_nested.ga_len == 0)
1438 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001439 // recursively delete the contained folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 deleteFoldRecurse(&fp->fd_nested);
1441 --gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 if (idx < gap->ga_len)
1443 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1444 }
1445 else
1446 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001447 // Move nested folds one level up, to overwrite the fold that is
1448 // deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 moved = fp->fd_nested.ga_len;
1450 if (ga_grow(gap, (int)(moved - 1)) == OK)
1451 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001452 // Get "fp" again, the array may have been reallocated.
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001453 fp = (fold_T *)gap->ga_data + idx;
1454
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001455 // adjust fd_top and fd_flags for the moved folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 nfp = (fold_T *)fp->fd_nested.ga_data;
1457 for (i = 0; i < moved; ++i)
1458 {
1459 nfp[i].fd_top += fp->fd_top;
1460 if (fp->fd_flags == FD_LEVEL)
1461 nfp[i].fd_flags = FD_LEVEL;
1462 if (fp->fd_small == MAYBE)
1463 nfp[i].fd_small = MAYBE;
1464 }
1465
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001466 // move the existing folds down to make room
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001467 if (idx + 1 < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 mch_memmove(fp + moved, fp + 1,
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001469 sizeof(fold_T) * (gap->ga_len - (idx + 1)));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001470 // move the contained folds one level up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1472 vim_free(nfp);
1473 gap->ga_len += moved - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 }
1475 }
1476}
1477
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001478// deleteFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479/*
1480 * Delete nested folds in a fold.
1481 */
1482 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001483deleteFoldRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484{
1485 int i;
1486
1487 for (i = 0; i < gap->ga_len; ++i)
1488 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1489 ga_clear(gap);
1490}
1491
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001492// foldMarkAdjust() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493/*
1494 * Update line numbers of folds for inserted/deleted lines.
1495 */
1496 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001497foldMarkAdjust(
1498 win_T *wp,
1499 linenr_T line1,
1500 linenr_T line2,
1501 long amount,
1502 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001504 // If deleting marks from line1 to line2, but not deleting all those
1505 // lines, set line2 so that only deleted lines have their folds removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1507 line2 = line1 - amount_after - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001508 // If appending a line in Insert mode, it should be included in the fold
1509 // just above the line.
Bram Moolenaar24959102022-05-07 20:01:16 +01001510 if ((State & MODE_INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 --line1;
1512 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1513}
1514
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001515// foldMarkAdjustRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001517foldMarkAdjustRecurse(
1518 garray_T *gap,
1519 linenr_T line1,
1520 linenr_T line2,
1521 long amount,
1522 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523{
1524 fold_T *fp;
1525 int i;
1526 linenr_T last;
1527 linenr_T top;
1528
Bram Moolenaar07e87e92020-08-31 21:22:40 +02001529 if (gap->ga_len == 0)
1530 return;
1531
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001532 // In Insert mode an inserted line at the top of a fold is considered part
1533 // of the fold, otherwise it isn't.
Bram Moolenaar24959102022-05-07 20:01:16 +01001534 if ((State & MODE_INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 top = line1 + 1;
1536 else
1537 top = line1;
1538
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001539 // Find the fold containing or just below "line1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 (void)foldFind(gap, line1, &fp);
1541
1542 /*
1543 * Adjust all folds below "line1" that are affected.
1544 */
1545 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1546 {
1547 /*
1548 * Check for these situations:
1549 * 1 2 3
1550 * 1 2 3
1551 * line1 2 3 4 5
1552 * 2 3 4 5
1553 * 2 3 4 5
1554 * line2 2 3 4 5
1555 * 3 5 6
1556 * 3 5 6
1557 */
1558
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001559 last = fp->fd_top + fp->fd_len - 1; // last line of fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001561 // 1. fold completely above line1: nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 if (last < line1)
1563 continue;
1564
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001565 // 6. fold below line2: only adjust for amount_after
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 if (fp->fd_top > line2)
1567 {
1568 if (amount_after == 0)
1569 break;
1570 fp->fd_top += amount_after;
1571 }
1572 else
1573 {
1574 if (fp->fd_top >= top && last <= line2)
1575 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001576 // 4. fold completely contained in range
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 if (amount == MAXLNUM)
1578 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001579 // Deleting lines: delete the fold completely
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 deleteFoldEntry(gap, i, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001581 --i; // adjust index for deletion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 --fp;
1583 }
1584 else
1585 fp->fd_top += amount;
1586 }
1587 else
1588 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 if (fp->fd_top < top)
1590 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001591 // 2 or 3: need to correct nested folds too
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001592 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1593 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 if (last <= line2)
1595 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001596 // 2. fold contains line1, line2 is below fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 if (amount == MAXLNUM)
1598 fp->fd_len = line1 - fp->fd_top;
1599 else
1600 fp->fd_len += amount;
1601 }
1602 else
1603 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001604 // 3. fold contains line1 and line2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 fp->fd_len += amount_after;
1606 }
1607 }
1608 else
1609 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001610 // 5. fold is below line1 and contains line2; need to
1611 // correct nested folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 if (amount == MAXLNUM)
1613 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001614 foldMarkAdjustRecurse(&fp->fd_nested,
Bram Moolenaar6b434712022-02-15 19:15:22 +00001615 0,
Bram Moolenaar1159b162017-02-28 21:53:56 +01001616 line2 - fp->fd_top,
1617 amount,
1618 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 fp->fd_len -= line2 - fp->fd_top + 1;
1620 fp->fd_top = line1;
1621 }
1622 else
1623 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001624 foldMarkAdjustRecurse(&fp->fd_nested,
Bram Moolenaar6b434712022-02-15 19:15:22 +00001625 0,
Bram Moolenaar1159b162017-02-28 21:53:56 +01001626 line2 - fp->fd_top,
1627 amount,
1628 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 fp->fd_len += amount_after - amount;
1630 fp->fd_top += amount;
1631 }
1632 }
1633 }
1634 }
1635 }
1636}
1637
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001638// getDeepestNesting() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639/*
1640 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1641 * current window open.
1642 */
1643 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001644getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645{
1646 checkupdate(curwin);
1647 return getDeepestNestingRecurse(&curwin->w_folds);
1648}
1649
1650 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001651getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652{
1653 int i;
1654 int level;
1655 int maxlevel = 0;
1656 fold_T *fp;
1657
1658 fp = (fold_T *)gap->ga_data;
1659 for (i = 0; i < gap->ga_len; ++i)
1660 {
1661 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1662 if (level > maxlevel)
1663 maxlevel = level;
1664 }
1665
1666 return maxlevel;
1667}
1668
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001669// check_closed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670/*
1671 * Check if a fold is closed and update the info needed to check nested folds.
1672 */
1673 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001674check_closed(
1675 win_T *win,
1676 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001677 int *use_levelp, // TRUE: outer fold had FD_LEVEL
1678 int level, // folding depth
1679 int *maybe_smallp, // TRUE: outer this had fd_small == MAYBE
1680 linenr_T lnum_off) // line number offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681{
1682 int closed = FALSE;
1683
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001684 // Check if this fold is closed. If the flag is FD_LEVEL this
1685 // fold and all folds it contains depend on 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1687 {
1688 *use_levelp = TRUE;
1689 if (level >= win->w_p_fdl)
1690 closed = TRUE;
1691 }
1692 else if (fp->fd_flags == FD_CLOSED)
1693 closed = TRUE;
1694
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001695 // Small fold isn't closed anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 if (fp->fd_small == MAYBE)
1697 *maybe_smallp = TRUE;
1698 if (closed)
1699 {
1700 if (*maybe_smallp)
1701 fp->fd_small = MAYBE;
1702 checkSmall(win, fp, lnum_off);
1703 if (fp->fd_small == TRUE)
1704 closed = FALSE;
1705 }
1706 return closed;
1707}
1708
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001709// checkSmall() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710/*
1711 * Update fd_small field of fold "fp".
1712 */
1713 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001714checkSmall(
1715 win_T *wp,
1716 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001717 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718{
1719 int count;
1720 int n;
1721
1722 if (fp->fd_small == MAYBE)
1723 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001724 // Mark any nested folds to maybe-small
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 setSmallMaybe(&fp->fd_nested);
1726
1727 if (fp->fd_len > curwin->w_p_fml)
1728 fp->fd_small = FALSE;
1729 else
1730 {
1731 count = 0;
1732 for (n = 0; n < fp->fd_len; ++n)
1733 {
1734 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1735 if (count > curwin->w_p_fml)
1736 {
1737 fp->fd_small = FALSE;
1738 return;
1739 }
1740 }
1741 fp->fd_small = TRUE;
1742 }
1743 }
1744}
1745
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001746// setSmallMaybe() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747/*
1748 * Set small flags in "gap" to MAYBE.
1749 */
1750 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001751setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752{
1753 int i;
1754 fold_T *fp;
1755
1756 fp = (fold_T *)gap->ga_data;
1757 for (i = 0; i < gap->ga_len; ++i)
1758 fp[i].fd_small = MAYBE;
1759}
1760
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001761// foldCreateMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762/*
1763 * Create a fold from line "start" to line "end" (inclusive) in the current
1764 * window by adding markers.
1765 */
1766 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001767foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768{
1769 if (!curbuf->b_p_ma)
1770 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001771 emsg(_(e_cannot_make_changes_modifiable_is_off));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 return;
1773 }
1774 parseMarker(curwin);
1775
1776 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1777 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1778
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001779 // Update both changes here, to avoid all folds after the start are
1780 // changed when the start marker is inserted and the end isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 changed_lines(start, (colnr_T)0, end, 0L);
1782}
1783
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001784// foldAddMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785/*
1786 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1787 */
1788 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001789foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790{
1791 char_u *cms = curbuf->b_p_cms;
1792 char_u *line;
1793 int line_len;
1794 char_u *newline;
1795 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001796 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001798 // Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 line = ml_get(lnum);
1800 line_len = (int)STRLEN(line);
1801
1802 if (u_save(lnum - 1, lnum + 1) == OK)
1803 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001804 // Check if the line ends with an unclosed comment
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001805 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
Bram Moolenaar964b3742019-05-24 18:54:09 +02001806 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 if (newline == NULL)
1808 return;
1809 STRCPY(newline, line);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001810 // Append the marker to the end of the line
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001811 if (p == NULL || line_is_comment)
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001812 vim_strncpy(newline + line_len, marker, markerlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 else
1814 {
1815 STRCPY(newline + line_len, cms);
1816 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1817 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1818 }
1819
1820 ml_replace(lnum, newline, FALSE);
1821 }
1822}
1823
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001824// deleteFoldMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825/*
1826 * Delete the markers for a fold, causing it to be deleted.
1827 */
1828 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001829deleteFoldMarkers(
1830 fold_T *fp,
1831 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001832 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833{
1834 int i;
1835
1836 if (recursive)
1837 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1838 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1839 lnum_off + fp->fd_top);
1840 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1841 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1842 foldendmarker, foldendmarkerlen);
1843}
1844
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001845// foldDelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846/*
1847 * Delete marker "marker[markerlen]" at the end of line "lnum".
1848 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001849 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 * close-marker.
1851 */
1852 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001853foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854{
1855 char_u *line;
1856 char_u *newline;
1857 char_u *p;
1858 int len;
1859 char_u *cms = curbuf->b_p_cms;
1860 char_u *cms2;
1861
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001862 // end marker may be missing and fold extends below the last line
1863 if (lnum > curbuf->b_ml.ml_line_count)
1864 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 line = ml_get(lnum);
1866 for (p = line; *p != NUL; ++p)
1867 if (STRNCMP(p, marker, markerlen) == 0)
1868 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001869 // Found the marker, include a digit if it's there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 len = markerlen;
1871 if (VIM_ISDIGIT(p[len]))
1872 ++len;
1873 if (*cms != NUL)
1874 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001875 // Also delete 'commentstring' if it matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 cms2 = (char_u *)strstr((char *)cms, "%s");
1877 if (p - line >= cms2 - cms
1878 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1879 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1880 {
1881 p -= cms2 - cms;
1882 len += (int)STRLEN(cms) - 2;
1883 }
1884 }
1885 if (u_save(lnum - 1, lnum + 1) == OK)
1886 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001887 // Make new line: text-before-marker + text-after-marker
Bram Moolenaar964b3742019-05-24 18:54:09 +02001888 newline = alloc(STRLEN(line) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 if (newline != NULL)
1890 {
1891 STRNCPY(newline, line, p - line);
1892 STRCPY(newline + (p - line), p + len);
1893 ml_replace(lnum, newline, FALSE);
1894 }
1895 }
1896 break;
1897 }
1898}
1899
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001900// get_foldtext() {{{2
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001901/*
1902 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001903 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1904 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001905 */
1906 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001907get_foldtext(
1908 win_T *wp,
1909 linenr_T lnum,
1910 linenr_T lnume,
1911 foldinfo_T *foldinfo,
1912 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001913{
1914 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001915#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001916 // an error occurred when evaluating 'fdt' setting
Bram Moolenaardab38d52013-06-15 17:06:36 +02001917 static int got_fdt_error = FALSE;
1918 int save_did_emsg = did_emsg;
1919 static win_T *last_wp = NULL;
1920 static linenr_T last_lnum = 0;
1921
1922 if (last_wp != wp || last_wp == NULL
1923 || last_lnum > lnum || last_lnum == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001924 // window changed, try evaluating foldtext setting once again
Bram Moolenaardab38d52013-06-15 17:06:36 +02001925 got_fdt_error = FALSE;
1926
1927 if (!got_fdt_error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001928 // a previous error should not abort evaluating 'foldexpr'
Bram Moolenaardab38d52013-06-15 17:06:36 +02001929 did_emsg = FALSE;
1930
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001931 if (*wp->w_p_fdt != NUL)
1932 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001933 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001934 int level;
1935 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001936
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001937 // Set "v:foldstart" and "v:foldend".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001938 set_vim_var_nr(VV_FOLDSTART, lnum);
1939 set_vim_var_nr(VV_FOLDEND, lnume);
1940
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001941 // Set "v:folddashes" to a string of "level" dashes.
1942 // Set "v:foldlevel" to "level".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001943 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001944 if (level > (int)sizeof(dashes) - 1)
1945 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001946 vim_memset(dashes, '-', (size_t)level);
1947 dashes[level] = NUL;
1948 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1949 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001950
Bram Moolenaar9530b582022-01-22 13:39:08 +00001951 // skip evaluating 'foldtext' on errors
Bram Moolenaardab38d52013-06-15 17:06:36 +02001952 if (!got_fdt_error)
1953 {
Bram Moolenaar9530b582022-01-22 13:39:08 +00001954 win_T *save_curwin = curwin;
1955 sctx_T saved_sctx = current_sctx;
1956
Bram Moolenaardab38d52013-06-15 17:06:36 +02001957 curwin = wp;
1958 curbuf = wp->w_buffer;
Bram Moolenaar9530b582022-01-22 13:39:08 +00001959 current_sctx = wp->w_p_script_ctx[WV_FDT];
Bram Moolenaardab38d52013-06-15 17:06:36 +02001960
Bram Moolenaar9530b582022-01-22 13:39:08 +00001961 ++emsg_off; // handle exceptions, but don't display errors
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001962 text = eval_to_string_safe(wp->w_p_fdt,
Bram Moolenaar9530b582022-01-22 13:39:08 +00001963 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL), TRUE);
1964 --emsg_off;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001965
Bram Moolenaardab38d52013-06-15 17:06:36 +02001966 if (text == NULL || did_emsg)
1967 got_fdt_error = TRUE;
1968
1969 curwin = save_curwin;
1970 curbuf = curwin->w_buffer;
Bram Moolenaar9530b582022-01-22 13:39:08 +00001971 current_sctx = saved_sctx;
Bram Moolenaardab38d52013-06-15 17:06:36 +02001972 }
1973 last_lnum = lnum;
1974 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001975 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1976
Bram Moolenaardab38d52013-06-15 17:06:36 +02001977 if (!did_emsg && save_did_emsg)
1978 did_emsg = save_did_emsg;
1979
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001980 if (text != NULL)
1981 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001982 // Replace unprintable characters, if there are any. But
1983 // replace a TAB with a space.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001984 for (p = text; *p != NUL; ++p)
1985 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001986 int len;
1987
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001988 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001989 {
1990 if (!vim_isprintc((*mb_ptr2char)(p)))
1991 break;
1992 p += len - 1;
1993 }
1994 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001995 if (*p == TAB)
1996 *p = ' ';
1997 else if (ptr2cells(p) > 1)
1998 break;
1999 }
2000 if (*p != NUL)
2001 {
2002 p = transstr(text);
2003 vim_free(text);
2004 text = p;
2005 }
2006 }
2007 }
2008 if (text == NULL)
2009#endif
2010 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02002011 long count = (long)(lnume - lnum + 1);
2012
2013 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01002014 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02002015 "+--%3ld lines folded ", count),
2016 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002017 text = buf;
2018 }
2019 return text;
2020}
2021
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002022// foldtext_cleanup() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +02002023#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024/*
2025 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2026 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02002027 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002028foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002030 char_u *cms_start; // first part or the whole comment
2031 int cms_slen = 0; // length of cms_start
2032 char_u *cms_end; // last part of the comment or NULL
2033 int cms_elen = 0; // length of cms_end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002035 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 int len;
2037 int did1 = FALSE;
2038 int did2 = FALSE;
2039
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002040 // Ignore leading and trailing white space in 'commentstring'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002042 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002043 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 --cms_slen;
2045
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002046 // locate "%s" in 'commentstring', use the part before and after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2048 if (cms_end != NULL)
2049 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002050 cms_elen = cms_slen - (int)(cms_end - cms_start);
2051 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002053 // exclude white space before "%s"
Bram Moolenaar1c465442017-03-12 20:10:05 +01002054 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 --cms_slen;
2056
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002057 // skip "%s" and white space after it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002059 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 cms_end = s;
2061 }
2062 parseMarker(curwin);
2063
2064 for (s = str; *s != NUL; )
2065 {
2066 len = 0;
2067 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002071 if (len > 0)
2072 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 if (VIM_ISDIGIT(s[len]))
2074 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002075
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002076 // May remove 'commentstring' start. Useful when it's a double
2077 // quote and we already removed a double quote.
Bram Moolenaar1c465442017-03-12 20:10:05 +01002078 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002079 ;
2080 if (p >= str + cms_slen
2081 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2082 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002083 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002084 s = p - cms_slen;
2085 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 }
2087 else if (cms_end != NULL)
2088 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002089 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 {
2091 len = cms_slen;
2092 did1 = TRUE;
2093 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002094 else if (!did2 && cms_elen > 0
2095 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 {
2097 len = cms_elen;
2098 did2 = TRUE;
2099 }
2100 }
2101 if (len != 0)
2102 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002103 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002105 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 }
2107 else
2108 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002109 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 }
2111 }
2112}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002113#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002115// Folding by indent, expr, marker and syntax. {{{1
2116// Define "fline_T", passed to get fold level for a line. {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117typedef struct
2118{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002119 win_T *wp; // window
2120 linenr_T lnum; // current line number
2121 linenr_T off; // offset between lnum and real line number
2122 linenr_T lnum_save; // line nr used by foldUpdateIEMSRecurse()
2123 int lvl; // current level (-1 for undefined)
2124 int lvl_next; // level used for next line
2125 int start; // number of folds that are forced to start at
2126 // this line.
2127 int end; // level of fold that is forced to end below
2128 // this line
2129 int had_end; // level of fold that is forced to end above
2130 // this line (copy of "end" of prev. line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131} fline_T;
2132
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002133// Flag is set when redrawing is needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134static int fold_changed;
2135
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002136// Function declarations. {{{2
Bram Moolenaard99df422016-01-29 23:20:40 +01002137static 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 +01002138static int foldInsert(garray_T *gap, int i);
2139static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2140static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2141static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2142static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002144static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002146static void foldlevelExpr(fline_T *flp);
2147static void foldlevelMarker(fline_T *flp);
2148static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002150// foldUpdateIEMS() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151/*
2152 * Update the folding for window "wp", at least from lines "top" to "bot".
2153 * Return TRUE if any folds did change.
2154 */
2155 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002156foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157{
2158 linenr_T start;
2159 linenr_T end;
2160 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002161 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 int level;
2163 fold_T *fp;
2164
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002165 // Avoid problems when being called recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 if (invalid_top != (linenr_T)0)
2167 return;
2168
2169 if (wp->w_foldinvalid)
2170 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002171 // Need to update all folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 top = 1;
2173 bot = wp->w_buffer->b_ml.ml_line_count;
2174 wp->w_foldinvalid = FALSE;
2175
Brandon Simmons3fcccf92022-05-20 18:25:21 +01002176 // Mark all folds as maybe-small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 setSmallMaybe(&wp->w_folds);
2178 }
2179
2180#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002181 // add the context for "diff" folding
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 if (foldmethodIsDiff(wp))
2183 {
2184 if (top > diff_context)
2185 top -= diff_context;
2186 else
2187 top = 1;
2188 bot += diff_context;
2189 }
2190#endif
2191
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002192 // When deleting lines at the end of the buffer "top" can be past the end
2193 // of the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 if (top > wp->w_buffer->b_ml.ml_line_count)
2195 top = wp->w_buffer->b_ml.ml_line_count;
2196
2197 fold_changed = FALSE;
2198 fline.wp = wp;
2199 fline.off = 0;
2200 fline.lvl = 0;
2201 fline.lvl_next = -1;
2202 fline.start = 0;
2203 fline.end = MAX_LEVEL + 1;
2204 fline.had_end = MAX_LEVEL + 1;
2205
2206 invalid_top = top;
2207 invalid_bot = bot;
2208
2209 if (foldmethodIsMarker(wp))
2210 {
2211 getlevel = foldlevelMarker;
2212
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002213 // Init marker variables to speed up foldlevelMarker().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 parseMarker(wp);
2215
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002216 // Need to get the level of the line above top, it is used if there is
2217 // no marker at the top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 if (top > 1)
2219 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002220 // Get the fold level at top - 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 level = foldLevelWin(wp, top - 1);
2222
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002223 // The fold may end just above the top, check for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 fline.lnum = top - 1;
2225 fline.lvl = level;
2226 getlevel(&fline);
2227
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002228 // If a fold started here, we already had the level, if it stops
2229 // here, we need to use lvl_next. Could also start and end a fold
2230 // in the same line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 if (fline.lvl > level)
2232 fline.lvl = level - (fline.lvl - fline.lvl_next);
2233 else
2234 fline.lvl = fline.lvl_next;
2235 }
2236 fline.lnum = top;
2237 getlevel(&fline);
2238 }
2239 else
2240 {
2241 fline.lnum = top;
2242 if (foldmethodIsExpr(wp))
2243 {
2244 getlevel = foldlevelExpr;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002245 // start one line back, because a "<1" may indicate the end of a
2246 // fold in the topline
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 if (top > 1)
2248 --fline.lnum;
2249 }
2250 else if (foldmethodIsSyntax(wp))
2251 getlevel = foldlevelSyntax;
2252#ifdef FEAT_DIFF
2253 else if (foldmethodIsDiff(wp))
2254 getlevel = foldlevelDiff;
2255#endif
2256 else
Brandon Simmonsd98e75e2022-05-10 19:13:23 +01002257 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 getlevel = foldlevelIndent;
Brandon Simmonsd98e75e2022-05-10 19:13:23 +01002259 // Start one line back, because if the line above "top" has an
2260 // undefined fold level, folding it relies on the line under it,
2261 // which is "top".
2262 if (top > 1)
2263 --fline.lnum;
2264 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002266 // Backup to a line for which the fold level is defined. Since it's
2267 // always defined for line one, we will stop there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 fline.lvl = -1;
2269 for ( ; !got_int; --fline.lnum)
2270 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002271 // Reset lvl_next each time, because it will be set to a value for
2272 // the next line, but we search backwards here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 fline.lvl_next = -1;
2274 getlevel(&fline);
2275 if (fline.lvl >= 0)
2276 break;
2277 }
2278 }
2279
Bram Moolenaarec986472009-11-03 13:46:54 +00002280 /*
2281 * If folding is defined by the syntax, it is possible that a change in
2282 * one line will cause all sub-folds of the current fold to change (e.g.,
2283 * closing a C-style comment can cause folds in the subsequent lines to
2284 * appear). To take that into account we should adjust the value of "bot"
2285 * to point to the end of the current fold:
2286 */
2287 if (foldlevelSyntax == getlevel)
2288 {
2289 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002290 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002291 int current_fdl = 0;
2292 linenr_T fold_start_lnum = 0;
2293 linenr_T lnum_rel = fline.lnum;
2294
2295 while (current_fdl < fline.lvl)
2296 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002297 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002298 break;
2299 ++current_fdl;
2300
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002301 fold_start_lnum += fpn->fd_top;
2302 gap = &fpn->fd_nested;
2303 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002304 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002305 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002306 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002307 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002308
2309 if (fold_end_lnum > bot)
2310 bot = fold_end_lnum;
2311 }
2312 }
2313
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 start = fline.lnum;
2315 end = bot;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002316 // Do at least one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2318 end = start;
2319 while (!got_int)
2320 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002321 // Always stop at the end of the file ("end" can be past the end of
2322 // the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2324 break;
2325 if (fline.lnum > end)
2326 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002327 // For "marker", "expr" and "syntax" methods: If a change caused
2328 // a fold to be removed, we need to continue at least until where
2329 // it ended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 if (getlevel != foldlevelMarker
2331 && getlevel != foldlevelSyntax
2332 && getlevel != foldlevelExpr)
2333 break;
2334 if ((start <= end
2335 && foldFind(&wp->w_folds, end, &fp)
2336 && fp->fd_top + fp->fd_len - 1 > end)
2337 || (fline.lvl == 0
2338 && foldFind(&wp->w_folds, fline.lnum, &fp)
2339 && fp->fd_top < fline.lnum))
2340 end = fp->fd_top + fp->fd_len - 1;
2341 else if (getlevel == foldlevelSyntax
2342 && foldLevelWin(wp, fline.lnum) != fline.lvl)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002343 // For "syntax" method: Compare the foldlevel that the syntax
2344 // tells us to the foldlevel from the existing folds. If they
2345 // don't match continue updating folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 end = fline.lnum;
2347 else
2348 break;
2349 }
2350
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002351 // A level 1 fold starts at a line with foldlevel > 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 if (fline.lvl > 0)
2353 {
2354 invalid_top = fline.lnum;
2355 invalid_bot = end;
2356 end = foldUpdateIEMSRecurse(&wp->w_folds,
2357 1, start, &fline, getlevel, end, FD_LEVEL);
2358 start = fline.lnum;
2359 }
2360 else
2361 {
2362 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2363 break;
2364 ++fline.lnum;
2365 fline.lvl = fline.lvl_next;
2366 getlevel(&fline);
2367 }
2368 }
2369
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002370 // There can't be any folds from start until end now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 foldRemove(&wp->w_folds, start, end);
2372
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002373 // If some fold changed, need to redraw and position cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002375 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002377 // If we updated folds past "bot", need to redraw more lines. Don't do
2378 // this in other situations, the changed lines will be redrawn anyway and
2379 // this method can cause the whole window to be updated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 if (end != bot)
2381 {
2382 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2383 wp->w_redraw_top = top;
2384 if (wp->w_redraw_bot < end)
2385 wp->w_redraw_bot = end;
2386 }
2387
2388 invalid_top = (linenr_T)0;
2389}
2390
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002391// foldUpdateIEMSRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392/*
2393 * Update a fold that starts at "flp->lnum". At this line there is always a
2394 * valid foldlevel, and its level >= "level".
2395 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2396 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2397 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2398 * the marker method and a text change made following folds to change.
2399 * When returning, "flp->lnum_save" is the line number that was used to get
2400 * the level when the level at "flp->lnum" is invalid.
2401 * Remove any folds from "startlnum" up to here at this level.
2402 * Recursively update nested folds.
2403 * Below line "bot" there are no changes in the text.
2404 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2405 * outer fold.
2406 * "flp->off" is the offset to the real line number in the buffer.
2407 *
2408 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002409 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2411 *
2412 * Returns bot, which may have been increased for lines that also need to be
2413 * updated as a result of a detected change in the fold.
2414 */
2415 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002416foldUpdateIEMSRecurse(
2417 garray_T *gap,
2418 int level,
2419 linenr_T startlnum,
2420 fline_T *flp,
2421 void (*getlevel)(fline_T *),
2422 linenr_T bot,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002423 int topflags) // flags used by containing fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424{
2425 linenr_T ll;
2426 fold_T *fp = NULL;
2427 fold_T *fp2;
2428 int lvl = level;
2429 linenr_T startlnum2 = startlnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002430 linenr_T firstlnum = flp->lnum; // first lnum we got
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 int i;
2432 int finish = FALSE;
2433 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2434 int concat;
2435
2436 /*
2437 * If using the marker method, the start line is not the start of a fold
2438 * at the level we're dealing with and the level is non-zero, we must use
2439 * the previous fold. But ignore a fold that starts at or below
2440 * startlnum, it must be deleted.
2441 */
2442 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2443 && flp->lvl > 0)
2444 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002445 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaarda697642020-09-17 19:36:04 +02002446 if (fp != NULL && (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2447 || fp->fd_top >= startlnum))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 fp = NULL;
2449 }
2450
2451 /*
2452 * Loop over all lines in this fold, or until "bot" is hit.
2453 * Handle nested folds inside of this fold.
2454 * "flp->lnum" is the current line. When finding the end of the fold, it
2455 * is just below the end of the fold.
2456 * "*flp" contains the level of the line "flp->lnum" or a following one if
2457 * there are lines with an invalid fold level. "flp->lnum_save" is the
2458 * line number that was used to get the fold level (below "flp->lnum" when
2459 * it has an invalid fold level). When called the fold level is always
2460 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2461 */
2462 flp->lnum_save = flp->lnum;
2463 while (!got_int)
2464 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002465 // Updating folds can be slow, check for CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 line_breakcheck();
2467
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002468 // Set "lvl" to the level of line "flp->lnum". When flp->start is set
2469 // and after the first line of the fold, set the level to zero to
2470 // force the fold to end. Do the same when had_end is set: Previous
2471 // line was marked as end of a fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 lvl = flp->lvl;
2473 if (lvl > MAX_LEVEL)
2474 lvl = MAX_LEVEL;
2475 if (flp->lnum > firstlnum
2476 && (level > lvl - flp->start || level >= flp->had_end))
2477 lvl = 0;
2478
2479 if (flp->lnum > bot && !finish && fp != NULL)
2480 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002481 // For "marker" and "syntax" methods:
2482 // - If a change caused a nested fold to be removed, we need to
2483 // delete it and continue at least until where it ended.
2484 // - If a change caused a nested fold to be created, or this fold
2485 // to continue below its original end, need to finish this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 if (getlevel != foldlevelMarker
2487 && getlevel != foldlevelExpr
2488 && getlevel != foldlevelSyntax)
2489 break;
2490 i = 0;
2491 fp2 = fp;
2492 if (lvl >= level)
2493 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002494 // Compute how deep the folds currently are, if it's deeper
2495 // than "lvl" then some must be deleted, need to update
2496 // at least one nested fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 ll = flp->lnum - fp->fd_top;
2498 while (foldFind(&fp2->fd_nested, ll, &fp2))
2499 {
2500 ++i;
2501 ll -= fp2->fd_top;
2502 }
2503 }
2504 if (lvl < level + i)
2505 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002506 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 if (fp2 != NULL)
2508 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2509 }
2510 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2511 finish = TRUE;
2512 else
2513 break;
2514 }
2515
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002516 // At the start of the first nested fold and at the end of the current
2517 // fold: check if existing folds at this level, before the current
2518 // one, need to be deleted or truncated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 if (fp == NULL
2520 && (lvl != level
2521 || flp->lnum_save >= bot
2522 || flp->start != 0
2523 || flp->had_end <= MAX_LEVEL
2524 || flp->lnum == linecount))
2525 {
2526 /*
2527 * Remove or update folds that have lines between startlnum and
2528 * firstlnum.
2529 */
2530 while (!got_int)
2531 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00002532 // set concat to 1 if it's allowed to concatenate this fold
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002533 // with a previous one that touches it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2535 concat = 0;
2536 else
2537 concat = 1;
2538
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002539 // Find an existing fold to re-use. Preferably one that
2540 // includes startlnum, otherwise one that ends just before
2541 // startlnum or starts after it.
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002542 if (gap->ga_len > 0 && (foldFind(gap, startlnum, &fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2544 && fp->fd_top <= firstlnum)
2545 || foldFind(gap, firstlnum - concat, &fp)
2546 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2547 && ((lvl < level && fp->fd_top < flp->lnum)
2548 || (lvl >= level
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002549 && fp->fd_top <= flp->lnum_save)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 {
2551 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2552 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002553 // Use existing fold for the new fold. If it starts
2554 // before where we started looking, extend it. If it
2555 // starts at another line, update nested folds to keep
2556 // their position, compensating for the new fd_top.
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002557 if (fp->fd_top == firstlnum)
2558 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002559 // have found a fold beginning where we want
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002560 }
2561 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 {
2563 if (fp->fd_top > firstlnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002564 // like lines are inserted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 foldMarkAdjustRecurse(&fp->fd_nested,
2566 (linenr_T)0, (linenr_T)MAXLNUM,
2567 (long)(fp->fd_top - firstlnum), 0L);
2568 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002569 // like lines are deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 foldMarkAdjustRecurse(&fp->fd_nested,
2571 (linenr_T)0,
2572 (long)(firstlnum - fp->fd_top - 1),
2573 (linenr_T)MAXLNUM,
2574 (long)(fp->fd_top - firstlnum));
2575 fp->fd_len += fp->fd_top - firstlnum;
2576 fp->fd_top = firstlnum;
2577 fold_changed = TRUE;
2578 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002579 else if ((flp->start != 0 && lvl == level)
2580 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002582 linenr_T breakstart;
2583 linenr_T breakend;
2584
2585 /*
2586 * Before there was a fold spanning from above
2587 * startlnum to below firstlnum. This fold is valid
2588 * above startlnum (because we are not updating
2589 * that range), but there should now be a break in
2590 * it.
2591 * If the break is because we are now forced to
2592 * start a new fold at the level "level" at line
2593 * fline->lnum, then we need to split the fold at
2594 * fline->lnum.
2595 * If the break is because the range
2596 * [startlnum, firstlnum) is now at a lower indent
2597 * than "level", we need to split the fold in this
2598 * range.
2599 * Any splits have to be done recursively.
2600 */
2601 if (firstlnum != startlnum)
2602 {
2603 breakstart = startlnum;
2604 breakend = firstlnum;
2605 }
2606 else
2607 {
2608 breakstart = flp->lnum;
2609 breakend = flp->lnum;
2610 }
2611 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2612 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002614 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002616
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002617 // If using the "marker" or "syntax" method, we
2618 // need to continue until the end of the fold is
2619 // found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 if (getlevel == foldlevelMarker
2621 || getlevel == foldlevelExpr
2622 || getlevel == foldlevelSyntax)
2623 finish = TRUE;
2624 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002625
2626 if (fp->fd_top == startlnum && concat)
2627 {
2628 i = (int)(fp - (fold_T *)gap->ga_data);
2629 if (i != 0)
2630 {
2631 fp2 = fp - 1;
2632 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2633 {
2634 foldMerge(fp2, gap, fp);
2635 fp = fp2;
2636 }
2637 }
2638 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 break;
2640 }
2641 if (fp->fd_top >= startlnum)
2642 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002643 // A fold that starts at or after startlnum and stops
2644 // before the new fold must be deleted. Continue
2645 // looking for the next one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 deleteFoldEntry(gap,
2647 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2648 }
2649 else
2650 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002651 // A fold has some lines above startlnum, truncate it
2652 // to stop just above startlnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 fp->fd_len = startlnum - fp->fd_top;
2654 foldMarkAdjustRecurse(&fp->fd_nested,
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00002655 fp->fd_len, (linenr_T)MAXLNUM,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 (linenr_T)MAXLNUM, 0L);
2657 fold_changed = TRUE;
2658 }
2659 }
2660 else
2661 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002662 // Insert new fold. Careful: ga_data may be NULL and it
2663 // may change!
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002664 if (gap->ga_len == 0)
2665 i = 0;
2666 else
2667 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 if (foldInsert(gap, i) != OK)
2669 return bot;
2670 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002671 // The new fold continues until bot, unless we find the
2672 // end earlier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 fp->fd_top = firstlnum;
2674 fp->fd_len = bot - firstlnum + 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002675 // When the containing fold is open, the new fold is open.
2676 // The new fold is closed if the fold above it is closed.
2677 // The first fold depends on the containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 if (topflags == FD_OPEN)
2679 {
2680 flp->wp->w_fold_manual = TRUE;
2681 fp->fd_flags = FD_OPEN;
2682 }
2683 else if (i <= 0)
2684 {
2685 fp->fd_flags = topflags;
2686 if (topflags != FD_LEVEL)
2687 flp->wp->w_fold_manual = TRUE;
2688 }
2689 else
2690 fp->fd_flags = (fp - 1)->fd_flags;
2691 fp->fd_small = MAYBE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002692 // If using the "marker", "expr" or "syntax" method, we
2693 // need to continue until the end of the fold is found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 if (getlevel == foldlevelMarker
2695 || getlevel == foldlevelExpr
2696 || getlevel == foldlevelSyntax)
2697 finish = TRUE;
2698 fold_changed = TRUE;
2699 break;
2700 }
2701 }
2702 }
2703
2704 if (lvl < level || flp->lnum > linecount)
2705 {
2706 /*
2707 * Found a line with a lower foldlevel, this fold ends just above
2708 * "flp->lnum".
2709 */
2710 break;
2711 }
2712
2713 /*
2714 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002715 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002717 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 {
2719 /*
2720 * There is a nested fold, handle it recursively.
2721 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002722 // At least do one line (can happen when finish is TRUE).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 if (bot < flp->lnum)
2724 bot = flp->lnum;
2725
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002726 // Line numbers in the nested fold are relative to the start of
2727 // this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 flp->lnum = flp->lnum_save - fp->fd_top;
2729 flp->off += fp->fd_top;
2730 i = (int)(fp - (fold_T *)gap->ga_data);
2731 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2732 startlnum2 - fp->fd_top, flp, getlevel,
2733 bot - fp->fd_top, fp->fd_flags);
2734 fp = (fold_T *)gap->ga_data + i;
2735 flp->lnum += fp->fd_top;
2736 flp->lnum_save += fp->fd_top;
2737 flp->off -= fp->fd_top;
2738 bot += fp->fd_top;
2739 startlnum2 = flp->lnum;
2740
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002741 // This fold may end at the same line, don't incr. flp->lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 }
2743 else
2744 {
2745 /*
2746 * Get the level of the next line, then continue the loop to check
2747 * if it ends there.
2748 * Skip over undefined lines, to find the foldlevel after it.
2749 * For the last line in the file the foldlevel is always valid.
2750 */
2751 flp->lnum = flp->lnum_save;
2752 ll = flp->lnum + 1;
2753 while (!got_int)
2754 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002755 // Make the previous level available to foldlevel().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 prev_lnum = flp->lnum;
2757 prev_lnum_lvl = flp->lvl;
2758
2759 if (++flp->lnum > linecount)
2760 break;
2761 flp->lvl = flp->lvl_next;
2762 getlevel(flp);
2763 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2764 break;
2765 }
2766 prev_lnum = 0;
2767 if (flp->lnum > linecount)
2768 break;
2769
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002770 // leave flp->lnum_save to lnum of the line that was used to get
2771 // the level, flp->lnum to the lnum of the next line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 flp->lnum_save = flp->lnum;
2773 flp->lnum = ll;
2774 }
2775 }
2776
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002777 if (fp == NULL) // only happens when got_int is set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 return bot;
2779
2780 /*
2781 * Get here when:
2782 * lvl < level: the folds ends just above "flp->lnum"
2783 * lvl >= level: fold continues below "bot"
2784 */
2785
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002786 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 if (fp->fd_len < flp->lnum - fp->fd_top)
2788 {
2789 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002790 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 fold_changed = TRUE;
2792 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002793 else if (fp->fd_top + fp->fd_len > linecount)
2794 // running into the end of the buffer (deleted last line)
2795 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002797 // Delete contained folds from the end of the last one found until where
2798 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2800 flp->lnum - 1 - fp->fd_top);
2801
2802 if (lvl < level)
2803 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002804 // End of fold found, update the length when it got shorter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 if (fp->fd_len != flp->lnum - fp->fd_top)
2806 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002807 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002809 // fold continued below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 if (getlevel == foldlevelMarker
2811 || getlevel == foldlevelExpr
2812 || getlevel == foldlevelSyntax)
2813 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002814 // marker method: truncate the fold and make sure the
2815 // previously included lines are processed again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 bot = fp->fd_top + fp->fd_len - 1;
2817 fp->fd_len = flp->lnum - fp->fd_top;
2818 }
2819 else
2820 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002821 // indent or expr method: split fold to create a new one
2822 // below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 i = (int)(fp - (fold_T *)gap->ga_data);
2824 foldSplit(gap, i, flp->lnum, bot);
2825 fp = (fold_T *)gap->ga_data + i;
2826 }
2827 }
2828 else
2829 fp->fd_len = flp->lnum - fp->fd_top;
2830 fold_changed = TRUE;
2831 }
2832 }
2833
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002834 // delete following folds that end before the current line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 for (;;)
2836 {
2837 fp2 = fp + 1;
2838 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2839 || fp2->fd_top > flp->lnum)
2840 break;
2841 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2842 {
2843 if (fp2->fd_top < flp->lnum)
2844 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002845 // Make fold that includes lnum start at lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 foldMarkAdjustRecurse(&fp2->fd_nested,
2847 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2848 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2849 fp2->fd_len -= flp->lnum - fp2->fd_top;
2850 fp2->fd_top = flp->lnum;
2851 fold_changed = TRUE;
2852 }
2853
2854 if (lvl >= level)
2855 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002856 // merge new fold with existing fold that follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 foldMerge(fp, gap, fp2);
2858 }
2859 break;
2860 }
2861 fold_changed = TRUE;
2862 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2863 }
2864
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002865 // Need to redraw the lines we inspected, which might be further down than
2866 // was asked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 if (bot < flp->lnum - 1)
2868 bot = flp->lnum - 1;
2869
2870 return bot;
2871}
2872
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002873// foldInsert() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874/*
2875 * Insert a new fold in "gap" at position "i".
2876 * Returns OK for success, FAIL for failure.
2877 */
2878 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002879foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880{
2881 fold_T *fp;
2882
2883 if (ga_grow(gap, 1) != OK)
2884 return FAIL;
2885 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002886 if (gap->ga_len > 0 && i < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2888 ++gap->ga_len;
Bram Moolenaar04935fb2022-01-08 16:19:22 +00002889 ga_init2(&fp->fd_nested, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 return OK;
2891}
2892
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002893// foldSplit() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894/*
2895 * Split the "i"th fold in "gap", which starts before "top" and ends below
2896 * "bot" in two pieces, one ending above "top" and the other starting below
2897 * "bot".
2898 * The caller must first have taken care of any nested folds from "top" to
2899 * "bot"!
2900 */
2901 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002902foldSplit(
2903 garray_T *gap,
2904 int i,
2905 linenr_T top,
2906 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907{
2908 fold_T *fp;
2909 fold_T *fp2;
2910 garray_T *gap1;
2911 garray_T *gap2;
2912 int idx;
2913 int len;
2914
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002915 // The fold continues below bot, need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 if (foldInsert(gap, i + 1) == FAIL)
2917 return;
2918 fp = (fold_T *)gap->ga_data + i;
2919 fp[1].fd_top = bot + 1;
2920 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2921 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002922 fp[1].fd_small = MAYBE;
2923 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002925 // Move nested folds below bot to new fold. There can't be
2926 // any between top and bot, they have been removed by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 gap1 = &fp->fd_nested;
2928 gap2 = &fp[1].fd_nested;
Brandon Simmons2c407072022-04-23 13:50:17 +01002929 (void)foldFind(gap1, bot + 1 - fp->fd_top, &fp2);
2930 if (fp2 != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002932 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2933 if (len > 0 && ga_grow(gap2, len) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002935 for (idx = 0; idx < len; ++idx)
2936 {
2937 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2938 ((fold_T *)gap2->ga_data)[idx].fd_top
2939 -= fp[1].fd_top - fp->fd_top;
2940 }
2941 gap2->ga_len = len;
2942 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 }
2945 fp->fd_len = top - fp->fd_top;
2946 fold_changed = TRUE;
2947}
2948
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002949// foldRemove() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950/*
2951 * Remove folds within the range "top" to and including "bot".
2952 * Check for these situations:
2953 * 1 2 3
2954 * 1 2 3
2955 * top 2 3 4 5
2956 * 2 3 4 5
2957 * bot 2 3 4 5
2958 * 3 5 6
2959 * 3 5 6
2960 *
2961 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002962 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 * 3: split in two parts, one stops above "top", other starts below "bot".
2964 * 4: deleted
2965 * 5: made to start below "bot".
2966 * 6: not changed
2967 */
2968 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002969foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970{
2971 fold_T *fp = NULL;
2972
2973 if (bot < top)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002974 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002976 while (gap->ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002978 // Find fold that includes top or a following one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2980 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002981 // 2: or 3: need to delete nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002983 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002985 // 3: need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2987 }
2988 else
2989 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002990 // 2: truncate fold at "top".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 fp->fd_len = top - fp->fd_top;
2992 }
2993 fold_changed = TRUE;
2994 continue;
2995 }
2996 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2997 || fp->fd_top > bot)
2998 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002999 // 6: Found a fold below bot, can stop looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 break;
3001 }
3002 if (fp->fd_top >= top)
3003 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003004 // Found an entry below top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003006 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003008 // 5: Make fold that includes bot start below bot.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 foldMarkAdjustRecurse(&fp->fd_nested,
3010 (linenr_T)0, (long)(bot - fp->fd_top),
3011 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
3012 fp->fd_len -= bot - fp->fd_top + 1;
3013 fp->fd_top = bot + 1;
3014 break;
3015 }
3016
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003017 // 4: Delete completely contained fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
3019 }
3020 }
3021}
3022
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003023// foldReverseOrder() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003024 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003025foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003026{
3027 fold_T *left, *right;
3028 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003029 linenr_T start = start_arg;
3030 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003031
3032 for (; start < end; start++, end--)
3033 {
3034 left = (fold_T *)gap->ga_data + start;
3035 right = (fold_T *)gap->ga_data + end;
3036 tmp = *left;
3037 *left = *right;
3038 *right = tmp;
3039 }
3040}
3041
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003042// foldMoveRange() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003043/*
3044 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3045 * requires "line1" <= "line2" <= "dest"
3046 *
3047 * There are the following situations for the first fold at or below line1 - 1.
3048 * 1 2 3 4
3049 * 1 2 3 4
3050 * line1 2 3 4
3051 * 2 3 4 5 6 7
3052 * line2 3 4 5 6 7
3053 * 3 4 6 7 8 9
3054 * dest 4 7 8 9
3055 * 4 7 8 10
3056 * 4 7 8 10
3057 *
3058 * In the following descriptions, "moved" means moving in the buffer, *and* in
3059 * the fold array.
3060 * Meanwhile, "shifted" just means moving in the buffer.
3061 * 1. not changed
3062 * 2. truncated above line1
3063 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3064 * dest are truncated and shifted up
3065 * 4. internal folds moved (from [line1, line2] to dest)
3066 * 5. moved to dest.
3067 * 6. truncated below line2 and moved.
3068 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3069 * removed, top is moved down by move_len.
3070 * 8. truncated below dest and shifted up.
3071 * 9. shifted up
3072 * 10. not changed
3073 */
3074
3075 static void
3076truncate_fold(fold_T *fp, linenr_T end)
3077{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003078 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003079 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003080 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003081}
3082
3083#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
Bram Moolenaar81fcb672020-09-01 21:21:24 +02003084#define valid_fold(fp, gap) ((gap)->ga_len > 0 && (fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
kylo252ae6f1d82022-02-16 19:24:07 +00003085#define fold_index(fp, gap) ((size_t)((fp) - ((fold_T *)(gap)->ga_data)))
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003086
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003087 void
3088foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003089{
3090 fold_T *fp;
3091 linenr_T range_len = line2 - line1 + 1;
3092 linenr_T move_len = dest - line2;
3093 int at_start = foldFind(gap, line1 - 1, &fp);
3094 size_t move_start = 0, move_end = 0, dest_index = 0;
3095
3096 if (at_start)
3097 {
3098 if (fold_end(fp) > dest)
3099 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003100 // Case 4
3101 // don't have to change this fold, but have to move nested folds.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003102 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3103 fp->fd_top, dest - fp->fd_top);
3104 return;
3105 }
3106 else if (fold_end(fp) > line2)
3107 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003108 // Case 3
3109 // Remove nested folds between line1 and line2 & reduce the
3110 // length of fold by "range_len".
3111 // Folds after this one must be dealt with.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003112 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3113 fp->fd_top, MAXLNUM, -range_len);
3114 fp->fd_len -= range_len;
3115 }
3116 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003117 // Case 2 truncate fold, folds after this one must be dealt with.
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003118 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003119
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003120 // Look at the next fold, and treat that one as if it were the first
3121 // after "line1" (because now it is).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003122 fp = fp + 1;
3123 }
3124
3125 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3126 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003127 // Case 10
3128 // No folds after "line1" and before "dest"
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003129 return;
3130 }
3131 else if (fp->fd_top > line2)
3132 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003133 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003134 // Case 9. (for all case 9's) -- shift up.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003135 fp->fd_top -= range_len;
3136
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003137 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003138 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003139 // Case 8. -- ensure truncated at dest, shift up
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003140 truncate_fold(fp, dest);
3141 fp->fd_top -= range_len;
3142 }
3143 return;
3144 }
3145 else if (fold_end(fp) > dest)
3146 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003147 // Case 7 -- remove nested folds and shrink
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003148 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3149 fp->fd_top, MAXLNUM, -move_len);
3150 fp->fd_len -= move_len;
3151 fp->fd_top += move_len;
3152 return;
3153 }
3154
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003155 // Case 5 or 6
3156 // changes rely on whether there are folds between the end of
3157 // this fold and "dest".
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003158 move_start = fold_index(fp, gap);
3159
3160 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3161 {
3162 if (fp->fd_top <= line2)
3163 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003164 // 1. 2. or 3.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003165 if (fold_end(fp) > line2)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003166 // 2. or 3., truncate before moving
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003167 truncate_fold(fp, line2);
3168
3169 fp->fd_top += move_len;
3170 continue;
3171 }
3172
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003173 // Record index of the first fold after the moved range.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003174 if (move_end == 0)
3175 move_end = fold_index(fp, gap);
3176
3177 if (fold_end(fp) > dest)
3178 truncate_fold(fp, dest);
3179
3180 fp->fd_top -= range_len;
3181 }
3182
3183 dest_index = fold_index(fp, gap);
3184
3185 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003186 * All folds are now correct, but not necessarily in the correct order. We
3187 * must swap folds in the range [move_end, dest_index) with those in the
3188 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003189 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003190 if (move_end == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003191 // There are no folds after those moved, hence no folds have been moved
3192 // out of order.
Bram Moolenaar94be6192017-04-22 22:40:11 +02003193 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003194 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3195 foldReverseOrder(gap, (linenr_T)move_start,
3196 (linenr_T)(move_start + dest_index - move_end - 1));
3197 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3198 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003199}
3200#undef fold_end
3201#undef valid_fold
3202#undef fold_index
3203
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003204// foldMerge() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003206 * Merge two adjacent folds (and the nested ones in them).
3207 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 * must end just above "fp2".
3209 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3210 * Fold entry "fp2" in "gap" is deleted.
3211 */
3212 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003213foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214{
3215 fold_T *fp3;
3216 fold_T *fp4;
3217 int idx;
3218 garray_T *gap1 = &fp1->fd_nested;
3219 garray_T *gap2 = &fp2->fd_nested;
3220
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003221 // If the last nested fold in fp1 touches the first nested fold in fp2,
3222 // merge them recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3224 foldMerge(fp3, gap2, fp4);
3225
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003226 // Move nested folds in fp2 to the end of fp1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3228 {
3229 for (idx = 0; idx < gap2->ga_len; ++idx)
3230 {
3231 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3232 = ((fold_T *)gap2->ga_data)[idx];
3233 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3234 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 }
3236 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 }
3238
3239 fp1->fd_len += fp2->fd_len;
3240 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3241 fold_changed = TRUE;
3242}
3243
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003244// foldlevelIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245/*
3246 * Low level function to get the foldlevel for the "indent" method.
3247 * Doesn't use any caching.
3248 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3249 */
3250 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003251foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252{
3253 char_u *s;
3254 buf_T *buf;
3255 linenr_T lnum = flp->lnum + flp->off;
3256
3257 buf = flp->wp->w_buffer;
3258 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3259
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003260 // empty line or lines starting with a character in 'foldignore': level
3261 // depends on surrounding lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3263 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003264 // first and last line can't be undefined, use level 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3266 flp->lvl = 0;
3267 else
3268 flp->lvl = -1;
3269 }
3270 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003271 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003273 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003275 if (flp->lvl < 0)
3276 flp->lvl = 0;
3277 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278}
3279
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003280// foldlevelDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281#ifdef FEAT_DIFF
3282/*
3283 * Low level function to get the foldlevel for the "diff" method.
3284 * Doesn't use any caching.
3285 */
3286 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003287foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288{
3289 if (diff_infold(flp->wp, flp->lnum + flp->off))
3290 flp->lvl = 1;
3291 else
3292 flp->lvl = 0;
3293}
3294#endif
3295
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003296// foldlevelExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297/*
3298 * Low level function to get the foldlevel for the "expr" method.
3299 * Doesn't use any caching.
3300 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3301 */
3302 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003303foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304{
3305#ifndef FEAT_EVAL
3306 flp->start = FALSE;
3307 flp->lvl = 0;
3308#else
3309 win_T *win;
3310 int n;
3311 int c;
3312 linenr_T lnum = flp->lnum + flp->off;
3313 int save_keytyped;
3314
3315 win = curwin;
3316 curwin = flp->wp;
3317 curbuf = flp->wp->w_buffer;
3318 set_vim_var_nr(VV_LNUM, lnum);
3319
3320 flp->start = 0;
3321 flp->had_end = flp->end;
3322 flp->end = MAX_LEVEL + 1;
3323 if (lnum <= 1)
3324 flp->lvl = 0;
3325
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003326 // KeyTyped may be reset to 0 when calling a function which invokes
3327 // do_cmdline(). To make 'foldopen' work correctly restore KeyTyped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 save_keytyped = KeyTyped;
Bram Moolenaare70dd112022-01-21 16:31:11 +00003329 n = eval_foldexpr(flp->wp, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 KeyTyped = save_keytyped;
3331
3332 switch (c)
3333 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003334 // "a1", "a2", .. : add to the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 case 'a': if (flp->lvl >= 0)
3336 {
3337 flp->lvl += n;
3338 flp->lvl_next = flp->lvl;
3339 }
3340 flp->start = n;
3341 break;
3342
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003343 // "s1", "s2", .. : subtract from the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 case 's': if (flp->lvl >= 0)
3345 {
3346 if (n > flp->lvl)
3347 flp->lvl_next = 0;
3348 else
3349 flp->lvl_next = flp->lvl - n;
3350 flp->end = flp->lvl_next + 1;
3351 }
3352 break;
3353
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003354 // ">1", ">2", .. : start a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 case '>': flp->lvl = n;
3356 flp->lvl_next = n;
3357 flp->start = 1;
3358 break;
3359
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003360 // "<1", "<2", .. : end a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 case '<': flp->lvl_next = n - 1;
3362 flp->end = n;
3363 break;
3364
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003365 // "=": No change in level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 case '=': flp->lvl_next = flp->lvl;
3367 break;
3368
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003369 // "-1", "0", "1", ..: set fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 default: if (n < 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003371 // Use the current level for the next line, so that "a1"
3372 // will work there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 flp->lvl_next = flp->lvl;
3374 else
3375 flp->lvl_next = n;
3376 flp->lvl = n;
3377 break;
3378 }
3379
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003380 // If the level is unknown for the first or the last line in the file, use
3381 // level 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 if (flp->lvl < 0)
3383 {
3384 if (lnum <= 1)
3385 {
3386 flp->lvl = 0;
3387 flp->lvl_next = 0;
3388 }
3389 if (lnum == curbuf->b_ml.ml_line_count)
3390 flp->lvl_next = 0;
3391 }
3392
3393 curwin = win;
3394 curbuf = curwin->w_buffer;
3395#endif
3396}
3397
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003398// parseMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399/*
3400 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3401 * "foldendmarkerlen".
3402 * Relies on the option value to have been checked for correctness already.
3403 */
3404 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003405parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406{
3407 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3408 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3409 foldendmarkerlen = (int)STRLEN(foldendmarker);
3410}
3411
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003412// foldlevelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413/*
3414 * Low level function to get the foldlevel for the "marker" method.
3415 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3416 * set before calling this.
3417 * Requires that flp->lvl is set to the fold level of the previous line!
3418 * Careful: This means you can't call this function twice on the same line.
3419 * Doesn't use any caching.
3420 * Sets flp->start when a start marker was found.
3421 */
3422 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003423foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424{
3425 char_u *startmarker;
3426 int cstart;
3427 int cend;
3428 int start_lvl = flp->lvl;
3429 char_u *s;
3430 int n;
3431
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003432 // cache a few values for speed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 startmarker = flp->wp->w_p_fmr;
3434 cstart = *startmarker;
3435 ++startmarker;
3436 cend = *foldendmarker;
3437
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003438 // Default: no start found, next level is same as current level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 flp->start = 0;
3440 flp->lvl_next = flp->lvl;
3441
3442 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3443 while (*s)
3444 {
3445 if (*s == cstart
3446 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3447 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003448 // found startmarker: set flp->lvl
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 s += foldstartmarkerlen;
3450 if (VIM_ISDIGIT(*s))
3451 {
3452 n = atoi((char *)s);
3453 if (n > 0)
3454 {
3455 flp->lvl = n;
3456 flp->lvl_next = n;
3457 if (n <= start_lvl)
3458 flp->start = 1;
3459 else
3460 flp->start = n - start_lvl;
3461 }
3462 }
3463 else
3464 {
3465 ++flp->lvl;
3466 ++flp->lvl_next;
3467 ++flp->start;
3468 }
3469 }
3470 else if (*s == cend
3471 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3472 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003473 // found endmarker: set flp->lvl_next
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 s += foldendmarkerlen;
3475 if (VIM_ISDIGIT(*s))
3476 {
3477 n = atoi((char *)s);
3478 if (n > 0)
3479 {
3480 flp->lvl = n;
3481 flp->lvl_next = n - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003482 // never start a fold with an end marker
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003483 if (flp->lvl_next > start_lvl)
3484 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 }
3486 }
3487 else
3488 --flp->lvl_next;
3489 }
3490 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003491 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 }
3493
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003494 // The level can't go negative, must be missing a start marker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 if (flp->lvl_next < 0)
3496 flp->lvl_next = 0;
3497}
3498
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003499// foldlevelSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500/*
3501 * Low level function to get the foldlevel for the "syntax" method.
3502 * Doesn't use any caching.
3503 */
3504 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003505foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506{
3507#ifndef FEAT_SYN_HL
3508 flp->start = 0;
3509 flp->lvl = 0;
3510#else
3511 linenr_T lnum = flp->lnum + flp->off;
3512 int n;
3513
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003514 // Use the maximum fold level at the start of this line and the next.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3516 flp->start = 0;
3517 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3518 {
3519 n = syn_get_foldlevel(flp->wp, lnum + 1);
3520 if (n > flp->lvl)
3521 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003522 flp->start = n - flp->lvl; // fold(s) start here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 flp->lvl = n;
3524 }
3525 }
3526#endif
3527}
3528
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003529// functions for storing the fold state in a View {{{1
3530// put_folds() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003532static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3533static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3534static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
3536/*
3537 * Write commands to "fd" to restore the manual folds in window "wp".
3538 * Return FAIL if writing fails.
3539 */
3540 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003541put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542{
3543 if (foldmethodIsManual(wp))
3544 {
3545 if (put_line(fd, "silent! normal! zE") == FAIL
Bram Moolenaarf9547eb2021-02-01 19:24:55 +01003546 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL
3547 || put_line(fd, "let &fdl = &fdl") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 return FAIL;
3549 }
3550
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003551 // If some folds are manually opened/closed, need to restore that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003553 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 return OK;
3556}
3557
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003558// put_folds_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559/*
3560 * Write commands to "fd" to recreate manually created folds.
3561 * Returns FAIL when writing failed.
3562 */
3563 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003564put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565{
3566 int i;
3567 fold_T *fp;
3568
3569 fp = (fold_T *)gap->ga_data;
3570 for (i = 0; i < gap->ga_len; i++)
3571 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003572 // Do nested folds first, they will be created closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3574 return FAIL;
3575 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3576 fp->fd_top + off + fp->fd_len - 1) < 0
3577 || put_eol(fd) == FAIL)
3578 return FAIL;
3579 ++fp;
3580 }
3581 return OK;
3582}
3583
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003584// put_foldopen_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585/*
3586 * Write commands to "fd" to open and close manually opened/closed folds.
3587 * Returns FAIL when writing failed.
3588 */
3589 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003590put_foldopen_recurse(
3591 FILE *fd,
3592 win_T *wp,
3593 garray_T *gap,
3594 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595{
3596 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003597 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 fold_T *fp;
3599
3600 fp = (fold_T *)gap->ga_data;
3601 for (i = 0; i < gap->ga_len; i++)
3602 {
3603 if (fp->fd_flags != FD_LEVEL)
3604 {
3605 if (fp->fd_nested.ga_len > 0)
3606 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003607 // open nested folds while this fold is open
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3609 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003610 || put_line(fd, "normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003612 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3613 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 == FAIL)
3615 return FAIL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003616 // close the parent when needed
Bram Moolenaard25ad652012-02-29 19:20:02 +01003617 if (fp->fd_flags == FD_CLOSED)
3618 {
3619 if (put_fold_open_close(fd, fp, off) == FAIL)
3620 return FAIL;
3621 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003623 else
3624 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003625 // Open or close the leaf according to the window foldlevel.
3626 // Do not close a leaf that is already closed, as it will close
3627 // the parent.
Bram Moolenaard25ad652012-02-29 19:20:02 +01003628 level = foldLevelWin(wp, off + fp->fd_top);
3629 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3630 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3631 if (put_fold_open_close(fd, fp, off) == FAIL)
3632 return FAIL;
3633 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 }
3635 ++fp;
3636 }
3637
3638 return OK;
3639}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003640
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003641// put_fold_open_close() {{{2
Bram Moolenaard25ad652012-02-29 19:20:02 +01003642/*
3643 * Write the open or close command to "fd".
3644 * Returns FAIL when writing failed.
3645 */
3646 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003647put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003648{
3649 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3650 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003651 || fprintf(fd, "normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003652 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3653 || put_eol(fd) == FAIL)
3654 return FAIL;
3655
3656 return OK;
3657}
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003658#endif // FEAT_SESSION
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003660// }}}1
Bram Moolenaardb022f32019-09-01 17:52:32 +02003661#endif // defined(FEAT_FOLDING) || defined(PROTO)
3662
3663#if defined(FEAT_EVAL) || defined(PROTO)
3664
3665/*
3666 * "foldclosed()" and "foldclosedend()" functions
3667 */
3668 static void
3669foldclosed_both(
3670 typval_T *argvars UNUSED,
3671 typval_T *rettv,
3672 int end UNUSED)
3673{
3674# ifdef FEAT_FOLDING
3675 linenr_T lnum;
3676 linenr_T first, last;
3677
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003678 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3679 return;
3680
Bram Moolenaardb022f32019-09-01 17:52:32 +02003681 lnum = tv_get_lnum(argvars);
3682 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3683 {
3684 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3685 {
3686 if (end)
3687 rettv->vval.v_number = (varnumber_T)last;
3688 else
3689 rettv->vval.v_number = (varnumber_T)first;
3690 return;
3691 }
3692 }
3693#endif
3694 rettv->vval.v_number = -1;
3695}
3696
3697/*
3698 * "foldclosed()" function
3699 */
3700 void
3701f_foldclosed(typval_T *argvars, typval_T *rettv)
3702{
3703 foldclosed_both(argvars, rettv, FALSE);
3704}
3705
3706/*
3707 * "foldclosedend()" function
3708 */
3709 void
3710f_foldclosedend(typval_T *argvars, typval_T *rettv)
3711{
3712 foldclosed_both(argvars, rettv, TRUE);
3713}
3714
3715/*
3716 * "foldlevel()" function
3717 */
3718 void
3719f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3720{
3721# ifdef FEAT_FOLDING
3722 linenr_T lnum;
3723
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003724 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3725 return;
3726
Bram Moolenaardb022f32019-09-01 17:52:32 +02003727 lnum = tv_get_lnum(argvars);
3728 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3729 rettv->vval.v_number = foldLevel(lnum);
3730# endif
3731}
3732
3733/*
3734 * "foldtext()" function
3735 */
3736 void
3737f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3738{
3739# ifdef FEAT_FOLDING
3740 linenr_T foldstart;
3741 linenr_T foldend;
3742 char_u *dashes;
3743 linenr_T lnum;
3744 char_u *s;
3745 char_u *r;
3746 int len;
3747 char *txt;
3748 long count;
3749# endif
3750
3751 rettv->v_type = VAR_STRING;
3752 rettv->vval.v_string = NULL;
3753# ifdef FEAT_FOLDING
3754 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3755 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3756 dashes = get_vim_var_str(VV_FOLDDASHES);
3757 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3758 && dashes != NULL)
3759 {
3760 // Find first non-empty line in the fold.
3761 for (lnum = foldstart; lnum < foldend; ++lnum)
3762 if (!linewhite(lnum))
3763 break;
3764
3765 // Find interesting text in this line.
3766 s = skipwhite(ml_get(lnum));
3767 // skip C comment-start
3768 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3769 {
3770 s = skipwhite(s + 2);
3771 if (*skipwhite(s) == NUL
3772 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3773 {
3774 s = skipwhite(ml_get(lnum + 1));
3775 if (*s == '*')
3776 s = skipwhite(s + 1);
3777 }
3778 }
3779 count = (long)(foldend - foldstart + 1);
3780 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3781 r = alloc(STRLEN(txt)
3782 + STRLEN(dashes) // for %s
3783 + 20 // for %3ld
3784 + STRLEN(s)); // concatenated
3785 if (r != NULL)
3786 {
3787 sprintf((char *)r, txt, dashes, count);
3788 len = (int)STRLEN(r);
3789 STRCAT(r, s);
3790 // remove 'foldmarker' and 'commentstring'
3791 foldtext_cleanup(r + len);
3792 rettv->vval.v_string = r;
3793 }
3794 }
3795# endif
3796}
3797
3798/*
3799 * "foldtextresult(lnum)" function
3800 */
3801 void
3802f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3803{
3804# ifdef FEAT_FOLDING
3805 linenr_T lnum;
3806 char_u *text;
3807 char_u buf[FOLD_TEXT_LEN];
3808 foldinfo_T foldinfo;
3809 int fold_count;
3810 static int entered = FALSE;
3811# endif
3812
3813 rettv->v_type = VAR_STRING;
3814 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003815
3816 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3817 return;
3818
Bram Moolenaardb022f32019-09-01 17:52:32 +02003819# ifdef FEAT_FOLDING
3820 if (entered)
3821 return; // reject recursive use
3822 entered = TRUE;
3823
3824 lnum = tv_get_lnum(argvars);
3825 // treat illegal types and illegal string values for {lnum} the same
3826 if (lnum < 0)
3827 lnum = 0;
3828 fold_count = foldedCount(curwin, lnum, &foldinfo);
3829 if (fold_count > 0)
3830 {
3831 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3832 &foldinfo, buf);
3833 if (text == buf)
3834 text = vim_strsave(text);
3835 rettv->vval.v_string = text;
3836 }
3837
3838 entered = FALSE;
3839# endif
3840}
3841
3842#endif // FEAT_EVAL