.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Syntax::Highlight::Engine::Simple 3pm"
.TH Syntax::Highlight::Engine::Simple 3pm "2017-06-23" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Syntax::Highlight::Engine::Simple \- Simple Syntax Highlight Engine
.SH "VERSION"
.IX Header "VERSION"
This document describes Syntax::Highlight::Engine::Simple
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Syntax::Highlight::Engine::Simple;
\&    
\&    # Constractor
\&    $highlight = Syntax::Highlight::Engine::Simple\->new(%hash);
\&    
\&    # Parameter configuration
\&    $highlight\->setParams(%hash);
\&    
\&    # Syntax definision and addition
\&    $highlight\->setSyntax(%hash);
\&    $highlight\->appendSyntax(%hash);
\&    
\&    # Perse
\&    $highlight\->doFile(%hash);
\&    $highlight\->doStr(%hash);
\&    
\&    # Utilities
\&    $highlight\->array2regexp(%hash);
\&    $highlight\->getClassNames(%hash);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Syntax highlight Engine. This generates a part of \s-1HTML\s0 string by
marking up the input string with span tags along the given rules so that you
can easily coloring with \s-1CSS.\s0
.PP
Advantage is the simpleness. This provides a simple way to define the
highlighting rules by packing the complicated part of it into regular
expression. Also, This works faster than similar highlight solutions on rough
benchmarks.
.PP
Here is a working example of This module.
.PP
http://jamadam.com/dev/cpan/demo/Syntax/Highlight/Engine/Simple/
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "new"
.IX Subsection "new"
\&\fInew\fR constractor calls for following arguments.
.Sp
.RS 4
\&\fBtype\fR
.Sp
File type. This argument causes specific sub class to be loaded.
.Sp
\&\fBsyntax\fR
.Sp
With this argument, you can assign rules in constractor.
.RE
.SS "setParams"
.IX Subsection "setParams"
This method calls for following arguments.
.Sp
.RS 4
\&\fBhtml_escape_code_ref\fR
.Sp
\&\s-1HTML\s0 escape code ref. Default subroutine escapes 3 characters '&', '<' and '>'.
.RE
.SS "setSyntax"
.IX Subsection "setSyntax"
Set the rules for highlight. It calls for a argument \fIsyntax\fR in array.
.PP
.Vb 10
\&    $highlighter\->setSyntax(
\&        syntax => [
\&                {
\&                    class => \*(Aqtag\*(Aq,
\&                    regexp => "<.+?>",
\&                },
\&                {
\&                    class => \*(Aqquote\*(Aq,
\&                    regexp => "\*(Aq.*?\*(Aq",
\&                    container => \*(Aqtag\*(Aq,
\&                },
\&                {
\&                    class => \*(Aqwquote\*(Aq,
\&                    regexp => \*(Aq".*?"\*(Aq,
\&                    container => \*(Aqtag\*(Aq,
\&                },
\&                {
\&                    class => \*(Aqkeyword\*(Aq,
\&                    regexp => \*(Aqsomekeyword\*(Aq,
\&                    container => [\*(Aqtag\*(Aq, \*(Aqquote\*(Aq, \*(Aqwquote\*(Aq],
\&                },
\&        ]
\&    );
.Ve
.PP
The array can contain rules in hash which is consists of 3 keys, \fIclass\fR,
\&\fIregexp\fR and \fIcontainer\fR.
.Sp
.RS 4
\&\fBclass\fR
.Sp
This appears to the output \s-1SPAN\s0 tag.
.Sp
\&\fBregexp\fR
.Sp
Regular expression to be highlighted.
.Sp
\&\fBcontainer\fR
.Sp
Class names of allowed container. It can be given in String or Array. This
restricts the \fIregexp\fR to stand only inside of the classes. This parameter
also works to ease the regulation some time. The highlighting rules doesn't
stand in any container in default. This parameter eliminates it.
.RE
.SS "appendSyntax"
.IX Subsection "appendSyntax"
Append syntax by giving a hash.
.PP
.Vb 7
\&    $highlighter\->setSyntax(
\&        syntax => {
\&            class       => \*(Aqquote\*(Aq,
\&            regexp      => "\*(Aq.*?\*(Aq",
\&            container   => \*(Aqtag\*(Aq,
\&        }
\&    );
.Ve
.SS "doStr"
.IX Subsection "doStr"
Highlighting input string and returns the marked up string. This method calls
for following arguments.
.Sp
.RS 4
\&\fBstr\fR
.Sp
String.
.Sp
\&\fBtab_width\fR
.Sp
Tab width for tab-space conversion. \-1 for disable it. \-1 is the default.
.RE
.PP
.Vb 4
\&    $highlighter\->doStr(
\&        str         => $str,
\&        tab_width   => 4
\&    );
.Ve
.SS "doFile"
.IX Subsection "doFile"
Highlighting the file and returns the marked up string. This method calls for
following arguments.
.Sp
.RS 4
\&\fBfile\fR
.Sp
File name.
.Sp
\&\fBtab_width\fR
.Sp
Tab width for tab-space conversion. \-1 for disable it. \-1 is the default.
.Sp
\&\fBencode\fR
.Sp
Set the encode of file. utf8 is the default.
.RE
.PP
.Vb 5
\&    $highlighter\->doStr(
\&        str         => $str,
\&        tab_width   => 4,
\&        encode      => \*(Aqutf8\*(Aq
\&    );
.Ve
.SS "array2regexp"
.IX Subsection "array2regexp"
This is a utility method for converting string array to regular expression.
.SS "getClassNames"
.IX Subsection "getClassNames"
Returns the class names in array.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP """doStr method got undefined value""" 4
.el .IP "\f(CWdoStr method got undefined value\fR" 4
.IX Item "doStr method got undefined value"
.PD 0
.ie n .IP """File open failed""" 4
.el .IP "\f(CWFile open failed\fR" 4
.IX Item "File open failed"
.PD
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
\&\fISyntax::Highlight::Engine::Simple\fR requires no configuration files or
environment variables. Specific language syntax can be defined with
sub classes and loaded in constructor if you give it the type argument.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.IP "UNIVERSAL::require" 4
.IX Item "UNIVERSAL::require"
.PD 0
.IP "encoding" 4
.IX Item "encoding"
.PD
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-syntax\-highlight\-engine\-Simple@rt.cpan.org\*(C'\fR, or through the web
interface at <http://rt.cpan.org>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Syntax::Highlight::Engine::Simple::HTML" 4
.IX Item "Syntax::Highlight::Engine::Simple::HTML"
.PD 0
.IP "Syntax::Highlight::Engine::Simple::Perl" 4
.IX Item "Syntax::Highlight::Engine::Simple::Perl"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Sugama Keita  \f(CW\*(C`<sugama@jamadam.com>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2008, Sugama Keita \f(CW\*(C`<sugama@jamadam.com>\*(C'\fR. All rights
reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See \fIperlartistic\fR.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0