blob: f314d7a349e8d13c198261bb26aedd060590f41d [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 * vim600:fdm=marker fdl=1 fdc=3:
3 *
4 * VIM - Vi IMproved by Bram Moolenaar
5 *
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
9 */
10
11/*
12 * fold.c: code for folding
13 */
14
15#include "vim.h"
16
17#if defined(FEAT_FOLDING) || defined(PROTO)
18
Bram Moolenaar217e1b82019-12-01 21:41:28 +010019// local declarations. {{{1
20// typedef fold_T {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +000021/*
22 * The toplevel folds for each window are stored in the w_folds growarray.
23 * Each toplevel fold can contain an array of second level folds in the
24 * fd_nested growarray.
25 * The info stored in both growarrays is the same: An array of fold_T.
26 */
27typedef struct
28{
Bram Moolenaar217e1b82019-12-01 21:41:28 +010029 linenr_T fd_top; // first line of fold; for nested fold
30 // relative to parent
31 linenr_T fd_len; // number of lines in the fold
32 garray_T fd_nested; // array of nested folds
33 char fd_flags; // see below
34 char fd_small; // TRUE, FALSE or MAYBE: fold smaller than
35 // 'foldminlines'; MAYBE applies to nested
36 // folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +000037} fold_T;
38
Bram Moolenaar217e1b82019-12-01 21:41:28 +010039#define FD_OPEN 0 // fold is open (nested ones can be closed)
40#define FD_CLOSED 1 // fold is closed
41#define FD_LEVEL 2 // depends on 'foldlevel' (nested folds too)
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
Bram Moolenaar217e1b82019-12-01 21:41:28 +010043#define MAX_LEVEL 20 // maximum fold depth
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
Bram Moolenaar217e1b82019-12-01 21:41:28 +010045// static functions {{{2
Bram Moolenaard25c16e2016-01-29 22:13:30 +010046static void newFoldLevelWin(win_T *wp);
47static int checkCloseRec(garray_T *gap, linenr_T lnum, int level);
48static int foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp);
49static int foldLevelWin(win_T *wp, linenr_T lnum);
50static void checkupdate(win_T *wp);
51static void setFoldRepeat(linenr_T lnum, long count, int do_open);
52static linenr_T setManualFold(linenr_T lnum, int opening, int recurse, int *donep);
53static linenr_T setManualFoldWin(win_T *wp, linenr_T lnum, int opening, int recurse, int *donep);
54static void foldOpenNested(fold_T *fpr);
55static void deleteFoldEntry(garray_T *gap, int idx, int recursive);
56static void foldMarkAdjustRecurse(garray_T *gap, linenr_T line1, linenr_T line2, long amount, long amount_after);
57static int getDeepestNestingRecurse(garray_T *gap);
58static int check_closed(win_T *win, fold_T *fp, int *use_levelp, int level, int *maybe_smallp, linenr_T lnum_off);
59static void checkSmall(win_T *wp, fold_T *fp, linenr_T lnum_off);
60static void setSmallMaybe(garray_T *gap);
61static void foldCreateMarkers(linenr_T start, linenr_T end);
62static void foldAddMarker(linenr_T lnum, char_u *marker, int markerlen);
63static void deleteFoldMarkers(fold_T *fp, int recursive, linenr_T lnum_off);
64static void foldDelMarker(linenr_T lnum, char_u *marker, int markerlen);
65static void foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot);
66static void parseMarker(win_T *wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +000067
Bram Moolenaar071d4272004-06-13 20:20:40 +000068/*
69 * While updating the folds lines between invalid_top and invalid_bot have an
70 * undefined fold level. Only used for the window currently being updated.
71 */
72static linenr_T invalid_top = (linenr_T)0;
73static linenr_T invalid_bot = (linenr_T)0;
74
75/*
76 * When using 'foldexpr' we sometimes get the level of the next line, which
77 * calls foldlevel() to get the level of the current line, which hasn't been
78 * stored yet. To get around this chicken-egg problem the level of the
79 * previous line is stored here when available. prev_lnum is zero when the
80 * level is not available.
81 */
82static linenr_T prev_lnum = 0;
83static int prev_lnum_lvl = -1;
84
Bram Moolenaar217e1b82019-12-01 21:41:28 +010085// Flags used for "done" argument of setManualFold.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086#define DONE_NOTHING 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010087#define DONE_ACTION 1 // did close or open a fold
88#define DONE_FOLD 2 // did find a fold
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90static int foldstartmarkerlen;
91static char_u *foldendmarker;
92static int foldendmarkerlen;
93
Bram Moolenaar217e1b82019-12-01 21:41:28 +010094// Exported folding functions. {{{1
95// copyFoldingState() {{{2
Bram Moolenaar4033c552017-09-16 20:54:51 +020096
Bram Moolenaar071d4272004-06-13 20:20:40 +000097/*
98 * Copy that folding state from window "wp_from" to window "wp_to".
99 */
100 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100101copyFoldingState(win_T *wp_from, win_T *wp_to)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102{
103 wp_to->w_fold_manual = wp_from->w_fold_manual;
104 wp_to->w_foldinvalid = wp_from->w_foldinvalid;
105 cloneFoldGrowArray(&wp_from->w_folds, &wp_to->w_folds);
106}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100108// hasAnyFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109/*
110 * Return TRUE if there may be folded lines in the current window.
111 */
112 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100113hasAnyFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100115 // very simple now, but can become more complex later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116 return (win->w_p_fen
117 && (!foldmethodIsManual(win) || win->w_folds.ga_len > 0));
118}
119
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100120// hasFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121/*
122 * Return TRUE if line "lnum" in the current window is part of a closed
123 * fold.
124 * When returning TRUE, *firstp and *lastp are set to the first and last
125 * lnum of the sequence of folded lines (skipped when NULL).
126 */
127 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100128hasFolding(linenr_T lnum, linenr_T *firstp, linenr_T *lastp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129{
130 return hasFoldingWin(curwin, lnum, firstp, lastp, TRUE, NULL);
131}
132
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100133// hasFoldingWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100135hasFoldingWin(
136 win_T *win,
137 linenr_T lnum,
138 linenr_T *firstp,
139 linenr_T *lastp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100140 int cache, // when TRUE: use cached values of window
141 foldinfo_T *infop) // where to store fold info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142{
143 int had_folded = FALSE;
144 linenr_T first = 0;
145 linenr_T last = 0;
146 linenr_T lnum_rel = lnum;
147 int x;
148 fold_T *fp;
149 int level = 0;
150 int use_level = FALSE;
151 int maybe_small = FALSE;
152 garray_T *gap;
Bram Moolenaar945ec092016-06-08 21:17:43 +0200153 int low_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154
155 checkupdate(win);
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +0100156
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 /*
158 * Return quickly when there is no folding at all in this window.
159 */
160 if (!hasAnyFolding(win))
161 {
162 if (infop != NULL)
163 infop->fi_level = 0;
164 return FALSE;
165 }
166
167 if (cache)
168 {
169 /*
170 * First look in cached info for displayed lines. This is probably
171 * the fastest, but it can only be used if the entry is still valid.
172 */
173 x = find_wl_entry(win, lnum);
174 if (x >= 0)
175 {
176 first = win->w_lines[x].wl_lnum;
177 last = win->w_lines[x].wl_lastlnum;
178 had_folded = win->w_lines[x].wl_folded;
179 }
180 }
181
182 if (first == 0)
183 {
184 /*
185 * Recursively search for a fold that contains "lnum".
186 */
187 gap = &win->w_folds;
188 for (;;)
189 {
190 if (!foldFind(gap, lnum_rel, &fp))
191 break;
192
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100193 // Remember lowest level of fold that starts in "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 if (lnum_rel == fp->fd_top && low_level == 0)
195 low_level = level + 1;
196
197 first += fp->fd_top;
198 last += fp->fd_top;
199
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100200 // is this fold closed?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 had_folded = check_closed(win, fp, &use_level, level,
202 &maybe_small, lnum - lnum_rel);
203 if (had_folded)
204 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100205 // Fold closed: Set last and quit loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 last += fp->fd_len - 1;
207 break;
208 }
209
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100210 // Fold found, but it's open: Check nested folds. Line number is
211 // relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 gap = &fp->fd_nested;
213 lnum_rel -= fp->fd_top;
214 ++level;
215 }
216 }
217
218 if (!had_folded)
219 {
220 if (infop != NULL)
221 {
222 infop->fi_level = level;
223 infop->fi_lnum = lnum - lnum_rel;
224 infop->fi_low_level = low_level == 0 ? level : low_level;
225 }
226 return FALSE;
227 }
228
Bram Moolenaar05b20fb2015-04-13 20:52:36 +0200229 if (last > win->w_buffer->b_ml.ml_line_count)
230 last = win->w_buffer->b_ml.ml_line_count;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 if (lastp != NULL)
232 *lastp = last;
233 if (firstp != NULL)
234 *firstp = first;
235 if (infop != NULL)
236 {
237 infop->fi_level = level + 1;
238 infop->fi_lnum = first;
239 infop->fi_low_level = low_level == 0 ? level + 1 : low_level;
240 }
241 return TRUE;
242}
243
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100244// foldLevel() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +0200245#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246/*
247 * Return fold level at line number "lnum" in the current window.
248 */
Bram Moolenaardb022f32019-09-01 17:52:32 +0200249 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100250foldLevel(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100252 // While updating the folds lines between invalid_top and invalid_bot have
253 // an undefined fold level. Otherwise update the folds first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 if (invalid_top == (linenr_T)0)
255 checkupdate(curwin);
256 else if (lnum == prev_lnum && prev_lnum_lvl >= 0)
257 return prev_lnum_lvl;
258 else if (lnum >= invalid_top && lnum <= invalid_bot)
259 return -1;
260
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100261 // Return quickly when there is no folding at all in this window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 if (!hasAnyFolding(curwin))
263 return 0;
264
265 return foldLevelWin(curwin, lnum);
266}
Bram Moolenaardb022f32019-09-01 17:52:32 +0200267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100269// lineFolded() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270/*
271 * Low level function to check if a line is folded. Doesn't use any caching.
272 * Return TRUE if line is folded.
273 * Return FALSE if line is not folded.
274 * Return MAYBE if the line is folded when next to a folded line.
275 */
276 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100277lineFolded(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278{
279 return foldedCount(win, lnum, NULL) != 0;
280}
281
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100282// foldedCount() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283/*
284 * Count the number of lines that are folded at line number "lnum".
285 * Normally "lnum" is the first line of a possible fold, and the returned
286 * number is the number of lines in the fold.
287 * Doesn't use caching from the displayed window.
288 * Returns number of folded lines from "lnum", or 0 if line is not folded.
289 * When "infop" is not NULL, fills *infop with the fold level info.
290 */
291 long
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100292foldedCount(win_T *win, linenr_T lnum, foldinfo_T *infop)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293{
294 linenr_T last;
295
296 if (hasFoldingWin(win, lnum, NULL, &last, FALSE, infop))
297 return (long)(last - lnum + 1);
298 return 0;
299}
300
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100301// foldmethodIsManual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302/*
303 * Return TRUE if 'foldmethod' is "manual"
304 */
305 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100306foldmethodIsManual(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000308 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[3] == 'u');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309}
310
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100311// foldmethodIsIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312/*
313 * Return TRUE if 'foldmethod' is "indent"
314 */
315 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100316foldmethodIsIndent(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317{
318 return (wp->w_p_fdm[0] == 'i');
319}
320
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100321// foldmethodIsExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322/*
323 * Return TRUE if 'foldmethod' is "expr"
324 */
325 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100326foldmethodIsExpr(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000328 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[1] == 'x');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329}
330
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100331// foldmethodIsMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332/*
333 * Return TRUE if 'foldmethod' is "marker"
334 */
335 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100336foldmethodIsMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337{
Bram Moolenaarcf1e0232021-11-24 15:13:26 +0000338 return (wp->w_p_fdm[0] != NUL && wp->w_p_fdm[2] == 'r');
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339}
340
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100341// foldmethodIsSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342/*
343 * Return TRUE if 'foldmethod' is "syntax"
344 */
345 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100346foldmethodIsSyntax(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347{
348 return (wp->w_p_fdm[0] == 's');
349}
350
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100351// foldmethodIsDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352/*
353 * Return TRUE if 'foldmethod' is "diff"
354 */
355 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100356foldmethodIsDiff(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357{
358 return (wp->w_p_fdm[0] == 'd');
359}
360
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100361// closeFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362/*
363 * Close fold for current window at line "lnum".
364 * Repeat "count" times.
365 */
366 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100367closeFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368{
369 setFoldRepeat(lnum, count, FALSE);
370}
371
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100372// closeFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373/*
374 * Close fold for current window at line "lnum" recursively.
375 */
376 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100377closeFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378{
379 (void)setManualFold(lnum, FALSE, TRUE, NULL);
380}
381
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100382// opFoldRange() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383/*
384 * Open or Close folds for current window in lines "first" to "last".
385 * Used for "zo", "zO", "zc" and "zC" in Visual mode.
386 */
387 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100388opFoldRange(
389 linenr_T first,
390 linenr_T last,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100391 int opening, // TRUE to open, FALSE to close
392 int recurse, // TRUE to do it recursively
393 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100395 int done = DONE_NOTHING; // avoid error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 linenr_T lnum;
397 linenr_T lnum_next;
398
399 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
400 {
401 lnum_next = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100402 // Opening one level only: next fold to open is after the one going to
403 // be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404 if (opening && !recurse)
405 (void)hasFolding(lnum, NULL, &lnum_next);
406 (void)setManualFold(lnum, opening, recurse, &done);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100407 // Closing one level only: next line to close a fold is after just
408 // closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 if (!opening && !recurse)
410 (void)hasFolding(lnum, NULL, &lnum_next);
411 }
412 if (done == DONE_NOTHING)
Bram Moolenaarb09feaa2022-01-02 20:20:45 +0000413 emsg(_(e_no_fold_found));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100414 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 if (had_visual)
416 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417}
418
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100419// openFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
421 * Open fold for current window at line "lnum".
422 * Repeat "count" times.
423 */
424 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100425openFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426{
427 setFoldRepeat(lnum, count, TRUE);
428}
429
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100430// openFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431/*
432 * Open fold for current window at line "lnum" recursively.
433 */
434 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100435openFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436{
437 (void)setManualFold(lnum, TRUE, TRUE, NULL);
438}
439
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100440// foldOpenCursor() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441/*
442 * Open folds until the cursor line is not in a closed fold.
443 */
444 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100445foldOpenCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446{
447 int done;
448
449 checkupdate(curwin);
450 if (hasAnyFolding(curwin))
451 for (;;)
452 {
453 done = DONE_NOTHING;
454 (void)setManualFold(curwin->w_cursor.lnum, TRUE, FALSE, &done);
455 if (!(done & DONE_ACTION))
456 break;
457 }
458}
459
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100460// newFoldLevel() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461/*
462 * Set new foldlevel for current window.
463 */
464 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100465newFoldLevel(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466{
467 newFoldLevelWin(curwin);
468
469#ifdef FEAT_DIFF
470 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
471 {
472 win_T *wp;
473
474 /*
475 * Set the same foldlevel in other windows in diff mode.
476 */
477 FOR_ALL_WINDOWS(wp)
478 {
479 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
480 {
481 wp->w_p_fdl = curwin->w_p_fdl;
482 newFoldLevelWin(wp);
483 }
484 }
485 }
486#endif
487}
488
489 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100490newFoldLevelWin(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491{
492 fold_T *fp;
493 int i;
494
495 checkupdate(wp);
496 if (wp->w_fold_manual)
497 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100498 // Set all flags for the first level of folds to FD_LEVEL. Following
499 // manual open/close will then change the flags to FD_OPEN or
500 // FD_CLOSED for those folds that don't use 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 fp = (fold_T *)wp->w_folds.ga_data;
502 for (i = 0; i < wp->w_folds.ga_len; ++i)
503 fp[i].fd_flags = FD_LEVEL;
504 wp->w_fold_manual = FALSE;
505 }
506 changed_window_setting_win(wp);
507}
508
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100509// foldCheckClose() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510/*
511 * Apply 'foldlevel' to all folds that don't contain the cursor.
512 */
513 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100514foldCheckClose(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100516 if (*p_fcl != NUL) // can only be "all" right now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517 {
518 checkupdate(curwin);
519 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
520 (int)curwin->w_p_fdl))
521 changed_window_setting();
522 }
523}
524
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100525// checkCloseRec() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100527checkCloseRec(garray_T *gap, linenr_T lnum, int level)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528{
529 fold_T *fp;
530 int retval = FALSE;
531 int i;
532
533 fp = (fold_T *)gap->ga_data;
534 for (i = 0; i < gap->ga_len; ++i)
535 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100536 // Only manually opened folds may need to be closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 if (fp[i].fd_flags == FD_OPEN)
538 {
539 if (level <= 0 && (lnum < fp[i].fd_top
540 || lnum >= fp[i].fd_top + fp[i].fd_len))
541 {
542 fp[i].fd_flags = FD_LEVEL;
543 retval = TRUE;
544 }
545 else
546 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
547 level - 1);
548 }
549 }
550 return retval;
551}
552
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100553// foldCreateAllowed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554/*
555 * Return TRUE if it's allowed to manually create or delete a fold.
556 * Give an error message and return FALSE if not.
557 */
558 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100559foldManualAllowed(int create)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560{
561 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
562 return TRUE;
563 if (create)
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000564 emsg(_(e_cannot_create_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 else
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000566 emsg(_(e_cannot_delete_fold_with_current_foldmethod));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 return FALSE;
568}
569
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100570// foldCreate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571/*
572 * Create a fold from line "start" to line "end" (inclusive) in the current
573 * window.
574 */
575 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100576foldCreate(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577{
578 fold_T *fp;
579 garray_T *gap;
580 garray_T fold_ga;
581 int i, j;
582 int cont;
583 int use_level = FALSE;
584 int closed = FALSE;
585 int level = 0;
586 linenr_T start_rel = start;
587 linenr_T end_rel = end;
588
589 if (start > end)
590 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100591 // reverse the range
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 end = start_rel;
593 start = end_rel;
594 start_rel = start;
595 end_rel = end;
596 }
597
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100598 // When 'foldmethod' is "marker" add markers, which creates the folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599 if (foldmethodIsMarker(curwin))
600 {
601 foldCreateMarkers(start, end);
602 return;
603 }
604
605 checkupdate(curwin);
606
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100607 // Find the place to insert the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 gap = &curwin->w_folds;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200609 if (gap->ga_len == 0)
610 i = 0;
611 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200613 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200615 if (!foldFind(gap, start_rel, &fp))
616 break;
617 if (fp->fd_top + fp->fd_len > end_rel)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618 {
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200619 // New fold is completely inside this fold: Go one level
620 // deeper.
621 gap = &fp->fd_nested;
622 start_rel -= fp->fd_top;
623 end_rel -= fp->fd_top;
624 if (use_level || fp->fd_flags == FD_LEVEL)
625 {
626 use_level = TRUE;
627 if (level >= curwin->w_p_fdl)
628 closed = TRUE;
629 }
630 else if (fp->fd_flags == FD_CLOSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 closed = TRUE;
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200632 ++level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 }
Bram Moolenaar2c93c682020-08-31 21:15:02 +0200634 else
635 {
636 // This fold and new fold overlap: Insert here and move some
637 // folds inside the new fold.
638 break;
639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 }
Bram Moolenaar5e1f22f2020-11-10 18:23:52 +0100641 if (gap->ga_len == 0)
642 i = 0;
643 else
644 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 }
646
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 if (ga_grow(gap, 1) == OK)
648 {
649 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000650 ga_init2(&fold_ga, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100652 // Count number of folds that will be contained in the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 for (cont = 0; i + cont < gap->ga_len; ++cont)
654 if (fp[cont].fd_top > end_rel)
655 break;
656 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
657 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100658 // If the first fold starts before the new fold, let the new fold
659 // start there. Otherwise the existing fold would change.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 if (start_rel > fp->fd_top)
661 start_rel = fp->fd_top;
662
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100663 // When last contained fold isn't completely contained, adjust end
664 // of new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
666 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100667 // Move contained folds to inside new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
669 fold_ga.ga_len += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 i += cont;
671
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100672 // Adjust line numbers in contained folds to be relative to the
673 // new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 for (j = 0; j < cont; ++j)
675 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
676 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100677 // Move remaining entries to after the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 if (i < gap->ga_len)
679 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
680 sizeof(fold_T) * (gap->ga_len - i));
681 gap->ga_len = gap->ga_len + 1 - cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100683 // insert new fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 fp->fd_nested = fold_ga;
685 fp->fd_top = start_rel;
686 fp->fd_len = end_rel - start_rel + 1;
687
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100688 // We want the new fold to be closed. If it would remain open because
689 // of using 'foldlevel', need to adjust fd_flags of containing folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 if (use_level && !closed && level < curwin->w_p_fdl)
691 closeFold(start, 1L);
692 if (!use_level)
693 curwin->w_fold_manual = TRUE;
694 fp->fd_flags = FD_CLOSED;
695 fp->fd_small = MAYBE;
696
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100697 // redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 changed_window_setting();
699 }
700}
701
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100702// deleteFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703/*
704 * Delete a fold at line "start" in the current window.
705 * When "end" is not 0, delete all folds from "start" to "end".
706 * When "recursive" is TRUE delete recursively.
707 */
708 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100709deleteFold(
710 linenr_T start,
711 linenr_T end,
712 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100713 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714{
715 garray_T *gap;
716 fold_T *fp;
717 garray_T *found_ga;
718 fold_T *found_fp = NULL;
719 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000720 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 int maybe_small = FALSE;
722 int level = 0;
723 linenr_T lnum = start;
724 linenr_T lnum_off;
725 int did_one = FALSE;
726 linenr_T first_lnum = MAXLNUM;
727 linenr_T last_lnum = 0;
728
729 checkupdate(curwin);
730
731 while (lnum <= end)
732 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100733 // Find the deepest fold for "start".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 gap = &curwin->w_folds;
735 found_ga = NULL;
736 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000737 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 for (;;)
739 {
740 if (!foldFind(gap, lnum - lnum_off, &fp))
741 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100742 // lnum is inside this fold, remember info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 found_ga = gap;
744 found_fp = fp;
745 found_off = lnum_off;
746
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100747 // if "lnum" is folded, don't check nesting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 if (check_closed(curwin, fp, &use_level, level,
749 &maybe_small, lnum_off))
750 break;
751
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100752 // check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 gap = &fp->fd_nested;
754 lnum_off += fp->fd_top;
755 ++level;
756 }
757 if (found_ga == NULL)
758 {
759 ++lnum;
760 }
761 else
762 {
763 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764
765 if (foldmethodIsManual(curwin))
766 deleteFoldEntry(found_ga,
767 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
768 else
769 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000770 if (first_lnum > found_fp->fd_top + found_off)
771 first_lnum = found_fp->fd_top + found_off;
772 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000774 if (!did_one)
775 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 deleteFoldMarkers(found_fp, recursive, found_off);
777 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000778 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // redraw window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 changed_window_setting();
782 }
783 }
784 if (!did_one)
785 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +0000786 emsg(_(e_no_fold_found));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100787 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 if (had_visual)
789 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000791 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100792 // Deleting markers may make cursor column invalid.
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000793 check_cursor_col();
794
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795 if (last_lnum > 0)
796 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
797}
798
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100799// clearFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800/*
801 * Remove all folding for window "win".
802 */
803 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100804clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805{
806 deleteFoldRecurse(&win->w_folds);
807 win->w_foldinvalid = FALSE;
808}
809
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100810// foldUpdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811/*
812 * Update folds for changes in the buffer of a window.
813 * Note that inserted/deleted lines must have already been taken care of by
814 * calling foldMarkAdjust().
815 * The changes in lines from top to bot (inclusive).
816 */
817 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100818foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819{
820 fold_T *fp;
821
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200822 if (disable_fold_update > 0)
823 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200824#ifdef FEAT_DIFF
825 if (need_diff_redraw)
826 // will update later
827 return;
828#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200829
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200830 if (wp->w_folds.ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 {
Bram Moolenaar64f37d32020-08-31 19:58:13 +0200832 // Mark all folds from top to bot as maybe-small.
833 (void)foldFind(&wp->w_folds, top, &fp);
834 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
835 && fp->fd_top < bot)
836 {
837 fp->fd_small = MAYBE;
838 ++fp;
839 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 }
841
842 if (foldmethodIsIndent(wp)
843 || foldmethodIsExpr(wp)
844 || foldmethodIsMarker(wp)
845#ifdef FEAT_DIFF
846 || foldmethodIsDiff(wp)
847#endif
848 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000849 {
850 int save_got_int = got_int;
851
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100852 // reset got_int here, otherwise it won't work
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000853 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000855 got_int |= save_got_int;
856 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857}
858
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100859// foldUpdateAll() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860/*
861 * Update all lines in a window for folding.
862 * Used when a fold setting changes or after reloading the buffer.
863 * The actual updating is postponed until fold info is used, to avoid doing
864 * every time a setting is changed or a syntax item is added.
865 */
866 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100867foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868{
869 win->w_foldinvalid = TRUE;
870 redraw_win_later(win, NOT_VALID);
871}
872
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100873// foldMoveTo() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874/*
875 * If "updown" is FALSE: Move to the start or end of the fold.
876 * If "updown" is TRUE: move to fold at the same level.
877 * If not moved return FAIL.
878 */
879 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100880foldMoveTo(
881 int updown,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100882 int dir, // FORWARD or BACKWARD
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100883 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884{
885 long n;
886 int retval = FAIL;
887 linenr_T lnum_off;
888 linenr_T lnum_found;
889 linenr_T lnum;
890 int use_level;
891 int maybe_small;
892 garray_T *gap;
893 fold_T *fp;
894 int level;
895 int last;
896
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000897 checkupdate(curwin);
898
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100899 // Repeat "count" times.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 for (n = 0; n < count; ++n)
901 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100902 // Find nested folds. Stop when a fold is closed. The deepest fold
903 // that moves the cursor is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 lnum_off = 0;
905 gap = &curwin->w_folds;
Bram Moolenaarc136a352020-11-03 20:05:40 +0100906 if (gap->ga_len == 0)
907 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 use_level = FALSE;
909 maybe_small = FALSE;
910 lnum_found = curwin->w_cursor.lnum;
911 level = 0;
912 last = FALSE;
913 for (;;)
914 {
915 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
916 {
Bram Moolenaar6a78f322020-12-21 14:01:41 +0100917 if (!updown || gap->ga_len == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918 break;
919
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100920 // When moving up, consider a fold above the cursor; when
921 // moving down consider a fold below the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 if (dir == FORWARD)
923 {
924 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
925 break;
926 --fp;
927 }
928 else
929 {
930 if (fp == (fold_T *)gap->ga_data)
931 break;
932 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100933 // don't look for contained folds, they will always move
934 // the cursor too far.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 last = TRUE;
936 }
937
938 if (!last)
939 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100940 // Check if this fold is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 if (check_closed(curwin, fp, &use_level, level,
942 &maybe_small, lnum_off))
943 last = TRUE;
944
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100945 // "[z" and "]z" stop at closed fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946 if (last && !updown)
947 break;
948 }
949
950 if (updown)
951 {
952 if (dir == FORWARD)
953 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100954 // to start of next fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
956 {
957 lnum = fp[1].fd_top + lnum_off;
958 if (lnum > curwin->w_cursor.lnum)
959 lnum_found = lnum;
960 }
961 }
962 else
963 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100964 // to end of previous fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 if (fp > (fold_T *)gap->ga_data)
966 {
967 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
968 if (lnum < curwin->w_cursor.lnum)
969 lnum_found = lnum;
970 }
971 }
972 }
973 else
974 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100975 // Open fold found, set cursor to its start/end and then check
976 // nested folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 if (dir == FORWARD)
978 {
979 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
980 if (lnum > curwin->w_cursor.lnum)
981 lnum_found = lnum;
982 }
983 else
984 {
985 lnum = fp->fd_top + lnum_off;
986 if (lnum < curwin->w_cursor.lnum)
987 lnum_found = lnum;
988 }
989 }
990
991 if (last)
992 break;
993
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100994 // Check nested folds (if any).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 gap = &fp->fd_nested;
996 lnum_off += fp->fd_top;
997 ++level;
998 }
999 if (lnum_found != curwin->w_cursor.lnum)
1000 {
1001 if (retval == FAIL)
1002 setpcmark();
1003 curwin->w_cursor.lnum = lnum_found;
1004 curwin->w_cursor.col = 0;
1005 retval = OK;
1006 }
1007 else
1008 break;
1009 }
1010
1011 return retval;
1012}
1013
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001014// foldInitWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015/*
1016 * Init the fold info in a new window.
1017 */
1018 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001019foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001021 ga_init2(&new_win->w_folds, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022}
1023
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001024// find_wl_entry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025/*
1026 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1027 * Only valid entries are considered (for entries where wl_valid is FALSE the
1028 * line number can be wrong).
1029 * Returns index of entry or -1 if not found.
1030 */
1031 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001032find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033{
1034 int i;
1035
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001036 for (i = 0; i < win->w_lines_valid; ++i)
1037 if (win->w_lines[i].wl_valid)
1038 {
1039 if (lnum < win->w_lines[i].wl_lnum)
1040 return -1;
1041 if (lnum <= win->w_lines[i].wl_lastlnum)
1042 return i;
1043 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 return -1;
1045}
1046
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001047// foldAdjustVisual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048/*
1049 * Adjust the Visual area to include any fold at the start or end completely.
1050 */
1051 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001052foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053{
1054 pos_T *start, *end;
1055 char_u *ptr;
1056
1057 if (!VIsual_active || !hasAnyFolding(curwin))
1058 return;
1059
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01001060 if (LTOREQ_POS(VIsual, curwin->w_cursor))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 {
1062 start = &VIsual;
1063 end = &curwin->w_cursor;
1064 }
1065 else
1066 {
1067 start = &curwin->w_cursor;
1068 end = &VIsual;
1069 }
1070 if (hasFolding(start->lnum, &start->lnum, NULL))
1071 start->col = 0;
1072 if (hasFolding(end->lnum, NULL, &end->lnum))
1073 {
1074 ptr = ml_get(end->lnum);
1075 end->col = (colnr_T)STRLEN(ptr);
1076 if (end->col > 0 && *p_sel == 'o')
1077 --end->col;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001078 // prevent cursor from moving on the trail byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 if (has_mbyte)
1080 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 }
1082}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001084// cursor_foldstart() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085/*
1086 * Move the cursor to the first line of a closed fold.
1087 */
1088 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001089foldAdjustCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090{
1091 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1092}
1093
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001094// Internal functions for "fold_T" {{{1
1095// cloneFoldGrowArray() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096/*
1097 * Will "clone" (i.e deep copy) a garray_T of folds.
1098 *
1099 * Return FAIL if the operation cannot be completed, otherwise OK.
1100 */
1101 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001102cloneFoldGrowArray(garray_T *from, garray_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103{
1104 int i;
1105 fold_T *from_p;
1106 fold_T *to_p;
1107
1108 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1109 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1110 return;
1111
1112 from_p = (fold_T *)from->ga_data;
1113 to_p = (fold_T *)to->ga_data;
1114
1115 for (i = 0; i < from->ga_len; i++)
1116 {
1117 to_p->fd_top = from_p->fd_top;
1118 to_p->fd_len = from_p->fd_len;
1119 to_p->fd_flags = from_p->fd_flags;
1120 to_p->fd_small = from_p->fd_small;
1121 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1122 ++to->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 ++from_p;
1124 ++to_p;
1125 }
1126}
1127
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001128// foldFind() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129/*
1130 * Search for line "lnum" in folds of growarray "gap".
1131 * Set *fpp to the fold struct for the fold that contains "lnum" or
1132 * the first fold below it (careful: it can be beyond the end of the array!).
1133 * Returns FALSE when there is no fold that contains "lnum".
1134 */
1135 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001136foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137{
1138 linenr_T low, high;
1139 fold_T *fp;
1140 int i;
1141
Bram Moolenaar64f37d32020-08-31 19:58:13 +02001142 if (gap->ga_len == 0)
1143 {
1144 *fpp = NULL;
1145 return FALSE;
1146 }
1147
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 /*
1149 * Perform a binary search.
1150 * "low" is lowest index of possible match.
1151 * "high" is highest index of possible match.
1152 */
1153 fp = (fold_T *)gap->ga_data;
1154 low = 0;
1155 high = gap->ga_len - 1;
1156 while (low <= high)
1157 {
1158 i = (low + high) / 2;
1159 if (fp[i].fd_top > lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001160 // fold below lnum, adjust high
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 high = i - 1;
1162 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001163 // fold above lnum, adjust low
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 low = i + 1;
1165 else
1166 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001167 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 *fpp = fp + i;
1169 return TRUE;
1170 }
1171 }
1172 *fpp = fp + low;
1173 return FALSE;
1174}
1175
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001176// foldLevelWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177/*
1178 * Return fold level at line number "lnum" in window "wp".
1179 */
1180 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001181foldLevelWin(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182{
1183 fold_T *fp;
1184 linenr_T lnum_rel = lnum;
1185 int level = 0;
1186 garray_T *gap;
1187
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001188 // Recursively search for a fold that contains "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 gap = &wp->w_folds;
1190 for (;;)
1191 {
1192 if (!foldFind(gap, lnum_rel, &fp))
1193 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001194 // Check nested folds. Line number is relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 gap = &fp->fd_nested;
1196 lnum_rel -= fp->fd_top;
1197 ++level;
1198 }
1199
1200 return level;
1201}
1202
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001203// checkupdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204/*
1205 * Check if the folds in window "wp" are invalid and update them if needed.
1206 */
1207 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001208checkupdate(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209{
1210 if (wp->w_foldinvalid)
1211 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001212 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); // will update all
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 wp->w_foldinvalid = FALSE;
1214 }
1215}
1216
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001217// setFoldRepeat() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218/*
1219 * Open or close fold for current window at line "lnum".
1220 * Repeat "count" times.
1221 */
1222 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001223setFoldRepeat(linenr_T lnum, long count, int do_open)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224{
1225 int done;
1226 long n;
1227
1228 for (n = 0; n < count; ++n)
1229 {
1230 done = DONE_NOTHING;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001231 (void)setManualFold(lnum, do_open, FALSE, &done);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 if (!(done & DONE_ACTION))
1233 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001234 // Only give an error message when no fold could be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 if (n == 0 && !(done & DONE_FOLD))
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001236 emsg(_(e_no_fold_found));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 break;
1238 }
1239 }
1240}
1241
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001242// setManualFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243/*
1244 * Open or close the fold in the current window which contains "lnum".
1245 * Also does this for other windows in diff mode when needed.
1246 */
1247 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001248setManualFold(
1249 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001250 int opening, // TRUE when opening, FALSE when closing
1251 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001252 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253{
1254#ifdef FEAT_DIFF
1255 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1256 {
1257 win_T *wp;
1258 linenr_T dlnum;
1259
1260 /*
1261 * Do the same operation in other windows in diff mode. Calculate the
1262 * line number from the diffs.
1263 */
1264 FOR_ALL_WINDOWS(wp)
1265 {
1266 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1267 {
1268 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1269 if (dlnum != 0)
1270 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1271 }
1272 }
1273 }
1274#endif
1275
1276 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1277}
1278
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001279// setManualFoldWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280/*
1281 * Open or close the fold in window "wp" which contains "lnum".
1282 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1283 * fold was found and to DONE_ACTION when some fold was opened or closed.
1284 * When "donep" is NULL give an error message when no fold was found for
1285 * "lnum", but only if "wp" is "curwin".
1286 * Return the line number of the next line that could be closed.
1287 * It's only valid when "opening" is TRUE!
1288 */
1289 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001290setManualFoldWin(
1291 win_T *wp,
1292 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001293 int opening, // TRUE when opening, FALSE when closing
1294 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001295 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296{
1297 fold_T *fp;
1298 fold_T *fp2;
1299 fold_T *found = NULL;
1300 int j;
1301 int level = 0;
1302 int use_level = FALSE;
1303 int found_fold = FALSE;
1304 garray_T *gap;
1305 linenr_T next = MAXLNUM;
1306 linenr_T off = 0;
1307 int done = 0;
1308
1309 checkupdate(wp);
1310
1311 /*
1312 * Find the fold, open or close it.
1313 */
1314 gap = &wp->w_folds;
1315 for (;;)
1316 {
1317 if (!foldFind(gap, lnum, &fp))
1318 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001319 // If there is a following fold, continue there next time.
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02001320 if (fp != NULL && fp < (fold_T *)gap->ga_data + gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 next = fp->fd_top + off;
1322 break;
1323 }
1324
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001325 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 found_fold = TRUE;
1327
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001328 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1330 next = fp[1].fd_top + off;
1331
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001332 // Change from level-dependent folding to manual.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 if (use_level || fp->fd_flags == FD_LEVEL)
1334 {
1335 use_level = TRUE;
1336 if (level >= wp->w_p_fdl)
1337 fp->fd_flags = FD_CLOSED;
1338 else
1339 fp->fd_flags = FD_OPEN;
1340 fp2 = (fold_T *)fp->fd_nested.ga_data;
1341 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1342 fp2[j].fd_flags = FD_LEVEL;
1343 }
1344
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001345 // Simple case: Close recursively means closing the fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 if (!opening && recurse)
1347 {
1348 if (fp->fd_flags != FD_CLOSED)
1349 {
1350 done |= DONE_ACTION;
1351 fp->fd_flags = FD_CLOSED;
1352 }
1353 }
1354 else if (fp->fd_flags == FD_CLOSED)
1355 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001356 // When opening, open topmost closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 if (opening)
1358 {
1359 fp->fd_flags = FD_OPEN;
1360 done |= DONE_ACTION;
1361 if (recurse)
1362 foldOpenNested(fp);
1363 }
1364 break;
1365 }
1366
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001367 // fold is open, check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 found = fp;
1369 gap = &fp->fd_nested;
1370 lnum -= fp->fd_top;
1371 off += fp->fd_top;
1372 ++level;
1373 }
1374 if (found_fold)
1375 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001376 // When closing and not recurse, close deepest open fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 if (!opening && found != NULL)
1378 {
1379 found->fd_flags = FD_CLOSED;
1380 done |= DONE_ACTION;
1381 }
1382 wp->w_fold_manual = TRUE;
1383 if (done & DONE_ACTION)
1384 changed_window_setting_win(wp);
1385 done |= DONE_FOLD;
1386 }
1387 else if (donep == NULL && wp == curwin)
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001388 emsg(_(e_no_fold_found));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389
1390 if (donep != NULL)
1391 *donep |= done;
1392
1393 return next;
1394}
1395
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001396// foldOpenNested() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397/*
1398 * Open all nested folds in fold "fpr" recursively.
1399 */
1400 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001401foldOpenNested(fold_T *fpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402{
1403 int i;
1404 fold_T *fp;
1405
1406 fp = (fold_T *)fpr->fd_nested.ga_data;
1407 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1408 {
1409 foldOpenNested(&fp[i]);
1410 fp[i].fd_flags = FD_OPEN;
1411 }
1412}
1413
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001414// deleteFoldEntry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415/*
1416 * Delete fold "idx" from growarray "gap".
1417 * When "recursive" is TRUE also delete all the folds contained in it.
1418 * When "recursive" is FALSE contained folds are moved one level up.
1419 */
1420 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001421deleteFoldEntry(garray_T *gap, int idx, int recursive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422{
1423 fold_T *fp;
1424 int i;
1425 long moved;
1426 fold_T *nfp;
1427
1428 fp = (fold_T *)gap->ga_data + idx;
1429 if (recursive || fp->fd_nested.ga_len == 0)
1430 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001431 // recursively delete the contained folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 deleteFoldRecurse(&fp->fd_nested);
1433 --gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 if (idx < gap->ga_len)
1435 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1436 }
1437 else
1438 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001439 // Move nested folds one level up, to overwrite the fold that is
1440 // deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 moved = fp->fd_nested.ga_len;
1442 if (ga_grow(gap, (int)(moved - 1)) == OK)
1443 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001444 // Get "fp" again, the array may have been reallocated.
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001445 fp = (fold_T *)gap->ga_data + idx;
1446
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001447 // adjust fd_top and fd_flags for the moved folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 nfp = (fold_T *)fp->fd_nested.ga_data;
1449 for (i = 0; i < moved; ++i)
1450 {
1451 nfp[i].fd_top += fp->fd_top;
1452 if (fp->fd_flags == FD_LEVEL)
1453 nfp[i].fd_flags = FD_LEVEL;
1454 if (fp->fd_small == MAYBE)
1455 nfp[i].fd_small = MAYBE;
1456 }
1457
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001458 // move the existing folds down to make room
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001459 if (idx + 1 < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 mch_memmove(fp + moved, fp + 1,
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001461 sizeof(fold_T) * (gap->ga_len - (idx + 1)));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001462 // move the contained folds one level up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1464 vim_free(nfp);
1465 gap->ga_len += moved - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 }
1467 }
1468}
1469
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001470// deleteFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471/*
1472 * Delete nested folds in a fold.
1473 */
1474 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001475deleteFoldRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476{
1477 int i;
1478
1479 for (i = 0; i < gap->ga_len; ++i)
1480 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1481 ga_clear(gap);
1482}
1483
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001484// foldMarkAdjust() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485/*
1486 * Update line numbers of folds for inserted/deleted lines.
1487 */
1488 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001489foldMarkAdjust(
1490 win_T *wp,
1491 linenr_T line1,
1492 linenr_T line2,
1493 long amount,
1494 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001496 // If deleting marks from line1 to line2, but not deleting all those
1497 // lines, set line2 so that only deleted lines have their folds removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1499 line2 = line1 - amount_after - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001500 // If appending a line in Insert mode, it should be included in the fold
1501 // just above the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1503 --line1;
1504 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1505}
1506
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001507// foldMarkAdjustRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001509foldMarkAdjustRecurse(
1510 garray_T *gap,
1511 linenr_T line1,
1512 linenr_T line2,
1513 long amount,
1514 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515{
1516 fold_T *fp;
1517 int i;
1518 linenr_T last;
1519 linenr_T top;
1520
Bram Moolenaar07e87e92020-08-31 21:22:40 +02001521 if (gap->ga_len == 0)
1522 return;
1523
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001524 // In Insert mode an inserted line at the top of a fold is considered part
1525 // of the fold, otherwise it isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1527 top = line1 + 1;
1528 else
1529 top = line1;
1530
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001531 // Find the fold containing or just below "line1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 (void)foldFind(gap, line1, &fp);
1533
1534 /*
1535 * Adjust all folds below "line1" that are affected.
1536 */
1537 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1538 {
1539 /*
1540 * Check for these situations:
1541 * 1 2 3
1542 * 1 2 3
1543 * line1 2 3 4 5
1544 * 2 3 4 5
1545 * 2 3 4 5
1546 * line2 2 3 4 5
1547 * 3 5 6
1548 * 3 5 6
1549 */
1550
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001551 last = fp->fd_top + fp->fd_len - 1; // last line of fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001553 // 1. fold completely above line1: nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 if (last < line1)
1555 continue;
1556
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001557 // 6. fold below line2: only adjust for amount_after
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 if (fp->fd_top > line2)
1559 {
1560 if (amount_after == 0)
1561 break;
1562 fp->fd_top += amount_after;
1563 }
1564 else
1565 {
1566 if (fp->fd_top >= top && last <= line2)
1567 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001568 // 4. fold completely contained in range
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 if (amount == MAXLNUM)
1570 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001571 // Deleting lines: delete the fold completely
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 deleteFoldEntry(gap, i, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001573 --i; // adjust index for deletion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 --fp;
1575 }
1576 else
1577 fp->fd_top += amount;
1578 }
1579 else
1580 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 if (fp->fd_top < top)
1582 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001583 // 2 or 3: need to correct nested folds too
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001584 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1585 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 if (last <= line2)
1587 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001588 // 2. fold contains line1, line2 is below fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 if (amount == MAXLNUM)
1590 fp->fd_len = line1 - fp->fd_top;
1591 else
1592 fp->fd_len += amount;
1593 }
1594 else
1595 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001596 // 3. fold contains line1 and line2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 fp->fd_len += amount_after;
1598 }
1599 }
1600 else
1601 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001602 // 5. fold is below line1 and contains line2; need to
1603 // correct nested folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 if (amount == MAXLNUM)
1605 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001606 foldMarkAdjustRecurse(&fp->fd_nested,
1607 line1 - fp->fd_top,
1608 line2 - fp->fd_top,
1609 amount,
1610 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 fp->fd_len -= line2 - fp->fd_top + 1;
1612 fp->fd_top = line1;
1613 }
1614 else
1615 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001616 foldMarkAdjustRecurse(&fp->fd_nested,
1617 line1 - fp->fd_top,
1618 line2 - fp->fd_top,
1619 amount,
1620 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 fp->fd_len += amount_after - amount;
1622 fp->fd_top += amount;
1623 }
1624 }
1625 }
1626 }
1627 }
1628}
1629
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001630// getDeepestNesting() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631/*
1632 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1633 * current window open.
1634 */
1635 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001636getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637{
1638 checkupdate(curwin);
1639 return getDeepestNestingRecurse(&curwin->w_folds);
1640}
1641
1642 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001643getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644{
1645 int i;
1646 int level;
1647 int maxlevel = 0;
1648 fold_T *fp;
1649
1650 fp = (fold_T *)gap->ga_data;
1651 for (i = 0; i < gap->ga_len; ++i)
1652 {
1653 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1654 if (level > maxlevel)
1655 maxlevel = level;
1656 }
1657
1658 return maxlevel;
1659}
1660
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001661// check_closed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662/*
1663 * Check if a fold is closed and update the info needed to check nested folds.
1664 */
1665 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001666check_closed(
1667 win_T *win,
1668 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001669 int *use_levelp, // TRUE: outer fold had FD_LEVEL
1670 int level, // folding depth
1671 int *maybe_smallp, // TRUE: outer this had fd_small == MAYBE
1672 linenr_T lnum_off) // line number offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673{
1674 int closed = FALSE;
1675
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001676 // Check if this fold is closed. If the flag is FD_LEVEL this
1677 // fold and all folds it contains depend on 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1679 {
1680 *use_levelp = TRUE;
1681 if (level >= win->w_p_fdl)
1682 closed = TRUE;
1683 }
1684 else if (fp->fd_flags == FD_CLOSED)
1685 closed = TRUE;
1686
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001687 // Small fold isn't closed anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 if (fp->fd_small == MAYBE)
1689 *maybe_smallp = TRUE;
1690 if (closed)
1691 {
1692 if (*maybe_smallp)
1693 fp->fd_small = MAYBE;
1694 checkSmall(win, fp, lnum_off);
1695 if (fp->fd_small == TRUE)
1696 closed = FALSE;
1697 }
1698 return closed;
1699}
1700
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001701// checkSmall() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702/*
1703 * Update fd_small field of fold "fp".
1704 */
1705 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001706checkSmall(
1707 win_T *wp,
1708 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001709 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710{
1711 int count;
1712 int n;
1713
1714 if (fp->fd_small == MAYBE)
1715 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001716 // Mark any nested folds to maybe-small
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 setSmallMaybe(&fp->fd_nested);
1718
1719 if (fp->fd_len > curwin->w_p_fml)
1720 fp->fd_small = FALSE;
1721 else
1722 {
1723 count = 0;
1724 for (n = 0; n < fp->fd_len; ++n)
1725 {
1726 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1727 if (count > curwin->w_p_fml)
1728 {
1729 fp->fd_small = FALSE;
1730 return;
1731 }
1732 }
1733 fp->fd_small = TRUE;
1734 }
1735 }
1736}
1737
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001738// setSmallMaybe() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739/*
1740 * Set small flags in "gap" to MAYBE.
1741 */
1742 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001743setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744{
1745 int i;
1746 fold_T *fp;
1747
1748 fp = (fold_T *)gap->ga_data;
1749 for (i = 0; i < gap->ga_len; ++i)
1750 fp[i].fd_small = MAYBE;
1751}
1752
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001753// foldCreateMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754/*
1755 * Create a fold from line "start" to line "end" (inclusive) in the current
1756 * window by adding markers.
1757 */
1758 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001759foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760{
1761 if (!curbuf->b_p_ma)
1762 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001763 emsg(_(e_cannot_make_changes_modifiable_is_off));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 return;
1765 }
1766 parseMarker(curwin);
1767
1768 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1769 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1770
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001771 // Update both changes here, to avoid all folds after the start are
1772 // changed when the start marker is inserted and the end isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 changed_lines(start, (colnr_T)0, end, 0L);
1774}
1775
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001776// foldAddMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777/*
1778 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1779 */
1780 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001781foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782{
1783 char_u *cms = curbuf->b_p_cms;
1784 char_u *line;
1785 int line_len;
1786 char_u *newline;
1787 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001788 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001790 // Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 line = ml_get(lnum);
1792 line_len = (int)STRLEN(line);
1793
1794 if (u_save(lnum - 1, lnum + 1) == OK)
1795 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001796 // Check if the line ends with an unclosed comment
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001797 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
Bram Moolenaar964b3742019-05-24 18:54:09 +02001798 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 if (newline == NULL)
1800 return;
1801 STRCPY(newline, line);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001802 // Append the marker to the end of the line
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001803 if (p == NULL || line_is_comment)
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001804 vim_strncpy(newline + line_len, marker, markerlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 else
1806 {
1807 STRCPY(newline + line_len, cms);
1808 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1809 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1810 }
1811
1812 ml_replace(lnum, newline, FALSE);
1813 }
1814}
1815
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001816// deleteFoldMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817/*
1818 * Delete the markers for a fold, causing it to be deleted.
1819 */
1820 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001821deleteFoldMarkers(
1822 fold_T *fp,
1823 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001824 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825{
1826 int i;
1827
1828 if (recursive)
1829 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1830 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1831 lnum_off + fp->fd_top);
1832 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1833 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1834 foldendmarker, foldendmarkerlen);
1835}
1836
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001837// foldDelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838/*
1839 * Delete marker "marker[markerlen]" at the end of line "lnum".
1840 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001841 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 * close-marker.
1843 */
1844 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001845foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846{
1847 char_u *line;
1848 char_u *newline;
1849 char_u *p;
1850 int len;
1851 char_u *cms = curbuf->b_p_cms;
1852 char_u *cms2;
1853
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001854 // end marker may be missing and fold extends below the last line
1855 if (lnum > curbuf->b_ml.ml_line_count)
1856 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 line = ml_get(lnum);
1858 for (p = line; *p != NUL; ++p)
1859 if (STRNCMP(p, marker, markerlen) == 0)
1860 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001861 // Found the marker, include a digit if it's there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 len = markerlen;
1863 if (VIM_ISDIGIT(p[len]))
1864 ++len;
1865 if (*cms != NUL)
1866 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001867 // Also delete 'commentstring' if it matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 cms2 = (char_u *)strstr((char *)cms, "%s");
1869 if (p - line >= cms2 - cms
1870 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1871 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1872 {
1873 p -= cms2 - cms;
1874 len += (int)STRLEN(cms) - 2;
1875 }
1876 }
1877 if (u_save(lnum - 1, lnum + 1) == OK)
1878 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001879 // Make new line: text-before-marker + text-after-marker
Bram Moolenaar964b3742019-05-24 18:54:09 +02001880 newline = alloc(STRLEN(line) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 if (newline != NULL)
1882 {
1883 STRNCPY(newline, line, p - line);
1884 STRCPY(newline + (p - line), p + len);
1885 ml_replace(lnum, newline, FALSE);
1886 }
1887 }
1888 break;
1889 }
1890}
1891
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001892// get_foldtext() {{{2
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001893/*
1894 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001895 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1896 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001897 */
1898 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001899get_foldtext(
1900 win_T *wp,
1901 linenr_T lnum,
1902 linenr_T lnume,
1903 foldinfo_T *foldinfo,
1904 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001905{
1906 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001907#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001908 // an error occurred when evaluating 'fdt' setting
Bram Moolenaardab38d52013-06-15 17:06:36 +02001909 static int got_fdt_error = FALSE;
1910 int save_did_emsg = did_emsg;
1911 static win_T *last_wp = NULL;
1912 static linenr_T last_lnum = 0;
1913
1914 if (last_wp != wp || last_wp == NULL
1915 || last_lnum > lnum || last_lnum == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001916 // window changed, try evaluating foldtext setting once again
Bram Moolenaardab38d52013-06-15 17:06:36 +02001917 got_fdt_error = FALSE;
1918
1919 if (!got_fdt_error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001920 // a previous error should not abort evaluating 'foldexpr'
Bram Moolenaardab38d52013-06-15 17:06:36 +02001921 did_emsg = FALSE;
1922
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001923 if (*wp->w_p_fdt != NUL)
1924 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001925 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001926 win_T *save_curwin;
1927 int level;
1928 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001929
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001930 // Set "v:foldstart" and "v:foldend".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001931 set_vim_var_nr(VV_FOLDSTART, lnum);
1932 set_vim_var_nr(VV_FOLDEND, lnume);
1933
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001934 // Set "v:folddashes" to a string of "level" dashes.
1935 // Set "v:foldlevel" to "level".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001936 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001937 if (level > (int)sizeof(dashes) - 1)
1938 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001939 vim_memset(dashes, '-', (size_t)level);
1940 dashes[level] = NUL;
1941 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1942 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001943
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001944 // skip evaluating foldtext on errors
Bram Moolenaardab38d52013-06-15 17:06:36 +02001945 if (!got_fdt_error)
1946 {
1947 save_curwin = curwin;
1948 curwin = wp;
1949 curbuf = wp->w_buffer;
1950
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001951 ++emsg_silent; // handle exceptions, but don't display errors
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001952 text = eval_to_string_safe(wp->w_p_fdt,
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001953 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
Bram Moolenaardab38d52013-06-15 17:06:36 +02001954 --emsg_silent;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001955
Bram Moolenaardab38d52013-06-15 17:06:36 +02001956 if (text == NULL || did_emsg)
1957 got_fdt_error = TRUE;
1958
1959 curwin = save_curwin;
1960 curbuf = curwin->w_buffer;
1961 }
1962 last_lnum = lnum;
1963 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001964 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1965
Bram Moolenaardab38d52013-06-15 17:06:36 +02001966 if (!did_emsg && save_did_emsg)
1967 did_emsg = save_did_emsg;
1968
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001969 if (text != NULL)
1970 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001971 // Replace unprintable characters, if there are any. But
1972 // replace a TAB with a space.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001973 for (p = text; *p != NUL; ++p)
1974 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001975 int len;
1976
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001977 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001978 {
1979 if (!vim_isprintc((*mb_ptr2char)(p)))
1980 break;
1981 p += len - 1;
1982 }
1983 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001984 if (*p == TAB)
1985 *p = ' ';
1986 else if (ptr2cells(p) > 1)
1987 break;
1988 }
1989 if (*p != NUL)
1990 {
1991 p = transstr(text);
1992 vim_free(text);
1993 text = p;
1994 }
1995 }
1996 }
1997 if (text == NULL)
1998#endif
1999 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02002000 long count = (long)(lnume - lnum + 1);
2001
2002 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01002003 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02002004 "+--%3ld lines folded ", count),
2005 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002006 text = buf;
2007 }
2008 return text;
2009}
2010
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002011// foldtext_cleanup() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +02002012#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013/*
2014 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
2015 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02002016 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002017foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002019 char_u *cms_start; // first part or the whole comment
2020 int cms_slen = 0; // length of cms_start
2021 char_u *cms_end; // last part of the comment or NULL
2022 int cms_elen = 0; // length of cms_end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002024 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 int len;
2026 int did1 = FALSE;
2027 int did2 = FALSE;
2028
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002029 // Ignore leading and trailing white space in 'commentstring'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002031 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002032 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 --cms_slen;
2034
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002035 // locate "%s" in 'commentstring', use the part before and after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2037 if (cms_end != NULL)
2038 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002039 cms_elen = cms_slen - (int)(cms_end - cms_start);
2040 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002042 // exclude white space before "%s"
Bram Moolenaar1c465442017-03-12 20:10:05 +01002043 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 --cms_slen;
2045
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002046 // skip "%s" and white space after it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002048 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 cms_end = s;
2050 }
2051 parseMarker(curwin);
2052
2053 for (s = str; *s != NUL; )
2054 {
2055 len = 0;
2056 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002060 if (len > 0)
2061 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 if (VIM_ISDIGIT(s[len]))
2063 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002064
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002065 // May remove 'commentstring' start. Useful when it's a double
2066 // quote and we already removed a double quote.
Bram Moolenaar1c465442017-03-12 20:10:05 +01002067 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002068 ;
2069 if (p >= str + cms_slen
2070 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2071 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002072 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002073 s = p - cms_slen;
2074 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 }
2076 else if (cms_end != NULL)
2077 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002078 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 {
2080 len = cms_slen;
2081 did1 = TRUE;
2082 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002083 else if (!did2 && cms_elen > 0
2084 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 {
2086 len = cms_elen;
2087 did2 = TRUE;
2088 }
2089 }
2090 if (len != 0)
2091 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002092 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002094 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 }
2096 else
2097 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002098 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 }
2100 }
2101}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002102#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002104// Folding by indent, expr, marker and syntax. {{{1
2105// Define "fline_T", passed to get fold level for a line. {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106typedef struct
2107{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002108 win_T *wp; // window
2109 linenr_T lnum; // current line number
2110 linenr_T off; // offset between lnum and real line number
2111 linenr_T lnum_save; // line nr used by foldUpdateIEMSRecurse()
2112 int lvl; // current level (-1 for undefined)
2113 int lvl_next; // level used for next line
2114 int start; // number of folds that are forced to start at
2115 // this line.
2116 int end; // level of fold that is forced to end below
2117 // this line
2118 int had_end; // level of fold that is forced to end above
2119 // this line (copy of "end" of prev. line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120} fline_T;
2121
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002122// Flag is set when redrawing is needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123static int fold_changed;
2124
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002125// Function declarations. {{{2
Bram Moolenaard99df422016-01-29 23:20:40 +01002126static 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 +01002127static int foldInsert(garray_T *gap, int i);
2128static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2129static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2130static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2131static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002133static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002135static void foldlevelExpr(fline_T *flp);
2136static void foldlevelMarker(fline_T *flp);
2137static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002139// foldUpdateIEMS() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140/*
2141 * Update the folding for window "wp", at least from lines "top" to "bot".
2142 * Return TRUE if any folds did change.
2143 */
2144 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002145foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146{
2147 linenr_T start;
2148 linenr_T end;
2149 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002150 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 int level;
2152 fold_T *fp;
2153
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002154 // Avoid problems when being called recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 if (invalid_top != (linenr_T)0)
2156 return;
2157
2158 if (wp->w_foldinvalid)
2159 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002160 // Need to update all folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 top = 1;
2162 bot = wp->w_buffer->b_ml.ml_line_count;
2163 wp->w_foldinvalid = FALSE;
2164
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002165 // Mark all folds a maybe-small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 setSmallMaybe(&wp->w_folds);
2167 }
2168
2169#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002170 // add the context for "diff" folding
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 if (foldmethodIsDiff(wp))
2172 {
2173 if (top > diff_context)
2174 top -= diff_context;
2175 else
2176 top = 1;
2177 bot += diff_context;
2178 }
2179#endif
2180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002181 // When deleting lines at the end of the buffer "top" can be past the end
2182 // of the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 if (top > wp->w_buffer->b_ml.ml_line_count)
2184 top = wp->w_buffer->b_ml.ml_line_count;
2185
2186 fold_changed = FALSE;
2187 fline.wp = wp;
2188 fline.off = 0;
2189 fline.lvl = 0;
2190 fline.lvl_next = -1;
2191 fline.start = 0;
2192 fline.end = MAX_LEVEL + 1;
2193 fline.had_end = MAX_LEVEL + 1;
2194
2195 invalid_top = top;
2196 invalid_bot = bot;
2197
2198 if (foldmethodIsMarker(wp))
2199 {
2200 getlevel = foldlevelMarker;
2201
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002202 // Init marker variables to speed up foldlevelMarker().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 parseMarker(wp);
2204
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002205 // Need to get the level of the line above top, it is used if there is
2206 // no marker at the top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 if (top > 1)
2208 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002209 // Get the fold level at top - 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 level = foldLevelWin(wp, top - 1);
2211
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002212 // The fold may end just above the top, check for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 fline.lnum = top - 1;
2214 fline.lvl = level;
2215 getlevel(&fline);
2216
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002217 // If a fold started here, we already had the level, if it stops
2218 // here, we need to use lvl_next. Could also start and end a fold
2219 // in the same line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 if (fline.lvl > level)
2221 fline.lvl = level - (fline.lvl - fline.lvl_next);
2222 else
2223 fline.lvl = fline.lvl_next;
2224 }
2225 fline.lnum = top;
2226 getlevel(&fline);
2227 }
2228 else
2229 {
2230 fline.lnum = top;
2231 if (foldmethodIsExpr(wp))
2232 {
2233 getlevel = foldlevelExpr;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002234 // start one line back, because a "<1" may indicate the end of a
2235 // fold in the topline
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 if (top > 1)
2237 --fline.lnum;
2238 }
2239 else if (foldmethodIsSyntax(wp))
2240 getlevel = foldlevelSyntax;
2241#ifdef FEAT_DIFF
2242 else if (foldmethodIsDiff(wp))
2243 getlevel = foldlevelDiff;
2244#endif
2245 else
2246 getlevel = foldlevelIndent;
2247
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002248 // Backup to a line for which the fold level is defined. Since it's
2249 // always defined for line one, we will stop there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 fline.lvl = -1;
2251 for ( ; !got_int; --fline.lnum)
2252 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002253 // Reset lvl_next each time, because it will be set to a value for
2254 // the next line, but we search backwards here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 fline.lvl_next = -1;
2256 getlevel(&fline);
2257 if (fline.lvl >= 0)
2258 break;
2259 }
2260 }
2261
Bram Moolenaarec986472009-11-03 13:46:54 +00002262 /*
2263 * If folding is defined by the syntax, it is possible that a change in
2264 * one line will cause all sub-folds of the current fold to change (e.g.,
2265 * closing a C-style comment can cause folds in the subsequent lines to
2266 * appear). To take that into account we should adjust the value of "bot"
2267 * to point to the end of the current fold:
2268 */
2269 if (foldlevelSyntax == getlevel)
2270 {
2271 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002272 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002273 int current_fdl = 0;
2274 linenr_T fold_start_lnum = 0;
2275 linenr_T lnum_rel = fline.lnum;
2276
2277 while (current_fdl < fline.lvl)
2278 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002279 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002280 break;
2281 ++current_fdl;
2282
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002283 fold_start_lnum += fpn->fd_top;
2284 gap = &fpn->fd_nested;
2285 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002286 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002287 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002288 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002289 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002290
2291 if (fold_end_lnum > bot)
2292 bot = fold_end_lnum;
2293 }
2294 }
2295
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 start = fline.lnum;
2297 end = bot;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002298 // Do at least one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2300 end = start;
2301 while (!got_int)
2302 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002303 // Always stop at the end of the file ("end" can be past the end of
2304 // the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2306 break;
2307 if (fline.lnum > end)
2308 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002309 // For "marker", "expr" and "syntax" methods: If a change caused
2310 // a fold to be removed, we need to continue at least until where
2311 // it ended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 if (getlevel != foldlevelMarker
2313 && getlevel != foldlevelSyntax
2314 && getlevel != foldlevelExpr)
2315 break;
2316 if ((start <= end
2317 && foldFind(&wp->w_folds, end, &fp)
2318 && fp->fd_top + fp->fd_len - 1 > end)
2319 || (fline.lvl == 0
2320 && foldFind(&wp->w_folds, fline.lnum, &fp)
2321 && fp->fd_top < fline.lnum))
2322 end = fp->fd_top + fp->fd_len - 1;
2323 else if (getlevel == foldlevelSyntax
2324 && foldLevelWin(wp, fline.lnum) != fline.lvl)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002325 // For "syntax" method: Compare the foldlevel that the syntax
2326 // tells us to the foldlevel from the existing folds. If they
2327 // don't match continue updating folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 end = fline.lnum;
2329 else
2330 break;
2331 }
2332
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002333 // A level 1 fold starts at a line with foldlevel > 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 if (fline.lvl > 0)
2335 {
2336 invalid_top = fline.lnum;
2337 invalid_bot = end;
2338 end = foldUpdateIEMSRecurse(&wp->w_folds,
2339 1, start, &fline, getlevel, end, FD_LEVEL);
2340 start = fline.lnum;
2341 }
2342 else
2343 {
2344 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2345 break;
2346 ++fline.lnum;
2347 fline.lvl = fline.lvl_next;
2348 getlevel(&fline);
2349 }
2350 }
2351
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002352 // There can't be any folds from start until end now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 foldRemove(&wp->w_folds, start, end);
2354
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002355 // If some fold changed, need to redraw and position cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002357 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002359 // If we updated folds past "bot", need to redraw more lines. Don't do
2360 // this in other situations, the changed lines will be redrawn anyway and
2361 // this method can cause the whole window to be updated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 if (end != bot)
2363 {
2364 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2365 wp->w_redraw_top = top;
2366 if (wp->w_redraw_bot < end)
2367 wp->w_redraw_bot = end;
2368 }
2369
2370 invalid_top = (linenr_T)0;
2371}
2372
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002373// foldUpdateIEMSRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374/*
2375 * Update a fold that starts at "flp->lnum". At this line there is always a
2376 * valid foldlevel, and its level >= "level".
2377 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2378 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2379 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2380 * the marker method and a text change made following folds to change.
2381 * When returning, "flp->lnum_save" is the line number that was used to get
2382 * the level when the level at "flp->lnum" is invalid.
2383 * Remove any folds from "startlnum" up to here at this level.
2384 * Recursively update nested folds.
2385 * Below line "bot" there are no changes in the text.
2386 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2387 * outer fold.
2388 * "flp->off" is the offset to the real line number in the buffer.
2389 *
2390 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002391 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2393 *
2394 * Returns bot, which may have been increased for lines that also need to be
2395 * updated as a result of a detected change in the fold.
2396 */
2397 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002398foldUpdateIEMSRecurse(
2399 garray_T *gap,
2400 int level,
2401 linenr_T startlnum,
2402 fline_T *flp,
2403 void (*getlevel)(fline_T *),
2404 linenr_T bot,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002405 int topflags) // flags used by containing fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406{
2407 linenr_T ll;
2408 fold_T *fp = NULL;
2409 fold_T *fp2;
2410 int lvl = level;
2411 linenr_T startlnum2 = startlnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002412 linenr_T firstlnum = flp->lnum; // first lnum we got
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 int i;
2414 int finish = FALSE;
2415 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2416 int concat;
2417
2418 /*
2419 * If using the marker method, the start line is not the start of a fold
2420 * at the level we're dealing with and the level is non-zero, we must use
2421 * the previous fold. But ignore a fold that starts at or below
2422 * startlnum, it must be deleted.
2423 */
2424 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2425 && flp->lvl > 0)
2426 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002427 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaarda697642020-09-17 19:36:04 +02002428 if (fp != NULL && (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2429 || fp->fd_top >= startlnum))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 fp = NULL;
2431 }
2432
2433 /*
2434 * Loop over all lines in this fold, or until "bot" is hit.
2435 * Handle nested folds inside of this fold.
2436 * "flp->lnum" is the current line. When finding the end of the fold, it
2437 * is just below the end of the fold.
2438 * "*flp" contains the level of the line "flp->lnum" or a following one if
2439 * there are lines with an invalid fold level. "flp->lnum_save" is the
2440 * line number that was used to get the fold level (below "flp->lnum" when
2441 * it has an invalid fold level). When called the fold level is always
2442 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2443 */
2444 flp->lnum_save = flp->lnum;
2445 while (!got_int)
2446 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002447 // Updating folds can be slow, check for CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 line_breakcheck();
2449
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002450 // Set "lvl" to the level of line "flp->lnum". When flp->start is set
2451 // and after the first line of the fold, set the level to zero to
2452 // force the fold to end. Do the same when had_end is set: Previous
2453 // line was marked as end of a fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454 lvl = flp->lvl;
2455 if (lvl > MAX_LEVEL)
2456 lvl = MAX_LEVEL;
2457 if (flp->lnum > firstlnum
2458 && (level > lvl - flp->start || level >= flp->had_end))
2459 lvl = 0;
2460
2461 if (flp->lnum > bot && !finish && fp != NULL)
2462 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002463 // For "marker" and "syntax" methods:
2464 // - If a change caused a nested fold to be removed, we need to
2465 // delete it and continue at least until where it ended.
2466 // - If a change caused a nested fold to be created, or this fold
2467 // to continue below its original end, need to finish this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 if (getlevel != foldlevelMarker
2469 && getlevel != foldlevelExpr
2470 && getlevel != foldlevelSyntax)
2471 break;
2472 i = 0;
2473 fp2 = fp;
2474 if (lvl >= level)
2475 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002476 // Compute how deep the folds currently are, if it's deeper
2477 // than "lvl" then some must be deleted, need to update
2478 // at least one nested fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 ll = flp->lnum - fp->fd_top;
2480 while (foldFind(&fp2->fd_nested, ll, &fp2))
2481 {
2482 ++i;
2483 ll -= fp2->fd_top;
2484 }
2485 }
2486 if (lvl < level + i)
2487 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002488 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 if (fp2 != NULL)
2490 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2491 }
2492 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2493 finish = TRUE;
2494 else
2495 break;
2496 }
2497
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002498 // At the start of the first nested fold and at the end of the current
2499 // fold: check if existing folds at this level, before the current
2500 // one, need to be deleted or truncated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 if (fp == NULL
2502 && (lvl != level
2503 || flp->lnum_save >= bot
2504 || flp->start != 0
2505 || flp->had_end <= MAX_LEVEL
2506 || flp->lnum == linecount))
2507 {
2508 /*
2509 * Remove or update folds that have lines between startlnum and
2510 * firstlnum.
2511 */
2512 while (!got_int)
2513 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00002514 // set concat to 1 if it's allowed to concatenate this fold
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002515 // with a previous one that touches it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2517 concat = 0;
2518 else
2519 concat = 1;
2520
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002521 // Find an existing fold to re-use. Preferably one that
2522 // includes startlnum, otherwise one that ends just before
2523 // startlnum or starts after it.
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002524 if (gap->ga_len > 0 && (foldFind(gap, startlnum, &fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2526 && fp->fd_top <= firstlnum)
2527 || foldFind(gap, firstlnum - concat, &fp)
2528 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2529 && ((lvl < level && fp->fd_top < flp->lnum)
2530 || (lvl >= level
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002531 && fp->fd_top <= flp->lnum_save)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 {
2533 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2534 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002535 // Use existing fold for the new fold. If it starts
2536 // before where we started looking, extend it. If it
2537 // starts at another line, update nested folds to keep
2538 // their position, compensating for the new fd_top.
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002539 if (fp->fd_top == firstlnum)
2540 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002541 // have found a fold beginning where we want
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002542 }
2543 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 {
2545 if (fp->fd_top > firstlnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002546 // like lines are inserted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 foldMarkAdjustRecurse(&fp->fd_nested,
2548 (linenr_T)0, (linenr_T)MAXLNUM,
2549 (long)(fp->fd_top - firstlnum), 0L);
2550 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002551 // like lines are deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 foldMarkAdjustRecurse(&fp->fd_nested,
2553 (linenr_T)0,
2554 (long)(firstlnum - fp->fd_top - 1),
2555 (linenr_T)MAXLNUM,
2556 (long)(fp->fd_top - firstlnum));
2557 fp->fd_len += fp->fd_top - firstlnum;
2558 fp->fd_top = firstlnum;
2559 fold_changed = TRUE;
2560 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002561 else if ((flp->start != 0 && lvl == level)
2562 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002564 linenr_T breakstart;
2565 linenr_T breakend;
2566
2567 /*
2568 * Before there was a fold spanning from above
2569 * startlnum to below firstlnum. This fold is valid
2570 * above startlnum (because we are not updating
2571 * that range), but there should now be a break in
2572 * it.
2573 * If the break is because we are now forced to
2574 * start a new fold at the level "level" at line
2575 * fline->lnum, then we need to split the fold at
2576 * fline->lnum.
2577 * If the break is because the range
2578 * [startlnum, firstlnum) is now at a lower indent
2579 * than "level", we need to split the fold in this
2580 * range.
2581 * Any splits have to be done recursively.
2582 */
2583 if (firstlnum != startlnum)
2584 {
2585 breakstart = startlnum;
2586 breakend = firstlnum;
2587 }
2588 else
2589 {
2590 breakstart = flp->lnum;
2591 breakend = flp->lnum;
2592 }
2593 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2594 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002596 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002598
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002599 // If using the "marker" or "syntax" method, we
2600 // need to continue until the end of the fold is
2601 // found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 if (getlevel == foldlevelMarker
2603 || getlevel == foldlevelExpr
2604 || getlevel == foldlevelSyntax)
2605 finish = TRUE;
2606 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002607
2608 if (fp->fd_top == startlnum && concat)
2609 {
2610 i = (int)(fp - (fold_T *)gap->ga_data);
2611 if (i != 0)
2612 {
2613 fp2 = fp - 1;
2614 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2615 {
2616 foldMerge(fp2, gap, fp);
2617 fp = fp2;
2618 }
2619 }
2620 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 break;
2622 }
2623 if (fp->fd_top >= startlnum)
2624 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002625 // A fold that starts at or after startlnum and stops
2626 // before the new fold must be deleted. Continue
2627 // looking for the next one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 deleteFoldEntry(gap,
2629 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2630 }
2631 else
2632 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002633 // A fold has some lines above startlnum, truncate it
2634 // to stop just above startlnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 fp->fd_len = startlnum - fp->fd_top;
2636 foldMarkAdjustRecurse(&fp->fd_nested,
2637 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2638 (linenr_T)MAXLNUM, 0L);
2639 fold_changed = TRUE;
2640 }
2641 }
2642 else
2643 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002644 // Insert new fold. Careful: ga_data may be NULL and it
2645 // may change!
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002646 if (gap->ga_len == 0)
2647 i = 0;
2648 else
2649 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 if (foldInsert(gap, i) != OK)
2651 return bot;
2652 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002653 // The new fold continues until bot, unless we find the
2654 // end earlier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 fp->fd_top = firstlnum;
2656 fp->fd_len = bot - firstlnum + 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002657 // When the containing fold is open, the new fold is open.
2658 // The new fold is closed if the fold above it is closed.
2659 // The first fold depends on the containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 if (topflags == FD_OPEN)
2661 {
2662 flp->wp->w_fold_manual = TRUE;
2663 fp->fd_flags = FD_OPEN;
2664 }
2665 else if (i <= 0)
2666 {
2667 fp->fd_flags = topflags;
2668 if (topflags != FD_LEVEL)
2669 flp->wp->w_fold_manual = TRUE;
2670 }
2671 else
2672 fp->fd_flags = (fp - 1)->fd_flags;
2673 fp->fd_small = MAYBE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002674 // If using the "marker", "expr" or "syntax" method, we
2675 // need to continue until the end of the fold is found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 if (getlevel == foldlevelMarker
2677 || getlevel == foldlevelExpr
2678 || getlevel == foldlevelSyntax)
2679 finish = TRUE;
2680 fold_changed = TRUE;
2681 break;
2682 }
2683 }
2684 }
2685
2686 if (lvl < level || flp->lnum > linecount)
2687 {
2688 /*
2689 * Found a line with a lower foldlevel, this fold ends just above
2690 * "flp->lnum".
2691 */
2692 break;
2693 }
2694
2695 /*
2696 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002697 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002699 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 {
2701 /*
2702 * There is a nested fold, handle it recursively.
2703 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002704 // At least do one line (can happen when finish is TRUE).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 if (bot < flp->lnum)
2706 bot = flp->lnum;
2707
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002708 // Line numbers in the nested fold are relative to the start of
2709 // this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 flp->lnum = flp->lnum_save - fp->fd_top;
2711 flp->off += fp->fd_top;
2712 i = (int)(fp - (fold_T *)gap->ga_data);
2713 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2714 startlnum2 - fp->fd_top, flp, getlevel,
2715 bot - fp->fd_top, fp->fd_flags);
2716 fp = (fold_T *)gap->ga_data + i;
2717 flp->lnum += fp->fd_top;
2718 flp->lnum_save += fp->fd_top;
2719 flp->off -= fp->fd_top;
2720 bot += fp->fd_top;
2721 startlnum2 = flp->lnum;
2722
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002723 // This fold may end at the same line, don't incr. flp->lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 }
2725 else
2726 {
2727 /*
2728 * Get the level of the next line, then continue the loop to check
2729 * if it ends there.
2730 * Skip over undefined lines, to find the foldlevel after it.
2731 * For the last line in the file the foldlevel is always valid.
2732 */
2733 flp->lnum = flp->lnum_save;
2734 ll = flp->lnum + 1;
2735 while (!got_int)
2736 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002737 // Make the previous level available to foldlevel().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 prev_lnum = flp->lnum;
2739 prev_lnum_lvl = flp->lvl;
2740
2741 if (++flp->lnum > linecount)
2742 break;
2743 flp->lvl = flp->lvl_next;
2744 getlevel(flp);
2745 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2746 break;
2747 }
2748 prev_lnum = 0;
2749 if (flp->lnum > linecount)
2750 break;
2751
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002752 // leave flp->lnum_save to lnum of the line that was used to get
2753 // the level, flp->lnum to the lnum of the next line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 flp->lnum_save = flp->lnum;
2755 flp->lnum = ll;
2756 }
2757 }
2758
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002759 if (fp == NULL) // only happens when got_int is set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 return bot;
2761
2762 /*
2763 * Get here when:
2764 * lvl < level: the folds ends just above "flp->lnum"
2765 * lvl >= level: fold continues below "bot"
2766 */
2767
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002768 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 if (fp->fd_len < flp->lnum - fp->fd_top)
2770 {
2771 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002772 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 fold_changed = TRUE;
2774 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002775 else if (fp->fd_top + fp->fd_len > linecount)
2776 // running into the end of the buffer (deleted last line)
2777 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002779 // Delete contained folds from the end of the last one found until where
2780 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2782 flp->lnum - 1 - fp->fd_top);
2783
2784 if (lvl < level)
2785 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002786 // End of fold found, update the length when it got shorter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 if (fp->fd_len != flp->lnum - fp->fd_top)
2788 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002789 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002791 // fold continued below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 if (getlevel == foldlevelMarker
2793 || getlevel == foldlevelExpr
2794 || getlevel == foldlevelSyntax)
2795 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002796 // marker method: truncate the fold and make sure the
2797 // previously included lines are processed again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 bot = fp->fd_top + fp->fd_len - 1;
2799 fp->fd_len = flp->lnum - fp->fd_top;
2800 }
2801 else
2802 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002803 // indent or expr method: split fold to create a new one
2804 // below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 i = (int)(fp - (fold_T *)gap->ga_data);
2806 foldSplit(gap, i, flp->lnum, bot);
2807 fp = (fold_T *)gap->ga_data + i;
2808 }
2809 }
2810 else
2811 fp->fd_len = flp->lnum - fp->fd_top;
2812 fold_changed = TRUE;
2813 }
2814 }
2815
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002816 // delete following folds that end before the current line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 for (;;)
2818 {
2819 fp2 = fp + 1;
2820 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2821 || fp2->fd_top > flp->lnum)
2822 break;
2823 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2824 {
2825 if (fp2->fd_top < flp->lnum)
2826 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002827 // Make fold that includes lnum start at lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 foldMarkAdjustRecurse(&fp2->fd_nested,
2829 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2830 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2831 fp2->fd_len -= flp->lnum - fp2->fd_top;
2832 fp2->fd_top = flp->lnum;
2833 fold_changed = TRUE;
2834 }
2835
2836 if (lvl >= level)
2837 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002838 // merge new fold with existing fold that follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 foldMerge(fp, gap, fp2);
2840 }
2841 break;
2842 }
2843 fold_changed = TRUE;
2844 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2845 }
2846
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002847 // Need to redraw the lines we inspected, which might be further down than
2848 // was asked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 if (bot < flp->lnum - 1)
2850 bot = flp->lnum - 1;
2851
2852 return bot;
2853}
2854
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002855// foldInsert() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856/*
2857 * Insert a new fold in "gap" at position "i".
2858 * Returns OK for success, FAIL for failure.
2859 */
2860 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002861foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862{
2863 fold_T *fp;
2864
2865 if (ga_grow(gap, 1) != OK)
2866 return FAIL;
2867 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002868 if (gap->ga_len > 0 && i < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2870 ++gap->ga_len;
Bram Moolenaar04935fb2022-01-08 16:19:22 +00002871 ga_init2(&fp->fd_nested, sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 return OK;
2873}
2874
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002875// foldSplit() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876/*
2877 * Split the "i"th fold in "gap", which starts before "top" and ends below
2878 * "bot" in two pieces, one ending above "top" and the other starting below
2879 * "bot".
2880 * The caller must first have taken care of any nested folds from "top" to
2881 * "bot"!
2882 */
2883 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002884foldSplit(
2885 garray_T *gap,
2886 int i,
2887 linenr_T top,
2888 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889{
2890 fold_T *fp;
2891 fold_T *fp2;
2892 garray_T *gap1;
2893 garray_T *gap2;
2894 int idx;
2895 int len;
2896
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002897 // The fold continues below bot, need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 if (foldInsert(gap, i + 1) == FAIL)
2899 return;
2900 fp = (fold_T *)gap->ga_data + i;
2901 fp[1].fd_top = bot + 1;
2902 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2903 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002904 fp[1].fd_small = MAYBE;
2905 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002907 // Move nested folds below bot to new fold. There can't be
2908 // any between top and bot, they have been removed by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 gap1 = &fp->fd_nested;
2910 gap2 = &fp[1].fd_nested;
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002911 if (foldFind(gap1, bot + 1 - fp->fd_top, &fp2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002913 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2914 if (len > 0 && ga_grow(gap2, len) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 {
Bram Moolenaar9c2b0662020-09-01 19:56:15 +02002916 for (idx = 0; idx < len; ++idx)
2917 {
2918 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2919 ((fold_T *)gap2->ga_data)[idx].fd_top
2920 -= fp[1].fd_top - fp->fd_top;
2921 }
2922 gap2->ga_len = len;
2923 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 }
2926 fp->fd_len = top - fp->fd_top;
2927 fold_changed = TRUE;
2928}
2929
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002930// foldRemove() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931/*
2932 * Remove folds within the range "top" to and including "bot".
2933 * Check for these situations:
2934 * 1 2 3
2935 * 1 2 3
2936 * top 2 3 4 5
2937 * 2 3 4 5
2938 * bot 2 3 4 5
2939 * 3 5 6
2940 * 3 5 6
2941 *
2942 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002943 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 * 3: split in two parts, one stops above "top", other starts below "bot".
2945 * 4: deleted
2946 * 5: made to start below "bot".
2947 * 6: not changed
2948 */
2949 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002950foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951{
2952 fold_T *fp = NULL;
2953
2954 if (bot < top)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002955 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956
Bram Moolenaar64f37d32020-08-31 19:58:13 +02002957 while (gap->ga_len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002959 // Find fold that includes top or a following one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2961 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002962 // 2: or 3: need to delete nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002964 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002966 // 3: need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2968 }
2969 else
2970 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002971 // 2: truncate fold at "top".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 fp->fd_len = top - fp->fd_top;
2973 }
2974 fold_changed = TRUE;
2975 continue;
2976 }
2977 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2978 || fp->fd_top > bot)
2979 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002980 // 6: Found a fold below bot, can stop looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 break;
2982 }
2983 if (fp->fd_top >= top)
2984 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002985 // Found an entry below top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002987 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002989 // 5: Make fold that includes bot start below bot.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 foldMarkAdjustRecurse(&fp->fd_nested,
2991 (linenr_T)0, (long)(bot - fp->fd_top),
2992 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2993 fp->fd_len -= bot - fp->fd_top + 1;
2994 fp->fd_top = bot + 1;
2995 break;
2996 }
2997
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002998 // 4: Delete completely contained fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
3000 }
3001 }
3002}
3003
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003004// foldReverseOrder() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003005 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003006foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003007{
3008 fold_T *left, *right;
3009 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02003010 linenr_T start = start_arg;
3011 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003012
3013 for (; start < end; start++, end--)
3014 {
3015 left = (fold_T *)gap->ga_data + start;
3016 right = (fold_T *)gap->ga_data + end;
3017 tmp = *left;
3018 *left = *right;
3019 *right = tmp;
3020 }
3021}
3022
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003023// foldMoveRange() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003024/*
3025 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3026 * requires "line1" <= "line2" <= "dest"
3027 *
3028 * There are the following situations for the first fold at or below line1 - 1.
3029 * 1 2 3 4
3030 * 1 2 3 4
3031 * line1 2 3 4
3032 * 2 3 4 5 6 7
3033 * line2 3 4 5 6 7
3034 * 3 4 6 7 8 9
3035 * dest 4 7 8 9
3036 * 4 7 8 10
3037 * 4 7 8 10
3038 *
3039 * In the following descriptions, "moved" means moving in the buffer, *and* in
3040 * the fold array.
3041 * Meanwhile, "shifted" just means moving in the buffer.
3042 * 1. not changed
3043 * 2. truncated above line1
3044 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3045 * dest are truncated and shifted up
3046 * 4. internal folds moved (from [line1, line2] to dest)
3047 * 5. moved to dest.
3048 * 6. truncated below line2 and moved.
3049 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3050 * removed, top is moved down by move_len.
3051 * 8. truncated below dest and shifted up.
3052 * 9. shifted up
3053 * 10. not changed
3054 */
3055
3056 static void
3057truncate_fold(fold_T *fp, linenr_T end)
3058{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003059 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003060 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003061 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003062}
3063
3064#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
Bram Moolenaar81fcb672020-09-01 21:21:24 +02003065#define valid_fold(fp, gap) ((gap)->ga_len > 0 && (fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003066#define fold_index(fp, gap) ((size_t)(fp - ((fold_T *)(gap)->ga_data)))
3067
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003068 void
3069foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003070{
3071 fold_T *fp;
3072 linenr_T range_len = line2 - line1 + 1;
3073 linenr_T move_len = dest - line2;
3074 int at_start = foldFind(gap, line1 - 1, &fp);
3075 size_t move_start = 0, move_end = 0, dest_index = 0;
3076
3077 if (at_start)
3078 {
3079 if (fold_end(fp) > dest)
3080 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003081 // Case 4
3082 // don't have to change this fold, but have to move nested folds.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003083 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3084 fp->fd_top, dest - fp->fd_top);
3085 return;
3086 }
3087 else if (fold_end(fp) > line2)
3088 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003089 // Case 3
3090 // Remove nested folds between line1 and line2 & reduce the
3091 // length of fold by "range_len".
3092 // Folds after this one must be dealt with.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003093 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3094 fp->fd_top, MAXLNUM, -range_len);
3095 fp->fd_len -= range_len;
3096 }
3097 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003098 // Case 2 truncate fold, folds after this one must be dealt with.
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003099 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003100
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003101 // Look at the next fold, and treat that one as if it were the first
3102 // after "line1" (because now it is).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003103 fp = fp + 1;
3104 }
3105
3106 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3107 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003108 // Case 10
3109 // No folds after "line1" and before "dest"
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003110 return;
3111 }
3112 else if (fp->fd_top > line2)
3113 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003114 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003115 // Case 9. (for all case 9's) -- shift up.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003116 fp->fd_top -= range_len;
3117
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003118 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003119 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003120 // Case 8. -- ensure truncated at dest, shift up
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003121 truncate_fold(fp, dest);
3122 fp->fd_top -= range_len;
3123 }
3124 return;
3125 }
3126 else if (fold_end(fp) > dest)
3127 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003128 // Case 7 -- remove nested folds and shrink
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003129 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3130 fp->fd_top, MAXLNUM, -move_len);
3131 fp->fd_len -= move_len;
3132 fp->fd_top += move_len;
3133 return;
3134 }
3135
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003136 // Case 5 or 6
3137 // changes rely on whether there are folds between the end of
3138 // this fold and "dest".
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003139 move_start = fold_index(fp, gap);
3140
3141 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3142 {
3143 if (fp->fd_top <= line2)
3144 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003145 // 1. 2. or 3.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003146 if (fold_end(fp) > line2)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003147 // 2. or 3., truncate before moving
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003148 truncate_fold(fp, line2);
3149
3150 fp->fd_top += move_len;
3151 continue;
3152 }
3153
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003154 // Record index of the first fold after the moved range.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003155 if (move_end == 0)
3156 move_end = fold_index(fp, gap);
3157
3158 if (fold_end(fp) > dest)
3159 truncate_fold(fp, dest);
3160
3161 fp->fd_top -= range_len;
3162 }
3163
3164 dest_index = fold_index(fp, gap);
3165
3166 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003167 * All folds are now correct, but not necessarily in the correct order. We
3168 * must swap folds in the range [move_end, dest_index) with those in the
3169 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003170 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003171 if (move_end == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003172 // There are no folds after those moved, hence no folds have been moved
3173 // out of order.
Bram Moolenaar94be6192017-04-22 22:40:11 +02003174 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003175 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3176 foldReverseOrder(gap, (linenr_T)move_start,
3177 (linenr_T)(move_start + dest_index - move_end - 1));
3178 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3179 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003180}
3181#undef fold_end
3182#undef valid_fold
3183#undef fold_index
3184
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003185// foldMerge() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003187 * Merge two adjacent folds (and the nested ones in them).
3188 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 * must end just above "fp2".
3190 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3191 * Fold entry "fp2" in "gap" is deleted.
3192 */
3193 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003194foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195{
3196 fold_T *fp3;
3197 fold_T *fp4;
3198 int idx;
3199 garray_T *gap1 = &fp1->fd_nested;
3200 garray_T *gap2 = &fp2->fd_nested;
3201
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003202 // If the last nested fold in fp1 touches the first nested fold in fp2,
3203 // merge them recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3205 foldMerge(fp3, gap2, fp4);
3206
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003207 // Move nested folds in fp2 to the end of fp1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3209 {
3210 for (idx = 0; idx < gap2->ga_len; ++idx)
3211 {
3212 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3213 = ((fold_T *)gap2->ga_data)[idx];
3214 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3215 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 }
3217 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 }
3219
3220 fp1->fd_len += fp2->fd_len;
3221 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3222 fold_changed = TRUE;
3223}
3224
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003225// foldlevelIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226/*
3227 * Low level function to get the foldlevel for the "indent" method.
3228 * Doesn't use any caching.
3229 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3230 */
3231 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003232foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233{
3234 char_u *s;
3235 buf_T *buf;
3236 linenr_T lnum = flp->lnum + flp->off;
3237
3238 buf = flp->wp->w_buffer;
3239 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3240
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003241 // empty line or lines starting with a character in 'foldignore': level
3242 // depends on surrounding lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3244 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003245 // first and last line can't be undefined, use level 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3247 flp->lvl = 0;
3248 else
3249 flp->lvl = -1;
3250 }
3251 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003252 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003254 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003256 if (flp->lvl < 0)
3257 flp->lvl = 0;
3258 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259}
3260
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003261// foldlevelDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262#ifdef FEAT_DIFF
3263/*
3264 * Low level function to get the foldlevel for the "diff" method.
3265 * Doesn't use any caching.
3266 */
3267 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003268foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269{
3270 if (diff_infold(flp->wp, flp->lnum + flp->off))
3271 flp->lvl = 1;
3272 else
3273 flp->lvl = 0;
3274}
3275#endif
3276
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003277// foldlevelExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278/*
3279 * Low level function to get the foldlevel for the "expr" method.
3280 * Doesn't use any caching.
3281 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3282 */
3283 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003284foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285{
3286#ifndef FEAT_EVAL
3287 flp->start = FALSE;
3288 flp->lvl = 0;
3289#else
3290 win_T *win;
3291 int n;
3292 int c;
3293 linenr_T lnum = flp->lnum + flp->off;
3294 int save_keytyped;
3295
3296 win = curwin;
3297 curwin = flp->wp;
3298 curbuf = flp->wp->w_buffer;
3299 set_vim_var_nr(VV_LNUM, lnum);
3300
3301 flp->start = 0;
3302 flp->had_end = flp->end;
3303 flp->end = MAX_LEVEL + 1;
3304 if (lnum <= 1)
3305 flp->lvl = 0;
3306
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003307 // KeyTyped may be reset to 0 when calling a function which invokes
3308 // do_cmdline(). To make 'foldopen' work correctly restore KeyTyped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 save_keytyped = KeyTyped;
Bram Moolenaarf9547eb2021-02-01 19:24:55 +01003310 n = eval_foldexpr(flp->wp->w_p_fde, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 KeyTyped = save_keytyped;
3312
3313 switch (c)
3314 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003315 // "a1", "a2", .. : add to the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 case 'a': if (flp->lvl >= 0)
3317 {
3318 flp->lvl += n;
3319 flp->lvl_next = flp->lvl;
3320 }
3321 flp->start = n;
3322 break;
3323
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003324 // "s1", "s2", .. : subtract from the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 case 's': if (flp->lvl >= 0)
3326 {
3327 if (n > flp->lvl)
3328 flp->lvl_next = 0;
3329 else
3330 flp->lvl_next = flp->lvl - n;
3331 flp->end = flp->lvl_next + 1;
3332 }
3333 break;
3334
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003335 // ">1", ">2", .. : start a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 case '>': flp->lvl = n;
3337 flp->lvl_next = n;
3338 flp->start = 1;
3339 break;
3340
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003341 // "<1", "<2", .. : end a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 case '<': flp->lvl_next = n - 1;
3343 flp->end = n;
3344 break;
3345
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003346 // "=": No change in level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 case '=': flp->lvl_next = flp->lvl;
3348 break;
3349
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003350 // "-1", "0", "1", ..: set fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 default: if (n < 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003352 // Use the current level for the next line, so that "a1"
3353 // will work there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 flp->lvl_next = flp->lvl;
3355 else
3356 flp->lvl_next = n;
3357 flp->lvl = n;
3358 break;
3359 }
3360
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003361 // If the level is unknown for the first or the last line in the file, use
3362 // level 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 if (flp->lvl < 0)
3364 {
3365 if (lnum <= 1)
3366 {
3367 flp->lvl = 0;
3368 flp->lvl_next = 0;
3369 }
3370 if (lnum == curbuf->b_ml.ml_line_count)
3371 flp->lvl_next = 0;
3372 }
3373
3374 curwin = win;
3375 curbuf = curwin->w_buffer;
3376#endif
3377}
3378
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003379// parseMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380/*
3381 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3382 * "foldendmarkerlen".
3383 * Relies on the option value to have been checked for correctness already.
3384 */
3385 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003386parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387{
3388 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3389 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3390 foldendmarkerlen = (int)STRLEN(foldendmarker);
3391}
3392
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003393// foldlevelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394/*
3395 * Low level function to get the foldlevel for the "marker" method.
3396 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3397 * set before calling this.
3398 * Requires that flp->lvl is set to the fold level of the previous line!
3399 * Careful: This means you can't call this function twice on the same line.
3400 * Doesn't use any caching.
3401 * Sets flp->start when a start marker was found.
3402 */
3403 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003404foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405{
3406 char_u *startmarker;
3407 int cstart;
3408 int cend;
3409 int start_lvl = flp->lvl;
3410 char_u *s;
3411 int n;
3412
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003413 // cache a few values for speed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 startmarker = flp->wp->w_p_fmr;
3415 cstart = *startmarker;
3416 ++startmarker;
3417 cend = *foldendmarker;
3418
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003419 // Default: no start found, next level is same as current level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 flp->start = 0;
3421 flp->lvl_next = flp->lvl;
3422
3423 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3424 while (*s)
3425 {
3426 if (*s == cstart
3427 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3428 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003429 // found startmarker: set flp->lvl
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 s += foldstartmarkerlen;
3431 if (VIM_ISDIGIT(*s))
3432 {
3433 n = atoi((char *)s);
3434 if (n > 0)
3435 {
3436 flp->lvl = n;
3437 flp->lvl_next = n;
3438 if (n <= start_lvl)
3439 flp->start = 1;
3440 else
3441 flp->start = n - start_lvl;
3442 }
3443 }
3444 else
3445 {
3446 ++flp->lvl;
3447 ++flp->lvl_next;
3448 ++flp->start;
3449 }
3450 }
3451 else if (*s == cend
3452 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3453 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003454 // found endmarker: set flp->lvl_next
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 s += foldendmarkerlen;
3456 if (VIM_ISDIGIT(*s))
3457 {
3458 n = atoi((char *)s);
3459 if (n > 0)
3460 {
3461 flp->lvl = n;
3462 flp->lvl_next = n - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003463 // never start a fold with an end marker
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003464 if (flp->lvl_next > start_lvl)
3465 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 }
3467 }
3468 else
3469 --flp->lvl_next;
3470 }
3471 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003472 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 }
3474
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003475 // The level can't go negative, must be missing a start marker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 if (flp->lvl_next < 0)
3477 flp->lvl_next = 0;
3478}
3479
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003480// foldlevelSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481/*
3482 * Low level function to get the foldlevel for the "syntax" method.
3483 * Doesn't use any caching.
3484 */
3485 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003486foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487{
3488#ifndef FEAT_SYN_HL
3489 flp->start = 0;
3490 flp->lvl = 0;
3491#else
3492 linenr_T lnum = flp->lnum + flp->off;
3493 int n;
3494
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003495 // Use the maximum fold level at the start of this line and the next.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3497 flp->start = 0;
3498 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3499 {
3500 n = syn_get_foldlevel(flp->wp, lnum + 1);
3501 if (n > flp->lvl)
3502 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003503 flp->start = n - flp->lvl; // fold(s) start here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 flp->lvl = n;
3505 }
3506 }
3507#endif
3508}
3509
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003510// functions for storing the fold state in a View {{{1
3511// put_folds() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003513static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3514static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3515static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516
3517/*
3518 * Write commands to "fd" to restore the manual folds in window "wp".
3519 * Return FAIL if writing fails.
3520 */
3521 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003522put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523{
3524 if (foldmethodIsManual(wp))
3525 {
3526 if (put_line(fd, "silent! normal! zE") == FAIL
Bram Moolenaarf9547eb2021-02-01 19:24:55 +01003527 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL
3528 || put_line(fd, "let &fdl = &fdl") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 return FAIL;
3530 }
3531
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003532 // If some folds are manually opened/closed, need to restore that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003534 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
3536 return OK;
3537}
3538
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003539// put_folds_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540/*
3541 * Write commands to "fd" to recreate manually created folds.
3542 * Returns FAIL when writing failed.
3543 */
3544 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003545put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546{
3547 int i;
3548 fold_T *fp;
3549
3550 fp = (fold_T *)gap->ga_data;
3551 for (i = 0; i < gap->ga_len; i++)
3552 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003553 // Do nested folds first, they will be created closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3555 return FAIL;
3556 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3557 fp->fd_top + off + fp->fd_len - 1) < 0
3558 || put_eol(fd) == FAIL)
3559 return FAIL;
3560 ++fp;
3561 }
3562 return OK;
3563}
3564
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003565// put_foldopen_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566/*
3567 * Write commands to "fd" to open and close manually opened/closed folds.
3568 * Returns FAIL when writing failed.
3569 */
3570 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003571put_foldopen_recurse(
3572 FILE *fd,
3573 win_T *wp,
3574 garray_T *gap,
3575 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576{
3577 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003578 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 fold_T *fp;
3580
3581 fp = (fold_T *)gap->ga_data;
3582 for (i = 0; i < gap->ga_len; i++)
3583 {
3584 if (fp->fd_flags != FD_LEVEL)
3585 {
3586 if (fp->fd_nested.ga_len > 0)
3587 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003588 // open nested folds while this fold is open
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3590 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003591 || put_line(fd, "normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003593 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3594 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 == FAIL)
3596 return FAIL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003597 // close the parent when needed
Bram Moolenaard25ad652012-02-29 19:20:02 +01003598 if (fp->fd_flags == FD_CLOSED)
3599 {
3600 if (put_fold_open_close(fd, fp, off) == FAIL)
3601 return FAIL;
3602 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003604 else
3605 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003606 // Open or close the leaf according to the window foldlevel.
3607 // Do not close a leaf that is already closed, as it will close
3608 // the parent.
Bram Moolenaard25ad652012-02-29 19:20:02 +01003609 level = foldLevelWin(wp, off + fp->fd_top);
3610 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3611 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3612 if (put_fold_open_close(fd, fp, off) == FAIL)
3613 return FAIL;
3614 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 }
3616 ++fp;
3617 }
3618
3619 return OK;
3620}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003621
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003622// put_fold_open_close() {{{2
Bram Moolenaard25ad652012-02-29 19:20:02 +01003623/*
3624 * Write the open or close command to "fd".
3625 * Returns FAIL when writing failed.
3626 */
3627 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003628put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003629{
3630 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3631 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003632 || fprintf(fd, "normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003633 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3634 || put_eol(fd) == FAIL)
3635 return FAIL;
3636
3637 return OK;
3638}
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003639#endif // FEAT_SESSION
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003641// }}}1
Bram Moolenaardb022f32019-09-01 17:52:32 +02003642#endif // defined(FEAT_FOLDING) || defined(PROTO)
3643
3644#if defined(FEAT_EVAL) || defined(PROTO)
3645
3646/*
3647 * "foldclosed()" and "foldclosedend()" functions
3648 */
3649 static void
3650foldclosed_both(
3651 typval_T *argvars UNUSED,
3652 typval_T *rettv,
3653 int end UNUSED)
3654{
3655# ifdef FEAT_FOLDING
3656 linenr_T lnum;
3657 linenr_T first, last;
3658
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003659 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3660 return;
3661
Bram Moolenaardb022f32019-09-01 17:52:32 +02003662 lnum = tv_get_lnum(argvars);
3663 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3664 {
3665 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3666 {
3667 if (end)
3668 rettv->vval.v_number = (varnumber_T)last;
3669 else
3670 rettv->vval.v_number = (varnumber_T)first;
3671 return;
3672 }
3673 }
3674#endif
3675 rettv->vval.v_number = -1;
3676}
3677
3678/*
3679 * "foldclosed()" function
3680 */
3681 void
3682f_foldclosed(typval_T *argvars, typval_T *rettv)
3683{
3684 foldclosed_both(argvars, rettv, FALSE);
3685}
3686
3687/*
3688 * "foldclosedend()" function
3689 */
3690 void
3691f_foldclosedend(typval_T *argvars, typval_T *rettv)
3692{
3693 foldclosed_both(argvars, rettv, TRUE);
3694}
3695
3696/*
3697 * "foldlevel()" function
3698 */
3699 void
3700f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3701{
3702# ifdef FEAT_FOLDING
3703 linenr_T lnum;
3704
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003705 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3706 return;
3707
Bram Moolenaardb022f32019-09-01 17:52:32 +02003708 lnum = tv_get_lnum(argvars);
3709 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3710 rettv->vval.v_number = foldLevel(lnum);
3711# endif
3712}
3713
3714/*
3715 * "foldtext()" function
3716 */
3717 void
3718f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3719{
3720# ifdef FEAT_FOLDING
3721 linenr_T foldstart;
3722 linenr_T foldend;
3723 char_u *dashes;
3724 linenr_T lnum;
3725 char_u *s;
3726 char_u *r;
3727 int len;
3728 char *txt;
3729 long count;
3730# endif
3731
3732 rettv->v_type = VAR_STRING;
3733 rettv->vval.v_string = NULL;
3734# ifdef FEAT_FOLDING
3735 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3736 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3737 dashes = get_vim_var_str(VV_FOLDDASHES);
3738 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3739 && dashes != NULL)
3740 {
3741 // Find first non-empty line in the fold.
3742 for (lnum = foldstart; lnum < foldend; ++lnum)
3743 if (!linewhite(lnum))
3744 break;
3745
3746 // Find interesting text in this line.
3747 s = skipwhite(ml_get(lnum));
3748 // skip C comment-start
3749 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3750 {
3751 s = skipwhite(s + 2);
3752 if (*skipwhite(s) == NUL
3753 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3754 {
3755 s = skipwhite(ml_get(lnum + 1));
3756 if (*s == '*')
3757 s = skipwhite(s + 1);
3758 }
3759 }
3760 count = (long)(foldend - foldstart + 1);
3761 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3762 r = alloc(STRLEN(txt)
3763 + STRLEN(dashes) // for %s
3764 + 20 // for %3ld
3765 + STRLEN(s)); // concatenated
3766 if (r != NULL)
3767 {
3768 sprintf((char *)r, txt, dashes, count);
3769 len = (int)STRLEN(r);
3770 STRCAT(r, s);
3771 // remove 'foldmarker' and 'commentstring'
3772 foldtext_cleanup(r + len);
3773 rettv->vval.v_string = r;
3774 }
3775 }
3776# endif
3777}
3778
3779/*
3780 * "foldtextresult(lnum)" function
3781 */
3782 void
3783f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3784{
3785# ifdef FEAT_FOLDING
3786 linenr_T lnum;
3787 char_u *text;
3788 char_u buf[FOLD_TEXT_LEN];
3789 foldinfo_T foldinfo;
3790 int fold_count;
3791 static int entered = FALSE;
3792# endif
3793
3794 rettv->v_type = VAR_STRING;
3795 rettv->vval.v_string = NULL;
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02003796
3797 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
3798 return;
3799
Bram Moolenaardb022f32019-09-01 17:52:32 +02003800# ifdef FEAT_FOLDING
3801 if (entered)
3802 return; // reject recursive use
3803 entered = TRUE;
3804
3805 lnum = tv_get_lnum(argvars);
3806 // treat illegal types and illegal string values for {lnum} the same
3807 if (lnum < 0)
3808 lnum = 0;
3809 fold_count = foldedCount(curwin, lnum, &foldinfo);
3810 if (fold_count > 0)
3811 {
3812 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3813 &foldinfo, buf);
3814 if (text == buf)
3815 text = vim_strsave(text);
3816 rettv->vval.v_string = text;
3817 }
3818
3819 entered = FALSE;
3820# endif
3821}
3822
3823#endif // FEAT_EVAL