Ivan Wills > File-CodeSearch > File::CodeSearch::Highlighter

Download:
File-CodeSearch-v0.7.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: v0.7.2   Source  

NAME ^

File::CodeSearch::Highlighter - Highlights matched parts of a line.

VERSION ^

This documentation refers to File::CodeSearch::Highlighter version 0.7.2.

SYNOPSIS ^

   use File::CodeSearch::Highlighter;

   # Brief but working code example(s) here showing the most common usage(s)
   # This section will be as far as many users bother reading, so make it as
   # educational and exemplary as possible.

DESCRIPTION ^

ATTRIBUTES ^

highlight_re

The regular expression used to find what to highlight

before_match (Str, BOLD RED)

A string put before a match

after_match (Str RESET)

A string put after a match

before_nomatch (Str, CYAN)

A string for before text that doesn't match

after_nomatch (Str, RESET)

A string for after text that doesn't match

before_snip (Str, RESET . RED . ON_BLACK)

A string for before snipped out text.

after_snip (Str, RESET)

A string for after snipped out text.

limit (Int, columns in terminal)

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

snip (Bool, 1)

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

SUBROUTINES/METHODS ^

highlight ( $search, )

Param: $search - type (detail) - description

Return: File::CodeSearch::Highlighter -

Description:

make_highlight_re ( $search, )

DIAGNOSTICS ^

CONFIGURATION AND ENVIRONMENT ^

DEPENDENCIES ^

INCOMPATIBILITIES ^

BUGS AND LIMITATIONS ^

There are no known bugs in this module.

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

Patches are welcome.

AUTHOR ^

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

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 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.

syntax highlighting: