blob: 4824a807ce3cec445e745ca36bb376f48e7cead0 [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/*
zeertzjq8c55d602024-03-13 20:42:26 +0100110 * Return TRUE if there may be folded lines in window "win".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 */
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)
Bram Moolenaara4d158b2022-08-14 14:17:45 +0100416 redraw_curbuf_later(UPD_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{
Yegappan Lakshmanan7f8b2552023-01-08 13:44:24 +0000516 if (*p_fcl == NUL)
517 return;
518
Yegappan Lakshmanan1cfb14a2023-01-09 19:04:23 +0000519 // 'foldclose' can only be "all" right now
Yegappan Lakshmanan7f8b2552023-01-08 13:44:24 +0000520 checkupdate(curwin);
521 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
522 (int)curwin->w_p_fdl))
523 changed_window_setting();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524}
525
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100526// checkCloseRec() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100528checkCloseRec(garray_T *gap, linenr_T lnum, int level)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529{
530 fold_T *fp;
531 int retval = FALSE;
532 int i;
533
534 fp = (fold_T *)gap->ga_data;
535 for (i = 0; i < gap->ga_len; ++i)
536 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100537 // Only manually opened folds may need to be closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538 if (fp[i].fd_flags == FD_OPEN)
539 {
540 if (level <= 0 && (lnum < fp[i].fd_top
541 || lnum >= fp[i].fd_top + fp[i].fd_len))
542 {
543 fp[i].fd_flags = FD_LEVEL;
544 retval = TRUE;
545 }
546 else
547 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
548 level - 1);
549 }
550 }
551 return retval;
552}
553
zeertzjq8c55d602024-03-13 20:42:26 +0100554// foldManualAllowed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555/*
556 * Return TRUE if it's allowed to manually create or delete a fold.
557 * Give an error message and return FALSE if not.
558 */
559 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100560foldManualAllowed(int create)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561{
562 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
563 return TRUE;
564 if (create)
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000565 emsg(_(e_cannot_create_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 else
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000567 emsg(_(e_cannot_delete_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 return FALSE;
569}
570
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100571// foldCreate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572/*
573 * Create a fold from line "start" to line "end" (inclusive) in the current
574 * window.
575 */
576 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100577foldCreate(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578{
579 fold_T *fp;
580 garray_T *gap;
581 garray_T fold_ga;
582 int i, j;
583 int cont;
584 int use_level = FALSE;
585 int closed = FALSE;
586 int level = 0;
587 linenr_T start_rel = start;
588 linenr_T end_rel = end;
589
590 if (start > end)
591 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100592 // reverse the range
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593 end = start_rel;
594 start = end_rel;
595 start_rel = start;
596 end_rel = end;
597 }
598
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100599 // When 'foldmethod' is "marker" add markers, which creates the folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000600 if (foldmethodIsMarker(curwin))
601 {
602 foldCreateMarkers(start, end);
603 return;
604 }
605
606 checkupdate(curwin);
607
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100608 // Find the place to insert the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 gap = &curwin->w_folds;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200610 if (gap->ga_len == 0)
611 i = 0;
612 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200614 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200616 if (!foldFind(gap, start_rel, &fp))
617 break;
618 if (fp->fd_top + fp->fd_len > end_rel)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200620 // New fold is completely inside this fold: Go one level
621 // deeper.
622 gap = &fp->fd_nested;
623 start_rel -= fp->fd_top;
624 end_rel -= fp->fd_top;
625 if (use_level || fp->fd_flags == FD_LEVEL)
626 {
627 use_level = TRUE;
628 if (level >= curwin->w_p_fdl)
629 closed = TRUE;
630 }
631 else if (fp->fd_flags == FD_CLOSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 closed = TRUE;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200633 ++level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 }
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200635 else
636 {
637 // This fold and new fold overlap: Insert here and move some
638 // folds inside the new fold.
639 break;
640 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 }
Bram Moolenaar5e1f22f2020-11-10 18:23:52 +0100642 if (gap->ga_len == 0)
643 i = 0;
644 else
645 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 }
647
Yegappan Lakshmananfadc02a2023-01-27 21:03:12 +0000648 if (ga_grow(gap, 1) == FAIL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000649 return;
650
651 fp = (fold_T *)gap->ga_data + i;
652 ga_init2(&fold_ga, sizeof(fold_T), 10);
653
654 // Count number of folds that will be contained in the new fold.
655 for (cont = 0; i + cont < gap->ga_len; ++cont)
656 if (fp[cont].fd_top > end_rel)
657 break;
658 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000660 // If the first fold starts before the new fold, let the new fold
661 // start there. Otherwise the existing fold would change.
662 if (start_rel > fp->fd_top)
663 start_rel = fp->fd_top;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000665 // When last contained fold isn't completely contained, adjust end
666 // of new fold.
667 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
668 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
669 // Move contained folds to inside new fold.
670 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
671 fold_ga.ga_len += cont;
672 i += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000674 // Adjust line numbers in contained folds to be relative to the
675 // new fold.
676 for (j = 0; j < cont; ++j)
677 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000679 // Move remaining entries to after the new fold.
680 if (i < gap->ga_len)
681 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
682 sizeof(fold_T) * (gap->ga_len - i));
683 gap->ga_len = gap->ga_len + 1 - cont;
684
685 // insert new fold
686 fp->fd_nested = fold_ga;
687 fp->fd_top = start_rel;
688 fp->fd_len = end_rel - start_rel + 1;
689
690 // We want the new fold to be closed. If it would remain open because
691 // of using 'foldlevel', need to adjust fd_flags of containing folds.
692 if (use_level && !closed && level < curwin->w_p_fdl)
693 closeFold(start, 1L);
694 if (!use_level)
695 curwin->w_fold_manual = TRUE;
696 fp->fd_flags = FD_CLOSED;
697 fp->fd_small = MAYBE;
698
699 // redraw
700 changed_window_setting();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701}
702
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100703// deleteFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704/*
705 * Delete a fold at line "start" in the current window.
706 * When "end" is not 0, delete all folds from "start" to "end".
707 * When "recursive" is TRUE delete recursively.
708 */
709 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100710deleteFold(
711 linenr_T start,
712 linenr_T end,
713 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100714 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715{
716 garray_T *gap;
717 fold_T *fp;
718 garray_T *found_ga;
719 fold_T *found_fp = NULL;
720 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000721 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 int maybe_small = FALSE;
723 int level = 0;
724 linenr_T lnum = start;
725 linenr_T lnum_off;
726 int did_one = FALSE;
727 linenr_T first_lnum = MAXLNUM;
728 linenr_T last_lnum = 0;
729
730 checkupdate(curwin);
731
732 while (lnum <= end)
733 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100734 // Find the deepest fold for "start".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 gap = &curwin->w_folds;
736 found_ga = NULL;
737 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000738 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 for (;;)
740 {
741 if (!foldFind(gap, lnum - lnum_off, &fp))
742 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100743 // lnum is inside this fold, remember info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 found_ga = gap;
745 found_fp = fp;
746 found_off = lnum_off;
747
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100748 // if "lnum" is folded, don't check nesting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 if (check_closed(curwin, fp, &use_level, level,
750 &maybe_small, lnum_off))
751 break;
752
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100753 // check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 gap = &fp->fd_nested;
755 lnum_off += fp->fd_top;
756 ++level;
757 }
758 if (found_ga == NULL)
759 {
760 ++lnum;
761 }
762 else
763 {
764 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
766 if (foldmethodIsManual(curwin))
767 deleteFoldEntry(found_ga,
768 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
769 else
770 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000771 if (first_lnum > found_fp->fd_top + found_off)
772 first_lnum = found_fp->fd_top + found_off;
773 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000775 if (!did_one)
776 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 deleteFoldMarkers(found_fp, recursive, found_off);
778 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000779 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100781 // redraw window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 changed_window_setting();
783 }
784 }
785 if (!did_one)
786 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +0000787 emsg(_(e_no_fold_found));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100788 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 if (had_visual)
Bram Moolenaara4d158b2022-08-14 14:17:45 +0100790 redraw_curbuf_later(UPD_INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000792 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100793 // Deleting markers may make cursor column invalid.
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000794 check_cursor_col();
795
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 if (last_lnum > 0)
797 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
798}
799
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100800// clearFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801/*
802 * Remove all folding for window "win".
803 */
804 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100805clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806{
807 deleteFoldRecurse(&win->w_folds);
808 win->w_foldinvalid = FALSE;
809}
810
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100811// foldUpdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812/*
813 * Update folds for changes in the buffer of a window.
814 * Note that inserted/deleted lines must have already been taken care of by
815 * calling foldMarkAdjust().
816 * The changes in lines from top to bot (inclusive).
817 */
818 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100819foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820{
821 fold_T *fp;
822
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200823 if (disable_fold_update > 0)
824 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200825#ifdef FEAT_DIFF
826 if (need_diff_redraw)
827 // will update later
828 return;
829#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200830
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200831 if (wp->w_folds.ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 {
Brandon Simmons3fcccf92022-05-20 18:25:21 +0100833 linenr_T maybe_small_start = top;
834 linenr_T maybe_small_end = bot;
835
836 // Mark all folds from top to bot (or bot to top) as maybe-small.
837 if (top > bot)
838 {
839 maybe_small_start = bot;
840 maybe_small_end = top;
841 }
842 (void)foldFind(&wp->w_folds, maybe_small_start, &fp);
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200843 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
Brandon Simmons3fcccf92022-05-20 18:25:21 +0100844 && fp->fd_top <= maybe_small_end)
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200845 {
846 fp->fd_small = MAYBE;
847 ++fp;
848 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 }
850
851 if (foldmethodIsIndent(wp)
852 || foldmethodIsExpr(wp)
853 || foldmethodIsMarker(wp)
854#ifdef FEAT_DIFF
855 || foldmethodIsDiff(wp)
856#endif
857 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000858 {
859 int save_got_int = got_int;
860
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100861 // reset got_int here, otherwise it won't work
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000862 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000864 got_int |= save_got_int;
865 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866}
867
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100868// foldUpdateAll() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869/*
870 * Update all lines in a window for folding.
871 * Used when a fold setting changes or after reloading the buffer.
872 * The actual updating is postponed until fold info is used, to avoid doing
873 * every time a setting is changed or a syntax item is added.
874 */
875 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100876foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877{
878 win->w_foldinvalid = TRUE;
Bram Moolenaara4d158b2022-08-14 14:17:45 +0100879 redraw_win_later(win, UPD_NOT_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880}
881
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100882// foldMoveTo() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883/*
884 * If "updown" is FALSE: Move to the start or end of the fold.
885 * If "updown" is TRUE: move to fold at the same level.
886 * If not moved return FAIL.
887 */
888 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100889foldMoveTo(
890 int updown,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100891 int dir, // FORWARD or BACKWARD
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100892 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893{
894 long n;
895 int retval = FAIL;
896 linenr_T lnum_off;
897 linenr_T lnum_found;
898 linenr_T lnum;
899 int use_level;
900 int maybe_small;
901 garray_T *gap;
902 fold_T *fp;
903 int level;
904 int last;
905
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000906 checkupdate(curwin);
907
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100908 // Repeat "count" times.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 for (n = 0; n < count; ++n)
910 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100911 // Find nested folds. Stop when a fold is closed. The deepest fold
912 // that moves the cursor is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 lnum_off = 0;
914 gap = &curwin->w_folds;
Bram Moolenaarc136a352020-11-03 20:05:40 +0100915 if (gap->ga_len == 0)
916 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 use_level = FALSE;
918 maybe_small = FALSE;
919 lnum_found = curwin->w_cursor.lnum;
920 level = 0;
921 last = FALSE;
922 for (;;)
923 {
924 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
925 {
Bram Moolenaar6a78f322020-12-21 14:01:41 +0100926 if (!updown || gap->ga_len == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 break;
928
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100929 // When moving up, consider a fold above the cursor; when
930 // moving down consider a fold below the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 if (dir == FORWARD)
932 {
933 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
934 break;
935 --fp;
936 }
937 else
938 {
939 if (fp == (fold_T *)gap->ga_data)
940 break;
941 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100942 // don't look for contained folds, they will always move
943 // the cursor too far.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 last = TRUE;
945 }
946
947 if (!last)
948 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100949 // Check if this fold is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 if (check_closed(curwin, fp, &use_level, level,
951 &maybe_small, lnum_off))
952 last = TRUE;
953
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100954 // "[z" and "]z" stop at closed fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 if (last && !updown)
956 break;
957 }
958
959 if (updown)
960 {
961 if (dir == FORWARD)
962 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100963 // to start of next fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
965 {
966 lnum = fp[1].fd_top + lnum_off;
967 if (lnum > curwin->w_cursor.lnum)
968 lnum_found = lnum;
969 }
970 }
971 else
972 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100973 // to end of previous fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 if (fp > (fold_T *)gap->ga_data)
975 {
976 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
977 if (lnum < curwin->w_cursor.lnum)
978 lnum_found = lnum;
979 }
980 }
981 }
982 else
983 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100984 // Open fold found, set cursor to its start/end and then check
985 // nested folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 if (dir == FORWARD)
987 {
988 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
989 if (lnum > curwin->w_cursor.lnum)
990 lnum_found = lnum;
991 }
992 else
993 {
994 lnum = fp->fd_top + lnum_off;
995 if (lnum < curwin->w_cursor.lnum)
996 lnum_found = lnum;
997 }
998 }
999
1000 if (last)
1001 break;
1002
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001003 // Check nested folds (if any).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 gap = &fp->fd_nested;
1005 lnum_off += fp->fd_top;
1006 ++level;
1007 }
1008 if (lnum_found != curwin->w_cursor.lnum)
1009 {
1010 if (retval == FAIL)
1011 setpcmark();
1012 curwin->w_cursor.lnum = lnum_found;
1013 curwin->w_cursor.col = 0;
1014 retval = OK;
1015 }
1016 else
1017 break;
1018 }
1019
1020 return retval;
1021}
1022
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001023// foldInitWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024/*
1025 * Init the fold info in a new window.
1026 */
1027 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001028foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001030 ga_init2(&new_win->w_folds, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031}
1032
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001033// find_wl_entry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034/*
1035 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1036 * Only valid entries are considered (for entries where wl_valid is FALSE the
1037 * line number can be wrong).
1038 * Returns index of entry or -1 if not found.
1039 */
1040 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001041find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042{
1043 int i;
1044
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001045 for (i = 0; i < win->w_lines_valid; ++i)
1046 if (win->w_lines[i].wl_valid)
1047 {
1048 if (lnum < win->w_lines[i].wl_lnum)
1049 return -1;
1050 if (lnum <= win->w_lines[i].wl_lastlnum)
1051 return i;
1052 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 return -1;
1054}
1055
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001056// foldAdjustVisual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057/*
1058 * Adjust the Visual area to include any fold at the start or end completely.
1059 */
1060 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001061foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062{
1063 pos_T *start, *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064
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;
Yegappan Lakshmanan7f8b2552023-01-08 13:44:24 +00001080
1081 if (!hasFolding(end->lnum, NULL, &end->lnum))
1082 return;
1083
zeertzjq94b7c322024-03-12 21:50:32 +01001084 end->col = ml_get_len(end->lnum);
Yegappan Lakshmanan7f8b2552023-01-08 13:44:24 +00001085 if (end->col > 0 && *p_sel == 'o')
1086 --end->col;
1087 // prevent cursor from moving on the trail byte
1088 if (has_mbyte)
1089 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
zeertzjq8c55d602024-03-13 20:42:26 +01001092// foldAdjustCursor() {{{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{
Yegappan Lakshmanan7f8b2552023-01-08 13:44:24 +00001218 if (!wp->w_foldinvalid)
1219 return;
1220
1221 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); // will update all
1222 wp->w_foldinvalid = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223}
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.
Christian Brabandt8d02e5c2024-08-11 20:12:41 +02001495 *
1496 * We are adjusting the folds in the range from line1 til line2,
1497 * make sure that line2 does not get smaller than line1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 */
1499 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001500foldMarkAdjust(
1501 win_T *wp,
1502 linenr_T line1,
1503 linenr_T line2,
1504 long amount,
1505 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001507 // If deleting marks from line1 to line2, but not deleting all those
1508 // lines, set line2 so that only deleted lines have their folds removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1510 line2 = line1 - amount_after - 1;
Christian Brabandt8d02e5c2024-08-11 20:12:41 +02001511 if (line2 < line1)
1512 line2 = line1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001513 // If appending a line in Insert mode, it should be included in the fold
1514 // just above the line.
Bram Moolenaar24959102022-05-07 20:01:16 +01001515 if ((State & MODE_INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 --line1;
1517 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1518}
1519
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001520// foldMarkAdjustRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001522foldMarkAdjustRecurse(
1523 garray_T *gap,
1524 linenr_T line1,
1525 linenr_T line2,
1526 long amount,
1527 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528{
1529 fold_T *fp;
1530 int i;
1531 linenr_T last;
1532 linenr_T top;
1533
Bram Moolenaar07e87e92020-08-31 21:22:40 +02001534 if (gap->ga_len == 0)
1535 return;
1536
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001537 // In Insert mode an inserted line at the top of a fold is considered part
1538 // of the fold, otherwise it isn't.
Bram Moolenaar24959102022-05-07 20:01:16 +01001539 if ((State & MODE_INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 top = line1 + 1;
1541 else
1542 top = line1;
1543
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001544 // Find the fold containing or just below "line1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 (void)foldFind(gap, line1, &fp);
1546
1547 /*
1548 * Adjust all folds below "line1" that are affected.
1549 */
1550 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1551 {
1552 /*
1553 * Check for these situations:
1554 * 1 2 3
1555 * 1 2 3
1556 * line1 2 3 4 5
1557 * 2 3 4 5
1558 * 2 3 4 5
1559 * line2 2 3 4 5
1560 * 3 5 6
1561 * 3 5 6
1562 */
1563
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001564 last = fp->fd_top + fp->fd_len - 1; // last line of fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001566 // 1. fold completely above line1: nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 if (last < line1)
1568 continue;
1569
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001570 // 6. fold below line2: only adjust for amount_after
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 if (fp->fd_top > line2)
1572 {
1573 if (amount_after == 0)
1574 break;
1575 fp->fd_top += amount_after;
1576 }
1577 else
1578 {
1579 if (fp->fd_top >= top && last <= line2)
1580 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001581 // 4. fold completely contained in range
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 if (amount == MAXLNUM)
1583 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001584 // Deleting lines: delete the fold completely
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 deleteFoldEntry(gap, i, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001586 --i; // adjust index for deletion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 --fp;
1588 }
1589 else
1590 fp->fd_top += amount;
1591 }
1592 else
1593 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 if (fp->fd_top < top)
1595 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001596 // 2 or 3: need to correct nested folds too
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001597 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1598 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 if (last <= line2)
1600 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001601 // 2. fold contains line1, line2 is below fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 if (amount == MAXLNUM)
1603 fp->fd_len = line1 - fp->fd_top;
1604 else
1605 fp->fd_len += amount;
1606 }
1607 else
1608 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001609 // 3. fold contains line1 and line2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 fp->fd_len += amount_after;
1611 }
1612 }
1613 else
1614 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001615 // 5. fold is below line1 and contains line2; need to
1616 // correct nested folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 if (amount == MAXLNUM)
1618 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001619 foldMarkAdjustRecurse(&fp->fd_nested,
Bram Moolenaar6b434712022-02-15 19:15:22 +00001620 0,
Bram Moolenaar1159b162017-02-28 21:53:56 +01001621 line2 - fp->fd_top,
1622 amount,
1623 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 fp->fd_len -= line2 - fp->fd_top + 1;
1625 fp->fd_top = line1;
1626 }
1627 else
1628 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001629 foldMarkAdjustRecurse(&fp->fd_nested,
Bram Moolenaar6b434712022-02-15 19:15:22 +00001630 0,
Bram Moolenaar1159b162017-02-28 21:53:56 +01001631 line2 - fp->fd_top,
1632 amount,
1633 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 fp->fd_len += amount_after - amount;
1635 fp->fd_top += amount;
1636 }
1637 }
1638 }
1639 }
1640 }
1641}
1642
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001643// getDeepestNesting() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644/*
1645 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1646 * current window open.
1647 */
1648 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001649getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650{
1651 checkupdate(curwin);
1652 return getDeepestNestingRecurse(&curwin->w_folds);
1653}
1654
1655 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001656getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657{
1658 int i;
1659 int level;
1660 int maxlevel = 0;
1661 fold_T *fp;
1662
1663 fp = (fold_T *)gap->ga_data;
1664 for (i = 0; i < gap->ga_len; ++i)
1665 {
1666 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1667 if (level > maxlevel)
1668 maxlevel = level;
1669 }
1670
1671 return maxlevel;
1672}
1673
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001674// check_closed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675/*
1676 * Check if a fold is closed and update the info needed to check nested folds.
1677 */
1678 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001679check_closed(
1680 win_T *win,
1681 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001682 int *use_levelp, // TRUE: outer fold had FD_LEVEL
1683 int level, // folding depth
1684 int *maybe_smallp, // TRUE: outer this had fd_small == MAYBE
1685 linenr_T lnum_off) // line number offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686{
1687 int closed = FALSE;
1688
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001689 // Check if this fold is closed. If the flag is FD_LEVEL this
1690 // fold and all folds it contains depend on 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1692 {
1693 *use_levelp = TRUE;
1694 if (level >= win->w_p_fdl)
1695 closed = TRUE;
1696 }
1697 else if (fp->fd_flags == FD_CLOSED)
1698 closed = TRUE;
1699
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001700 // Small fold isn't closed anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 if (fp->fd_small == MAYBE)
1702 *maybe_smallp = TRUE;
1703 if (closed)
1704 {
1705 if (*maybe_smallp)
1706 fp->fd_small = MAYBE;
1707 checkSmall(win, fp, lnum_off);
1708 if (fp->fd_small == TRUE)
1709 closed = FALSE;
1710 }
1711 return closed;
1712}
1713
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001714// checkSmall() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715/*
1716 * Update fd_small field of fold "fp".
1717 */
1718 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001719checkSmall(
1720 win_T *wp,
1721 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001722 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723{
1724 int count;
1725 int n;
1726
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001727 if (fp->fd_small != MAYBE)
1728 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001730 // Mark any nested folds to maybe-small
1731 setSmallMaybe(&fp->fd_nested);
1732
1733 if (fp->fd_len > curwin->w_p_fml)
1734 fp->fd_small = FALSE;
1735 else
1736 {
1737 count = 0;
1738 for (n = 0; n < fp->fd_len; ++n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001740 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1741 if (count > curwin->w_p_fml)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001743 fp->fd_small = FALSE;
1744 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001747 fp->fd_small = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 }
1749}
1750
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001751// setSmallMaybe() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752/*
1753 * Set small flags in "gap" to MAYBE.
1754 */
1755 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001756setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757{
1758 int i;
1759 fold_T *fp;
1760
1761 fp = (fold_T *)gap->ga_data;
1762 for (i = 0; i < gap->ga_len; ++i)
1763 fp[i].fd_small = MAYBE;
1764}
1765
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001766// foldCreateMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767/*
1768 * Create a fold from line "start" to line "end" (inclusive) in the current
1769 * window by adding markers.
1770 */
1771 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001772foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773{
1774 if (!curbuf->b_p_ma)
1775 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001776 emsg(_(e_cannot_make_changes_modifiable_is_off));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 return;
1778 }
1779 parseMarker(curwin);
1780
1781 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1782 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1783
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001784 // Update both changes here, to avoid all folds after the start are
1785 // changed when the start marker is inserted and the end isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 changed_lines(start, (colnr_T)0, end, 0L);
1787}
1788
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001789// foldAddMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790/*
1791 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1792 */
1793 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001794foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795{
1796 char_u *cms = curbuf->b_p_cms;
1797 char_u *line;
1798 int line_len;
1799 char_u *newline;
1800 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001801 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001803 // Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 line = ml_get(lnum);
zeertzjq94b7c322024-03-12 21:50:32 +01001805 line_len = ml_get_len(lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001807 if (u_save(lnum - 1, lnum + 1) != OK)
1808 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001810 // Check if the line ends with an unclosed comment
1811 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
1812 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
1813 if (newline == NULL)
1814 return;
1815 STRCPY(newline, line);
1816 // Append the marker to the end of the line
1817 if (p == NULL || line_is_comment)
1818 vim_strncpy(newline + line_len, marker, markerlen);
1819 else
1820 {
1821 STRCPY(newline + line_len, cms);
1822 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1823 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00001825
1826 ml_replace(lnum, newline, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827}
1828
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001829// deleteFoldMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830/*
1831 * Delete the markers for a fold, causing it to be deleted.
1832 */
1833 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001834deleteFoldMarkers(
1835 fold_T *fp,
1836 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001837 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838{
1839 int i;
1840
1841 if (recursive)
1842 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1843 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1844 lnum_off + fp->fd_top);
1845 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1846 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1847 foldendmarker, foldendmarkerlen);
1848}
1849
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001850// foldDelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851/*
1852 * Delete marker "marker[markerlen]" at the end of line "lnum".
1853 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001854 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 * close-marker.
1856 */
1857 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001858foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859{
1860 char_u *line;
1861 char_u *newline;
1862 char_u *p;
1863 int len;
1864 char_u *cms = curbuf->b_p_cms;
1865 char_u *cms2;
1866
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001867 // end marker may be missing and fold extends below the last line
1868 if (lnum > curbuf->b_ml.ml_line_count)
1869 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 line = ml_get(lnum);
1871 for (p = line; *p != NUL; ++p)
1872 if (STRNCMP(p, marker, markerlen) == 0)
1873 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001874 // Found the marker, include a digit if it's there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 len = markerlen;
1876 if (VIM_ISDIGIT(p[len]))
1877 ++len;
1878 if (*cms != NUL)
1879 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001880 // Also delete 'commentstring' if it matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 cms2 = (char_u *)strstr((char *)cms, "%s");
Christian Brabandt1ac53b82025-01-14 17:25:02 +01001882 if (cms2 != NULL && p - line >= cms2 - cms
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1884 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1885 {
1886 p -= cms2 - cms;
1887 len += (int)STRLEN(cms) - 2;
1888 }
1889 }
1890 if (u_save(lnum - 1, lnum + 1) == OK)
1891 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001892 // Make new line: text-before-marker + text-after-marker
zeertzjq94b7c322024-03-12 21:50:32 +01001893 newline = alloc(ml_get_len(lnum) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 if (newline != NULL)
1895 {
1896 STRNCPY(newline, line, p - line);
1897 STRCPY(newline + (p - line), p + len);
1898 ml_replace(lnum, newline, FALSE);
1899 }
1900 }
1901 break;
1902 }
1903}
1904
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001905// get_foldtext() {{{2
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001906/*
1907 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001908 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1909 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001910 */
1911 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001912get_foldtext(
1913 win_T *wp,
1914 linenr_T lnum,
1915 linenr_T lnume,
1916 foldinfo_T *foldinfo,
1917 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001918{
1919 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001920#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001921 // an error occurred when evaluating 'fdt' setting
Bram Moolenaardab38d52013-06-15 17:06:36 +02001922 static int got_fdt_error = FALSE;
1923 int save_did_emsg = did_emsg;
1924 static win_T *last_wp = NULL;
1925 static linenr_T last_lnum = 0;
1926
1927 if (last_wp != wp || last_wp == NULL
1928 || last_lnum > lnum || last_lnum == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001929 // window changed, try evaluating foldtext setting once again
Bram Moolenaardab38d52013-06-15 17:06:36 +02001930 got_fdt_error = FALSE;
1931
1932 if (!got_fdt_error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001933 // a previous error should not abort evaluating 'foldexpr'
Bram Moolenaardab38d52013-06-15 17:06:36 +02001934 did_emsg = FALSE;
1935
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001936 if (*wp->w_p_fdt != NUL)
1937 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001938 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001939 int level;
1940 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001941
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001942 // Set "v:foldstart" and "v:foldend".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001943 set_vim_var_nr(VV_FOLDSTART, lnum);
1944 set_vim_var_nr(VV_FOLDEND, lnume);
1945
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001946 // Set "v:folddashes" to a string of "level" dashes.
1947 // Set "v:foldlevel" to "level".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001948 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001949 if (level > (int)sizeof(dashes) - 1)
1950 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001951 vim_memset(dashes, '-', (size_t)level);
1952 dashes[level] = NUL;
1953 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1954 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001955
Bram Moolenaar9530b582022-01-22 13:39:08 +00001956 // skip evaluating 'foldtext' on errors
Bram Moolenaardab38d52013-06-15 17:06:36 +02001957 if (!got_fdt_error)
1958 {
Bram Moolenaar9530b582022-01-22 13:39:08 +00001959 win_T *save_curwin = curwin;
1960 sctx_T saved_sctx = current_sctx;
1961
Bram Moolenaardab38d52013-06-15 17:06:36 +02001962 curwin = wp;
1963 curbuf = wp->w_buffer;
Bram Moolenaar9530b582022-01-22 13:39:08 +00001964 current_sctx = wp->w_p_script_ctx[WV_FDT];
Bram Moolenaardab38d52013-06-15 17:06:36 +02001965
Bram Moolenaar9530b582022-01-22 13:39:08 +00001966 ++emsg_off; // handle exceptions, but don't display errors
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001967 text = eval_to_string_safe(wp->w_p_fdt,
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001968 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL),
1969 TRUE, TRUE);
Bram Moolenaar9530b582022-01-22 13:39:08 +00001970 --emsg_off;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001971
Bram Moolenaardab38d52013-06-15 17:06:36 +02001972 if (text == NULL || did_emsg)
1973 got_fdt_error = TRUE;
1974
1975 curwin = save_curwin;
1976 curbuf = curwin->w_buffer;
Bram Moolenaar9530b582022-01-22 13:39:08 +00001977 current_sctx = saved_sctx;
Bram Moolenaardab38d52013-06-15 17:06:36 +02001978 }
1979 last_lnum = lnum;
1980 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001981 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1982
Bram Moolenaardab38d52013-06-15 17:06:36 +02001983 if (!did_emsg && save_did_emsg)
1984 did_emsg = save_did_emsg;
1985
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001986 if (text != NULL)
1987 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001988 // Replace unprintable characters, if there are any. But
1989 // replace a TAB with a space.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001990 for (p = text; *p != NUL; ++p)
1991 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001992 int len;
1993
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001994 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001995 {
1996 if (!vim_isprintc((*mb_ptr2char)(p)))
1997 break;
1998 p += len - 1;
1999 }
2000 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002001 if (*p == TAB)
2002 *p = ' ';
2003 else if (ptr2cells(p) > 1)
2004 break;
2005 }
2006 if (*p != NUL)
2007 {
2008 p = transstr(text);
2009 vim_free(text);
2010 text = p;
2011 }
2012 }
2013 }
2014 if (text == NULL)
2015#endif
2016 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02002017 long count = (long)(lnume - lnum + 1);
2018
2019 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01002020 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02002021 "+--%3ld lines folded ", count),
2022 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002023 text = buf;
2024 }
2025 return text;
2026}
2027
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002028// foldtext_cleanup() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +02002029#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030/*
2031 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2032 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02002033 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002034foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002036 char_u *cms_start; // first part or the whole comment
2037 int cms_slen = 0; // length of cms_start
2038 char_u *cms_end; // last part of the comment or NULL
2039 int cms_elen = 0; // length of cms_end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002041 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 int len;
2043 int did1 = FALSE;
2044 int did2 = FALSE;
2045
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002046 // Ignore leading and trailing white space in 'commentstring'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002048 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002049 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 --cms_slen;
2051
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002052 // locate "%s" in 'commentstring', use the part before and after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2054 if (cms_end != NULL)
2055 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002056 cms_elen = cms_slen - (int)(cms_end - cms_start);
2057 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002059 // exclude white space before "%s"
Bram Moolenaar1c465442017-03-12 20:10:05 +01002060 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 --cms_slen;
2062
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002063 // skip "%s" and white space after it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002065 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 cms_end = s;
2067 }
2068 parseMarker(curwin);
2069
2070 for (s = str; *s != NUL; )
2071 {
2072 len = 0;
2073 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002077 if (len > 0)
2078 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 if (VIM_ISDIGIT(s[len]))
2080 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002081
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002082 // May remove 'commentstring' start. Useful when it's a double
2083 // quote and we already removed a double quote.
Bram Moolenaar1c465442017-03-12 20:10:05 +01002084 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002085 ;
2086 if (p >= str + cms_slen
2087 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2088 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002089 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002090 s = p - cms_slen;
2091 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 }
2093 else if (cms_end != NULL)
2094 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002095 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 {
2097 len = cms_slen;
2098 did1 = TRUE;
2099 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002100 else if (!did2 && cms_elen > 0
2101 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 {
2103 len = cms_elen;
2104 did2 = TRUE;
2105 }
2106 }
2107 if (len != 0)
2108 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002109 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002111 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 }
2113 else
2114 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002115 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 }
2117 }
2118}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002119#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002121// Folding by indent, expr, marker and syntax. {{{1
2122// Define "fline_T", passed to get fold level for a line. {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123typedef struct
2124{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002125 win_T *wp; // window
2126 linenr_T lnum; // current line number
2127 linenr_T off; // offset between lnum and real line number
2128 linenr_T lnum_save; // line nr used by foldUpdateIEMSRecurse()
2129 int lvl; // current level (-1 for undefined)
2130 int lvl_next; // level used for next line
2131 int start; // number of folds that are forced to start at
2132 // this line.
2133 int end; // level of fold that is forced to end below
2134 // this line
2135 int had_end; // level of fold that is forced to end above
2136 // this line (copy of "end" of prev. line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137} fline_T;
2138
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002139// Flag is set when redrawing is needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140static int fold_changed;
2141
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002142// Function declarations. {{{2
Bram Moolenaard99df422016-01-29 23:20:40 +01002143static 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 +01002144static int foldInsert(garray_T *gap, int i);
2145static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2146static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2147static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2148static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002150static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002152static void foldlevelExpr(fline_T *flp);
2153static void foldlevelMarker(fline_T *flp);
2154static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002156// foldUpdateIEMS() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157/*
2158 * Update the folding for window "wp", at least from lines "top" to "bot".
2159 * Return TRUE if any folds did change.
2160 */
2161 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002162foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163{
2164 linenr_T start;
2165 linenr_T end;
2166 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002167 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 int level;
2169 fold_T *fp;
2170
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002171 // Avoid problems when being called recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 if (invalid_top != (linenr_T)0)
2173 return;
2174
2175 if (wp->w_foldinvalid)
2176 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002177 // Need to update all folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 top = 1;
2179 bot = wp->w_buffer->b_ml.ml_line_count;
2180 wp->w_foldinvalid = FALSE;
2181
Brandon Simmons3fcccf92022-05-20 18:25:21 +01002182 // Mark all folds as maybe-small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 setSmallMaybe(&wp->w_folds);
2184 }
2185
2186#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002187 // add the context for "diff" folding
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 if (foldmethodIsDiff(wp))
2189 {
2190 if (top > diff_context)
2191 top -= diff_context;
2192 else
2193 top = 1;
2194 bot += diff_context;
2195 }
2196#endif
2197
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002198 // When deleting lines at the end of the buffer "top" can be past the end
2199 // of the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 if (top > wp->w_buffer->b_ml.ml_line_count)
2201 top = wp->w_buffer->b_ml.ml_line_count;
2202
2203 fold_changed = FALSE;
2204 fline.wp = wp;
2205 fline.off = 0;
2206 fline.lvl = 0;
2207 fline.lvl_next = -1;
2208 fline.start = 0;
2209 fline.end = MAX_LEVEL + 1;
2210 fline.had_end = MAX_LEVEL + 1;
2211
2212 invalid_top = top;
2213 invalid_bot = bot;
2214
2215 if (foldmethodIsMarker(wp))
2216 {
2217 getlevel = foldlevelMarker;
2218
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002219 // Init marker variables to speed up foldlevelMarker().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 parseMarker(wp);
2221
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002222 // Need to get the level of the line above top, it is used if there is
2223 // no marker at the top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 if (top > 1)
2225 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002226 // Get the fold level at top - 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 level = foldLevelWin(wp, top - 1);
2228
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002229 // The fold may end just above the top, check for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 fline.lnum = top - 1;
2231 fline.lvl = level;
2232 getlevel(&fline);
2233
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002234 // If a fold started here, we already had the level, if it stops
2235 // here, we need to use lvl_next. Could also start and end a fold
2236 // in the same line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 if (fline.lvl > level)
2238 fline.lvl = level - (fline.lvl - fline.lvl_next);
2239 else
2240 fline.lvl = fline.lvl_next;
2241 }
2242 fline.lnum = top;
2243 getlevel(&fline);
2244 }
2245 else
2246 {
2247 fline.lnum = top;
2248 if (foldmethodIsExpr(wp))
2249 {
2250 getlevel = foldlevelExpr;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002251 // start one line back, because a "<1" may indicate the end of a
2252 // fold in the topline
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 if (top > 1)
2254 --fline.lnum;
2255 }
2256 else if (foldmethodIsSyntax(wp))
2257 getlevel = foldlevelSyntax;
2258#ifdef FEAT_DIFF
2259 else if (foldmethodIsDiff(wp))
2260 getlevel = foldlevelDiff;
2261#endif
2262 else
Brandon Simmonsd98e75e2022-05-10 19:13:23 +01002263 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 getlevel = foldlevelIndent;
Brandon Simmonsd98e75e2022-05-10 19:13:23 +01002265 // Start one line back, because if the line above "top" has an
2266 // undefined fold level, folding it relies on the line under it,
2267 // which is "top".
2268 if (top > 1)
2269 --fline.lnum;
2270 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002272 // Backup to a line for which the fold level is defined. Since it's
2273 // always defined for line one, we will stop there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 fline.lvl = -1;
2275 for ( ; !got_int; --fline.lnum)
2276 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002277 // Reset lvl_next each time, because it will be set to a value for
2278 // the next line, but we search backwards here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 fline.lvl_next = -1;
2280 getlevel(&fline);
2281 if (fline.lvl >= 0)
2282 break;
2283 }
2284 }
2285
Bram Moolenaarec986472009-11-03 13:46:54 +00002286 /*
2287 * If folding is defined by the syntax, it is possible that a change in
2288 * one line will cause all sub-folds of the current fold to change (e.g.,
2289 * closing a C-style comment can cause folds in the subsequent lines to
2290 * appear). To take that into account we should adjust the value of "bot"
2291 * to point to the end of the current fold:
2292 */
2293 if (foldlevelSyntax == getlevel)
2294 {
2295 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002296 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002297 int current_fdl = 0;
2298 linenr_T fold_start_lnum = 0;
2299 linenr_T lnum_rel = fline.lnum;
2300
2301 while (current_fdl < fline.lvl)
2302 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002303 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002304 break;
2305 ++current_fdl;
2306
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002307 fold_start_lnum += fpn->fd_top;
2308 gap = &fpn->fd_nested;
2309 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002310 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002311 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002312 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002313 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002314
2315 if (fold_end_lnum > bot)
2316 bot = fold_end_lnum;
2317 }
2318 }
2319
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 start = fline.lnum;
2321 end = bot;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002322 // Do at least one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2324 end = start;
2325 while (!got_int)
2326 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002327 // Always stop at the end of the file ("end" can be past the end of
2328 // the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2330 break;
2331 if (fline.lnum > end)
2332 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002333 // For "marker", "expr" and "syntax" methods: If a change caused
2334 // a fold to be removed, we need to continue at least until where
2335 // it ended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 if (getlevel != foldlevelMarker
2337 && getlevel != foldlevelSyntax
2338 && getlevel != foldlevelExpr)
2339 break;
2340 if ((start <= end
2341 && foldFind(&wp->w_folds, end, &fp)
2342 && fp->fd_top + fp->fd_len - 1 > end)
2343 || (fline.lvl == 0
2344 && foldFind(&wp->w_folds, fline.lnum, &fp)
2345 && fp->fd_top < fline.lnum))
2346 end = fp->fd_top + fp->fd_len - 1;
2347 else if (getlevel == foldlevelSyntax
2348 && foldLevelWin(wp, fline.lnum) != fline.lvl)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002349 // For "syntax" method: Compare the foldlevel that the syntax
2350 // tells us to the foldlevel from the existing folds. If they
2351 // don't match continue updating folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 end = fline.lnum;
2353 else
2354 break;
2355 }
2356
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002357 // A level 1 fold starts at a line with foldlevel > 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 if (fline.lvl > 0)
2359 {
2360 invalid_top = fline.lnum;
2361 invalid_bot = end;
2362 end = foldUpdateIEMSRecurse(&wp->w_folds,
2363 1, start, &fline, getlevel, end, FD_LEVEL);
2364 start = fline.lnum;
2365 }
2366 else
2367 {
2368 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2369 break;
2370 ++fline.lnum;
2371 fline.lvl = fline.lvl_next;
2372 getlevel(&fline);
2373 }
2374 }
2375
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002376 // There can't be any folds from start until end now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 foldRemove(&wp->w_folds, start, end);
2378
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002379 // If some fold changed, need to redraw and position cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002381 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002383 // If we updated folds past "bot", need to redraw more lines. Don't do
2384 // this in other situations, the changed lines will be redrawn anyway and
2385 // this method can cause the whole window to be updated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 if (end != bot)
Luuk van Baal7bbb0f32025-02-22 09:19:04 +01002387 redraw_win_range_later(wp, top, end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388
2389 invalid_top = (linenr_T)0;
2390}
2391
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002392// foldUpdateIEMSRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393/*
2394 * Update a fold that starts at "flp->lnum". At this line there is always a
2395 * valid foldlevel, and its level >= "level".
2396 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2397 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2398 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2399 * the marker method and a text change made following folds to change.
2400 * When returning, "flp->lnum_save" is the line number that was used to get
2401 * the level when the level at "flp->lnum" is invalid.
2402 * Remove any folds from "startlnum" up to here at this level.
2403 * Recursively update nested folds.
2404 * Below line "bot" there are no changes in the text.
2405 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2406 * outer fold.
2407 * "flp->off" is the offset to the real line number in the buffer.
2408 *
2409 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002410 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2412 *
2413 * Returns bot, which may have been increased for lines that also need to be
2414 * updated as a result of a detected change in the fold.
2415 */
2416 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002417foldUpdateIEMSRecurse(
2418 garray_T *gap,
2419 int level,
2420 linenr_T startlnum,
2421 fline_T *flp,
2422 void (*getlevel)(fline_T *),
2423 linenr_T bot,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002424 int topflags) // flags used by containing fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425{
2426 linenr_T ll;
2427 fold_T *fp = NULL;
2428 fold_T *fp2;
2429 int lvl = level;
2430 linenr_T startlnum2 = startlnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002431 linenr_T firstlnum = flp->lnum; // first lnum we got
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 int i;
2433 int finish = FALSE;
2434 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2435 int concat;
2436
2437 /*
2438 * If using the marker method, the start line is not the start of a fold
2439 * at the level we're dealing with and the level is non-zero, we must use
2440 * the previous fold. But ignore a fold that starts at or below
2441 * startlnum, it must be deleted.
2442 */
2443 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2444 && flp->lvl > 0)
2445 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002446 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaarda697642020-09-17 19:36:04 +02002447 if (fp != NULL && (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2448 || fp->fd_top >= startlnum))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 fp = NULL;
2450 }
2451
2452 /*
2453 * Loop over all lines in this fold, or until "bot" is hit.
2454 * Handle nested folds inside of this fold.
2455 * "flp->lnum" is the current line. When finding the end of the fold, it
2456 * is just below the end of the fold.
2457 * "*flp" contains the level of the line "flp->lnum" or a following one if
2458 * there are lines with an invalid fold level. "flp->lnum_save" is the
2459 * line number that was used to get the fold level (below "flp->lnum" when
2460 * it has an invalid fold level). When called the fold level is always
2461 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2462 */
2463 flp->lnum_save = flp->lnum;
2464 while (!got_int)
2465 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002466 // Updating folds can be slow, check for CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 line_breakcheck();
2468
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002469 // Set "lvl" to the level of line "flp->lnum". When flp->start is set
2470 // and after the first line of the fold, set the level to zero to
2471 // force the fold to end. Do the same when had_end is set: Previous
2472 // line was marked as end of a fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 lvl = flp->lvl;
2474 if (lvl > MAX_LEVEL)
2475 lvl = MAX_LEVEL;
2476 if (flp->lnum > firstlnum
2477 && (level > lvl - flp->start || level >= flp->had_end))
2478 lvl = 0;
2479
2480 if (flp->lnum > bot && !finish && fp != NULL)
2481 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002482 // For "marker" and "syntax" methods:
2483 // - If a change caused a nested fold to be removed, we need to
2484 // delete it and continue at least until where it ended.
2485 // - If a change caused a nested fold to be created, or this fold
2486 // to continue below its original end, need to finish this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 if (getlevel != foldlevelMarker
2488 && getlevel != foldlevelExpr
2489 && getlevel != foldlevelSyntax)
2490 break;
2491 i = 0;
2492 fp2 = fp;
2493 if (lvl >= level)
2494 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002495 // Compute how deep the folds currently are, if it's deeper
2496 // than "lvl" then some must be deleted, need to update
2497 // at least one nested fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 ll = flp->lnum - fp->fd_top;
2499 while (foldFind(&fp2->fd_nested, ll, &fp2))
2500 {
2501 ++i;
2502 ll -= fp2->fd_top;
2503 }
2504 }
2505 if (lvl < level + i)
2506 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002507 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 if (fp2 != NULL)
2509 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2510 }
2511 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2512 finish = TRUE;
2513 else
2514 break;
2515 }
2516
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002517 // At the start of the first nested fold and at the end of the current
2518 // fold: check if existing folds at this level, before the current
2519 // one, need to be deleted or truncated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 if (fp == NULL
2521 && (lvl != level
2522 || flp->lnum_save >= bot
2523 || flp->start != 0
2524 || flp->had_end <= MAX_LEVEL
2525 || flp->lnum == linecount))
2526 {
2527 /*
2528 * Remove or update folds that have lines between startlnum and
2529 * firstlnum.
2530 */
2531 while (!got_int)
2532 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00002533 // set concat to 1 if it's allowed to concatenate this fold
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002534 // with a previous one that touches it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2536 concat = 0;
2537 else
2538 concat = 1;
2539
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002540 // Find an existing fold to re-use. Preferably one that
2541 // includes startlnum, otherwise one that ends just before
2542 // startlnum or starts after it.
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002543 if (gap->ga_len > 0 && (foldFind(gap, startlnum, &fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2545 && fp->fd_top <= firstlnum)
2546 || foldFind(gap, firstlnum - concat, &fp)
2547 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2548 && ((lvl < level && fp->fd_top < flp->lnum)
2549 || (lvl >= level
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002550 && fp->fd_top <= flp->lnum_save)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 {
2552 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2553 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002554 // Use existing fold for the new fold. If it starts
2555 // before where we started looking, extend it. If it
2556 // starts at another line, update nested folds to keep
2557 // their position, compensating for the new fd_top.
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002558 if (fp->fd_top == firstlnum)
2559 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002560 // have found a fold beginning where we want
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002561 }
2562 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 {
2564 if (fp->fd_top > firstlnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002565 // like lines are inserted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 foldMarkAdjustRecurse(&fp->fd_nested,
2567 (linenr_T)0, (linenr_T)MAXLNUM,
2568 (long)(fp->fd_top - firstlnum), 0L);
2569 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002570 // like lines are deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 foldMarkAdjustRecurse(&fp->fd_nested,
2572 (linenr_T)0,
2573 (long)(firstlnum - fp->fd_top - 1),
2574 (linenr_T)MAXLNUM,
2575 (long)(fp->fd_top - firstlnum));
2576 fp->fd_len += fp->fd_top - firstlnum;
2577 fp->fd_top = firstlnum;
Brandon Simmonse8c4a642022-05-23 15:33:08 +01002578 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 fold_changed = TRUE;
2580 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002581 else if ((flp->start != 0 && lvl == level)
2582 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002584 linenr_T breakstart;
2585 linenr_T breakend;
2586
2587 /*
2588 * Before there was a fold spanning from above
2589 * startlnum to below firstlnum. This fold is valid
2590 * above startlnum (because we are not updating
2591 * that range), but there should now be a break in
2592 * it.
2593 * If the break is because we are now forced to
2594 * start a new fold at the level "level" at line
2595 * fline->lnum, then we need to split the fold at
2596 * fline->lnum.
2597 * If the break is because the range
2598 * [startlnum, firstlnum) is now at a lower indent
2599 * than "level", we need to split the fold in this
2600 * range.
2601 * Any splits have to be done recursively.
2602 */
2603 if (firstlnum != startlnum)
2604 {
2605 breakstart = startlnum;
2606 breakend = firstlnum;
2607 }
2608 else
2609 {
2610 breakstart = flp->lnum;
2611 breakend = flp->lnum;
2612 }
2613 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2614 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002616 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002618
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002619 // If using the "marker" or "syntax" method, we
2620 // need to continue until the end of the fold is
2621 // found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 if (getlevel == foldlevelMarker
2623 || getlevel == foldlevelExpr
2624 || getlevel == foldlevelSyntax)
2625 finish = TRUE;
2626 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002627
2628 if (fp->fd_top == startlnum && concat)
2629 {
2630 i = (int)(fp - (fold_T *)gap->ga_data);
2631 if (i != 0)
2632 {
2633 fp2 = fp - 1;
2634 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2635 {
2636 foldMerge(fp2, gap, fp);
2637 fp = fp2;
2638 }
2639 }
2640 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 break;
2642 }
2643 if (fp->fd_top >= startlnum)
2644 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002645 // A fold that starts at or after startlnum and stops
2646 // before the new fold must be deleted. Continue
2647 // looking for the next one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 deleteFoldEntry(gap,
2649 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2650 }
2651 else
2652 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002653 // A fold has some lines above startlnum, truncate it
2654 // to stop just above startlnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 fp->fd_len = startlnum - fp->fd_top;
2656 foldMarkAdjustRecurse(&fp->fd_nested,
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00002657 fp->fd_len, (linenr_T)MAXLNUM,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 (linenr_T)MAXLNUM, 0L);
2659 fold_changed = TRUE;
2660 }
2661 }
2662 else
2663 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002664 // Insert new fold. Careful: ga_data may be NULL and it
2665 // may change!
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002666 if (gap->ga_len == 0)
2667 i = 0;
2668 else
2669 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 if (foldInsert(gap, i) != OK)
2671 return bot;
2672 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002673 // The new fold continues until bot, unless we find the
2674 // end earlier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 fp->fd_top = firstlnum;
2676 fp->fd_len = bot - firstlnum + 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002677 // When the containing fold is open, the new fold is open.
2678 // The new fold is closed if the fold above it is closed.
2679 // The first fold depends on the containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 if (topflags == FD_OPEN)
2681 {
2682 flp->wp->w_fold_manual = TRUE;
2683 fp->fd_flags = FD_OPEN;
2684 }
2685 else if (i <= 0)
2686 {
2687 fp->fd_flags = topflags;
2688 if (topflags != FD_LEVEL)
2689 flp->wp->w_fold_manual = TRUE;
2690 }
2691 else
2692 fp->fd_flags = (fp - 1)->fd_flags;
2693 fp->fd_small = MAYBE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002694 // If using the "marker", "expr" or "syntax" method, we
2695 // need to continue until the end of the fold is found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 if (getlevel == foldlevelMarker
2697 || getlevel == foldlevelExpr
2698 || getlevel == foldlevelSyntax)
2699 finish = TRUE;
2700 fold_changed = TRUE;
2701 break;
2702 }
2703 }
2704 }
2705
2706 if (lvl < level || flp->lnum > linecount)
2707 {
2708 /*
2709 * Found a line with a lower foldlevel, this fold ends just above
2710 * "flp->lnum".
2711 */
2712 break;
2713 }
2714
2715 /*
2716 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002717 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002719 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 {
2721 /*
2722 * There is a nested fold, handle it recursively.
2723 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002724 // At least do one line (can happen when finish is TRUE).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 if (bot < flp->lnum)
2726 bot = flp->lnum;
2727
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002728 // Line numbers in the nested fold are relative to the start of
2729 // this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 flp->lnum = flp->lnum_save - fp->fd_top;
2731 flp->off += fp->fd_top;
2732 i = (int)(fp - (fold_T *)gap->ga_data);
2733 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2734 startlnum2 - fp->fd_top, flp, getlevel,
2735 bot - fp->fd_top, fp->fd_flags);
2736 fp = (fold_T *)gap->ga_data + i;
2737 flp->lnum += fp->fd_top;
2738 flp->lnum_save += fp->fd_top;
2739 flp->off -= fp->fd_top;
2740 bot += fp->fd_top;
2741 startlnum2 = flp->lnum;
2742
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002743 // This fold may end at the same line, don't incr. flp->lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 }
2745 else
2746 {
2747 /*
2748 * Get the level of the next line, then continue the loop to check
2749 * if it ends there.
2750 * Skip over undefined lines, to find the foldlevel after it.
2751 * For the last line in the file the foldlevel is always valid.
2752 */
2753 flp->lnum = flp->lnum_save;
2754 ll = flp->lnum + 1;
2755 while (!got_int)
2756 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002757 // Make the previous level available to foldlevel().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 prev_lnum = flp->lnum;
2759 prev_lnum_lvl = flp->lvl;
2760
2761 if (++flp->lnum > linecount)
2762 break;
2763 flp->lvl = flp->lvl_next;
2764 getlevel(flp);
2765 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2766 break;
2767 }
2768 prev_lnum = 0;
2769 if (flp->lnum > linecount)
2770 break;
2771
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002772 // leave flp->lnum_save to lnum of the line that was used to get
2773 // the level, flp->lnum to the lnum of the next line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 flp->lnum_save = flp->lnum;
2775 flp->lnum = ll;
2776 }
2777 }
2778
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002779 if (fp == NULL) // only happens when got_int is set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 return bot;
2781
2782 /*
2783 * Get here when:
2784 * lvl < level: the folds ends just above "flp->lnum"
2785 * lvl >= level: fold continues below "bot"
2786 */
2787
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002788 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 if (fp->fd_len < flp->lnum - fp->fd_top)
2790 {
2791 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002792 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 fold_changed = TRUE;
2794 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002795 else if (fp->fd_top + fp->fd_len > linecount)
2796 // running into the end of the buffer (deleted last line)
2797 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002799 // Delete contained folds from the end of the last one found until where
2800 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2802 flp->lnum - 1 - fp->fd_top);
2803
2804 if (lvl < level)
2805 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002806 // End of fold found, update the length when it got shorter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 if (fp->fd_len != flp->lnum - fp->fd_top)
2808 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002809 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002811 // fold continued below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 if (getlevel == foldlevelMarker
2813 || getlevel == foldlevelExpr
2814 || getlevel == foldlevelSyntax)
2815 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002816 // marker method: truncate the fold and make sure the
2817 // previously included lines are processed again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 bot = fp->fd_top + fp->fd_len - 1;
2819 fp->fd_len = flp->lnum - fp->fd_top;
2820 }
2821 else
2822 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002823 // indent or expr method: split fold to create a new one
2824 // below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 i = (int)(fp - (fold_T *)gap->ga_data);
2826 foldSplit(gap, i, flp->lnum, bot);
2827 fp = (fold_T *)gap->ga_data + i;
2828 }
2829 }
2830 else
2831 fp->fd_len = flp->lnum - fp->fd_top;
2832 fold_changed = TRUE;
2833 }
2834 }
2835
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002836 // delete following folds that end before the current line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 for (;;)
2838 {
2839 fp2 = fp + 1;
2840 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2841 || fp2->fd_top > flp->lnum)
2842 break;
2843 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2844 {
2845 if (fp2->fd_top < flp->lnum)
2846 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002847 // Make fold that includes lnum start at lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 foldMarkAdjustRecurse(&fp2->fd_nested,
2849 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2850 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2851 fp2->fd_len -= flp->lnum - fp2->fd_top;
2852 fp2->fd_top = flp->lnum;
2853 fold_changed = TRUE;
2854 }
2855
2856 if (lvl >= level)
2857 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002858 // merge new fold with existing fold that follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 foldMerge(fp, gap, fp2);
2860 }
2861 break;
2862 }
2863 fold_changed = TRUE;
2864 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2865 }
2866
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002867 // Need to redraw the lines we inspected, which might be further down than
2868 // was asked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 if (bot < flp->lnum - 1)
2870 bot = flp->lnum - 1;
2871
2872 return bot;
2873}
2874
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002875// foldInsert() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876/*
2877 * Insert a new fold in "gap" at position "i".
2878 * Returns OK for success, FAIL for failure.
2879 */
2880 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002881foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882{
2883 fold_T *fp;
2884
Yegappan Lakshmananfadc02a2023-01-27 21:03:12 +00002885 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 return FAIL;
2887 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002888 if (gap->ga_len > 0 && i < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2890 ++gap->ga_len;
Bram Moolenaar04935fb2022-01-08 16:19:22 +00002891 ga_init2(&fp->fd_nested, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 return OK;
2893}
2894
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002895// foldSplit() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896/*
2897 * Split the "i"th fold in "gap", which starts before "top" and ends below
2898 * "bot" in two pieces, one ending above "top" and the other starting below
2899 * "bot".
2900 * The caller must first have taken care of any nested folds from "top" to
2901 * "bot"!
2902 */
2903 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002904foldSplit(
2905 garray_T *gap,
2906 int i,
2907 linenr_T top,
2908 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909{
2910 fold_T *fp;
2911 fold_T *fp2;
2912 garray_T *gap1;
2913 garray_T *gap2;
2914 int idx;
2915 int len;
2916
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002917 // The fold continues below bot, need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 if (foldInsert(gap, i + 1) == FAIL)
2919 return;
2920 fp = (fold_T *)gap->ga_data + i;
2921 fp[1].fd_top = bot + 1;
2922 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2923 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002924 fp[1].fd_small = MAYBE;
2925 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002927 // Move nested folds below bot to new fold. There can't be
2928 // any between top and bot, they have been removed by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 gap1 = &fp->fd_nested;
2930 gap2 = &fp[1].fd_nested;
Brandon Simmons2c407072022-04-23 13:50:17 +01002931 (void)foldFind(gap1, bot + 1 - fp->fd_top, &fp2);
2932 if (fp2 != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002934 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2935 if (len > 0 && ga_grow(gap2, len) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002937 for (idx = 0; idx < len; ++idx)
2938 {
2939 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2940 ((fold_T *)gap2->ga_data)[idx].fd_top
2941 -= fp[1].fd_top - fp->fd_top;
2942 }
2943 gap2->ga_len = len;
2944 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 }
2947 fp->fd_len = top - fp->fd_top;
2948 fold_changed = TRUE;
2949}
2950
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002951// foldRemove() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952/*
2953 * Remove folds within the range "top" to and including "bot".
2954 * Check for these situations:
2955 * 1 2 3
2956 * 1 2 3
2957 * top 2 3 4 5
2958 * 2 3 4 5
2959 * bot 2 3 4 5
2960 * 3 5 6
2961 * 3 5 6
2962 *
2963 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002964 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 * 3: split in two parts, one stops above "top", other starts below "bot".
2966 * 4: deleted
2967 * 5: made to start below "bot".
2968 * 6: not changed
2969 */
2970 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002971foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972{
2973 fold_T *fp = NULL;
2974
2975 if (bot < top)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002976 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002978 while (gap->ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002980 // Find fold that includes top or a following one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2982 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002983 // 2: or 3: need to delete nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002985 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002987 // 3: need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2989 }
2990 else
2991 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002992 // 2: truncate fold at "top".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 fp->fd_len = top - fp->fd_top;
2994 }
2995 fold_changed = TRUE;
2996 continue;
2997 }
2998 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2999 || fp->fd_top > bot)
3000 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003001 // 6: Found a fold below bot, can stop looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 break;
3003 }
3004 if (fp->fd_top >= top)
3005 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003006 // Found an entry below top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003008 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003010 // 5: Make fold that includes bot start below bot.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 foldMarkAdjustRecurse(&fp->fd_nested,
3012 (linenr_T)0, (long)(bot - fp->fd_top),
3013 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
3014 fp->fd_len -= bot - fp->fd_top + 1;
3015 fp->fd_top = bot + 1;
3016 break;
3017 }
3018
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003019 // 4: Delete completely contained fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
3021 }
3022 }
3023}
3024
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003025// foldReverseOrder() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003026 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003027foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003028{
3029 fold_T *left, *right;
3030 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003031 linenr_T start = start_arg;
3032 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003033
3034 for (; start < end; start++, end--)
3035 {
3036 left = (fold_T *)gap->ga_data + start;
3037 right = (fold_T *)gap->ga_data + end;
3038 tmp = *left;
3039 *left = *right;
3040 *right = tmp;
3041 }
3042}
3043
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003044// foldMoveRange() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003045/*
3046 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3047 * requires "line1" <= "line2" <= "dest"
3048 *
3049 * There are the following situations for the first fold at or below line1 - 1.
3050 * 1 2 3 4
3051 * 1 2 3 4
3052 * line1 2 3 4
3053 * 2 3 4 5 6 7
3054 * line2 3 4 5 6 7
3055 * 3 4 6 7 8 9
3056 * dest 4 7 8 9
3057 * 4 7 8 10
3058 * 4 7 8 10
3059 *
3060 * In the following descriptions, "moved" means moving in the buffer, *and* in
3061 * the fold array.
3062 * Meanwhile, "shifted" just means moving in the buffer.
3063 * 1. not changed
3064 * 2. truncated above line1
3065 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3066 * dest are truncated and shifted up
3067 * 4. internal folds moved (from [line1, line2] to dest)
3068 * 5. moved to dest.
3069 * 6. truncated below line2 and moved.
3070 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3071 * removed, top is moved down by move_len.
3072 * 8. truncated below dest and shifted up.
3073 * 9. shifted up
3074 * 10. not changed
3075 */
3076
3077 static void
3078truncate_fold(fold_T *fp, linenr_T end)
3079{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003080 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003081 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003082 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003083}
3084
3085#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
Bram Moolenaar81fcb672020-09-01 21:21:24 +02003086#define valid_fold(fp, gap) ((gap)->ga_len > 0 && (fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
kylo252ae6f1d82022-02-16 19:24:07 +00003087#define fold_index(fp, gap) ((size_t)((fp) - ((fold_T *)(gap)->ga_data)))
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003088
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003089 void
3090foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003091{
3092 fold_T *fp;
3093 linenr_T range_len = line2 - line1 + 1;
3094 linenr_T move_len = dest - line2;
3095 int at_start = foldFind(gap, line1 - 1, &fp);
3096 size_t move_start = 0, move_end = 0, dest_index = 0;
3097
3098 if (at_start)
3099 {
3100 if (fold_end(fp) > dest)
3101 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003102 // Case 4
3103 // don't have to change this fold, but have to move nested folds.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003104 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3105 fp->fd_top, dest - fp->fd_top);
3106 return;
3107 }
3108 else if (fold_end(fp) > line2)
3109 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003110 // Case 3
3111 // Remove nested folds between line1 and line2 & reduce the
3112 // length of fold by "range_len".
3113 // Folds after this one must be dealt with.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003114 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3115 fp->fd_top, MAXLNUM, -range_len);
3116 fp->fd_len -= range_len;
3117 }
3118 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003119 // Case 2 truncate fold, folds after this one must be dealt with.
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003120 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003121
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003122 // Look at the next fold, and treat that one as if it were the first
3123 // after "line1" (because now it is).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003124 fp = fp + 1;
3125 }
3126
3127 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3128 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003129 // Case 10
3130 // No folds after "line1" and before "dest"
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003131 return;
3132 }
3133 else if (fp->fd_top > line2)
3134 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003135 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003136 // Case 9. (for all case 9's) -- shift up.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003137 fp->fd_top -= range_len;
3138
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003139 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003140 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003141 // Case 8. -- ensure truncated at dest, shift up
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003142 truncate_fold(fp, dest);
3143 fp->fd_top -= range_len;
3144 }
3145 return;
3146 }
3147 else if (fold_end(fp) > dest)
3148 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003149 // Case 7 -- remove nested folds and shrink
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003150 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3151 fp->fd_top, MAXLNUM, -move_len);
3152 fp->fd_len -= move_len;
3153 fp->fd_top += move_len;
3154 return;
3155 }
3156
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003157 // Case 5 or 6
3158 // changes rely on whether there are folds between the end of
3159 // this fold and "dest".
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003160 move_start = fold_index(fp, gap);
3161
3162 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3163 {
3164 if (fp->fd_top <= line2)
3165 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003166 // 1. 2. or 3.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003167 if (fold_end(fp) > line2)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003168 // 2. or 3., truncate before moving
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003169 truncate_fold(fp, line2);
3170
3171 fp->fd_top += move_len;
3172 continue;
3173 }
3174
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003175 // Record index of the first fold after the moved range.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003176 if (move_end == 0)
3177 move_end = fold_index(fp, gap);
3178
3179 if (fold_end(fp) > dest)
3180 truncate_fold(fp, dest);
3181
3182 fp->fd_top -= range_len;
3183 }
3184
3185 dest_index = fold_index(fp, gap);
3186
3187 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003188 * All folds are now correct, but not necessarily in the correct order. We
3189 * must swap folds in the range [move_end, dest_index) with those in the
3190 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003191 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003192 if (move_end == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003193 // There are no folds after those moved, hence no folds have been moved
3194 // out of order.
Bram Moolenaar94be6192017-04-22 22:40:11 +02003195 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003196 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3197 foldReverseOrder(gap, (linenr_T)move_start,
3198 (linenr_T)(move_start + dest_index - move_end - 1));
3199 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3200 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003201}
3202#undef fold_end
3203#undef valid_fold
3204#undef fold_index
3205
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003206// foldMerge() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003208 * Merge two adjacent folds (and the nested ones in them).
3209 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 * must end just above "fp2".
3211 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3212 * Fold entry "fp2" in "gap" is deleted.
3213 */
3214 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003215foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216{
3217 fold_T *fp3;
3218 fold_T *fp4;
3219 int idx;
3220 garray_T *gap1 = &fp1->fd_nested;
3221 garray_T *gap2 = &fp2->fd_nested;
3222
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003223 // If the last nested fold in fp1 touches the first nested fold in fp2,
3224 // merge them recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3226 foldMerge(fp3, gap2, fp4);
3227
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003228 // Move nested folds in fp2 to the end of fp1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3230 {
3231 for (idx = 0; idx < gap2->ga_len; ++idx)
3232 {
3233 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3234 = ((fold_T *)gap2->ga_data)[idx];
3235 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3236 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 }
3238 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 }
3240
3241 fp1->fd_len += fp2->fd_len;
3242 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3243 fold_changed = TRUE;
3244}
3245
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003246// foldlevelIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247/*
3248 * Low level function to get the foldlevel for the "indent" method.
3249 * Doesn't use any caching.
3250 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3251 */
3252 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003253foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254{
3255 char_u *s;
3256 buf_T *buf;
3257 linenr_T lnum = flp->lnum + flp->off;
3258
3259 buf = flp->wp->w_buffer;
3260 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3261
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003262 // empty line or lines starting with a character in 'foldignore': level
3263 // depends on surrounding lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3265 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003266 // first and last line can't be undefined, use level 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3268 flp->lvl = 0;
3269 else
3270 flp->lvl = -1;
3271 }
3272 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003273 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003275 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003277 if (flp->lvl < 0)
3278 flp->lvl = 0;
3279 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280}
3281
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003282// foldlevelDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283#ifdef FEAT_DIFF
3284/*
3285 * Low level function to get the foldlevel for the "diff" method.
3286 * Doesn't use any caching.
3287 */
3288 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003289foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290{
3291 if (diff_infold(flp->wp, flp->lnum + flp->off))
3292 flp->lvl = 1;
3293 else
3294 flp->lvl = 0;
3295}
3296#endif
3297
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003298// foldlevelExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299/*
3300 * Low level function to get the foldlevel for the "expr" method.
3301 * Doesn't use any caching.
3302 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3303 */
3304 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003305foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306{
3307#ifndef FEAT_EVAL
3308 flp->start = FALSE;
3309 flp->lvl = 0;
3310#else
3311 win_T *win;
3312 int n;
3313 int c;
3314 linenr_T lnum = flp->lnum + flp->off;
3315 int save_keytyped;
3316
3317 win = curwin;
3318 curwin = flp->wp;
3319 curbuf = flp->wp->w_buffer;
3320 set_vim_var_nr(VV_LNUM, lnum);
3321
3322 flp->start = 0;
3323 flp->had_end = flp->end;
3324 flp->end = MAX_LEVEL + 1;
3325 if (lnum <= 1)
3326 flp->lvl = 0;
3327
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003328 // KeyTyped may be reset to 0 when calling a function which invokes
3329 // do_cmdline(). To make 'foldopen' work correctly restore KeyTyped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 save_keytyped = KeyTyped;
Bram Moolenaare70dd112022-01-21 16:31:11 +00003331 n = eval_foldexpr(flp->wp, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 KeyTyped = save_keytyped;
3333
3334 switch (c)
3335 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003336 // "a1", "a2", .. : add to the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 case 'a': if (flp->lvl >= 0)
3338 {
3339 flp->lvl += n;
3340 flp->lvl_next = flp->lvl;
3341 }
3342 flp->start = n;
3343 break;
3344
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003345 // "s1", "s2", .. : subtract from the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 case 's': if (flp->lvl >= 0)
3347 {
3348 if (n > flp->lvl)
3349 flp->lvl_next = 0;
3350 else
3351 flp->lvl_next = flp->lvl - n;
3352 flp->end = flp->lvl_next + 1;
3353 }
3354 break;
3355
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003356 // ">1", ">2", .. : start a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 case '>': flp->lvl = n;
3358 flp->lvl_next = n;
3359 flp->start = 1;
3360 break;
3361
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003362 // "<1", "<2", .. : end a fold with a certain level
Shota Nozaki0689b872024-01-03 19:18:43 +01003363 case '<': // To prevent an unexpected start of a new fold, the next
3364 // level must not exceed the level of the current fold.
3365 flp->lvl_next = MIN(flp->lvl, n - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 flp->end = n;
3367 break;
3368
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003369 // "=": No change in level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 case '=': flp->lvl_next = flp->lvl;
3371 break;
3372
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003373 // "-1", "0", "1", ..: set fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 default: if (n < 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003375 // Use the current level for the next line, so that "a1"
3376 // will work there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 flp->lvl_next = flp->lvl;
3378 else
3379 flp->lvl_next = n;
3380 flp->lvl = n;
3381 break;
3382 }
3383
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003384 // If the level is unknown for the first or the last line in the file, use
3385 // level 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 if (flp->lvl < 0)
3387 {
3388 if (lnum <= 1)
3389 {
3390 flp->lvl = 0;
3391 flp->lvl_next = 0;
3392 }
3393 if (lnum == curbuf->b_ml.ml_line_count)
3394 flp->lvl_next = 0;
3395 }
3396
3397 curwin = win;
3398 curbuf = curwin->w_buffer;
3399#endif
3400}
3401
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003402// parseMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403/*
3404 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3405 * "foldendmarkerlen".
3406 * Relies on the option value to have been checked for correctness already.
3407 */
3408 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003409parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410{
3411 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3412 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3413 foldendmarkerlen = (int)STRLEN(foldendmarker);
3414}
3415
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003416// foldlevelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417/*
3418 * Low level function to get the foldlevel for the "marker" method.
3419 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3420 * set before calling this.
3421 * Requires that flp->lvl is set to the fold level of the previous line!
3422 * Careful: This means you can't call this function twice on the same line.
3423 * Doesn't use any caching.
3424 * Sets flp->start when a start marker was found.
3425 */
3426 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003427foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428{
3429 char_u *startmarker;
3430 int cstart;
3431 int cend;
3432 int start_lvl = flp->lvl;
3433 char_u *s;
3434 int n;
3435
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003436 // cache a few values for speed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 startmarker = flp->wp->w_p_fmr;
3438 cstart = *startmarker;
3439 ++startmarker;
3440 cend = *foldendmarker;
3441
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003442 // Default: no start found, next level is same as current level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 flp->start = 0;
3444 flp->lvl_next = flp->lvl;
3445
3446 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3447 while (*s)
3448 {
3449 if (*s == cstart
3450 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3451 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003452 // found startmarker: set flp->lvl
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 s += foldstartmarkerlen;
3454 if (VIM_ISDIGIT(*s))
3455 {
3456 n = atoi((char *)s);
3457 if (n > 0)
3458 {
3459 flp->lvl = n;
3460 flp->lvl_next = n;
3461 if (n <= start_lvl)
3462 flp->start = 1;
3463 else
3464 flp->start = n - start_lvl;
3465 }
3466 }
3467 else
3468 {
3469 ++flp->lvl;
3470 ++flp->lvl_next;
3471 ++flp->start;
3472 }
3473 }
3474 else if (*s == cend
3475 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3476 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003477 // found endmarker: set flp->lvl_next
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 s += foldendmarkerlen;
3479 if (VIM_ISDIGIT(*s))
3480 {
3481 n = atoi((char *)s);
3482 if (n > 0)
3483 {
3484 flp->lvl = n;
3485 flp->lvl_next = n - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003486 // never start a fold with an end marker
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003487 if (flp->lvl_next > start_lvl)
3488 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 }
3490 }
3491 else
3492 --flp->lvl_next;
3493 }
3494 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003495 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 }
3497
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003498 // The level can't go negative, must be missing a start marker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 if (flp->lvl_next < 0)
3500 flp->lvl_next = 0;
3501}
3502
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003503// foldlevelSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504/*
3505 * Low level function to get the foldlevel for the "syntax" method.
3506 * Doesn't use any caching.
3507 */
3508 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003509foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510{
3511#ifndef FEAT_SYN_HL
3512 flp->start = 0;
3513 flp->lvl = 0;
3514#else
3515 linenr_T lnum = flp->lnum + flp->off;
3516 int n;
3517
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003518 // Use the maximum fold level at the start of this line and the next.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3520 flp->start = 0;
3521 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3522 {
3523 n = syn_get_foldlevel(flp->wp, lnum + 1);
3524 if (n > flp->lvl)
3525 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003526 flp->start = n - flp->lvl; // fold(s) start here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 flp->lvl = n;
3528 }
3529 }
3530#endif
3531}
3532
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003533// functions for storing the fold state in a View {{{1
3534// put_folds() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003536static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3537static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3538static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539
3540/*
3541 * Write commands to "fd" to restore the manual folds in window "wp".
3542 * Return FAIL if writing fails.
3543 */
3544 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003545put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546{
3547 if (foldmethodIsManual(wp))
3548 {
3549 if (put_line(fd, "silent! normal! zE") == FAIL
Bram Moolenaarf9547eb2021-02-01 19:24:55 +01003550 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL
3551 || put_line(fd, "let &fdl = &fdl") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 return FAIL;
3553 }
3554
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003555 // If some folds are manually opened/closed, need to restore that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003557 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559 return OK;
3560}
3561
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003562// put_folds_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563/*
3564 * Write commands to "fd" to recreate manually created folds.
3565 * Returns FAIL when writing failed.
3566 */
3567 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003568put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569{
3570 int i;
3571 fold_T *fp;
3572
3573 fp = (fold_T *)gap->ga_data;
3574 for (i = 0; i < gap->ga_len; i++)
3575 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003576 // Do nested folds first, they will be created closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3578 return FAIL;
Igor Lacerdacca5dea2025-04-17 20:41:31 +02003579 if (fprintf(fd, "sil! %ld,%ldfold", fp->fd_top + off,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 fp->fd_top + off + fp->fd_len - 1) < 0
3581 || put_eol(fd) == FAIL)
3582 return FAIL;
3583 ++fp;
3584 }
3585 return OK;
3586}
3587
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003588// put_foldopen_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589/*
3590 * Write commands to "fd" to open and close manually opened/closed folds.
3591 * Returns FAIL when writing failed.
3592 */
3593 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003594put_foldopen_recurse(
3595 FILE *fd,
3596 win_T *wp,
3597 garray_T *gap,
3598 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599{
3600 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003601 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 fold_T *fp;
3603
3604 fp = (fold_T *)gap->ga_data;
3605 for (i = 0; i < gap->ga_len; i++)
3606 {
3607 if (fp->fd_flags != FD_LEVEL)
3608 {
3609 if (fp->fd_nested.ga_len > 0)
3610 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003611 // open nested folds while this fold is open
Igor Lacerdacca5dea2025-04-17 20:41:31 +02003612 // ignore errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3614 || put_eol(fd) == FAIL
Igor Lacerdacca5dea2025-04-17 20:41:31 +02003615 || put_line(fd, "sil! normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003617 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3618 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 == FAIL)
3620 return FAIL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003621 // close the parent when needed
Bram Moolenaard25ad652012-02-29 19:20:02 +01003622 if (fp->fd_flags == FD_CLOSED)
3623 {
3624 if (put_fold_open_close(fd, fp, off) == FAIL)
3625 return FAIL;
3626 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003628 else
3629 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003630 // Open or close the leaf according to the window foldlevel.
3631 // Do not close a leaf that is already closed, as it will close
3632 // the parent.
Bram Moolenaard25ad652012-02-29 19:20:02 +01003633 level = foldLevelWin(wp, off + fp->fd_top);
3634 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3635 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3636 if (put_fold_open_close(fd, fp, off) == FAIL)
3637 return FAIL;
3638 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 }
3640 ++fp;
3641 }
3642
3643 return OK;
3644}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003645
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003646// put_fold_open_close() {{{2
Bram Moolenaard25ad652012-02-29 19:20:02 +01003647/*
3648 * Write the open or close command to "fd".
3649 * Returns FAIL when writing failed.
3650 */
3651 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003652put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003653{
3654 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3655 || put_eol(fd) == FAIL
Igor Lacerdacca5dea2025-04-17 20:41:31 +02003656 || fprintf(fd, "sil! normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003657 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3658 || put_eol(fd) == FAIL)
3659 return FAIL;
3660
3661 return OK;
3662}
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003663#endif // FEAT_SESSION
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003665// }}}1
Bram Moolenaardb022f32019-09-01 17:52:32 +02003666#endif // defined(FEAT_FOLDING) || defined(PROTO)
3667
3668#if defined(FEAT_EVAL) || defined(PROTO)
3669
3670/*
3671 * "foldclosed()" and "foldclosedend()" functions
3672 */
3673 static void
3674foldclosed_both(
3675 typval_T *argvars UNUSED,
3676 typval_T *rettv,
3677 int end UNUSED)
3678{
3679# ifdef FEAT_FOLDING
3680 linenr_T lnum;
3681 linenr_T first, last;
3682
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003683 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3684 return;
3685
Bram Moolenaardb022f32019-09-01 17:52:32 +02003686 lnum = tv_get_lnum(argvars);
3687 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3688 {
3689 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3690 {
3691 if (end)
3692 rettv->vval.v_number = (varnumber_T)last;
3693 else
3694 rettv->vval.v_number = (varnumber_T)first;
3695 return;
3696 }
3697 }
3698#endif
3699 rettv->vval.v_number = -1;
3700}
3701
3702/*
3703 * "foldclosed()" function
3704 */
3705 void
3706f_foldclosed(typval_T *argvars, typval_T *rettv)
3707{
3708 foldclosed_both(argvars, rettv, FALSE);
3709}
3710
3711/*
3712 * "foldclosedend()" function
3713 */
3714 void
3715f_foldclosedend(typval_T *argvars, typval_T *rettv)
3716{
3717 foldclosed_both(argvars, rettv, TRUE);
3718}
3719
3720/*
3721 * "foldlevel()" function
3722 */
3723 void
3724f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3725{
3726# ifdef FEAT_FOLDING
3727 linenr_T lnum;
3728
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003729 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3730 return;
3731
Bram Moolenaardb022f32019-09-01 17:52:32 +02003732 lnum = tv_get_lnum(argvars);
3733 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3734 rettv->vval.v_number = foldLevel(lnum);
3735# endif
3736}
3737
3738/*
3739 * "foldtext()" function
3740 */
3741 void
3742f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3743{
3744# ifdef FEAT_FOLDING
3745 linenr_T foldstart;
3746 linenr_T foldend;
3747 char_u *dashes;
3748 linenr_T lnum;
3749 char_u *s;
3750 char_u *r;
3751 int len;
3752 char *txt;
3753 long count;
3754# endif
3755
3756 rettv->v_type = VAR_STRING;
3757 rettv->vval.v_string = NULL;
3758# ifdef FEAT_FOLDING
3759 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3760 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3761 dashes = get_vim_var_str(VV_FOLDDASHES);
3762 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3763 && dashes != NULL)
3764 {
3765 // Find first non-empty line in the fold.
3766 for (lnum = foldstart; lnum < foldend; ++lnum)
3767 if (!linewhite(lnum))
3768 break;
3769
3770 // Find interesting text in this line.
3771 s = skipwhite(ml_get(lnum));
3772 // skip C comment-start
3773 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3774 {
3775 s = skipwhite(s + 2);
3776 if (*skipwhite(s) == NUL
3777 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3778 {
3779 s = skipwhite(ml_get(lnum + 1));
3780 if (*s == '*')
3781 s = skipwhite(s + 1);
3782 }
3783 }
3784 count = (long)(foldend - foldstart + 1);
3785 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3786 r = alloc(STRLEN(txt)
3787 + STRLEN(dashes) // for %s
3788 + 20 // for %3ld
3789 + STRLEN(s)); // concatenated
3790 if (r != NULL)
3791 {
3792 sprintf((char *)r, txt, dashes, count);
3793 len = (int)STRLEN(r);
3794 STRCAT(r, s);
3795 // remove 'foldmarker' and 'commentstring'
3796 foldtext_cleanup(r + len);
3797 rettv->vval.v_string = r;
3798 }
3799 }
3800# endif
3801}
3802
3803/*
3804 * "foldtextresult(lnum)" function
3805 */
3806 void
3807f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3808{
3809# ifdef FEAT_FOLDING
3810 linenr_T lnum;
3811 char_u *text;
3812 char_u buf[FOLD_TEXT_LEN];
3813 foldinfo_T foldinfo;
3814 int fold_count;
3815 static int entered = FALSE;
3816# endif
3817
3818 rettv->v_type = VAR_STRING;
3819 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003820
3821 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3822 return;
3823
Bram Moolenaardb022f32019-09-01 17:52:32 +02003824# ifdef FEAT_FOLDING
3825 if (entered)
3826 return; // reject recursive use
3827 entered = TRUE;
3828
3829 lnum = tv_get_lnum(argvars);
3830 // treat illegal types and illegal string values for {lnum} the same
3831 if (lnum < 0)
3832 lnum = 0;
3833 fold_count = foldedCount(curwin, lnum, &foldinfo);
3834 if (fold_count > 0)
3835 {
3836 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3837 &foldinfo, buf);
3838 if (text == buf)
3839 text = vim_strsave(text);
3840 rettv->vval.v_string = text;
3841 }
3842
3843 entered = FALSE;
3844# endif
3845}
3846
3847#endif // FEAT_EVAL