blob: 043037fa64e5c71070e2d966aee72e18a7afec70 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 * vim600:fdm=marker fdl=1 fdc=3:
3 *
4 * VIM - Vi IMproved by Bram Moolenaar
5 *
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
9 */
10
11/*
12 * fold.c: code for folding
13 */
14
15#include "vim.h"
16
17#if defined(FEAT_FOLDING) || defined(PROTO)
18
Bram Moolenaar217e1b82019-12-01 21:41:28 +010019// local declarations. {{{1
20// typedef fold_T {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +000021/*
22 * The toplevel folds for each window are stored in the w_folds growarray.
23 * Each toplevel fold can contain an array of second level folds in the
24 * fd_nested growarray.
25 * The info stored in both growarrays is the same: An array of fold_T.
26 */
27typedef struct
28{
Bram Moolenaar217e1b82019-12-01 21:41:28 +010029 linenr_T fd_top; // first line of fold; for nested fold
30 // relative to parent
31 linenr_T fd_len; // number of lines in the fold
32 garray_T fd_nested; // array of nested folds
33 char fd_flags; // see below
34 char fd_small; // TRUE, FALSE or MAYBE: fold smaller than
35 // 'foldminlines'; MAYBE applies to nested
36 // folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +000037} fold_T;
38
Bram Moolenaar217e1b82019-12-01 21:41:28 +010039#define FD_OPEN 0 // fold is open (nested ones can be closed)
40#define FD_CLOSED 1 // fold is closed
41#define FD_LEVEL 2 // depends on 'foldlevel' (nested folds too)
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
Bram Moolenaar217e1b82019-12-01 21:41:28 +010043#define MAX_LEVEL 20 // maximum fold depth
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
Bram Moolenaar217e1b82019-12-01 21:41:28 +010045// static functions {{{2
Bram Moolenaard25c16e2016-01-29 22:13:30 +010046static void newFoldLevelWin(win_T *wp);
47static int checkCloseRec(garray_T *gap, linenr_T lnum, int level);
48static int foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp);
49static int foldLevelWin(win_T *wp, linenr_T lnum);
50static void checkupdate(win_T *wp);
51static void setFoldRepeat(linenr_T lnum, long count, int do_open);
52static linenr_T setManualFold(linenr_T lnum, int opening, int recurse, int *donep);
53static linenr_T setManualFoldWin(win_T *wp, linenr_T lnum, int opening, int recurse, int *donep);
54static void foldOpenNested(fold_T *fpr);
55static void deleteFoldEntry(garray_T *gap, int idx, int recursive);
56static void foldMarkAdjustRecurse(garray_T *gap, linenr_T line1, linenr_T line2, long amount, long amount_after);
57static int getDeepestNestingRecurse(garray_T *gap);
58static int check_closed(win_T *win, fold_T *fp, int *use_levelp, int level, int *maybe_smallp, linenr_T lnum_off);
59static void checkSmall(win_T *wp, fold_T *fp, linenr_T lnum_off);
60static void setSmallMaybe(garray_T *gap);
61static void foldCreateMarkers(linenr_T start, linenr_T end);
62static void foldAddMarker(linenr_T lnum, char_u *marker, int markerlen);
63static void deleteFoldMarkers(fold_T *fp, int recursive, linenr_T lnum_off);
64static void foldDelMarker(linenr_T lnum, char_u *marker, int markerlen);
65static void foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot);
66static void parseMarker(win_T *wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +000067
68static char *e_nofold = N_("E490: No fold found");
69
70/*
71 * While updating the folds lines between invalid_top and invalid_bot have an
72 * undefined fold level. Only used for the window currently being updated.
73 */
74static linenr_T invalid_top = (linenr_T)0;
75static linenr_T invalid_bot = (linenr_T)0;
76
77/*
78 * When using 'foldexpr' we sometimes get the level of the next line, which
79 * calls foldlevel() to get the level of the current line, which hasn't been
80 * stored yet. To get around this chicken-egg problem the level of the
81 * previous line is stored here when available. prev_lnum is zero when the
82 * level is not available.
83 */
84static linenr_T prev_lnum = 0;
85static int prev_lnum_lvl = -1;
86
Bram Moolenaar217e1b82019-12-01 21:41:28 +010087// Flags used for "done" argument of setManualFold.
Bram Moolenaar071d4272004-06-13 20:20:40 +000088#define DONE_NOTHING 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010089#define DONE_ACTION 1 // did close or open a fold
90#define DONE_FOLD 2 // did find a fold
Bram Moolenaar071d4272004-06-13 20:20:40 +000091
92static int foldstartmarkerlen;
93static char_u *foldendmarker;
94static int foldendmarkerlen;
95
Bram Moolenaar217e1b82019-12-01 21:41:28 +010096// Exported folding functions. {{{1
97// copyFoldingState() {{{2
Bram Moolenaar4033c552017-09-16 20:54:51 +020098
Bram Moolenaar071d4272004-06-13 20:20:40 +000099/*
100 * Copy that folding state from window "wp_from" to window "wp_to".
101 */
102 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100103copyFoldingState(win_T *wp_from, win_T *wp_to)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104{
105 wp_to->w_fold_manual = wp_from->w_fold_manual;
106 wp_to->w_foldinvalid = wp_from->w_foldinvalid;
107 cloneFoldGrowArray(&wp_from->w_folds, &wp_to->w_folds);
108}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100110// hasAnyFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111/*
112 * Return TRUE if there may be folded lines in the current window.
113 */
114 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100115hasAnyFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100117 // very simple now, but can become more complex later
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118 return (win->w_p_fen
119 && (!foldmethodIsManual(win) || win->w_folds.ga_len > 0));
120}
121
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100122// hasFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123/*
124 * Return TRUE if line "lnum" in the current window is part of a closed
125 * fold.
126 * When returning TRUE, *firstp and *lastp are set to the first and last
127 * lnum of the sequence of folded lines (skipped when NULL).
128 */
129 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100130hasFolding(linenr_T lnum, linenr_T *firstp, linenr_T *lastp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131{
132 return hasFoldingWin(curwin, lnum, firstp, lastp, TRUE, NULL);
133}
134
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100135// hasFoldingWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100137hasFoldingWin(
138 win_T *win,
139 linenr_T lnum,
140 linenr_T *firstp,
141 linenr_T *lastp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100142 int cache, // when TRUE: use cached values of window
143 foldinfo_T *infop) // where to store fold info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 int had_folded = FALSE;
146 linenr_T first = 0;
147 linenr_T last = 0;
148 linenr_T lnum_rel = lnum;
149 int x;
150 fold_T *fp;
151 int level = 0;
152 int use_level = FALSE;
153 int maybe_small = FALSE;
154 garray_T *gap;
Bram Moolenaar945ec092016-06-08 21:17:43 +0200155 int low_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156
157 checkupdate(win);
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +0100158
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 /*
160 * Return quickly when there is no folding at all in this window.
161 */
162 if (!hasAnyFolding(win))
163 {
164 if (infop != NULL)
165 infop->fi_level = 0;
166 return FALSE;
167 }
168
169 if (cache)
170 {
171 /*
172 * First look in cached info for displayed lines. This is probably
173 * the fastest, but it can only be used if the entry is still valid.
174 */
175 x = find_wl_entry(win, lnum);
176 if (x >= 0)
177 {
178 first = win->w_lines[x].wl_lnum;
179 last = win->w_lines[x].wl_lastlnum;
180 had_folded = win->w_lines[x].wl_folded;
181 }
182 }
183
184 if (first == 0)
185 {
186 /*
187 * Recursively search for a fold that contains "lnum".
188 */
189 gap = &win->w_folds;
190 for (;;)
191 {
192 if (!foldFind(gap, lnum_rel, &fp))
193 break;
194
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100195 // Remember lowest level of fold that starts in "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 if (lnum_rel == fp->fd_top && low_level == 0)
197 low_level = level + 1;
198
199 first += fp->fd_top;
200 last += fp->fd_top;
201
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100202 // is this fold closed?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 had_folded = check_closed(win, fp, &use_level, level,
204 &maybe_small, lnum - lnum_rel);
205 if (had_folded)
206 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100207 // Fold closed: Set last and quit loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208 last += fp->fd_len - 1;
209 break;
210 }
211
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100212 // Fold found, but it's open: Check nested folds. Line number is
213 // relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 gap = &fp->fd_nested;
215 lnum_rel -= fp->fd_top;
216 ++level;
217 }
218 }
219
220 if (!had_folded)
221 {
222 if (infop != NULL)
223 {
224 infop->fi_level = level;
225 infop->fi_lnum = lnum - lnum_rel;
226 infop->fi_low_level = low_level == 0 ? level : low_level;
227 }
228 return FALSE;
229 }
230
Bram Moolenaar05b20fb2015-04-13 20:52:36 +0200231 if (last > win->w_buffer->b_ml.ml_line_count)
232 last = win->w_buffer->b_ml.ml_line_count;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 if (lastp != NULL)
234 *lastp = last;
235 if (firstp != NULL)
236 *firstp = first;
237 if (infop != NULL)
238 {
239 infop->fi_level = level + 1;
240 infop->fi_lnum = first;
241 infop->fi_low_level = low_level == 0 ? level + 1 : low_level;
242 }
243 return TRUE;
244}
245
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100246// foldLevel() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +0200247#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248/*
249 * Return fold level at line number "lnum" in the current window.
250 */
Bram Moolenaardb022f32019-09-01 17:52:32 +0200251 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100252foldLevel(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100254 // While updating the folds lines between invalid_top and invalid_bot have
255 // an undefined fold level. Otherwise update the folds first.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 if (invalid_top == (linenr_T)0)
257 checkupdate(curwin);
258 else if (lnum == prev_lnum && prev_lnum_lvl >= 0)
259 return prev_lnum_lvl;
260 else if (lnum >= invalid_top && lnum <= invalid_bot)
261 return -1;
262
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100263 // Return quickly when there is no folding at all in this window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 if (!hasAnyFolding(curwin))
265 return 0;
266
267 return foldLevelWin(curwin, lnum);
268}
Bram Moolenaardb022f32019-09-01 17:52:32 +0200269#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100271// lineFolded() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272/*
273 * Low level function to check if a line is folded. Doesn't use any caching.
274 * Return TRUE if line is folded.
275 * Return FALSE if line is not folded.
276 * Return MAYBE if the line is folded when next to a folded line.
277 */
278 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100279lineFolded(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280{
281 return foldedCount(win, lnum, NULL) != 0;
282}
283
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100284// foldedCount() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285/*
286 * Count the number of lines that are folded at line number "lnum".
287 * Normally "lnum" is the first line of a possible fold, and the returned
288 * number is the number of lines in the fold.
289 * Doesn't use caching from the displayed window.
290 * Returns number of folded lines from "lnum", or 0 if line is not folded.
291 * When "infop" is not NULL, fills *infop with the fold level info.
292 */
293 long
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100294foldedCount(win_T *win, linenr_T lnum, foldinfo_T *infop)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295{
296 linenr_T last;
297
298 if (hasFoldingWin(win, lnum, NULL, &last, FALSE, infop))
299 return (long)(last - lnum + 1);
300 return 0;
301}
302
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100303// foldmethodIsManual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304/*
305 * Return TRUE if 'foldmethod' is "manual"
306 */
307 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100308foldmethodIsManual(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309{
310 return (wp->w_p_fdm[3] == 'u');
311}
312
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100313// foldmethodIsIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314/*
315 * Return TRUE if 'foldmethod' is "indent"
316 */
317 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100318foldmethodIsIndent(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319{
320 return (wp->w_p_fdm[0] == 'i');
321}
322
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100323// foldmethodIsExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324/*
325 * Return TRUE if 'foldmethod' is "expr"
326 */
327 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100328foldmethodIsExpr(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329{
330 return (wp->w_p_fdm[1] == 'x');
331}
332
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100333// foldmethodIsMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334/*
335 * Return TRUE if 'foldmethod' is "marker"
336 */
337 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100338foldmethodIsMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339{
340 return (wp->w_p_fdm[2] == 'r');
341}
342
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100343// foldmethodIsSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344/*
345 * Return TRUE if 'foldmethod' is "syntax"
346 */
347 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100348foldmethodIsSyntax(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349{
350 return (wp->w_p_fdm[0] == 's');
351}
352
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100353// foldmethodIsDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354/*
355 * Return TRUE if 'foldmethod' is "diff"
356 */
357 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100358foldmethodIsDiff(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359{
360 return (wp->w_p_fdm[0] == 'd');
361}
362
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100363// closeFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364/*
365 * Close fold for current window at line "lnum".
366 * Repeat "count" times.
367 */
368 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100369closeFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370{
371 setFoldRepeat(lnum, count, FALSE);
372}
373
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100374// closeFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375/*
376 * Close fold for current window at line "lnum" recursively.
377 */
378 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100379closeFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380{
381 (void)setManualFold(lnum, FALSE, TRUE, NULL);
382}
383
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100384// opFoldRange() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385/*
386 * Open or Close folds for current window in lines "first" to "last".
387 * Used for "zo", "zO", "zc" and "zC" in Visual mode.
388 */
389 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100390opFoldRange(
391 linenr_T first,
392 linenr_T last,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100393 int opening, // TRUE to open, FALSE to close
394 int recurse, // TRUE to do it recursively
395 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100397 int done = DONE_NOTHING; // avoid error messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 linenr_T lnum;
399 linenr_T lnum_next;
400
401 for (lnum = first; lnum <= last; lnum = lnum_next + 1)
402 {
403 lnum_next = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100404 // Opening one level only: next fold to open is after the one going to
405 // be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 if (opening && !recurse)
407 (void)hasFolding(lnum, NULL, &lnum_next);
408 (void)setManualFold(lnum, opening, recurse, &done);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100409 // Closing one level only: next line to close a fold is after just
410 // closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 if (!opening && !recurse)
412 (void)hasFolding(lnum, NULL, &lnum_next);
413 }
414 if (done == DONE_NOTHING)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100415 emsg(_(e_nofold));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100416 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417 if (had_visual)
418 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419}
420
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100421// openFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422/*
423 * Open fold for current window at line "lnum".
424 * Repeat "count" times.
425 */
426 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100427openFold(linenr_T lnum, long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428{
429 setFoldRepeat(lnum, count, TRUE);
430}
431
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100432// openFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433/*
434 * Open fold for current window at line "lnum" recursively.
435 */
436 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100437openFoldRecurse(linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438{
439 (void)setManualFold(lnum, TRUE, TRUE, NULL);
440}
441
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100442// foldOpenCursor() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443/*
444 * Open folds until the cursor line is not in a closed fold.
445 */
446 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100447foldOpenCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448{
449 int done;
450
451 checkupdate(curwin);
452 if (hasAnyFolding(curwin))
453 for (;;)
454 {
455 done = DONE_NOTHING;
456 (void)setManualFold(curwin->w_cursor.lnum, TRUE, FALSE, &done);
457 if (!(done & DONE_ACTION))
458 break;
459 }
460}
461
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100462// newFoldLevel() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463/*
464 * Set new foldlevel for current window.
465 */
466 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100467newFoldLevel(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468{
469 newFoldLevelWin(curwin);
470
471#ifdef FEAT_DIFF
472 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
473 {
474 win_T *wp;
475
476 /*
477 * Set the same foldlevel in other windows in diff mode.
478 */
479 FOR_ALL_WINDOWS(wp)
480 {
481 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
482 {
483 wp->w_p_fdl = curwin->w_p_fdl;
484 newFoldLevelWin(wp);
485 }
486 }
487 }
488#endif
489}
490
491 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100492newFoldLevelWin(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493{
494 fold_T *fp;
495 int i;
496
497 checkupdate(wp);
498 if (wp->w_fold_manual)
499 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100500 // Set all flags for the first level of folds to FD_LEVEL. Following
501 // manual open/close will then change the flags to FD_OPEN or
502 // FD_CLOSED for those folds that don't use 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 fp = (fold_T *)wp->w_folds.ga_data;
504 for (i = 0; i < wp->w_folds.ga_len; ++i)
505 fp[i].fd_flags = FD_LEVEL;
506 wp->w_fold_manual = FALSE;
507 }
508 changed_window_setting_win(wp);
509}
510
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100511// foldCheckClose() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512/*
513 * Apply 'foldlevel' to all folds that don't contain the cursor.
514 */
515 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100516foldCheckClose(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100518 if (*p_fcl != NUL) // can only be "all" right now
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 {
520 checkupdate(curwin);
521 if (checkCloseRec(&curwin->w_folds, curwin->w_cursor.lnum,
522 (int)curwin->w_p_fdl))
523 changed_window_setting();
524 }
525}
526
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100527// checkCloseRec() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100529checkCloseRec(garray_T *gap, linenr_T lnum, int level)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530{
531 fold_T *fp;
532 int retval = FALSE;
533 int i;
534
535 fp = (fold_T *)gap->ga_data;
536 for (i = 0; i < gap->ga_len; ++i)
537 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100538 // Only manually opened folds may need to be closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 if (fp[i].fd_flags == FD_OPEN)
540 {
541 if (level <= 0 && (lnum < fp[i].fd_top
542 || lnum >= fp[i].fd_top + fp[i].fd_len))
543 {
544 fp[i].fd_flags = FD_LEVEL;
545 retval = TRUE;
546 }
547 else
548 retval |= checkCloseRec(&fp[i].fd_nested, lnum - fp[i].fd_top,
549 level - 1);
550 }
551 }
552 return retval;
553}
554
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100555// foldCreateAllowed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556/*
557 * Return TRUE if it's allowed to manually create or delete a fold.
558 * Give an error message and return FALSE if not.
559 */
560 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100561foldManualAllowed(int create)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562{
563 if (foldmethodIsManual(curwin) || foldmethodIsMarker(curwin))
564 return TRUE;
565 if (create)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100566 emsg(_("E350: Cannot create fold with current 'foldmethod'"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100568 emsg(_("E351: Cannot delete fold with current 'foldmethod'"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569 return FALSE;
570}
571
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100572// foldCreate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573/*
574 * Create a fold from line "start" to line "end" (inclusive) in the current
575 * window.
576 */
577 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100578foldCreate(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579{
580 fold_T *fp;
581 garray_T *gap;
582 garray_T fold_ga;
583 int i, j;
584 int cont;
585 int use_level = FALSE;
586 int closed = FALSE;
587 int level = 0;
588 linenr_T start_rel = start;
589 linenr_T end_rel = end;
590
591 if (start > end)
592 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100593 // reverse the range
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 end = start_rel;
595 start = end_rel;
596 start_rel = start;
597 end_rel = end;
598 }
599
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100600 // When 'foldmethod' is "marker" add markers, which creates the folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 if (foldmethodIsMarker(curwin))
602 {
603 foldCreateMarkers(start, end);
604 return;
605 }
606
607 checkupdate(curwin);
608
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100609 // Find the place to insert the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 gap = &curwin->w_folds;
611 for (;;)
612 {
613 if (!foldFind(gap, start_rel, &fp))
614 break;
615 if (fp->fd_top + fp->fd_len > end_rel)
616 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100617 // New fold is completely inside this fold: Go one level deeper.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618 gap = &fp->fd_nested;
619 start_rel -= fp->fd_top;
620 end_rel -= fp->fd_top;
621 if (use_level || fp->fd_flags == FD_LEVEL)
622 {
623 use_level = TRUE;
624 if (level >= curwin->w_p_fdl)
625 closed = TRUE;
626 }
627 else if (fp->fd_flags == FD_CLOSED)
628 closed = TRUE;
629 ++level;
630 }
631 else
632 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100633 // This fold and new fold overlap: Insert here and move some folds
634 // inside the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 break;
636 }
637 }
638
639 i = (int)(fp - (fold_T *)gap->ga_data);
640 if (ga_grow(gap, 1) == OK)
641 {
642 fp = (fold_T *)gap->ga_data + i;
643 ga_init2(&fold_ga, (int)sizeof(fold_T), 10);
644
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100645 // Count number of folds that will be contained in the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 for (cont = 0; i + cont < gap->ga_len; ++cont)
647 if (fp[cont].fd_top > end_rel)
648 break;
649 if (cont > 0 && ga_grow(&fold_ga, cont) == OK)
650 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100651 // If the first fold starts before the new fold, let the new fold
652 // start there. Otherwise the existing fold would change.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 if (start_rel > fp->fd_top)
654 start_rel = fp->fd_top;
655
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100656 // When last contained fold isn't completely contained, adjust end
657 // of new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 if (end_rel < fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1)
659 end_rel = fp[cont - 1].fd_top + fp[cont - 1].fd_len - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100660 // Move contained folds to inside new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 mch_memmove(fold_ga.ga_data, fp, sizeof(fold_T) * cont);
662 fold_ga.ga_len += cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 i += cont;
664
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100665 // Adjust line numbers in contained folds to be relative to the
666 // new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 for (j = 0; j < cont; ++j)
668 ((fold_T *)fold_ga.ga_data)[j].fd_top -= start_rel;
669 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100670 // Move remaining entries to after the new fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 if (i < gap->ga_len)
672 mch_memmove(fp + 1, (fold_T *)gap->ga_data + i,
673 sizeof(fold_T) * (gap->ga_len - i));
674 gap->ga_len = gap->ga_len + 1 - cont;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100676 // insert new fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 fp->fd_nested = fold_ga;
678 fp->fd_top = start_rel;
679 fp->fd_len = end_rel - start_rel + 1;
680
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100681 // We want the new fold to be closed. If it would remain open because
682 // of using 'foldlevel', need to adjust fd_flags of containing folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 if (use_level && !closed && level < curwin->w_p_fdl)
684 closeFold(start, 1L);
685 if (!use_level)
686 curwin->w_fold_manual = TRUE;
687 fp->fd_flags = FD_CLOSED;
688 fp->fd_small = MAYBE;
689
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100690 // redraw
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 changed_window_setting();
692 }
693}
694
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100695// deleteFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696/*
697 * Delete a fold at line "start" in the current window.
698 * When "end" is not 0, delete all folds from "start" to "end".
699 * When "recursive" is TRUE delete recursively.
700 */
701 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100702deleteFold(
703 linenr_T start,
704 linenr_T end,
705 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100706 int had_visual) // TRUE when Visual selection used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707{
708 garray_T *gap;
709 fold_T *fp;
710 garray_T *found_ga;
711 fold_T *found_fp = NULL;
712 linenr_T found_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000713 int use_level;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 int maybe_small = FALSE;
715 int level = 0;
716 linenr_T lnum = start;
717 linenr_T lnum_off;
718 int did_one = FALSE;
719 linenr_T first_lnum = MAXLNUM;
720 linenr_T last_lnum = 0;
721
722 checkupdate(curwin);
723
724 while (lnum <= end)
725 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100726 // Find the deepest fold for "start".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 gap = &curwin->w_folds;
728 found_ga = NULL;
729 lnum_off = 0;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000730 use_level = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 for (;;)
732 {
733 if (!foldFind(gap, lnum - lnum_off, &fp))
734 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100735 // lnum is inside this fold, remember info
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 found_ga = gap;
737 found_fp = fp;
738 found_off = lnum_off;
739
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100740 // if "lnum" is folded, don't check nesting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 if (check_closed(curwin, fp, &use_level, level,
742 &maybe_small, lnum_off))
743 break;
744
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100745 // check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 gap = &fp->fd_nested;
747 lnum_off += fp->fd_top;
748 ++level;
749 }
750 if (found_ga == NULL)
751 {
752 ++lnum;
753 }
754 else
755 {
756 lnum = found_fp->fd_top + found_fp->fd_len + found_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758 if (foldmethodIsManual(curwin))
759 deleteFoldEntry(found_ga,
760 (int)(found_fp - (fold_T *)found_ga->ga_data), recursive);
761 else
762 {
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000763 if (first_lnum > found_fp->fd_top + found_off)
764 first_lnum = found_fp->fd_top + found_off;
765 if (last_lnum < lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 last_lnum = lnum;
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000767 if (!did_one)
768 parseMarker(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 deleteFoldMarkers(found_fp, recursive, found_off);
770 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000771 did_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100773 // redraw window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 changed_window_setting();
775 }
776 }
777 if (!did_one)
778 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100779 emsg(_(e_nofold));
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // Force a redraw to remove the Visual highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 if (had_visual)
782 redraw_curbuf_later(INVERTED);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 }
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000784 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100785 // Deleting markers may make cursor column invalid.
Bram Moolenaar238b8e22009-01-06 14:02:45 +0000786 check_cursor_col();
787
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 if (last_lnum > 0)
789 changed_lines(first_lnum, (colnr_T)0, last_lnum, 0L);
790}
791
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100792// clearFolding() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793/*
794 * Remove all folding for window "win".
795 */
796 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100797clearFolding(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798{
799 deleteFoldRecurse(&win->w_folds);
800 win->w_foldinvalid = FALSE;
801}
802
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100803// foldUpdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804/*
805 * Update folds for changes in the buffer of a window.
806 * Note that inserted/deleted lines must have already been taken care of by
807 * calling foldMarkAdjust().
808 * The changes in lines from top to bot (inclusive).
809 */
810 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100811foldUpdate(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812{
813 fold_T *fp;
814
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200815 if (disable_fold_update > 0)
816 return;
Bram Moolenaar4f57eef2019-08-24 20:54:19 +0200817#ifdef FEAT_DIFF
818 if (need_diff_redraw)
819 // will update later
820 return;
821#endif
Bram Moolenaar429fcfb2016-04-14 16:22:04 +0200822
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100823 // Mark all folds from top to bot as maybe-small.
Bram Moolenaard5f69332015-04-15 12:43:50 +0200824 (void)foldFind(&wp->w_folds, top, &fp);
825 while (fp < (fold_T *)wp->w_folds.ga_data + wp->w_folds.ga_len
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 && fp->fd_top < bot)
827 {
828 fp->fd_small = MAYBE;
829 ++fp;
830 }
831
832 if (foldmethodIsIndent(wp)
833 || foldmethodIsExpr(wp)
834 || foldmethodIsMarker(wp)
835#ifdef FEAT_DIFF
836 || foldmethodIsDiff(wp)
837#endif
838 || foldmethodIsSyntax(wp))
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000839 {
840 int save_got_int = got_int;
841
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100842 // reset got_int here, otherwise it won't work
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000843 got_int = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 foldUpdateIEMS(wp, top, bot);
Bram Moolenaarfa6d5af2007-10-14 13:33:20 +0000845 got_int |= save_got_int;
846 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847}
848
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100849// foldUpdateAll() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850/*
851 * Update all lines in a window for folding.
852 * Used when a fold setting changes or after reloading the buffer.
853 * The actual updating is postponed until fold info is used, to avoid doing
854 * every time a setting is changed or a syntax item is added.
855 */
856 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100857foldUpdateAll(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858{
859 win->w_foldinvalid = TRUE;
860 redraw_win_later(win, NOT_VALID);
861}
862
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100863// foldMoveTo() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864/*
865 * If "updown" is FALSE: Move to the start or end of the fold.
866 * If "updown" is TRUE: move to fold at the same level.
867 * If not moved return FAIL.
868 */
869 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100870foldMoveTo(
871 int updown,
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100872 int dir, // FORWARD or BACKWARD
Bram Moolenaar66f948e2016-01-30 16:39:25 +0100873 long count)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874{
875 long n;
876 int retval = FAIL;
877 linenr_T lnum_off;
878 linenr_T lnum_found;
879 linenr_T lnum;
880 int use_level;
881 int maybe_small;
882 garray_T *gap;
883 fold_T *fp;
884 int level;
885 int last;
886
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000887 checkupdate(curwin);
888
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100889 // Repeat "count" times.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 for (n = 0; n < count; ++n)
891 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100892 // Find nested folds. Stop when a fold is closed. The deepest fold
893 // that moves the cursor is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 lnum_off = 0;
895 gap = &curwin->w_folds;
896 use_level = FALSE;
897 maybe_small = FALSE;
898 lnum_found = curwin->w_cursor.lnum;
899 level = 0;
900 last = FALSE;
901 for (;;)
902 {
903 if (!foldFind(gap, curwin->w_cursor.lnum - lnum_off, &fp))
904 {
905 if (!updown)
906 break;
907
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100908 // When moving up, consider a fold above the cursor; when
909 // moving down consider a fold below the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 if (dir == FORWARD)
911 {
912 if (fp - (fold_T *)gap->ga_data >= gap->ga_len)
913 break;
914 --fp;
915 }
916 else
917 {
918 if (fp == (fold_T *)gap->ga_data)
919 break;
920 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100921 // don't look for contained folds, they will always move
922 // the cursor too far.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 last = TRUE;
924 }
925
926 if (!last)
927 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100928 // Check if this fold is closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 if (check_closed(curwin, fp, &use_level, level,
930 &maybe_small, lnum_off))
931 last = TRUE;
932
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100933 // "[z" and "]z" stop at closed fold
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 if (last && !updown)
935 break;
936 }
937
938 if (updown)
939 {
940 if (dir == FORWARD)
941 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100942 // to start of next fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 if (fp + 1 - (fold_T *)gap->ga_data < gap->ga_len)
944 {
945 lnum = fp[1].fd_top + lnum_off;
946 if (lnum > curwin->w_cursor.lnum)
947 lnum_found = lnum;
948 }
949 }
950 else
951 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100952 // to end of previous fold if there is one
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 if (fp > (fold_T *)gap->ga_data)
954 {
955 lnum = fp[-1].fd_top + lnum_off + fp[-1].fd_len - 1;
956 if (lnum < curwin->w_cursor.lnum)
957 lnum_found = lnum;
958 }
959 }
960 }
961 else
962 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100963 // Open fold found, set cursor to its start/end and then check
964 // nested folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 if (dir == FORWARD)
966 {
967 lnum = fp->fd_top + lnum_off + fp->fd_len - 1;
968 if (lnum > curwin->w_cursor.lnum)
969 lnum_found = lnum;
970 }
971 else
972 {
973 lnum = fp->fd_top + lnum_off;
974 if (lnum < curwin->w_cursor.lnum)
975 lnum_found = lnum;
976 }
977 }
978
979 if (last)
980 break;
981
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100982 // Check nested folds (if any).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 gap = &fp->fd_nested;
984 lnum_off += fp->fd_top;
985 ++level;
986 }
987 if (lnum_found != curwin->w_cursor.lnum)
988 {
989 if (retval == FAIL)
990 setpcmark();
991 curwin->w_cursor.lnum = lnum_found;
992 curwin->w_cursor.col = 0;
993 retval = OK;
994 }
995 else
996 break;
997 }
998
999 return retval;
1000}
1001
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001002// foldInitWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003/*
1004 * Init the fold info in a new window.
1005 */
1006 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001007foldInitWin(win_T *new_win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008{
Bram Moolenaar70b2a562012-01-10 22:26:17 +01001009 ga_init2(&new_win->w_folds, (int)sizeof(fold_T), 10);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010}
1011
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001012// find_wl_entry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013/*
1014 * Find an entry in the win->w_lines[] array for buffer line "lnum".
1015 * Only valid entries are considered (for entries where wl_valid is FALSE the
1016 * line number can be wrong).
1017 * Returns index of entry or -1 if not found.
1018 */
1019 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001020find_wl_entry(win_T *win, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021{
1022 int i;
1023
Bram Moolenaar08bb82e2010-03-17 16:45:12 +01001024 for (i = 0; i < win->w_lines_valid; ++i)
1025 if (win->w_lines[i].wl_valid)
1026 {
1027 if (lnum < win->w_lines[i].wl_lnum)
1028 return -1;
1029 if (lnum <= win->w_lines[i].wl_lastlnum)
1030 return i;
1031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 return -1;
1033}
1034
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001035// foldAdjustVisual() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036/*
1037 * Adjust the Visual area to include any fold at the start or end completely.
1038 */
1039 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001040foldAdjustVisual(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041{
1042 pos_T *start, *end;
1043 char_u *ptr;
1044
1045 if (!VIsual_active || !hasAnyFolding(curwin))
1046 return;
1047
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01001048 if (LTOREQ_POS(VIsual, curwin->w_cursor))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 {
1050 start = &VIsual;
1051 end = &curwin->w_cursor;
1052 }
1053 else
1054 {
1055 start = &curwin->w_cursor;
1056 end = &VIsual;
1057 }
1058 if (hasFolding(start->lnum, &start->lnum, NULL))
1059 start->col = 0;
1060 if (hasFolding(end->lnum, NULL, &end->lnum))
1061 {
1062 ptr = ml_get(end->lnum);
1063 end->col = (colnr_T)STRLEN(ptr);
1064 if (end->col > 0 && *p_sel == 'o')
1065 --end->col;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001066 // prevent cursor from moving on the trail byte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 if (has_mbyte)
1068 mb_adjust_cursor();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 }
1070}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001072// cursor_foldstart() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073/*
1074 * Move the cursor to the first line of a closed fold.
1075 */
1076 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001077foldAdjustCursor(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078{
1079 (void)hasFolding(curwin->w_cursor.lnum, &curwin->w_cursor.lnum, NULL);
1080}
1081
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001082// Internal functions for "fold_T" {{{1
1083// cloneFoldGrowArray() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084/*
1085 * Will "clone" (i.e deep copy) a garray_T of folds.
1086 *
1087 * Return FAIL if the operation cannot be completed, otherwise OK.
1088 */
1089 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001090cloneFoldGrowArray(garray_T *from, garray_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091{
1092 int i;
1093 fold_T *from_p;
1094 fold_T *to_p;
1095
1096 ga_init2(to, from->ga_itemsize, from->ga_growsize);
1097 if (from->ga_len == 0 || ga_grow(to, from->ga_len) == FAIL)
1098 return;
1099
1100 from_p = (fold_T *)from->ga_data;
1101 to_p = (fold_T *)to->ga_data;
1102
1103 for (i = 0; i < from->ga_len; i++)
1104 {
1105 to_p->fd_top = from_p->fd_top;
1106 to_p->fd_len = from_p->fd_len;
1107 to_p->fd_flags = from_p->fd_flags;
1108 to_p->fd_small = from_p->fd_small;
1109 cloneFoldGrowArray(&from_p->fd_nested, &to_p->fd_nested);
1110 ++to->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 ++from_p;
1112 ++to_p;
1113 }
1114}
1115
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001116// foldFind() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117/*
1118 * Search for line "lnum" in folds of growarray "gap".
1119 * Set *fpp to the fold struct for the fold that contains "lnum" or
1120 * the first fold below it (careful: it can be beyond the end of the array!).
1121 * Returns FALSE when there is no fold that contains "lnum".
1122 */
1123 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001124foldFind(garray_T *gap, linenr_T lnum, fold_T **fpp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125{
1126 linenr_T low, high;
1127 fold_T *fp;
1128 int i;
1129
1130 /*
1131 * Perform a binary search.
1132 * "low" is lowest index of possible match.
1133 * "high" is highest index of possible match.
1134 */
1135 fp = (fold_T *)gap->ga_data;
1136 low = 0;
1137 high = gap->ga_len - 1;
1138 while (low <= high)
1139 {
1140 i = (low + high) / 2;
1141 if (fp[i].fd_top > lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001142 // fold below lnum, adjust high
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 high = i - 1;
1144 else if (fp[i].fd_top + fp[i].fd_len <= lnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001145 // fold above lnum, adjust low
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 low = i + 1;
1147 else
1148 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001149 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 *fpp = fp + i;
1151 return TRUE;
1152 }
1153 }
1154 *fpp = fp + low;
1155 return FALSE;
1156}
1157
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001158// foldLevelWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159/*
1160 * Return fold level at line number "lnum" in window "wp".
1161 */
1162 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001163foldLevelWin(win_T *wp, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164{
1165 fold_T *fp;
1166 linenr_T lnum_rel = lnum;
1167 int level = 0;
1168 garray_T *gap;
1169
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001170 // Recursively search for a fold that contains "lnum".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 gap = &wp->w_folds;
1172 for (;;)
1173 {
1174 if (!foldFind(gap, lnum_rel, &fp))
1175 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001176 // Check nested folds. Line number is relative to containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 gap = &fp->fd_nested;
1178 lnum_rel -= fp->fd_top;
1179 ++level;
1180 }
1181
1182 return level;
1183}
1184
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001185// checkupdate() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186/*
1187 * Check if the folds in window "wp" are invalid and update them if needed.
1188 */
1189 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001190checkupdate(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191{
1192 if (wp->w_foldinvalid)
1193 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001194 foldUpdate(wp, (linenr_T)1, (linenr_T)MAXLNUM); // will update all
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 wp->w_foldinvalid = FALSE;
1196 }
1197}
1198
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001199// setFoldRepeat() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200/*
1201 * Open or close fold for current window at line "lnum".
1202 * Repeat "count" times.
1203 */
1204 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001205setFoldRepeat(linenr_T lnum, long count, int do_open)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206{
1207 int done;
1208 long n;
1209
1210 for (n = 0; n < count; ++n)
1211 {
1212 done = DONE_NOTHING;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001213 (void)setManualFold(lnum, do_open, FALSE, &done);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 if (!(done & DONE_ACTION))
1215 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001216 // Only give an error message when no fold could be opened.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 if (n == 0 && !(done & DONE_FOLD))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001218 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 break;
1220 }
1221 }
1222}
1223
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001224// setManualFold() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225/*
1226 * Open or close the fold in the current window which contains "lnum".
1227 * Also does this for other windows in diff mode when needed.
1228 */
1229 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001230setManualFold(
1231 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001232 int opening, // TRUE when opening, FALSE when closing
1233 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001234 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235{
1236#ifdef FEAT_DIFF
1237 if (foldmethodIsDiff(curwin) && curwin->w_p_scb)
1238 {
1239 win_T *wp;
1240 linenr_T dlnum;
1241
1242 /*
1243 * Do the same operation in other windows in diff mode. Calculate the
1244 * line number from the diffs.
1245 */
1246 FOR_ALL_WINDOWS(wp)
1247 {
1248 if (wp != curwin && foldmethodIsDiff(wp) && wp->w_p_scb)
1249 {
1250 dlnum = diff_lnum_win(curwin->w_cursor.lnum, wp);
1251 if (dlnum != 0)
1252 (void)setManualFoldWin(wp, dlnum, opening, recurse, NULL);
1253 }
1254 }
1255 }
1256#endif
1257
1258 return setManualFoldWin(curwin, lnum, opening, recurse, donep);
1259}
1260
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001261// setManualFoldWin() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262/*
1263 * Open or close the fold in window "wp" which contains "lnum".
1264 * "donep", when not NULL, points to flag that is set to DONE_FOLD when some
1265 * fold was found and to DONE_ACTION when some fold was opened or closed.
1266 * When "donep" is NULL give an error message when no fold was found for
1267 * "lnum", but only if "wp" is "curwin".
1268 * Return the line number of the next line that could be closed.
1269 * It's only valid when "opening" is TRUE!
1270 */
1271 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001272setManualFoldWin(
1273 win_T *wp,
1274 linenr_T lnum,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001275 int opening, // TRUE when opening, FALSE when closing
1276 int recurse, // TRUE when closing/opening recursive
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001277 int *donep)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278{
1279 fold_T *fp;
1280 fold_T *fp2;
1281 fold_T *found = NULL;
1282 int j;
1283 int level = 0;
1284 int use_level = FALSE;
1285 int found_fold = FALSE;
1286 garray_T *gap;
1287 linenr_T next = MAXLNUM;
1288 linenr_T off = 0;
1289 int done = 0;
1290
1291 checkupdate(wp);
1292
1293 /*
1294 * Find the fold, open or close it.
1295 */
1296 gap = &wp->w_folds;
1297 for (;;)
1298 {
1299 if (!foldFind(gap, lnum, &fp))
1300 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001301 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 if (fp < (fold_T *)gap->ga_data + gap->ga_len)
1303 next = fp->fd_top + off;
1304 break;
1305 }
1306
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001307 // lnum is inside this fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 found_fold = TRUE;
1309
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001310 // If there is a following fold, continue there next time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 if (fp + 1 < (fold_T *)gap->ga_data + gap->ga_len)
1312 next = fp[1].fd_top + off;
1313
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001314 // Change from level-dependent folding to manual.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 if (use_level || fp->fd_flags == FD_LEVEL)
1316 {
1317 use_level = TRUE;
1318 if (level >= wp->w_p_fdl)
1319 fp->fd_flags = FD_CLOSED;
1320 else
1321 fp->fd_flags = FD_OPEN;
1322 fp2 = (fold_T *)fp->fd_nested.ga_data;
1323 for (j = 0; j < fp->fd_nested.ga_len; ++j)
1324 fp2[j].fd_flags = FD_LEVEL;
1325 }
1326
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001327 // Simple case: Close recursively means closing the fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 if (!opening && recurse)
1329 {
1330 if (fp->fd_flags != FD_CLOSED)
1331 {
1332 done |= DONE_ACTION;
1333 fp->fd_flags = FD_CLOSED;
1334 }
1335 }
1336 else if (fp->fd_flags == FD_CLOSED)
1337 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001338 // When opening, open topmost closed fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 if (opening)
1340 {
1341 fp->fd_flags = FD_OPEN;
1342 done |= DONE_ACTION;
1343 if (recurse)
1344 foldOpenNested(fp);
1345 }
1346 break;
1347 }
1348
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001349 // fold is open, check nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 found = fp;
1351 gap = &fp->fd_nested;
1352 lnum -= fp->fd_top;
1353 off += fp->fd_top;
1354 ++level;
1355 }
1356 if (found_fold)
1357 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001358 // When closing and not recurse, close deepest open fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 if (!opening && found != NULL)
1360 {
1361 found->fd_flags = FD_CLOSED;
1362 done |= DONE_ACTION;
1363 }
1364 wp->w_fold_manual = TRUE;
1365 if (done & DONE_ACTION)
1366 changed_window_setting_win(wp);
1367 done |= DONE_FOLD;
1368 }
1369 else if (donep == NULL && wp == curwin)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001370 emsg(_(e_nofold));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371
1372 if (donep != NULL)
1373 *donep |= done;
1374
1375 return next;
1376}
1377
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001378// foldOpenNested() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379/*
1380 * Open all nested folds in fold "fpr" recursively.
1381 */
1382 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001383foldOpenNested(fold_T *fpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384{
1385 int i;
1386 fold_T *fp;
1387
1388 fp = (fold_T *)fpr->fd_nested.ga_data;
1389 for (i = 0; i < fpr->fd_nested.ga_len; ++i)
1390 {
1391 foldOpenNested(&fp[i]);
1392 fp[i].fd_flags = FD_OPEN;
1393 }
1394}
1395
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001396// deleteFoldEntry() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397/*
1398 * Delete fold "idx" from growarray "gap".
1399 * When "recursive" is TRUE also delete all the folds contained in it.
1400 * When "recursive" is FALSE contained folds are moved one level up.
1401 */
1402 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001403deleteFoldEntry(garray_T *gap, int idx, int recursive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404{
1405 fold_T *fp;
1406 int i;
1407 long moved;
1408 fold_T *nfp;
1409
1410 fp = (fold_T *)gap->ga_data + idx;
1411 if (recursive || fp->fd_nested.ga_len == 0)
1412 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001413 // recursively delete the contained folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 deleteFoldRecurse(&fp->fd_nested);
1415 --gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 if (idx < gap->ga_len)
1417 mch_memmove(fp, fp + 1, sizeof(fold_T) * (gap->ga_len - idx));
1418 }
1419 else
1420 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001421 // Move nested folds one level up, to overwrite the fold that is
1422 // deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 moved = fp->fd_nested.ga_len;
1424 if (ga_grow(gap, (int)(moved - 1)) == OK)
1425 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001426 // Get "fp" again, the array may have been reallocated.
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001427 fp = (fold_T *)gap->ga_data + idx;
1428
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001429 // adjust fd_top and fd_flags for the moved folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 nfp = (fold_T *)fp->fd_nested.ga_data;
1431 for (i = 0; i < moved; ++i)
1432 {
1433 nfp[i].fd_top += fp->fd_top;
1434 if (fp->fd_flags == FD_LEVEL)
1435 nfp[i].fd_flags = FD_LEVEL;
1436 if (fp->fd_small == MAYBE)
1437 nfp[i].fd_small = MAYBE;
1438 }
1439
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001440 // move the existing folds down to make room
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001441 if (idx + 1 < gap->ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 mch_memmove(fp + moved, fp + 1,
Bram Moolenaarc9927c12011-08-26 16:13:00 +02001443 sizeof(fold_T) * (gap->ga_len - (idx + 1)));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001444 // move the contained folds one level up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 mch_memmove(fp, nfp, (size_t)(sizeof(fold_T) * moved));
1446 vim_free(nfp);
1447 gap->ga_len += moved - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 }
1449 }
1450}
1451
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001452// deleteFoldRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453/*
1454 * Delete nested folds in a fold.
1455 */
1456 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001457deleteFoldRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458{
1459 int i;
1460
1461 for (i = 0; i < gap->ga_len; ++i)
1462 deleteFoldRecurse(&(((fold_T *)(gap->ga_data))[i].fd_nested));
1463 ga_clear(gap);
1464}
1465
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001466// foldMarkAdjust() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467/*
1468 * Update line numbers of folds for inserted/deleted lines.
1469 */
1470 void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001471foldMarkAdjust(
1472 win_T *wp,
1473 linenr_T line1,
1474 linenr_T line2,
1475 long amount,
1476 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001478 // If deleting marks from line1 to line2, but not deleting all those
1479 // lines, set line2 so that only deleted lines have their folds removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 if (amount == MAXLNUM && line2 >= line1 && line2 - line1 >= -amount_after)
1481 line2 = line1 - amount_after - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001482 // If appending a line in Insert mode, it should be included in the fold
1483 // just above the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1485 --line1;
1486 foldMarkAdjustRecurse(&wp->w_folds, line1, line2, amount, amount_after);
1487}
1488
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001489// foldMarkAdjustRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001491foldMarkAdjustRecurse(
1492 garray_T *gap,
1493 linenr_T line1,
1494 linenr_T line2,
1495 long amount,
1496 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497{
1498 fold_T *fp;
1499 int i;
1500 linenr_T last;
1501 linenr_T top;
1502
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001503 // In Insert mode an inserted line at the top of a fold is considered part
1504 // of the fold, otherwise it isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 if ((State & INSERT) && amount == (linenr_T)1 && line2 == MAXLNUM)
1506 top = line1 + 1;
1507 else
1508 top = line1;
1509
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001510 // Find the fold containing or just below "line1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 (void)foldFind(gap, line1, &fp);
1512
1513 /*
1514 * Adjust all folds below "line1" that are affected.
1515 */
1516 for (i = (int)(fp - (fold_T *)gap->ga_data); i < gap->ga_len; ++i, ++fp)
1517 {
1518 /*
1519 * Check for these situations:
1520 * 1 2 3
1521 * 1 2 3
1522 * line1 2 3 4 5
1523 * 2 3 4 5
1524 * 2 3 4 5
1525 * line2 2 3 4 5
1526 * 3 5 6
1527 * 3 5 6
1528 */
1529
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001530 last = fp->fd_top + fp->fd_len - 1; // last line of fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001532 // 1. fold completely above line1: nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 if (last < line1)
1534 continue;
1535
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001536 // 6. fold below line2: only adjust for amount_after
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 if (fp->fd_top > line2)
1538 {
1539 if (amount_after == 0)
1540 break;
1541 fp->fd_top += amount_after;
1542 }
1543 else
1544 {
1545 if (fp->fd_top >= top && last <= line2)
1546 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001547 // 4. fold completely contained in range
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 if (amount == MAXLNUM)
1549 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001550 // Deleting lines: delete the fold completely
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 deleteFoldEntry(gap, i, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001552 --i; // adjust index for deletion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 --fp;
1554 }
1555 else
1556 fp->fd_top += amount;
1557 }
1558 else
1559 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 if (fp->fd_top < top)
1561 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001562 // 2 or 3: need to correct nested folds too
Bram Moolenaar194b94c2009-09-18 13:17:09 +00001563 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top,
1564 line2 - fp->fd_top, amount, amount_after);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 if (last <= line2)
1566 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001567 // 2. fold contains line1, line2 is below fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 if (amount == MAXLNUM)
1569 fp->fd_len = line1 - fp->fd_top;
1570 else
1571 fp->fd_len += amount;
1572 }
1573 else
1574 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001575 // 3. fold contains line1 and line2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 fp->fd_len += amount_after;
1577 }
1578 }
1579 else
1580 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001581 // 5. fold is below line1 and contains line2; need to
1582 // correct nested folds too
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 if (amount == MAXLNUM)
1584 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001585 foldMarkAdjustRecurse(&fp->fd_nested,
1586 line1 - fp->fd_top,
1587 line2 - fp->fd_top,
1588 amount,
1589 amount_after + (fp->fd_top - top));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 fp->fd_len -= line2 - fp->fd_top + 1;
1591 fp->fd_top = line1;
1592 }
1593 else
1594 {
Bram Moolenaar1159b162017-02-28 21:53:56 +01001595 foldMarkAdjustRecurse(&fp->fd_nested,
1596 line1 - fp->fd_top,
1597 line2 - fp->fd_top,
1598 amount,
1599 amount_after - amount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 fp->fd_len += amount_after - amount;
1601 fp->fd_top += amount;
1602 }
1603 }
1604 }
1605 }
1606 }
1607}
1608
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001609// getDeepestNesting() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610/*
1611 * Get the lowest 'foldlevel' value that makes the deepest nested fold in the
1612 * current window open.
1613 */
1614 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001615getDeepestNesting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616{
1617 checkupdate(curwin);
1618 return getDeepestNestingRecurse(&curwin->w_folds);
1619}
1620
1621 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001622getDeepestNestingRecurse(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623{
1624 int i;
1625 int level;
1626 int maxlevel = 0;
1627 fold_T *fp;
1628
1629 fp = (fold_T *)gap->ga_data;
1630 for (i = 0; i < gap->ga_len; ++i)
1631 {
1632 level = getDeepestNestingRecurse(&fp[i].fd_nested) + 1;
1633 if (level > maxlevel)
1634 maxlevel = level;
1635 }
1636
1637 return maxlevel;
1638}
1639
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001640// check_closed() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641/*
1642 * Check if a fold is closed and update the info needed to check nested folds.
1643 */
1644 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001645check_closed(
1646 win_T *win,
1647 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001648 int *use_levelp, // TRUE: outer fold had FD_LEVEL
1649 int level, // folding depth
1650 int *maybe_smallp, // TRUE: outer this had fd_small == MAYBE
1651 linenr_T lnum_off) // line number offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652{
1653 int closed = FALSE;
1654
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001655 // Check if this fold is closed. If the flag is FD_LEVEL this
1656 // fold and all folds it contains depend on 'foldlevel'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 if (*use_levelp || fp->fd_flags == FD_LEVEL)
1658 {
1659 *use_levelp = TRUE;
1660 if (level >= win->w_p_fdl)
1661 closed = TRUE;
1662 }
1663 else if (fp->fd_flags == FD_CLOSED)
1664 closed = TRUE;
1665
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001666 // Small fold isn't closed anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 if (fp->fd_small == MAYBE)
1668 *maybe_smallp = TRUE;
1669 if (closed)
1670 {
1671 if (*maybe_smallp)
1672 fp->fd_small = MAYBE;
1673 checkSmall(win, fp, lnum_off);
1674 if (fp->fd_small == TRUE)
1675 closed = FALSE;
1676 }
1677 return closed;
1678}
1679
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001680// checkSmall() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681/*
1682 * Update fd_small field of fold "fp".
1683 */
1684 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001685checkSmall(
1686 win_T *wp,
1687 fold_T *fp,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001688 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689{
1690 int count;
1691 int n;
1692
1693 if (fp->fd_small == MAYBE)
1694 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001695 // Mark any nested folds to maybe-small
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 setSmallMaybe(&fp->fd_nested);
1697
1698 if (fp->fd_len > curwin->w_p_fml)
1699 fp->fd_small = FALSE;
1700 else
1701 {
1702 count = 0;
1703 for (n = 0; n < fp->fd_len; ++n)
1704 {
1705 count += plines_win_nofold(wp, fp->fd_top + lnum_off + n);
1706 if (count > curwin->w_p_fml)
1707 {
1708 fp->fd_small = FALSE;
1709 return;
1710 }
1711 }
1712 fp->fd_small = TRUE;
1713 }
1714 }
1715}
1716
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001717// setSmallMaybe() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718/*
1719 * Set small flags in "gap" to MAYBE.
1720 */
1721 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001722setSmallMaybe(garray_T *gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723{
1724 int i;
1725 fold_T *fp;
1726
1727 fp = (fold_T *)gap->ga_data;
1728 for (i = 0; i < gap->ga_len; ++i)
1729 fp[i].fd_small = MAYBE;
1730}
1731
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001732// foldCreateMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733/*
1734 * Create a fold from line "start" to line "end" (inclusive) in the current
1735 * window by adding markers.
1736 */
1737 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001738foldCreateMarkers(linenr_T start, linenr_T end)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739{
1740 if (!curbuf->b_p_ma)
1741 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001742 emsg(_(e_modifiable));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 return;
1744 }
1745 parseMarker(curwin);
1746
1747 foldAddMarker(start, curwin->w_p_fmr, foldstartmarkerlen);
1748 foldAddMarker(end, foldendmarker, foldendmarkerlen);
1749
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001750 // Update both changes here, to avoid all folds after the start are
1751 // changed when the start marker is inserted and the end isn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 changed_lines(start, (colnr_T)0, end, 0L);
1753}
1754
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001755// foldAddMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756/*
1757 * Add "marker[markerlen]" in 'commentstring' to line "lnum".
1758 */
1759 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001760foldAddMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761{
1762 char_u *cms = curbuf->b_p_cms;
1763 char_u *line;
1764 int line_len;
1765 char_u *newline;
1766 char_u *p = (char_u *)strstr((char *)curbuf->b_p_cms, "%s");
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001767 int line_is_comment = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001769 // Allocate a new line: old-line + 'cms'-start + marker + 'cms'-end
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 line = ml_get(lnum);
1771 line_len = (int)STRLEN(line);
1772
1773 if (u_save(lnum - 1, lnum + 1) == OK)
1774 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001775 // Check if the line ends with an unclosed comment
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001776 (void)skip_comment(line, FALSE, FALSE, &line_is_comment);
Bram Moolenaar964b3742019-05-24 18:54:09 +02001777 newline = alloc(line_len + markerlen + STRLEN(cms) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 if (newline == NULL)
1779 return;
1780 STRCPY(newline, line);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001781 // Append the marker to the end of the line
Bram Moolenaar025a6b72017-03-12 20:37:21 +01001782 if (p == NULL || line_is_comment)
Bram Moolenaarce0842a2005-07-18 21:58:11 +00001783 vim_strncpy(newline + line_len, marker, markerlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 else
1785 {
1786 STRCPY(newline + line_len, cms);
1787 STRNCPY(newline + line_len + (p - cms), marker, markerlen);
1788 STRCPY(newline + line_len + (p - cms) + markerlen, p + 2);
1789 }
1790
1791 ml_replace(lnum, newline, FALSE);
1792 }
1793}
1794
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001795// deleteFoldMarkers() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796/*
1797 * Delete the markers for a fold, causing it to be deleted.
1798 */
1799 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001800deleteFoldMarkers(
1801 fold_T *fp,
1802 int recursive,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001803 linenr_T lnum_off) // offset for fp->fd_top
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804{
1805 int i;
1806
1807 if (recursive)
1808 for (i = 0; i < fp->fd_nested.ga_len; ++i)
1809 deleteFoldMarkers((fold_T *)fp->fd_nested.ga_data + i, TRUE,
1810 lnum_off + fp->fd_top);
1811 foldDelMarker(fp->fd_top + lnum_off, curwin->w_p_fmr, foldstartmarkerlen);
1812 foldDelMarker(fp->fd_top + lnum_off + fp->fd_len - 1,
1813 foldendmarker, foldendmarkerlen);
1814}
1815
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001816// foldDelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817/*
1818 * Delete marker "marker[markerlen]" at the end of line "lnum".
1819 * Delete 'commentstring' if it matches.
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001820 * If the marker is not found, there is no error message. Could be a missing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 * close-marker.
1822 */
1823 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001824foldDelMarker(linenr_T lnum, char_u *marker, int markerlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825{
1826 char_u *line;
1827 char_u *newline;
1828 char_u *p;
1829 int len;
1830 char_u *cms = curbuf->b_p_cms;
1831 char_u *cms2;
1832
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02001833 // end marker may be missing and fold extends below the last line
1834 if (lnum > curbuf->b_ml.ml_line_count)
1835 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 line = ml_get(lnum);
1837 for (p = line; *p != NUL; ++p)
1838 if (STRNCMP(p, marker, markerlen) == 0)
1839 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001840 // Found the marker, include a digit if it's there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 len = markerlen;
1842 if (VIM_ISDIGIT(p[len]))
1843 ++len;
1844 if (*cms != NUL)
1845 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001846 // Also delete 'commentstring' if it matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 cms2 = (char_u *)strstr((char *)cms, "%s");
1848 if (p - line >= cms2 - cms
1849 && STRNCMP(p - (cms2 - cms), cms, cms2 - cms) == 0
1850 && STRNCMP(p + len, cms2 + 2, STRLEN(cms2 + 2)) == 0)
1851 {
1852 p -= cms2 - cms;
1853 len += (int)STRLEN(cms) - 2;
1854 }
1855 }
1856 if (u_save(lnum - 1, lnum + 1) == OK)
1857 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001858 // Make new line: text-before-marker + text-after-marker
Bram Moolenaar964b3742019-05-24 18:54:09 +02001859 newline = alloc(STRLEN(line) - len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 if (newline != NULL)
1861 {
1862 STRNCPY(newline, line, p - line);
1863 STRCPY(newline + (p - line), p + len);
1864 ml_replace(lnum, newline, FALSE);
1865 }
1866 }
1867 break;
1868 }
1869}
1870
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001871// get_foldtext() {{{2
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001872/*
1873 * Return the text for a closed fold at line "lnum", with last line "lnume".
Bram Moolenaaree695f72016-08-03 22:08:45 +02001874 * When 'foldtext' isn't set puts the result in "buf[FOLD_TEXT_LEN]".
1875 * Otherwise the result is in allocated memory.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001876 */
1877 char_u *
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001878get_foldtext(
1879 win_T *wp,
1880 linenr_T lnum,
1881 linenr_T lnume,
1882 foldinfo_T *foldinfo,
1883 char_u *buf)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001884{
1885 char_u *text = NULL;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001886#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001887 // an error occurred when evaluating 'fdt' setting
Bram Moolenaardab38d52013-06-15 17:06:36 +02001888 static int got_fdt_error = FALSE;
1889 int save_did_emsg = did_emsg;
1890 static win_T *last_wp = NULL;
1891 static linenr_T last_lnum = 0;
1892
1893 if (last_wp != wp || last_wp == NULL
1894 || last_lnum > lnum || last_lnum == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001895 // window changed, try evaluating foldtext setting once again
Bram Moolenaardab38d52013-06-15 17:06:36 +02001896 got_fdt_error = FALSE;
1897
1898 if (!got_fdt_error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001899 // a previous error should not abort evaluating 'foldexpr'
Bram Moolenaardab38d52013-06-15 17:06:36 +02001900 did_emsg = FALSE;
1901
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001902 if (*wp->w_p_fdt != NUL)
1903 {
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001904 char_u dashes[MAX_LEVEL + 2];
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001905 win_T *save_curwin;
1906 int level;
1907 char_u *p;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001908
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001909 // Set "v:foldstart" and "v:foldend".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001910 set_vim_var_nr(VV_FOLDSTART, lnum);
1911 set_vim_var_nr(VV_FOLDEND, lnume);
1912
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001913 // Set "v:folddashes" to a string of "level" dashes.
1914 // Set "v:foldlevel" to "level".
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001915 level = foldinfo->fi_level;
Bram Moolenaar5b88ba42009-11-03 15:30:12 +00001916 if (level > (int)sizeof(dashes) - 1)
1917 level = (int)sizeof(dashes) - 1;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001918 vim_memset(dashes, '-', (size_t)level);
1919 dashes[level] = NUL;
1920 set_vim_var_string(VV_FOLDDASHES, dashes, -1);
1921 set_vim_var_nr(VV_FOLDLEVEL, (long)level);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001922
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001923 // skip evaluating foldtext on errors
Bram Moolenaardab38d52013-06-15 17:06:36 +02001924 if (!got_fdt_error)
1925 {
1926 save_curwin = curwin;
1927 curwin = wp;
1928 curbuf = wp->w_buffer;
1929
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001930 ++emsg_silent; // handle exceptions, but don't display errors
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001931 text = eval_to_string_safe(wp->w_p_fdt,
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001932 was_set_insecurely((char_u *)"foldtext", OPT_LOCAL));
Bram Moolenaardab38d52013-06-15 17:06:36 +02001933 --emsg_silent;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001934
Bram Moolenaardab38d52013-06-15 17:06:36 +02001935 if (text == NULL || did_emsg)
1936 got_fdt_error = TRUE;
1937
1938 curwin = save_curwin;
1939 curbuf = curwin->w_buffer;
1940 }
1941 last_lnum = lnum;
1942 last_wp = wp;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001943 set_vim_var_string(VV_FOLDDASHES, NULL, -1);
1944
Bram Moolenaardab38d52013-06-15 17:06:36 +02001945 if (!did_emsg && save_did_emsg)
1946 did_emsg = save_did_emsg;
1947
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001948 if (text != NULL)
1949 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001950 // Replace unprintable characters, if there are any. But
1951 // replace a TAB with a space.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001952 for (p = text; *p != NUL; ++p)
1953 {
Bram Moolenaar009b2592004-10-24 19:18:58 +00001954 int len;
1955
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001956 if (has_mbyte && (len = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001957 {
1958 if (!vim_isprintc((*mb_ptr2char)(p)))
1959 break;
1960 p += len - 1;
1961 }
1962 else
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001963 if (*p == TAB)
1964 *p = ' ';
1965 else if (ptr2cells(p) > 1)
1966 break;
1967 }
1968 if (*p != NUL)
1969 {
1970 p = transstr(text);
1971 vim_free(text);
1972 text = p;
1973 }
1974 }
1975 }
1976 if (text == NULL)
1977#endif
1978 {
Bram Moolenaaree695f72016-08-03 22:08:45 +02001979 long count = (long)(lnume - lnum + 1);
1980
1981 vim_snprintf((char *)buf, FOLD_TEXT_LEN,
Bram Moolenaar1c465442017-03-12 20:10:05 +01001982 NGETTEXT("+--%3ld line folded ",
Bram Moolenaaree695f72016-08-03 22:08:45 +02001983 "+--%3ld lines folded ", count),
1984 count);
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001985 text = buf;
1986 }
1987 return text;
1988}
1989
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001990// foldtext_cleanup() {{{2
Bram Moolenaardb022f32019-09-01 17:52:32 +02001991#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992/*
1993 * Remove 'foldmarker' and 'commentstring' from "str" (in-place).
1994 */
Bram Moolenaardb022f32019-09-01 17:52:32 +02001995 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01001996foldtext_cleanup(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001998 char_u *cms_start; // first part or the whole comment
1999 int cms_slen = 0; // length of cms_start
2000 char_u *cms_end; // last part of the comment or NULL
2001 int cms_elen = 0; // length of cms_end
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 char_u *s;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002003 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 int len;
2005 int did1 = FALSE;
2006 int did2 = FALSE;
2007
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002008 // Ignore leading and trailing white space in 'commentstring'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 cms_start = skipwhite(curbuf->b_p_cms);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002010 cms_slen = (int)STRLEN(cms_start);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002011 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 --cms_slen;
2013
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002014 // locate "%s" in 'commentstring', use the part before and after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 cms_end = (char_u *)strstr((char *)cms_start, "%s");
2016 if (cms_end != NULL)
2017 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002018 cms_elen = cms_slen - (int)(cms_end - cms_start);
2019 cms_slen = (int)(cms_end - cms_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002021 // exclude white space before "%s"
Bram Moolenaar1c465442017-03-12 20:10:05 +01002022 while (cms_slen > 0 && VIM_ISWHITE(cms_start[cms_slen - 1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 --cms_slen;
2024
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002025 // skip "%s" and white space after it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 s = skipwhite(cms_end + 2);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002027 cms_elen -= (int)(s - cms_end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 cms_end = s;
2029 }
2030 parseMarker(curwin);
2031
2032 for (s = str; *s != NUL; )
2033 {
2034 len = 0;
2035 if (STRNCMP(s, curwin->w_p_fmr, foldstartmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 len = foldstartmarkerlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 else if (STRNCMP(s, foldendmarker, foldendmarkerlen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 len = foldendmarkerlen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002039 if (len > 0)
2040 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 if (VIM_ISDIGIT(s[len]))
2042 ++len;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002043
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002044 // May remove 'commentstring' start. Useful when it's a double
2045 // quote and we already removed a double quote.
Bram Moolenaar1c465442017-03-12 20:10:05 +01002046 for (p = s; p > str && VIM_ISWHITE(p[-1]); --p)
Bram Moolenaardef9e822004-12-31 20:58:58 +00002047 ;
2048 if (p >= str + cms_slen
2049 && STRNCMP(p - cms_slen, cms_start, cms_slen) == 0)
2050 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002051 len += (int)(s - p) + cms_slen;
Bram Moolenaardef9e822004-12-31 20:58:58 +00002052 s = p - cms_slen;
2053 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 }
2055 else if (cms_end != NULL)
2056 {
Bram Moolenaardef9e822004-12-31 20:58:58 +00002057 if (!did1 && cms_slen > 0 && STRNCMP(s, cms_start, cms_slen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 {
2059 len = cms_slen;
2060 did1 = TRUE;
2061 }
Bram Moolenaardef9e822004-12-31 20:58:58 +00002062 else if (!did2 && cms_elen > 0
2063 && STRNCMP(s, cms_end, cms_elen) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 {
2065 len = cms_elen;
2066 did2 = TRUE;
2067 }
2068 }
2069 if (len != 0)
2070 {
Bram Moolenaar1c465442017-03-12 20:10:05 +01002071 while (VIM_ISWHITE(s[len]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 ++len;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002073 STRMOVE(s, s + len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 }
2075 else
2076 {
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002077 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 }
2079 }
2080}
Bram Moolenaardb022f32019-09-01 17:52:32 +02002081#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002083// Folding by indent, expr, marker and syntax. {{{1
2084// Define "fline_T", passed to get fold level for a line. {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085typedef struct
2086{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002087 win_T *wp; // window
2088 linenr_T lnum; // current line number
2089 linenr_T off; // offset between lnum and real line number
2090 linenr_T lnum_save; // line nr used by foldUpdateIEMSRecurse()
2091 int lvl; // current level (-1 for undefined)
2092 int lvl_next; // level used for next line
2093 int start; // number of folds that are forced to start at
2094 // this line.
2095 int end; // level of fold that is forced to end below
2096 // this line
2097 int had_end; // level of fold that is forced to end above
2098 // this line (copy of "end" of prev. line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099} fline_T;
2100
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002101// Flag is set when redrawing is needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102static int fold_changed;
2103
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002104// Function declarations. {{{2
Bram Moolenaard99df422016-01-29 23:20:40 +01002105static 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 +01002106static int foldInsert(garray_T *gap, int i);
2107static void foldSplit(garray_T *gap, int i, linenr_T top, linenr_T bot);
2108static void foldRemove(garray_T *gap, linenr_T top, linenr_T bot);
2109static void foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2);
2110static void foldlevelIndent(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111#ifdef FEAT_DIFF
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002112static void foldlevelDiff(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113#endif
Bram Moolenaard25c16e2016-01-29 22:13:30 +01002114static void foldlevelExpr(fline_T *flp);
2115static void foldlevelMarker(fline_T *flp);
2116static void foldlevelSyntax(fline_T *flp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002118// foldUpdateIEMS() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119/*
2120 * Update the folding for window "wp", at least from lines "top" to "bot".
2121 * Return TRUE if any folds did change.
2122 */
2123 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002124foldUpdateIEMS(win_T *wp, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125{
2126 linenr_T start;
2127 linenr_T end;
2128 fline_T fline;
Bram Moolenaard99df422016-01-29 23:20:40 +01002129 void (*getlevel)(fline_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 int level;
2131 fold_T *fp;
2132
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002133 // Avoid problems when being called recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 if (invalid_top != (linenr_T)0)
2135 return;
2136
2137 if (wp->w_foldinvalid)
2138 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002139 // Need to update all folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 top = 1;
2141 bot = wp->w_buffer->b_ml.ml_line_count;
2142 wp->w_foldinvalid = FALSE;
2143
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002144 // Mark all folds a maybe-small.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 setSmallMaybe(&wp->w_folds);
2146 }
2147
2148#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002149 // add the context for "diff" folding
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 if (foldmethodIsDiff(wp))
2151 {
2152 if (top > diff_context)
2153 top -= diff_context;
2154 else
2155 top = 1;
2156 bot += diff_context;
2157 }
2158#endif
2159
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002160 // When deleting lines at the end of the buffer "top" can be past the end
2161 // of the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 if (top > wp->w_buffer->b_ml.ml_line_count)
2163 top = wp->w_buffer->b_ml.ml_line_count;
2164
2165 fold_changed = FALSE;
2166 fline.wp = wp;
2167 fline.off = 0;
2168 fline.lvl = 0;
2169 fline.lvl_next = -1;
2170 fline.start = 0;
2171 fline.end = MAX_LEVEL + 1;
2172 fline.had_end = MAX_LEVEL + 1;
2173
2174 invalid_top = top;
2175 invalid_bot = bot;
2176
2177 if (foldmethodIsMarker(wp))
2178 {
2179 getlevel = foldlevelMarker;
2180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002181 // Init marker variables to speed up foldlevelMarker().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 parseMarker(wp);
2183
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002184 // Need to get the level of the line above top, it is used if there is
2185 // no marker at the top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 if (top > 1)
2187 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002188 // Get the fold level at top - 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 level = foldLevelWin(wp, top - 1);
2190
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002191 // The fold may end just above the top, check for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 fline.lnum = top - 1;
2193 fline.lvl = level;
2194 getlevel(&fline);
2195
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002196 // If a fold started here, we already had the level, if it stops
2197 // here, we need to use lvl_next. Could also start and end a fold
2198 // in the same line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 if (fline.lvl > level)
2200 fline.lvl = level - (fline.lvl - fline.lvl_next);
2201 else
2202 fline.lvl = fline.lvl_next;
2203 }
2204 fline.lnum = top;
2205 getlevel(&fline);
2206 }
2207 else
2208 {
2209 fline.lnum = top;
2210 if (foldmethodIsExpr(wp))
2211 {
2212 getlevel = foldlevelExpr;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002213 // start one line back, because a "<1" may indicate the end of a
2214 // fold in the topline
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 if (top > 1)
2216 --fline.lnum;
2217 }
2218 else if (foldmethodIsSyntax(wp))
2219 getlevel = foldlevelSyntax;
2220#ifdef FEAT_DIFF
2221 else if (foldmethodIsDiff(wp))
2222 getlevel = foldlevelDiff;
2223#endif
2224 else
2225 getlevel = foldlevelIndent;
2226
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002227 // Backup to a line for which the fold level is defined. Since it's
2228 // always defined for line one, we will stop there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 fline.lvl = -1;
2230 for ( ; !got_int; --fline.lnum)
2231 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002232 // Reset lvl_next each time, because it will be set to a value for
2233 // the next line, but we search backwards here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 fline.lvl_next = -1;
2235 getlevel(&fline);
2236 if (fline.lvl >= 0)
2237 break;
2238 }
2239 }
2240
Bram Moolenaarec986472009-11-03 13:46:54 +00002241 /*
2242 * If folding is defined by the syntax, it is possible that a change in
2243 * one line will cause all sub-folds of the current fold to change (e.g.,
2244 * closing a C-style comment can cause folds in the subsequent lines to
2245 * appear). To take that into account we should adjust the value of "bot"
2246 * to point to the end of the current fold:
2247 */
2248 if (foldlevelSyntax == getlevel)
2249 {
2250 garray_T *gap = &wp->w_folds;
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002251 fold_T *fpn = NULL;
Bram Moolenaarec986472009-11-03 13:46:54 +00002252 int current_fdl = 0;
2253 linenr_T fold_start_lnum = 0;
2254 linenr_T lnum_rel = fline.lnum;
2255
2256 while (current_fdl < fline.lvl)
2257 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002258 if (!foldFind(gap, lnum_rel, &fpn))
Bram Moolenaarec986472009-11-03 13:46:54 +00002259 break;
2260 ++current_fdl;
2261
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002262 fold_start_lnum += fpn->fd_top;
2263 gap = &fpn->fd_nested;
2264 lnum_rel -= fpn->fd_top;
Bram Moolenaarec986472009-11-03 13:46:54 +00002265 }
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002266 if (fpn != NULL && current_fdl == fline.lvl)
Bram Moolenaarec986472009-11-03 13:46:54 +00002267 {
Bram Moolenaarf506c5b2010-06-22 06:28:58 +02002268 linenr_T fold_end_lnum = fold_start_lnum + fpn->fd_len;
Bram Moolenaarec986472009-11-03 13:46:54 +00002269
2270 if (fold_end_lnum > bot)
2271 bot = fold_end_lnum;
2272 }
2273 }
2274
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 start = fline.lnum;
2276 end = bot;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002277 // Do at least one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 if (start > end && end < wp->w_buffer->b_ml.ml_line_count)
2279 end = start;
2280 while (!got_int)
2281 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002282 // Always stop at the end of the file ("end" can be past the end of
2283 // the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 if (fline.lnum > wp->w_buffer->b_ml.ml_line_count)
2285 break;
2286 if (fline.lnum > end)
2287 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002288 // For "marker", "expr" and "syntax" methods: If a change caused
2289 // a fold to be removed, we need to continue at least until where
2290 // it ended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 if (getlevel != foldlevelMarker
2292 && getlevel != foldlevelSyntax
2293 && getlevel != foldlevelExpr)
2294 break;
2295 if ((start <= end
2296 && foldFind(&wp->w_folds, end, &fp)
2297 && fp->fd_top + fp->fd_len - 1 > end)
2298 || (fline.lvl == 0
2299 && foldFind(&wp->w_folds, fline.lnum, &fp)
2300 && fp->fd_top < fline.lnum))
2301 end = fp->fd_top + fp->fd_len - 1;
2302 else if (getlevel == foldlevelSyntax
2303 && foldLevelWin(wp, fline.lnum) != fline.lvl)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002304 // For "syntax" method: Compare the foldlevel that the syntax
2305 // tells us to the foldlevel from the existing folds. If they
2306 // don't match continue updating folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 end = fline.lnum;
2308 else
2309 break;
2310 }
2311
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002312 // A level 1 fold starts at a line with foldlevel > 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 if (fline.lvl > 0)
2314 {
2315 invalid_top = fline.lnum;
2316 invalid_bot = end;
2317 end = foldUpdateIEMSRecurse(&wp->w_folds,
2318 1, start, &fline, getlevel, end, FD_LEVEL);
2319 start = fline.lnum;
2320 }
2321 else
2322 {
2323 if (fline.lnum == wp->w_buffer->b_ml.ml_line_count)
2324 break;
2325 ++fline.lnum;
2326 fline.lvl = fline.lvl_next;
2327 getlevel(&fline);
2328 }
2329 }
2330
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002331 // There can't be any folds from start until end now.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 foldRemove(&wp->w_folds, start, end);
2333
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002334 // If some fold changed, need to redraw and position cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 if (fold_changed && wp->w_p_fen)
Bram Moolenaare3b3f282008-03-06 21:45:49 +00002336 changed_window_setting_win(wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002338 // If we updated folds past "bot", need to redraw more lines. Don't do
2339 // this in other situations, the changed lines will be redrawn anyway and
2340 // this method can cause the whole window to be updated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 if (end != bot)
2342 {
2343 if (wp->w_redraw_top == 0 || wp->w_redraw_top > top)
2344 wp->w_redraw_top = top;
2345 if (wp->w_redraw_bot < end)
2346 wp->w_redraw_bot = end;
2347 }
2348
2349 invalid_top = (linenr_T)0;
2350}
2351
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002352// foldUpdateIEMSRecurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353/*
2354 * Update a fold that starts at "flp->lnum". At this line there is always a
2355 * valid foldlevel, and its level >= "level".
2356 * "flp" is valid for "flp->lnum" when called and it's valid when returning.
2357 * "flp->lnum" is set to the lnum just below the fold, if it ends before
2358 * "bot", it's "bot" plus one if the fold continues and it's bigger when using
2359 * the marker method and a text change made following folds to change.
2360 * When returning, "flp->lnum_save" is the line number that was used to get
2361 * the level when the level at "flp->lnum" is invalid.
2362 * Remove any folds from "startlnum" up to here at this level.
2363 * Recursively update nested folds.
2364 * Below line "bot" there are no changes in the text.
2365 * "flp->lnum", "flp->lnum_save" and "bot" are relative to the start of the
2366 * outer fold.
2367 * "flp->off" is the offset to the real line number in the buffer.
2368 *
2369 * All this would be a lot simpler if all folds in the range would be deleted
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002370 * and then created again. But we would lose all information about the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 * folds, even when making changes that don't affect the folding (e.g. "vj~").
2372 *
2373 * Returns bot, which may have been increased for lines that also need to be
2374 * updated as a result of a detected change in the fold.
2375 */
2376 static linenr_T
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002377foldUpdateIEMSRecurse(
2378 garray_T *gap,
2379 int level,
2380 linenr_T startlnum,
2381 fline_T *flp,
2382 void (*getlevel)(fline_T *),
2383 linenr_T bot,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002384 int topflags) // flags used by containing fold
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 linenr_T ll;
2387 fold_T *fp = NULL;
2388 fold_T *fp2;
2389 int lvl = level;
2390 linenr_T startlnum2 = startlnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002391 linenr_T firstlnum = flp->lnum; // first lnum we got
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 int i;
2393 int finish = FALSE;
2394 linenr_T linecount = flp->wp->w_buffer->b_ml.ml_line_count - flp->off;
2395 int concat;
2396
2397 /*
2398 * If using the marker method, the start line is not the start of a fold
2399 * at the level we're dealing with and the level is non-zero, we must use
2400 * the previous fold. But ignore a fold that starts at or below
2401 * startlnum, it must be deleted.
2402 */
2403 if (getlevel == foldlevelMarker && flp->start <= flp->lvl - level
2404 && flp->lvl > 0)
2405 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002406 (void)foldFind(gap, startlnum - 1, &fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 if (fp >= ((fold_T *)gap->ga_data) + gap->ga_len
2408 || fp->fd_top >= startlnum)
2409 fp = NULL;
2410 }
2411
2412 /*
2413 * Loop over all lines in this fold, or until "bot" is hit.
2414 * Handle nested folds inside of this fold.
2415 * "flp->lnum" is the current line. When finding the end of the fold, it
2416 * is just below the end of the fold.
2417 * "*flp" contains the level of the line "flp->lnum" or a following one if
2418 * there are lines with an invalid fold level. "flp->lnum_save" is the
2419 * line number that was used to get the fold level (below "flp->lnum" when
2420 * it has an invalid fold level). When called the fold level is always
2421 * valid, thus "flp->lnum_save" is equal to "flp->lnum".
2422 */
2423 flp->lnum_save = flp->lnum;
2424 while (!got_int)
2425 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002426 // Updating folds can be slow, check for CTRL-C.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 line_breakcheck();
2428
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002429 // Set "lvl" to the level of line "flp->lnum". When flp->start is set
2430 // and after the first line of the fold, set the level to zero to
2431 // force the fold to end. Do the same when had_end is set: Previous
2432 // line was marked as end of a fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 lvl = flp->lvl;
2434 if (lvl > MAX_LEVEL)
2435 lvl = MAX_LEVEL;
2436 if (flp->lnum > firstlnum
2437 && (level > lvl - flp->start || level >= flp->had_end))
2438 lvl = 0;
2439
2440 if (flp->lnum > bot && !finish && fp != NULL)
2441 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002442 // For "marker" and "syntax" methods:
2443 // - If a change caused a nested fold to be removed, we need to
2444 // delete it and continue at least until where it ended.
2445 // - If a change caused a nested fold to be created, or this fold
2446 // to continue below its original end, need to finish this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 if (getlevel != foldlevelMarker
2448 && getlevel != foldlevelExpr
2449 && getlevel != foldlevelSyntax)
2450 break;
2451 i = 0;
2452 fp2 = fp;
2453 if (lvl >= level)
2454 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002455 // Compute how deep the folds currently are, if it's deeper
2456 // than "lvl" then some must be deleted, need to update
2457 // at least one nested fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 ll = flp->lnum - fp->fd_top;
2459 while (foldFind(&fp2->fd_nested, ll, &fp2))
2460 {
2461 ++i;
2462 ll -= fp2->fd_top;
2463 }
2464 }
2465 if (lvl < level + i)
2466 {
Bram Moolenaarcde88542015-08-11 19:14:00 +02002467 (void)foldFind(&fp->fd_nested, flp->lnum - fp->fd_top, &fp2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 if (fp2 != NULL)
2469 bot = fp2->fd_top + fp2->fd_len - 1 + fp->fd_top;
2470 }
2471 else if (fp->fd_top + fp->fd_len <= flp->lnum && lvl >= level)
2472 finish = TRUE;
2473 else
2474 break;
2475 }
2476
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002477 // At the start of the first nested fold and at the end of the current
2478 // fold: check if existing folds at this level, before the current
2479 // one, need to be deleted or truncated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 if (fp == NULL
2481 && (lvl != level
2482 || flp->lnum_save >= bot
2483 || flp->start != 0
2484 || flp->had_end <= MAX_LEVEL
2485 || flp->lnum == linecount))
2486 {
2487 /*
2488 * Remove or update folds that have lines between startlnum and
2489 * firstlnum.
2490 */
2491 while (!got_int)
2492 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002493 // set concat to 1 if it's allowed to concatenated this fold
2494 // with a previous one that touches it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 if (flp->start != 0 || flp->had_end <= MAX_LEVEL)
2496 concat = 0;
2497 else
2498 concat = 1;
2499
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002500 // Find an existing fold to re-use. Preferably one that
2501 // includes startlnum, otherwise one that ends just before
2502 // startlnum or starts after it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 if (foldFind(gap, startlnum, &fp)
2504 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2505 && fp->fd_top <= firstlnum)
2506 || foldFind(gap, firstlnum - concat, &fp)
2507 || (fp < ((fold_T *)gap->ga_data) + gap->ga_len
2508 && ((lvl < level && fp->fd_top < flp->lnum)
2509 || (lvl >= level
2510 && fp->fd_top <= flp->lnum_save))))
2511 {
2512 if (fp->fd_top + fp->fd_len + concat > firstlnum)
2513 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002514 // Use existing fold for the new fold. If it starts
2515 // before where we started looking, extend it. If it
2516 // starts at another line, update nested folds to keep
2517 // their position, compensating for the new fd_top.
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002518 if (fp->fd_top == firstlnum)
2519 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002520 // have found a fold beginning where we want
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002521 }
2522 else if (fp->fd_top >= startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 {
2524 if (fp->fd_top > firstlnum)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002525 // like lines are inserted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 foldMarkAdjustRecurse(&fp->fd_nested,
2527 (linenr_T)0, (linenr_T)MAXLNUM,
2528 (long)(fp->fd_top - firstlnum), 0L);
2529 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002530 // like lines are deleted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 foldMarkAdjustRecurse(&fp->fd_nested,
2532 (linenr_T)0,
2533 (long)(firstlnum - fp->fd_top - 1),
2534 (linenr_T)MAXLNUM,
2535 (long)(fp->fd_top - firstlnum));
2536 fp->fd_len += fp->fd_top - firstlnum;
2537 fp->fd_top = firstlnum;
2538 fold_changed = TRUE;
2539 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002540 else if ((flp->start != 0 && lvl == level)
2541 || firstlnum != startlnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 {
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002543 linenr_T breakstart;
2544 linenr_T breakend;
2545
2546 /*
2547 * Before there was a fold spanning from above
2548 * startlnum to below firstlnum. This fold is valid
2549 * above startlnum (because we are not updating
2550 * that range), but there should now be a break in
2551 * it.
2552 * If the break is because we are now forced to
2553 * start a new fold at the level "level" at line
2554 * fline->lnum, then we need to split the fold at
2555 * fline->lnum.
2556 * If the break is because the range
2557 * [startlnum, firstlnum) is now at a lower indent
2558 * than "level", we need to split the fold in this
2559 * range.
2560 * Any splits have to be done recursively.
2561 */
2562 if (firstlnum != startlnum)
2563 {
2564 breakstart = startlnum;
2565 breakend = firstlnum;
2566 }
2567 else
2568 {
2569 breakstart = flp->lnum;
2570 breakend = flp->lnum;
2571 }
2572 foldRemove(&fp->fd_nested, breakstart - fp->fd_top,
2573 breakend - fp->fd_top);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 i = (int)(fp - (fold_T *)gap->ga_data);
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002575 foldSplit(gap, i, breakstart, breakend - 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 fp = (fold_T *)gap->ga_data + i + 1;
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002577
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002578 // If using the "marker" or "syntax" method, we
2579 // need to continue until the end of the fold is
2580 // found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 if (getlevel == foldlevelMarker
2582 || getlevel == foldlevelExpr
2583 || getlevel == foldlevelSyntax)
2584 finish = TRUE;
2585 }
Bram Moolenaareadbc2b2017-03-04 18:42:39 +01002586
2587 if (fp->fd_top == startlnum && concat)
2588 {
2589 i = (int)(fp - (fold_T *)gap->ga_data);
2590 if (i != 0)
2591 {
2592 fp2 = fp - 1;
2593 if (fp2->fd_top + fp2->fd_len == fp->fd_top)
2594 {
2595 foldMerge(fp2, gap, fp);
2596 fp = fp2;
2597 }
2598 }
2599 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 break;
2601 }
2602 if (fp->fd_top >= startlnum)
2603 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002604 // A fold that starts at or after startlnum and stops
2605 // before the new fold must be deleted. Continue
2606 // looking for the next one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 deleteFoldEntry(gap,
2608 (int)(fp - (fold_T *)gap->ga_data), TRUE);
2609 }
2610 else
2611 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002612 // A fold has some lines above startlnum, truncate it
2613 // to stop just above startlnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 fp->fd_len = startlnum - fp->fd_top;
2615 foldMarkAdjustRecurse(&fp->fd_nested,
2616 (linenr_T)fp->fd_len, (linenr_T)MAXLNUM,
2617 (linenr_T)MAXLNUM, 0L);
2618 fold_changed = TRUE;
2619 }
2620 }
2621 else
2622 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002623 // Insert new fold. Careful: ga_data may be NULL and it
2624 // may change!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 i = (int)(fp - (fold_T *)gap->ga_data);
2626 if (foldInsert(gap, i) != OK)
2627 return bot;
2628 fp = (fold_T *)gap->ga_data + i;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002629 // The new fold continues until bot, unless we find the
2630 // end earlier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 fp->fd_top = firstlnum;
2632 fp->fd_len = bot - firstlnum + 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002633 // When the containing fold is open, the new fold is open.
2634 // The new fold is closed if the fold above it is closed.
2635 // The first fold depends on the containing fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 if (topflags == FD_OPEN)
2637 {
2638 flp->wp->w_fold_manual = TRUE;
2639 fp->fd_flags = FD_OPEN;
2640 }
2641 else if (i <= 0)
2642 {
2643 fp->fd_flags = topflags;
2644 if (topflags != FD_LEVEL)
2645 flp->wp->w_fold_manual = TRUE;
2646 }
2647 else
2648 fp->fd_flags = (fp - 1)->fd_flags;
2649 fp->fd_small = MAYBE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002650 // If using the "marker", "expr" or "syntax" method, we
2651 // need to continue until the end of the fold is found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 if (getlevel == foldlevelMarker
2653 || getlevel == foldlevelExpr
2654 || getlevel == foldlevelSyntax)
2655 finish = TRUE;
2656 fold_changed = TRUE;
2657 break;
2658 }
2659 }
2660 }
2661
2662 if (lvl < level || flp->lnum > linecount)
2663 {
2664 /*
2665 * Found a line with a lower foldlevel, this fold ends just above
2666 * "flp->lnum".
2667 */
2668 break;
2669 }
2670
2671 /*
2672 * The fold includes the line "flp->lnum" and "flp->lnum_save".
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002673 * Check "fp" for safety.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002675 if (lvl > level && fp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 {
2677 /*
2678 * There is a nested fold, handle it recursively.
2679 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002680 // At least do one line (can happen when finish is TRUE).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 if (bot < flp->lnum)
2682 bot = flp->lnum;
2683
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002684 // Line numbers in the nested fold are relative to the start of
2685 // this fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 flp->lnum = flp->lnum_save - fp->fd_top;
2687 flp->off += fp->fd_top;
2688 i = (int)(fp - (fold_T *)gap->ga_data);
2689 bot = foldUpdateIEMSRecurse(&fp->fd_nested, level + 1,
2690 startlnum2 - fp->fd_top, flp, getlevel,
2691 bot - fp->fd_top, fp->fd_flags);
2692 fp = (fold_T *)gap->ga_data + i;
2693 flp->lnum += fp->fd_top;
2694 flp->lnum_save += fp->fd_top;
2695 flp->off -= fp->fd_top;
2696 bot += fp->fd_top;
2697 startlnum2 = flp->lnum;
2698
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002699 // This fold may end at the same line, don't incr. flp->lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 }
2701 else
2702 {
2703 /*
2704 * Get the level of the next line, then continue the loop to check
2705 * if it ends there.
2706 * Skip over undefined lines, to find the foldlevel after it.
2707 * For the last line in the file the foldlevel is always valid.
2708 */
2709 flp->lnum = flp->lnum_save;
2710 ll = flp->lnum + 1;
2711 while (!got_int)
2712 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002713 // Make the previous level available to foldlevel().
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 prev_lnum = flp->lnum;
2715 prev_lnum_lvl = flp->lvl;
2716
2717 if (++flp->lnum > linecount)
2718 break;
2719 flp->lvl = flp->lvl_next;
2720 getlevel(flp);
2721 if (flp->lvl >= 0 || flp->had_end <= MAX_LEVEL)
2722 break;
2723 }
2724 prev_lnum = 0;
2725 if (flp->lnum > linecount)
2726 break;
2727
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002728 // leave flp->lnum_save to lnum of the line that was used to get
2729 // the level, flp->lnum to the lnum of the next line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 flp->lnum_save = flp->lnum;
2731 flp->lnum = ll;
2732 }
2733 }
2734
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002735 if (fp == NULL) // only happens when got_int is set
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 return bot;
2737
2738 /*
2739 * Get here when:
2740 * lvl < level: the folds ends just above "flp->lnum"
2741 * lvl >= level: fold continues below "bot"
2742 */
2743
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002744 // Current fold at least extends until lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 if (fp->fd_len < flp->lnum - fp->fd_top)
2746 {
2747 fp->fd_len = flp->lnum - fp->fd_top;
Bram Moolenaaref6fc092008-01-13 20:58:13 +00002748 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 fold_changed = TRUE;
2750 }
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002751 else if (fp->fd_top + fp->fd_len > linecount)
2752 // running into the end of the buffer (deleted last line)
2753 fp->fd_len = linecount - fp->fd_top + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
Bram Moolenaar9a4a8c42019-08-19 22:48:30 +02002755 // Delete contained folds from the end of the last one found until where
2756 // we stopped looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 foldRemove(&fp->fd_nested, startlnum2 - fp->fd_top,
2758 flp->lnum - 1 - fp->fd_top);
2759
2760 if (lvl < level)
2761 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002762 // End of fold found, update the length when it got shorter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 if (fp->fd_len != flp->lnum - fp->fd_top)
2764 {
Bram Moolenaar9d20ce62017-03-23 21:53:35 +01002765 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002767 // fold continued below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 if (getlevel == foldlevelMarker
2769 || getlevel == foldlevelExpr
2770 || getlevel == foldlevelSyntax)
2771 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002772 // marker method: truncate the fold and make sure the
2773 // previously included lines are processed again
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 bot = fp->fd_top + fp->fd_len - 1;
2775 fp->fd_len = flp->lnum - fp->fd_top;
2776 }
2777 else
2778 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002779 // indent or expr method: split fold to create a new one
2780 // below bot
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 i = (int)(fp - (fold_T *)gap->ga_data);
2782 foldSplit(gap, i, flp->lnum, bot);
2783 fp = (fold_T *)gap->ga_data + i;
2784 }
2785 }
2786 else
2787 fp->fd_len = flp->lnum - fp->fd_top;
2788 fold_changed = TRUE;
2789 }
2790 }
2791
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002792 // delete following folds that end before the current line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 for (;;)
2794 {
2795 fp2 = fp + 1;
2796 if (fp2 >= (fold_T *)gap->ga_data + gap->ga_len
2797 || fp2->fd_top > flp->lnum)
2798 break;
2799 if (fp2->fd_top + fp2->fd_len > flp->lnum)
2800 {
2801 if (fp2->fd_top < flp->lnum)
2802 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002803 // Make fold that includes lnum start at lnum.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 foldMarkAdjustRecurse(&fp2->fd_nested,
2805 (linenr_T)0, (long)(flp->lnum - fp2->fd_top - 1),
2806 (linenr_T)MAXLNUM, (long)(fp2->fd_top - flp->lnum));
2807 fp2->fd_len -= flp->lnum - fp2->fd_top;
2808 fp2->fd_top = flp->lnum;
2809 fold_changed = TRUE;
2810 }
2811
2812 if (lvl >= level)
2813 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002814 // merge new fold with existing fold that follows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 foldMerge(fp, gap, fp2);
2816 }
2817 break;
2818 }
2819 fold_changed = TRUE;
2820 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
2821 }
2822
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002823 // Need to redraw the lines we inspected, which might be further down than
2824 // was asked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 if (bot < flp->lnum - 1)
2826 bot = flp->lnum - 1;
2827
2828 return bot;
2829}
2830
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002831// foldInsert() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832/*
2833 * Insert a new fold in "gap" at position "i".
2834 * Returns OK for success, FAIL for failure.
2835 */
2836 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002837foldInsert(garray_T *gap, int i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838{
2839 fold_T *fp;
2840
2841 if (ga_grow(gap, 1) != OK)
2842 return FAIL;
2843 fp = (fold_T *)gap->ga_data + i;
2844 if (i < gap->ga_len)
2845 mch_memmove(fp + 1, fp, sizeof(fold_T) * (gap->ga_len - i));
2846 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 ga_init2(&fp->fd_nested, (int)sizeof(fold_T), 10);
2848 return OK;
2849}
2850
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002851// foldSplit() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852/*
2853 * Split the "i"th fold in "gap", which starts before "top" and ends below
2854 * "bot" in two pieces, one ending above "top" and the other starting below
2855 * "bot".
2856 * The caller must first have taken care of any nested folds from "top" to
2857 * "bot"!
2858 */
2859 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002860foldSplit(
2861 garray_T *gap,
2862 int i,
2863 linenr_T top,
2864 linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865{
2866 fold_T *fp;
2867 fold_T *fp2;
2868 garray_T *gap1;
2869 garray_T *gap2;
2870 int idx;
2871 int len;
2872
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002873 // The fold continues below bot, need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 if (foldInsert(gap, i + 1) == FAIL)
2875 return;
2876 fp = (fold_T *)gap->ga_data + i;
2877 fp[1].fd_top = bot + 1;
2878 fp[1].fd_len = fp->fd_len - (fp[1].fd_top - fp->fd_top);
2879 fp[1].fd_flags = fp->fd_flags;
Bram Moolenaareda6eb92009-11-03 17:04:43 +00002880 fp[1].fd_small = MAYBE;
2881 fp->fd_small = MAYBE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002883 // Move nested folds below bot to new fold. There can't be
2884 // any between top and bot, they have been removed by the caller.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 gap1 = &fp->fd_nested;
2886 gap2 = &fp[1].fd_nested;
2887 (void)(foldFind(gap1, bot + 1 - fp->fd_top, &fp2));
2888 len = (int)((fold_T *)gap1->ga_data + gap1->ga_len - fp2);
2889 if (len > 0 && ga_grow(gap2, len) == OK)
2890 {
2891 for (idx = 0; idx < len; ++idx)
2892 {
2893 ((fold_T *)gap2->ga_data)[idx] = fp2[idx];
2894 ((fold_T *)gap2->ga_data)[idx].fd_top
2895 -= fp[1].fd_top - fp->fd_top;
2896 }
2897 gap2->ga_len = len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 gap1->ga_len -= len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 }
2900 fp->fd_len = top - fp->fd_top;
2901 fold_changed = TRUE;
2902}
2903
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002904// foldRemove() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905/*
2906 * Remove folds within the range "top" to and including "bot".
2907 * Check for these situations:
2908 * 1 2 3
2909 * 1 2 3
2910 * top 2 3 4 5
2911 * 2 3 4 5
2912 * bot 2 3 4 5
2913 * 3 5 6
2914 * 3 5 6
2915 *
2916 * 1: not changed
Bram Moolenaar25394022007-05-10 19:06:20 +00002917 * 2: truncate to stop above "top"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 * 3: split in two parts, one stops above "top", other starts below "bot".
2919 * 4: deleted
2920 * 5: made to start below "bot".
2921 * 6: not changed
2922 */
2923 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01002924foldRemove(garray_T *gap, linenr_T top, linenr_T bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925{
2926 fold_T *fp = NULL;
2927
2928 if (bot < top)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002929 return; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930
2931 for (;;)
2932 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002933 // Find fold that includes top or a following one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 if (foldFind(gap, top, &fp) && fp->fd_top < top)
2935 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002936 // 2: or 3: need to delete nested folds
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 foldRemove(&fp->fd_nested, top - fp->fd_top, bot - fp->fd_top);
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002938 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002940 // 3: need to split it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 foldSplit(gap, (int)(fp - (fold_T *)gap->ga_data), top, bot);
2942 }
2943 else
2944 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002945 // 2: truncate fold at "top".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 fp->fd_len = top - fp->fd_top;
2947 }
2948 fold_changed = TRUE;
2949 continue;
2950 }
2951 if (fp >= (fold_T *)(gap->ga_data) + gap->ga_len
2952 || fp->fd_top > bot)
2953 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002954 // 6: Found a fold below bot, can stop looking.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 break;
2956 }
2957 if (fp->fd_top >= top)
2958 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002959 // Found an entry below top.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 fold_changed = TRUE;
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002961 if (fp->fd_top + fp->fd_len - 1 > bot)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002963 // 5: Make fold that includes bot start below bot.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 foldMarkAdjustRecurse(&fp->fd_nested,
2965 (linenr_T)0, (long)(bot - fp->fd_top),
2966 (linenr_T)MAXLNUM, (long)(fp->fd_top - bot - 1));
2967 fp->fd_len -= bot - fp->fd_top + 1;
2968 fp->fd_top = bot + 1;
2969 break;
2970 }
2971
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002972 // 4: Delete completely contained fold.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 deleteFoldEntry(gap, (int)(fp - (fold_T *)gap->ga_data), TRUE);
2974 }
2975 }
2976}
2977
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002978// foldReverseOrder() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002979 static void
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002980foldReverseOrder(garray_T *gap, linenr_T start_arg, linenr_T end_arg)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002981{
2982 fold_T *left, *right;
2983 fold_T tmp;
Bram Moolenaarb11c8262017-04-23 16:48:20 +02002984 linenr_T start = start_arg;
2985 linenr_T end = end_arg;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002986
2987 for (; start < end; start++, end--)
2988 {
2989 left = (fold_T *)gap->ga_data + start;
2990 right = (fold_T *)gap->ga_data + end;
2991 tmp = *left;
2992 *left = *right;
2993 *right = tmp;
2994 }
2995}
2996
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002997// foldMoveRange() {{{2
Bram Moolenaar88d298a2017-03-14 21:53:58 +01002998/*
2999 * Move folds within the inclusive range "line1" to "line2" to after "dest"
3000 * requires "line1" <= "line2" <= "dest"
3001 *
3002 * There are the following situations for the first fold at or below line1 - 1.
3003 * 1 2 3 4
3004 * 1 2 3 4
3005 * line1 2 3 4
3006 * 2 3 4 5 6 7
3007 * line2 3 4 5 6 7
3008 * 3 4 6 7 8 9
3009 * dest 4 7 8 9
3010 * 4 7 8 10
3011 * 4 7 8 10
3012 *
3013 * In the following descriptions, "moved" means moving in the buffer, *and* in
3014 * the fold array.
3015 * Meanwhile, "shifted" just means moving in the buffer.
3016 * 1. not changed
3017 * 2. truncated above line1
3018 * 3. length reduced by line2 - line1, folds starting between the end of 3 and
3019 * dest are truncated and shifted up
3020 * 4. internal folds moved (from [line1, line2] to dest)
3021 * 5. moved to dest.
3022 * 6. truncated below line2 and moved.
3023 * 7. length reduced by line2 - dest, folds starting between line2 and dest are
3024 * removed, top is moved down by move_len.
3025 * 8. truncated below dest and shifted up.
3026 * 9. shifted up
3027 * 10. not changed
3028 */
3029
3030 static void
3031truncate_fold(fold_T *fp, linenr_T end)
3032{
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003033 end += 1;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003034 foldRemove(&fp->fd_nested, end - fp->fd_top, MAXLNUM);
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003035 fp->fd_len = end - fp->fd_top;
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003036}
3037
3038#define fold_end(fp) ((fp)->fd_top + (fp)->fd_len - 1)
3039#define valid_fold(fp, gap) ((fp) < ((fold_T *)(gap)->ga_data + (gap)->ga_len))
3040#define fold_index(fp, gap) ((size_t)(fp - ((fold_T *)(gap)->ga_data)))
3041
Bram Moolenaar4a5a8dd2017-03-16 13:54:10 +01003042 void
3043foldMoveRange(garray_T *gap, linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003044{
3045 fold_T *fp;
3046 linenr_T range_len = line2 - line1 + 1;
3047 linenr_T move_len = dest - line2;
3048 int at_start = foldFind(gap, line1 - 1, &fp);
3049 size_t move_start = 0, move_end = 0, dest_index = 0;
3050
3051 if (at_start)
3052 {
3053 if (fold_end(fp) > dest)
3054 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003055 // Case 4
3056 // don't have to change this fold, but have to move nested folds.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003057 foldMoveRange(&fp->fd_nested, line1 - fp->fd_top, line2 -
3058 fp->fd_top, dest - fp->fd_top);
3059 return;
3060 }
3061 else if (fold_end(fp) > line2)
3062 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003063 // Case 3
3064 // Remove nested folds between line1 and line2 & reduce the
3065 // length of fold by "range_len".
3066 // Folds after this one must be dealt with.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003067 foldMarkAdjustRecurse(&fp->fd_nested, line1 - fp->fd_top, line2 -
3068 fp->fd_top, MAXLNUM, -range_len);
3069 fp->fd_len -= range_len;
3070 }
3071 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003072 // Case 2 truncate fold, folds after this one must be dealt with.
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003073 truncate_fold(fp, line1 - 1);
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003074
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003075 // Look at the next fold, and treat that one as if it were the first
3076 // after "line1" (because now it is).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003077 fp = fp + 1;
3078 }
3079
3080 if (!valid_fold(fp, gap) || fp->fd_top > dest)
3081 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003082 // Case 10
3083 // No folds after "line1" and before "dest"
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003084 return;
3085 }
3086 else if (fp->fd_top > line2)
3087 {
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003088 for (; valid_fold(fp, gap) && fold_end(fp) <= dest; fp++)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003089 // Case 9. (for all case 9's) -- shift up.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003090 fp->fd_top -= range_len;
3091
Bram Moolenaar40ebc0a2017-03-16 15:59:14 +01003092 if (valid_fold(fp, gap) && fp->fd_top <= dest)
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003093 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003094 // Case 8. -- ensure truncated at dest, shift up
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003095 truncate_fold(fp, dest);
3096 fp->fd_top -= range_len;
3097 }
3098 return;
3099 }
3100 else if (fold_end(fp) > dest)
3101 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003102 // Case 7 -- remove nested folds and shrink
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003103 foldMarkAdjustRecurse(&fp->fd_nested, line2 + 1 - fp->fd_top, dest -
3104 fp->fd_top, MAXLNUM, -move_len);
3105 fp->fd_len -= move_len;
3106 fp->fd_top += move_len;
3107 return;
3108 }
3109
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003110 // Case 5 or 6
3111 // changes rely on whether there are folds between the end of
3112 // this fold and "dest".
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003113 move_start = fold_index(fp, gap);
3114
3115 for (; valid_fold(fp, gap) && fp->fd_top <= dest; fp++)
3116 {
3117 if (fp->fd_top <= line2)
3118 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003119 // 1. 2. or 3.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003120 if (fold_end(fp) > line2)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003121 // 2. or 3., truncate before moving
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003122 truncate_fold(fp, line2);
3123
3124 fp->fd_top += move_len;
3125 continue;
3126 }
3127
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003128 // Record index of the first fold after the moved range.
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003129 if (move_end == 0)
3130 move_end = fold_index(fp, gap);
3131
3132 if (fold_end(fp) > dest)
3133 truncate_fold(fp, dest);
3134
3135 fp->fd_top -= range_len;
3136 }
3137
3138 dest_index = fold_index(fp, gap);
3139
3140 /*
Bram Moolenaar94be6192017-04-22 22:40:11 +02003141 * All folds are now correct, but not necessarily in the correct order. We
3142 * must swap folds in the range [move_end, dest_index) with those in the
3143 * range [move_start, move_end).
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003144 */
Bram Moolenaar94be6192017-04-22 22:40:11 +02003145 if (move_end == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003146 // There are no folds after those moved, hence no folds have been moved
3147 // out of order.
Bram Moolenaar94be6192017-04-22 22:40:11 +02003148 return;
Bram Moolenaar0c0d4ec2017-03-16 22:06:57 +01003149 foldReverseOrder(gap, (linenr_T)move_start, (linenr_T)dest_index - 1);
3150 foldReverseOrder(gap, (linenr_T)move_start,
3151 (linenr_T)(move_start + dest_index - move_end - 1));
3152 foldReverseOrder(gap, (linenr_T)(move_start + dest_index - move_end),
3153 (linenr_T)(dest_index - 1));
Bram Moolenaar88d298a2017-03-14 21:53:58 +01003154}
3155#undef fold_end
3156#undef valid_fold
3157#undef fold_index
3158
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003159// foldMerge() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160/*
Bram Moolenaar25394022007-05-10 19:06:20 +00003161 * Merge two adjacent folds (and the nested ones in them).
3162 * This only works correctly when the folds are really adjacent! Thus "fp1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 * must end just above "fp2".
3164 * The resulting fold is "fp1", nested folds are moved from "fp2" to "fp1".
3165 * Fold entry "fp2" in "gap" is deleted.
3166 */
3167 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003168foldMerge(fold_T *fp1, garray_T *gap, fold_T *fp2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169{
3170 fold_T *fp3;
3171 fold_T *fp4;
3172 int idx;
3173 garray_T *gap1 = &fp1->fd_nested;
3174 garray_T *gap2 = &fp2->fd_nested;
3175
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003176 // If the last nested fold in fp1 touches the first nested fold in fp2,
3177 // merge them recursively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 if (foldFind(gap1, fp1->fd_len - 1L, &fp3) && foldFind(gap2, 0L, &fp4))
3179 foldMerge(fp3, gap2, fp4);
3180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003181 // Move nested folds in fp2 to the end of fp1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 if (gap2->ga_len > 0 && ga_grow(gap1, gap2->ga_len) == OK)
3183 {
3184 for (idx = 0; idx < gap2->ga_len; ++idx)
3185 {
3186 ((fold_T *)gap1->ga_data)[gap1->ga_len]
3187 = ((fold_T *)gap2->ga_data)[idx];
3188 ((fold_T *)gap1->ga_data)[gap1->ga_len].fd_top += fp1->fd_len;
3189 ++gap1->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 }
3191 gap2->ga_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 }
3193
3194 fp1->fd_len += fp2->fd_len;
3195 deleteFoldEntry(gap, (int)(fp2 - (fold_T *)gap->ga_data), TRUE);
3196 fold_changed = TRUE;
3197}
3198
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003199// foldlevelIndent() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200/*
3201 * Low level function to get the foldlevel for the "indent" method.
3202 * Doesn't use any caching.
3203 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3204 */
3205 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003206foldlevelIndent(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207{
3208 char_u *s;
3209 buf_T *buf;
3210 linenr_T lnum = flp->lnum + flp->off;
3211
3212 buf = flp->wp->w_buffer;
3213 s = skipwhite(ml_get_buf(buf, lnum, FALSE));
3214
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003215 // empty line or lines starting with a character in 'foldignore': level
3216 // depends on surrounding lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 if (*s == NUL || vim_strchr(flp->wp->w_p_fdi, *s) != NULL)
3218 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003219 // first and last line can't be undefined, use level 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 if (lnum == 1 || lnum == buf->b_ml.ml_line_count)
3221 flp->lvl = 0;
3222 else
3223 flp->lvl = -1;
3224 }
3225 else
Bram Moolenaar0c27cbc2018-11-14 21:45:32 +01003226 flp->lvl = get_indent_buf(buf, lnum) / get_sw_value(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 if (flp->lvl > flp->wp->w_p_fdn)
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003228 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 flp->lvl = flp->wp->w_p_fdn;
Bram Moolenaar74c596b2006-11-01 11:44:31 +00003230 if (flp->lvl < 0)
3231 flp->lvl = 0;
3232 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233}
3234
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003235// foldlevelDiff() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236#ifdef FEAT_DIFF
3237/*
3238 * Low level function to get the foldlevel for the "diff" method.
3239 * Doesn't use any caching.
3240 */
3241 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003242foldlevelDiff(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243{
3244 if (diff_infold(flp->wp, flp->lnum + flp->off))
3245 flp->lvl = 1;
3246 else
3247 flp->lvl = 0;
3248}
3249#endif
3250
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003251// foldlevelExpr() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252/*
3253 * Low level function to get the foldlevel for the "expr" method.
3254 * Doesn't use any caching.
3255 * Returns a level of -1 if the foldlevel depends on surrounding lines.
3256 */
3257 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003258foldlevelExpr(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259{
3260#ifndef FEAT_EVAL
3261 flp->start = FALSE;
3262 flp->lvl = 0;
3263#else
3264 win_T *win;
3265 int n;
3266 int c;
3267 linenr_T lnum = flp->lnum + flp->off;
3268 int save_keytyped;
3269
3270 win = curwin;
3271 curwin = flp->wp;
3272 curbuf = flp->wp->w_buffer;
3273 set_vim_var_nr(VV_LNUM, lnum);
3274
3275 flp->start = 0;
3276 flp->had_end = flp->end;
3277 flp->end = MAX_LEVEL + 1;
3278 if (lnum <= 1)
3279 flp->lvl = 0;
3280
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003281 // KeyTyped may be reset to 0 when calling a function which invokes
3282 // do_cmdline(). To make 'foldopen' work correctly restore KeyTyped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 save_keytyped = KeyTyped;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003284 n = (int)eval_foldexpr(flp->wp->w_p_fde, &c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 KeyTyped = save_keytyped;
3286
3287 switch (c)
3288 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003289 // "a1", "a2", .. : add to the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 case 'a': if (flp->lvl >= 0)
3291 {
3292 flp->lvl += n;
3293 flp->lvl_next = flp->lvl;
3294 }
3295 flp->start = n;
3296 break;
3297
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003298 // "s1", "s2", .. : subtract from the fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 case 's': if (flp->lvl >= 0)
3300 {
3301 if (n > flp->lvl)
3302 flp->lvl_next = 0;
3303 else
3304 flp->lvl_next = flp->lvl - n;
3305 flp->end = flp->lvl_next + 1;
3306 }
3307 break;
3308
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003309 // ">1", ">2", .. : start a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 case '>': flp->lvl = n;
3311 flp->lvl_next = n;
3312 flp->start = 1;
3313 break;
3314
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003315 // "<1", "<2", .. : end a fold with a certain level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 case '<': flp->lvl_next = n - 1;
3317 flp->end = n;
3318 break;
3319
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003320 // "=": No change in level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 case '=': flp->lvl_next = flp->lvl;
3322 break;
3323
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003324 // "-1", "0", "1", ..: set fold level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 default: if (n < 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003326 // Use the current level for the next line, so that "a1"
3327 // will work there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 flp->lvl_next = flp->lvl;
3329 else
3330 flp->lvl_next = n;
3331 flp->lvl = n;
3332 break;
3333 }
3334
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003335 // If the level is unknown for the first or the last line in the file, use
3336 // level 0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 if (flp->lvl < 0)
3338 {
3339 if (lnum <= 1)
3340 {
3341 flp->lvl = 0;
3342 flp->lvl_next = 0;
3343 }
3344 if (lnum == curbuf->b_ml.ml_line_count)
3345 flp->lvl_next = 0;
3346 }
3347
3348 curwin = win;
3349 curbuf = curwin->w_buffer;
3350#endif
3351}
3352
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003353// parseMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354/*
3355 * Parse 'foldmarker' and set "foldendmarker", "foldstartmarkerlen" and
3356 * "foldendmarkerlen".
3357 * Relies on the option value to have been checked for correctness already.
3358 */
3359 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003360parseMarker(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361{
3362 foldendmarker = vim_strchr(wp->w_p_fmr, ',');
3363 foldstartmarkerlen = (int)(foldendmarker++ - wp->w_p_fmr);
3364 foldendmarkerlen = (int)STRLEN(foldendmarker);
3365}
3366
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003367// foldlevelMarker() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368/*
3369 * Low level function to get the foldlevel for the "marker" method.
3370 * "foldendmarker", "foldstartmarkerlen" and "foldendmarkerlen" must have been
3371 * set before calling this.
3372 * Requires that flp->lvl is set to the fold level of the previous line!
3373 * Careful: This means you can't call this function twice on the same line.
3374 * Doesn't use any caching.
3375 * Sets flp->start when a start marker was found.
3376 */
3377 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003378foldlevelMarker(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379{
3380 char_u *startmarker;
3381 int cstart;
3382 int cend;
3383 int start_lvl = flp->lvl;
3384 char_u *s;
3385 int n;
3386
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003387 // cache a few values for speed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 startmarker = flp->wp->w_p_fmr;
3389 cstart = *startmarker;
3390 ++startmarker;
3391 cend = *foldendmarker;
3392
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003393 // Default: no start found, next level is same as current level
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 flp->start = 0;
3395 flp->lvl_next = flp->lvl;
3396
3397 s = ml_get_buf(flp->wp->w_buffer, flp->lnum + flp->off, FALSE);
3398 while (*s)
3399 {
3400 if (*s == cstart
3401 && STRNCMP(s + 1, startmarker, foldstartmarkerlen - 1) == 0)
3402 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003403 // found startmarker: set flp->lvl
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 s += foldstartmarkerlen;
3405 if (VIM_ISDIGIT(*s))
3406 {
3407 n = atoi((char *)s);
3408 if (n > 0)
3409 {
3410 flp->lvl = n;
3411 flp->lvl_next = n;
3412 if (n <= start_lvl)
3413 flp->start = 1;
3414 else
3415 flp->start = n - start_lvl;
3416 }
3417 }
3418 else
3419 {
3420 ++flp->lvl;
3421 ++flp->lvl_next;
3422 ++flp->start;
3423 }
3424 }
3425 else if (*s == cend
3426 && STRNCMP(s + 1, foldendmarker + 1, foldendmarkerlen - 1) == 0)
3427 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003428 // found endmarker: set flp->lvl_next
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 s += foldendmarkerlen;
3430 if (VIM_ISDIGIT(*s))
3431 {
3432 n = atoi((char *)s);
3433 if (n > 0)
3434 {
3435 flp->lvl = n;
3436 flp->lvl_next = n - 1;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003437 // never start a fold with an end marker
Bram Moolenaar3ee02292010-01-19 17:24:25 +01003438 if (flp->lvl_next > start_lvl)
3439 flp->lvl_next = start_lvl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 }
3441 }
3442 else
3443 --flp->lvl_next;
3444 }
3445 else
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003446 MB_PTR_ADV(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 }
3448
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003449 // The level can't go negative, must be missing a start marker.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 if (flp->lvl_next < 0)
3451 flp->lvl_next = 0;
3452}
3453
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003454// foldlevelSyntax() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455/*
3456 * Low level function to get the foldlevel for the "syntax" method.
3457 * Doesn't use any caching.
3458 */
3459 static void
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003460foldlevelSyntax(fline_T *flp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461{
3462#ifndef FEAT_SYN_HL
3463 flp->start = 0;
3464 flp->lvl = 0;
3465#else
3466 linenr_T lnum = flp->lnum + flp->off;
3467 int n;
3468
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003469 // Use the maximum fold level at the start of this line and the next.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 flp->lvl = syn_get_foldlevel(flp->wp, lnum);
3471 flp->start = 0;
3472 if (lnum < flp->wp->w_buffer->b_ml.ml_line_count)
3473 {
3474 n = syn_get_foldlevel(flp->wp, lnum + 1);
3475 if (n > flp->lvl)
3476 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003477 flp->start = n - flp->lvl; // fold(s) start here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 flp->lvl = n;
3479 }
3480 }
3481#endif
3482}
3483
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003484// functions for storing the fold state in a View {{{1
3485// put_folds() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486#if defined(FEAT_SESSION) || defined(PROTO)
Bram Moolenaard25c16e2016-01-29 22:13:30 +01003487static int put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off);
3488static int put_foldopen_recurse(FILE *fd, win_T *wp, garray_T *gap, linenr_T off);
3489static int put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490
3491/*
3492 * Write commands to "fd" to restore the manual folds in window "wp".
3493 * Return FAIL if writing fails.
3494 */
3495 int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003496put_folds(FILE *fd, win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497{
3498 if (foldmethodIsManual(wp))
3499 {
3500 if (put_line(fd, "silent! normal! zE") == FAIL
3501 || put_folds_recurse(fd, &wp->w_folds, (linenr_T)0) == FAIL)
3502 return FAIL;
3503 }
3504
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003505 // If some folds are manually opened/closed, need to restore that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 if (wp->w_fold_manual)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003507 return put_foldopen_recurse(fd, wp, &wp->w_folds, (linenr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508
3509 return OK;
3510}
3511
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003512// put_folds_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513/*
3514 * Write commands to "fd" to recreate manually created folds.
3515 * Returns FAIL when writing failed.
3516 */
3517 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003518put_folds_recurse(FILE *fd, garray_T *gap, linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519{
3520 int i;
3521 fold_T *fp;
3522
3523 fp = (fold_T *)gap->ga_data;
3524 for (i = 0; i < gap->ga_len; i++)
3525 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003526 // Do nested folds first, they will be created closed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 if (put_folds_recurse(fd, &fp->fd_nested, off + fp->fd_top) == FAIL)
3528 return FAIL;
3529 if (fprintf(fd, "%ld,%ldfold", fp->fd_top + off,
3530 fp->fd_top + off + fp->fd_len - 1) < 0
3531 || put_eol(fd) == FAIL)
3532 return FAIL;
3533 ++fp;
3534 }
3535 return OK;
3536}
3537
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003538// put_foldopen_recurse() {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539/*
3540 * Write commands to "fd" to open and close manually opened/closed folds.
3541 * Returns FAIL when writing failed.
3542 */
3543 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003544put_foldopen_recurse(
3545 FILE *fd,
3546 win_T *wp,
3547 garray_T *gap,
3548 linenr_T off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549{
3550 int i;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003551 int level;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 fold_T *fp;
3553
3554 fp = (fold_T *)gap->ga_data;
3555 for (i = 0; i < gap->ga_len; i++)
3556 {
3557 if (fp->fd_flags != FD_LEVEL)
3558 {
3559 if (fp->fd_nested.ga_len > 0)
3560 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003561 // open nested folds while this fold is open
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3563 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003564 || put_line(fd, "normal! zo") == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 return FAIL;
Bram Moolenaard25ad652012-02-29 19:20:02 +01003566 if (put_foldopen_recurse(fd, wp, &fp->fd_nested,
3567 off + fp->fd_top)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 == FAIL)
3569 return FAIL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003570 // close the parent when needed
Bram Moolenaard25ad652012-02-29 19:20:02 +01003571 if (fp->fd_flags == FD_CLOSED)
3572 {
3573 if (put_fold_open_close(fd, fp, off) == FAIL)
3574 return FAIL;
3575 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 }
Bram Moolenaard25ad652012-02-29 19:20:02 +01003577 else
3578 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003579 // Open or close the leaf according to the window foldlevel.
3580 // Do not close a leaf that is already closed, as it will close
3581 // the parent.
Bram Moolenaard25ad652012-02-29 19:20:02 +01003582 level = foldLevelWin(wp, off + fp->fd_top);
3583 if ((fp->fd_flags == FD_CLOSED && wp->w_p_fdl >= level)
3584 || (fp->fd_flags != FD_CLOSED && wp->w_p_fdl < level))
3585 if (put_fold_open_close(fd, fp, off) == FAIL)
3586 return FAIL;
3587 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 }
3589 ++fp;
3590 }
3591
3592 return OK;
3593}
Bram Moolenaard25ad652012-02-29 19:20:02 +01003594
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003595// put_fold_open_close() {{{2
Bram Moolenaard25ad652012-02-29 19:20:02 +01003596/*
3597 * Write the open or close command to "fd".
3598 * Returns FAIL when writing failed.
3599 */
3600 static int
Bram Moolenaar66f948e2016-01-30 16:39:25 +01003601put_fold_open_close(FILE *fd, fold_T *fp, linenr_T off)
Bram Moolenaard25ad652012-02-29 19:20:02 +01003602{
3603 if (fprintf(fd, "%ld", fp->fd_top + off) < 0
3604 || put_eol(fd) == FAIL
Bram Moolenaar002a4ed2012-08-29 15:22:25 +02003605 || fprintf(fd, "normal! z%c",
Bram Moolenaard25ad652012-02-29 19:20:02 +01003606 fp->fd_flags == FD_CLOSED ? 'c' : 'o') < 0
3607 || put_eol(fd) == FAIL)
3608 return FAIL;
3609
3610 return OK;
3611}
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003612#endif // FEAT_SESSION
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003614// }}}1
Bram Moolenaardb022f32019-09-01 17:52:32 +02003615#endif // defined(FEAT_FOLDING) || defined(PROTO)
3616
3617#if defined(FEAT_EVAL) || defined(PROTO)
3618
3619/*
3620 * "foldclosed()" and "foldclosedend()" functions
3621 */
3622 static void
3623foldclosed_both(
3624 typval_T *argvars UNUSED,
3625 typval_T *rettv,
3626 int end UNUSED)
3627{
3628# ifdef FEAT_FOLDING
3629 linenr_T lnum;
3630 linenr_T first, last;
3631
3632 lnum = tv_get_lnum(argvars);
3633 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3634 {
3635 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
3636 {
3637 if (end)
3638 rettv->vval.v_number = (varnumber_T)last;
3639 else
3640 rettv->vval.v_number = (varnumber_T)first;
3641 return;
3642 }
3643 }
3644#endif
3645 rettv->vval.v_number = -1;
3646}
3647
3648/*
3649 * "foldclosed()" function
3650 */
3651 void
3652f_foldclosed(typval_T *argvars, typval_T *rettv)
3653{
3654 foldclosed_both(argvars, rettv, FALSE);
3655}
3656
3657/*
3658 * "foldclosedend()" function
3659 */
3660 void
3661f_foldclosedend(typval_T *argvars, typval_T *rettv)
3662{
3663 foldclosed_both(argvars, rettv, TRUE);
3664}
3665
3666/*
3667 * "foldlevel()" function
3668 */
3669 void
3670f_foldlevel(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
3671{
3672# ifdef FEAT_FOLDING
3673 linenr_T lnum;
3674
3675 lnum = tv_get_lnum(argvars);
3676 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
3677 rettv->vval.v_number = foldLevel(lnum);
3678# endif
3679}
3680
3681/*
3682 * "foldtext()" function
3683 */
3684 void
3685f_foldtext(typval_T *argvars UNUSED, typval_T *rettv)
3686{
3687# ifdef FEAT_FOLDING
3688 linenr_T foldstart;
3689 linenr_T foldend;
3690 char_u *dashes;
3691 linenr_T lnum;
3692 char_u *s;
3693 char_u *r;
3694 int len;
3695 char *txt;
3696 long count;
3697# endif
3698
3699 rettv->v_type = VAR_STRING;
3700 rettv->vval.v_string = NULL;
3701# ifdef FEAT_FOLDING
3702 foldstart = (linenr_T)get_vim_var_nr(VV_FOLDSTART);
3703 foldend = (linenr_T)get_vim_var_nr(VV_FOLDEND);
3704 dashes = get_vim_var_str(VV_FOLDDASHES);
3705 if (foldstart > 0 && foldend <= curbuf->b_ml.ml_line_count
3706 && dashes != NULL)
3707 {
3708 // Find first non-empty line in the fold.
3709 for (lnum = foldstart; lnum < foldend; ++lnum)
3710 if (!linewhite(lnum))
3711 break;
3712
3713 // Find interesting text in this line.
3714 s = skipwhite(ml_get(lnum));
3715 // skip C comment-start
3716 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
3717 {
3718 s = skipwhite(s + 2);
3719 if (*skipwhite(s) == NUL
3720 && lnum + 1 < (linenr_T)get_vim_var_nr(VV_FOLDEND))
3721 {
3722 s = skipwhite(ml_get(lnum + 1));
3723 if (*s == '*')
3724 s = skipwhite(s + 1);
3725 }
3726 }
3727 count = (long)(foldend - foldstart + 1);
3728 txt = NGETTEXT("+-%s%3ld line: ", "+-%s%3ld lines: ", count);
3729 r = alloc(STRLEN(txt)
3730 + STRLEN(dashes) // for %s
3731 + 20 // for %3ld
3732 + STRLEN(s)); // concatenated
3733 if (r != NULL)
3734 {
3735 sprintf((char *)r, txt, dashes, count);
3736 len = (int)STRLEN(r);
3737 STRCAT(r, s);
3738 // remove 'foldmarker' and 'commentstring'
3739 foldtext_cleanup(r + len);
3740 rettv->vval.v_string = r;
3741 }
3742 }
3743# endif
3744}
3745
3746/*
3747 * "foldtextresult(lnum)" function
3748 */
3749 void
3750f_foldtextresult(typval_T *argvars UNUSED, typval_T *rettv)
3751{
3752# ifdef FEAT_FOLDING
3753 linenr_T lnum;
3754 char_u *text;
3755 char_u buf[FOLD_TEXT_LEN];
3756 foldinfo_T foldinfo;
3757 int fold_count;
3758 static int entered = FALSE;
3759# endif
3760
3761 rettv->v_type = VAR_STRING;
3762 rettv->vval.v_string = NULL;
3763# ifdef FEAT_FOLDING
3764 if (entered)
3765 return; // reject recursive use
3766 entered = TRUE;
3767
3768 lnum = tv_get_lnum(argvars);
3769 // treat illegal types and illegal string values for {lnum} the same
3770 if (lnum < 0)
3771 lnum = 0;
3772 fold_count = foldedCount(curwin, lnum, &foldinfo);
3773 if (fold_count > 0)
3774 {
3775 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
3776 &foldinfo, buf);
3777 if (text == buf)
3778 text = vim_strsave(text);
3779 rettv->vval.v_string = text;
3780 }
3781
3782 entered = FALSE;
3783# endif
3784}
3785
3786#endif // FEAT_EVAL