
=head1 NAME

Tk::TextHighlight - a TextUndo widget with syntax highlighting capabilities.

Tk::ROTextHighlight - a Read-only Text widget with syntax highlighting capabilities.

=head1 SYNOPSIS

=over 4

 use Tk;
 my $haveKateInstalled = 0;
 eval "use Syntax::Highlight::Engine::Kate; \$haveKateInstalled = 1; 1";

 require Tk::TextHighlight;

 my $m = new MainWindow;

 my $e = $m->Scrolled("TextHighlight",
    -syntax => "Perl",
    -scrollbars => "se",
 )->pack(-expand => 1, -fill => "both");

 if ($haveKateInstalled) {
  my ($sections, $kateExtensions) = $e->fetchKateInfo;
  $e->addKate2ViewMenu($sections);
 }
 $m->configure(-menu => $e->menu);
 $m->MainLoop;

=back

=head1 DESCRIPTION

Tk::TextHighlight inherits Tk::TextUndo and all its options and methods. Besides
syntax highlighting, methods are provided for commenting and uncommenting
as well as indenting and unindenting a selected area, matching pairs of braces, brackets and
brackets and curlies and automatic indenting of new lines.

If you want your widget to be read-only, then B<require Tk::ROTextHighlight>, which 
is based on B<Tk::ROText> instead of B<Tk::TextUndo>.

Syntax highlighting is done through a plugin approach. Adding languages 
is a matter of writing plugin modules. Theoretically this is not limited to programming languages. 
The plugin approach could also provide the possibility for grammar or spell checking in spoken 
languages.

Currently there is support for B<Bash>, B<HTML>, B<Perl>, B<Pod>, B<Kate>, and B<Xresources>.

=head1 OPTIONS

=over 4

=item Name: B<autoindent>

=item Class: B<Autoindent>

=item Switch: B<-autoindent>

Boolean, when you press the enter button, should the next line begin at the
same position as the current line or not. By default B<false>.

=item Name: B<commentchar>

=item Class: B<Commentchar>

=item Switch: B<-commentchar>

By default "#".

=item Name: B<disablemenu> 

=item Class: B<Disablemenu>

=item Switch: B<-disablemenu>

Boolean, by default 0. In case you don't want the menu under the
right mouse button to pop up.

=item Name: B<highlightInBackground>

=item Class: B<highlightInBackground>

=item Switch: B<-highlightInBackground>

Whether or not to do highlighting in background freeing up the mouse and 
keyboard for most events (experimental).  May be 1 or 0.  Default 0 (Do not 
highlight in background - block input until highlighting completed).

=item Name: B<indentchar>

=item Class: B<Indentchar>

=item Switch: B<-indentchar>

String to be inserted when the [Tab] key is pressed or when indenting.
Default "\t".

=item Name: B<match>

=item Class: B<Match>

=item Switch: B<-match>

string of pairs for brace/bracket/curlie etc matching. If this description
doesn't make anything clear, don't worry, the default setting will:

 '[]{}()'

if you don't want matching to be available, simply set it to ''.

=item Name: B<matchoptions>

=item Class: B<Matchoptions>

=item Switch: B<-matchoptions>

Options list for the tag 'Match'. By default:

 [-background => 'red', -foreground => 'yellow']

You can also specify this option as a space separated string. Might come in
handy for your Xresource files.

 "-background red -foreground yellow"

=item Name: not available

=item Class: not available

=item Switch B<-rules>

Specify the color and font options for highlighting. You specify a list
looking a bit like this.

 [
     ['Tagname1', @options1],
     ['Tagname2', @options2],
 ]

The names of the tags are depending on the syntax that is highlighted. 
See the language modules for more information about this data structure.

=item Name: rulesdir

=item Class: Rulesdir

=item Switch B<-rulesdir>

Specify the directory where this widget stores its coloring defenitions.
Files in this directory are stored as "HTML.rules", "Perl.rules" etc.
By default it is set to '', which means that when you switch syntax
the highlighting rules are not loaded or stored. The hard coded defaults
in the language modules will be used.

=item Name: B<syntax>

=item Class: B<Syntax>

=item Switch: B<-syntax>


Specifies the language for highlighting. At this moment the possible
values are B<None>, B<HTML>, B<Perl>, B<Pod> B<Kate:Language>, and B<Xresources>. 
By default B<None>

If B<Syntax::Highlight::Engine::Kate> is installed, you may specify any language 
that the B<Kate> syntax highlight engine supports.

Alternatively it is possible to specify a reference to your independent plugin.

=item Name: Not available

