view release on metacpan or  search on metacpan

lib/File/CodeSearch/Highlighter.pm  view on Meta::CPAN

=over 4

=item C<highlight_re>

The regular expression used to find what to highlight

=item C<before_match (Str, BOLD RED)>

A string put before a match

=item C<after_match (Str RESET)>

A string put after a match

=item C<before_nomatch (Str, CYAN)>

A string for before text that doesn't match

=item C<after_nomatch (Str, RESET)>

A string for after text that doesn't match

=item C<before_snip (Str, RESET . RED . ON_BLACK)>

A string for before snipped out text.

=item C<after_snip (Str, RESET)>

A string for after snipped out text.

=item C<limit (Int, columns in terminal)>

The size of the limit for line length of text that is extremely long.

=item C<snip (Bool, 1)>

Cut out non-matching text so that one line of text matches on line of output

=back

=head1 SUBROUTINES/METHODS

=head3 C<highlight ( $search, )>

Param: C<$search> - type (detail) - description

Return: File::CodeSearch::Highlighter -

Description:

=head3 C<make_highlight_re ( $search, )>

=head1 DIAGNOSTICS

=head1 CONFIGURATION AND ENVIRONMENT

=head1 DEPENDENCIES

=head1 INCOMPATIBILITIES

=head1 BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

=head1 AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

=head1 LICENSE AND COPYRIGHT

Copyright (c) 2009 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077).
All rights reserved.

This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. See L<perlartistic>.  This program is
distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.

=cut