On 10/17/2016 04:45 PM, Bram Moolenaar wrote:
> Brad King wrote:
>> I've revised the change to add a new syntax command:
>>
>> :syntax foldlevel [start | minimum]
>>
>> that can be used to enable this.
>
> Thanks. I suppose that's the best way to do it.
Great. I realized that the "syntax foldlevel" command itself should not
be conditioned on FEAT_FOLDING because clients should not have to switch
on the existence of the feature before calling it. Here is a revised
patch. Now the documentation simply says that the command is not
meaningful when folding is not available.
Thanks,
-Brad
--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
---
You received this message because you are subscribed to the Google Groups
"vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to vim_dev+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
>From 617860554d40293a40ef757b4404073769fe0bca Mon Sep 17 00:00:00 2001
Message-Id: <617860554d40293a40ef757b4404073769fe0bca.1476793464.git.brad.k...@kitware.com>
From: Brad King <brad.k...@kitware.com>
Date: Mon, 17 Oct 2016 13:42:53 -0400
Subject: [PATCH] syntax: Add command to control how foldlevel is computed for
a line
With `foldmethod=syntax` the foldlevel of a line is computed based
on syntax items on the line. Previously we always used the level
of the syntax item containing the start of the line. This works
well in cases such as:
if (...) {
...
}
else if (...) {
...
}
else {
...
}
which folds like this:
+--- 3 lines: if (...) {---------------------------
+--- 3 lines: else if (...) {----------------------
+--- 3 lines: else {-------------------------------
However, the code:
if (...) {
...
} else if (...) {
...
} else {
...
}
folds like this:
+--- 7 lines: if (...) {---------------------------
We can make the latter case fold like this:
+--- 2 lines: if (...) {---------------------------
+--- 2 lines: } else if (...) {--------------------
+--- 3 lines: } else {-----------------------------
by choosing on each line the lowest fold level that is followed
by a higher fold level.
Add a syntax command
:syntax foldlevel [start | minimum]
to choose between these two methods of computing the foldlevel of
a line.
---
runtime/doc/syntax.txt | 19 +++++++++++++++
src/structs.h | 5 ++++
src/syntax.c | 64 ++++++++++++++++++++++++++++++++++++++++++++++----
3 files changed, 84 insertions(+), 4 deletions(-)
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index ae80a44..177f645 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -3480,6 +3480,23 @@ DEFINING CASE *:syn-case* *E390*
items until the next ":syntax case" command are affected.
+DEFINING FOLDLEVEL *:syn-foldlevel*
+
+:sy[ntax] foldlevel [start | minimum]
+ This defines how the foldlevel of a line is computed when using
+ foldmethod=syntax (see |fold-syntax| and |:syn-fold|):
+
+ start: Use level of item containing start of line.
+ minimum: Use lowest local-minimum level of items on line.
+
+ The default is 'start'. Use 'minimum' to search a line horizontally
+ for the lowest level contained on the line that is followed by a
+ higher level. This produces more natural folds when syntax items
+ may close and open horizontally within a line.
+
+ {not meaningful when Vim was compiled without |+folding| feature}
+
+
SPELL CHECKING *:syn-spell*
:sy[ntax] spell [toplevel | notoplevel | default]
@@ -3938,6 +3955,8 @@ This will make each {} block form one fold.
The fold will start on the line where the item starts, and end where the item
ends. If the start and end are within the same line, there is no fold.
The 'foldnestmax' option limits the nesting of syntax folds.
+See |:syn-foldlevel| to control how the foldlevel of a line is computed
+from its syntax items.
{not available when Vim was compiled without |+folding| feature}
diff --git a/src/structs.h b/src/structs.h
index 7a4d7fb..184f316 100644
--- a/src/structs.h
+++ b/src/structs.h
@@ -1710,6 +1710,10 @@ typedef struct list_stack_S
#define SYNSPL_TOP 1 /* spell check toplevel text */
#define SYNSPL_NOTOP 2 /* don't spell check toplevel text */
+/* values for b_syn_foldlevel: how to compute foldlevel on a line */
+#define SYNFLD_START 0 /* use level of item at start of line */
+#define SYNFLD_MINIMUM 1 /* use lowest local minimum level on line */
+
/* avoid #ifdefs for when b_spell is not available */
#ifdef FEAT_SPELL
# define B_SPELL(buf) ((buf)->b_spell)
@@ -1761,6 +1765,7 @@ typedef struct {
hashtab_T b_keywtab_ic; /* idem, ignore case */
int b_syn_error; /* TRUE when error occurred in HL */
int b_syn_ic; /* ignore case for :syn cmds */
+ int b_syn_foldlevel; /* how to compute foldlevel on a line */
int b_syn_spell; /* SYNSPL_ values */
garray_T b_syn_patterns; /* table for syntax patterns */
garray_T b_syn_clusters; /* table for syntax clusters */
diff --git a/src/syntax.c b/src/syntax.c
index 75ede36..9b46701 100644
--- a/src/syntax.c
+++ b/src/syntax.c
@@ -435,6 +435,7 @@ static char_u *syn_getcurline(void);
static int syn_regexec(regmmatch_T *rmp, linenr_T lnum, colnr_T col, syn_time_T *st);
static int check_keyword_id(char_u *line, int startcol, int *endcol, long *flags, short **next_list, stateitem_T *cur_si, int *ccharp);
static void syn_cmd_case(exarg_T *eap, int syncing);
+static void syn_cmd_foldlevel(exarg_T *eap, int syncing);
static void syn_cmd_spell(exarg_T *eap, int syncing);
static void syntax_sync_clear(void);
static void syn_remove_pattern(synblock_T *block, int idx);
@@ -3466,6 +3467,31 @@ syn_cmd_case(exarg_T *eap, int syncing UNUSED)
}
/*
+ * Handle ":syntax foldlevel" command.
+ */
+ static void
+syn_cmd_foldlevel(exarg_T *eap, int syncing UNUSED)
+{
+ char_u *arg = eap->arg;
+ char_u *next;
+
+ eap->nextcmd = find_nextcmd(arg);
+ if (eap->skip)
+ return;
+
+ next = skiptowhite(arg);
+ if (STRNICMP(arg, "start", 5) == 0 && next - arg == 5)
+ curwin->w_s->b_syn_foldlevel = SYNFLD_START;
+ else if (STRNICMP(arg, "minimum", 7) == 0 && next - arg == 7)
+ curwin->w_s->b_syn_foldlevel = SYNFLD_MINIMUM;
+ else
+ {
+ EMSG2(_("E390: Illegal argument: %s"), arg);
+ return;
+ }
+}
+
+/*
* Handle ":syntax spell" command.
*/
static void
@@ -3554,6 +3580,7 @@ syntax_clear(synblock_T *block)
block->b_syn_error = FALSE; /* clear previous error */
block->b_syn_ic = FALSE; /* Use case, by default */
+ block->b_syn_foldlevel = SYNFLD_START;
block->b_syn_spell = SYNSPL_DEFAULT; /* default spell checking */
block->b_syn_containedin = FALSE;
@@ -6262,6 +6289,7 @@ static struct subcommand subcommands[] =
{"cluster", syn_cmd_cluster},
{"conceal", syn_cmd_conceal},
{"enable", syn_cmd_enable},
+ {"foldlevel", syn_cmd_foldlevel},
{"include", syn_cmd_include},
{"iskeyword", syn_cmd_iskeyword},
{"keyword", syn_cmd_keyword},
@@ -6537,6 +6565,17 @@ syn_get_stack_item(int i)
#endif
#if defined(FEAT_FOLDING) || defined(PROTO)
+ static int
+syn_cur_foldlevel(void)
+{
+ int level = 0;
+ int i;
+ for (i = 0; i < current_state.ga_len; ++i)
+ if (CUR_STATE(i).si_flags & HL_FOLD)
+ ++level;
+ return level;
+}
+
/*
* Function called to get folding level for line "lnum" in window "wp".
*/
@@ -6544,16 +6583,33 @@ syn_get_stack_item(int i)
syn_get_foldlevel(win_T *wp, long lnum)
{
int level = 0;
- int i;
+ int low_level;
+ int cur_level;
/* Return quickly when there are no fold items at all. */
if (wp->w_s->b_syn_folditems != 0)
{
syntax_start(wp, lnum);
- for (i = 0; i < current_state.ga_len; ++i)
- if (CUR_STATE(i).si_flags & HL_FOLD)
- ++level;
+ /* Start with the fold level at the start of the line. */
+ level = syn_cur_foldlevel();
+
+ if (wp->w_s->b_syn_foldlevel == SYNFLD_MINIMUM)
+ {
+ /* Find the lowest fold level that is followed by a higher one. */
+ cur_level = level;
+ low_level = cur_level;
+ while (!current_finished)
+ {
+ (void)syn_current_attr(FALSE, FALSE, NULL, FALSE);
+ cur_level = syn_cur_foldlevel();
+ if (cur_level < low_level)
+ low_level = cur_level;
+ else if (cur_level > low_level)
+ level = low_level;
+ ++current_col;
+ }
+ }
}
if (level > wp->w_p_fdn)
{
--
2.9.3