=item Class: Not available

=item Switch: B<-updatecall>

Here you can specify a callback that will be executed whenever the insert
cursor has moved or text has been modified, so your application can keep
track of position etc. Don't make this callback to heavy, the widget will
get sluggish quickly.

=item Name: Not available

=item Class: Not available

=item Switch: B<-noPlugInit>

Disables TextHighlight feature of initializing default rules when no B<.rules> file present.

=item Name: Not available

=item Class: Not available

=item Switch: B<-noSyntaxMenu>

Don't show the B<Syntax> submenu option in the B<View> submenu of the right-click menu.

=item Name: Not available

=item Class: Not available

=item Switch: B<-noSaveRulesMenu>

Don't show the B<Save Rules> submenu option in the B<View> submenu of the right-click menu.

=item Name: Not available

=item Class: Not available

=item Switch: B<-noRulesEditMenu>

Don't show the B<Rules Editor> option in the B<View> submenu of the right-click menu.

=item Name: Not available

=item Class: Not available

=item Switch: B<-noRulesMenu>

Don't show any of the TextHighlight menu items (combines B<-noSyntaxMenu>, 
B<-noRulesEditMenu>, and B<-noSaveRulesMenu> options.

=back

There are some undocumented options. They are used internally. 
It is propably best to leave them alone.

=cut

=head1 METHODS

=over 4

=item B<doAutoIndent>

Checks the indention of the previous line and indents
the line where the cursor is equally deep.

=item B<highlight>(I<$begin>, I<$end>);

Does syntax highlighting on the section of text indicated by $begin and $end. 
$begin and $end are linenumbers not indexes!

=item B<highlightCheck>>(I<$begin>, I<$end>);

An insert or delete has taken place affecting the section of text between $begin and $end.
B<highlightCheck> is being called after and insert or delete operation. $begin and $end (again
linenumbers, not indexes) indicate the section of text affected. B<highlightCheck> checks what 
needs to be highlighted again and does the highlighting.

=item B<highlightLine>(I<$line>);

Does syntax highlighting on linenumber $line.

=item B<highlightPlug>

Checks wether the appropriate highlight plugin has been loaded. If none or the wrong 
one is loaded, it loads the correct plugin. It returns a reference to the plugin loaded.
It also checks wether the rules have changed. If so, it restarts highlighting 
from the beginning of the text.

=item B<highlightPlugInit>

Loads and initalizes a highlighting plugin. First it checks the value of the B<-syntax> option
to see which plugin should be loaded. Then it checks wether a set of rules is defined to this plugin
in the B<-rules> option. If not, it tries to obtain a set of rules from disk using B<rulesFetch>. 
If this fails as well it will use the hardcoded rules from the syntax plugin.

=item B<highlightPurge>(I<$line>);

Tells the widget that the text from linenumber $line to the end of the text is not to be considered 
highlighted any more.

=item B<highlightVisual>

Calls B<visualEnd> to see what part of the text is visible on the display, and adjusts highlighting
accordingly.

=item B<linenumber>(I<$index>);

Returns the linenumber part of an index. You may also specify indexes like 'end' or 'insert' etc.

=item B<matchCheck>

Checks wether the character that is just before the 'insert'-mark should be matched, and if so
should it match forwards or backwards. It then calls B<matchFind>.

=item B<matchFind>(I<$direction>, I<$char>, I<$match>, I<$start>, I<$stop>);

Matches $char to $match, skipping nested $char/$match pairs, and displays the match found (if any).

=item B<rulesEdit>

Pops up a window that enables the user to set the color and font options
for the current syntax.

=item B<rulesFetch>

Checks wether the file 

 $text->cget('-rulesdir') . '/' . $text->cget('-syntax') . '.rules'

exists, and if so attempts to load this as a set of rules.

=item B<rulesSave>

Saves the currently loaded rules as

 $text->cget('-rulesdir') . '/' . $text->cget('-syntax') . '.rules'

=item B<selectionComment>

Comment currently selected text.

=item B<selectionIndent>

Indent currently selected text.

=item B<selectionModify>

Used by the other B<selection...> methods to do the actual work.

=item B<selectionUnComment>

Uncomment currently selected text.

=item B<selectionUnIndent>

Unindent currently selected text.

=item B<setRule(rulename,colorattribute,color)>

Allows altering of individual rules by the programmer.

=item B<fetchKateInfo>

