Merge branch 'vim'
[MacVim.git] / src / syntax.c
blob9debd935f3704c7836b6e8d75309cc53dec71d9e
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * syntax.c: code for syntax highlighting
14 #include "vim.h"
17 * Structure that stores information about a highlight group.
18 * The ID of a highlight group is also called group ID. It is the index in
19 * the highlight_ga array PLUS ONE.
21 struct hl_group
23 char_u *sg_name; /* highlight group name */
24 char_u *sg_name_u; /* uppercase of sg_name */
25 /* for normal terminals */
26 int sg_term; /* "term=" highlighting attributes */
27 char_u *sg_start; /* terminal string for start highl */
28 char_u *sg_stop; /* terminal string for stop highl */
29 int sg_term_attr; /* Screen attr for term mode */
30 /* for color terminals */
31 int sg_cterm; /* "cterm=" highlighting attr */
32 int sg_cterm_bold; /* bold attr was set for light color */
33 int sg_cterm_fg; /* terminal fg color number + 1 */
34 int sg_cterm_bg; /* terminal bg color number + 1 */
35 int sg_cterm_attr; /* Screen attr for color term mode */
36 #ifdef FEAT_GUI
37 /* for when using the GUI */
38 int sg_gui; /* "gui=" highlighting attributes */
39 guicolor_T sg_gui_fg; /* GUI foreground color handle */
40 char_u *sg_gui_fg_name;/* GUI foreground color name */
41 guicolor_T sg_gui_bg; /* GUI background color handle */
42 char_u *sg_gui_bg_name;/* GUI background color name */
43 guicolor_T sg_gui_sp; /* GUI special color handle */
44 char_u *sg_gui_sp_name;/* GUI special color name */
45 GuiFont sg_font; /* GUI font handle */
46 #ifdef FEAT_XFONTSET
47 GuiFontset sg_fontset; /* GUI fontset handle */
48 #endif
49 char_u *sg_font_name; /* GUI font or fontset name */
50 int sg_gui_attr; /* Screen attr for GUI mode */
51 #endif
52 int sg_link; /* link to this highlight group ID */
53 int sg_set; /* combination of SG_* flags */
54 #ifdef FEAT_EVAL
55 scid_T sg_scriptID; /* script in which the group was last set */
56 #endif
59 #define SG_TERM 1 /* term has been set */
60 #define SG_CTERM 2 /* cterm has been set */
61 #define SG_GUI 4 /* gui has been set */
62 #define SG_LINK 8 /* link has been set */
64 static garray_T highlight_ga; /* highlight groups for 'highlight' option */
66 #define HL_TABLE() ((struct hl_group *)((highlight_ga.ga_data)))
68 #ifdef FEAT_CMDL_COMPL
69 /* Flags to indicate an additional string for highlight name completion. */
70 static int include_none = 0; /* when 1 include "None" */
71 static int include_default = 0; /* when 1 include "default" */
72 static int include_link = 0; /* when 2 include "link" and "clear" */
73 #endif
76 * The "term", "cterm" and "gui" arguments can be any combination of the
77 * following names, separated by commas (but no spaces!).
79 static char *(hl_name_table[]) =
80 {"bold", "standout", "underline", "undercurl",
81 "italic", "reverse", "inverse", "NONE"};
82 static int hl_attr_table[] =
83 {HL_BOLD, HL_STANDOUT, HL_UNDERLINE, HL_UNDERCURL, HL_ITALIC, HL_INVERSE, HL_INVERSE, 0};
85 static int get_attr_entry __ARGS((garray_T *table, attrentry_T *aep));
86 static void syn_unadd_group __ARGS((void));
87 static void set_hl_attr __ARGS((int idx));
88 static void highlight_list_one __ARGS((int id));
89 static int highlight_list_arg __ARGS((int id, int didh, int type, int iarg, char_u *sarg, char *name));
90 static int syn_add_group __ARGS((char_u *name));
91 static int syn_list_header __ARGS((int did_header, int outlen, int id));
92 static int hl_has_settings __ARGS((int idx, int check_link));
93 static void highlight_clear __ARGS((int idx));
95 #ifdef FEAT_GUI
96 static void gui_do_one_color __ARGS((int idx, int do_menu, int do_tooltip));
97 static int set_group_colors __ARGS((char_u *name, guicolor_T *fgp, guicolor_T *bgp, int do_menu, int use_norm, int do_tooltip));
98 static guicolor_T color_name2handle __ARGS((char_u *name));
99 static GuiFont font_name2handle __ARGS((char_u *name));
100 # ifdef FEAT_XFONTSET
101 static GuiFontset fontset_name2handle __ARGS((char_u *name, int fixed_width));
102 # endif
103 static void hl_do_font __ARGS((int idx, char_u *arg, int do_normal, int do_menu, int do_tooltip));
104 #endif
107 * An attribute number is the index in attr_table plus ATTR_OFF.
109 #define ATTR_OFF (HL_ALL + 1)
111 #if defined(FEAT_SYN_HL) || defined(PROTO)
113 #define SYN_NAMELEN 50 /* maximum length of a syntax name */
115 /* different types of offsets that are possible */
116 #define SPO_MS_OFF 0 /* match start offset */
117 #define SPO_ME_OFF 1 /* match end offset */
118 #define SPO_HS_OFF 2 /* highl. start offset */
119 #define SPO_HE_OFF 3 /* highl. end offset */
120 #define SPO_RS_OFF 4 /* region start offset */
121 #define SPO_RE_OFF 5 /* region end offset */
122 #define SPO_LC_OFF 6 /* leading context offset */
123 #define SPO_COUNT 7
125 static char *(spo_name_tab[SPO_COUNT]) =
126 {"ms=", "me=", "hs=", "he=", "rs=", "re=", "lc="};
129 * The patterns that are being searched for are stored in a syn_pattern.
130 * A match item consists of one pattern.
131 * A start/end item consists of n start patterns and m end patterns.
132 * A start/skip/end item consists of n start patterns, one skip pattern and m
133 * end patterns.
134 * For the latter two, the patterns are always consecutive: start-skip-end.
136 * A character offset can be given for the matched text (_m_start and _m_end)
137 * and for the actually highlighted text (_h_start and _h_end).
139 typedef struct syn_pattern
141 char sp_type; /* see SPTYPE_ defines below */
142 char sp_syncing; /* this item used for syncing */
143 short sp_flags; /* see HL_ defines below */
144 struct sp_syn sp_syn; /* struct passed to in_id_list() */
145 short sp_syn_match_id; /* highlight group ID of pattern */
146 char_u *sp_pattern; /* regexp to match, pattern */
147 regprog_T *sp_prog; /* regexp to match, program */
148 int sp_ic; /* ignore-case flag for sp_prog */
149 short sp_off_flags; /* see below */
150 int sp_offsets[SPO_COUNT]; /* offsets */
151 short *sp_cont_list; /* cont. group IDs, if non-zero */
152 short *sp_next_list; /* next group IDs, if non-zero */
153 int sp_sync_idx; /* sync item index (syncing only) */
154 int sp_line_id; /* ID of last line where tried */
155 int sp_startcol; /* next match in sp_line_id line */
156 } synpat_T;
158 /* The sp_off_flags are computed like this:
159 * offset from the start of the matched text: (1 << SPO_XX_OFF)
160 * offset from the end of the matched text: (1 << (SPO_XX_OFF + SPO_COUNT))
161 * When both are present, only one is used.
164 #define SPTYPE_MATCH 1 /* match keyword with this group ID */
165 #define SPTYPE_START 2 /* match a regexp, start of item */
166 #define SPTYPE_END 3 /* match a regexp, end of item */
167 #define SPTYPE_SKIP 4 /* match a regexp, skip within item */
169 #define HL_CONTAINED 0x01 /* not used on toplevel */
170 #define HL_TRANSP 0x02 /* has no highlighting */
171 #define HL_ONELINE 0x04 /* match within one line only */
172 #define HL_HAS_EOL 0x08 /* end pattern that matches with $ */
173 #define HL_SYNC_HERE 0x10 /* sync point after this item (syncing only) */
174 #define HL_SYNC_THERE 0x20 /* sync point at current line (syncing only) */
175 #define HL_MATCH 0x40 /* use match ID instead of item ID */
176 #define HL_SKIPNL 0x80 /* nextgroup can skip newlines */
177 #define HL_SKIPWHITE 0x100 /* nextgroup can skip white space */
178 #define HL_SKIPEMPTY 0x200 /* nextgroup can skip empty lines */
179 #define HL_KEEPEND 0x400 /* end match always kept */
180 #define HL_EXCLUDENL 0x800 /* exclude NL from match */
181 #define HL_DISPLAY 0x1000 /* only used for displaying, not syncing */
182 #define HL_FOLD 0x2000 /* define fold */
183 #define HL_EXTEND 0x4000 /* ignore a keepend */
184 /* These don't fit in a short, thus can't be used for syntax items, only for
185 * si_flags and bs_flags. */
186 #define HL_MATCHCONT 0x8000 /* match continued from previous line */
187 #define HL_TRANS_CONT 0x10000L /* transparent item without contains arg */
189 #define SYN_ITEMS(buf) ((synpat_T *)((buf)->b_syn_patterns.ga_data))
191 #define NONE_IDX -2 /* value of sp_sync_idx for "NONE" */
194 * Flags for b_syn_sync_flags:
196 #define SF_CCOMMENT 0x01 /* sync on a C-style comment */
197 #define SF_MATCH 0x02 /* sync by matching a pattern */
199 #define SYN_STATE_P(ssp) ((bufstate_T *)((ssp)->ga_data))
201 #define MAXKEYWLEN 80 /* maximum length of a keyword */
204 * The attributes of the syntax item that has been recognized.
206 static int current_attr = 0; /* attr of current syntax word */
207 #ifdef FEAT_EVAL
208 static int current_id = 0; /* ID of current char for syn_get_id() */
209 static int current_trans_id = 0; /* idem, transparency removed */
210 #endif
212 typedef struct syn_cluster_S
214 char_u *scl_name; /* syntax cluster name */
215 char_u *scl_name_u; /* uppercase of scl_name */
216 short *scl_list; /* IDs in this syntax cluster */
217 } syn_cluster_T;
220 * Methods of combining two clusters
222 #define CLUSTER_REPLACE 1 /* replace first list with second */
223 #define CLUSTER_ADD 2 /* add second list to first */
224 #define CLUSTER_SUBTRACT 3 /* subtract second list from first */
226 #define SYN_CLSTR(buf) ((syn_cluster_T *)((buf)->b_syn_clusters.ga_data))
229 * Syntax group IDs have different types:
230 * 0 - 9999 normal syntax groups
231 * 10000 - 14999 ALLBUT indicator (current_syn_inc_tag added)
232 * 15000 - 19999 TOP indicator (current_syn_inc_tag added)
233 * 20000 - 24999 CONTAINED indicator (current_syn_inc_tag added)
234 * >= 25000 cluster IDs (subtract SYNID_CLUSTER for the cluster ID)
236 #define SYNID_ALLBUT 10000 /* syntax group ID for contains=ALLBUT */
237 #define SYNID_TOP 15000 /* syntax group ID for contains=TOP */
238 #define SYNID_CONTAINED 20000 /* syntax group ID for contains=CONTAINED */
239 #define SYNID_CLUSTER 25000 /* first syntax group ID for clusters */
242 * Annoying Hack(TM): ":syn include" needs this pointer to pass to
243 * expand_filename(). Most of the other syntax commands don't need it, so
244 * instead of passing it to them, we stow it here.
246 static char_u **syn_cmdlinep;
249 * Another Annoying Hack(TM): To prevent rules from other ":syn include"'d
250 * files from from leaking into ALLBUT lists, we assign a unique ID to the
251 * rules in each ":syn include"'d file.
253 static int current_syn_inc_tag = 0;
254 static int running_syn_inc_tag = 0;
257 * In a hashtable item "hi_key" points to "keyword" in a keyentry.
258 * This avoids adding a pointer to the hashtable item.
259 * KE2HIKEY() converts a var pointer to a hashitem key pointer.
260 * HIKEY2KE() converts a hashitem key pointer to a var pointer.
261 * HI2KE() converts a hashitem pointer to a var pointer.
263 static keyentry_T dumkey;
264 #define KE2HIKEY(kp) ((kp)->keyword)
265 #define HIKEY2KE(p) ((keyentry_T *)((p) - (dumkey.keyword - (char_u *)&dumkey)))
266 #define HI2KE(hi) HIKEY2KE((hi)->hi_key)
269 * To reduce the time spent in keepend(), remember at which level in the state
270 * stack the first item with "keepend" is present. When "-1", there is no
271 * "keepend" on the stack.
273 static int keepend_level = -1;
276 * For the current state we need to remember more than just the idx.
277 * When si_m_endpos.lnum is 0, the items other than si_idx are unknown.
278 * (The end positions have the column number of the next char)
280 typedef struct state_item
282 int si_idx; /* index of syntax pattern or
283 KEYWORD_IDX */
284 int si_id; /* highlight group ID for keywords */
285 int si_trans_id; /* idem, transparency removed */
286 int si_m_lnum; /* lnum of the match */
287 int si_m_startcol; /* starting column of the match */
288 lpos_T si_m_endpos; /* just after end posn of the match */
289 lpos_T si_h_startpos; /* start position of the highlighting */
290 lpos_T si_h_endpos; /* end position of the highlighting */
291 lpos_T si_eoe_pos; /* end position of end pattern */
292 int si_end_idx; /* group ID for end pattern or zero */
293 int si_ends; /* if match ends before si_m_endpos */
294 int si_attr; /* attributes in this state */
295 long si_flags; /* HL_HAS_EOL flag in this state, and
296 * HL_SKIP* for si_next_list */
297 short *si_cont_list; /* list of contained groups */
298 short *si_next_list; /* nextgroup IDs after this item ends */
299 reg_extmatch_T *si_extmatch; /* \z(...\) matches from start
300 * pattern */
301 } stateitem_T;
303 #define KEYWORD_IDX -1 /* value of si_idx for keywords */
304 #define ID_LIST_ALL (short *)-1 /* valid of si_cont_list for containing all
305 but contained groups */
308 * Struct to reduce the number of arguments to get_syn_options(), it's used
309 * very often.
311 typedef struct
313 int flags; /* flags for contained and transparent */
314 int keyword; /* TRUE for ":syn keyword" */
315 int *sync_idx; /* syntax item for "grouphere" argument, NULL
316 if not allowed */
317 char has_cont_list; /* TRUE if "cont_list" can be used */
318 short *cont_list; /* group IDs for "contains" argument */
319 short *cont_in_list; /* group IDs for "containedin" argument */
320 short *next_list; /* group IDs for "nextgroup" argument */
321 } syn_opt_arg_T;
324 * The next possible match in the current line for any pattern is remembered,
325 * to avoid having to try for a match in each column.
326 * If next_match_idx == -1, not tried (in this line) yet.
327 * If next_match_col == MAXCOL, no match found in this line.
328 * (All end positions have the column of the char after the end)
330 static int next_match_col; /* column for start of next match */
331 static lpos_T next_match_m_endpos; /* position for end of next match */
332 static lpos_T next_match_h_startpos; /* pos. for highl. start of next match */
333 static lpos_T next_match_h_endpos; /* pos. for highl. end of next match */
334 static int next_match_idx; /* index of matched item */
335 static long next_match_flags; /* flags for next match */
336 static lpos_T next_match_eos_pos; /* end of start pattn (start region) */
337 static lpos_T next_match_eoe_pos; /* pos. for end of end pattern */
338 static int next_match_end_idx; /* ID of group for end pattn or zero */
339 static reg_extmatch_T *next_match_extmatch = NULL;
342 * A state stack is an array of integers or stateitem_T, stored in a
343 * garray_T. A state stack is invalid if it's itemsize entry is zero.
345 #define INVALID_STATE(ssp) ((ssp)->ga_itemsize == 0)
346 #define VALID_STATE(ssp) ((ssp)->ga_itemsize != 0)
349 * The current state (within the line) of the recognition engine.
350 * When current_state.ga_itemsize is 0 the current state is invalid.
352 static win_T *syn_win; /* current window for highlighting */
353 static buf_T *syn_buf; /* current buffer for highlighting */
354 static linenr_T current_lnum = 0; /* lnum of current state */
355 static colnr_T current_col = 0; /* column of current state */
356 static int current_state_stored = 0; /* TRUE if stored current state
357 * after setting current_finished */
358 static int current_finished = 0; /* current line has been finished */
359 static garray_T current_state /* current stack of state_items */
360 = {0, 0, 0, 0, NULL};
361 static short *current_next_list = NULL; /* when non-zero, nextgroup list */
362 static int current_next_flags = 0; /* flags for current_next_list */
363 static int current_line_id = 0; /* unique number for current line */
365 #define CUR_STATE(idx) ((stateitem_T *)(current_state.ga_data))[idx]
367 static void syn_sync __ARGS((win_T *wp, linenr_T lnum, synstate_T *last_valid));
368 static int syn_match_linecont __ARGS((linenr_T lnum));
369 static void syn_start_line __ARGS((void));
370 static void syn_update_ends __ARGS((int startofline));
371 static void syn_stack_alloc __ARGS((void));
372 static int syn_stack_cleanup __ARGS((void));
373 static void syn_stack_free_entry __ARGS((buf_T *buf, synstate_T *p));
374 static synstate_T *syn_stack_find_entry __ARGS((linenr_T lnum));
375 static synstate_T *store_current_state __ARGS((void));
376 static void load_current_state __ARGS((synstate_T *from));
377 static void invalidate_current_state __ARGS((void));
378 static int syn_stack_equal __ARGS((synstate_T *sp));
379 static void validate_current_state __ARGS((void));
380 static int syn_finish_line __ARGS((int syncing));
381 static int syn_current_attr __ARGS((int syncing, int displaying, int *can_spell, int keep_state));
382 static int did_match_already __ARGS((int idx, garray_T *gap));
383 static stateitem_T *push_next_match __ARGS((stateitem_T *cur_si));
384 static void check_state_ends __ARGS((void));
385 static void update_si_attr __ARGS((int idx));
386 static void check_keepend __ARGS((void));
387 static void update_si_end __ARGS((stateitem_T *sip, int startcol, int force));
388 static short *copy_id_list __ARGS((short *list));
389 static int in_id_list __ARGS((stateitem_T *item, short *cont_list, struct sp_syn *ssp, int contained));
390 static int push_current_state __ARGS((int idx));
391 static void pop_current_state __ARGS((void));
393 static void find_endpos __ARGS((int idx, lpos_T *startpos, lpos_T *m_endpos, lpos_T *hl_endpos, long *flagsp, lpos_T *end_endpos, int *end_idx, reg_extmatch_T *start_ext));
394 static void clear_syn_state __ARGS((synstate_T *p));
395 static void clear_current_state __ARGS((void));
397 static void limit_pos __ARGS((lpos_T *pos, lpos_T *limit));
398 static void limit_pos_zero __ARGS((lpos_T *pos, lpos_T *limit));
399 static void syn_add_end_off __ARGS((lpos_T *result, regmmatch_T *regmatch, synpat_T *spp, int idx, int extra));
400 static void syn_add_start_off __ARGS((lpos_T *result, regmmatch_T *regmatch, synpat_T *spp, int idx, int extra));
401 static char_u *syn_getcurline __ARGS((void));
402 static int syn_regexec __ARGS((regmmatch_T *rmp, linenr_T lnum, colnr_T col));
403 static int check_keyword_id __ARGS((char_u *line, int startcol, int *endcol, long *flags, short **next_list, stateitem_T *cur_si));
404 static void syn_cmd_case __ARGS((exarg_T *eap, int syncing));
405 static void syn_cmd_spell __ARGS((exarg_T *eap, int syncing));
406 static void syntax_sync_clear __ARGS((void));
407 static void syn_remove_pattern __ARGS((buf_T *buf, int idx));
408 static void syn_clear_pattern __ARGS((buf_T *buf, int i));
409 static void syn_clear_cluster __ARGS((buf_T *buf, int i));
410 static void syn_cmd_clear __ARGS((exarg_T *eap, int syncing));
411 static void syn_clear_one __ARGS((int id, int syncing));
412 static void syn_cmd_on __ARGS((exarg_T *eap, int syncing));
413 static void syn_cmd_enable __ARGS((exarg_T *eap, int syncing));
414 static void syn_cmd_reset __ARGS((exarg_T *eap, int syncing));
415 static void syn_cmd_manual __ARGS((exarg_T *eap, int syncing));
416 static void syn_cmd_off __ARGS((exarg_T *eap, int syncing));
417 static void syn_cmd_onoff __ARGS((exarg_T *eap, char *name));
418 static void syn_cmd_list __ARGS((exarg_T *eap, int syncing));
419 static void syn_lines_msg __ARGS((void));
420 static void syn_match_msg __ARGS((void));
421 static void syn_list_one __ARGS((int id, int syncing, int link_only));
422 static void syn_list_cluster __ARGS((int id));
423 static void put_id_list __ARGS((char_u *name, short *list, int attr));
424 static void put_pattern __ARGS((char *s, int c, synpat_T *spp, int attr));
425 static int syn_list_keywords __ARGS((int id, hashtab_T *ht, int did_header, int attr));
426 static void syn_clear_keyword __ARGS((int id, hashtab_T *ht));
427 static void clear_keywtab __ARGS((hashtab_T *ht));
428 static void add_keyword __ARGS((char_u *name, int id, int flags, short *cont_in_list, short *next_list));
429 static char_u *get_group_name __ARGS((char_u *arg, char_u **name_end));
430 static char_u *get_syn_options __ARGS((char_u *arg, syn_opt_arg_T *opt));
431 static void syn_cmd_include __ARGS((exarg_T *eap, int syncing));
432 static void syn_cmd_keyword __ARGS((exarg_T *eap, int syncing));
433 static void syn_cmd_match __ARGS((exarg_T *eap, int syncing));
434 static void syn_cmd_region __ARGS((exarg_T *eap, int syncing));
435 #ifdef __BORLANDC__
436 static int _RTLENTRYF syn_compare_stub __ARGS((const void *v1, const void *v2));
437 #else
438 static int syn_compare_stub __ARGS((const void *v1, const void *v2));
439 #endif
440 static void syn_cmd_cluster __ARGS((exarg_T *eap, int syncing));
441 static int syn_scl_name2id __ARGS((char_u *name));
442 static int syn_scl_namen2id __ARGS((char_u *linep, int len));
443 static int syn_check_cluster __ARGS((char_u *pp, int len));
444 static int syn_add_cluster __ARGS((char_u *name));
445 static void init_syn_patterns __ARGS((void));
446 static char_u *get_syn_pattern __ARGS((char_u *arg, synpat_T *ci));
447 static void syn_cmd_sync __ARGS((exarg_T *eap, int syncing));
448 static int get_id_list __ARGS((char_u **arg, int keylen, short **list));
449 static void syn_combine_list __ARGS((short **clstr1, short **clstr2, int list_op));
450 static void syn_incl_toplevel __ARGS((int id, int *flagsp));
453 * Start the syntax recognition for a line. This function is normally called
454 * from the screen updating, once for each displayed line.
455 * The buffer is remembered in syn_buf, because get_syntax_attr() doesn't get
456 * it. Careful: curbuf and curwin are likely to point to another buffer and
457 * window.
459 void
460 syntax_start(wp, lnum)
461 win_T *wp;
462 linenr_T lnum;
464 synstate_T *p;
465 synstate_T *last_valid = NULL;
466 synstate_T *last_min_valid = NULL;
467 synstate_T *sp, *prev = NULL;
468 linenr_T parsed_lnum;
469 linenr_T first_stored;
470 int dist;
471 static int changedtick = 0; /* remember the last change ID */
474 * After switching buffers, invalidate current_state.
475 * Also do this when a change was made, the current state may be invalid
476 * then.
478 if (syn_buf != wp->w_buffer || changedtick != syn_buf->b_changedtick)
480 invalidate_current_state();
481 syn_buf = wp->w_buffer;
483 changedtick = syn_buf->b_changedtick;
484 syn_win = wp;
487 * Allocate syntax stack when needed.
489 syn_stack_alloc();
490 if (syn_buf->b_sst_array == NULL)
491 return; /* out of memory */
492 syn_buf->b_sst_lasttick = display_tick;
495 * If the state of the end of the previous line is useful, store it.
497 if (VALID_STATE(&current_state)
498 && current_lnum < lnum
499 && current_lnum < syn_buf->b_ml.ml_line_count)
501 (void)syn_finish_line(FALSE);
502 if (!current_state_stored)
504 ++current_lnum;
505 (void)store_current_state();
509 * If the current_lnum is now the same as "lnum", keep the current
510 * state (this happens very often!). Otherwise invalidate
511 * current_state and figure it out below.
513 if (current_lnum != lnum)
514 invalidate_current_state();
516 else
517 invalidate_current_state();
520 * Try to synchronize from a saved state in b_sst_array[].
521 * Only do this if lnum is not before and not to far beyond a saved state.
523 if (INVALID_STATE(&current_state) && syn_buf->b_sst_array != NULL)
525 /* Find last valid saved state before start_lnum. */
526 for (p = syn_buf->b_sst_first; p != NULL; p = p->sst_next)
528 if (p->sst_lnum > lnum)
529 break;
530 if (p->sst_lnum <= lnum && p->sst_change_lnum == 0)
532 last_valid = p;
533 if (p->sst_lnum >= lnum - syn_buf->b_syn_sync_minlines)
534 last_min_valid = p;
537 if (last_min_valid != NULL)
538 load_current_state(last_min_valid);
542 * If "lnum" is before or far beyond a line with a saved state, need to
543 * re-synchronize.
545 if (INVALID_STATE(&current_state))
547 syn_sync(wp, lnum, last_valid);
548 first_stored = current_lnum + syn_buf->b_syn_sync_minlines;
550 else
551 first_stored = current_lnum;
554 * Advance from the sync point or saved state until the current line.
555 * Save some entries for syncing with later on.
557 if (syn_buf->b_sst_len <= Rows)
558 dist = 999999;
559 else
560 dist = syn_buf->b_ml.ml_line_count / (syn_buf->b_sst_len - Rows) + 1;
561 while (current_lnum < lnum)
563 syn_start_line();
564 (void)syn_finish_line(FALSE);
565 ++current_lnum;
567 /* If we parsed at least "minlines" lines or started at a valid
568 * state, the current state is considered valid. */
569 if (current_lnum >= first_stored)
571 /* Check if the saved state entry is for the current line and is
572 * equal to the current state. If so, then validate all saved
573 * states that depended on a change before the parsed line. */
574 if (prev == NULL)
575 prev = syn_stack_find_entry(current_lnum - 1);
576 if (prev == NULL)
577 sp = syn_buf->b_sst_first;
578 else
579 sp = prev;
580 while (sp != NULL && sp->sst_lnum < current_lnum)
581 sp = sp->sst_next;
582 if (sp != NULL
583 && sp->sst_lnum == current_lnum
584 && syn_stack_equal(sp))
586 parsed_lnum = current_lnum;
587 prev = sp;
588 while (sp != NULL && sp->sst_change_lnum <= parsed_lnum)
590 if (sp->sst_lnum <= lnum)
591 /* valid state before desired line, use this one */
592 prev = sp;
593 else if (sp->sst_change_lnum == 0)
594 /* past saved states depending on change, break here. */
595 break;
596 sp->sst_change_lnum = 0;
597 sp = sp->sst_next;
599 load_current_state(prev);
601 /* Store the state at this line when it's the first one, the line
602 * where we start parsing, or some distance from the previously
603 * saved state. But only when parsed at least 'minlines'. */
604 else if (prev == NULL
605 || current_lnum == lnum
606 || current_lnum >= prev->sst_lnum + dist)
607 prev = store_current_state();
610 /* This can take a long time: break when CTRL-C pressed. The current
611 * state will be wrong then. */
612 line_breakcheck();
613 if (got_int)
615 current_lnum = lnum;
616 break;
620 syn_start_line();
624 * We cannot simply discard growarrays full of state_items or buf_states; we
625 * have to manually release their extmatch pointers first.
627 static void
628 clear_syn_state(p)
629 synstate_T *p;
631 int i;
632 garray_T *gap;
634 if (p->sst_stacksize > SST_FIX_STATES)
636 gap = &(p->sst_union.sst_ga);
637 for (i = 0; i < gap->ga_len; i++)
638 unref_extmatch(SYN_STATE_P(gap)[i].bs_extmatch);
639 ga_clear(gap);
641 else
643 for (i = 0; i < p->sst_stacksize; i++)
644 unref_extmatch(p->sst_union.sst_stack[i].bs_extmatch);
649 * Cleanup the current_state stack.
651 static void
652 clear_current_state()
654 int i;
655 stateitem_T *sip;
657 sip = (stateitem_T *)(current_state.ga_data);
658 for (i = 0; i < current_state.ga_len; i++)
659 unref_extmatch(sip[i].si_extmatch);
660 ga_clear(&current_state);
664 * Try to find a synchronisation point for line "lnum".
666 * This sets current_lnum and the current state. One of three methods is
667 * used:
668 * 1. Search backwards for the end of a C-comment.
669 * 2. Search backwards for given sync patterns.
670 * 3. Simply start on a given number of lines above "lnum".
672 static void
673 syn_sync(wp, start_lnum, last_valid)
674 win_T *wp;
675 linenr_T start_lnum;
676 synstate_T *last_valid;
678 buf_T *curbuf_save;
679 win_T *curwin_save;
680 pos_T cursor_save;
681 int idx;
682 linenr_T lnum;
683 linenr_T end_lnum;
684 linenr_T break_lnum;
685 int had_sync_point;
686 stateitem_T *cur_si;
687 synpat_T *spp;
688 char_u *line;
689 int found_flags = 0;
690 int found_match_idx = 0;
691 linenr_T found_current_lnum = 0;
692 int found_current_col= 0;
693 lpos_T found_m_endpos;
694 colnr_T prev_current_col;
697 * Clear any current state that might be hanging around.
699 invalidate_current_state();
702 * Start at least "minlines" back. Default starting point for parsing is
703 * there.
704 * Start further back, to avoid that scrolling backwards will result in
705 * resyncing for every line. Now it resyncs only one out of N lines,
706 * where N is minlines * 1.5, or minlines * 2 if minlines is small.
707 * Watch out for overflow when minlines is MAXLNUM.
709 if (syn_buf->b_syn_sync_minlines > start_lnum)
710 start_lnum = 1;
711 else
713 if (syn_buf->b_syn_sync_minlines == 1)
714 lnum = 1;
715 else if (syn_buf->b_syn_sync_minlines < 10)
716 lnum = syn_buf->b_syn_sync_minlines * 2;
717 else
718 lnum = syn_buf->b_syn_sync_minlines * 3 / 2;
719 if (syn_buf->b_syn_sync_maxlines != 0
720 && lnum > syn_buf->b_syn_sync_maxlines)
721 lnum = syn_buf->b_syn_sync_maxlines;
722 if (lnum >= start_lnum)
723 start_lnum = 1;
724 else
725 start_lnum -= lnum;
727 current_lnum = start_lnum;
730 * 1. Search backwards for the end of a C-style comment.
732 if (syn_buf->b_syn_sync_flags & SF_CCOMMENT)
734 /* Need to make syn_buf the current buffer for a moment, to be able to
735 * use find_start_comment(). */
736 curwin_save = curwin;
737 curwin = wp;
738 curbuf_save = curbuf;
739 curbuf = syn_buf;
742 * Skip lines that end in a backslash.
744 for ( ; start_lnum > 1; --start_lnum)
746 line = ml_get(start_lnum - 1);
747 if (*line == NUL || *(line + STRLEN(line) - 1) != '\\')
748 break;
750 current_lnum = start_lnum;
752 /* set cursor to start of search */
753 cursor_save = wp->w_cursor;
754 wp->w_cursor.lnum = start_lnum;
755 wp->w_cursor.col = 0;
758 * If the line is inside a comment, need to find the syntax item that
759 * defines the comment.
760 * Restrict the search for the end of a comment to b_syn_sync_maxlines.
762 if (find_start_comment((int)syn_buf->b_syn_sync_maxlines) != NULL)
764 for (idx = syn_buf->b_syn_patterns.ga_len; --idx >= 0; )
765 if (SYN_ITEMS(syn_buf)[idx].sp_syn.id == syn_buf->b_syn_sync_id
766 && SYN_ITEMS(syn_buf)[idx].sp_type == SPTYPE_START)
768 validate_current_state();
769 if (push_current_state(idx) == OK)
770 update_si_attr(current_state.ga_len - 1);
771 break;
775 /* restore cursor and buffer */
776 wp->w_cursor = cursor_save;
777 curwin = curwin_save;
778 curbuf = curbuf_save;
782 * 2. Search backwards for given sync patterns.
784 else if (syn_buf->b_syn_sync_flags & SF_MATCH)
786 if (syn_buf->b_syn_sync_maxlines != 0
787 && start_lnum > syn_buf->b_syn_sync_maxlines)
788 break_lnum = start_lnum - syn_buf->b_syn_sync_maxlines;
789 else
790 break_lnum = 0;
792 found_m_endpos.lnum = 0;
793 found_m_endpos.col = 0;
794 end_lnum = start_lnum;
795 lnum = start_lnum;
796 while (--lnum > break_lnum)
798 /* This can take a long time: break when CTRL-C pressed. */
799 line_breakcheck();
800 if (got_int)
802 invalidate_current_state();
803 current_lnum = start_lnum;
804 break;
807 /* Check if we have run into a valid saved state stack now. */
808 if (last_valid != NULL && lnum == last_valid->sst_lnum)
810 load_current_state(last_valid);
811 break;
815 * Check if the previous line has the line-continuation pattern.
817 if (lnum > 1 && syn_match_linecont(lnum - 1))
818 continue;
821 * Start with nothing on the state stack
823 validate_current_state();
825 for (current_lnum = lnum; current_lnum < end_lnum; ++current_lnum)
827 syn_start_line();
828 for (;;)
830 had_sync_point = syn_finish_line(TRUE);
832 * When a sync point has been found, remember where, and
833 * continue to look for another one, further on in the line.
835 if (had_sync_point && current_state.ga_len)
837 cur_si = &CUR_STATE(current_state.ga_len - 1);
838 if (cur_si->si_m_endpos.lnum > start_lnum)
840 /* ignore match that goes to after where started */
841 current_lnum = end_lnum;
842 break;
844 if (cur_si->si_idx < 0)
846 /* Cannot happen? */
847 found_flags = 0;
848 found_match_idx = KEYWORD_IDX;
850 else
852 spp = &(SYN_ITEMS(syn_buf)[cur_si->si_idx]);
853 found_flags = spp->sp_flags;
854 found_match_idx = spp->sp_sync_idx;
856 found_current_lnum = current_lnum;
857 found_current_col = current_col;
858 found_m_endpos = cur_si->si_m_endpos;
860 * Continue after the match (be aware of a zero-length
861 * match).
863 if (found_m_endpos.lnum > current_lnum)
865 current_lnum = found_m_endpos.lnum;
866 current_col = found_m_endpos.col;
867 if (current_lnum >= end_lnum)
868 break;
870 else if (found_m_endpos.col > current_col)
871 current_col = found_m_endpos.col;
872 else
873 ++current_col;
875 /* syn_current_attr() will have skipped the check for
876 * an item that ends here, need to do that now. Be
877 * careful not to go past the NUL. */
878 prev_current_col = current_col;
879 if (syn_getcurline()[current_col] != NUL)
880 ++current_col;
881 check_state_ends();
882 current_col = prev_current_col;
884 else
885 break;
890 * If a sync point was encountered, break here.
892 if (found_flags)
895 * Put the item that was specified by the sync point on the
896 * state stack. If there was no item specified, make the
897 * state stack empty.
899 clear_current_state();
900 if (found_match_idx >= 0
901 && push_current_state(found_match_idx) == OK)
902 update_si_attr(current_state.ga_len - 1);
905 * When using "grouphere", continue from the sync point
906 * match, until the end of the line. Parsing starts at
907 * the next line.
908 * For "groupthere" the parsing starts at start_lnum.
910 if (found_flags & HL_SYNC_HERE)
912 if (current_state.ga_len)
914 cur_si = &CUR_STATE(current_state.ga_len - 1);
915 cur_si->si_h_startpos.lnum = found_current_lnum;
916 cur_si->si_h_startpos.col = found_current_col;
917 update_si_end(cur_si, (int)current_col, TRUE);
918 check_keepend();
920 current_col = found_m_endpos.col;
921 current_lnum = found_m_endpos.lnum;
922 (void)syn_finish_line(FALSE);
923 ++current_lnum;
925 else
926 current_lnum = start_lnum;
928 break;
931 end_lnum = lnum;
932 invalidate_current_state();
935 /* Ran into start of the file or exceeded maximum number of lines */
936 if (lnum <= break_lnum)
938 invalidate_current_state();
939 current_lnum = break_lnum + 1;
943 validate_current_state();
947 * Return TRUE if the line-continuation pattern matches in line "lnum".
949 static int
950 syn_match_linecont(lnum)
951 linenr_T lnum;
953 regmmatch_T regmatch;
955 if (syn_buf->b_syn_linecont_prog != NULL)
957 regmatch.rmm_ic = syn_buf->b_syn_linecont_ic;
958 regmatch.regprog = syn_buf->b_syn_linecont_prog;
959 return syn_regexec(&regmatch, lnum, (colnr_T)0);
961 return FALSE;
965 * Prepare the current state for the start of a line.
967 static void
968 syn_start_line()
970 current_finished = FALSE;
971 current_col = 0;
974 * Need to update the end of a start/skip/end that continues from the
975 * previous line and regions that have "keepend".
977 if (current_state.ga_len > 0)
978 syn_update_ends(TRUE);
980 next_match_idx = -1;
981 ++current_line_id;
985 * Check for items in the stack that need their end updated.
986 * When "startofline" is TRUE the last item is always updated.
987 * When "startofline" is FALSE the item with "keepend" is forcefully updated.
989 static void
990 syn_update_ends(startofline)
991 int startofline;
993 stateitem_T *cur_si;
994 int i;
995 int seen_keepend;
997 if (startofline)
999 /* Check for a match carried over from a previous line with a
1000 * contained region. The match ends as soon as the region ends. */
1001 for (i = 0; i < current_state.ga_len; ++i)
1003 cur_si = &CUR_STATE(i);
1004 if (cur_si->si_idx >= 0
1005 && (SYN_ITEMS(syn_buf)[cur_si->si_idx]).sp_type
1006 == SPTYPE_MATCH
1007 && cur_si->si_m_endpos.lnum < current_lnum)
1009 cur_si->si_flags |= HL_MATCHCONT;
1010 cur_si->si_m_endpos.lnum = 0;
1011 cur_si->si_m_endpos.col = 0;
1012 cur_si->si_h_endpos = cur_si->si_m_endpos;
1013 cur_si->si_ends = TRUE;
1019 * Need to update the end of a start/skip/end that continues from the
1020 * previous line. And regions that have "keepend", because they may
1021 * influence contained items. If we've just removed "extend"
1022 * (startofline == 0) then we should update ends of normal regions
1023 * contained inside "keepend" because "extend" could have extended
1024 * these "keepend" regions as well as contained normal regions.
1025 * Then check for items ending in column 0.
1027 i = current_state.ga_len - 1;
1028 if (keepend_level >= 0)
1029 for ( ; i > keepend_level; --i)
1030 if (CUR_STATE(i).si_flags & HL_EXTEND)
1031 break;
1033 seen_keepend = FALSE;
1034 for ( ; i < current_state.ga_len; ++i)
1036 cur_si = &CUR_STATE(i);
1037 if ((cur_si->si_flags & HL_KEEPEND)
1038 || (seen_keepend && !startofline)
1039 || (i == current_state.ga_len - 1 && startofline))
1041 cur_si->si_h_startpos.col = 0; /* start highl. in col 0 */
1042 cur_si->si_h_startpos.lnum = current_lnum;
1044 if (!(cur_si->si_flags & HL_MATCHCONT))
1045 update_si_end(cur_si, (int)current_col, !startofline);
1047 if (!startofline && (cur_si->si_flags & HL_KEEPEND))
1048 seen_keepend = TRUE;
1051 check_keepend();
1052 check_state_ends();
1055 /****************************************
1056 * Handling of the state stack cache.
1060 * EXPLANATION OF THE SYNTAX STATE STACK CACHE
1062 * To speed up syntax highlighting, the state stack for the start of some
1063 * lines is cached. These entries can be used to start parsing at that point.
1065 * The stack is kept in b_sst_array[] for each buffer. There is a list of
1066 * valid entries. b_sst_first points to the first one, then follow sst_next.
1067 * The entries are sorted on line number. The first entry is often for line 2
1068 * (line 1 always starts with an empty stack).
1069 * There is also a list for free entries. This construction is used to avoid
1070 * having to allocate and free memory blocks too often.
1072 * When making changes to the buffer, this is logged in b_mod_*. When calling
1073 * update_screen() to update the display, it will call
1074 * syn_stack_apply_changes() for each displayed buffer to adjust the cached
1075 * entries. The entries which are inside the changed area are removed,
1076 * because they must be recomputed. Entries below the changed have their line
1077 * number adjusted for deleted/inserted lines, and have their sst_change_lnum
1078 * set to indicate that a check must be made if the changed lines would change
1079 * the cached entry.
1081 * When later displaying lines, an entry is stored for each line. Displayed
1082 * lines are likely to be displayed again, in which case the state at the
1083 * start of the line is needed.
1084 * For not displayed lines, an entry is stored for every so many lines. These
1085 * entries will be used e.g., when scrolling backwards. The distance between
1086 * entries depends on the number of lines in the buffer. For small buffers
1087 * the distance is fixed at SST_DIST, for large buffers there is a fixed
1088 * number of entries SST_MAX_ENTRIES, and the distance is computed.
1092 * Free b_sst_array[] for buffer "buf".
1093 * Used when syntax items changed to force resyncing everywhere.
1095 void
1096 syn_stack_free_all(buf)
1097 buf_T *buf;
1099 synstate_T *p;
1100 win_T *wp;
1102 if (buf->b_sst_array != NULL)
1104 for (p = buf->b_sst_first; p != NULL; p = p->sst_next)
1105 clear_syn_state(p);
1106 vim_free(buf->b_sst_array);
1107 buf->b_sst_array = NULL;
1108 buf->b_sst_len = 0;
1110 #ifdef FEAT_FOLDING
1111 /* When using "syntax" fold method, must update all folds. */
1112 FOR_ALL_WINDOWS(wp)
1114 if (wp->w_buffer == buf && foldmethodIsSyntax(wp))
1115 foldUpdateAll(wp);
1117 #endif
1121 * Allocate the syntax state stack for syn_buf when needed.
1122 * If the number of entries in b_sst_array[] is much too big or a bit too
1123 * small, reallocate it.
1124 * Also used to allocate b_sst_array[] for the first time.
1126 static void
1127 syn_stack_alloc()
1129 long len;
1130 synstate_T *to, *from;
1131 synstate_T *sstp;
1133 len = syn_buf->b_ml.ml_line_count / SST_DIST + Rows * 2;
1134 if (len < SST_MIN_ENTRIES)
1135 len = SST_MIN_ENTRIES;
1136 else if (len > SST_MAX_ENTRIES)
1137 len = SST_MAX_ENTRIES;
1138 if (syn_buf->b_sst_len > len * 2 || syn_buf->b_sst_len < len)
1140 /* Allocate 50% too much, to avoid reallocating too often. */
1141 len = syn_buf->b_ml.ml_line_count;
1142 len = (len + len / 2) / SST_DIST + Rows * 2;
1143 if (len < SST_MIN_ENTRIES)
1144 len = SST_MIN_ENTRIES;
1145 else if (len > SST_MAX_ENTRIES)
1146 len = SST_MAX_ENTRIES;
1148 if (syn_buf->b_sst_array != NULL)
1150 /* When shrinking the array, cleanup the existing stack.
1151 * Make sure that all valid entries fit in the new array. */
1152 while (syn_buf->b_sst_len - syn_buf->b_sst_freecount + 2 > len
1153 && syn_stack_cleanup())
1155 if (len < syn_buf->b_sst_len - syn_buf->b_sst_freecount + 2)
1156 len = syn_buf->b_sst_len - syn_buf->b_sst_freecount + 2;
1159 sstp = (synstate_T *)alloc_clear((unsigned)(len * sizeof(synstate_T)));
1160 if (sstp == NULL) /* out of memory! */
1161 return;
1163 to = sstp - 1;
1164 if (syn_buf->b_sst_array != NULL)
1166 /* Move the states from the old array to the new one. */
1167 for (from = syn_buf->b_sst_first; from != NULL;
1168 from = from->sst_next)
1170 ++to;
1171 *to = *from;
1172 to->sst_next = to + 1;
1175 if (to != sstp - 1)
1177 to->sst_next = NULL;
1178 syn_buf->b_sst_first = sstp;
1179 syn_buf->b_sst_freecount = len - (int)(to - sstp) - 1;
1181 else
1183 syn_buf->b_sst_first = NULL;
1184 syn_buf->b_sst_freecount = len;
1187 /* Create the list of free entries. */
1188 syn_buf->b_sst_firstfree = to + 1;
1189 while (++to < sstp + len)
1190 to->sst_next = to + 1;
1191 (sstp + len - 1)->sst_next = NULL;
1193 vim_free(syn_buf->b_sst_array);
1194 syn_buf->b_sst_array = sstp;
1195 syn_buf->b_sst_len = len;
1200 * Check for changes in a buffer to affect stored syntax states. Uses the
1201 * b_mod_* fields.
1202 * Called from update_screen(), before screen is being updated, once for each
1203 * displayed buffer.
1205 void
1206 syn_stack_apply_changes(buf)
1207 buf_T *buf;
1209 synstate_T *p, *prev, *np;
1210 linenr_T n;
1212 if (buf->b_sst_array == NULL) /* nothing to do */
1213 return;
1215 prev = NULL;
1216 for (p = buf->b_sst_first; p != NULL; )
1218 if (p->sst_lnum + buf->b_syn_sync_linebreaks > buf->b_mod_top)
1220 n = p->sst_lnum + buf->b_mod_xlines;
1221 if (n <= buf->b_mod_bot)
1223 /* this state is inside the changed area, remove it */
1224 np = p->sst_next;
1225 if (prev == NULL)
1226 buf->b_sst_first = np;
1227 else
1228 prev->sst_next = np;
1229 syn_stack_free_entry(buf, p);
1230 p = np;
1231 continue;
1233 /* This state is below the changed area. Remember the line
1234 * that needs to be parsed before this entry can be made valid
1235 * again. */
1236 if (p->sst_change_lnum != 0 && p->sst_change_lnum > buf->b_mod_top)
1238 if (p->sst_change_lnum + buf->b_mod_xlines > buf->b_mod_top)
1239 p->sst_change_lnum += buf->b_mod_xlines;
1240 else
1241 p->sst_change_lnum = buf->b_mod_top;
1243 if (p->sst_change_lnum == 0
1244 || p->sst_change_lnum < buf->b_mod_bot)
1245 p->sst_change_lnum = buf->b_mod_bot;
1247 p->sst_lnum = n;
1249 prev = p;
1250 p = p->sst_next;
1255 * Reduce the number of entries in the state stack for syn_buf.
1256 * Returns TRUE if at least one entry was freed.
1258 static int
1259 syn_stack_cleanup()
1261 synstate_T *p, *prev;
1262 disptick_T tick;
1263 int above;
1264 int dist;
1265 int retval = FALSE;
1267 if (syn_buf->b_sst_array == NULL || syn_buf->b_sst_first == NULL)
1268 return retval;
1270 /* Compute normal distance between non-displayed entries. */
1271 if (syn_buf->b_sst_len <= Rows)
1272 dist = 999999;
1273 else
1274 dist = syn_buf->b_ml.ml_line_count / (syn_buf->b_sst_len - Rows) + 1;
1277 * Go through the list to find the "tick" for the oldest entry that can
1278 * be removed. Set "above" when the "tick" for the oldest entry is above
1279 * "b_sst_lasttick" (the display tick wraps around).
1281 tick = syn_buf->b_sst_lasttick;
1282 above = FALSE;
1283 prev = syn_buf->b_sst_first;
1284 for (p = prev->sst_next; p != NULL; prev = p, p = p->sst_next)
1286 if (prev->sst_lnum + dist > p->sst_lnum)
1288 if (p->sst_tick > syn_buf->b_sst_lasttick)
1290 if (!above || p->sst_tick < tick)
1291 tick = p->sst_tick;
1292 above = TRUE;
1294 else if (!above && p->sst_tick < tick)
1295 tick = p->sst_tick;
1300 * Go through the list to make the entries for the oldest tick at an
1301 * interval of several lines.
1303 prev = syn_buf->b_sst_first;
1304 for (p = prev->sst_next; p != NULL; prev = p, p = p->sst_next)
1306 if (p->sst_tick == tick && prev->sst_lnum + dist > p->sst_lnum)
1308 /* Move this entry from used list to free list */
1309 prev->sst_next = p->sst_next;
1310 syn_stack_free_entry(syn_buf, p);
1311 p = prev;
1312 retval = TRUE;
1315 return retval;
1319 * Free the allocated memory for a syn_state item.
1320 * Move the entry into the free list.
1322 static void
1323 syn_stack_free_entry(buf, p)
1324 buf_T *buf;
1325 synstate_T *p;
1327 clear_syn_state(p);
1328 p->sst_next = buf->b_sst_firstfree;
1329 buf->b_sst_firstfree = p;
1330 ++buf->b_sst_freecount;
1334 * Find an entry in the list of state stacks at or before "lnum".
1335 * Returns NULL when there is no entry or the first entry is after "lnum".
1337 static synstate_T *
1338 syn_stack_find_entry(lnum)
1339 linenr_T lnum;
1341 synstate_T *p, *prev;
1343 prev = NULL;
1344 for (p = syn_buf->b_sst_first; p != NULL; prev = p, p = p->sst_next)
1346 if (p->sst_lnum == lnum)
1347 return p;
1348 if (p->sst_lnum > lnum)
1349 break;
1351 return prev;
1355 * Try saving the current state in b_sst_array[].
1356 * The current state must be valid for the start of the current_lnum line!
1358 static synstate_T *
1359 store_current_state()
1361 int i;
1362 synstate_T *p;
1363 bufstate_T *bp;
1364 stateitem_T *cur_si;
1365 synstate_T *sp = syn_stack_find_entry(current_lnum);
1368 * If the current state contains a start or end pattern that continues
1369 * from the previous line, we can't use it. Don't store it then.
1371 for (i = current_state.ga_len - 1; i >= 0; --i)
1373 cur_si = &CUR_STATE(i);
1374 if (cur_si->si_h_startpos.lnum >= current_lnum
1375 || cur_si->si_m_endpos.lnum >= current_lnum
1376 || cur_si->si_h_endpos.lnum >= current_lnum
1377 || (cur_si->si_end_idx
1378 && cur_si->si_eoe_pos.lnum >= current_lnum))
1379 break;
1381 if (i >= 0)
1383 if (sp != NULL)
1385 /* find "sp" in the list and remove it */
1386 if (syn_buf->b_sst_first == sp)
1387 /* it's the first entry */
1388 syn_buf->b_sst_first = sp->sst_next;
1389 else
1391 /* find the entry just before this one to adjust sst_next */
1392 for (p = syn_buf->b_sst_first; p != NULL; p = p->sst_next)
1393 if (p->sst_next == sp)
1394 break;
1395 if (p != NULL) /* just in case */
1396 p->sst_next = sp->sst_next;
1398 syn_stack_free_entry(syn_buf, sp);
1399 sp = NULL;
1402 else if (sp == NULL || sp->sst_lnum != current_lnum)
1405 * Add a new entry
1407 /* If no free items, cleanup the array first. */
1408 if (syn_buf->b_sst_freecount == 0)
1410 (void)syn_stack_cleanup();
1411 /* "sp" may have been moved to the freelist now */
1412 sp = syn_stack_find_entry(current_lnum);
1414 /* Still no free items? Must be a strange problem... */
1415 if (syn_buf->b_sst_freecount == 0)
1416 sp = NULL;
1417 else
1419 /* Take the first item from the free list and put it in the used
1420 * list, after *sp */
1421 p = syn_buf->b_sst_firstfree;
1422 syn_buf->b_sst_firstfree = p->sst_next;
1423 --syn_buf->b_sst_freecount;
1424 if (sp == NULL)
1426 /* Insert in front of the list */
1427 p->sst_next = syn_buf->b_sst_first;
1428 syn_buf->b_sst_first = p;
1430 else
1432 /* insert in list after *sp */
1433 p->sst_next = sp->sst_next;
1434 sp->sst_next = p;
1436 sp = p;
1437 sp->sst_stacksize = 0;
1438 sp->sst_lnum = current_lnum;
1441 if (sp != NULL)
1443 /* When overwriting an existing state stack, clear it first */
1444 clear_syn_state(sp);
1445 sp->sst_stacksize = current_state.ga_len;
1446 if (current_state.ga_len > SST_FIX_STATES)
1448 /* Need to clear it, might be something remaining from when the
1449 * length was less than SST_FIX_STATES. */
1450 ga_init2(&sp->sst_union.sst_ga, (int)sizeof(bufstate_T), 1);
1451 if (ga_grow(&sp->sst_union.sst_ga, current_state.ga_len) == FAIL)
1452 sp->sst_stacksize = 0;
1453 else
1454 sp->sst_union.sst_ga.ga_len = current_state.ga_len;
1455 bp = SYN_STATE_P(&(sp->sst_union.sst_ga));
1457 else
1458 bp = sp->sst_union.sst_stack;
1459 for (i = 0; i < sp->sst_stacksize; ++i)
1461 bp[i].bs_idx = CUR_STATE(i).si_idx;
1462 bp[i].bs_flags = CUR_STATE(i).si_flags;
1463 bp[i].bs_extmatch = ref_extmatch(CUR_STATE(i).si_extmatch);
1465 sp->sst_next_flags = current_next_flags;
1466 sp->sst_next_list = current_next_list;
1467 sp->sst_tick = display_tick;
1468 sp->sst_change_lnum = 0;
1470 current_state_stored = TRUE;
1471 return sp;
1475 * Copy a state stack from "from" in b_sst_array[] to current_state;
1477 static void
1478 load_current_state(from)
1479 synstate_T *from;
1481 int i;
1482 bufstate_T *bp;
1484 clear_current_state();
1485 validate_current_state();
1486 keepend_level = -1;
1487 if (from->sst_stacksize
1488 && ga_grow(&current_state, from->sst_stacksize) != FAIL)
1490 if (from->sst_stacksize > SST_FIX_STATES)
1491 bp = SYN_STATE_P(&(from->sst_union.sst_ga));
1492 else
1493 bp = from->sst_union.sst_stack;
1494 for (i = 0; i < from->sst_stacksize; ++i)
1496 CUR_STATE(i).si_idx = bp[i].bs_idx;
1497 CUR_STATE(i).si_flags = bp[i].bs_flags;
1498 CUR_STATE(i).si_extmatch = ref_extmatch(bp[i].bs_extmatch);
1499 if (keepend_level < 0 && (CUR_STATE(i).si_flags & HL_KEEPEND))
1500 keepend_level = i;
1501 CUR_STATE(i).si_ends = FALSE;
1502 CUR_STATE(i).si_m_lnum = 0;
1503 if (CUR_STATE(i).si_idx >= 0)
1504 CUR_STATE(i).si_next_list =
1505 (SYN_ITEMS(syn_buf)[CUR_STATE(i).si_idx]).sp_next_list;
1506 else
1507 CUR_STATE(i).si_next_list = NULL;
1508 update_si_attr(i);
1510 current_state.ga_len = from->sst_stacksize;
1512 current_next_list = from->sst_next_list;
1513 current_next_flags = from->sst_next_flags;
1514 current_lnum = from->sst_lnum;
1518 * Compare saved state stack "*sp" with the current state.
1519 * Return TRUE when they are equal.
1521 static int
1522 syn_stack_equal(sp)
1523 synstate_T *sp;
1525 int i, j;
1526 bufstate_T *bp;
1527 reg_extmatch_T *six, *bsx;
1529 /* First a quick check if the stacks have the same size end nextlist. */
1530 if (sp->sst_stacksize == current_state.ga_len
1531 && sp->sst_next_list == current_next_list)
1533 /* Need to compare all states on both stacks. */
1534 if (sp->sst_stacksize > SST_FIX_STATES)
1535 bp = SYN_STATE_P(&(sp->sst_union.sst_ga));
1536 else
1537 bp = sp->sst_union.sst_stack;
1539 for (i = current_state.ga_len; --i >= 0; )
1541 /* If the item has another index the state is different. */
1542 if (bp[i].bs_idx != CUR_STATE(i).si_idx)
1543 break;
1544 if (bp[i].bs_extmatch != CUR_STATE(i).si_extmatch)
1546 /* When the extmatch pointers are different, the strings in
1547 * them can still be the same. Check if the extmatch
1548 * references are equal. */
1549 bsx = bp[i].bs_extmatch;
1550 six = CUR_STATE(i).si_extmatch;
1551 /* If one of the extmatch pointers is NULL the states are
1552 * different. */
1553 if (bsx == NULL || six == NULL)
1554 break;
1555 for (j = 0; j < NSUBEXP; ++j)
1557 /* Check each referenced match string. They must all be
1558 * equal. */
1559 if (bsx->matches[j] != six->matches[j])
1561 /* If the pointer is different it can still be the
1562 * same text. Compare the strings, ignore case when
1563 * the start item has the sp_ic flag set. */
1564 if (bsx->matches[j] == NULL
1565 || six->matches[j] == NULL)
1566 break;
1567 if ((SYN_ITEMS(syn_buf)[CUR_STATE(i).si_idx]).sp_ic
1568 ? MB_STRICMP(bsx->matches[j],
1569 six->matches[j]) != 0
1570 : STRCMP(bsx->matches[j], six->matches[j]) != 0)
1571 break;
1574 if (j != NSUBEXP)
1575 break;
1578 if (i < 0)
1579 return TRUE;
1581 return FALSE;
1585 * We stop parsing syntax above line "lnum". If the stored state at or below
1586 * this line depended on a change before it, it now depends on the line below
1587 * the last parsed line.
1588 * The window looks like this:
1589 * line which changed
1590 * displayed line
1591 * displayed line
1592 * lnum -> line below window
1594 void
1595 syntax_end_parsing(lnum)
1596 linenr_T lnum;
1598 synstate_T *sp;
1600 sp = syn_stack_find_entry(lnum);
1601 if (sp != NULL && sp->sst_lnum < lnum)
1602 sp = sp->sst_next;
1604 if (sp != NULL && sp->sst_change_lnum != 0)
1605 sp->sst_change_lnum = lnum;
1609 * End of handling of the state stack.
1610 ****************************************/
1612 static void
1613 invalidate_current_state()
1615 clear_current_state();
1616 current_state.ga_itemsize = 0; /* mark current_state invalid */
1617 current_next_list = NULL;
1618 keepend_level = -1;
1621 static void
1622 validate_current_state()
1624 current_state.ga_itemsize = sizeof(stateitem_T);
1625 current_state.ga_growsize = 3;
1629 * Return TRUE if the syntax at start of lnum changed since last time.
1630 * This will only be called just after get_syntax_attr() for the previous
1631 * line, to check if the next line needs to be redrawn too.
1634 syntax_check_changed(lnum)
1635 linenr_T lnum;
1637 int retval = TRUE;
1638 synstate_T *sp;
1641 * Check the state stack when:
1642 * - lnum is just below the previously syntaxed line.
1643 * - lnum is not before the lines with saved states.
1644 * - lnum is not past the lines with saved states.
1645 * - lnum is at or before the last changed line.
1647 if (VALID_STATE(&current_state) && lnum == current_lnum + 1)
1649 sp = syn_stack_find_entry(lnum);
1650 if (sp != NULL && sp->sst_lnum == lnum)
1653 * finish the previous line (needed when not all of the line was
1654 * drawn)
1656 (void)syn_finish_line(FALSE);
1659 * Compare the current state with the previously saved state of
1660 * the line.
1662 if (syn_stack_equal(sp))
1663 retval = FALSE;
1666 * Store the current state in b_sst_array[] for later use.
1668 ++current_lnum;
1669 (void)store_current_state();
1673 return retval;
1677 * Finish the current line.
1678 * This doesn't return any attributes, it only gets the state at the end of
1679 * the line. It can start anywhere in the line, as long as the current state
1680 * is valid.
1682 static int
1683 syn_finish_line(syncing)
1684 int syncing; /* called for syncing */
1686 stateitem_T *cur_si;
1687 colnr_T prev_current_col;
1689 if (!current_finished)
1691 while (!current_finished)
1693 (void)syn_current_attr(syncing, FALSE, NULL, FALSE);
1695 * When syncing, and found some item, need to check the item.
1697 if (syncing && current_state.ga_len)
1700 * Check for match with sync item.
1702 cur_si = &CUR_STATE(current_state.ga_len - 1);
1703 if (cur_si->si_idx >= 0
1704 && (SYN_ITEMS(syn_buf)[cur_si->si_idx].sp_flags
1705 & (HL_SYNC_HERE|HL_SYNC_THERE)))
1706 return TRUE;
1708 /* syn_current_attr() will have skipped the check for an item
1709 * that ends here, need to do that now. Be careful not to go
1710 * past the NUL. */
1711 prev_current_col = current_col;
1712 if (syn_getcurline()[current_col] != NUL)
1713 ++current_col;
1714 check_state_ends();
1715 current_col = prev_current_col;
1717 ++current_col;
1720 return FALSE;
1724 * Return highlight attributes for next character.
1725 * Must first call syntax_start() once for the line.
1726 * "col" is normally 0 for the first use in a line, and increments by one each
1727 * time. It's allowed to skip characters and to stop before the end of the
1728 * line. But only a "col" after a previously used column is allowed.
1729 * When "can_spell" is not NULL set it to TRUE when spell-checking should be
1730 * done.
1733 get_syntax_attr(col, can_spell, keep_state)
1734 colnr_T col;
1735 int *can_spell;
1736 int keep_state; /* keep state of char at "col" */
1738 int attr = 0;
1740 if (can_spell != NULL)
1741 /* Default: Only do spelling when there is no @Spell cluster or when
1742 * ":syn spell toplevel" was used. */
1743 *can_spell = syn_buf->b_syn_spell == SYNSPL_DEFAULT
1744 ? (syn_buf->b_spell_cluster_id == 0)
1745 : (syn_buf->b_syn_spell == SYNSPL_TOP);
1747 /* check for out of memory situation */
1748 if (syn_buf->b_sst_array == NULL)
1749 return 0;
1751 /* After 'synmaxcol' the attribute is always zero. */
1752 if (syn_buf->b_p_smc > 0 && col >= (colnr_T)syn_buf->b_p_smc)
1754 clear_current_state();
1755 #ifdef FEAT_EVAL
1756 current_id = 0;
1757 current_trans_id = 0;
1758 #endif
1759 return 0;
1762 /* Make sure current_state is valid */
1763 if (INVALID_STATE(&current_state))
1764 validate_current_state();
1767 * Skip from the current column to "col", get the attributes for "col".
1769 while (current_col <= col)
1771 attr = syn_current_attr(FALSE, TRUE, can_spell,
1772 current_col == col ? keep_state : FALSE);
1773 ++current_col;
1776 return attr;
1780 * Get syntax attributes for current_lnum, current_col.
1782 static int
1783 syn_current_attr(syncing, displaying, can_spell, keep_state)
1784 int syncing; /* When 1: called for syncing */
1785 int displaying; /* result will be displayed */
1786 int *can_spell; /* return: do spell checking */
1787 int keep_state; /* keep syntax stack afterwards */
1789 int syn_id;
1790 lpos_T endpos; /* was: char_u *endp; */
1791 lpos_T hl_startpos; /* was: int hl_startcol; */
1792 lpos_T hl_endpos;
1793 lpos_T eos_pos; /* end-of-start match (start region) */
1794 lpos_T eoe_pos; /* end-of-end pattern */
1795 int end_idx; /* group ID for end pattern */
1796 int idx;
1797 synpat_T *spp;
1798 stateitem_T *cur_si, *sip = NULL;
1799 int startcol;
1800 int endcol;
1801 long flags;
1802 short *next_list;
1803 int found_match; /* found usable match */
1804 static int try_next_column = FALSE; /* must try in next col */
1805 int do_keywords;
1806 regmmatch_T regmatch;
1807 lpos_T pos;
1808 int lc_col;
1809 reg_extmatch_T *cur_extmatch = NULL;
1810 char_u *line; /* current line. NOTE: becomes invalid after
1811 looking for a pattern match! */
1813 /* variables for zero-width matches that have a "nextgroup" argument */
1814 int keep_next_list;
1815 int zero_width_next_list = FALSE;
1816 garray_T zero_width_next_ga;
1819 * No character, no attributes! Past end of line?
1820 * Do try matching with an empty line (could be the start of a region).
1822 line = syn_getcurline();
1823 if (line[current_col] == NUL && current_col != 0)
1826 * If we found a match after the last column, use it.
1828 if (next_match_idx >= 0 && next_match_col >= (int)current_col
1829 && next_match_col != MAXCOL)
1830 (void)push_next_match(NULL);
1832 current_finished = TRUE;
1833 current_state_stored = FALSE;
1834 return 0;
1837 /* if the current or next character is NUL, we will finish the line now */
1838 if (line[current_col] == NUL || line[current_col + 1] == NUL)
1840 current_finished = TRUE;
1841 current_state_stored = FALSE;
1845 * When in the previous column there was a match but it could not be used
1846 * (empty match or already matched in this column) need to try again in
1847 * the next column.
1849 if (try_next_column)
1851 next_match_idx = -1;
1852 try_next_column = FALSE;
1855 /* Only check for keywords when not syncing and there are some. */
1856 do_keywords = !syncing
1857 && (syn_buf->b_keywtab.ht_used > 0
1858 || syn_buf->b_keywtab_ic.ht_used > 0);
1860 /* Init the list of zero-width matches with a nextlist. This is used to
1861 * avoid matching the same item in the same position twice. */
1862 ga_init2(&zero_width_next_ga, (int)sizeof(int), 10);
1865 * Repeat matching keywords and patterns, to find contained items at the
1866 * same column. This stops when there are no extra matches at the current
1867 * column.
1871 found_match = FALSE;
1872 keep_next_list = FALSE;
1873 syn_id = 0;
1876 * 1. Check for a current state.
1877 * Only when there is no current state, or if the current state may
1878 * contain other things, we need to check for keywords and patterns.
1879 * Always need to check for contained items if some item has the
1880 * "containedin" argument (takes extra time!).
1882 if (current_state.ga_len)
1883 cur_si = &CUR_STATE(current_state.ga_len - 1);
1884 else
1885 cur_si = NULL;
1887 if (syn_buf->b_syn_containedin || cur_si == NULL
1888 || cur_si->si_cont_list != NULL)
1891 * 2. Check for keywords, if on a keyword char after a non-keyword
1892 * char. Don't do this when syncing.
1894 if (do_keywords)
1896 line = syn_getcurline();
1897 if (vim_iswordc_buf(line + current_col, syn_buf)
1898 && (current_col == 0
1899 || !vim_iswordc_buf(line + current_col - 1
1900 #ifdef FEAT_MBYTE
1901 - (has_mbyte
1902 ? (*mb_head_off)(line, line + current_col - 1)
1903 : 0)
1904 #endif
1905 , syn_buf)))
1907 syn_id = check_keyword_id(line, (int)current_col,
1908 &endcol, &flags, &next_list, cur_si);
1909 if (syn_id != 0)
1911 if (push_current_state(KEYWORD_IDX) == OK)
1913 cur_si = &CUR_STATE(current_state.ga_len - 1);
1914 cur_si->si_m_startcol = current_col;
1915 cur_si->si_h_startpos.lnum = current_lnum;
1916 cur_si->si_h_startpos.col = 0; /* starts right away */
1917 cur_si->si_m_endpos.lnum = current_lnum;
1918 cur_si->si_m_endpos.col = endcol;
1919 cur_si->si_h_endpos.lnum = current_lnum;
1920 cur_si->si_h_endpos.col = endcol;
1921 cur_si->si_ends = TRUE;
1922 cur_si->si_end_idx = 0;
1923 cur_si->si_flags = flags;
1924 cur_si->si_id = syn_id;
1925 cur_si->si_trans_id = syn_id;
1926 if (flags & HL_TRANSP)
1928 if (current_state.ga_len < 2)
1930 cur_si->si_attr = 0;
1931 cur_si->si_trans_id = 0;
1933 else
1935 cur_si->si_attr = CUR_STATE(
1936 current_state.ga_len - 2).si_attr;
1937 cur_si->si_trans_id = CUR_STATE(
1938 current_state.ga_len - 2).si_trans_id;
1941 else
1942 cur_si->si_attr = syn_id2attr(syn_id);
1943 cur_si->si_cont_list = NULL;
1944 cur_si->si_next_list = next_list;
1945 check_keepend();
1947 else
1948 vim_free(next_list);
1954 * 3. Check for patterns (only if no keyword found).
1956 if (syn_id == 0 && syn_buf->b_syn_patterns.ga_len)
1959 * If we didn't check for a match yet, or we are past it, check
1960 * for any match with a pattern.
1962 if (next_match_idx < 0 || next_match_col < (int)current_col)
1965 * Check all relevant patterns for a match at this
1966 * position. This is complicated, because matching with a
1967 * pattern takes quite a bit of time, thus we want to
1968 * avoid doing it when it's not needed.
1970 next_match_idx = 0; /* no match in this line yet */
1971 next_match_col = MAXCOL;
1972 for (idx = syn_buf->b_syn_patterns.ga_len; --idx >= 0; )
1974 spp = &(SYN_ITEMS(syn_buf)[idx]);
1975 if ( spp->sp_syncing == syncing
1976 && (displaying || !(spp->sp_flags & HL_DISPLAY))
1977 && (spp->sp_type == SPTYPE_MATCH
1978 || spp->sp_type == SPTYPE_START)
1979 && (current_next_list != NULL
1980 ? in_id_list(NULL, current_next_list,
1981 &spp->sp_syn, 0)
1982 : (cur_si == NULL
1983 ? !(spp->sp_flags & HL_CONTAINED)
1984 : in_id_list(cur_si,
1985 cur_si->si_cont_list, &spp->sp_syn,
1986 spp->sp_flags & HL_CONTAINED))))
1988 /* If we already tried matching in this line, and
1989 * there isn't a match before next_match_col, skip
1990 * this item. */
1991 if (spp->sp_line_id == current_line_id
1992 && spp->sp_startcol >= next_match_col)
1993 continue;
1994 spp->sp_line_id = current_line_id;
1996 lc_col = current_col - spp->sp_offsets[SPO_LC_OFF];
1997 if (lc_col < 0)
1998 lc_col = 0;
2000 regmatch.rmm_ic = spp->sp_ic;
2001 regmatch.regprog = spp->sp_prog;
2002 if (!syn_regexec(&regmatch, current_lnum,
2003 (colnr_T)lc_col))
2005 /* no match in this line, try another one */
2006 spp->sp_startcol = MAXCOL;
2007 continue;
2011 * Compute the first column of the match.
2013 syn_add_start_off(&pos, &regmatch,
2014 spp, SPO_MS_OFF, -1);
2015 if (pos.lnum > current_lnum)
2017 /* must have used end of match in a next line,
2018 * we can't handle that */
2019 spp->sp_startcol = MAXCOL;
2020 continue;
2022 startcol = pos.col;
2024 /* remember the next column where this pattern
2025 * matches in the current line */
2026 spp->sp_startcol = startcol;
2029 * If a previously found match starts at a lower
2030 * column number, don't use this one.
2032 if (startcol >= next_match_col)
2033 continue;
2036 * If we matched this pattern at this position
2037 * before, skip it. Must retry in the next
2038 * column, because it may match from there.
2040 if (did_match_already(idx, &zero_width_next_ga))
2042 try_next_column = TRUE;
2043 continue;
2046 endpos.lnum = regmatch.endpos[0].lnum;
2047 endpos.col = regmatch.endpos[0].col;
2049 /* Compute the highlight start. */
2050 syn_add_start_off(&hl_startpos, &regmatch,
2051 spp, SPO_HS_OFF, -1);
2053 /* Compute the region start. */
2054 /* Default is to use the end of the match. */
2055 syn_add_end_off(&eos_pos, &regmatch,
2056 spp, SPO_RS_OFF, 0);
2059 * Grab the external submatches before they get
2060 * overwritten. Reference count doesn't change.
2062 unref_extmatch(cur_extmatch);
2063 cur_extmatch = re_extmatch_out;
2064 re_extmatch_out = NULL;
2066 flags = 0;
2067 eoe_pos.lnum = 0; /* avoid warning */
2068 eoe_pos.col = 0;
2069 end_idx = 0;
2070 hl_endpos.lnum = 0;
2073 * For a "oneline" the end must be found in the
2074 * same line too. Search for it after the end of
2075 * the match with the start pattern. Set the
2076 * resulting end positions at the same time.
2078 if (spp->sp_type == SPTYPE_START
2079 && (spp->sp_flags & HL_ONELINE))
2081 lpos_T startpos;
2083 startpos = endpos;
2084 find_endpos(idx, &startpos, &endpos, &hl_endpos,
2085 &flags, &eoe_pos, &end_idx, cur_extmatch);
2086 if (endpos.lnum == 0)
2087 continue; /* not found */
2091 * For a "match" the size must be > 0 after the
2092 * end offset needs has been added. Except when
2093 * syncing.
2095 else if (spp->sp_type == SPTYPE_MATCH)
2097 syn_add_end_off(&hl_endpos, &regmatch, spp,
2098 SPO_HE_OFF, 0);
2099 syn_add_end_off(&endpos, &regmatch, spp,
2100 SPO_ME_OFF, 0);
2101 if (endpos.lnum == current_lnum
2102 && (int)endpos.col + syncing < startcol)
2105 * If an empty string is matched, may need
2106 * to try matching again at next column.
2108 if (regmatch.startpos[0].col
2109 == regmatch.endpos[0].col)
2110 try_next_column = TRUE;
2111 continue;
2116 * keep the best match so far in next_match_*
2118 /* Highlighting must start after startpos and end
2119 * before endpos. */
2120 if (hl_startpos.lnum == current_lnum
2121 && (int)hl_startpos.col < startcol)
2122 hl_startpos.col = startcol;
2123 limit_pos_zero(&hl_endpos, &endpos);
2125 next_match_idx = idx;
2126 next_match_col = startcol;
2127 next_match_m_endpos = endpos;
2128 next_match_h_endpos = hl_endpos;
2129 next_match_h_startpos = hl_startpos;
2130 next_match_flags = flags;
2131 next_match_eos_pos = eos_pos;
2132 next_match_eoe_pos = eoe_pos;
2133 next_match_end_idx = end_idx;
2134 unref_extmatch(next_match_extmatch);
2135 next_match_extmatch = cur_extmatch;
2136 cur_extmatch = NULL;
2142 * If we found a match at the current column, use it.
2144 if (next_match_idx >= 0 && next_match_col == (int)current_col)
2146 synpat_T *lspp;
2148 /* When a zero-width item matched which has a nextgroup,
2149 * don't push the item but set nextgroup. */
2150 lspp = &(SYN_ITEMS(syn_buf)[next_match_idx]);
2151 if (next_match_m_endpos.lnum == current_lnum
2152 && next_match_m_endpos.col == current_col
2153 && lspp->sp_next_list != NULL)
2155 current_next_list = lspp->sp_next_list;
2156 current_next_flags = lspp->sp_flags;
2157 keep_next_list = TRUE;
2158 zero_width_next_list = TRUE;
2160 /* Add the index to a list, so that we can check
2161 * later that we don't match it again (and cause an
2162 * endless loop). */
2163 if (ga_grow(&zero_width_next_ga, 1) == OK)
2165 ((int *)(zero_width_next_ga.ga_data))
2166 [zero_width_next_ga.ga_len++] = next_match_idx;
2168 next_match_idx = -1;
2170 else
2171 cur_si = push_next_match(cur_si);
2172 found_match = TRUE;
2178 * Handle searching for nextgroup match.
2180 if (current_next_list != NULL && !keep_next_list)
2183 * If a nextgroup was not found, continue looking for one if:
2184 * - this is an empty line and the "skipempty" option was given
2185 * - we are on white space and the "skipwhite" option was given
2187 if (!found_match)
2189 line = syn_getcurline();
2190 if (((current_next_flags & HL_SKIPWHITE)
2191 && vim_iswhite(line[current_col]))
2192 || ((current_next_flags & HL_SKIPEMPTY)
2193 && *line == NUL))
2194 break;
2198 * If a nextgroup was found: Use it, and continue looking for
2199 * contained matches.
2200 * If a nextgroup was not found: Continue looking for a normal
2201 * match.
2202 * When did set current_next_list for a zero-width item and no
2203 * match was found don't loop (would get stuck).
2205 current_next_list = NULL;
2206 next_match_idx = -1;
2207 if (!zero_width_next_list)
2208 found_match = TRUE;
2211 } while (found_match);
2214 * Use attributes from the current state, if within its highlighting.
2215 * If not, use attributes from the current-but-one state, etc.
2217 current_attr = 0;
2218 #ifdef FEAT_EVAL
2219 current_id = 0;
2220 current_trans_id = 0;
2221 #endif
2222 if (cur_si != NULL)
2224 #ifndef FEAT_EVAL
2225 int current_trans_id = 0;
2226 #endif
2227 for (idx = current_state.ga_len - 1; idx >= 0; --idx)
2229 sip = &CUR_STATE(idx);
2230 if ((current_lnum > sip->si_h_startpos.lnum
2231 || (current_lnum == sip->si_h_startpos.lnum
2232 && current_col >= sip->si_h_startpos.col))
2233 && (sip->si_h_endpos.lnum == 0
2234 || current_lnum < sip->si_h_endpos.lnum
2235 || (current_lnum == sip->si_h_endpos.lnum
2236 && current_col < sip->si_h_endpos.col)))
2238 current_attr = sip->si_attr;
2239 #ifdef FEAT_EVAL
2240 current_id = sip->si_id;
2241 #endif
2242 current_trans_id = sip->si_trans_id;
2243 break;
2247 if (can_spell != NULL)
2249 struct sp_syn sps;
2252 * set "can_spell" to TRUE if spell checking is supposed to be
2253 * done in the current item.
2255 if (syn_buf->b_spell_cluster_id == 0)
2257 /* There is no @Spell cluster: Do spelling for items without
2258 * @NoSpell cluster. */
2259 if (syn_buf->b_nospell_cluster_id == 0 || current_trans_id == 0)
2260 *can_spell = (syn_buf->b_syn_spell != SYNSPL_NOTOP);
2261 else
2263 sps.inc_tag = 0;
2264 sps.id = syn_buf->b_nospell_cluster_id;
2265 sps.cont_in_list = NULL;
2266 *can_spell = !in_id_list(sip, sip->si_cont_list, &sps, 0);
2269 else
2271 /* The @Spell cluster is defined: Do spelling in items with
2272 * the @Spell cluster. But not when @NoSpell is also there.
2273 * At the toplevel only spell check when ":syn spell toplevel"
2274 * was used. */
2275 if (current_trans_id == 0)
2276 *can_spell = (syn_buf->b_syn_spell == SYNSPL_TOP);
2277 else
2279 sps.inc_tag = 0;
2280 sps.id = syn_buf->b_spell_cluster_id;
2281 sps.cont_in_list = NULL;
2282 *can_spell = in_id_list(sip, sip->si_cont_list, &sps, 0);
2284 if (syn_buf->b_nospell_cluster_id != 0)
2286 sps.id = syn_buf->b_nospell_cluster_id;
2287 if (in_id_list(sip, sip->si_cont_list, &sps, 0))
2288 *can_spell = FALSE;
2296 * Check for end of current state (and the states before it) at the
2297 * next column. Don't do this for syncing, because we would miss a
2298 * single character match.
2299 * First check if the current state ends at the current column. It
2300 * may be for an empty match and a containing item might end in the
2301 * current column.
2303 if (!syncing && !keep_state)
2305 check_state_ends();
2306 if (current_state.ga_len > 0
2307 && syn_getcurline()[current_col] != NUL)
2309 ++current_col;
2310 check_state_ends();
2311 --current_col;
2315 else if (can_spell != NULL)
2316 /* Default: Only do spelling when there is no @Spell cluster or when
2317 * ":syn spell toplevel" was used. */
2318 *can_spell = syn_buf->b_syn_spell == SYNSPL_DEFAULT
2319 ? (syn_buf->b_spell_cluster_id == 0)
2320 : (syn_buf->b_syn_spell == SYNSPL_TOP);
2322 /* nextgroup ends at end of line, unless "skipnl" or "skipempty" present */
2323 if (current_next_list != NULL
2324 && syn_getcurline()[current_col + 1] == NUL
2325 && !(current_next_flags & (HL_SKIPNL | HL_SKIPEMPTY)))
2326 current_next_list = NULL;
2328 if (zero_width_next_ga.ga_len > 0)
2329 ga_clear(&zero_width_next_ga);
2331 /* No longer need external matches. But keep next_match_extmatch. */
2332 unref_extmatch(re_extmatch_out);
2333 re_extmatch_out = NULL;
2334 unref_extmatch(cur_extmatch);
2336 return current_attr;
2341 * Check if we already matched pattern "idx" at the current column.
2343 static int
2344 did_match_already(idx, gap)
2345 int idx;
2346 garray_T *gap;
2348 int i;
2350 for (i = current_state.ga_len; --i >= 0; )
2351 if (CUR_STATE(i).si_m_startcol == (int)current_col
2352 && CUR_STATE(i).si_m_lnum == (int)current_lnum
2353 && CUR_STATE(i).si_idx == idx)
2354 return TRUE;
2356 /* Zero-width matches with a nextgroup argument are not put on the syntax
2357 * stack, and can only be matched once anyway. */
2358 for (i = gap->ga_len; --i >= 0; )
2359 if (((int *)(gap->ga_data))[i] == idx)
2360 return TRUE;
2362 return FALSE;
2366 * Push the next match onto the stack.
2368 static stateitem_T *
2369 push_next_match(cur_si)
2370 stateitem_T *cur_si;
2372 synpat_T *spp;
2374 spp = &(SYN_ITEMS(syn_buf)[next_match_idx]);
2377 * Push the item in current_state stack;
2379 if (push_current_state(next_match_idx) == OK)
2382 * If it's a start-skip-end type that crosses lines, figure out how
2383 * much it continues in this line. Otherwise just fill in the length.
2385 cur_si = &CUR_STATE(current_state.ga_len - 1);
2386 cur_si->si_h_startpos = next_match_h_startpos;
2387 cur_si->si_m_startcol = current_col;
2388 cur_si->si_m_lnum = current_lnum;
2389 cur_si->si_flags = spp->sp_flags;
2390 cur_si->si_next_list = spp->sp_next_list;
2391 cur_si->si_extmatch = ref_extmatch(next_match_extmatch);
2392 if (spp->sp_type == SPTYPE_START && !(spp->sp_flags & HL_ONELINE))
2394 /* Try to find the end pattern in the current line */
2395 update_si_end(cur_si, (int)(next_match_m_endpos.col), TRUE);
2396 check_keepend();
2398 else
2400 cur_si->si_m_endpos = next_match_m_endpos;
2401 cur_si->si_h_endpos = next_match_h_endpos;
2402 cur_si->si_ends = TRUE;
2403 cur_si->si_flags |= next_match_flags;
2404 cur_si->si_eoe_pos = next_match_eoe_pos;
2405 cur_si->si_end_idx = next_match_end_idx;
2407 if (keepend_level < 0 && (cur_si->si_flags & HL_KEEPEND))
2408 keepend_level = current_state.ga_len - 1;
2409 check_keepend();
2410 update_si_attr(current_state.ga_len - 1);
2413 * If the start pattern has another highlight group, push another item
2414 * on the stack for the start pattern.
2416 if ( spp->sp_type == SPTYPE_START
2417 && spp->sp_syn_match_id != 0
2418 && push_current_state(next_match_idx) == OK)
2420 cur_si = &CUR_STATE(current_state.ga_len - 1);
2421 cur_si->si_h_startpos = next_match_h_startpos;
2422 cur_si->si_m_startcol = current_col;
2423 cur_si->si_m_lnum = current_lnum;
2424 cur_si->si_m_endpos = next_match_eos_pos;
2425 cur_si->si_h_endpos = next_match_eos_pos;
2426 cur_si->si_ends = TRUE;
2427 cur_si->si_end_idx = 0;
2428 cur_si->si_flags = HL_MATCH;
2429 cur_si->si_next_list = NULL;
2430 check_keepend();
2431 update_si_attr(current_state.ga_len - 1);
2435 next_match_idx = -1; /* try other match next time */
2437 return cur_si;
2441 * Check for end of current state (and the states before it).
2443 static void
2444 check_state_ends()
2446 stateitem_T *cur_si;
2447 int had_extend = FALSE;
2449 cur_si = &CUR_STATE(current_state.ga_len - 1);
2450 for (;;)
2452 if (cur_si->si_ends
2453 && (cur_si->si_m_endpos.lnum < current_lnum
2454 || (cur_si->si_m_endpos.lnum == current_lnum
2455 && cur_si->si_m_endpos.col <= current_col)))
2458 * If there is an end pattern group ID, highlight the end pattern
2459 * now. No need to pop the current item from the stack.
2460 * Only do this if the end pattern continues beyond the current
2461 * position.
2463 if (cur_si->si_end_idx
2464 && (cur_si->si_eoe_pos.lnum > current_lnum
2465 || (cur_si->si_eoe_pos.lnum == current_lnum
2466 && cur_si->si_eoe_pos.col > current_col)))
2468 cur_si->si_idx = cur_si->si_end_idx;
2469 cur_si->si_end_idx = 0;
2470 cur_si->si_m_endpos = cur_si->si_eoe_pos;
2471 cur_si->si_h_endpos = cur_si->si_eoe_pos;
2472 cur_si->si_flags |= HL_MATCH;
2473 update_si_attr(current_state.ga_len - 1);
2475 /* what matches next may be different now, clear it */
2476 next_match_idx = 0;
2477 next_match_col = MAXCOL;
2478 break;
2480 else
2482 /* handle next_list, unless at end of line and no "skipnl" or
2483 * "skipempty" */
2484 current_next_list = cur_si->si_next_list;
2485 current_next_flags = cur_si->si_flags;
2486 if (!(current_next_flags & (HL_SKIPNL | HL_SKIPEMPTY))
2487 && syn_getcurline()[current_col] == NUL)
2488 current_next_list = NULL;
2490 /* When the ended item has "extend", another item with
2491 * "keepend" now needs to check for its end. */
2492 if (cur_si->si_flags & HL_EXTEND)
2493 had_extend = TRUE;
2495 pop_current_state();
2497 if (current_state.ga_len == 0)
2498 break;
2500 if (had_extend && keepend_level >= 0)
2502 syn_update_ends(FALSE);
2503 if (current_state.ga_len == 0)
2504 break;
2507 cur_si = &CUR_STATE(current_state.ga_len - 1);
2510 * Only for a region the search for the end continues after
2511 * the end of the contained item. If the contained match
2512 * included the end-of-line, break here, the region continues.
2513 * Don't do this when:
2514 * - "keepend" is used for the contained item
2515 * - not at the end of the line (could be end="x$"me=e-1).
2516 * - "excludenl" is used (HL_HAS_EOL won't be set)
2518 if (cur_si->si_idx >= 0
2519 && SYN_ITEMS(syn_buf)[cur_si->si_idx].sp_type
2520 == SPTYPE_START
2521 && !(cur_si->si_flags & (HL_MATCH | HL_KEEPEND)))
2523 update_si_end(cur_si, (int)current_col, TRUE);
2524 check_keepend();
2525 if ((current_next_flags & HL_HAS_EOL)
2526 && keepend_level < 0
2527 && syn_getcurline()[current_col] == NUL)
2528 break;
2532 else
2533 break;
2538 * Update an entry in the current_state stack for a match or region. This
2539 * fills in si_attr, si_next_list and si_cont_list.
2541 static void
2542 update_si_attr(idx)
2543 int idx;
2545 stateitem_T *sip = &CUR_STATE(idx);
2546 synpat_T *spp;
2548 /* This should not happen... */
2549 if (sip->si_idx < 0)
2550 return;
2552 spp = &(SYN_ITEMS(syn_buf)[sip->si_idx]);
2553 if (sip->si_flags & HL_MATCH)
2554 sip->si_id = spp->sp_syn_match_id;
2555 else
2556 sip->si_id = spp->sp_syn.id;
2557 sip->si_attr = syn_id2attr(sip->si_id);
2558 sip->si_trans_id = sip->si_id;
2559 if (sip->si_flags & HL_MATCH)
2560 sip->si_cont_list = NULL;
2561 else
2562 sip->si_cont_list = spp->sp_cont_list;
2565 * For transparent items, take attr from outer item.
2566 * Also take cont_list, if there is none.
2567 * Don't do this for the matchgroup of a start or end pattern.
2569 if ((spp->sp_flags & HL_TRANSP) && !(sip->si_flags & HL_MATCH))
2571 if (idx == 0)
2573 sip->si_attr = 0;
2574 sip->si_trans_id = 0;
2575 if (sip->si_cont_list == NULL)
2576 sip->si_cont_list = ID_LIST_ALL;
2578 else
2580 sip->si_attr = CUR_STATE(idx - 1).si_attr;
2581 sip->si_trans_id = CUR_STATE(idx - 1).si_trans_id;
2582 sip->si_h_startpos = CUR_STATE(idx - 1).si_h_startpos;
2583 sip->si_h_endpos = CUR_STATE(idx - 1).si_h_endpos;
2584 if (sip->si_cont_list == NULL)
2586 sip->si_flags |= HL_TRANS_CONT;
2587 sip->si_cont_list = CUR_STATE(idx - 1).si_cont_list;
2594 * Check the current stack for patterns with "keepend" flag.
2595 * Propagate the match-end to contained items, until a "skipend" item is found.
2597 static void
2598 check_keepend()
2600 int i;
2601 lpos_T maxpos;
2602 lpos_T maxpos_h;
2603 stateitem_T *sip;
2606 * This check can consume a lot of time; only do it from the level where
2607 * there really is a keepend.
2609 if (keepend_level < 0)
2610 return;
2613 * Find the last index of an "extend" item. "keepend" items before that
2614 * won't do anything. If there is no "extend" item "i" will be
2615 * "keepend_level" and all "keepend" items will work normally.
2617 for (i = current_state.ga_len - 1; i > keepend_level; --i)
2618 if (CUR_STATE(i).si_flags & HL_EXTEND)
2619 break;
2621 maxpos.lnum = 0;
2622 maxpos.col = 0;
2623 maxpos_h.lnum = 0;
2624 maxpos_h.col = 0;
2625 for ( ; i < current_state.ga_len; ++i)
2627 sip = &CUR_STATE(i);
2628 if (maxpos.lnum != 0)
2630 limit_pos_zero(&sip->si_m_endpos, &maxpos);
2631 limit_pos_zero(&sip->si_h_endpos, &maxpos_h);
2632 limit_pos_zero(&sip->si_eoe_pos, &maxpos);
2633 sip->si_ends = TRUE;
2635 if (sip->si_ends && (sip->si_flags & HL_KEEPEND))
2637 if (maxpos.lnum == 0
2638 || maxpos.lnum > sip->si_m_endpos.lnum
2639 || (maxpos.lnum == sip->si_m_endpos.lnum
2640 && maxpos.col > sip->si_m_endpos.col))
2641 maxpos = sip->si_m_endpos;
2642 if (maxpos_h.lnum == 0
2643 || maxpos_h.lnum > sip->si_h_endpos.lnum
2644 || (maxpos_h.lnum == sip->si_h_endpos.lnum
2645 && maxpos_h.col > sip->si_h_endpos.col))
2646 maxpos_h = sip->si_h_endpos;
2652 * Update an entry in the current_state stack for a start-skip-end pattern.
2653 * This finds the end of the current item, if it's in the current line.
2655 * Return the flags for the matched END.
2657 static void
2658 update_si_end(sip, startcol, force)
2659 stateitem_T *sip;
2660 int startcol; /* where to start searching for the end */
2661 int force; /* when TRUE overrule a previous end */
2663 lpos_T startpos;
2664 lpos_T endpos;
2665 lpos_T hl_endpos;
2666 lpos_T end_endpos;
2667 int end_idx;
2669 /* return quickly for a keyword */
2670 if (sip->si_idx < 0)
2671 return;
2673 /* Don't update when it's already done. Can be a match of an end pattern
2674 * that started in a previous line. Watch out: can also be a "keepend"
2675 * from a containing item. */
2676 if (!force && sip->si_m_endpos.lnum >= current_lnum)
2677 return;
2680 * We need to find the end of the region. It may continue in the next
2681 * line.
2683 end_idx = 0;
2684 startpos.lnum = current_lnum;
2685 startpos.col = startcol;
2686 find_endpos(sip->si_idx, &startpos, &endpos, &hl_endpos,
2687 &(sip->si_flags), &end_endpos, &end_idx, sip->si_extmatch);
2689 if (endpos.lnum == 0)
2691 /* No end pattern matched. */
2692 if (SYN_ITEMS(syn_buf)[sip->si_idx].sp_flags & HL_ONELINE)
2694 /* a "oneline" never continues in the next line */
2695 sip->si_ends = TRUE;
2696 sip->si_m_endpos.lnum = current_lnum;
2697 sip->si_m_endpos.col = (colnr_T)STRLEN(syn_getcurline());
2699 else
2701 /* continues in the next line */
2702 sip->si_ends = FALSE;
2703 sip->si_m_endpos.lnum = 0;
2705 sip->si_h_endpos = sip->si_m_endpos;
2707 else
2709 /* match within this line */
2710 sip->si_m_endpos = endpos;
2711 sip->si_h_endpos = hl_endpos;
2712 sip->si_eoe_pos = end_endpos;
2713 sip->si_ends = TRUE;
2714 sip->si_end_idx = end_idx;
2719 * Add a new state to the current state stack.
2720 * It is cleared and the index set to "idx".
2721 * Return FAIL if it's not possible (out of memory).
2723 static int
2724 push_current_state(idx)
2725 int idx;
2727 if (ga_grow(&current_state, 1) == FAIL)
2728 return FAIL;
2729 vim_memset(&CUR_STATE(current_state.ga_len), 0, sizeof(stateitem_T));
2730 CUR_STATE(current_state.ga_len).si_idx = idx;
2731 ++current_state.ga_len;
2732 return OK;
2736 * Remove a state from the current_state stack.
2738 static void
2739 pop_current_state()
2741 if (current_state.ga_len)
2743 unref_extmatch(CUR_STATE(current_state.ga_len - 1).si_extmatch);
2744 --current_state.ga_len;
2746 /* after the end of a pattern, try matching a keyword or pattern */
2747 next_match_idx = -1;
2749 /* if first state with "keepend" is popped, reset keepend_level */
2750 if (keepend_level >= current_state.ga_len)
2751 keepend_level = -1;
2755 * Find the end of a start/skip/end syntax region after "startpos".
2756 * Only checks one line.
2757 * Also handles a match item that continued from a previous line.
2758 * If not found, the syntax item continues in the next line. m_endpos->lnum
2759 * will be 0.
2760 * If found, the end of the region and the end of the highlighting is
2761 * computed.
2763 static void
2764 find_endpos(idx, startpos, m_endpos, hl_endpos, flagsp, end_endpos,
2765 end_idx, start_ext)
2766 int idx; /* index of the pattern */
2767 lpos_T *startpos; /* where to start looking for an END match */
2768 lpos_T *m_endpos; /* return: end of match */
2769 lpos_T *hl_endpos; /* return: end of highlighting */
2770 long *flagsp; /* return: flags of matching END */
2771 lpos_T *end_endpos; /* return: end of end pattern match */
2772 int *end_idx; /* return: group ID for end pat. match, or 0 */
2773 reg_extmatch_T *start_ext; /* submatches from the start pattern */
2775 colnr_T matchcol;
2776 synpat_T *spp, *spp_skip;
2777 int start_idx;
2778 int best_idx;
2779 regmmatch_T regmatch;
2780 regmmatch_T best_regmatch; /* startpos/endpos of best match */
2781 lpos_T pos;
2782 char_u *line;
2783 int had_match = FALSE;
2785 /* just in case we are invoked for a keyword */
2786 if (idx < 0)
2787 return;
2790 * Check for being called with a START pattern.
2791 * Can happen with a match that continues to the next line, because it
2792 * contained a region.
2794 spp = &(SYN_ITEMS(syn_buf)[idx]);
2795 if (spp->sp_type != SPTYPE_START)
2797 *hl_endpos = *startpos;
2798 return;
2802 * Find the SKIP or first END pattern after the last START pattern.
2804 for (;;)
2806 spp = &(SYN_ITEMS(syn_buf)[idx]);
2807 if (spp->sp_type != SPTYPE_START)
2808 break;
2809 ++idx;
2813 * Lookup the SKIP pattern (if present)
2815 if (spp->sp_type == SPTYPE_SKIP)
2817 spp_skip = spp;
2818 ++idx;
2820 else
2821 spp_skip = NULL;
2823 /* Setup external matches for syn_regexec(). */
2824 unref_extmatch(re_extmatch_in);
2825 re_extmatch_in = ref_extmatch(start_ext);
2827 matchcol = startpos->col; /* start looking for a match at sstart */
2828 start_idx = idx; /* remember the first END pattern. */
2829 best_regmatch.startpos[0].col = 0; /* avoid compiler warning */
2830 for (;;)
2833 * Find end pattern that matches first after "matchcol".
2835 best_idx = -1;
2836 for (idx = start_idx; idx < syn_buf->b_syn_patterns.ga_len; ++idx)
2838 int lc_col = matchcol;
2840 spp = &(SYN_ITEMS(syn_buf)[idx]);
2841 if (spp->sp_type != SPTYPE_END) /* past last END pattern */
2842 break;
2843 lc_col -= spp->sp_offsets[SPO_LC_OFF];
2844 if (lc_col < 0)
2845 lc_col = 0;
2847 regmatch.rmm_ic = spp->sp_ic;
2848 regmatch.regprog = spp->sp_prog;
2849 if (syn_regexec(&regmatch, startpos->lnum, lc_col))
2851 if (best_idx == -1 || regmatch.startpos[0].col
2852 < best_regmatch.startpos[0].col)
2854 best_idx = idx;
2855 best_regmatch.startpos[0] = regmatch.startpos[0];
2856 best_regmatch.endpos[0] = regmatch.endpos[0];
2862 * If all end patterns have been tried, and there is no match, the
2863 * item continues until end-of-line.
2865 if (best_idx == -1)
2866 break;
2869 * If the skip pattern matches before the end pattern,
2870 * continue searching after the skip pattern.
2872 if (spp_skip != NULL)
2874 int lc_col = matchcol - spp_skip->sp_offsets[SPO_LC_OFF];
2876 if (lc_col < 0)
2877 lc_col = 0;
2878 regmatch.rmm_ic = spp_skip->sp_ic;
2879 regmatch.regprog = spp_skip->sp_prog;
2880 if (syn_regexec(&regmatch, startpos->lnum, lc_col)
2881 && regmatch.startpos[0].col
2882 <= best_regmatch.startpos[0].col)
2884 /* Add offset to skip pattern match */
2885 syn_add_end_off(&pos, &regmatch, spp_skip, SPO_ME_OFF, 1);
2887 /* If the skip pattern goes on to the next line, there is no
2888 * match with an end pattern in this line. */
2889 if (pos.lnum > startpos->lnum)
2890 break;
2892 line = ml_get_buf(syn_buf, startpos->lnum, FALSE);
2894 /* take care of an empty match or negative offset */
2895 if (pos.col <= matchcol)
2896 ++matchcol;
2897 else if (pos.col <= regmatch.endpos[0].col)
2898 matchcol = pos.col;
2899 else
2900 /* Be careful not to jump over the NUL at the end-of-line */
2901 for (matchcol = regmatch.endpos[0].col;
2902 line[matchcol] != NUL && matchcol < pos.col;
2903 ++matchcol)
2906 /* if the skip pattern includes end-of-line, break here */
2907 if (line[matchcol] == NUL)
2908 break;
2910 continue; /* start with first end pattern again */
2915 * Match from start pattern to end pattern.
2916 * Correct for match and highlight offset of end pattern.
2918 spp = &(SYN_ITEMS(syn_buf)[best_idx]);
2919 syn_add_end_off(m_endpos, &best_regmatch, spp, SPO_ME_OFF, 1);
2920 /* can't end before the start */
2921 if (m_endpos->lnum == startpos->lnum && m_endpos->col < startpos->col)
2922 m_endpos->col = startpos->col;
2924 syn_add_end_off(end_endpos, &best_regmatch, spp, SPO_HE_OFF, 1);
2925 /* can't end before the start */
2926 if (end_endpos->lnum == startpos->lnum
2927 && end_endpos->col < startpos->col)
2928 end_endpos->col = startpos->col;
2929 /* can't end after the match */
2930 limit_pos(end_endpos, m_endpos);
2933 * If the end group is highlighted differently, adjust the pointers.
2935 if (spp->sp_syn_match_id != spp->sp_syn.id && spp->sp_syn_match_id != 0)
2937 *end_idx = best_idx;
2938 if (spp->sp_off_flags & (1 << (SPO_RE_OFF + SPO_COUNT)))
2940 hl_endpos->lnum = best_regmatch.endpos[0].lnum;
2941 hl_endpos->col = best_regmatch.endpos[0].col;
2943 else
2945 hl_endpos->lnum = best_regmatch.startpos[0].lnum;
2946 hl_endpos->col = best_regmatch.startpos[0].col;
2948 hl_endpos->col += spp->sp_offsets[SPO_RE_OFF];
2950 /* can't end before the start */
2951 if (hl_endpos->lnum == startpos->lnum
2952 && hl_endpos->col < startpos->col)
2953 hl_endpos->col = startpos->col;
2954 limit_pos(hl_endpos, m_endpos);
2956 /* now the match ends where the highlighting ends, it is turned
2957 * into the matchgroup for the end */
2958 *m_endpos = *hl_endpos;
2960 else
2962 *end_idx = 0;
2963 *hl_endpos = *end_endpos;
2966 *flagsp = spp->sp_flags;
2968 had_match = TRUE;
2969 break;
2972 /* no match for an END pattern in this line */
2973 if (!had_match)
2974 m_endpos->lnum = 0;
2976 /* Remove external matches. */
2977 unref_extmatch(re_extmatch_in);
2978 re_extmatch_in = NULL;
2982 * Limit "pos" not to be after "limit".
2984 static void
2985 limit_pos(pos, limit)
2986 lpos_T *pos;
2987 lpos_T *limit;
2989 if (pos->lnum > limit->lnum)
2990 *pos = *limit;
2991 else if (pos->lnum == limit->lnum && pos->col > limit->col)
2992 pos->col = limit->col;
2996 * Limit "pos" not to be after "limit", unless pos->lnum is zero.
2998 static void
2999 limit_pos_zero(pos, limit)
3000 lpos_T *pos;
3001 lpos_T *limit;
3003 if (pos->lnum == 0)
3004 *pos = *limit;
3005 else
3006 limit_pos(pos, limit);
3010 * Add offset to matched text for end of match or highlight.
3012 static void
3013 syn_add_end_off(result, regmatch, spp, idx, extra)
3014 lpos_T *result; /* returned position */
3015 regmmatch_T *regmatch; /* start/end of match */
3016 synpat_T *spp; /* matched pattern */
3017 int idx; /* index of offset */
3018 int extra; /* extra chars for offset to start */
3020 int col;
3021 int off;
3022 char_u *base;
3023 char_u *p;
3025 if (spp->sp_off_flags & (1 << idx))
3027 result->lnum = regmatch->startpos[0].lnum;
3028 col = regmatch->startpos[0].col;
3029 off = spp->sp_offsets[idx] + extra;
3031 else
3033 result->lnum = regmatch->endpos[0].lnum;
3034 col = regmatch->endpos[0].col;
3035 off = spp->sp_offsets[idx];
3037 /* Don't go past the end of the line. Matters for "rs=e+2" when there
3038 * is a matchgroup. Watch out for match with last NL in the buffer. */
3039 if (result->lnum > syn_buf->b_ml.ml_line_count)
3040 col = 0;
3041 else if (off != 0)
3043 base = ml_get_buf(syn_buf, result->lnum, FALSE);
3044 p = base + col;
3045 if (off > 0)
3047 while (off-- > 0 && *p != NUL)
3048 mb_ptr_adv(p);
3050 else if (off < 0)
3052 while (off++ < 0 && base < p)
3053 mb_ptr_back(base, p);
3055 col = (int)(p - base);
3057 result->col = col;
3061 * Add offset to matched text for start of match or highlight.
3062 * Avoid resulting column to become negative.
3064 static void
3065 syn_add_start_off(result, regmatch, spp, idx, extra)
3066 lpos_T *result; /* returned position */
3067 regmmatch_T *regmatch; /* start/end of match */
3068 synpat_T *spp;
3069 int idx;
3070 int extra; /* extra chars for offset to end */
3072 int col;
3073 int off;
3074 char_u *base;
3075 char_u *p;
3077 if (spp->sp_off_flags & (1 << (idx + SPO_COUNT)))
3079 result->lnum = regmatch->endpos[0].lnum;
3080 col = regmatch->endpos[0].col;
3081 off = spp->sp_offsets[idx] + extra;
3083 else
3085 result->lnum = regmatch->startpos[0].lnum;
3086 col = regmatch->startpos[0].col;
3087 off = spp->sp_offsets[idx];
3089 if (result->lnum > syn_buf->b_ml.ml_line_count)
3091 /* a "\n" at the end of the pattern may take us below the last line */
3092 result->lnum = syn_buf->b_ml.ml_line_count;
3093 col = STRLEN(ml_get_buf(syn_buf, result->lnum, FALSE));
3095 if (off != 0)
3097 base = ml_get_buf(syn_buf, result->lnum, FALSE);
3098 p = base + col;
3099 if (off > 0)
3101 while (off-- && *p != NUL)
3102 mb_ptr_adv(p);
3104 else if (off < 0)
3106 while (off++ && base < p)
3107 mb_ptr_back(base, p);
3109 col = (int)(p - base);
3111 result->col = col;
3115 * Get current line in syntax buffer.
3117 static char_u *
3118 syn_getcurline()
3120 return ml_get_buf(syn_buf, current_lnum, FALSE);
3124 * Call vim_regexec() to find a match with "rmp" in "syn_buf".
3125 * Returns TRUE when there is a match.
3127 static int
3128 syn_regexec(rmp, lnum, col)
3129 regmmatch_T *rmp;
3130 linenr_T lnum;
3131 colnr_T col;
3133 rmp->rmm_maxcol = syn_buf->b_p_smc;
3134 if (vim_regexec_multi(rmp, syn_win, syn_buf, lnum, col, NULL) > 0)
3136 rmp->startpos[0].lnum += lnum;
3137 rmp->endpos[0].lnum += lnum;
3138 return TRUE;
3140 return FALSE;
3144 * Check one position in a line for a matching keyword.
3145 * The caller must check if a keyword can start at startcol.
3146 * Return it's ID if found, 0 otherwise.
3148 static int
3149 check_keyword_id(line, startcol, endcolp, flagsp, next_listp, cur_si)
3150 char_u *line;
3151 int startcol; /* position in line to check for keyword */
3152 int *endcolp; /* return: character after found keyword */
3153 long *flagsp; /* return: flags of matching keyword */
3154 short **next_listp; /* return: next_list of matching keyword */
3155 stateitem_T *cur_si; /* item at the top of the stack */
3157 keyentry_T *kp;
3158 char_u *kwp;
3159 int round;
3160 int kwlen;
3161 char_u keyword[MAXKEYWLEN + 1]; /* assume max. keyword len is 80 */
3162 hashtab_T *ht;
3163 hashitem_T *hi;
3165 /* Find first character after the keyword. First character was already
3166 * checked. */
3167 kwp = line + startcol;
3168 kwlen = 0;
3171 #ifdef FEAT_MBYTE
3172 if (has_mbyte)
3173 kwlen += (*mb_ptr2len)(kwp + kwlen);
3174 else
3175 #endif
3176 ++kwlen;
3178 while (vim_iswordc_buf(kwp + kwlen, syn_buf));
3180 if (kwlen > MAXKEYWLEN)
3181 return 0;
3184 * Must make a copy of the keyword, so we can add a NUL and make it
3185 * lowercase.
3187 vim_strncpy(keyword, kwp, kwlen);
3190 * Try twice:
3191 * 1. matching case
3192 * 2. ignoring case
3194 for (round = 1; round <= 2; ++round)
3196 ht = round == 1 ? &syn_buf->b_keywtab : &syn_buf->b_keywtab_ic;
3197 if (ht->ht_used == 0)
3198 continue;
3199 if (round == 2) /* ignore case */
3200 (void)str_foldcase(kwp, kwlen, keyword, MAXKEYWLEN + 1);
3203 * Find keywords that match. There can be several with different
3204 * attributes.
3205 * When current_next_list is non-zero accept only that group, otherwise:
3206 * Accept a not-contained keyword at toplevel.
3207 * Accept a keyword at other levels only if it is in the contains list.
3209 hi = hash_find(ht, keyword);
3210 if (!HASHITEM_EMPTY(hi))
3211 for (kp = HI2KE(hi); kp != NULL; kp = kp->ke_next)
3213 if (current_next_list != 0
3214 ? in_id_list(NULL, current_next_list, &kp->k_syn, 0)
3215 : (cur_si == NULL
3216 ? !(kp->flags & HL_CONTAINED)
3217 : in_id_list(cur_si, cur_si->si_cont_list,
3218 &kp->k_syn, kp->flags & HL_CONTAINED)))
3220 *endcolp = startcol + kwlen;
3221 *flagsp = kp->flags;
3222 *next_listp = kp->next_list;
3223 return kp->k_syn.id;
3227 return 0;
3231 * Handle ":syntax case" command.
3233 static void
3234 syn_cmd_case(eap, syncing)
3235 exarg_T *eap;
3236 int syncing UNUSED;
3238 char_u *arg = eap->arg;
3239 char_u *next;
3241 eap->nextcmd = find_nextcmd(arg);
3242 if (eap->skip)
3243 return;
3245 next = skiptowhite(arg);
3246 if (STRNICMP(arg, "match", 5) == 0 && next - arg == 5)
3247 curbuf->b_syn_ic = FALSE;
3248 else if (STRNICMP(arg, "ignore", 6) == 0 && next - arg == 6)
3249 curbuf->b_syn_ic = TRUE;
3250 else
3251 EMSG2(_("E390: Illegal argument: %s"), arg);
3255 * Handle ":syntax spell" command.
3257 static void
3258 syn_cmd_spell(eap, syncing)
3259 exarg_T *eap;
3260 int syncing UNUSED;
3262 char_u *arg = eap->arg;
3263 char_u *next;
3265 eap->nextcmd = find_nextcmd(arg);
3266 if (eap->skip)
3267 return;
3269 next = skiptowhite(arg);
3270 if (STRNICMP(arg, "toplevel", 8) == 0 && next - arg == 8)
3271 curbuf->b_syn_spell = SYNSPL_TOP;
3272 else if (STRNICMP(arg, "notoplevel", 10) == 0 && next - arg == 10)
3273 curbuf->b_syn_spell = SYNSPL_NOTOP;
3274 else if (STRNICMP(arg, "default", 7) == 0 && next - arg == 7)
3275 curbuf->b_syn_spell = SYNSPL_DEFAULT;
3276 else
3277 EMSG2(_("E390: Illegal argument: %s"), arg);
3281 * Clear all syntax info for one buffer.
3283 void
3284 syntax_clear(buf)
3285 buf_T *buf;
3287 int i;
3289 buf->b_syn_error = FALSE; /* clear previous error */
3290 buf->b_syn_ic = FALSE; /* Use case, by default */
3291 buf->b_syn_spell = SYNSPL_DEFAULT; /* default spell checking */
3292 buf->b_syn_containedin = FALSE;
3294 /* free the keywords */
3295 clear_keywtab(&buf->b_keywtab);
3296 clear_keywtab(&buf->b_keywtab_ic);
3298 /* free the syntax patterns */
3299 for (i = buf->b_syn_patterns.ga_len; --i >= 0; )
3300 syn_clear_pattern(buf, i);
3301 ga_clear(&buf->b_syn_patterns);
3303 /* free the syntax clusters */
3304 for (i = buf->b_syn_clusters.ga_len; --i >= 0; )
3305 syn_clear_cluster(buf, i);
3306 ga_clear(&buf->b_syn_clusters);
3307 buf->b_spell_cluster_id = 0;
3308 buf->b_nospell_cluster_id = 0;
3310 buf->b_syn_sync_flags = 0;
3311 buf->b_syn_sync_minlines = 0;
3312 buf->b_syn_sync_maxlines = 0;
3313 buf->b_syn_sync_linebreaks = 0;
3315 vim_free(buf->b_syn_linecont_prog);
3316 buf->b_syn_linecont_prog = NULL;
3317 vim_free(buf->b_syn_linecont_pat);
3318 buf->b_syn_linecont_pat = NULL;
3319 #ifdef FEAT_FOLDING
3320 buf->b_syn_folditems = 0;
3321 #endif
3323 /* free the stored states */
3324 syn_stack_free_all(buf);
3325 invalidate_current_state();
3329 * Clear syncing info for one buffer.
3331 static void
3332 syntax_sync_clear()
3334 int i;
3336 /* free the syntax patterns */
3337 for (i = curbuf->b_syn_patterns.ga_len; --i >= 0; )
3338 if (SYN_ITEMS(curbuf)[i].sp_syncing)
3339 syn_remove_pattern(curbuf, i);
3341 curbuf->b_syn_sync_flags = 0;
3342 curbuf->b_syn_sync_minlines = 0;
3343 curbuf->b_syn_sync_maxlines = 0;
3344 curbuf->b_syn_sync_linebreaks = 0;
3346 vim_free(curbuf->b_syn_linecont_prog);
3347 curbuf->b_syn_linecont_prog = NULL;
3348 vim_free(curbuf->b_syn_linecont_pat);
3349 curbuf->b_syn_linecont_pat = NULL;
3351 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
3355 * Remove one pattern from the buffer's pattern list.
3357 static void
3358 syn_remove_pattern(buf, idx)
3359 buf_T *buf;
3360 int idx;
3362 synpat_T *spp;
3364 spp = &(SYN_ITEMS(buf)[idx]);
3365 #ifdef FEAT_FOLDING
3366 if (spp->sp_flags & HL_FOLD)
3367 --buf->b_syn_folditems;
3368 #endif
3369 syn_clear_pattern(buf, idx);
3370 mch_memmove(spp, spp + 1,
3371 sizeof(synpat_T) * (buf->b_syn_patterns.ga_len - idx - 1));
3372 --buf->b_syn_patterns.ga_len;
3376 * Clear and free one syntax pattern. When clearing all, must be called from
3377 * last to first!
3379 static void
3380 syn_clear_pattern(buf, i)
3381 buf_T *buf;
3382 int i;
3384 vim_free(SYN_ITEMS(buf)[i].sp_pattern);
3385 vim_free(SYN_ITEMS(buf)[i].sp_prog);
3386 /* Only free sp_cont_list and sp_next_list of first start pattern */
3387 if (i == 0 || SYN_ITEMS(buf)[i - 1].sp_type != SPTYPE_START)
3389 vim_free(SYN_ITEMS(buf)[i].sp_cont_list);
3390 vim_free(SYN_ITEMS(buf)[i].sp_next_list);
3391 vim_free(SYN_ITEMS(buf)[i].sp_syn.cont_in_list);
3396 * Clear and free one syntax cluster.
3398 static void
3399 syn_clear_cluster(buf, i)
3400 buf_T *buf;
3401 int i;
3403 vim_free(SYN_CLSTR(buf)[i].scl_name);
3404 vim_free(SYN_CLSTR(buf)[i].scl_name_u);
3405 vim_free(SYN_CLSTR(buf)[i].scl_list);
3409 * Handle ":syntax clear" command.
3411 static void
3412 syn_cmd_clear(eap, syncing)
3413 exarg_T *eap;
3414 int syncing;
3416 char_u *arg = eap->arg;
3417 char_u *arg_end;
3418 int id;
3420 eap->nextcmd = find_nextcmd(arg);
3421 if (eap->skip)
3422 return;
3425 * We have to disable this within ":syn include @group filename",
3426 * because otherwise @group would get deleted.
3427 * Only required for Vim 5.x syntax files, 6.0 ones don't contain ":syn
3428 * clear".
3430 if (curbuf->b_syn_topgrp != 0)
3431 return;
3433 if (ends_excmd(*arg))
3436 * No argument: Clear all syntax items.
3438 if (syncing)
3439 syntax_sync_clear();
3440 else
3442 syntax_clear(curbuf);
3443 do_unlet((char_u *)"b:current_syntax", TRUE);
3446 else
3449 * Clear the group IDs that are in the argument.
3451 while (!ends_excmd(*arg))
3453 arg_end = skiptowhite(arg);
3454 if (*arg == '@')
3456 id = syn_scl_namen2id(arg + 1, (int)(arg_end - arg - 1));
3457 if (id == 0)
3459 EMSG2(_("E391: No such syntax cluster: %s"), arg);
3460 break;
3462 else
3465 * We can't physically delete a cluster without changing
3466 * the IDs of other clusters, so we do the next best thing
3467 * and make it empty.
3469 short scl_id = id - SYNID_CLUSTER;
3471 vim_free(SYN_CLSTR(curbuf)[scl_id].scl_list);
3472 SYN_CLSTR(curbuf)[scl_id].scl_list = NULL;
3475 else
3477 id = syn_namen2id(arg, (int)(arg_end - arg));
3478 if (id == 0)
3480 EMSG2(_(e_nogroup), arg);
3481 break;
3483 else
3484 syn_clear_one(id, syncing);
3486 arg = skipwhite(arg_end);
3489 redraw_curbuf_later(SOME_VALID);
3490 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
3494 * Clear one syntax group for the current buffer.
3496 static void
3497 syn_clear_one(id, syncing)
3498 int id;
3499 int syncing;
3501 synpat_T *spp;
3502 int idx;
3504 /* Clear keywords only when not ":syn sync clear group-name" */
3505 if (!syncing)
3507 (void)syn_clear_keyword(id, &curbuf->b_keywtab);
3508 (void)syn_clear_keyword(id, &curbuf->b_keywtab_ic);
3511 /* clear the patterns for "id" */
3512 for (idx = curbuf->b_syn_patterns.ga_len; --idx >= 0; )
3514 spp = &(SYN_ITEMS(curbuf)[idx]);
3515 if (spp->sp_syn.id != id || spp->sp_syncing != syncing)
3516 continue;
3517 syn_remove_pattern(curbuf, idx);
3522 * Handle ":syntax on" command.
3524 static void
3525 syn_cmd_on(eap, syncing)
3526 exarg_T *eap;
3527 int syncing UNUSED;
3529 syn_cmd_onoff(eap, "syntax");
3533 * Handle ":syntax enable" command.
3535 static void
3536 syn_cmd_enable(eap, syncing)
3537 exarg_T *eap;
3538 int syncing UNUSED;
3540 set_internal_string_var((char_u *)"syntax_cmd", (char_u *)"enable");
3541 syn_cmd_onoff(eap, "syntax");
3542 do_unlet((char_u *)"g:syntax_cmd", TRUE);
3546 * Handle ":syntax reset" command.
3548 static void
3549 syn_cmd_reset(eap, syncing)
3550 exarg_T *eap;
3551 int syncing UNUSED;
3553 eap->nextcmd = check_nextcmd(eap->arg);
3554 if (!eap->skip)
3556 set_internal_string_var((char_u *)"syntax_cmd", (char_u *)"reset");
3557 do_cmdline_cmd((char_u *)"runtime! syntax/syncolor.vim");
3558 do_unlet((char_u *)"g:syntax_cmd", TRUE);
3563 * Handle ":syntax manual" command.
3565 static void
3566 syn_cmd_manual(eap, syncing)
3567 exarg_T *eap;
3568 int syncing UNUSED;
3570 syn_cmd_onoff(eap, "manual");
3574 * Handle ":syntax off" command.
3576 static void
3577 syn_cmd_off(eap, syncing)
3578 exarg_T *eap;
3579 int syncing UNUSED;
3581 syn_cmd_onoff(eap, "nosyntax");
3584 static void
3585 syn_cmd_onoff(eap, name)
3586 exarg_T *eap;
3587 char *name;
3589 char_u buf[100];
3591 eap->nextcmd = check_nextcmd(eap->arg);
3592 if (!eap->skip)
3594 STRCPY(buf, "so ");
3595 vim_snprintf((char *)buf + 3, sizeof(buf) - 3, SYNTAX_FNAME, name);
3596 do_cmdline_cmd(buf);
3601 * Handle ":syntax [list]" command: list current syntax words.
3603 static void
3604 syn_cmd_list(eap, syncing)
3605 exarg_T *eap;
3606 int syncing; /* when TRUE: list syncing items */
3608 char_u *arg = eap->arg;
3609 int id;
3610 char_u *arg_end;
3612 eap->nextcmd = find_nextcmd(arg);
3613 if (eap->skip)
3614 return;
3616 if (!syntax_present(curbuf))
3618 MSG(_("No Syntax items defined for this buffer"));
3619 return;
3622 if (syncing)
3624 if (curbuf->b_syn_sync_flags & SF_CCOMMENT)
3626 MSG_PUTS(_("syncing on C-style comments"));
3627 syn_lines_msg();
3628 syn_match_msg();
3629 return;
3631 else if (!(curbuf->b_syn_sync_flags & SF_MATCH))
3633 if (curbuf->b_syn_sync_minlines == 0)
3634 MSG_PUTS(_("no syncing"));
3635 else
3637 MSG_PUTS(_("syncing starts "));
3638 msg_outnum(curbuf->b_syn_sync_minlines);
3639 MSG_PUTS(_(" lines before top line"));
3640 syn_match_msg();
3642 return;
3644 MSG_PUTS_TITLE(_("\n--- Syntax sync items ---"));
3645 if (curbuf->b_syn_sync_minlines > 0
3646 || curbuf->b_syn_sync_maxlines > 0
3647 || curbuf->b_syn_sync_linebreaks > 0)
3649 MSG_PUTS(_("\nsyncing on items"));
3650 syn_lines_msg();
3651 syn_match_msg();
3654 else
3655 MSG_PUTS_TITLE(_("\n--- Syntax items ---"));
3656 if (ends_excmd(*arg))
3659 * No argument: List all group IDs and all syntax clusters.
3661 for (id = 1; id <= highlight_ga.ga_len && !got_int; ++id)
3662 syn_list_one(id, syncing, FALSE);
3663 for (id = 0; id < curbuf->b_syn_clusters.ga_len && !got_int; ++id)
3664 syn_list_cluster(id);
3666 else
3669 * List the group IDs and syntax clusters that are in the argument.
3671 while (!ends_excmd(*arg) && !got_int)
3673 arg_end = skiptowhite(arg);
3674 if (*arg == '@')
3676 id = syn_scl_namen2id(arg + 1, (int)(arg_end - arg - 1));
3677 if (id == 0)
3678 EMSG2(_("E392: No such syntax cluster: %s"), arg);
3679 else
3680 syn_list_cluster(id - SYNID_CLUSTER);
3682 else
3684 id = syn_namen2id(arg, (int)(arg_end - arg));
3685 if (id == 0)
3686 EMSG2(_(e_nogroup), arg);
3687 else
3688 syn_list_one(id, syncing, TRUE);
3690 arg = skipwhite(arg_end);
3693 eap->nextcmd = check_nextcmd(arg);
3696 static void
3697 syn_lines_msg()
3699 if (curbuf->b_syn_sync_maxlines > 0 || curbuf->b_syn_sync_minlines > 0)
3701 MSG_PUTS("; ");
3702 if (curbuf->b_syn_sync_minlines > 0)
3704 MSG_PUTS(_("minimal "));
3705 msg_outnum(curbuf->b_syn_sync_minlines);
3706 if (curbuf->b_syn_sync_maxlines)
3707 MSG_PUTS(", ");
3709 if (curbuf->b_syn_sync_maxlines > 0)
3711 MSG_PUTS(_("maximal "));
3712 msg_outnum(curbuf->b_syn_sync_maxlines);
3714 MSG_PUTS(_(" lines before top line"));
3718 static void
3719 syn_match_msg()
3721 if (curbuf->b_syn_sync_linebreaks > 0)
3723 MSG_PUTS(_("; match "));
3724 msg_outnum(curbuf->b_syn_sync_linebreaks);
3725 MSG_PUTS(_(" line breaks"));
3729 static int last_matchgroup;
3731 struct name_list
3733 int flag;
3734 char *name;
3737 static void syn_list_flags __ARGS((struct name_list *nl, int flags, int attr));
3740 * List one syntax item, for ":syntax" or "syntax list syntax_name".
3742 static void
3743 syn_list_one(id, syncing, link_only)
3744 int id;
3745 int syncing; /* when TRUE: list syncing items */
3746 int link_only; /* when TRUE; list link-only too */
3748 int attr;
3749 int idx;
3750 int did_header = FALSE;
3751 synpat_T *spp;
3752 static struct name_list namelist1[] =
3754 {HL_DISPLAY, "display"},
3755 {HL_CONTAINED, "contained"},
3756 {HL_ONELINE, "oneline"},
3757 {HL_KEEPEND, "keepend"},
3758 {HL_EXTEND, "extend"},
3759 {HL_EXCLUDENL, "excludenl"},
3760 {HL_TRANSP, "transparent"},
3761 {HL_FOLD, "fold"},
3762 {0, NULL}
3764 static struct name_list namelist2[] =
3766 {HL_SKIPWHITE, "skipwhite"},
3767 {HL_SKIPNL, "skipnl"},
3768 {HL_SKIPEMPTY, "skipempty"},
3769 {0, NULL}
3772 attr = hl_attr(HLF_D); /* highlight like directories */
3774 /* list the keywords for "id" */
3775 if (!syncing)
3777 did_header = syn_list_keywords(id, &curbuf->b_keywtab, FALSE, attr);
3778 did_header = syn_list_keywords(id, &curbuf->b_keywtab_ic,
3779 did_header, attr);
3782 /* list the patterns for "id" */
3783 for (idx = 0; idx < curbuf->b_syn_patterns.ga_len && !got_int; ++idx)
3785 spp = &(SYN_ITEMS(curbuf)[idx]);
3786 if (spp->sp_syn.id != id || spp->sp_syncing != syncing)
3787 continue;
3789 (void)syn_list_header(did_header, 999, id);
3790 did_header = TRUE;
3791 last_matchgroup = 0;
3792 if (spp->sp_type == SPTYPE_MATCH)
3794 put_pattern("match", ' ', spp, attr);
3795 msg_putchar(' ');
3797 else if (spp->sp_type == SPTYPE_START)
3799 while (SYN_ITEMS(curbuf)[idx].sp_type == SPTYPE_START)
3800 put_pattern("start", '=', &SYN_ITEMS(curbuf)[idx++], attr);
3801 if (SYN_ITEMS(curbuf)[idx].sp_type == SPTYPE_SKIP)
3802 put_pattern("skip", '=', &SYN_ITEMS(curbuf)[idx++], attr);
3803 while (idx < curbuf->b_syn_patterns.ga_len
3804 && SYN_ITEMS(curbuf)[idx].sp_type == SPTYPE_END)
3805 put_pattern("end", '=', &SYN_ITEMS(curbuf)[idx++], attr);
3806 --idx;
3807 msg_putchar(' ');
3809 syn_list_flags(namelist1, spp->sp_flags, attr);
3811 if (spp->sp_cont_list != NULL)
3812 put_id_list((char_u *)"contains", spp->sp_cont_list, attr);
3814 if (spp->sp_syn.cont_in_list != NULL)
3815 put_id_list((char_u *)"containedin",
3816 spp->sp_syn.cont_in_list, attr);
3818 if (spp->sp_next_list != NULL)
3820 put_id_list((char_u *)"nextgroup", spp->sp_next_list, attr);
3821 syn_list_flags(namelist2, spp->sp_flags, attr);
3823 if (spp->sp_flags & (HL_SYNC_HERE|HL_SYNC_THERE))
3825 if (spp->sp_flags & HL_SYNC_HERE)
3826 msg_puts_attr((char_u *)"grouphere", attr);
3827 else
3828 msg_puts_attr((char_u *)"groupthere", attr);
3829 msg_putchar(' ');
3830 if (spp->sp_sync_idx >= 0)
3831 msg_outtrans(HL_TABLE()[SYN_ITEMS(curbuf)
3832 [spp->sp_sync_idx].sp_syn.id - 1].sg_name);
3833 else
3834 MSG_PUTS("NONE");
3835 msg_putchar(' ');
3839 /* list the link, if there is one */
3840 if (HL_TABLE()[id - 1].sg_link && (did_header || link_only) && !got_int)
3842 (void)syn_list_header(did_header, 999, id);
3843 msg_puts_attr((char_u *)"links to", attr);
3844 msg_putchar(' ');
3845 msg_outtrans(HL_TABLE()[HL_TABLE()[id - 1].sg_link - 1].sg_name);
3849 static void
3850 syn_list_flags(nl, flags, attr)
3851 struct name_list *nl;
3852 int flags;
3853 int attr;
3855 int i;
3857 for (i = 0; nl[i].flag != 0; ++i)
3858 if (flags & nl[i].flag)
3860 msg_puts_attr((char_u *)nl[i].name, attr);
3861 msg_putchar(' ');
3866 * List one syntax cluster, for ":syntax" or "syntax list syntax_name".
3868 static void
3869 syn_list_cluster(id)
3870 int id;
3872 int endcol = 15;
3874 /* slight hack: roughly duplicate the guts of syn_list_header() */
3875 msg_putchar('\n');
3876 msg_outtrans(SYN_CLSTR(curbuf)[id].scl_name);
3878 if (msg_col >= endcol) /* output at least one space */
3879 endcol = msg_col + 1;
3880 if (Columns <= endcol) /* avoid hang for tiny window */
3881 endcol = Columns - 1;
3883 msg_advance(endcol);
3884 if (SYN_CLSTR(curbuf)[id].scl_list != NULL)
3886 put_id_list((char_u *)"cluster", SYN_CLSTR(curbuf)[id].scl_list,
3887 hl_attr(HLF_D));
3889 else
3891 msg_puts_attr((char_u *)"cluster", hl_attr(HLF_D));
3892 msg_puts((char_u *)"=NONE");
3896 static void
3897 put_id_list(name, list, attr)
3898 char_u *name;
3899 short *list;
3900 int attr;
3902 short *p;
3904 msg_puts_attr(name, attr);
3905 msg_putchar('=');
3906 for (p = list; *p; ++p)
3908 if (*p >= SYNID_ALLBUT && *p < SYNID_TOP)
3910 if (p[1])
3911 MSG_PUTS("ALLBUT");
3912 else
3913 MSG_PUTS("ALL");
3915 else if (*p >= SYNID_TOP && *p < SYNID_CONTAINED)
3917 MSG_PUTS("TOP");
3919 else if (*p >= SYNID_CONTAINED && *p < SYNID_CLUSTER)
3921 MSG_PUTS("CONTAINED");
3923 else if (*p >= SYNID_CLUSTER)
3925 short scl_id = *p - SYNID_CLUSTER;
3927 msg_putchar('@');
3928 msg_outtrans(SYN_CLSTR(curbuf)[scl_id].scl_name);
3930 else
3931 msg_outtrans(HL_TABLE()[*p - 1].sg_name);
3932 if (p[1])
3933 msg_putchar(',');
3935 msg_putchar(' ');
3938 static void
3939 put_pattern(s, c, spp, attr)
3940 char *s;
3941 int c;
3942 synpat_T *spp;
3943 int attr;
3945 long n;
3946 int mask;
3947 int first;
3948 static char *sepchars = "/+=-#@\"|'^&";
3949 int i;
3951 /* May have to write "matchgroup=group" */
3952 if (last_matchgroup != spp->sp_syn_match_id)
3954 last_matchgroup = spp->sp_syn_match_id;
3955 msg_puts_attr((char_u *)"matchgroup", attr);
3956 msg_putchar('=');
3957 if (last_matchgroup == 0)
3958 msg_outtrans((char_u *)"NONE");
3959 else
3960 msg_outtrans(HL_TABLE()[last_matchgroup - 1].sg_name);
3961 msg_putchar(' ');
3964 /* output the name of the pattern and an '=' or ' ' */
3965 msg_puts_attr((char_u *)s, attr);
3966 msg_putchar(c);
3968 /* output the pattern, in between a char that is not in the pattern */
3969 for (i = 0; vim_strchr(spp->sp_pattern, sepchars[i]) != NULL; )
3970 if (sepchars[++i] == NUL)
3972 i = 0; /* no good char found, just use the first one */
3973 break;
3975 msg_putchar(sepchars[i]);
3976 msg_outtrans(spp->sp_pattern);
3977 msg_putchar(sepchars[i]);
3979 /* output any pattern options */
3980 first = TRUE;
3981 for (i = 0; i < SPO_COUNT; ++i)
3983 mask = (1 << i);
3984 if (spp->sp_off_flags & (mask + (mask << SPO_COUNT)))
3986 if (!first)
3987 msg_putchar(','); /* separate with commas */
3988 msg_puts((char_u *)spo_name_tab[i]);
3989 n = spp->sp_offsets[i];
3990 if (i != SPO_LC_OFF)
3992 if (spp->sp_off_flags & mask)
3993 msg_putchar('s');
3994 else
3995 msg_putchar('e');
3996 if (n > 0)
3997 msg_putchar('+');
3999 if (n || i == SPO_LC_OFF)
4000 msg_outnum(n);
4001 first = FALSE;
4004 msg_putchar(' ');
4008 * List or clear the keywords for one syntax group.
4009 * Return TRUE if the header has been printed.
4011 static int
4012 syn_list_keywords(id, ht, did_header, attr)
4013 int id;
4014 hashtab_T *ht;
4015 int did_header; /* header has already been printed */
4016 int attr;
4018 int outlen;
4019 hashitem_T *hi;
4020 keyentry_T *kp;
4021 int todo;
4022 int prev_contained = 0;
4023 short *prev_next_list = NULL;
4024 short *prev_cont_in_list = NULL;
4025 int prev_skipnl = 0;
4026 int prev_skipwhite = 0;
4027 int prev_skipempty = 0;
4030 * Unfortunately, this list of keywords is not sorted on alphabet but on
4031 * hash value...
4033 todo = (int)ht->ht_used;
4034 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
4036 if (!HASHITEM_EMPTY(hi))
4038 --todo;
4039 for (kp = HI2KE(hi); kp != NULL && !got_int; kp = kp->ke_next)
4041 if (kp->k_syn.id == id)
4043 if (prev_contained != (kp->flags & HL_CONTAINED)
4044 || prev_skipnl != (kp->flags & HL_SKIPNL)
4045 || prev_skipwhite != (kp->flags & HL_SKIPWHITE)
4046 || prev_skipempty != (kp->flags & HL_SKIPEMPTY)
4047 || prev_cont_in_list != kp->k_syn.cont_in_list
4048 || prev_next_list != kp->next_list)
4049 outlen = 9999;
4050 else
4051 outlen = (int)STRLEN(kp->keyword);
4052 /* output "contained" and "nextgroup" on each line */
4053 if (syn_list_header(did_header, outlen, id))
4055 prev_contained = 0;
4056 prev_next_list = NULL;
4057 prev_cont_in_list = NULL;
4058 prev_skipnl = 0;
4059 prev_skipwhite = 0;
4060 prev_skipempty = 0;
4062 did_header = TRUE;
4063 if (prev_contained != (kp->flags & HL_CONTAINED))
4065 msg_puts_attr((char_u *)"contained", attr);
4066 msg_putchar(' ');
4067 prev_contained = (kp->flags & HL_CONTAINED);
4069 if (kp->k_syn.cont_in_list != prev_cont_in_list)
4071 put_id_list((char_u *)"containedin",
4072 kp->k_syn.cont_in_list, attr);
4073 msg_putchar(' ');
4074 prev_cont_in_list = kp->k_syn.cont_in_list;
4076 if (kp->next_list != prev_next_list)
4078 put_id_list((char_u *)"nextgroup", kp->next_list, attr);
4079 msg_putchar(' ');
4080 prev_next_list = kp->next_list;
4081 if (kp->flags & HL_SKIPNL)
4083 msg_puts_attr((char_u *)"skipnl", attr);
4084 msg_putchar(' ');
4085 prev_skipnl = (kp->flags & HL_SKIPNL);
4087 if (kp->flags & HL_SKIPWHITE)
4089 msg_puts_attr((char_u *)"skipwhite", attr);
4090 msg_putchar(' ');
4091 prev_skipwhite = (kp->flags & HL_SKIPWHITE);
4093 if (kp->flags & HL_SKIPEMPTY)
4095 msg_puts_attr((char_u *)"skipempty", attr);
4096 msg_putchar(' ');
4097 prev_skipempty = (kp->flags & HL_SKIPEMPTY);
4100 msg_outtrans(kp->keyword);
4106 return did_header;
4109 static void
4110 syn_clear_keyword(id, ht)
4111 int id;
4112 hashtab_T *ht;
4114 hashitem_T *hi;
4115 keyentry_T *kp;
4116 keyentry_T *kp_prev;
4117 keyentry_T *kp_next;
4118 int todo;
4120 hash_lock(ht);
4121 todo = (int)ht->ht_used;
4122 for (hi = ht->ht_array; todo > 0; ++hi)
4124 if (!HASHITEM_EMPTY(hi))
4126 --todo;
4127 kp_prev = NULL;
4128 for (kp = HI2KE(hi); kp != NULL; )
4130 if (kp->k_syn.id == id)
4132 kp_next = kp->ke_next;
4133 if (kp_prev == NULL)
4135 if (kp_next == NULL)
4136 hash_remove(ht, hi);
4137 else
4138 hi->hi_key = KE2HIKEY(kp_next);
4140 else
4141 kp_prev->ke_next = kp_next;
4142 vim_free(kp->next_list);
4143 vim_free(kp->k_syn.cont_in_list);
4144 vim_free(kp);
4145 kp = kp_next;
4147 else
4149 kp_prev = kp;
4150 kp = kp->ke_next;
4155 hash_unlock(ht);
4159 * Clear a whole keyword table.
4161 static void
4162 clear_keywtab(ht)
4163 hashtab_T *ht;
4165 hashitem_T *hi;
4166 int todo;
4167 keyentry_T *kp;
4168 keyentry_T *kp_next;
4170 todo = (int)ht->ht_used;
4171 for (hi = ht->ht_array; todo > 0; ++hi)
4173 if (!HASHITEM_EMPTY(hi))
4175 --todo;
4176 for (kp = HI2KE(hi); kp != NULL; kp = kp_next)
4178 kp_next = kp->ke_next;
4179 vim_free(kp->next_list);
4180 vim_free(kp->k_syn.cont_in_list);
4181 vim_free(kp);
4185 hash_clear(ht);
4186 hash_init(ht);
4190 * Add a keyword to the list of keywords.
4192 static void
4193 add_keyword(name, id, flags, cont_in_list, next_list)
4194 char_u *name; /* name of keyword */
4195 int id; /* group ID for this keyword */
4196 int flags; /* flags for this keyword */
4197 short *cont_in_list; /* containedin for this keyword */
4198 short *next_list; /* nextgroup for this keyword */
4200 keyentry_T *kp;
4201 hashtab_T *ht;
4202 hashitem_T *hi;
4203 char_u *name_ic;
4204 long_u hash;
4205 char_u name_folded[MAXKEYWLEN + 1];
4207 if (curbuf->b_syn_ic)
4208 name_ic = str_foldcase(name, (int)STRLEN(name),
4209 name_folded, MAXKEYWLEN + 1);
4210 else
4211 name_ic = name;
4212 kp = (keyentry_T *)alloc((int)(sizeof(keyentry_T) + STRLEN(name_ic)));
4213 if (kp == NULL)
4214 return;
4215 STRCPY(kp->keyword, name_ic);
4216 kp->k_syn.id = id;
4217 kp->k_syn.inc_tag = current_syn_inc_tag;
4218 kp->flags = flags;
4219 kp->k_syn.cont_in_list = copy_id_list(cont_in_list);
4220 if (cont_in_list != NULL)
4221 curbuf->b_syn_containedin = TRUE;
4222 kp->next_list = copy_id_list(next_list);
4224 if (curbuf->b_syn_ic)
4225 ht = &curbuf->b_keywtab_ic;
4226 else
4227 ht = &curbuf->b_keywtab;
4229 hash = hash_hash(kp->keyword);
4230 hi = hash_lookup(ht, kp->keyword, hash);
4231 if (HASHITEM_EMPTY(hi))
4233 /* new keyword, add to hashtable */
4234 kp->ke_next = NULL;
4235 hash_add_item(ht, hi, kp->keyword, hash);
4237 else
4239 /* keyword already exists, prepend to list */
4240 kp->ke_next = HI2KE(hi);
4241 hi->hi_key = KE2HIKEY(kp);
4246 * Get the start and end of the group name argument.
4247 * Return a pointer to the first argument.
4248 * Return NULL if the end of the command was found instead of further args.
4250 static char_u *
4251 get_group_name(arg, name_end)
4252 char_u *arg; /* start of the argument */
4253 char_u **name_end; /* pointer to end of the name */
4255 char_u *rest;
4257 *name_end = skiptowhite(arg);
4258 rest = skipwhite(*name_end);
4261 * Check if there are enough arguments. The first argument may be a
4262 * pattern, where '|' is allowed, so only check for NUL.
4264 if (ends_excmd(*arg) || *rest == NUL)
4265 return NULL;
4266 return rest;
4270 * Check for syntax command option arguments.
4271 * This can be called at any place in the list of arguments, and just picks
4272 * out the arguments that are known. Can be called several times in a row to
4273 * collect all options in between other arguments.
4274 * Return a pointer to the next argument (which isn't an option).
4275 * Return NULL for any error;
4277 static char_u *
4278 get_syn_options(arg, opt)
4279 char_u *arg; /* next argument to be checked */
4280 syn_opt_arg_T *opt; /* various things */
4282 char_u *gname_start, *gname;
4283 int syn_id;
4284 int len;
4285 char *p;
4286 int i;
4287 int fidx;
4288 static struct flag
4290 char *name;
4291 int argtype;
4292 int flags;
4293 } flagtab[] = { {"cCoOnNtTaAiInNeEdD", 0, HL_CONTAINED},
4294 {"oOnNeElLiInNeE", 0, HL_ONELINE},
4295 {"kKeEeEpPeEnNdD", 0, HL_KEEPEND},
4296 {"eExXtTeEnNdD", 0, HL_EXTEND},
4297 {"eExXcClLuUdDeEnNlL", 0, HL_EXCLUDENL},
4298 {"tTrRaAnNsSpPaArReEnNtT", 0, HL_TRANSP},
4299 {"sSkKiIpPnNlL", 0, HL_SKIPNL},
4300 {"sSkKiIpPwWhHiItTeE", 0, HL_SKIPWHITE},
4301 {"sSkKiIpPeEmMpPtTyY", 0, HL_SKIPEMPTY},
4302 {"gGrRoOuUpPhHeErReE", 0, HL_SYNC_HERE},
4303 {"gGrRoOuUpPtThHeErReE", 0, HL_SYNC_THERE},
4304 {"dDiIsSpPlLaAyY", 0, HL_DISPLAY},
4305 {"fFoOlLdD", 0, HL_FOLD},
4306 {"cCoOnNtTaAiInNsS", 1, 0},
4307 {"cCoOnNtTaAiInNeEdDiInN", 2, 0},
4308 {"nNeExXtTgGrRoOuUpP", 3, 0},
4310 static char *first_letters = "cCoOkKeEtTsSgGdDfFnN";
4312 if (arg == NULL) /* already detected error */
4313 return NULL;
4315 for (;;)
4318 * This is used very often when a large number of keywords is defined.
4319 * Need to skip quickly when no option name is found.
4320 * Also avoid tolower(), it's slow.
4322 if (strchr(first_letters, *arg) == NULL)
4323 break;
4325 for (fidx = sizeof(flagtab) / sizeof(struct flag); --fidx >= 0; )
4327 p = flagtab[fidx].name;
4328 for (i = 0, len = 0; p[i] != NUL; i += 2, ++len)
4329 if (arg[len] != p[i] && arg[len] != p[i + 1])
4330 break;
4331 if (p[i] == NUL && (vim_iswhite(arg[len])
4332 || (flagtab[fidx].argtype > 0
4333 ? arg[len] == '='
4334 : ends_excmd(arg[len]))))
4336 if (opt->keyword
4337 && (flagtab[fidx].flags == HL_DISPLAY
4338 || flagtab[fidx].flags == HL_FOLD
4339 || flagtab[fidx].flags == HL_EXTEND))
4340 /* treat "display", "fold" and "extend" as a keyword */
4341 fidx = -1;
4342 break;
4345 if (fidx < 0) /* no match found */
4346 break;
4348 if (flagtab[fidx].argtype == 1)
4350 if (!opt->has_cont_list)
4352 EMSG(_("E395: contains argument not accepted here"));
4353 return NULL;
4355 if (get_id_list(&arg, 8, &opt->cont_list) == FAIL)
4356 return NULL;
4358 else if (flagtab[fidx].argtype == 2)
4360 #if 0 /* cannot happen */
4361 if (opt->cont_in_list == NULL)
4363 EMSG(_("E396: containedin argument not accepted here"));
4364 return NULL;
4366 #endif
4367 if (get_id_list(&arg, 11, &opt->cont_in_list) == FAIL)
4368 return NULL;
4370 else if (flagtab[fidx].argtype == 3)
4372 if (get_id_list(&arg, 9, &opt->next_list) == FAIL)
4373 return NULL;
4375 else
4377 opt->flags |= flagtab[fidx].flags;
4378 arg = skipwhite(arg + len);
4380 if (flagtab[fidx].flags == HL_SYNC_HERE
4381 || flagtab[fidx].flags == HL_SYNC_THERE)
4383 if (opt->sync_idx == NULL)
4385 EMSG(_("E393: group[t]here not accepted here"));
4386 return NULL;
4388 gname_start = arg;
4389 arg = skiptowhite(arg);
4390 if (gname_start == arg)
4391 return NULL;
4392 gname = vim_strnsave(gname_start, (int)(arg - gname_start));
4393 if (gname == NULL)
4394 return NULL;
4395 if (STRCMP(gname, "NONE") == 0)
4396 *opt->sync_idx = NONE_IDX;
4397 else
4399 syn_id = syn_name2id(gname);
4400 for (i = curbuf->b_syn_patterns.ga_len; --i >= 0; )
4401 if (SYN_ITEMS(curbuf)[i].sp_syn.id == syn_id
4402 && SYN_ITEMS(curbuf)[i].sp_type == SPTYPE_START)
4404 *opt->sync_idx = i;
4405 break;
4407 if (i < 0)
4409 EMSG2(_("E394: Didn't find region item for %s"), gname);
4410 vim_free(gname);
4411 return NULL;
4415 vim_free(gname);
4416 arg = skipwhite(arg);
4418 #ifdef FEAT_FOLDING
4419 else if (flagtab[fidx].flags == HL_FOLD
4420 && foldmethodIsSyntax(curwin))
4421 /* Need to update folds later. */
4422 foldUpdateAll(curwin);
4423 #endif
4427 return arg;
4431 * Adjustments to syntax item when declared in a ":syn include"'d file.
4432 * Set the contained flag, and if the item is not already contained, add it
4433 * to the specified top-level group, if any.
4435 static void
4436 syn_incl_toplevel(id, flagsp)
4437 int id;
4438 int *flagsp;
4440 if ((*flagsp & HL_CONTAINED) || curbuf->b_syn_topgrp == 0)
4441 return;
4442 *flagsp |= HL_CONTAINED;
4443 if (curbuf->b_syn_topgrp >= SYNID_CLUSTER)
4445 /* We have to alloc this, because syn_combine_list() will free it. */
4446 short *grp_list = (short *)alloc((unsigned)(2 * sizeof(short)));
4447 int tlg_id = curbuf->b_syn_topgrp - SYNID_CLUSTER;
4449 if (grp_list != NULL)
4451 grp_list[0] = id;
4452 grp_list[1] = 0;
4453 syn_combine_list(&SYN_CLSTR(curbuf)[tlg_id].scl_list, &grp_list,
4454 CLUSTER_ADD);
4460 * Handle ":syntax include [@{group-name}] filename" command.
4462 static void
4463 syn_cmd_include(eap, syncing)
4464 exarg_T *eap;
4465 int syncing UNUSED;
4467 char_u *arg = eap->arg;
4468 int sgl_id = 1;
4469 char_u *group_name_end;
4470 char_u *rest;
4471 char_u *errormsg = NULL;
4472 int prev_toplvl_grp;
4473 int prev_syn_inc_tag;
4474 int source = FALSE;
4476 eap->nextcmd = find_nextcmd(arg);
4477 if (eap->skip)
4478 return;
4480 if (arg[0] == '@')
4482 ++arg;
4483 rest = get_group_name(arg, &group_name_end);
4484 if (rest == NULL)
4486 EMSG((char_u *)_("E397: Filename required"));
4487 return;
4489 sgl_id = syn_check_cluster(arg, (int)(group_name_end - arg));
4490 /* separate_nextcmd() and expand_filename() depend on this */
4491 eap->arg = rest;
4495 * Everything that's left, up to the next command, should be the
4496 * filename to include.
4498 eap->argt |= (XFILE | NOSPC);
4499 separate_nextcmd(eap);
4500 if (*eap->arg == '<' || *eap->arg == '$' || mch_isFullName(eap->arg))
4502 /* For an absolute path, "$VIM/..." or "<sfile>.." we ":source" the
4503 * file. Need to expand the file name first. In other cases
4504 * ":runtime!" is used. */
4505 source = TRUE;
4506 if (expand_filename(eap, syn_cmdlinep, &errormsg) == FAIL)
4508 if (errormsg != NULL)
4509 EMSG(errormsg);
4510 return;
4515 * Save and restore the existing top-level grouplist id and ":syn
4516 * include" tag around the actual inclusion.
4518 prev_syn_inc_tag = current_syn_inc_tag;
4519 current_syn_inc_tag = ++running_syn_inc_tag;
4520 prev_toplvl_grp = curbuf->b_syn_topgrp;
4521 curbuf->b_syn_topgrp = sgl_id;
4522 if (source ? do_source(eap->arg, FALSE, DOSO_NONE) == FAIL
4523 : source_runtime(eap->arg, TRUE) == FAIL)
4524 EMSG2(_(e_notopen), eap->arg);
4525 curbuf->b_syn_topgrp = prev_toplvl_grp;
4526 current_syn_inc_tag = prev_syn_inc_tag;
4530 * Handle ":syntax keyword {group-name} [{option}] keyword .." command.
4532 static void
4533 syn_cmd_keyword(eap, syncing)
4534 exarg_T *eap;
4535 int syncing UNUSED;
4537 char_u *arg = eap->arg;
4538 char_u *group_name_end;
4539 int syn_id;
4540 char_u *rest;
4541 char_u *keyword_copy;
4542 char_u *p;
4543 char_u *kw;
4544 syn_opt_arg_T syn_opt_arg;
4545 int cnt;
4547 rest = get_group_name(arg, &group_name_end);
4549 if (rest != NULL)
4551 syn_id = syn_check_group(arg, (int)(group_name_end - arg));
4553 /* allocate a buffer, for removing the backslashes in the keyword */
4554 keyword_copy = alloc((unsigned)STRLEN(rest) + 1);
4555 if (keyword_copy != NULL)
4557 syn_opt_arg.flags = 0;
4558 syn_opt_arg.keyword = TRUE;
4559 syn_opt_arg.sync_idx = NULL;
4560 syn_opt_arg.has_cont_list = FALSE;
4561 syn_opt_arg.cont_in_list = NULL;
4562 syn_opt_arg.next_list = NULL;
4565 * The options given apply to ALL keywords, so all options must be
4566 * found before keywords can be created.
4567 * 1: collect the options and copy the keywords to keyword_copy.
4569 cnt = 0;
4570 p = keyword_copy;
4571 for ( ; rest != NULL && !ends_excmd(*rest); rest = skipwhite(rest))
4573 rest = get_syn_options(rest, &syn_opt_arg);
4574 if (rest == NULL || ends_excmd(*rest))
4575 break;
4576 /* Copy the keyword, removing backslashes, and add a NUL. */
4577 while (*rest != NUL && !vim_iswhite(*rest))
4579 if (*rest == '\\' && rest[1] != NUL)
4580 ++rest;
4581 *p++ = *rest++;
4583 *p++ = NUL;
4584 ++cnt;
4587 if (!eap->skip)
4589 /* Adjust flags for use of ":syn include". */
4590 syn_incl_toplevel(syn_id, &syn_opt_arg.flags);
4593 * 2: Add an entry for each keyword.
4595 for (kw = keyword_copy; --cnt >= 0; kw += STRLEN(kw) + 1)
4597 for (p = vim_strchr(kw, '['); ; )
4599 if (p != NULL)
4600 *p = NUL;
4601 add_keyword(kw, syn_id, syn_opt_arg.flags,
4602 syn_opt_arg.cont_in_list,
4603 syn_opt_arg.next_list);
4604 if (p == NULL)
4605 break;
4606 if (p[1] == NUL)
4608 EMSG2(_("E789: Missing ']': %s"), kw);
4609 kw = p + 2; /* skip over the NUL */
4610 break;
4612 if (p[1] == ']')
4614 kw = p + 1; /* skip over the "]" */
4615 break;
4617 #ifdef FEAT_MBYTE
4618 if (has_mbyte)
4620 int l = (*mb_ptr2len)(p + 1);
4622 mch_memmove(p, p + 1, l);
4623 p += l;
4625 else
4626 #endif
4628 p[0] = p[1];
4629 ++p;
4635 vim_free(keyword_copy);
4636 vim_free(syn_opt_arg.cont_in_list);
4637 vim_free(syn_opt_arg.next_list);
4641 if (rest != NULL)
4642 eap->nextcmd = check_nextcmd(rest);
4643 else
4644 EMSG2(_(e_invarg2), arg);
4646 redraw_curbuf_later(SOME_VALID);
4647 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
4651 * Handle ":syntax match {name} [{options}] {pattern} [{options}]".
4653 * Also ":syntax sync match {name} [[grouphere | groupthere] {group-name}] .."
4655 static void
4656 syn_cmd_match(eap, syncing)
4657 exarg_T *eap;
4658 int syncing; /* TRUE for ":syntax sync match .. " */
4660 char_u *arg = eap->arg;
4661 char_u *group_name_end;
4662 char_u *rest;
4663 synpat_T item; /* the item found in the line */
4664 int syn_id;
4665 int idx;
4666 syn_opt_arg_T syn_opt_arg;
4667 int sync_idx = 0;
4669 /* Isolate the group name, check for validity */
4670 rest = get_group_name(arg, &group_name_end);
4672 /* Get options before the pattern */
4673 syn_opt_arg.flags = 0;
4674 syn_opt_arg.keyword = FALSE;
4675 syn_opt_arg.sync_idx = syncing ? &sync_idx : NULL;
4676 syn_opt_arg.has_cont_list = TRUE;
4677 syn_opt_arg.cont_list = NULL;
4678 syn_opt_arg.cont_in_list = NULL;
4679 syn_opt_arg.next_list = NULL;
4680 rest = get_syn_options(rest, &syn_opt_arg);
4682 /* get the pattern. */
4683 init_syn_patterns();
4684 vim_memset(&item, 0, sizeof(item));
4685 rest = get_syn_pattern(rest, &item);
4686 if (vim_regcomp_had_eol() && !(syn_opt_arg.flags & HL_EXCLUDENL))
4687 syn_opt_arg.flags |= HL_HAS_EOL;
4689 /* Get options after the pattern */
4690 rest = get_syn_options(rest, &syn_opt_arg);
4692 if (rest != NULL) /* all arguments are valid */
4695 * Check for trailing command and illegal trailing arguments.
4697 eap->nextcmd = check_nextcmd(rest);
4698 if (!ends_excmd(*rest) || eap->skip)
4699 rest = NULL;
4700 else if (ga_grow(&curbuf->b_syn_patterns, 1) != FAIL
4701 && (syn_id = syn_check_group(arg,
4702 (int)(group_name_end - arg))) != 0)
4704 syn_incl_toplevel(syn_id, &syn_opt_arg.flags);
4706 * Store the pattern in the syn_items list
4708 idx = curbuf->b_syn_patterns.ga_len;
4709 SYN_ITEMS(curbuf)[idx] = item;
4710 SYN_ITEMS(curbuf)[idx].sp_syncing = syncing;
4711 SYN_ITEMS(curbuf)[idx].sp_type = SPTYPE_MATCH;
4712 SYN_ITEMS(curbuf)[idx].sp_syn.id = syn_id;
4713 SYN_ITEMS(curbuf)[idx].sp_syn.inc_tag = current_syn_inc_tag;
4714 SYN_ITEMS(curbuf)[idx].sp_flags = syn_opt_arg.flags;
4715 SYN_ITEMS(curbuf)[idx].sp_sync_idx = sync_idx;
4716 SYN_ITEMS(curbuf)[idx].sp_cont_list = syn_opt_arg.cont_list;
4717 SYN_ITEMS(curbuf)[idx].sp_syn.cont_in_list =
4718 syn_opt_arg.cont_in_list;
4719 if (syn_opt_arg.cont_in_list != NULL)
4720 curbuf->b_syn_containedin = TRUE;
4721 SYN_ITEMS(curbuf)[idx].sp_next_list = syn_opt_arg.next_list;
4722 ++curbuf->b_syn_patterns.ga_len;
4724 /* remember that we found a match for syncing on */
4725 if (syn_opt_arg.flags & (HL_SYNC_HERE|HL_SYNC_THERE))
4726 curbuf->b_syn_sync_flags |= SF_MATCH;
4727 #ifdef FEAT_FOLDING
4728 if (syn_opt_arg.flags & HL_FOLD)
4729 ++curbuf->b_syn_folditems;
4730 #endif
4732 redraw_curbuf_later(SOME_VALID);
4733 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
4734 return; /* don't free the progs and patterns now */
4739 * Something failed, free the allocated memory.
4741 vim_free(item.sp_prog);
4742 vim_free(item.sp_pattern);
4743 vim_free(syn_opt_arg.cont_list);
4744 vim_free(syn_opt_arg.cont_in_list);
4745 vim_free(syn_opt_arg.next_list);
4747 if (rest == NULL)
4748 EMSG2(_(e_invarg2), arg);
4752 * Handle ":syntax region {group-name} [matchgroup={group-name}]
4753 * start {start} .. [skip {skip}] end {end} .. [{options}]".
4755 static void
4756 syn_cmd_region(eap, syncing)
4757 exarg_T *eap;
4758 int syncing; /* TRUE for ":syntax sync region .." */
4760 char_u *arg = eap->arg;
4761 char_u *group_name_end;
4762 char_u *rest; /* next arg, NULL on error */
4763 char_u *key_end;
4764 char_u *key = NULL;
4765 char_u *p;
4766 int item;
4767 #define ITEM_START 0
4768 #define ITEM_SKIP 1
4769 #define ITEM_END 2
4770 #define ITEM_MATCHGROUP 3
4771 struct pat_ptr
4773 synpat_T *pp_synp; /* pointer to syn_pattern */
4774 int pp_matchgroup_id; /* matchgroup ID */
4775 struct pat_ptr *pp_next; /* pointer to next pat_ptr */
4776 } *(pat_ptrs[3]);
4777 /* patterns found in the line */
4778 struct pat_ptr *ppp;
4779 struct pat_ptr *ppp_next;
4780 int pat_count = 0; /* nr of syn_patterns found */
4781 int syn_id;
4782 int matchgroup_id = 0;
4783 int not_enough = FALSE; /* not enough arguments */
4784 int illegal = FALSE; /* illegal arguments */
4785 int success = FALSE;
4786 int idx;
4787 syn_opt_arg_T syn_opt_arg;
4789 /* Isolate the group name, check for validity */
4790 rest = get_group_name(arg, &group_name_end);
4792 pat_ptrs[0] = NULL;
4793 pat_ptrs[1] = NULL;
4794 pat_ptrs[2] = NULL;
4796 init_syn_patterns();
4798 syn_opt_arg.flags = 0;
4799 syn_opt_arg.keyword = FALSE;
4800 syn_opt_arg.sync_idx = NULL;
4801 syn_opt_arg.has_cont_list = TRUE;
4802 syn_opt_arg.cont_list = NULL;
4803 syn_opt_arg.cont_in_list = NULL;
4804 syn_opt_arg.next_list = NULL;
4807 * get the options, patterns and matchgroup.
4809 while (rest != NULL && !ends_excmd(*rest))
4811 /* Check for option arguments */
4812 rest = get_syn_options(rest, &syn_opt_arg);
4813 if (rest == NULL || ends_excmd(*rest))
4814 break;
4816 /* must be a pattern or matchgroup then */
4817 key_end = rest;
4818 while (*key_end && !vim_iswhite(*key_end) && *key_end != '=')
4819 ++key_end;
4820 vim_free(key);
4821 key = vim_strnsave_up(rest, (int)(key_end - rest));
4822 if (key == NULL) /* out of memory */
4824 rest = NULL;
4825 break;
4827 if (STRCMP(key, "MATCHGROUP") == 0)
4828 item = ITEM_MATCHGROUP;
4829 else if (STRCMP(key, "START") == 0)
4830 item = ITEM_START;
4831 else if (STRCMP(key, "END") == 0)
4832 item = ITEM_END;
4833 else if (STRCMP(key, "SKIP") == 0)
4835 if (pat_ptrs[ITEM_SKIP] != NULL) /* one skip pattern allowed */
4837 illegal = TRUE;
4838 break;
4840 item = ITEM_SKIP;
4842 else
4843 break;
4844 rest = skipwhite(key_end);
4845 if (*rest != '=')
4847 rest = NULL;
4848 EMSG2(_("E398: Missing '=': %s"), arg);
4849 break;
4851 rest = skipwhite(rest + 1);
4852 if (*rest == NUL)
4854 not_enough = TRUE;
4855 break;
4858 if (item == ITEM_MATCHGROUP)
4860 p = skiptowhite(rest);
4861 if ((p - rest == 4 && STRNCMP(rest, "NONE", 4) == 0) || eap->skip)
4862 matchgroup_id = 0;
4863 else
4865 matchgroup_id = syn_check_group(rest, (int)(p - rest));
4866 if (matchgroup_id == 0)
4868 illegal = TRUE;
4869 break;
4872 rest = skipwhite(p);
4874 else
4877 * Allocate room for a syn_pattern, and link it in the list of
4878 * syn_patterns for this item, at the start (because the list is
4879 * used from end to start).
4881 ppp = (struct pat_ptr *)alloc((unsigned)sizeof(struct pat_ptr));
4882 if (ppp == NULL)
4884 rest = NULL;
4885 break;
4887 ppp->pp_next = pat_ptrs[item];
4888 pat_ptrs[item] = ppp;
4889 ppp->pp_synp = (synpat_T *)alloc_clear((unsigned)sizeof(synpat_T));
4890 if (ppp->pp_synp == NULL)
4892 rest = NULL;
4893 break;
4897 * Get the syntax pattern and the following offset(s).
4899 /* Enable the appropriate \z specials. */
4900 if (item == ITEM_START)
4901 reg_do_extmatch = REX_SET;
4902 else if (item == ITEM_SKIP || item == ITEM_END)
4903 reg_do_extmatch = REX_USE;
4904 rest = get_syn_pattern(rest, ppp->pp_synp);
4905 reg_do_extmatch = 0;
4906 if (item == ITEM_END && vim_regcomp_had_eol()
4907 && !(syn_opt_arg.flags & HL_EXCLUDENL))
4908 ppp->pp_synp->sp_flags |= HL_HAS_EOL;
4909 ppp->pp_matchgroup_id = matchgroup_id;
4910 ++pat_count;
4913 vim_free(key);
4914 if (illegal || not_enough)
4915 rest = NULL;
4918 * Must have a "start" and "end" pattern.
4920 if (rest != NULL && (pat_ptrs[ITEM_START] == NULL ||
4921 pat_ptrs[ITEM_END] == NULL))
4923 not_enough = TRUE;
4924 rest = NULL;
4927 if (rest != NULL)
4930 * Check for trailing garbage or command.
4931 * If OK, add the item.
4933 eap->nextcmd = check_nextcmd(rest);
4934 if (!ends_excmd(*rest) || eap->skip)
4935 rest = NULL;
4936 else if (ga_grow(&(curbuf->b_syn_patterns), pat_count) != FAIL
4937 && (syn_id = syn_check_group(arg,
4938 (int)(group_name_end - arg))) != 0)
4940 syn_incl_toplevel(syn_id, &syn_opt_arg.flags);
4942 * Store the start/skip/end in the syn_items list
4944 idx = curbuf->b_syn_patterns.ga_len;
4945 for (item = ITEM_START; item <= ITEM_END; ++item)
4947 for (ppp = pat_ptrs[item]; ppp != NULL; ppp = ppp->pp_next)
4949 SYN_ITEMS(curbuf)[idx] = *(ppp->pp_synp);
4950 SYN_ITEMS(curbuf)[idx].sp_syncing = syncing;
4951 SYN_ITEMS(curbuf)[idx].sp_type =
4952 (item == ITEM_START) ? SPTYPE_START :
4953 (item == ITEM_SKIP) ? SPTYPE_SKIP : SPTYPE_END;
4954 SYN_ITEMS(curbuf)[idx].sp_flags |= syn_opt_arg.flags;
4955 SYN_ITEMS(curbuf)[idx].sp_syn.id = syn_id;
4956 SYN_ITEMS(curbuf)[idx].sp_syn.inc_tag = current_syn_inc_tag;
4957 SYN_ITEMS(curbuf)[idx].sp_syn_match_id =
4958 ppp->pp_matchgroup_id;
4959 if (item == ITEM_START)
4961 SYN_ITEMS(curbuf)[idx].sp_cont_list =
4962 syn_opt_arg.cont_list;
4963 SYN_ITEMS(curbuf)[idx].sp_syn.cont_in_list =
4964 syn_opt_arg.cont_in_list;
4965 if (syn_opt_arg.cont_in_list != NULL)
4966 curbuf->b_syn_containedin = TRUE;
4967 SYN_ITEMS(curbuf)[idx].sp_next_list =
4968 syn_opt_arg.next_list;
4970 ++curbuf->b_syn_patterns.ga_len;
4971 ++idx;
4972 #ifdef FEAT_FOLDING
4973 if (syn_opt_arg.flags & HL_FOLD)
4974 ++curbuf->b_syn_folditems;
4975 #endif
4979 redraw_curbuf_later(SOME_VALID);
4980 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
4981 success = TRUE; /* don't free the progs and patterns now */
4986 * Free the allocated memory.
4988 for (item = ITEM_START; item <= ITEM_END; ++item)
4989 for (ppp = pat_ptrs[item]; ppp != NULL; ppp = ppp_next)
4991 if (!success)
4993 vim_free(ppp->pp_synp->sp_prog);
4994 vim_free(ppp->pp_synp->sp_pattern);
4996 vim_free(ppp->pp_synp);
4997 ppp_next = ppp->pp_next;
4998 vim_free(ppp);
5001 if (!success)
5003 vim_free(syn_opt_arg.cont_list);
5004 vim_free(syn_opt_arg.cont_in_list);
5005 vim_free(syn_opt_arg.next_list);
5006 if (not_enough)
5007 EMSG2(_("E399: Not enough arguments: syntax region %s"), arg);
5008 else if (illegal || rest == NULL)
5009 EMSG2(_(e_invarg2), arg);
5014 * A simple syntax group ID comparison function suitable for use in qsort()
5016 static int
5017 #ifdef __BORLANDC__
5018 _RTLENTRYF
5019 #endif
5020 syn_compare_stub(v1, v2)
5021 const void *v1;
5022 const void *v2;
5024 const short *s1 = v1;
5025 const short *s2 = v2;
5027 return (*s1 > *s2 ? 1 : *s1 < *s2 ? -1 : 0);
5031 * Combines lists of syntax clusters.
5032 * *clstr1 and *clstr2 must both be allocated memory; they will be consumed.
5034 static void
5035 syn_combine_list(clstr1, clstr2, list_op)
5036 short **clstr1;
5037 short **clstr2;
5038 int list_op;
5040 int count1 = 0;
5041 int count2 = 0;
5042 short *g1;
5043 short *g2;
5044 short *clstr = NULL;
5045 int count;
5046 int round;
5049 * Handle degenerate cases.
5051 if (*clstr2 == NULL)
5052 return;
5053 if (*clstr1 == NULL || list_op == CLUSTER_REPLACE)
5055 if (list_op == CLUSTER_REPLACE)
5056 vim_free(*clstr1);
5057 if (list_op == CLUSTER_REPLACE || list_op == CLUSTER_ADD)
5058 *clstr1 = *clstr2;
5059 else
5060 vim_free(*clstr2);
5061 return;
5064 for (g1 = *clstr1; *g1; g1++)
5065 ++count1;
5066 for (g2 = *clstr2; *g2; g2++)
5067 ++count2;
5070 * For speed purposes, sort both lists.
5072 qsort(*clstr1, (size_t)count1, sizeof(short), syn_compare_stub);
5073 qsort(*clstr2, (size_t)count2, sizeof(short), syn_compare_stub);
5076 * We proceed in two passes; in round 1, we count the elements to place
5077 * in the new list, and in round 2, we allocate and populate the new
5078 * list. For speed, we use a mergesort-like method, adding the smaller
5079 * of the current elements in each list to the new list.
5081 for (round = 1; round <= 2; round++)
5083 g1 = *clstr1;
5084 g2 = *clstr2;
5085 count = 0;
5088 * First, loop through the lists until one of them is empty.
5090 while (*g1 && *g2)
5093 * We always want to add from the first list.
5095 if (*g1 < *g2)
5097 if (round == 2)
5098 clstr[count] = *g1;
5099 count++;
5100 g1++;
5101 continue;
5104 * We only want to add from the second list if we're adding the
5105 * lists.
5107 if (list_op == CLUSTER_ADD)
5109 if (round == 2)
5110 clstr[count] = *g2;
5111 count++;
5113 if (*g1 == *g2)
5114 g1++;
5115 g2++;
5119 * Now add the leftovers from whichever list didn't get finished
5120 * first. As before, we only want to add from the second list if
5121 * we're adding the lists.
5123 for (; *g1; g1++, count++)
5124 if (round == 2)
5125 clstr[count] = *g1;
5126 if (list_op == CLUSTER_ADD)
5127 for (; *g2; g2++, count++)
5128 if (round == 2)
5129 clstr[count] = *g2;
5131 if (round == 1)
5134 * If the group ended up empty, we don't need to allocate any
5135 * space for it.
5137 if (count == 0)
5139 clstr = NULL;
5140 break;
5142 clstr = (short *)alloc((unsigned)((count + 1) * sizeof(short)));
5143 if (clstr == NULL)
5144 break;
5145 clstr[count] = 0;
5150 * Finally, put the new list in place.
5152 vim_free(*clstr1);
5153 vim_free(*clstr2);
5154 *clstr1 = clstr;
5158 * Lookup a syntax cluster name and return it's ID.
5159 * If it is not found, 0 is returned.
5161 static int
5162 syn_scl_name2id(name)
5163 char_u *name;
5165 int i;
5166 char_u *name_u;
5168 /* Avoid using stricmp() too much, it's slow on some systems */
5169 name_u = vim_strsave_up(name);
5170 if (name_u == NULL)
5171 return 0;
5172 for (i = curbuf->b_syn_clusters.ga_len; --i >= 0; )
5173 if (SYN_CLSTR(curbuf)[i].scl_name_u != NULL
5174 && STRCMP(name_u, SYN_CLSTR(curbuf)[i].scl_name_u) == 0)
5175 break;
5176 vim_free(name_u);
5177 return (i < 0 ? 0 : i + SYNID_CLUSTER);
5181 * Like syn_scl_name2id(), but take a pointer + length argument.
5183 static int
5184 syn_scl_namen2id(linep, len)
5185 char_u *linep;
5186 int len;
5188 char_u *name;
5189 int id = 0;
5191 name = vim_strnsave(linep, len);
5192 if (name != NULL)
5194 id = syn_scl_name2id(name);
5195 vim_free(name);
5197 return id;
5201 * Find syntax cluster name in the table and return it's ID.
5202 * The argument is a pointer to the name and the length of the name.
5203 * If it doesn't exist yet, a new entry is created.
5204 * Return 0 for failure.
5206 static int
5207 syn_check_cluster(pp, len)
5208 char_u *pp;
5209 int len;
5211 int id;
5212 char_u *name;
5214 name = vim_strnsave(pp, len);
5215 if (name == NULL)
5216 return 0;
5218 id = syn_scl_name2id(name);
5219 if (id == 0) /* doesn't exist yet */
5220 id = syn_add_cluster(name);
5221 else
5222 vim_free(name);
5223 return id;
5227 * Add new syntax cluster and return it's ID.
5228 * "name" must be an allocated string, it will be consumed.
5229 * Return 0 for failure.
5231 static int
5232 syn_add_cluster(name)
5233 char_u *name;
5235 int len;
5238 * First call for this growarray: init growing array.
5240 if (curbuf->b_syn_clusters.ga_data == NULL)
5242 curbuf->b_syn_clusters.ga_itemsize = sizeof(syn_cluster_T);
5243 curbuf->b_syn_clusters.ga_growsize = 10;
5247 * Make room for at least one other cluster entry.
5249 if (ga_grow(&curbuf->b_syn_clusters, 1) == FAIL)
5251 vim_free(name);
5252 return 0;
5254 len = curbuf->b_syn_clusters.ga_len;
5256 vim_memset(&(SYN_CLSTR(curbuf)[len]), 0, sizeof(syn_cluster_T));
5257 SYN_CLSTR(curbuf)[len].scl_name = name;
5258 SYN_CLSTR(curbuf)[len].scl_name_u = vim_strsave_up(name);
5259 SYN_CLSTR(curbuf)[len].scl_list = NULL;
5260 ++curbuf->b_syn_clusters.ga_len;
5262 if (STRICMP(name, "Spell") == 0)
5263 curbuf->b_spell_cluster_id = len + SYNID_CLUSTER;
5264 if (STRICMP(name, "NoSpell") == 0)
5265 curbuf->b_nospell_cluster_id = len + SYNID_CLUSTER;
5267 return len + SYNID_CLUSTER;
5271 * Handle ":syntax cluster {cluster-name} [contains={groupname},..]
5272 * [add={groupname},..] [remove={groupname},..]".
5274 static void
5275 syn_cmd_cluster(eap, syncing)
5276 exarg_T *eap;
5277 int syncing UNUSED;
5279 char_u *arg = eap->arg;
5280 char_u *group_name_end;
5281 char_u *rest;
5282 int scl_id;
5283 short *clstr_list;
5284 int got_clstr = FALSE;
5285 int opt_len;
5286 int list_op;
5288 eap->nextcmd = find_nextcmd(arg);
5289 if (eap->skip)
5290 return;
5292 rest = get_group_name(arg, &group_name_end);
5294 if (rest != NULL)
5296 scl_id = syn_check_cluster(arg, (int)(group_name_end - arg))
5297 - SYNID_CLUSTER;
5299 for (;;)
5301 if (STRNICMP(rest, "add", 3) == 0
5302 && (vim_iswhite(rest[3]) || rest[3] == '='))
5304 opt_len = 3;
5305 list_op = CLUSTER_ADD;
5307 else if (STRNICMP(rest, "remove", 6) == 0
5308 && (vim_iswhite(rest[6]) || rest[6] == '='))
5310 opt_len = 6;
5311 list_op = CLUSTER_SUBTRACT;
5313 else if (STRNICMP(rest, "contains", 8) == 0
5314 && (vim_iswhite(rest[8]) || rest[8] == '='))
5316 opt_len = 8;
5317 list_op = CLUSTER_REPLACE;
5319 else
5320 break;
5322 clstr_list = NULL;
5323 if (get_id_list(&rest, opt_len, &clstr_list) == FAIL)
5325 EMSG2(_(e_invarg2), rest);
5326 break;
5328 syn_combine_list(&SYN_CLSTR(curbuf)[scl_id].scl_list,
5329 &clstr_list, list_op);
5330 got_clstr = TRUE;
5333 if (got_clstr)
5335 redraw_curbuf_later(SOME_VALID);
5336 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
5340 if (!got_clstr)
5341 EMSG(_("E400: No cluster specified"));
5342 if (rest == NULL || !ends_excmd(*rest))
5343 EMSG2(_(e_invarg2), arg);
5347 * On first call for current buffer: Init growing array.
5349 static void
5350 init_syn_patterns()
5352 curbuf->b_syn_patterns.ga_itemsize = sizeof(synpat_T);
5353 curbuf->b_syn_patterns.ga_growsize = 10;
5357 * Get one pattern for a ":syntax match" or ":syntax region" command.
5358 * Stores the pattern and program in a synpat_T.
5359 * Returns a pointer to the next argument, or NULL in case of an error.
5361 static char_u *
5362 get_syn_pattern(arg, ci)
5363 char_u *arg;
5364 synpat_T *ci;
5366 char_u *end;
5367 int *p;
5368 int idx;
5369 char_u *cpo_save;
5371 /* need at least three chars */
5372 if (arg == NULL || arg[1] == NUL || arg[2] == NUL)
5373 return NULL;
5375 end = skip_regexp(arg + 1, *arg, TRUE, NULL);
5376 if (*end != *arg) /* end delimiter not found */
5378 EMSG2(_("E401: Pattern delimiter not found: %s"), arg);
5379 return NULL;
5381 /* store the pattern and compiled regexp program */
5382 if ((ci->sp_pattern = vim_strnsave(arg + 1, (int)(end - arg - 1))) == NULL)
5383 return NULL;
5385 /* Make 'cpoptions' empty, to avoid the 'l' flag */
5386 cpo_save = p_cpo;
5387 p_cpo = (char_u *)"";
5388 ci->sp_prog = vim_regcomp(ci->sp_pattern, RE_MAGIC);
5389 p_cpo = cpo_save;
5391 if (ci->sp_prog == NULL)
5392 return NULL;
5393 ci->sp_ic = curbuf->b_syn_ic;
5396 * Check for a match, highlight or region offset.
5398 ++end;
5401 for (idx = SPO_COUNT; --idx >= 0; )
5402 if (STRNCMP(end, spo_name_tab[idx], 3) == 0)
5403 break;
5404 if (idx >= 0)
5406 p = &(ci->sp_offsets[idx]);
5407 if (idx != SPO_LC_OFF)
5408 switch (end[3])
5410 case 's': break;
5411 case 'b': break;
5412 case 'e': idx += SPO_COUNT; break;
5413 default: idx = -1; break;
5415 if (idx >= 0)
5417 ci->sp_off_flags |= (1 << idx);
5418 if (idx == SPO_LC_OFF) /* lc=99 */
5420 end += 3;
5421 *p = getdigits(&end);
5423 /* "lc=" offset automatically sets "ms=" offset */
5424 if (!(ci->sp_off_flags & (1 << SPO_MS_OFF)))
5426 ci->sp_off_flags |= (1 << SPO_MS_OFF);
5427 ci->sp_offsets[SPO_MS_OFF] = *p;
5430 else /* yy=x+99 */
5432 end += 4;
5433 if (*end == '+')
5435 ++end;
5436 *p = getdigits(&end); /* positive offset */
5438 else if (*end == '-')
5440 ++end;
5441 *p = -getdigits(&end); /* negative offset */
5444 if (*end != ',')
5445 break;
5446 ++end;
5449 } while (idx >= 0);
5451 if (!ends_excmd(*end) && !vim_iswhite(*end))
5453 EMSG2(_("E402: Garbage after pattern: %s"), arg);
5454 return NULL;
5456 return skipwhite(end);
5460 * Handle ":syntax sync .." command.
5462 static void
5463 syn_cmd_sync(eap, syncing)
5464 exarg_T *eap;
5465 int syncing UNUSED;
5467 char_u *arg_start = eap->arg;
5468 char_u *arg_end;
5469 char_u *key = NULL;
5470 char_u *next_arg;
5471 int illegal = FALSE;
5472 int finished = FALSE;
5473 long n;
5474 char_u *cpo_save;
5476 if (ends_excmd(*arg_start))
5478 syn_cmd_list(eap, TRUE);
5479 return;
5482 while (!ends_excmd(*arg_start))
5484 arg_end = skiptowhite(arg_start);
5485 next_arg = skipwhite(arg_end);
5486 vim_free(key);
5487 key = vim_strnsave_up(arg_start, (int)(arg_end - arg_start));
5488 if (STRCMP(key, "CCOMMENT") == 0)
5490 if (!eap->skip)
5491 curbuf->b_syn_sync_flags |= SF_CCOMMENT;
5492 if (!ends_excmd(*next_arg))
5494 arg_end = skiptowhite(next_arg);
5495 if (!eap->skip)
5496 curbuf->b_syn_sync_id = syn_check_group(next_arg,
5497 (int)(arg_end - next_arg));
5498 next_arg = skipwhite(arg_end);
5500 else if (!eap->skip)
5501 curbuf->b_syn_sync_id = syn_name2id((char_u *)"Comment");
5503 else if ( STRNCMP(key, "LINES", 5) == 0
5504 || STRNCMP(key, "MINLINES", 8) == 0
5505 || STRNCMP(key, "MAXLINES", 8) == 0
5506 || STRNCMP(key, "LINEBREAKS", 10) == 0)
5508 if (key[4] == 'S')
5509 arg_end = key + 6;
5510 else if (key[0] == 'L')
5511 arg_end = key + 11;
5512 else
5513 arg_end = key + 9;
5514 if (arg_end[-1] != '=' || !VIM_ISDIGIT(*arg_end))
5516 illegal = TRUE;
5517 break;
5519 n = getdigits(&arg_end);
5520 if (!eap->skip)
5522 if (key[4] == 'B')
5523 curbuf->b_syn_sync_linebreaks = n;
5524 else if (key[1] == 'A')
5525 curbuf->b_syn_sync_maxlines = n;
5526 else
5527 curbuf->b_syn_sync_minlines = n;
5530 else if (STRCMP(key, "FROMSTART") == 0)
5532 if (!eap->skip)
5534 curbuf->b_syn_sync_minlines = MAXLNUM;
5535 curbuf->b_syn_sync_maxlines = 0;
5538 else if (STRCMP(key, "LINECONT") == 0)
5540 if (curbuf->b_syn_linecont_pat != NULL)
5542 EMSG(_("E403: syntax sync: line continuations pattern specified twice"));
5543 finished = TRUE;
5544 break;
5546 arg_end = skip_regexp(next_arg + 1, *next_arg, TRUE, NULL);
5547 if (*arg_end != *next_arg) /* end delimiter not found */
5549 illegal = TRUE;
5550 break;
5553 if (!eap->skip)
5555 /* store the pattern and compiled regexp program */
5556 if ((curbuf->b_syn_linecont_pat = vim_strnsave(next_arg + 1,
5557 (int)(arg_end - next_arg - 1))) == NULL)
5559 finished = TRUE;
5560 break;
5562 curbuf->b_syn_linecont_ic = curbuf->b_syn_ic;
5564 /* Make 'cpoptions' empty, to avoid the 'l' flag */
5565 cpo_save = p_cpo;
5566 p_cpo = (char_u *)"";
5567 curbuf->b_syn_linecont_prog =
5568 vim_regcomp(curbuf->b_syn_linecont_pat, RE_MAGIC);
5569 p_cpo = cpo_save;
5571 if (curbuf->b_syn_linecont_prog == NULL)
5573 vim_free(curbuf->b_syn_linecont_pat);
5574 curbuf->b_syn_linecont_pat = NULL;
5575 finished = TRUE;
5576 break;
5579 next_arg = skipwhite(arg_end + 1);
5581 else
5583 eap->arg = next_arg;
5584 if (STRCMP(key, "MATCH") == 0)
5585 syn_cmd_match(eap, TRUE);
5586 else if (STRCMP(key, "REGION") == 0)
5587 syn_cmd_region(eap, TRUE);
5588 else if (STRCMP(key, "CLEAR") == 0)
5589 syn_cmd_clear(eap, TRUE);
5590 else
5591 illegal = TRUE;
5592 finished = TRUE;
5593 break;
5595 arg_start = next_arg;
5597 vim_free(key);
5598 if (illegal)
5599 EMSG2(_("E404: Illegal arguments: %s"), arg_start);
5600 else if (!finished)
5602 eap->nextcmd = check_nextcmd(arg_start);
5603 redraw_curbuf_later(SOME_VALID);
5604 syn_stack_free_all(curbuf); /* Need to recompute all syntax. */
5609 * Convert a line of highlight group names into a list of group ID numbers.
5610 * "arg" should point to the "contains" or "nextgroup" keyword.
5611 * "arg" is advanced to after the last group name.
5612 * Careful: the argument is modified (NULs added).
5613 * returns FAIL for some error, OK for success.
5615 static int
5616 get_id_list(arg, keylen, list)
5617 char_u **arg;
5618 int keylen; /* length of keyword */
5619 short **list; /* where to store the resulting list, if not
5620 NULL, the list is silently skipped! */
5622 char_u *p = NULL;
5623 char_u *end;
5624 int round;
5625 int count;
5626 int total_count = 0;
5627 short *retval = NULL;
5628 char_u *name;
5629 regmatch_T regmatch;
5630 int id;
5631 int i;
5632 int failed = FALSE;
5635 * We parse the list twice:
5636 * round == 1: count the number of items, allocate the array.
5637 * round == 2: fill the array with the items.
5638 * In round 1 new groups may be added, causing the number of items to
5639 * grow when a regexp is used. In that case round 1 is done once again.
5641 for (round = 1; round <= 2; ++round)
5644 * skip "contains"
5646 p = skipwhite(*arg + keylen);
5647 if (*p != '=')
5649 EMSG2(_("E405: Missing equal sign: %s"), *arg);
5650 break;
5652 p = skipwhite(p + 1);
5653 if (ends_excmd(*p))
5655 EMSG2(_("E406: Empty argument: %s"), *arg);
5656 break;
5660 * parse the arguments after "contains"
5662 count = 0;
5663 while (!ends_excmd(*p))
5665 for (end = p; *end && !vim_iswhite(*end) && *end != ','; ++end)
5667 name = alloc((int)(end - p + 3)); /* leave room for "^$" */
5668 if (name == NULL)
5670 failed = TRUE;
5671 break;
5673 vim_strncpy(name + 1, p, end - p);
5674 if ( STRCMP(name + 1, "ALLBUT") == 0
5675 || STRCMP(name + 1, "ALL") == 0
5676 || STRCMP(name + 1, "TOP") == 0
5677 || STRCMP(name + 1, "CONTAINED") == 0)
5679 if (TOUPPER_ASC(**arg) != 'C')
5681 EMSG2(_("E407: %s not allowed here"), name + 1);
5682 failed = TRUE;
5683 vim_free(name);
5684 break;
5686 if (count != 0)
5688 EMSG2(_("E408: %s must be first in contains list"), name + 1);
5689 failed = TRUE;
5690 vim_free(name);
5691 break;
5693 if (name[1] == 'A')
5694 id = SYNID_ALLBUT;
5695 else if (name[1] == 'T')
5696 id = SYNID_TOP;
5697 else
5698 id = SYNID_CONTAINED;
5699 id += current_syn_inc_tag;
5701 else if (name[1] == '@')
5703 id = syn_check_cluster(name + 2, (int)(end - p - 1));
5705 else
5708 * Handle full group name.
5710 if (vim_strpbrk(name + 1, (char_u *)"\\.*^$~[") == NULL)
5711 id = syn_check_group(name + 1, (int)(end - p));
5712 else
5715 * Handle match of regexp with group names.
5717 *name = '^';
5718 STRCAT(name, "$");
5719 regmatch.regprog = vim_regcomp(name, RE_MAGIC);
5720 if (regmatch.regprog == NULL)
5722 failed = TRUE;
5723 vim_free(name);
5724 break;
5727 regmatch.rm_ic = TRUE;
5728 id = 0;
5729 for (i = highlight_ga.ga_len; --i >= 0; )
5731 if (vim_regexec(&regmatch, HL_TABLE()[i].sg_name,
5732 (colnr_T)0))
5734 if (round == 2)
5736 /* Got more items than expected; can happen
5737 * when adding items that match:
5738 * "contains=a.*b,axb".
5739 * Go back to first round */
5740 if (count >= total_count)
5742 vim_free(retval);
5743 round = 1;
5745 else
5746 retval[count] = i + 1;
5748 ++count;
5749 id = -1; /* remember that we found one */
5752 vim_free(regmatch.regprog);
5755 vim_free(name);
5756 if (id == 0)
5758 EMSG2(_("E409: Unknown group name: %s"), p);
5759 failed = TRUE;
5760 break;
5762 if (id > 0)
5764 if (round == 2)
5766 /* Got more items than expected, go back to first round */
5767 if (count >= total_count)
5769 vim_free(retval);
5770 round = 1;
5772 else
5773 retval[count] = id;
5775 ++count;
5777 p = skipwhite(end);
5778 if (*p != ',')
5779 break;
5780 p = skipwhite(p + 1); /* skip comma in between arguments */
5782 if (failed)
5783 break;
5784 if (round == 1)
5786 retval = (short *)alloc((unsigned)((count + 1) * sizeof(short)));
5787 if (retval == NULL)
5788 break;
5789 retval[count] = 0; /* zero means end of the list */
5790 total_count = count;
5794 *arg = p;
5795 if (failed || retval == NULL)
5797 vim_free(retval);
5798 return FAIL;
5801 if (*list == NULL)
5802 *list = retval;
5803 else
5804 vim_free(retval); /* list already found, don't overwrite it */
5806 return OK;
5810 * Make a copy of an ID list.
5812 static short *
5813 copy_id_list(list)
5814 short *list;
5816 int len;
5817 int count;
5818 short *retval;
5820 if (list == NULL)
5821 return NULL;
5823 for (count = 0; list[count]; ++count)
5825 len = (count + 1) * sizeof(short);
5826 retval = (short *)alloc((unsigned)len);
5827 if (retval != NULL)
5828 mch_memmove(retval, list, (size_t)len);
5830 return retval;
5834 * Check if syntax group "ssp" is in the ID list "list" of "cur_si".
5835 * "cur_si" can be NULL if not checking the "containedin" list.
5836 * Used to check if a syntax item is in the "contains" or "nextgroup" list of
5837 * the current item.
5838 * This function is called very often, keep it fast!!
5840 static int
5841 in_id_list(cur_si, list, ssp, contained)
5842 stateitem_T *cur_si; /* current item or NULL */
5843 short *list; /* id list */
5844 struct sp_syn *ssp; /* group id and ":syn include" tag of group */
5845 int contained; /* group id is contained */
5847 int retval;
5848 short *scl_list;
5849 short item;
5850 short id = ssp->id;
5851 static int depth = 0;
5852 int r;
5854 /* If spp has a "containedin" list and "cur_si" is in it, return TRUE. */
5855 if (cur_si != NULL && ssp->cont_in_list != NULL
5856 && !(cur_si->si_flags & HL_MATCH))
5858 /* Ignore transparent items without a contains argument. Double check
5859 * that we don't go back past the first one. */
5860 while ((cur_si->si_flags & HL_TRANS_CONT)
5861 && cur_si > (stateitem_T *)(current_state.ga_data))
5862 --cur_si;
5863 /* cur_si->si_idx is -1 for keywords, these never contain anything. */
5864 if (cur_si->si_idx >= 0 && in_id_list(NULL, ssp->cont_in_list,
5865 &(SYN_ITEMS(syn_buf)[cur_si->si_idx].sp_syn),
5866 SYN_ITEMS(syn_buf)[cur_si->si_idx].sp_flags & HL_CONTAINED))
5867 return TRUE;
5870 if (list == NULL)
5871 return FALSE;
5874 * If list is ID_LIST_ALL, we are in a transparent item that isn't
5875 * inside anything. Only allow not-contained groups.
5877 if (list == ID_LIST_ALL)
5878 return !contained;
5881 * If the first item is "ALLBUT", return TRUE if "id" is NOT in the
5882 * contains list. We also require that "id" is at the same ":syn include"
5883 * level as the list.
5885 item = *list;
5886 if (item >= SYNID_ALLBUT && item < SYNID_CLUSTER)
5888 if (item < SYNID_TOP)
5890 /* ALL or ALLBUT: accept all groups in the same file */
5891 if (item - SYNID_ALLBUT != ssp->inc_tag)
5892 return FALSE;
5894 else if (item < SYNID_CONTAINED)
5896 /* TOP: accept all not-contained groups in the same file */
5897 if (item - SYNID_TOP != ssp->inc_tag || contained)
5898 return FALSE;
5900 else
5902 /* CONTAINED: accept all contained groups in the same file */
5903 if (item - SYNID_CONTAINED != ssp->inc_tag || !contained)
5904 return FALSE;
5906 item = *++list;
5907 retval = FALSE;
5909 else
5910 retval = TRUE;
5913 * Return "retval" if id is in the contains list.
5915 while (item != 0)
5917 if (item == id)
5918 return retval;
5919 if (item >= SYNID_CLUSTER)
5921 scl_list = SYN_CLSTR(syn_buf)[item - SYNID_CLUSTER].scl_list;
5922 /* restrict recursiveness to 30 to avoid an endless loop for a
5923 * cluster that includes itself (indirectly) */
5924 if (scl_list != NULL && depth < 30)
5926 ++depth;
5927 r = in_id_list(NULL, scl_list, ssp, contained);
5928 --depth;
5929 if (r)
5930 return retval;
5933 item = *++list;
5935 return !retval;
5938 struct subcommand
5940 char *name; /* subcommand name */
5941 void (*func)__ARGS((exarg_T *, int)); /* function to call */
5944 static struct subcommand subcommands[] =
5946 {"case", syn_cmd_case},
5947 {"clear", syn_cmd_clear},
5948 {"cluster", syn_cmd_cluster},
5949 {"enable", syn_cmd_enable},
5950 {"include", syn_cmd_include},
5951 {"keyword", syn_cmd_keyword},
5952 {"list", syn_cmd_list},
5953 {"manual", syn_cmd_manual},
5954 {"match", syn_cmd_match},
5955 {"on", syn_cmd_on},
5956 {"off", syn_cmd_off},
5957 {"region", syn_cmd_region},
5958 {"reset", syn_cmd_reset},
5959 {"spell", syn_cmd_spell},
5960 {"sync", syn_cmd_sync},
5961 {"", syn_cmd_list},
5962 {NULL, NULL}
5966 * ":syntax".
5967 * This searches the subcommands[] table for the subcommand name, and calls a
5968 * syntax_subcommand() function to do the rest.
5970 void
5971 ex_syntax(eap)
5972 exarg_T *eap;
5974 char_u *arg = eap->arg;
5975 char_u *subcmd_end;
5976 char_u *subcmd_name;
5977 int i;
5979 syn_cmdlinep = eap->cmdlinep;
5981 /* isolate subcommand name */
5982 for (subcmd_end = arg; ASCII_ISALPHA(*subcmd_end); ++subcmd_end)
5984 subcmd_name = vim_strnsave(arg, (int)(subcmd_end - arg));
5985 if (subcmd_name != NULL)
5987 if (eap->skip) /* skip error messages for all subcommands */
5988 ++emsg_skip;
5989 for (i = 0; ; ++i)
5991 if (subcommands[i].name == NULL)
5993 EMSG2(_("E410: Invalid :syntax subcommand: %s"), subcmd_name);
5994 break;
5996 if (STRCMP(subcmd_name, (char_u *)subcommands[i].name) == 0)
5998 eap->arg = skipwhite(subcmd_end);
5999 (subcommands[i].func)(eap, FALSE);
6000 break;
6003 vim_free(subcmd_name);
6004 if (eap->skip)
6005 --emsg_skip;
6010 syntax_present(buf)
6011 buf_T *buf;
6013 return (buf->b_syn_patterns.ga_len != 0
6014 || buf->b_syn_clusters.ga_len != 0
6015 || buf->b_keywtab.ht_used > 0
6016 || buf->b_keywtab_ic.ht_used > 0);
6019 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
6021 static enum
6023 EXP_SUBCMD, /* expand ":syn" sub-commands */
6024 EXP_CASE /* expand ":syn case" arguments */
6025 } expand_what;
6028 * Reset include_link, include_default, include_none to 0.
6029 * Called when we are done expanding.
6031 void
6032 reset_expand_highlight()
6034 include_link = include_default = include_none = 0;
6038 * Handle command line completion for :match and :echohl command: Add "None"
6039 * as highlight group.
6041 void
6042 set_context_in_echohl_cmd(xp, arg)
6043 expand_T *xp;
6044 char_u *arg;
6046 xp->xp_context = EXPAND_HIGHLIGHT;
6047 xp->xp_pattern = arg;
6048 include_none = 1;
6052 * Handle command line completion for :syntax command.
6054 void
6055 set_context_in_syntax_cmd(xp, arg)
6056 expand_T *xp;
6057 char_u *arg;
6059 char_u *p;
6061 /* Default: expand subcommands */
6062 xp->xp_context = EXPAND_SYNTAX;
6063 expand_what = EXP_SUBCMD;
6064 xp->xp_pattern = arg;
6065 include_link = 0;
6066 include_default = 0;
6068 /* (part of) subcommand already typed */
6069 if (*arg != NUL)
6071 p = skiptowhite(arg);
6072 if (*p != NUL) /* past first word */
6074 xp->xp_pattern = skipwhite(p);
6075 if (*skiptowhite(xp->xp_pattern) != NUL)
6076 xp->xp_context = EXPAND_NOTHING;
6077 else if (STRNICMP(arg, "case", p - arg) == 0)
6078 expand_what = EXP_CASE;
6079 else if ( STRNICMP(arg, "keyword", p - arg) == 0
6080 || STRNICMP(arg, "region", p - arg) == 0
6081 || STRNICMP(arg, "match", p - arg) == 0
6082 || STRNICMP(arg, "list", p - arg) == 0)
6083 xp->xp_context = EXPAND_HIGHLIGHT;
6084 else
6085 xp->xp_context = EXPAND_NOTHING;
6090 static char *(case_args[]) = {"match", "ignore", NULL};
6093 * Function given to ExpandGeneric() to obtain the list syntax names for
6094 * expansion.
6096 char_u *
6097 get_syntax_name(xp, idx)
6098 expand_T *xp UNUSED;
6099 int idx;
6101 if (expand_what == EXP_SUBCMD)
6102 return (char_u *)subcommands[idx].name;
6103 return (char_u *)case_args[idx];
6106 #endif /* FEAT_CMDL_COMPL */
6109 * Function called for expression evaluation: get syntax ID at file position.
6112 syn_get_id(wp, lnum, col, trans, spellp, keep_state)
6113 win_T *wp;
6114 long lnum;
6115 colnr_T col;
6116 int trans; /* remove transparency */
6117 int *spellp; /* return: can do spell checking */
6118 int keep_state; /* keep state of char at "col" */
6120 /* When the position is not after the current position and in the same
6121 * line of the same buffer, need to restart parsing. */
6122 if (wp->w_buffer != syn_buf
6123 || lnum != current_lnum
6124 || col < current_col)
6125 syntax_start(wp, lnum);
6127 (void)get_syntax_attr(col, spellp, keep_state);
6129 return (trans ? current_trans_id : current_id);
6132 #if defined(FEAT_EVAL) || defined(PROTO)
6134 * Return the syntax ID at position "i" in the current stack.
6135 * The caller must have called syn_get_id() before to fill the stack.
6136 * Returns -1 when "i" is out of range.
6139 syn_get_stack_item(i)
6140 int i;
6142 if (i >= current_state.ga_len)
6144 /* Need to invalidate the state, because we didn't properly finish it
6145 * for the last character, "keep_state" was TRUE. */
6146 invalidate_current_state();
6147 current_col = MAXCOL;
6148 return -1;
6150 return CUR_STATE(i).si_id;
6152 #endif
6154 #if defined(FEAT_FOLDING) || defined(PROTO)
6156 * Function called to get folding level for line "lnum" in window "wp".
6159 syn_get_foldlevel(wp, lnum)
6160 win_T *wp;
6161 long lnum;
6163 int level = 0;
6164 int i;
6166 /* Return quickly when there are no fold items at all. */
6167 if (wp->w_buffer->b_syn_folditems != 0)
6169 syntax_start(wp, lnum);
6171 for (i = 0; i < current_state.ga_len; ++i)
6172 if (CUR_STATE(i).si_flags & HL_FOLD)
6173 ++level;
6175 if (level > wp->w_p_fdn)
6177 level = wp->w_p_fdn;
6178 if (level < 0)
6179 level = 0;
6181 return level;
6183 #endif
6185 #endif /* FEAT_SYN_HL */
6188 /**************************************
6189 * Highlighting stuff *
6190 **************************************/
6193 * The default highlight groups. These are compiled-in for fast startup and
6194 * they still work when the runtime files can't be found.
6195 * When making changes here, also change runtime/colors/default.vim!
6196 * The #ifdefs are needed to reduce the amount of static data. Helps to make
6197 * the 16 bit DOS (museum) version compile.
6199 #ifdef FEAT_GUI
6200 # define CENT(a, b) b
6201 #else
6202 # define CENT(a, b) a
6203 #endif
6204 static char *(highlight_init_both[]) =
6206 CENT("ErrorMsg term=standout ctermbg=DarkRed ctermfg=White",
6207 "ErrorMsg term=standout ctermbg=DarkRed ctermfg=White guibg=Red guifg=White"),
6208 #ifdef FEAT_SEARCH_EXTRA
6209 CENT("IncSearch term=reverse cterm=reverse",
6210 "IncSearch term=reverse cterm=reverse gui=reverse"),
6211 #endif
6212 CENT("ModeMsg term=bold cterm=bold",
6213 "ModeMsg term=bold cterm=bold gui=bold"),
6214 CENT("NonText term=bold ctermfg=Blue",
6215 "NonText term=bold ctermfg=Blue gui=bold guifg=Blue"),
6216 CENT("StatusLine term=reverse,bold cterm=reverse,bold",
6217 "StatusLine term=reverse,bold cterm=reverse,bold gui=reverse,bold"),
6218 CENT("StatusLineNC term=reverse cterm=reverse",
6219 "StatusLineNC term=reverse cterm=reverse gui=reverse"),
6220 #ifdef FEAT_VERTSPLIT
6221 CENT("VertSplit term=reverse cterm=reverse",
6222 "VertSplit term=reverse cterm=reverse gui=reverse"),
6223 #endif
6224 #ifdef FEAT_CLIPBOARD
6225 CENT("VisualNOS term=underline,bold cterm=underline,bold",
6226 "VisualNOS term=underline,bold cterm=underline,bold gui=underline,bold"),
6227 #endif
6228 #ifdef FEAT_DIFF
6229 CENT("DiffText term=reverse cterm=bold ctermbg=Red",
6230 "DiffText term=reverse cterm=bold ctermbg=Red gui=bold guibg=Red"),
6231 #endif
6232 #ifdef FEAT_INS_EXPAND
6233 CENT("PmenuThumb cterm=reverse",
6234 "PmenuThumb cterm=reverse gui=reverse"),
6235 CENT("PmenuSbar ctermbg=Grey",
6236 "PmenuSbar ctermbg=Grey guibg=Grey"),
6237 #endif
6238 #ifdef FEAT_WINDOWS
6239 CENT("TabLineSel term=bold cterm=bold",
6240 "TabLineSel term=bold cterm=bold gui=bold"),
6241 CENT("TabLineFill term=reverse cterm=reverse",
6242 "TabLineFill term=reverse cterm=reverse gui=reverse"),
6243 #endif
6244 #ifdef FEAT_GUI
6245 "Cursor guibg=fg guifg=bg",
6246 "lCursor guibg=fg guifg=bg", /* should be different, but what? */
6247 #endif
6248 NULL
6251 static char *(highlight_init_light[]) =
6253 CENT("Directory term=bold ctermfg=DarkBlue",
6254 "Directory term=bold ctermfg=DarkBlue guifg=Blue"),
6255 CENT("LineNr term=underline ctermfg=Brown",
6256 "LineNr term=underline ctermfg=Brown guifg=Brown"),
6257 CENT("MoreMsg term=bold ctermfg=DarkGreen",
6258 "MoreMsg term=bold ctermfg=DarkGreen gui=bold guifg=SeaGreen"),
6259 CENT("Question term=standout ctermfg=DarkGreen",
6260 "Question term=standout ctermfg=DarkGreen gui=bold guifg=SeaGreen"),
6261 CENT("Search term=reverse ctermbg=Yellow ctermfg=NONE",
6262 "Search term=reverse ctermbg=Yellow ctermfg=NONE guibg=Yellow guifg=NONE"),
6263 #ifdef FEAT_SPELL
6264 CENT("SpellBad term=reverse ctermbg=LightRed",
6265 "SpellBad term=reverse ctermbg=LightRed guisp=Red gui=undercurl"),
6266 CENT("SpellCap term=reverse ctermbg=LightBlue",
6267 "SpellCap term=reverse ctermbg=LightBlue guisp=Blue gui=undercurl"),
6268 CENT("SpellRare term=reverse ctermbg=LightMagenta",
6269 "SpellRare term=reverse ctermbg=LightMagenta guisp=Magenta gui=undercurl"),
6270 CENT("SpellLocal term=underline ctermbg=Cyan",
6271 "SpellLocal term=underline ctermbg=Cyan guisp=DarkCyan gui=undercurl"),
6272 #endif
6273 #ifdef FEAT_INS_EXPAND
6274 CENT("Pmenu ctermbg=LightMagenta",
6275 "Pmenu ctermbg=LightMagenta guibg=LightMagenta"),
6276 CENT("PmenuSel ctermbg=LightGrey",
6277 "PmenuSel ctermbg=LightGrey guibg=Grey"),
6278 #endif
6279 CENT("SpecialKey term=bold ctermfg=DarkBlue",
6280 "SpecialKey term=bold ctermfg=DarkBlue guifg=Blue"),
6281 CENT("Title term=bold ctermfg=DarkMagenta",
6282 "Title term=bold ctermfg=DarkMagenta gui=bold guifg=Magenta"),
6283 CENT("WarningMsg term=standout ctermfg=DarkRed",
6284 "WarningMsg term=standout ctermfg=DarkRed guifg=Red"),
6285 #ifdef FEAT_WILDMENU
6286 CENT("WildMenu term=standout ctermbg=Yellow ctermfg=Black",
6287 "WildMenu term=standout ctermbg=Yellow ctermfg=Black guibg=Yellow guifg=Black"),
6288 #endif
6289 #ifdef FEAT_FOLDING
6290 CENT("Folded term=standout ctermbg=Grey ctermfg=DarkBlue",
6291 "Folded term=standout ctermbg=Grey ctermfg=DarkBlue guibg=LightGrey guifg=DarkBlue"),
6292 CENT("FoldColumn term=standout ctermbg=Grey ctermfg=DarkBlue",
6293 "FoldColumn term=standout ctermbg=Grey ctermfg=DarkBlue guibg=Grey guifg=DarkBlue"),
6294 #endif
6295 #ifdef FEAT_SIGNS
6296 CENT("SignColumn term=standout ctermbg=Grey ctermfg=DarkBlue",
6297 "SignColumn term=standout ctermbg=Grey ctermfg=DarkBlue guibg=Grey guifg=DarkBlue"),
6298 #endif
6299 #ifdef FEAT_VISUAL
6300 CENT("Visual term=reverse",
6301 "Visual term=reverse guibg=LightGrey"),
6302 #endif
6303 #ifdef FEAT_DIFF
6304 CENT("DiffAdd term=bold ctermbg=LightBlue",
6305 "DiffAdd term=bold ctermbg=LightBlue guibg=LightBlue"),
6306 CENT("DiffChange term=bold ctermbg=LightMagenta",
6307 "DiffChange term=bold ctermbg=LightMagenta guibg=LightMagenta"),
6308 CENT("DiffDelete term=bold ctermfg=Blue ctermbg=LightCyan",
6309 "DiffDelete term=bold ctermfg=Blue ctermbg=LightCyan gui=bold guifg=Blue guibg=LightCyan"),
6310 #endif
6311 #ifdef FEAT_WINDOWS
6312 CENT("TabLine term=underline cterm=underline ctermfg=black ctermbg=LightGrey",
6313 "TabLine term=underline cterm=underline ctermfg=black ctermbg=LightGrey gui=underline guibg=LightGrey"),
6314 #endif
6315 #ifdef FEAT_SYN_HL
6316 CENT("CursorColumn term=reverse ctermbg=LightGrey",
6317 "CursorColumn term=reverse ctermbg=LightGrey guibg=Grey90"),
6318 CENT("CursorLine term=underline cterm=underline",
6319 "CursorLine term=underline cterm=underline guibg=Grey90"),
6320 #endif
6321 #ifdef FEAT_AUTOCMD
6322 CENT("MatchParen term=reverse ctermbg=Cyan",
6323 "MatchParen term=reverse ctermbg=Cyan guibg=Cyan"),
6324 #endif
6325 #ifdef FEAT_GUI
6326 "Normal gui=NONE",
6327 #endif
6328 NULL
6331 static char *(highlight_init_dark[]) =
6333 CENT("Directory term=bold ctermfg=LightCyan",
6334 "Directory term=bold ctermfg=LightCyan guifg=Cyan"),
6335 CENT("LineNr term=underline ctermfg=Yellow",
6336 "LineNr term=underline ctermfg=Yellow guifg=Yellow"),
6337 CENT("MoreMsg term=bold ctermfg=LightGreen",
6338 "MoreMsg term=bold ctermfg=LightGreen gui=bold guifg=SeaGreen"),
6339 CENT("Question term=standout ctermfg=LightGreen",
6340 "Question term=standout ctermfg=LightGreen gui=bold guifg=Green"),
6341 CENT("Search term=reverse ctermbg=Yellow ctermfg=Black",
6342 "Search term=reverse ctermbg=Yellow ctermfg=Black guibg=Yellow guifg=Black"),
6343 CENT("SpecialKey term=bold ctermfg=LightBlue",
6344 "SpecialKey term=bold ctermfg=LightBlue guifg=Cyan"),
6345 #ifdef FEAT_SPELL
6346 CENT("SpellBad term=reverse ctermbg=Red",
6347 "SpellBad term=reverse ctermbg=Red guisp=Red gui=undercurl"),
6348 CENT("SpellCap term=reverse ctermbg=Blue",
6349 "SpellCap term=reverse ctermbg=Blue guisp=Blue gui=undercurl"),
6350 CENT("SpellRare term=reverse ctermbg=Magenta",
6351 "SpellRare term=reverse ctermbg=Magenta guisp=Magenta gui=undercurl"),
6352 CENT("SpellLocal term=underline ctermbg=Cyan",
6353 "SpellLocal term=underline ctermbg=Cyan guisp=Cyan gui=undercurl"),
6354 #endif
6355 #ifdef FEAT_INS_EXPAND
6356 CENT("Pmenu ctermbg=Magenta",
6357 "Pmenu ctermbg=Magenta guibg=Magenta"),
6358 CENT("PmenuSel ctermbg=DarkGrey",
6359 "PmenuSel ctermbg=DarkGrey guibg=DarkGrey"),
6360 #endif
6361 CENT("Title term=bold ctermfg=LightMagenta",
6362 "Title term=bold ctermfg=LightMagenta gui=bold guifg=Magenta"),
6363 CENT("WarningMsg term=standout ctermfg=LightRed",
6364 "WarningMsg term=standout ctermfg=LightRed guifg=Red"),
6365 #ifdef FEAT_WILDMENU
6366 CENT("WildMenu term=standout ctermbg=Yellow ctermfg=Black",
6367 "WildMenu term=standout ctermbg=Yellow ctermfg=Black guibg=Yellow guifg=Black"),
6368 #endif
6369 #ifdef FEAT_FOLDING
6370 CENT("Folded term=standout ctermbg=DarkGrey ctermfg=Cyan",
6371 "Folded term=standout ctermbg=DarkGrey ctermfg=Cyan guibg=DarkGrey guifg=Cyan"),
6372 CENT("FoldColumn term=standout ctermbg=DarkGrey ctermfg=Cyan",
6373 "FoldColumn term=standout ctermbg=DarkGrey ctermfg=Cyan guibg=Grey guifg=Cyan"),
6374 #endif
6375 #ifdef FEAT_SIGNS
6376 CENT("SignColumn term=standout ctermbg=DarkGrey ctermfg=Cyan",
6377 "SignColumn term=standout ctermbg=DarkGrey ctermfg=Cyan guibg=Grey guifg=Cyan"),
6378 #endif
6379 #ifdef FEAT_VISUAL
6380 CENT("Visual term=reverse",
6381 "Visual term=reverse guibg=DarkGrey"),
6382 #endif
6383 #ifdef FEAT_DIFF
6384 CENT("DiffAdd term=bold ctermbg=DarkBlue",
6385 "DiffAdd term=bold ctermbg=DarkBlue guibg=DarkBlue"),
6386 CENT("DiffChange term=bold ctermbg=DarkMagenta",
6387 "DiffChange term=bold ctermbg=DarkMagenta guibg=DarkMagenta"),
6388 CENT("DiffDelete term=bold ctermfg=Blue ctermbg=DarkCyan",
6389 "DiffDelete term=bold ctermfg=Blue ctermbg=DarkCyan gui=bold guifg=Blue guibg=DarkCyan"),
6390 #endif
6391 #ifdef FEAT_WINDOWS
6392 CENT("TabLine term=underline cterm=underline ctermfg=white ctermbg=DarkGrey",
6393 "TabLine term=underline cterm=underline ctermfg=white ctermbg=DarkGrey gui=underline guibg=DarkGrey"),
6394 #endif
6395 #ifdef FEAT_SYN_HL
6396 CENT("CursorColumn term=reverse ctermbg=DarkGrey",
6397 "CursorColumn term=reverse ctermbg=DarkGrey guibg=Grey40"),
6398 CENT("CursorLine term=underline cterm=underline",
6399 "CursorLine term=underline cterm=underline guibg=Grey40"),
6400 #endif
6401 #ifdef FEAT_AUTOCMD
6402 CENT("MatchParen term=reverse ctermbg=DarkCyan",
6403 "MatchParen term=reverse ctermbg=DarkCyan guibg=DarkCyan"),
6404 #endif
6405 #ifdef FEAT_GUI
6406 "Normal gui=NONE",
6407 #endif
6408 NULL
6411 void
6412 init_highlight(both, reset)
6413 int both; /* include groups where 'bg' doesn't matter */
6414 int reset; /* clear group first */
6416 int i;
6417 char **pp;
6418 static int had_both = FALSE;
6419 #ifdef FEAT_EVAL
6420 char_u *p;
6423 * Try finding the color scheme file. Used when a color file was loaded
6424 * and 'background' or 't_Co' is changed.
6426 p = get_var_value((char_u *)"g:colors_name");
6427 if (p != NULL && load_colors(p) == OK)
6428 return;
6429 #endif
6432 * Didn't use a color file, use the compiled-in colors.
6434 if (both)
6436 had_both = TRUE;
6437 pp = highlight_init_both;
6438 for (i = 0; pp[i] != NULL; ++i)
6439 do_highlight((char_u *)pp[i], reset, TRUE);
6441 else if (!had_both)
6442 /* Don't do anything before the call with both == TRUE from main().
6443 * Not everything has been setup then, and that call will overrule
6444 * everything anyway. */
6445 return;
6447 if (*p_bg == 'l')
6448 pp = highlight_init_light;
6449 else
6450 pp = highlight_init_dark;
6451 for (i = 0; pp[i] != NULL; ++i)
6452 do_highlight((char_u *)pp[i], reset, TRUE);
6454 /* Reverse looks ugly, but grey may not work for 8 colors. Thus let it
6455 * depend on the number of colors available.
6456 * With 8 colors brown is equal to yellow, need to use black for Search fg
6457 * to avoid Statement highlighted text disappears.
6458 * Clear the attributes, needed when changing the t_Co value. */
6459 if (t_colors > 8)
6460 do_highlight((char_u *)(*p_bg == 'l'
6461 ? "Visual cterm=NONE ctermbg=LightGrey"
6462 : "Visual cterm=NONE ctermbg=DarkGrey"), FALSE, TRUE);
6463 else
6465 do_highlight((char_u *)"Visual cterm=reverse ctermbg=NONE",
6466 FALSE, TRUE);
6467 if (*p_bg == 'l')
6468 do_highlight((char_u *)"Search ctermfg=black", FALSE, TRUE);
6471 #ifdef FEAT_SYN_HL
6473 * If syntax highlighting is enabled load the highlighting for it.
6475 if (get_var_value((char_u *)"g:syntax_on") != NULL)
6477 static int recursive = 0;
6479 if (recursive >= 5)
6480 EMSG(_("E679: recursive loop loading syncolor.vim"));
6481 else
6483 ++recursive;
6484 (void)source_runtime((char_u *)"syntax/syncolor.vim", TRUE);
6485 --recursive;
6488 #endif
6492 * Load color file "name".
6493 * Return OK for success, FAIL for failure.
6496 load_colors(name)
6497 char_u *name;
6499 char_u *buf;
6500 int retval = FAIL;
6501 static int recursive = FALSE;
6503 /* When being called recursively, this is probably because setting
6504 * 'background' caused the highlighting to be reloaded. This means it is
6505 * working, thus we should return OK. */
6506 if (recursive)
6507 return OK;
6509 recursive = TRUE;
6510 buf = alloc((unsigned)(STRLEN(name) + 12));
6511 if (buf != NULL)
6513 sprintf((char *)buf, "colors/%s.vim", name);
6514 retval = source_runtime(buf, FALSE);
6515 vim_free(buf);
6516 #ifdef FEAT_AUTOCMD
6517 apply_autocmds(EVENT_COLORSCHEME, NULL, NULL, FALSE, curbuf);
6518 #endif
6520 recursive = FALSE;
6522 return retval;
6526 * Handle the ":highlight .." command.
6527 * When using ":hi clear" this is called recursively for each group with
6528 * "forceit" and "init" both TRUE.
6530 void
6531 do_highlight(line, forceit, init)
6532 char_u *line;
6533 int forceit;
6534 int init; /* TRUE when called for initializing */
6536 char_u *name_end;
6537 char_u *p;
6538 char_u *linep;
6539 char_u *key_start;
6540 char_u *arg_start;
6541 char_u *key = NULL, *arg = NULL;
6542 long i;
6543 int off;
6544 int len;
6545 int attr;
6546 int id;
6547 int idx;
6548 int dodefault = FALSE;
6549 int doclear = FALSE;
6550 int dolink = FALSE;
6551 int error = FALSE;
6552 int color;
6553 int is_normal_group = FALSE; /* "Normal" group */
6554 #ifdef FEAT_GUI_X11
6555 int is_menu_group = FALSE; /* "Menu" group */
6556 int is_scrollbar_group = FALSE; /* "Scrollbar" group */
6557 int is_tooltip_group = FALSE; /* "Tooltip" group */
6558 int do_colors = FALSE; /* need to update colors? */
6559 #else
6560 # define is_menu_group 0
6561 # define is_tooltip_group 0
6562 #endif
6565 * If no argument, list current highlighting.
6567 if (ends_excmd(*line))
6569 for (i = 1; i <= highlight_ga.ga_len && !got_int; ++i)
6570 /* TODO: only call when the group has attributes set */
6571 highlight_list_one((int)i);
6572 return;
6576 * Isolate the name.
6578 name_end = skiptowhite(line);
6579 linep = skipwhite(name_end);
6582 * Check for "default" argument.
6584 if (STRNCMP(line, "default", name_end - line) == 0)
6586 dodefault = TRUE;
6587 line = linep;
6588 name_end = skiptowhite(line);
6589 linep = skipwhite(name_end);
6593 * Check for "clear" or "link" argument.
6595 if (STRNCMP(line, "clear", name_end - line) == 0)
6596 doclear = TRUE;
6597 if (STRNCMP(line, "link", name_end - line) == 0)
6598 dolink = TRUE;
6601 * ":highlight {group-name}": list highlighting for one group.
6603 if (!doclear && !dolink && ends_excmd(*linep))
6605 id = syn_namen2id(line, (int)(name_end - line));
6606 if (id == 0)
6607 EMSG2(_("E411: highlight group not found: %s"), line);
6608 else
6609 highlight_list_one(id);
6610 return;
6614 * Handle ":highlight link {from} {to}" command.
6616 if (dolink)
6618 char_u *from_start = linep;
6619 char_u *from_end;
6620 char_u *to_start;
6621 char_u *to_end;
6622 int from_id;
6623 int to_id;
6625 from_end = skiptowhite(from_start);
6626 to_start = skipwhite(from_end);
6627 to_end = skiptowhite(to_start);
6629 if (ends_excmd(*from_start) || ends_excmd(*to_start))
6631 EMSG2(_("E412: Not enough arguments: \":highlight link %s\""),
6632 from_start);
6633 return;
6636 if (!ends_excmd(*skipwhite(to_end)))
6638 EMSG2(_("E413: Too many arguments: \":highlight link %s\""), from_start);
6639 return;
6642 from_id = syn_check_group(from_start, (int)(from_end - from_start));
6643 if (STRNCMP(to_start, "NONE", 4) == 0)
6644 to_id = 0;
6645 else
6646 to_id = syn_check_group(to_start, (int)(to_end - to_start));
6648 if (from_id > 0 && (!init || HL_TABLE()[from_id - 1].sg_set == 0))
6651 * Don't allow a link when there already is some highlighting
6652 * for the group, unless '!' is used
6654 if (to_id > 0 && !forceit && !init
6655 && hl_has_settings(from_id - 1, dodefault))
6657 if (sourcing_name == NULL && !dodefault)
6658 EMSG(_("E414: group has settings, highlight link ignored"));
6660 else
6662 if (!init)
6663 HL_TABLE()[from_id - 1].sg_set |= SG_LINK;
6664 HL_TABLE()[from_id - 1].sg_link = to_id;
6665 #ifdef FEAT_EVAL
6666 HL_TABLE()[from_id - 1].sg_scriptID = current_SID;
6667 #endif
6668 redraw_all_later(SOME_VALID);
6672 /* Only call highlight_changed() once, after sourcing a syntax file */
6673 need_highlight_changed = TRUE;
6675 return;
6678 if (doclear)
6681 * ":highlight clear [group]" command.
6683 line = linep;
6684 if (ends_excmd(*line))
6686 #ifdef FEAT_GUI
6687 /* First, we do not destroy the old values, but allocate the new
6688 * ones and update the display. THEN we destroy the old values.
6689 * If we destroy the old values first, then the old values
6690 * (such as GuiFont's or GuiFontset's) will still be displayed but
6691 * invalid because they were free'd.
6693 if (gui.in_use)
6695 # ifdef FEAT_BEVAL_TIP
6696 gui_init_tooltip_font();
6697 # endif
6698 # if defined(FEAT_MENU) && (defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_MOTIF))
6699 gui_init_menu_font();
6700 # endif
6702 # if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_X11) \
6703 || defined(FEAT_GUI_MACVIM)
6704 gui_mch_def_colors();
6705 # endif
6706 # ifdef FEAT_GUI_X11
6707 # ifdef FEAT_MENU
6709 /* This only needs to be done when there is no Menu highlight
6710 * group defined by default, which IS currently the case.
6712 gui_mch_new_menu_colors();
6713 # endif
6714 if (gui.in_use)
6716 gui_new_scrollbar_colors();
6717 # ifdef FEAT_BEVAL
6718 gui_mch_new_tooltip_colors();
6719 # endif
6720 # ifdef FEAT_MENU
6721 gui_mch_new_menu_font();
6722 # endif
6724 # endif
6726 /* Ok, we're done allocating the new default graphics items.
6727 * The screen should already be refreshed at this point.
6728 * It is now Ok to clear out the old data.
6730 #endif
6731 #ifdef FEAT_EVAL
6732 do_unlet((char_u *)"colors_name", TRUE);
6733 #endif
6734 restore_cterm_colors();
6737 * Clear all default highlight groups and load the defaults.
6739 for (idx = 0; idx < highlight_ga.ga_len; ++idx)
6740 highlight_clear(idx);
6741 init_highlight(TRUE, TRUE);
6742 #ifdef FEAT_GUI
6743 if (gui.in_use)
6744 highlight_gui_started();
6745 #endif
6746 highlight_changed();
6747 redraw_later_clear();
6748 return;
6750 name_end = skiptowhite(line);
6751 linep = skipwhite(name_end);
6755 * Find the group name in the table. If it does not exist yet, add it.
6757 id = syn_check_group(line, (int)(name_end - line));
6758 if (id == 0) /* failed (out of memory) */
6759 return;
6760 idx = id - 1; /* index is ID minus one */
6762 /* Return if "default" was used and the group already has settings. */
6763 if (dodefault && hl_has_settings(idx, TRUE))
6764 return;
6766 if (STRCMP(HL_TABLE()[idx].sg_name_u, "NORMAL") == 0)
6767 is_normal_group = TRUE;
6768 #ifdef FEAT_GUI_X11
6769 else if (STRCMP(HL_TABLE()[idx].sg_name_u, "MENU") == 0)
6770 is_menu_group = TRUE;
6771 else if (STRCMP(HL_TABLE()[idx].sg_name_u, "SCROLLBAR") == 0)
6772 is_scrollbar_group = TRUE;
6773 else if (STRCMP(HL_TABLE()[idx].sg_name_u, "TOOLTIP") == 0)
6774 is_tooltip_group = TRUE;
6775 #endif
6777 /* Clear the highlighting for ":hi clear {group}" and ":hi clear". */
6778 if (doclear || (forceit && init))
6780 highlight_clear(idx);
6781 if (!doclear)
6782 HL_TABLE()[idx].sg_set = 0;
6785 if (!doclear)
6786 while (!ends_excmd(*linep))
6788 key_start = linep;
6789 if (*linep == '=')
6791 EMSG2(_("E415: unexpected equal sign: %s"), key_start);
6792 error = TRUE;
6793 break;
6797 * Isolate the key ("term", "ctermfg", "ctermbg", "font", "guifg" or
6798 * "guibg").
6800 while (*linep && !vim_iswhite(*linep) && *linep != '=')
6801 ++linep;
6802 vim_free(key);
6803 key = vim_strnsave_up(key_start, (int)(linep - key_start));
6804 if (key == NULL)
6806 error = TRUE;
6807 break;
6809 linep = skipwhite(linep);
6811 if (STRCMP(key, "NONE") == 0)
6813 if (!init || HL_TABLE()[idx].sg_set == 0)
6815 if (!init)
6816 HL_TABLE()[idx].sg_set |= SG_TERM+SG_CTERM+SG_GUI;
6817 highlight_clear(idx);
6819 continue;
6823 * Check for the equal sign.
6825 if (*linep != '=')
6827 EMSG2(_("E416: missing equal sign: %s"), key_start);
6828 error = TRUE;
6829 break;
6831 ++linep;
6834 * Isolate the argument.
6836 linep = skipwhite(linep);
6837 if (*linep == '\'') /* guifg='color name' */
6839 arg_start = ++linep;
6840 linep = vim_strchr(linep, '\'');
6841 if (linep == NULL)
6843 EMSG2(_(e_invarg2), key_start);
6844 error = TRUE;
6845 break;
6848 else
6850 arg_start = linep;
6851 linep = skiptowhite(linep);
6853 if (linep == arg_start)
6855 EMSG2(_("E417: missing argument: %s"), key_start);
6856 error = TRUE;
6857 break;
6859 vim_free(arg);
6860 arg = vim_strnsave(arg_start, (int)(linep - arg_start));
6861 if (arg == NULL)
6863 error = TRUE;
6864 break;
6866 if (*linep == '\'')
6867 ++linep;
6870 * Store the argument.
6872 if ( STRCMP(key, "TERM") == 0
6873 || STRCMP(key, "CTERM") == 0
6874 || STRCMP(key, "GUI") == 0)
6876 attr = 0;
6877 off = 0;
6878 while (arg[off] != NUL)
6880 for (i = sizeof(hl_attr_table) / sizeof(int); --i >= 0; )
6882 len = (int)STRLEN(hl_name_table[i]);
6883 if (STRNICMP(arg + off, hl_name_table[i], len) == 0)
6885 attr |= hl_attr_table[i];
6886 off += len;
6887 break;
6890 if (i < 0)
6892 EMSG2(_("E418: Illegal value: %s"), arg);
6893 error = TRUE;
6894 break;
6896 if (arg[off] == ',') /* another one follows */
6897 ++off;
6899 if (error)
6900 break;
6901 if (*key == 'T')
6903 if (!init || !(HL_TABLE()[idx].sg_set & SG_TERM))
6905 if (!init)
6906 HL_TABLE()[idx].sg_set |= SG_TERM;
6907 HL_TABLE()[idx].sg_term = attr;
6910 else if (*key == 'C')
6912 if (!init || !(HL_TABLE()[idx].sg_set & SG_CTERM))
6914 if (!init)
6915 HL_TABLE()[idx].sg_set |= SG_CTERM;
6916 HL_TABLE()[idx].sg_cterm = attr;
6917 HL_TABLE()[idx].sg_cterm_bold = FALSE;
6920 #ifdef FEAT_GUI
6921 else
6923 if (!init || !(HL_TABLE()[idx].sg_set & SG_GUI))
6925 if (!init)
6926 HL_TABLE()[idx].sg_set |= SG_GUI;
6927 HL_TABLE()[idx].sg_gui = attr;
6930 #endif
6932 else if (STRCMP(key, "FONT") == 0)
6934 /* in non-GUI fonts are simply ignored */
6935 #ifdef FEAT_GUI
6936 if (!gui.shell_created)
6938 /* GUI not started yet, always accept the name. */
6939 vim_free(HL_TABLE()[idx].sg_font_name);
6940 HL_TABLE()[idx].sg_font_name = vim_strsave(arg);
6942 else
6944 GuiFont temp_sg_font = HL_TABLE()[idx].sg_font;
6945 # ifdef FEAT_XFONTSET
6946 GuiFontset temp_sg_fontset = HL_TABLE()[idx].sg_fontset;
6947 # endif
6948 /* First, save the current font/fontset.
6949 * Then try to allocate the font/fontset.
6950 * If the allocation fails, HL_TABLE()[idx].sg_font OR
6951 * sg_fontset will be set to NOFONT or NOFONTSET respectively.
6954 HL_TABLE()[idx].sg_font = NOFONT;
6955 # ifdef FEAT_XFONTSET
6956 HL_TABLE()[idx].sg_fontset = NOFONTSET;
6957 # endif
6958 hl_do_font(idx, arg, is_normal_group, is_menu_group,
6959 is_tooltip_group);
6961 # ifdef FEAT_XFONTSET
6962 if (HL_TABLE()[idx].sg_fontset != NOFONTSET)
6964 /* New fontset was accepted. Free the old one, if there was
6965 * one.
6967 gui_mch_free_fontset(temp_sg_fontset);
6968 vim_free(HL_TABLE()[idx].sg_font_name);
6969 HL_TABLE()[idx].sg_font_name = vim_strsave(arg);
6971 else
6972 HL_TABLE()[idx].sg_fontset = temp_sg_fontset;
6973 # endif
6974 if (HL_TABLE()[idx].sg_font != NOFONT)
6976 /* New font was accepted. Free the old one, if there was
6977 * one.
6979 gui_mch_free_font(temp_sg_font);
6980 vim_free(HL_TABLE()[idx].sg_font_name);
6981 HL_TABLE()[idx].sg_font_name = vim_strsave(arg);
6983 else
6984 HL_TABLE()[idx].sg_font = temp_sg_font;
6986 #endif
6988 else if (STRCMP(key, "CTERMFG") == 0 || STRCMP(key, "CTERMBG") == 0)
6990 if (!init || !(HL_TABLE()[idx].sg_set & SG_CTERM))
6992 if (!init)
6993 HL_TABLE()[idx].sg_set |= SG_CTERM;
6995 /* When setting the foreground color, and previously the "bold"
6996 * flag was set for a light color, reset it now */
6997 if (key[5] == 'F' && HL_TABLE()[idx].sg_cterm_bold)
6999 HL_TABLE()[idx].sg_cterm &= ~HL_BOLD;
7000 HL_TABLE()[idx].sg_cterm_bold = FALSE;
7003 if (VIM_ISDIGIT(*arg))
7004 color = atoi((char *)arg);
7005 else if (STRICMP(arg, "fg") == 0)
7007 if (cterm_normal_fg_color)
7008 color = cterm_normal_fg_color - 1;
7009 else
7011 EMSG(_("E419: FG color unknown"));
7012 error = TRUE;
7013 break;
7016 else if (STRICMP(arg, "bg") == 0)
7018 if (cterm_normal_bg_color > 0)
7019 color = cterm_normal_bg_color - 1;
7020 else
7022 EMSG(_("E420: BG color unknown"));
7023 error = TRUE;
7024 break;
7027 else
7029 static char *(color_names[28]) = {
7030 "Black", "DarkBlue", "DarkGreen", "DarkCyan",
7031 "DarkRed", "DarkMagenta", "Brown", "DarkYellow",
7032 "Gray", "Grey",
7033 "LightGray", "LightGrey", "DarkGray", "DarkGrey",
7034 "Blue", "LightBlue", "Green", "LightGreen",
7035 "Cyan", "LightCyan", "Red", "LightRed", "Magenta",
7036 "LightMagenta", "Yellow", "LightYellow", "White", "NONE"};
7037 static int color_numbers_16[28] = {0, 1, 2, 3,
7038 4, 5, 6, 6,
7039 7, 7,
7040 7, 7, 8, 8,
7041 9, 9, 10, 10,
7042 11, 11, 12, 12, 13,
7043 13, 14, 14, 15, -1};
7044 /* for xterm with 88 colors... */
7045 static int color_numbers_88[28] = {0, 4, 2, 6,
7046 1, 5, 32, 72,
7047 84, 84,
7048 7, 7, 82, 82,
7049 12, 43, 10, 61,
7050 14, 63, 9, 74, 13,
7051 75, 11, 78, 15, -1};
7052 /* for xterm with 256 colors... */
7053 static int color_numbers_256[28] = {0, 4, 2, 6,
7054 1, 5, 130, 130,
7055 248, 248,
7056 7, 7, 242, 242,
7057 12, 81, 10, 121,
7058 14, 159, 9, 224, 13,
7059 225, 11, 229, 15, -1};
7060 /* for terminals with less than 16 colors... */
7061 static int color_numbers_8[28] = {0, 4, 2, 6,
7062 1, 5, 3, 3,
7063 7, 7,
7064 7, 7, 0+8, 0+8,
7065 4+8, 4+8, 2+8, 2+8,
7066 6+8, 6+8, 1+8, 1+8, 5+8,
7067 5+8, 3+8, 3+8, 7+8, -1};
7068 #if defined(__QNXNTO__)
7069 static int *color_numbers_8_qansi = color_numbers_8;
7070 /* On qnx, the 8 & 16 color arrays are the same */
7071 if (STRNCMP(T_NAME, "qansi", 5) == 0)
7072 color_numbers_8_qansi = color_numbers_16;
7073 #endif
7075 /* reduce calls to STRICMP a bit, it can be slow */
7076 off = TOUPPER_ASC(*arg);
7077 for (i = (sizeof(color_names) / sizeof(char *)); --i >= 0; )
7078 if (off == color_names[i][0]
7079 && STRICMP(arg + 1, color_names[i] + 1) == 0)
7080 break;
7081 if (i < 0)
7083 EMSG2(_("E421: Color name or number not recognized: %s"), key_start);
7084 error = TRUE;
7085 break;
7088 /* Use the _16 table to check if its a valid color name. */
7089 color = color_numbers_16[i];
7090 if (color >= 0)
7092 if (t_colors == 8)
7094 /* t_Co is 8: use the 8 colors table */
7095 #if defined(__QNXNTO__)
7096 color = color_numbers_8_qansi[i];
7097 #else
7098 color = color_numbers_8[i];
7099 #endif
7100 if (key[5] == 'F')
7102 /* set/reset bold attribute to get light foreground
7103 * colors (on some terminals, e.g. "linux") */
7104 if (color & 8)
7106 HL_TABLE()[idx].sg_cterm |= HL_BOLD;
7107 HL_TABLE()[idx].sg_cterm_bold = TRUE;
7109 else
7110 HL_TABLE()[idx].sg_cterm &= ~HL_BOLD;
7112 color &= 7; /* truncate to 8 colors */
7114 else if (t_colors == 16 || t_colors == 88
7115 || t_colors == 256)
7118 * Guess: if the termcap entry ends in 'm', it is
7119 * probably an xterm-like terminal. Use the changed
7120 * order for colors.
7122 if (*T_CAF != NUL)
7123 p = T_CAF;
7124 else
7125 p = T_CSF;
7126 if (*p != NUL && *(p + STRLEN(p) - 1) == 'm')
7127 switch (t_colors)
7129 case 16:
7130 color = color_numbers_8[i];
7131 break;
7132 case 88:
7133 color = color_numbers_88[i];
7134 break;
7135 case 256:
7136 color = color_numbers_256[i];
7137 break;
7142 /* Add one to the argument, to avoid zero */
7143 if (key[5] == 'F')
7145 HL_TABLE()[idx].sg_cterm_fg = color + 1;
7146 if (is_normal_group)
7148 cterm_normal_fg_color = color + 1;
7149 cterm_normal_fg_bold = (HL_TABLE()[idx].sg_cterm & HL_BOLD);
7150 #ifdef FEAT_GUI
7151 /* Don't do this if the GUI is used. */
7152 if (!gui.in_use && !gui.starting)
7153 #endif
7155 must_redraw = CLEAR;
7156 if (termcap_active)
7157 term_fg_color(color);
7161 else
7163 HL_TABLE()[idx].sg_cterm_bg = color + 1;
7164 if (is_normal_group)
7166 cterm_normal_bg_color = color + 1;
7167 #ifdef FEAT_GUI
7168 /* Don't mess with 'background' if the GUI is used. */
7169 if (!gui.in_use && !gui.starting)
7170 #endif
7172 must_redraw = CLEAR;
7173 if (termcap_active)
7174 term_bg_color(color);
7175 if (t_colors < 16)
7176 i = (color == 0 || color == 4);
7177 else
7178 i = (color < 7 || color == 8);
7179 /* Set the 'background' option if the value is wrong. */
7180 if (i != (*p_bg == 'd'))
7181 set_option_value((char_u *)"bg", 0L,
7182 i ? (char_u *)"dark" : (char_u *)"light", 0);
7188 else if (STRCMP(key, "GUIFG") == 0)
7190 #ifdef FEAT_GUI /* in non-GUI guifg colors are simply ignored */
7191 if (!init || !(HL_TABLE()[idx].sg_set & SG_GUI))
7193 if (!init)
7194 HL_TABLE()[idx].sg_set |= SG_GUI;
7196 i = color_name2handle(arg);
7197 if (i != INVALCOLOR || STRCMP(arg, "NONE") == 0 || !gui.in_use)
7199 HL_TABLE()[idx].sg_gui_fg = i;
7200 vim_free(HL_TABLE()[idx].sg_gui_fg_name);
7201 if (STRCMP(arg, "NONE"))
7202 HL_TABLE()[idx].sg_gui_fg_name = vim_strsave(arg);
7203 else
7204 HL_TABLE()[idx].sg_gui_fg_name = NULL;
7205 # ifdef FEAT_GUI_X11
7206 if (is_menu_group)
7207 gui.menu_fg_pixel = i;
7208 if (is_scrollbar_group)
7209 gui.scroll_fg_pixel = i;
7210 # ifdef FEAT_BEVAL
7211 if (is_tooltip_group)
7212 gui.tooltip_fg_pixel = i;
7213 # endif
7214 do_colors = TRUE;
7215 # endif
7218 #endif
7220 else if (STRCMP(key, "GUIBG") == 0)
7222 #ifdef FEAT_GUI /* in non-GUI guibg colors are simply ignored */
7223 if (!init || !(HL_TABLE()[idx].sg_set & SG_GUI))
7225 if (!init)
7226 HL_TABLE()[idx].sg_set |= SG_GUI;
7228 i = color_name2handle(arg);
7229 if (i != INVALCOLOR || STRCMP(arg, "NONE") == 0 || !gui.in_use)
7231 HL_TABLE()[idx].sg_gui_bg = i;
7232 vim_free(HL_TABLE()[idx].sg_gui_bg_name);
7233 if (STRCMP(arg, "NONE") != 0)
7234 HL_TABLE()[idx].sg_gui_bg_name = vim_strsave(arg);
7235 else
7236 HL_TABLE()[idx].sg_gui_bg_name = NULL;
7237 # ifdef FEAT_GUI_X11
7238 if (is_menu_group)
7239 gui.menu_bg_pixel = i;
7240 if (is_scrollbar_group)
7241 gui.scroll_bg_pixel = i;
7242 # ifdef FEAT_BEVAL
7243 if (is_tooltip_group)
7244 gui.tooltip_bg_pixel = i;
7245 # endif
7246 do_colors = TRUE;
7247 # endif
7250 #endif
7252 else if (STRCMP(key, "GUISP") == 0)
7254 #ifdef FEAT_GUI /* in non-GUI guisp colors are simply ignored */
7255 if (!init || !(HL_TABLE()[idx].sg_set & SG_GUI))
7257 if (!init)
7258 HL_TABLE()[idx].sg_set |= SG_GUI;
7260 i = color_name2handle(arg);
7261 if (i != INVALCOLOR || STRCMP(arg, "NONE") == 0 || !gui.in_use)
7263 HL_TABLE()[idx].sg_gui_sp = i;
7264 vim_free(HL_TABLE()[idx].sg_gui_sp_name);
7265 if (STRCMP(arg, "NONE") != 0)
7266 HL_TABLE()[idx].sg_gui_sp_name = vim_strsave(arg);
7267 else
7268 HL_TABLE()[idx].sg_gui_sp_name = NULL;
7271 #endif
7273 else if (STRCMP(key, "START") == 0 || STRCMP(key, "STOP") == 0)
7275 char_u buf[100];
7276 char_u *tname;
7278 if (!init)
7279 HL_TABLE()[idx].sg_set |= SG_TERM;
7282 * The "start" and "stop" arguments can be a literal escape
7283 * sequence, or a comma separated list of terminal codes.
7285 if (STRNCMP(arg, "t_", 2) == 0)
7287 off = 0;
7288 buf[0] = 0;
7289 while (arg[off] != NUL)
7291 /* Isolate one termcap name */
7292 for (len = 0; arg[off + len] &&
7293 arg[off + len] != ','; ++len)
7295 tname = vim_strnsave(arg + off, len);
7296 if (tname == NULL) /* out of memory */
7298 error = TRUE;
7299 break;
7301 /* lookup the escape sequence for the item */
7302 p = get_term_code(tname);
7303 vim_free(tname);
7304 if (p == NULL) /* ignore non-existing things */
7305 p = (char_u *)"";
7307 /* Append it to the already found stuff */
7308 if ((int)(STRLEN(buf) + STRLEN(p)) >= 99)
7310 EMSG2(_("E422: terminal code too long: %s"), arg);
7311 error = TRUE;
7312 break;
7314 STRCAT(buf, p);
7316 /* Advance to the next item */
7317 off += len;
7318 if (arg[off] == ',') /* another one follows */
7319 ++off;
7322 else
7325 * Copy characters from arg[] to buf[], translating <> codes.
7327 for (p = arg, off = 0; off < 100 && *p; )
7329 len = trans_special(&p, buf + off, FALSE);
7330 if (len) /* recognized special char */
7331 off += len;
7332 else /* copy as normal char */
7333 buf[off++] = *p++;
7335 buf[off] = NUL;
7337 if (error)
7338 break;
7340 if (STRCMP(buf, "NONE") == 0) /* resetting the value */
7341 p = NULL;
7342 else
7343 p = vim_strsave(buf);
7344 if (key[2] == 'A')
7346 vim_free(HL_TABLE()[idx].sg_start);
7347 HL_TABLE()[idx].sg_start = p;
7349 else
7351 vim_free(HL_TABLE()[idx].sg_stop);
7352 HL_TABLE()[idx].sg_stop = p;
7355 else
7357 EMSG2(_("E423: Illegal argument: %s"), key_start);
7358 error = TRUE;
7359 break;
7363 * When highlighting has been given for a group, don't link it.
7365 if (!init || !(HL_TABLE()[idx].sg_set & SG_LINK))
7366 HL_TABLE()[idx].sg_link = 0;
7369 * Continue with next argument.
7371 linep = skipwhite(linep);
7375 * If there is an error, and it's a new entry, remove it from the table.
7377 if (error && idx == highlight_ga.ga_len)
7378 syn_unadd_group();
7379 else
7381 if (is_normal_group)
7383 HL_TABLE()[idx].sg_term_attr = 0;
7384 HL_TABLE()[idx].sg_cterm_attr = 0;
7385 #ifdef FEAT_GUI
7386 HL_TABLE()[idx].sg_gui_attr = 0;
7388 * Need to update all groups, because they might be using "bg"
7389 * and/or "fg", which have been changed now.
7391 if (gui.in_use)
7392 highlight_gui_started();
7393 #endif
7395 #ifdef FEAT_GUI_X11
7396 # ifdef FEAT_MENU
7397 else if (is_menu_group)
7399 if (gui.in_use && do_colors)
7400 gui_mch_new_menu_colors();
7402 # endif
7403 else if (is_scrollbar_group)
7405 if (gui.in_use && do_colors)
7406 gui_new_scrollbar_colors();
7408 # ifdef FEAT_BEVAL
7409 else if (is_tooltip_group)
7411 if (gui.in_use && do_colors)
7412 gui_mch_new_tooltip_colors();
7414 # endif
7415 #endif
7416 else
7417 set_hl_attr(idx);
7418 #ifdef FEAT_EVAL
7419 HL_TABLE()[idx].sg_scriptID = current_SID;
7420 #endif
7421 redraw_all_later(NOT_VALID);
7423 vim_free(key);
7424 vim_free(arg);
7426 /* Only call highlight_changed() once, after sourcing a syntax file */
7427 need_highlight_changed = TRUE;
7430 #if defined(EXITFREE) || defined(PROTO)
7431 void
7432 free_highlight()
7434 int i;
7436 for (i = 0; i < highlight_ga.ga_len; ++i)
7438 highlight_clear(i);
7439 vim_free(HL_TABLE()[i].sg_name);
7440 vim_free(HL_TABLE()[i].sg_name_u);
7442 ga_clear(&highlight_ga);
7444 #endif
7447 * Reset the cterm colors to what they were before Vim was started, if
7448 * possible. Otherwise reset them to zero.
7450 void
7451 restore_cterm_colors()
7453 #if defined(MSDOS) || (defined(WIN3264) && !defined(FEAT_GUI_W32))
7454 /* Since t_me has been set, this probably means that the user
7455 * wants to use this as default colors. Need to reset default
7456 * background/foreground colors. */
7457 mch_set_normal_colors();
7458 #else
7459 cterm_normal_fg_color = 0;
7460 cterm_normal_fg_bold = 0;
7461 cterm_normal_bg_color = 0;
7462 #endif
7466 * Return TRUE if highlight group "idx" has any settings.
7467 * When "check_link" is TRUE also check for an existing link.
7469 static int
7470 hl_has_settings(idx, check_link)
7471 int idx;
7472 int check_link;
7474 return ( HL_TABLE()[idx].sg_term_attr != 0
7475 || HL_TABLE()[idx].sg_cterm_attr != 0
7476 #ifdef FEAT_GUI
7477 || HL_TABLE()[idx].sg_gui_attr != 0
7478 #endif
7479 || (check_link && (HL_TABLE()[idx].sg_set & SG_LINK)));
7483 * Clear highlighting for one group.
7485 static void
7486 highlight_clear(idx)
7487 int idx;
7489 HL_TABLE()[idx].sg_term = 0;
7490 vim_free(HL_TABLE()[idx].sg_start);
7491 HL_TABLE()[idx].sg_start = NULL;
7492 vim_free(HL_TABLE()[idx].sg_stop);
7493 HL_TABLE()[idx].sg_stop = NULL;
7494 HL_TABLE()[idx].sg_term_attr = 0;
7495 HL_TABLE()[idx].sg_cterm = 0;
7496 HL_TABLE()[idx].sg_cterm_bold = FALSE;
7497 HL_TABLE()[idx].sg_cterm_fg = 0;
7498 HL_TABLE()[idx].sg_cterm_bg = 0;
7499 HL_TABLE()[idx].sg_cterm_attr = 0;
7500 #ifdef FEAT_GUI /* in non-GUI fonts are simply ignored */
7501 HL_TABLE()[idx].sg_gui = 0;
7502 HL_TABLE()[idx].sg_gui_fg = INVALCOLOR;
7503 vim_free(HL_TABLE()[idx].sg_gui_fg_name);
7504 HL_TABLE()[idx].sg_gui_fg_name = NULL;
7505 HL_TABLE()[idx].sg_gui_bg = INVALCOLOR;
7506 vim_free(HL_TABLE()[idx].sg_gui_bg_name);
7507 HL_TABLE()[idx].sg_gui_bg_name = NULL;
7508 HL_TABLE()[idx].sg_gui_sp = INVALCOLOR;
7509 vim_free(HL_TABLE()[idx].sg_gui_sp_name);
7510 HL_TABLE()[idx].sg_gui_sp_name = NULL;
7511 gui_mch_free_font(HL_TABLE()[idx].sg_font);
7512 HL_TABLE()[idx].sg_font = NOFONT;
7513 # ifdef FEAT_XFONTSET
7514 gui_mch_free_fontset(HL_TABLE()[idx].sg_fontset);
7515 HL_TABLE()[idx].sg_fontset = NOFONTSET;
7516 # endif
7517 vim_free(HL_TABLE()[idx].sg_font_name);
7518 HL_TABLE()[idx].sg_font_name = NULL;
7519 HL_TABLE()[idx].sg_gui_attr = 0;
7520 #endif
7521 #ifdef FEAT_EVAL
7522 /* Clear the script ID only when there is no link, since that is not
7523 * cleared. */
7524 if (HL_TABLE()[idx].sg_link == 0)
7525 HL_TABLE()[idx].sg_scriptID = 0;
7526 #endif
7529 #if defined(FEAT_GUI) || defined(PROTO)
7531 * Set the normal foreground and background colors according to the "Normal"
7532 * highlighting group. For X11 also set "Menu", "Scrollbar", and
7533 * "Tooltip" colors.
7535 void
7536 set_normal_colors()
7538 if (set_group_colors((char_u *)"Normal",
7539 &gui.norm_pixel, &gui.back_pixel,
7540 FALSE, TRUE, FALSE))
7542 gui_mch_new_colors();
7543 must_redraw = CLEAR;
7545 #ifdef FEAT_GUI_X11
7546 if (set_group_colors((char_u *)"Menu",
7547 &gui.menu_fg_pixel, &gui.menu_bg_pixel,
7548 TRUE, FALSE, FALSE))
7550 # ifdef FEAT_MENU
7551 gui_mch_new_menu_colors();
7552 # endif
7553 must_redraw = CLEAR;
7555 # ifdef FEAT_BEVAL
7556 if (set_group_colors((char_u *)"Tooltip",
7557 &gui.tooltip_fg_pixel, &gui.tooltip_bg_pixel,
7558 FALSE, FALSE, TRUE))
7560 # ifdef FEAT_TOOLBAR
7561 gui_mch_new_tooltip_colors();
7562 # endif
7563 must_redraw = CLEAR;
7565 #endif
7566 if (set_group_colors((char_u *)"Scrollbar",
7567 &gui.scroll_fg_pixel, &gui.scroll_bg_pixel,
7568 FALSE, FALSE, FALSE))
7570 gui_new_scrollbar_colors();
7571 must_redraw = CLEAR;
7573 #endif
7577 * Set the colors for "Normal", "Menu", "Tooltip" or "Scrollbar".
7579 static int
7580 set_group_colors(name, fgp, bgp, do_menu, use_norm, do_tooltip)
7581 char_u *name;
7582 guicolor_T *fgp;
7583 guicolor_T *bgp;
7584 int do_menu;
7585 int use_norm;
7586 int do_tooltip;
7588 int idx;
7590 idx = syn_name2id(name) - 1;
7591 if (idx >= 0)
7593 gui_do_one_color(idx, do_menu, do_tooltip);
7595 if (HL_TABLE()[idx].sg_gui_fg != INVALCOLOR)
7596 *fgp = HL_TABLE()[idx].sg_gui_fg;
7597 else if (use_norm)
7598 *fgp = gui.def_norm_pixel;
7599 if (HL_TABLE()[idx].sg_gui_bg != INVALCOLOR)
7600 *bgp = HL_TABLE()[idx].sg_gui_bg;
7601 else if (use_norm)
7602 *bgp = gui.def_back_pixel;
7603 return TRUE;
7605 return FALSE;
7609 * Get the font of the "Normal" group.
7610 * Returns "" when it's not found or not set.
7612 char_u *
7613 hl_get_font_name()
7615 int id;
7616 char_u *s;
7618 id = syn_name2id((char_u *)"Normal");
7619 if (id > 0)
7621 s = HL_TABLE()[id - 1].sg_font_name;
7622 if (s != NULL)
7623 return s;
7625 return (char_u *)"";
7629 * Set font for "Normal" group. Called by gui_mch_init_font() when a font has
7630 * actually chosen to be used.
7632 void
7633 hl_set_font_name(font_name)
7634 char_u *font_name;
7636 int id;
7638 id = syn_name2id((char_u *)"Normal");
7639 if (id > 0)
7641 vim_free(HL_TABLE()[id - 1].sg_font_name);
7642 HL_TABLE()[id - 1].sg_font_name = vim_strsave(font_name);
7647 * Set background color for "Normal" group. Called by gui_set_bg_color()
7648 * when the color is known.
7650 void
7651 hl_set_bg_color_name(name)
7652 char_u *name; /* must have been allocated */
7654 int id;
7656 if (name != NULL)
7658 id = syn_name2id((char_u *)"Normal");
7659 if (id > 0)
7661 vim_free(HL_TABLE()[id - 1].sg_gui_bg_name);
7662 HL_TABLE()[id - 1].sg_gui_bg_name = name;
7668 * Set foreground color for "Normal" group. Called by gui_set_fg_color()
7669 * when the color is known.
7671 void
7672 hl_set_fg_color_name(name)
7673 char_u *name; /* must have been allocated */
7675 int id;
7677 if (name != NULL)
7679 id = syn_name2id((char_u *)"Normal");
7680 if (id > 0)
7682 vim_free(HL_TABLE()[id - 1].sg_gui_fg_name);
7683 HL_TABLE()[id - 1].sg_gui_fg_name = name;
7689 * Return the handle for a color name.
7690 * Returns INVALCOLOR when failed.
7692 static guicolor_T
7693 color_name2handle(name)
7694 char_u *name;
7696 if (STRCMP(name, "NONE") == 0)
7697 return INVALCOLOR;
7699 if (STRICMP(name, "fg") == 0 || STRICMP(name, "foreground") == 0)
7700 return gui.norm_pixel;
7701 if (STRICMP(name, "bg") == 0 || STRICMP(name, "background") == 0)
7702 return gui.back_pixel;
7704 return gui_get_color(name);
7708 * Return the handle for a font name.
7709 * Returns NOFONT when failed.
7711 static GuiFont
7712 font_name2handle(name)
7713 char_u *name;
7715 if (STRCMP(name, "NONE") == 0)
7716 return NOFONT;
7718 return gui_mch_get_font(name, TRUE);
7721 # ifdef FEAT_XFONTSET
7723 * Return the handle for a fontset name.
7724 * Returns NOFONTSET when failed.
7726 static GuiFontset
7727 fontset_name2handle(name, fixed_width)
7728 char_u *name;
7729 int fixed_width;
7731 if (STRCMP(name, "NONE") == 0)
7732 return NOFONTSET;
7734 return gui_mch_get_fontset(name, TRUE, fixed_width);
7736 # endif
7739 * Get the font or fontset for one highlight group.
7741 static void
7742 hl_do_font(idx, arg, do_normal, do_menu, do_tooltip)
7743 int idx;
7744 char_u *arg;
7745 int do_normal; /* set normal font */
7746 int do_menu UNUSED; /* set menu font */
7747 int do_tooltip UNUSED; /* set tooltip font */
7749 # ifdef FEAT_XFONTSET
7750 /* If 'guifontset' is not empty, first try using the name as a
7751 * fontset. If that doesn't work, use it as a font name. */
7752 if (*p_guifontset != NUL
7753 # ifdef FONTSET_ALWAYS
7754 || do_menu
7755 # endif
7756 # ifdef FEAT_BEVAL_TIP
7757 /* In Athena & Motif, the Tooltip highlight group is always a fontset */
7758 || do_tooltip
7759 # endif
7761 HL_TABLE()[idx].sg_fontset = fontset_name2handle(arg, 0
7762 # ifdef FONTSET_ALWAYS
7763 || do_menu
7764 # endif
7765 # ifdef FEAT_BEVAL_TIP
7766 || do_tooltip
7767 # endif
7769 if (HL_TABLE()[idx].sg_fontset != NOFONTSET)
7771 /* If it worked and it's the Normal group, use it as the
7772 * normal fontset. Same for the Menu group. */
7773 if (do_normal)
7774 gui_init_font(arg, TRUE);
7775 # if (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA)) && defined(FEAT_MENU)
7776 if (do_menu)
7778 # ifdef FONTSET_ALWAYS
7779 gui.menu_fontset = HL_TABLE()[idx].sg_fontset;
7780 # else
7781 /* YIKES! This is a bug waiting to crash the program */
7782 gui.menu_font = HL_TABLE()[idx].sg_fontset;
7783 # endif
7784 gui_mch_new_menu_font();
7786 # ifdef FEAT_BEVAL
7787 if (do_tooltip)
7789 /* The Athena widget set cannot currently handle switching between
7790 * displaying a single font and a fontset.
7791 * If the XtNinternational resource is set to True at widget
7792 * creation, then a fontset is always used, otherwise an
7793 * XFontStruct is used.
7795 gui.tooltip_fontset = (XFontSet)HL_TABLE()[idx].sg_fontset;
7796 gui_mch_new_tooltip_font();
7798 # endif
7799 # endif
7801 else
7802 # endif
7804 HL_TABLE()[idx].sg_font = font_name2handle(arg);
7805 /* If it worked and it's the Normal group, use it as the
7806 * normal font. Same for the Menu group. */
7807 if (HL_TABLE()[idx].sg_font != NOFONT)
7809 if (do_normal)
7810 gui_init_font(arg, FALSE);
7811 #ifndef FONTSET_ALWAYS
7812 # if (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA)) && defined(FEAT_MENU)
7813 if (do_menu)
7815 gui.menu_font = HL_TABLE()[idx].sg_font;
7816 gui_mch_new_menu_font();
7818 # endif
7819 #endif
7824 #endif /* FEAT_GUI */
7827 * Table with the specifications for an attribute number.
7828 * Note that this table is used by ALL buffers. This is required because the
7829 * GUI can redraw at any time for any buffer.
7831 static garray_T term_attr_table = {0, 0, 0, 0, NULL};
7833 #define TERM_ATTR_ENTRY(idx) ((attrentry_T *)term_attr_table.ga_data)[idx]
7835 static garray_T cterm_attr_table = {0, 0, 0, 0, NULL};
7837 #define CTERM_ATTR_ENTRY(idx) ((attrentry_T *)cterm_attr_table.ga_data)[idx]
7839 #ifdef FEAT_GUI
7840 static garray_T gui_attr_table = {0, 0, 0, 0, NULL};
7842 #define GUI_ATTR_ENTRY(idx) ((attrentry_T *)gui_attr_table.ga_data)[idx]
7843 #endif
7846 * Return the attr number for a set of colors and font.
7847 * Add a new entry to the term_attr_table, cterm_attr_table or gui_attr_table
7848 * if the combination is new.
7849 * Return 0 for error (no more room).
7851 static int
7852 get_attr_entry(table, aep)
7853 garray_T *table;
7854 attrentry_T *aep;
7856 int i;
7857 attrentry_T *taep;
7858 static int recursive = FALSE;
7861 * Init the table, in case it wasn't done yet.
7863 table->ga_itemsize = sizeof(attrentry_T);
7864 table->ga_growsize = 7;
7867 * Try to find an entry with the same specifications.
7869 for (i = 0; i < table->ga_len; ++i)
7871 taep = &(((attrentry_T *)table->ga_data)[i]);
7872 if ( aep->ae_attr == taep->ae_attr
7873 && (
7874 #ifdef FEAT_GUI
7875 (table == &gui_attr_table
7876 && (aep->ae_u.gui.fg_color == taep->ae_u.gui.fg_color
7877 && aep->ae_u.gui.bg_color
7878 == taep->ae_u.gui.bg_color
7879 && aep->ae_u.gui.sp_color
7880 == taep->ae_u.gui.sp_color
7881 && aep->ae_u.gui.font == taep->ae_u.gui.font
7882 # ifdef FEAT_XFONTSET
7883 && aep->ae_u.gui.fontset == taep->ae_u.gui.fontset
7884 # endif
7887 #endif
7888 (table == &term_attr_table
7889 && (aep->ae_u.term.start == NULL)
7890 == (taep->ae_u.term.start == NULL)
7891 && (aep->ae_u.term.start == NULL
7892 || STRCMP(aep->ae_u.term.start,
7893 taep->ae_u.term.start) == 0)
7894 && (aep->ae_u.term.stop == NULL)
7895 == (taep->ae_u.term.stop == NULL)
7896 && (aep->ae_u.term.stop == NULL
7897 || STRCMP(aep->ae_u.term.stop,
7898 taep->ae_u.term.stop) == 0))
7899 || (table == &cterm_attr_table
7900 && aep->ae_u.cterm.fg_color
7901 == taep->ae_u.cterm.fg_color
7902 && aep->ae_u.cterm.bg_color
7903 == taep->ae_u.cterm.bg_color)
7906 return i + ATTR_OFF;
7909 if (table->ga_len + ATTR_OFF > MAX_TYPENR)
7912 * Running out of attribute entries! remove all attributes, and
7913 * compute new ones for all groups.
7914 * When called recursively, we are really out of numbers.
7916 if (recursive)
7918 EMSG(_("E424: Too many different highlighting attributes in use"));
7919 return 0;
7921 recursive = TRUE;
7923 clear_hl_tables();
7925 must_redraw = CLEAR;
7927 for (i = 0; i < highlight_ga.ga_len; ++i)
7928 set_hl_attr(i);
7930 recursive = FALSE;
7934 * This is a new combination of colors and font, add an entry.
7936 if (ga_grow(table, 1) == FAIL)
7937 return 0;
7939 taep = &(((attrentry_T *)table->ga_data)[table->ga_len]);
7940 vim_memset(taep, 0, sizeof(attrentry_T));
7941 taep->ae_attr = aep->ae_attr;
7942 #ifdef FEAT_GUI
7943 if (table == &gui_attr_table)
7945 taep->ae_u.gui.fg_color = aep->ae_u.gui.fg_color;
7946 taep->ae_u.gui.bg_color = aep->ae_u.gui.bg_color;
7947 taep->ae_u.gui.sp_color = aep->ae_u.gui.sp_color;
7948 taep->ae_u.gui.font = aep->ae_u.gui.font;
7949 # ifdef FEAT_XFONTSET
7950 taep->ae_u.gui.fontset = aep->ae_u.gui.fontset;
7951 # endif
7953 #endif
7954 if (table == &term_attr_table)
7956 if (aep->ae_u.term.start == NULL)
7957 taep->ae_u.term.start = NULL;
7958 else
7959 taep->ae_u.term.start = vim_strsave(aep->ae_u.term.start);
7960 if (aep->ae_u.term.stop == NULL)
7961 taep->ae_u.term.stop = NULL;
7962 else
7963 taep->ae_u.term.stop = vim_strsave(aep->ae_u.term.stop);
7965 else if (table == &cterm_attr_table)
7967 taep->ae_u.cterm.fg_color = aep->ae_u.cterm.fg_color;
7968 taep->ae_u.cterm.bg_color = aep->ae_u.cterm.bg_color;
7970 ++table->ga_len;
7971 return (table->ga_len - 1 + ATTR_OFF);
7975 * Clear all highlight tables.
7977 void
7978 clear_hl_tables()
7980 int i;
7981 attrentry_T *taep;
7983 #ifdef FEAT_GUI
7984 ga_clear(&gui_attr_table);
7985 #endif
7986 for (i = 0; i < term_attr_table.ga_len; ++i)
7988 taep = &(((attrentry_T *)term_attr_table.ga_data)[i]);
7989 vim_free(taep->ae_u.term.start);
7990 vim_free(taep->ae_u.term.stop);
7992 ga_clear(&term_attr_table);
7993 ga_clear(&cterm_attr_table);
7996 #if defined(FEAT_SYN_HL) || defined(FEAT_SPELL) || defined(PROTO)
7998 * Combine special attributes (e.g., for spelling) with other attributes
7999 * (e.g., for syntax highlighting).
8000 * "prim_attr" overrules "char_attr".
8001 * This creates a new group when required.
8002 * Since we expect there to be few spelling mistakes we don't cache the
8003 * result.
8004 * Return the resulting attributes.
8007 hl_combine_attr(char_attr, prim_attr)
8008 int char_attr;
8009 int prim_attr;
8011 attrentry_T *char_aep = NULL;
8012 attrentry_T *spell_aep;
8013 attrentry_T new_en;
8015 if (char_attr == 0)
8016 return prim_attr;
8017 if (char_attr <= HL_ALL && prim_attr <= HL_ALL)
8018 return char_attr | prim_attr;
8019 #ifdef FEAT_GUI
8020 if (gui.in_use)
8022 if (char_attr > HL_ALL)
8023 char_aep = syn_gui_attr2entry(char_attr);
8024 if (char_aep != NULL)
8025 new_en = *char_aep;
8026 else
8028 vim_memset(&new_en, 0, sizeof(new_en));
8029 new_en.ae_u.gui.fg_color = INVALCOLOR;
8030 new_en.ae_u.gui.bg_color = INVALCOLOR;
8031 new_en.ae_u.gui.sp_color = INVALCOLOR;
8032 if (char_attr <= HL_ALL)
8033 new_en.ae_attr = char_attr;
8036 if (prim_attr <= HL_ALL)
8037 new_en.ae_attr |= prim_attr;
8038 else
8040 spell_aep = syn_gui_attr2entry(prim_attr);
8041 if (spell_aep != NULL)
8043 new_en.ae_attr |= spell_aep->ae_attr;
8044 if (spell_aep->ae_u.gui.fg_color != INVALCOLOR)
8045 new_en.ae_u.gui.fg_color = spell_aep->ae_u.gui.fg_color;
8046 if (spell_aep->ae_u.gui.bg_color != INVALCOLOR)
8047 new_en.ae_u.gui.bg_color = spell_aep->ae_u.gui.bg_color;
8048 if (spell_aep->ae_u.gui.sp_color != INVALCOLOR)
8049 new_en.ae_u.gui.sp_color = spell_aep->ae_u.gui.sp_color;
8050 if (spell_aep->ae_u.gui.font != NOFONT)
8051 new_en.ae_u.gui.font = spell_aep->ae_u.gui.font;
8052 # ifdef FEAT_XFONTSET
8053 if (spell_aep->ae_u.gui.fontset != NOFONTSET)
8054 new_en.ae_u.gui.fontset = spell_aep->ae_u.gui.fontset;
8055 # endif
8058 return get_attr_entry(&gui_attr_table, &new_en);
8060 #endif
8062 if (t_colors > 1)
8064 if (char_attr > HL_ALL)
8065 char_aep = syn_cterm_attr2entry(char_attr);
8066 if (char_aep != NULL)
8067 new_en = *char_aep;
8068 else
8070 vim_memset(&new_en, 0, sizeof(new_en));
8071 if (char_attr <= HL_ALL)
8072 new_en.ae_attr = char_attr;
8075 if (prim_attr <= HL_ALL)
8076 new_en.ae_attr |= prim_attr;
8077 else
8079 spell_aep = syn_cterm_attr2entry(prim_attr);
8080 if (spell_aep != NULL)
8082 new_en.ae_attr |= spell_aep->ae_attr;
8083 if (spell_aep->ae_u.cterm.fg_color > 0)
8084 new_en.ae_u.cterm.fg_color = spell_aep->ae_u.cterm.fg_color;
8085 if (spell_aep->ae_u.cterm.bg_color > 0)
8086 new_en.ae_u.cterm.bg_color = spell_aep->ae_u.cterm.bg_color;
8089 return get_attr_entry(&cterm_attr_table, &new_en);
8092 if (char_attr > HL_ALL)
8093 char_aep = syn_term_attr2entry(char_attr);
8094 if (char_aep != NULL)
8095 new_en = *char_aep;
8096 else
8098 vim_memset(&new_en, 0, sizeof(new_en));
8099 if (char_attr <= HL_ALL)
8100 new_en.ae_attr = char_attr;
8103 if (prim_attr <= HL_ALL)
8104 new_en.ae_attr |= prim_attr;
8105 else
8107 spell_aep = syn_term_attr2entry(prim_attr);
8108 if (spell_aep != NULL)
8110 new_en.ae_attr |= spell_aep->ae_attr;
8111 if (spell_aep->ae_u.term.start != NULL)
8113 new_en.ae_u.term.start = spell_aep->ae_u.term.start;
8114 new_en.ae_u.term.stop = spell_aep->ae_u.term.stop;
8118 return get_attr_entry(&term_attr_table, &new_en);
8120 #endif
8122 #ifdef FEAT_GUI
8124 attrentry_T *
8125 syn_gui_attr2entry(attr)
8126 int attr;
8128 attr -= ATTR_OFF;
8129 if (attr >= gui_attr_table.ga_len) /* did ":syntax clear" */
8130 return NULL;
8131 return &(GUI_ATTR_ENTRY(attr));
8133 #endif /* FEAT_GUI */
8136 * Get the highlight attributes (HL_BOLD etc.) from an attribute nr.
8137 * Only to be used when "attr" > HL_ALL.
8140 syn_attr2attr(attr)
8141 int attr;
8143 attrentry_T *aep;
8145 #ifdef FEAT_GUI
8146 if (gui.in_use)
8147 aep = syn_gui_attr2entry(attr);
8148 else
8149 #endif
8150 if (t_colors > 1)
8151 aep = syn_cterm_attr2entry(attr);
8152 else
8153 aep = syn_term_attr2entry(attr);
8155 if (aep == NULL) /* highlighting not set */
8156 return 0;
8157 return aep->ae_attr;
8161 attrentry_T *
8162 syn_term_attr2entry(attr)
8163 int attr;
8165 attr -= ATTR_OFF;
8166 if (attr >= term_attr_table.ga_len) /* did ":syntax clear" */
8167 return NULL;
8168 return &(TERM_ATTR_ENTRY(attr));
8171 attrentry_T *
8172 syn_cterm_attr2entry(attr)
8173 int attr;
8175 attr -= ATTR_OFF;
8176 if (attr >= cterm_attr_table.ga_len) /* did ":syntax clear" */
8177 return NULL;
8178 return &(CTERM_ATTR_ENTRY(attr));
8181 #define LIST_ATTR 1
8182 #define LIST_STRING 2
8183 #define LIST_INT 3
8185 static void
8186 highlight_list_one(id)
8187 int id;
8189 struct hl_group *sgp;
8190 int didh = FALSE;
8192 sgp = &HL_TABLE()[id - 1]; /* index is ID minus one */
8194 didh = highlight_list_arg(id, didh, LIST_ATTR,
8195 sgp->sg_term, NULL, "term");
8196 didh = highlight_list_arg(id, didh, LIST_STRING,
8197 0, sgp->sg_start, "start");
8198 didh = highlight_list_arg(id, didh, LIST_STRING,
8199 0, sgp->sg_stop, "stop");
8201 didh = highlight_list_arg(id, didh, LIST_ATTR,
8202 sgp->sg_cterm, NULL, "cterm");
8203 didh = highlight_list_arg(id, didh, LIST_INT,
8204 sgp->sg_cterm_fg, NULL, "ctermfg");
8205 didh = highlight_list_arg(id, didh, LIST_INT,
8206 sgp->sg_cterm_bg, NULL, "ctermbg");
8208 #ifdef FEAT_GUI
8209 didh = highlight_list_arg(id, didh, LIST_ATTR,
8210 sgp->sg_gui, NULL, "gui");
8211 didh = highlight_list_arg(id, didh, LIST_STRING,
8212 0, sgp->sg_gui_fg_name, "guifg");
8213 didh = highlight_list_arg(id, didh, LIST_STRING,
8214 0, sgp->sg_gui_bg_name, "guibg");
8215 didh = highlight_list_arg(id, didh, LIST_STRING,
8216 0, sgp->sg_gui_sp_name, "guisp");
8217 didh = highlight_list_arg(id, didh, LIST_STRING,
8218 0, sgp->sg_font_name, "font");
8219 #endif
8221 if (sgp->sg_link && !got_int)
8223 (void)syn_list_header(didh, 9999, id);
8224 didh = TRUE;
8225 msg_puts_attr((char_u *)"links to", hl_attr(HLF_D));
8226 msg_putchar(' ');
8227 msg_outtrans(HL_TABLE()[HL_TABLE()[id - 1].sg_link - 1].sg_name);
8230 if (!didh)
8231 highlight_list_arg(id, didh, LIST_STRING, 0, (char_u *)"cleared", "");
8232 #ifdef FEAT_EVAL
8233 if (p_verbose > 0)
8234 last_set_msg(sgp->sg_scriptID);
8235 #endif
8238 static int
8239 highlight_list_arg(id, didh, type, iarg, sarg, name)
8240 int id;
8241 int didh;
8242 int type;
8243 int iarg;
8244 char_u *sarg;
8245 char *name;
8247 char_u buf[100];
8248 char_u *ts;
8249 int i;
8251 if (got_int)
8252 return FALSE;
8253 if (type == LIST_STRING ? (sarg != NULL) : (iarg != 0))
8255 ts = buf;
8256 if (type == LIST_INT)
8257 sprintf((char *)buf, "%d", iarg - 1);
8258 else if (type == LIST_STRING)
8259 ts = sarg;
8260 else /* type == LIST_ATTR */
8262 buf[0] = NUL;
8263 for (i = 0; hl_attr_table[i] != 0; ++i)
8265 if (iarg & hl_attr_table[i])
8267 if (buf[0] != NUL)
8268 STRCAT(buf, ",");
8269 STRCAT(buf, hl_name_table[i]);
8270 iarg &= ~hl_attr_table[i]; /* don't want "inverse" */
8275 (void)syn_list_header(didh,
8276 (int)(vim_strsize(ts) + STRLEN(name) + 1), id);
8277 didh = TRUE;
8278 if (!got_int)
8280 if (*name != NUL)
8282 MSG_PUTS_ATTR(name, hl_attr(HLF_D));
8283 MSG_PUTS_ATTR("=", hl_attr(HLF_D));
8285 msg_outtrans(ts);
8288 return didh;
8291 #if (((defined(FEAT_EVAL) || defined(FEAT_PRINTER))) && defined(FEAT_SYN_HL)) || defined(PROTO)
8293 * Return "1" if highlight group "id" has attribute "flag".
8294 * Return NULL otherwise.
8296 char_u *
8297 highlight_has_attr(id, flag, modec)
8298 int id;
8299 int flag;
8300 int modec; /* 'g' for GUI, 'c' for cterm, 't' for term */
8302 int attr;
8304 if (id <= 0 || id > highlight_ga.ga_len)
8305 return NULL;
8307 #ifdef FEAT_GUI
8308 if (modec == 'g')
8309 attr = HL_TABLE()[id - 1].sg_gui;
8310 else
8311 #endif
8312 if (modec == 'c')
8313 attr = HL_TABLE()[id - 1].sg_cterm;
8314 else
8315 attr = HL_TABLE()[id - 1].sg_term;
8317 if (attr & flag)
8318 return (char_u *)"1";
8319 return NULL;
8321 #endif
8323 #if (defined(FEAT_SYN_HL) && defined(FEAT_EVAL)) || defined(PROTO)
8325 * Return color name of highlight group "id".
8327 char_u *
8328 highlight_color(id, what, modec)
8329 int id;
8330 char_u *what; /* "fg", "bg", "sp", "fg#", "bg#" or "sp#" */
8331 int modec; /* 'g' for GUI, 'c' for cterm, 't' for term */
8333 static char_u name[20];
8334 int n;
8335 int fg = FALSE;
8336 # ifdef FEAT_GUI
8337 int sp = FALSE;
8338 # endif
8340 if (id <= 0 || id > highlight_ga.ga_len)
8341 return NULL;
8343 if (TOLOWER_ASC(what[0]) == 'f')
8344 fg = TRUE;
8345 # ifdef FEAT_GUI
8346 else if (TOLOWER_ASC(what[0]) == 's')
8347 sp = TRUE;
8348 if (modec == 'g')
8350 /* return #RRGGBB form (only possible when GUI is running) */
8351 if (gui.in_use && what[1] && what[2] == '#')
8353 guicolor_T color;
8354 long_u rgb;
8355 static char_u buf[10];
8357 if (fg)
8358 color = HL_TABLE()[id - 1].sg_gui_fg;
8359 else if (sp)
8360 color = HL_TABLE()[id - 1].sg_gui_sp;
8361 else
8362 color = HL_TABLE()[id - 1].sg_gui_bg;
8363 if (color == INVALCOLOR)
8364 return NULL;
8365 rgb = gui_mch_get_rgb(color);
8366 sprintf((char *)buf, "#%02x%02x%02x",
8367 (unsigned)(rgb >> 16),
8368 (unsigned)(rgb >> 8) & 255,
8369 (unsigned)rgb & 255);
8370 return buf;
8372 if (fg)
8373 return (HL_TABLE()[id - 1].sg_gui_fg_name);
8374 if (sp)
8375 return (HL_TABLE()[id - 1].sg_gui_sp_name);
8376 return (HL_TABLE()[id - 1].sg_gui_bg_name);
8378 # endif
8379 if (modec == 'c')
8381 if (fg)
8382 n = HL_TABLE()[id - 1].sg_cterm_fg - 1;
8383 else
8384 n = HL_TABLE()[id - 1].sg_cterm_bg - 1;
8385 sprintf((char *)name, "%d", n);
8386 return name;
8388 /* term doesn't have color */
8389 return NULL;
8391 #endif
8393 #if (defined(FEAT_SYN_HL) && defined(FEAT_GUI) && defined(FEAT_PRINTER)) \
8394 || defined(PROTO)
8396 * Return color name of highlight group "id" as RGB value.
8398 long_u
8399 highlight_gui_color_rgb(id, fg)
8400 int id;
8401 int fg; /* TRUE = fg, FALSE = bg */
8403 guicolor_T color;
8405 if (id <= 0 || id > highlight_ga.ga_len)
8406 return 0L;
8408 if (fg)
8409 color = HL_TABLE()[id - 1].sg_gui_fg;
8410 else
8411 color = HL_TABLE()[id - 1].sg_gui_bg;
8413 if (color == INVALCOLOR)
8414 return 0L;
8416 return gui_mch_get_rgb(color);
8418 #endif
8421 * Output the syntax list header.
8422 * Return TRUE when started a new line.
8424 static int
8425 syn_list_header(did_header, outlen, id)
8426 int did_header; /* did header already */
8427 int outlen; /* length of string that comes */
8428 int id; /* highlight group id */
8430 int endcol = 19;
8431 int newline = TRUE;
8433 if (!did_header)
8435 msg_putchar('\n');
8436 if (got_int)
8437 return TRUE;
8438 msg_outtrans(HL_TABLE()[id - 1].sg_name);
8439 endcol = 15;
8441 else if (msg_col + outlen + 1 >= Columns)
8443 msg_putchar('\n');
8444 if (got_int)
8445 return TRUE;
8447 else
8449 if (msg_col >= endcol) /* wrap around is like starting a new line */
8450 newline = FALSE;
8453 if (msg_col >= endcol) /* output at least one space */
8454 endcol = msg_col + 1;
8455 if (Columns <= endcol) /* avoid hang for tiny window */
8456 endcol = Columns - 1;
8458 msg_advance(endcol);
8460 /* Show "xxx" with the attributes. */
8461 if (!did_header)
8463 msg_puts_attr((char_u *)"xxx", syn_id2attr(id));
8464 msg_putchar(' ');
8467 return newline;
8471 * Set the attribute numbers for a highlight group.
8472 * Called after one of the attributes has changed.
8474 static void
8475 set_hl_attr(idx)
8476 int idx; /* index in array */
8478 attrentry_T at_en;
8479 struct hl_group *sgp = HL_TABLE() + idx;
8481 /* The "Normal" group doesn't need an attribute number */
8482 if (sgp->sg_name_u != NULL && STRCMP(sgp->sg_name_u, "NORMAL") == 0)
8483 return;
8485 #ifdef FEAT_GUI
8487 * For the GUI mode: If there are other than "normal" highlighting
8488 * attributes, need to allocate an attr number.
8490 if (sgp->sg_gui_fg == INVALCOLOR
8491 && sgp->sg_gui_bg == INVALCOLOR
8492 && sgp->sg_gui_sp == INVALCOLOR
8493 && sgp->sg_font == NOFONT
8494 # ifdef FEAT_XFONTSET
8495 && sgp->sg_fontset == NOFONTSET
8496 # endif
8499 sgp->sg_gui_attr = sgp->sg_gui;
8501 else
8503 at_en.ae_attr = sgp->sg_gui;
8504 at_en.ae_u.gui.fg_color = sgp->sg_gui_fg;
8505 at_en.ae_u.gui.bg_color = sgp->sg_gui_bg;
8506 at_en.ae_u.gui.sp_color = sgp->sg_gui_sp;
8507 at_en.ae_u.gui.font = sgp->sg_font;
8508 # ifdef FEAT_XFONTSET
8509 at_en.ae_u.gui.fontset = sgp->sg_fontset;
8510 # endif
8511 sgp->sg_gui_attr = get_attr_entry(&gui_attr_table, &at_en);
8513 #endif
8515 * For the term mode: If there are other than "normal" highlighting
8516 * attributes, need to allocate an attr number.
8518 if (sgp->sg_start == NULL && sgp->sg_stop == NULL)
8519 sgp->sg_term_attr = sgp->sg_term;
8520 else
8522 at_en.ae_attr = sgp->sg_term;
8523 at_en.ae_u.term.start = sgp->sg_start;
8524 at_en.ae_u.term.stop = sgp->sg_stop;
8525 sgp->sg_term_attr = get_attr_entry(&term_attr_table, &at_en);
8529 * For the color term mode: If there are other than "normal"
8530 * highlighting attributes, need to allocate an attr number.
8532 if (sgp->sg_cterm_fg == 0 && sgp->sg_cterm_bg == 0)
8533 sgp->sg_cterm_attr = sgp->sg_cterm;
8534 else
8536 at_en.ae_attr = sgp->sg_cterm;
8537 at_en.ae_u.cterm.fg_color = sgp->sg_cterm_fg;
8538 at_en.ae_u.cterm.bg_color = sgp->sg_cterm_bg;
8539 sgp->sg_cterm_attr = get_attr_entry(&cterm_attr_table, &at_en);
8544 * Lookup a highlight group name and return it's ID.
8545 * If it is not found, 0 is returned.
8548 syn_name2id(name)
8549 char_u *name;
8551 int i;
8552 char_u name_u[200];
8554 /* Avoid using stricmp() too much, it's slow on some systems */
8555 /* Avoid alloc()/free(), these are slow too. ID names over 200 chars
8556 * don't deserve to be found! */
8557 vim_strncpy(name_u, name, 199);
8558 vim_strup(name_u);
8559 for (i = highlight_ga.ga_len; --i >= 0; )
8560 if (HL_TABLE()[i].sg_name_u != NULL
8561 && STRCMP(name_u, HL_TABLE()[i].sg_name_u) == 0)
8562 break;
8563 return i + 1;
8566 #if defined(FEAT_EVAL) || defined(PROTO)
8568 * Return TRUE if highlight group "name" exists.
8571 highlight_exists(name)
8572 char_u *name;
8574 return (syn_name2id(name) > 0);
8577 # if defined(FEAT_SEARCH_EXTRA) || defined(PROTO)
8579 * Return the name of highlight group "id".
8580 * When not a valid ID return an empty string.
8582 char_u *
8583 syn_id2name(id)
8584 int id;
8586 if (id <= 0 || id > highlight_ga.ga_len)
8587 return (char_u *)"";
8588 return HL_TABLE()[id - 1].sg_name;
8590 # endif
8591 #endif
8594 * Like syn_name2id(), but take a pointer + length argument.
8597 syn_namen2id(linep, len)
8598 char_u *linep;
8599 int len;
8601 char_u *name;
8602 int id = 0;
8604 name = vim_strnsave(linep, len);
8605 if (name != NULL)
8607 id = syn_name2id(name);
8608 vim_free(name);
8610 return id;
8614 * Find highlight group name in the table and return it's ID.
8615 * The argument is a pointer to the name and the length of the name.
8616 * If it doesn't exist yet, a new entry is created.
8617 * Return 0 for failure.
8620 syn_check_group(pp, len)
8621 char_u *pp;
8622 int len;
8624 int id;
8625 char_u *name;
8627 name = vim_strnsave(pp, len);
8628 if (name == NULL)
8629 return 0;
8631 id = syn_name2id(name);
8632 if (id == 0) /* doesn't exist yet */
8633 id = syn_add_group(name);
8634 else
8635 vim_free(name);
8636 return id;
8640 * Add new highlight group and return it's ID.
8641 * "name" must be an allocated string, it will be consumed.
8642 * Return 0 for failure.
8644 static int
8645 syn_add_group(name)
8646 char_u *name;
8648 char_u *p;
8650 /* Check that the name is ASCII letters, digits and underscore. */
8651 for (p = name; *p != NUL; ++p)
8653 if (!vim_isprintc(*p))
8655 EMSG(_("E669: Unprintable character in group name"));
8656 vim_free(name);
8657 return 0;
8659 else if (!ASCII_ISALNUM(*p) && *p != '_')
8661 /* This is an error, but since there previously was no check only
8662 * give a warning. */
8663 msg_source(hl_attr(HLF_W));
8664 MSG(_("W18: Invalid character in group name"));
8665 break;
8670 * First call for this growarray: init growing array.
8672 if (highlight_ga.ga_data == NULL)
8674 highlight_ga.ga_itemsize = sizeof(struct hl_group);
8675 highlight_ga.ga_growsize = 10;
8679 * Make room for at least one other syntax_highlight entry.
8681 if (ga_grow(&highlight_ga, 1) == FAIL)
8683 vim_free(name);
8684 return 0;
8687 vim_memset(&(HL_TABLE()[highlight_ga.ga_len]), 0, sizeof(struct hl_group));
8688 HL_TABLE()[highlight_ga.ga_len].sg_name = name;
8689 HL_TABLE()[highlight_ga.ga_len].sg_name_u = vim_strsave_up(name);
8690 #ifdef FEAT_GUI
8691 HL_TABLE()[highlight_ga.ga_len].sg_gui_bg = INVALCOLOR;
8692 HL_TABLE()[highlight_ga.ga_len].sg_gui_fg = INVALCOLOR;
8693 HL_TABLE()[highlight_ga.ga_len].sg_gui_sp = INVALCOLOR;
8694 #endif
8695 ++highlight_ga.ga_len;
8697 return highlight_ga.ga_len; /* ID is index plus one */
8701 * When, just after calling syn_add_group(), an error is discovered, this
8702 * function deletes the new name.
8704 static void
8705 syn_unadd_group()
8707 --highlight_ga.ga_len;
8708 vim_free(HL_TABLE()[highlight_ga.ga_len].sg_name);
8709 vim_free(HL_TABLE()[highlight_ga.ga_len].sg_name_u);
8713 * Translate a group ID to highlight attributes.
8716 syn_id2attr(hl_id)
8717 int hl_id;
8719 int attr;
8720 struct hl_group *sgp;
8722 hl_id = syn_get_final_id(hl_id);
8723 sgp = &HL_TABLE()[hl_id - 1]; /* index is ID minus one */
8725 #ifdef FEAT_GUI
8727 * Only use GUI attr when the GUI is being used.
8729 if (gui.in_use)
8730 attr = sgp->sg_gui_attr;
8731 else
8732 #endif
8733 if (t_colors > 1)
8734 attr = sgp->sg_cterm_attr;
8735 else
8736 attr = sgp->sg_term_attr;
8738 return attr;
8741 #ifdef FEAT_GUI
8743 * Get the GUI colors and attributes for a group ID.
8744 * NOTE: the colors will be INVALCOLOR when not set, the color otherwise.
8747 syn_id2colors(hl_id, fgp, bgp)
8748 int hl_id;
8749 guicolor_T *fgp;
8750 guicolor_T *bgp;
8752 struct hl_group *sgp;
8754 hl_id = syn_get_final_id(hl_id);
8755 sgp = &HL_TABLE()[hl_id - 1]; /* index is ID minus one */
8757 *fgp = sgp->sg_gui_fg;
8758 *bgp = sgp->sg_gui_bg;
8759 return sgp->sg_gui;
8761 #endif
8764 * Translate a group ID to the final group ID (following links).
8767 syn_get_final_id(hl_id)
8768 int hl_id;
8770 int count;
8771 struct hl_group *sgp;
8773 if (hl_id > highlight_ga.ga_len || hl_id < 1)
8774 return 0; /* Can be called from eval!! */
8777 * Follow links until there is no more.
8778 * Look out for loops! Break after 100 links.
8780 for (count = 100; --count >= 0; )
8782 sgp = &HL_TABLE()[hl_id - 1]; /* index is ID minus one */
8783 if (sgp->sg_link == 0 || sgp->sg_link > highlight_ga.ga_len)
8784 break;
8785 hl_id = sgp->sg_link;
8788 return hl_id;
8791 #ifdef FEAT_GUI
8793 * Call this function just after the GUI has started.
8794 * It finds the font and color handles for the highlighting groups.
8796 void
8797 highlight_gui_started()
8799 int idx;
8801 /* First get the colors from the "Normal" and "Menu" group, if set */
8802 set_normal_colors();
8804 for (idx = 0; idx < highlight_ga.ga_len; ++idx)
8805 gui_do_one_color(idx, FALSE, FALSE);
8807 highlight_changed();
8810 static void
8811 gui_do_one_color(idx, do_menu, do_tooltip)
8812 int idx;
8813 int do_menu; /* TRUE: might set the menu font */
8814 int do_tooltip; /* TRUE: might set the tooltip font */
8816 int didit = FALSE;
8818 if (HL_TABLE()[idx].sg_font_name != NULL)
8820 hl_do_font(idx, HL_TABLE()[idx].sg_font_name, FALSE, do_menu,
8821 do_tooltip);
8822 didit = TRUE;
8824 if (HL_TABLE()[idx].sg_gui_fg_name != NULL)
8826 HL_TABLE()[idx].sg_gui_fg =
8827 color_name2handle(HL_TABLE()[idx].sg_gui_fg_name);
8828 didit = TRUE;
8830 if (HL_TABLE()[idx].sg_gui_bg_name != NULL)
8832 HL_TABLE()[idx].sg_gui_bg =
8833 color_name2handle(HL_TABLE()[idx].sg_gui_bg_name);
8834 didit = TRUE;
8836 if (HL_TABLE()[idx].sg_gui_sp_name != NULL)
8838 HL_TABLE()[idx].sg_gui_sp =
8839 color_name2handle(HL_TABLE()[idx].sg_gui_sp_name);
8840 didit = TRUE;
8842 if (didit) /* need to get a new attr number */
8843 set_hl_attr(idx);
8846 #endif
8849 * Translate the 'highlight' option into attributes in highlight_attr[] and
8850 * set up the user highlights User1..9. If FEAT_STL_OPT is in use, a set of
8851 * corresponding highlights to use on top of HLF_SNC is computed.
8852 * Called only when the 'highlight' option has been changed and upon first
8853 * screen redraw after any :highlight command.
8854 * Return FAIL when an invalid flag is found in 'highlight'. OK otherwise.
8857 highlight_changed()
8859 int hlf;
8860 int i;
8861 char_u *p;
8862 int attr;
8863 char_u *end;
8864 int id;
8865 #ifdef USER_HIGHLIGHT
8866 char_u userhl[10];
8867 # ifdef FEAT_STL_OPT
8868 int id_SNC = -1;
8869 int id_S = -1;
8870 int hlcnt;
8871 # endif
8872 #endif
8873 static int hl_flags[HLF_COUNT] = HL_FLAGS;
8875 need_highlight_changed = FALSE;
8878 * Clear all attributes.
8880 for (hlf = 0; hlf < (int)HLF_COUNT; ++hlf)
8881 highlight_attr[hlf] = 0;
8884 * First set all attributes to their default value.
8885 * Then use the attributes from the 'highlight' option.
8887 for (i = 0; i < 2; ++i)
8889 if (i)
8890 p = p_hl;
8891 else
8892 p = get_highlight_default();
8893 if (p == NULL) /* just in case */
8894 continue;
8896 while (*p)
8898 for (hlf = 0; hlf < (int)HLF_COUNT; ++hlf)
8899 if (hl_flags[hlf] == *p)
8900 break;
8901 ++p;
8902 if (hlf == (int)HLF_COUNT || *p == NUL)
8903 return FAIL;
8906 * Allow several hl_flags to be combined, like "bu" for
8907 * bold-underlined.
8909 attr = 0;
8910 for ( ; *p && *p != ','; ++p) /* parse upto comma */
8912 if (vim_iswhite(*p)) /* ignore white space */
8913 continue;
8915 if (attr > HL_ALL) /* Combination with ':' is not allowed. */
8916 return FAIL;
8918 switch (*p)
8920 case 'b': attr |= HL_BOLD;
8921 break;
8922 case 'i': attr |= HL_ITALIC;
8923 break;
8924 case '-':
8925 case 'n': /* no highlighting */
8926 break;
8927 case 'r': attr |= HL_INVERSE;
8928 break;
8929 case 's': attr |= HL_STANDOUT;
8930 break;
8931 case 'u': attr |= HL_UNDERLINE;
8932 break;
8933 case 'c': attr |= HL_UNDERCURL;
8934 break;
8935 case ':': ++p; /* highlight group name */
8936 if (attr || *p == NUL) /* no combinations */
8937 return FAIL;
8938 end = vim_strchr(p, ',');
8939 if (end == NULL)
8940 end = p + STRLEN(p);
8941 id = syn_check_group(p, (int)(end - p));
8942 if (id == 0)
8943 return FAIL;
8944 attr = syn_id2attr(id);
8945 p = end - 1;
8946 #if defined(FEAT_STL_OPT) && defined(USER_HIGHLIGHT)
8947 if (hlf == (int)HLF_SNC)
8948 id_SNC = syn_get_final_id(id);
8949 else if (hlf == (int)HLF_S)
8950 id_S = syn_get_final_id(id);
8951 #endif
8952 break;
8953 default: return FAIL;
8956 highlight_attr[hlf] = attr;
8958 p = skip_to_option_part(p); /* skip comma and spaces */
8962 #ifdef USER_HIGHLIGHT
8963 /* Setup the user highlights
8965 * Temporarily utilize 10 more hl entries. Have to be in there
8966 * simultaneously in case of table overflows in get_attr_entry()
8968 # ifdef FEAT_STL_OPT
8969 if (ga_grow(&highlight_ga, 10) == FAIL)
8970 return FAIL;
8971 hlcnt = highlight_ga.ga_len;
8972 if (id_S == 0)
8973 { /* Make sure id_S is always valid to simplify code below */
8974 memset(&HL_TABLE()[hlcnt + 9], 0, sizeof(struct hl_group));
8975 HL_TABLE()[hlcnt + 9].sg_term = highlight_attr[HLF_S];
8976 id_S = hlcnt + 10;
8978 # endif
8979 for (i = 0; i < 9; i++)
8981 sprintf((char *)userhl, "User%d", i + 1);
8982 id = syn_name2id(userhl);
8983 if (id == 0)
8985 highlight_user[i] = 0;
8986 # ifdef FEAT_STL_OPT
8987 highlight_stlnc[i] = 0;
8988 # endif
8990 else
8992 # ifdef FEAT_STL_OPT
8993 struct hl_group *hlt = HL_TABLE();
8994 # endif
8996 highlight_user[i] = syn_id2attr(id);
8997 # ifdef FEAT_STL_OPT
8998 if (id_SNC == 0)
9000 memset(&hlt[hlcnt + i], 0, sizeof(struct hl_group));
9001 hlt[hlcnt + i].sg_term = highlight_attr[HLF_SNC];
9002 hlt[hlcnt + i].sg_cterm = highlight_attr[HLF_SNC];
9003 # ifdef FEAT_GUI
9004 hlt[hlcnt + i].sg_gui = highlight_attr[HLF_SNC];
9005 # endif
9007 else
9008 mch_memmove(&hlt[hlcnt + i],
9009 &hlt[id_SNC - 1],
9010 sizeof(struct hl_group));
9011 hlt[hlcnt + i].sg_link = 0;
9013 /* Apply difference between UserX and HLF_S to HLF_SNC */
9014 hlt[hlcnt + i].sg_term ^=
9015 hlt[id - 1].sg_term ^ hlt[id_S - 1].sg_term;
9016 if (hlt[id - 1].sg_start != hlt[id_S - 1].sg_start)
9017 hlt[hlcnt + i].sg_start = hlt[id - 1].sg_start;
9018 if (hlt[id - 1].sg_stop != hlt[id_S - 1].sg_stop)
9019 hlt[hlcnt + i].sg_stop = hlt[id - 1].sg_stop;
9020 hlt[hlcnt + i].sg_cterm ^=
9021 hlt[id - 1].sg_cterm ^ hlt[id_S - 1].sg_cterm;
9022 if (hlt[id - 1].sg_cterm_fg != hlt[id_S - 1].sg_cterm_fg)
9023 hlt[hlcnt + i].sg_cterm_fg = hlt[id - 1].sg_cterm_fg;
9024 if (hlt[id - 1].sg_cterm_bg != hlt[id_S - 1].sg_cterm_bg)
9025 hlt[hlcnt + i].sg_cterm_bg = hlt[id - 1].sg_cterm_bg;
9026 # ifdef FEAT_GUI
9027 hlt[hlcnt + i].sg_gui ^=
9028 hlt[id - 1].sg_gui ^ hlt[id_S - 1].sg_gui;
9029 if (hlt[id - 1].sg_gui_fg != hlt[id_S - 1].sg_gui_fg)
9030 hlt[hlcnt + i].sg_gui_fg = hlt[id - 1].sg_gui_fg;
9031 if (hlt[id - 1].sg_gui_bg != hlt[id_S - 1].sg_gui_bg)
9032 hlt[hlcnt + i].sg_gui_bg = hlt[id - 1].sg_gui_bg;
9033 if (hlt[id - 1].sg_gui_sp != hlt[id_S - 1].sg_gui_sp)
9034 hlt[hlcnt + i].sg_gui_sp = hlt[id - 1].sg_gui_sp;
9035 if (hlt[id - 1].sg_font != hlt[id_S - 1].sg_font)
9036 hlt[hlcnt + i].sg_font = hlt[id - 1].sg_font;
9037 # ifdef FEAT_XFONTSET
9038 if (hlt[id - 1].sg_fontset != hlt[id_S - 1].sg_fontset)
9039 hlt[hlcnt + i].sg_fontset = hlt[id - 1].sg_fontset;
9040 # endif
9041 # endif
9042 highlight_ga.ga_len = hlcnt + i + 1;
9043 set_hl_attr(hlcnt + i); /* At long last we can apply */
9044 highlight_stlnc[i] = syn_id2attr(hlcnt + i + 1);
9045 # endif
9048 # ifdef FEAT_STL_OPT
9049 highlight_ga.ga_len = hlcnt;
9050 # endif
9052 #endif /* USER_HIGHLIGHT */
9054 return OK;
9057 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9059 static void highlight_list __ARGS((void));
9060 static void highlight_list_two __ARGS((int cnt, int attr));
9063 * Handle command line completion for :highlight command.
9065 void
9066 set_context_in_highlight_cmd(xp, arg)
9067 expand_T *xp;
9068 char_u *arg;
9070 char_u *p;
9072 /* Default: expand group names */
9073 xp->xp_context = EXPAND_HIGHLIGHT;
9074 xp->xp_pattern = arg;
9075 include_link = 2;
9076 include_default = 1;
9078 /* (part of) subcommand already typed */
9079 if (*arg != NUL)
9081 p = skiptowhite(arg);
9082 if (*p != NUL) /* past "default" or group name */
9084 include_default = 0;
9085 if (STRNCMP("default", arg, p - arg) == 0)
9087 arg = skipwhite(p);
9088 xp->xp_pattern = arg;
9089 p = skiptowhite(arg);
9091 if (*p != NUL) /* past group name */
9093 include_link = 0;
9094 if (arg[1] == 'i' && arg[0] == 'N')
9095 highlight_list();
9096 if (STRNCMP("link", arg, p - arg) == 0
9097 || STRNCMP("clear", arg, p - arg) == 0)
9099 xp->xp_pattern = skipwhite(p);
9100 p = skiptowhite(xp->xp_pattern);
9101 if (*p != NUL) /* past first group name */
9103 xp->xp_pattern = skipwhite(p);
9104 p = skiptowhite(xp->xp_pattern);
9107 if (*p != NUL) /* past group name(s) */
9108 xp->xp_context = EXPAND_NOTHING;
9115 * List highlighting matches in a nice way.
9117 static void
9118 highlight_list()
9120 int i;
9122 for (i = 10; --i >= 0; )
9123 highlight_list_two(i, hl_attr(HLF_D));
9124 for (i = 40; --i >= 0; )
9125 highlight_list_two(99, 0);
9128 static void
9129 highlight_list_two(cnt, attr)
9130 int cnt;
9131 int attr;
9133 msg_puts_attr((char_u *)("N \bI \b! \b" + cnt / 11), attr);
9134 msg_clr_eos();
9135 out_flush();
9136 ui_delay(cnt == 99 ? 40L : (long)cnt * 50L, FALSE);
9139 #endif /* FEAT_CMDL_COMPL */
9141 #if defined(FEAT_CMDL_COMPL) || (defined(FEAT_SYN_HL) && defined(FEAT_EVAL)) \
9142 || defined(FEAT_SIGNS) || defined(PROTO)
9144 * Function given to ExpandGeneric() to obtain the list of group names.
9145 * Also used for synIDattr() function.
9147 char_u *
9148 get_highlight_name(xp, idx)
9149 expand_T *xp UNUSED;
9150 int idx;
9152 #ifdef FEAT_CMDL_COMPL
9153 if (idx == highlight_ga.ga_len && include_none != 0)
9154 return (char_u *)"none";
9155 if (idx == highlight_ga.ga_len + include_none && include_default != 0)
9156 return (char_u *)"default";
9157 if (idx == highlight_ga.ga_len + include_none + include_default
9158 && include_link != 0)
9159 return (char_u *)"link";
9160 if (idx == highlight_ga.ga_len + include_none + include_default + 1
9161 && include_link != 0)
9162 return (char_u *)"clear";
9163 #endif
9164 if (idx < 0 || idx >= highlight_ga.ga_len)
9165 return NULL;
9166 return HL_TABLE()[idx].sg_name;
9168 #endif
9170 #if defined(FEAT_GUI) || defined(PROTO)
9172 * Free all the highlight group fonts.
9173 * Used when quitting for systems which need it.
9175 void
9176 free_highlight_fonts()
9178 int idx;
9180 for (idx = 0; idx < highlight_ga.ga_len; ++idx)
9182 gui_mch_free_font(HL_TABLE()[idx].sg_font);
9183 HL_TABLE()[idx].sg_font = NOFONT;
9184 # ifdef FEAT_XFONTSET
9185 gui_mch_free_fontset(HL_TABLE()[idx].sg_fontset);
9186 HL_TABLE()[idx].sg_fontset = NOFONTSET;
9187 # endif
9190 gui_mch_free_font(gui.norm_font);
9191 # ifdef FEAT_XFONTSET
9192 gui_mch_free_fontset(gui.fontset);
9193 # endif
9194 # ifndef HAVE_GTK2
9195 gui_mch_free_font(gui.bold_font);
9196 gui_mch_free_font(gui.ital_font);
9197 gui_mch_free_font(gui.boldital_font);
9198 # endif
9200 #endif
9202 /**************************************
9203 * End of Highlighting stuff *
9204 **************************************/