Support all of Vim's syntax groups

This allows for much more detailed highlighting.

This implementation is a general solution to a hack we've been
using in the vim-perl test suite.

lib/Text/VimColor.pm

@@ -28,19 +28,6 @@ our %VIM_LET = (
    'b:is_bash' => 1,
 );
 
-our %SYNTAX_TYPE = (
-   Comment    => 1,
-   Constant   => 1,
-   Identifier => 1,
-   Statement  => 1,
-   PreProc    => 1,
-   Type       => 1,
-   Special    => 1,
-   Underlined => 1,
-   Error      => 1,
-   Todo       => 1,
-);
-
 our %ANSI_COLORS = (
    Comment    =>  'blue',
    Constant   =>  'red',
@@ -50,16 +37,48 @@ our %ANSI_COLORS = (
    Type       =>  'green',
    Special    =>  'bright_magenta',
    Underlined =>  'underline',
+   Ignore     =>  'bright_white',
    Error      =>  'on_red',
    Todo       =>  'on_cyan',
 );
 
+# These extra syntax group are available but linked to the groups above by
+# default in vim. They'll get their own highlighting if the user unlinks them.
+$ANSI_COLORS{String}         = $ANSI_COLORS{Constant};
+$ANSI_COLORS{Character}      = $ANSI_COLORS{Constant};
+$ANSI_COLORS{Number}         = $ANSI_COLORS{Constant};
+$ANSI_COLORS{Boolean}        = $ANSI_COLORS{Constant};
+$ANSI_COLORS{Float}          = $ANSI_COLORS{Constant};
+$ANSI_COLORS{Function}       = $ANSI_COLORS{Identifier};
+$ANSI_COLORS{Conditional}    = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Repeat}         = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Label}          = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Operator}       = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Keyword}        = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Exception}      = $ANSI_COLORS{Statement};
+$ANSI_COLORS{Include}        = $ANSI_COLORS{PreProc};
+$ANSI_COLORS{Define}         = $ANSI_COLORS{PreProc};
+$ANSI_COLORS{Macro}          = $ANSI_COLORS{PreProc};
+$ANSI_COLORS{PreCondit}      = $ANSI_COLORS{PreProc};
+$ANSI_COLORS{StorageClass}   = $ANSI_COLORS{Type};
+$ANSI_COLORS{Structure}      = $ANSI_COLORS{Type};
+$ANSI_COLORS{Typedef}        = $ANSI_COLORS{Type};
+$ANSI_COLORS{Tag}            = $ANSI_COLORS{Special};
+$ANSI_COLORS{SpecialChar}    = $ANSI_COLORS{Special};
+$ANSI_COLORS{Delimiter}      = $ANSI_COLORS{Special};
+$ANSI_COLORS{SpecialComment} = $ANSI_COLORS{Special};
+$ANSI_COLORS{Debug}          = $ANSI_COLORS{Special};
+
+our %SYNTAX_TYPE;
+%SYNTAX_TYPE = map { $_ => 1 } %ANSI_COLORS;
+
 # Set to true to print the command line used to run Vim.
 our $DEBUG = $ENV{TEXT_VIMCOLOR_DEBUG};
 
 sub new {
   my $class = shift;
   my $self = {
+    all_syntax_groups      => 0,
     extra_vim_options      => [],
     html_inline_stylesheet => 1,
     xml_root_element       => 1,
@@ -155,9 +174,9 @@ sub ansi
   # compared to join/map or foreach/my this benched as the fastest:
   my $ansi = '';
   for ( @$syntax ){
-    $ansi .= $_->[0] eq ''
-      ? $_->[1]
-      : Term::ANSIColor::colored([ $colors{ $_->[0] } ], $_->[1]);
+    $ansi .= $colors{$_->[0]}
+      ? Term::ANSIColor::colored([ $colors{ $_->[0] } ], $_->[1])
+      : $_->[1];
   }
 
    return $ansi;
@@ -304,6 +323,7 @@ sub _do_markup
 {
    my ($self) = @_;
    my $vim_syntax_script = $self->dist_file('mark.vim');
+   my $vim_define_all = $self->dist_file('define_all.vim');
 
    croak "Text::VimColor syntax script '$vim_syntax_script' not installed"
       unless -f $vim_syntax_script && -r $vim_syntax_script;
@@ -395,6 +415,7 @@ sub _do_markup
 
       ':filetype on',
        $filetype_set,
+       $self->{all_syntax_groups} ? ":source $vim_define_all" : (),
       ":source $vim_syntax_script",
       ":write! $out_filename",
       ':qall!',
@@ -448,9 +469,6 @@ sub _add_markup
 {
    my ($syntax, $type, $text) = @_;
 
-   # TODO: make this optional
-   # (https://github.com/petdance/vim-perl/blob/master/t/01_highlighting.t#L12)
-
    # Ignore types we don't know about.  At least one syntax file (xml.vim)
    # can produce these.  It happens when a syntax type isn't 'linked' to
    # one of the predefined types.
@@ -618,6 +636,55 @@ This option, whether or not it is passed to L</new>, can be overridden
 when calling L</syntax_mark_file> and L</syntax_mark_string>, so you can
 use the same object to process multiple files of different types.
 
+=item all_syntax_groups
+
+By default, this option is disabled. That means that the highlighting will
+only use the following syntax groups:
+
+  Comment
+  Constant
+  Identifier
+  Statement
+  PreProc
+  Type
+  Special
+  Underlined
+  Ignore
+  Error
+  Todo
+
+This mirrors vim's default behavior of linking more specific syntax groups
+to the main groups above. However, most syntax files support more specific
+groups, so if you want to benefit from finer-grained syntax highlighting
+you can turn on this option. The additional syntax groups are:
+
+  Group             Linked to by default
+  ---------------------------------------
+  String            Constant
+  Character         Constant
+  Number            Constant
+  Boolean           Constant
+  Float             Constant
+  Function          Identifier
+  Conditional       Statement
+  Repeat            Statement
+  Label             Statement
+  Operator          Statement
+  Keyword           Statement
+  Exception         Statement
+  Include           PreProc
+  Define            PreProc
+  Macro             PreProc
+  PreCondit         PreProc
+  StorageClass      Type
+  Structure         Type
+  Typedef           Type
+  Tag               Special
+  SpecialChar       Special
+  Delimiter         Special
+  SpecialComment    Special
+  Debug             Special
+
 =item html_full_page
 
 By default the L</html> output method returns a fragment of HTML, not a

share/define_all.vim

@@ -0,0 +1,39 @@
+" Vim color file
+"
+" This is a dummy color file that defines a color for every syntax class.
+
+hi Normal           ctermfg=7
+hi Comment          ctermfg=7
+hi Constant         ctermfg=7
+hi Special          ctermfg=7
+hi Identifier       ctermfg=7
+hi Statement        ctermfg=7
+hi PreProc          ctermfg=7
+hi Type             ctermfg=7
+hi Underlined       ctermfg=7
+hi Ignore           ctermfg=7
+hi Error            ctermfg=7
+hi Todo             ctermfg=7
+hi String           ctermfg=7
+hi Character        ctermfg=7
+hi Number           ctermfg=7
+hi Boolean          ctermfg=7
+hi Float            ctermfg=7
+hi Function         ctermfg=7
+hi Conditional      ctermfg=7
+hi Repeat           ctermfg=7
+hi Label            ctermfg=7
+hi Operator         ctermfg=7
+hi Keyword          ctermfg=7
+hi Exception        ctermfg=7
+hi Include          ctermfg=7
+hi Define           ctermfg=7
+hi Macro            ctermfg=7
+hi PreCondit        ctermfg=7
+hi StorageClass     ctermfg=7
+hi Typedef          ctermfg=7
+hi Tag              ctermfg=7
+hi SpecialChar      ctermfg=7
+hi Delimiter        ctermfg=7
+hi SpecialComment   ctermfg=7
+hi Debug            ctermfg=7

t/all-syntax-groups.t

@@ -0,0 +1,23 @@
+# Test that additional syntax groups get activated with all_syntax_groups => 1
+
+use strict;
+use warnings;
+use Test::More;
+use lib 't/lib';
+use TVC_Test;
+
+plan tests => 2;
+
+my $linked = Text::VimColor->new(
+    string   => "()",
+    filetype => 'vim',
+)->marked;
+
+my $unlinked = Text::VimColor->new(
+    all_syntax_groups => 1,
+    string            => "()",
+    filetype          => 'vim',
+)->marked;
+
+is($linked->[0][0], 'Special', 'The Delimiter group is linked to Special by default');
+is($unlinked->[0][0], 'Delimiter', 'The Delimiter group is used if it has its own coloring');