Fetches 3 hashrefs containing information about the installed Kate highlight 
engine (if installed).  The three hashrefs contain in order:  The first can be 
passed to the B<addkate2viewmenu()> method to add the B<Kate> languages to the 
Syntax.View menu.  the keys are "Kate::language" and the values are what's 
needed to instantiate Kate for that language.  the 2nd is a list of file-
extension pattern suitable for matching against file-names and the values are 
the reccomended Kate language for that file-extension.  It will return 
B<(undef, undef, undef)>  if B<Kate> is not installed.

=item B<addKate2ViewMenu($sections)>

Inserts the list of B<Kate>-supported languages to the widget's Syntax.View 
right-mousebutton popup menu along with the basic TextHight-supported choices. 
These choices can then be selected to change the current language-highlighting 
used in the text in the widget.  B<$sections> is a hash-ref normally returned 
as the 1st item in the list returned by B<fetchKateInfo>.  NOTE:  No menu 
items will be added if B<Kate> is not installed or if B<-noRulesMenu> or 
B<-noSyntaxMenu> is set!

=back

=head1 SYNTAX HIGHLIGHTING

This section is a brief description of how the syntax highlighting process
works.

B<Initiating plugin>

The highlighting plugin is only then initiated when it is needed. When some
highlighting needs to be done, the widget calls B<highlightPlug> to retrieve
a reference to the plugin. 

B<highlightPlug> checks wether a plugin is present. Next it will check whether
the B<-rules> option has been specified or wether the B<-rules> option has changed.
If no rules are specified in B<-rules>, it will look for a pathname
in the B<-rulesdir> option. If that is found it will try to load a file
called '*.rules', where * is the value of B<-syntax>. 

If no plugin is present, or the B<-syntax> option has changed value,
B<highlightPlug> loads the plugin. and constructs optionally giving it 
a reference to the found rules as parameter. if no rules
are specified, the plugin will use its internal hardcoded defaults.

B<Changing the rules>

A set of rules is a list, containing lists of tagnames, followed by options. 
If you want to see what they look like, you can have a look at the constructors
of each plugin module. Every plugin has a fixed set of tagnames it can handle.

There are two ways to change the rules.

You can invoke the B<rulesEdit> method, which is also available through the 
B<View> menu. The result is a popup in which you can specify color and font
options for each tagname. After pressing 'Ok', the edited rules will be applied.
If B<-rulesdir> is specified, the rules will be saved on disk as
I<rulesdir/syntax.rules>.

You can also use B<configure> to specify a new set of rules. In this you have
ofcause more freedom to use all available tag options. For more details about
those there is a nice section about tag options in the Tk::Text documentation.
After the call to B<configure> it is wise to call B<highlightPlug>.

B<Highlighting text>

Syntax highlighting is done in a lazy manor. Only that piece of text is
highlighted that is needed to present the user a pretty picture. This is
done to minimize use of system resources. Highlighting is running on the
foreground. Jumping directly to the end of a long fresh loaded textfile may
very well take a couple of seconds.

Highlighting is done on a line to line basis. At the end of each line the
highlighting status is saved in the list in B<-colorinf>, so when highlighting
the next line, the B<highlight> method of B<TextHighlight> will know how to begin.

The line that needs highlighting is offered to the B<highlight> method of
the plugin. This method returns a list of offset and tagname pairs.
Take for example the following line of perl code.

 my $mother = 'older than i am';

The B<highlight> method of the Perl plugin will return the following list;

 (2 => 'Reserved',    #'my' is a reserved word
  1 => 'DEFAULT',     #Space
  7 => 'Variable',    #$mother
  1 => 'DEFAULT',     #Space
  1 => 'Operator',    #'='
  1 => 'DEFAULT',     #Space
  17 => 'String',     #'older than i am'
  1 => 'DEFAULT',)    #;

The B<highlight> method of TextHighlight will then mark positions 0 to 2 as 
'Reserved', positions 2 to 3 as 'DEFAULT', positions 3 to 10 as 'Variable',
etcetera.

=cut

=head1 WRITING PLUGINS

After writing a couple of plugins myself i have come to a couple of guidelines
about how to set them up. If you are interested in adding support for your
own syntax highlighting problem or language this section is of interest to you.

B<From scratch>

If you choose to build a plugin completely from scratch, your module needs
to meet the following requirements.

 - If you want to write a formal addition to Tk::TextHighlight, 
   your plugin must be in the namespace 
   Tk::TextHighlight::YourSyntax.
 - The constructor is called 'new', and it should accept 
   a reference a reference to a list of rules as parameters.
 - The following methods will be called upon by Tk::TextHighlight: 
     highlight, stateCompare, rules, setSate, 
     getState, syntax.

More information about those methods is available in the documentation of
Tk::TextHighlight::None and Tk::TextHighlight::Template. Good luck, you're on your own now.

B<Inheriting Tk::TextHighlight::Template>

For many highlighting problems Tk::TextHighlight::Template
provides a nice basis to start from. Your code
could look like this:

 package Tk::TextHighlight::MySyntax;
 
 use strict;
 use base('Tk::TextHighlight::Template');
 
 sub new {
    my ($proto, $wdg, $rules) = @_;
    my $class = ref($proto) || $proto;

Next, specify the set of hardcoded rules.

    if (not defined($rules)) {
       $rules =  [
          ['Tagname1', -foreground => 'red'],
          ['Tagname1', -foreground => 'red'],
       ];
    };

Call the constructor of Tk::TextHighlight::Template and bless your
object.

    my $self = $class->SUPER::new($rules);

So now we have the SUPER class avalable and we can start defining
a couple of things.

You could add a couple of lists, usefull for keywords etc.

    $self->lists({
        'Keywords' => ['foo', 'bar'],
        'Operators' => ['and', 'or'],
    });

For every tag you have to define a corresponding callback like this.

    $self->callbacks({
        'Tagname1' => \&Callback1,
        'Tagname2' => \&Callback2,
    });

You have to define a default tagname like this:

    $self->stackPush('Tagname1');

Perhaps do a couple of other things but in the end, wrap up the new method.

    
    bless ($self, $class);
    return $self;
 }

Then you need define the callbacks that are mentioned in the B<callbacks>
hash. When you just start writing your plugin i suggest you make them look
like this:

 sub callback1 {
    my ($self $txt) = @_;
    return $self->parserError($txt); #for debugging your later additions
 }

Later you add matching statements inside these callback methods. For instance,
if you want I<callback1> to parse spaces it is going to look like this:


 sub callback1 {
    my ($self $txt) = @_;
    if ($text =~ s/^(\s+)//) { #spaces
        $self->snippetParse($1, 'Tagname1'); #the tagname here is optional
        return $text;
    }
    return $self->parserError($txt); #for debugging your later additions
 }

If I<callback1> is the callback that is called by default, you have to add
the mechanism for checking lists to it. Hnce, the code will look like this:

 sub callback1 {
    my ($self $txt) = @_;
    if ($text =~ s/^(\s+)//) { #spaces
        $self->snippetParse($1, 'Tagname1'); #the tagname here is optional
        return $text;
    }
    if ($text =~ s/^([^$separators]+)//) {	#fetching a bare part
        if ($self->tokenTest($1, 'Reserved')) {
            $self->snippetParse($1, 'Reserved');
        } elsif ($self->tokenTest($1, 'Keyword')) {
            $self->snippetParse($1, 'Keyword');
        } else { #unrecognized text
            $self->snippetParse($1);
        }
        return $text
    }
    return $self->parserError($txt); #for debugging your later additions
 }

Have a look at the code of Tk::TextHighlight::Bash. Things should clear up.
And then, last but not least, you need a B<syntax> method.

B<Using another module as basis>

An example of this approach is the Perl syntax module.

Also with this approach you will have to meet the minimum criteria
as set out in the B<From scratch> section.

=cut

=head1 CONTRIBUTIONS

If you have written a plugin, i will be happy to include it in the next release
of Tk::TextHighlight. If you send it to me, please have it accompanied with the 
sample of code that you used for testing.

=head1 AUTHOR

=over 4

=item Jim Turner (turnerjw784 - att.symbol.thingy - yahoo.com).  

This is a derived work from Tk::CodeText, by Hans Jeuken (haje - att.symbol.thingy - toneel.demon.nl)

Thanks go to Mr. Hans Jeuken for his great work in making this and the Kate 
modules possible.  He did the hard work!

=back

=cut

=head1 BUGS

Unknown. If you find any, please contact the author.

=cut

=head1 TODO

=over 4

=item Add additional language modules. I am going to need help on this one.

=item HTML and Xresources plugins need rewriting.

=item The sample files in the test suite should be set up so that conformity
with the language specification can actually be verified.

=item Speed up the highlighting process by optimizing the re-highlighting process.

=back

=cut

=head1 SEE ALSO

=over 4

=item B<Tk::Text>, B<Tk::TextUndo>, B<Tk::Text::SuperText>, B<Tk::TextHighlight::None>, B<Tk::TextHighlight::Perl>
B<Tk::TextHighlight::HTML>, B<Tk::TextHighlight::Template>, B<Tk::TextHighlight::Bash>, B<Tk::CodeText>

=back

=cut



