NAME

Term::Highlight - Perl module to highlight regexp patterns on terminals

SYNOPSIS

use Term::Highlight;

$obj = Term::Highlight->new( tagtype => $TAGTYPE, skip_nl_check => 0 );

$obj->LoadPatterns( \@ptns );

$obj->LoadArgs( \@args );

$obj->GetPatterns( );

$obj->ClearPatterns( );

$obj->Process( \$string );

DESCRIPTION

Term::Highlight is a Perl module aimed to support highlighting of regexp patterns in color terminals. It supports 256 color terminals a well as older 8 color terminals.

OPTIONS

tagtype

sets type of color tags. Only term and term-debug tag types are currently supported. If tagtype is term then boundaries of found patterns will be enclosed in ANSI terminal color escape sequence tags. If tagtype is term-debug then they will be marked by special symbolic sequences: this is supposed to use for debug purposes.

skip_nl_check

defines how to treat newlines in input lines. Set this to non-zero value if input lines do not contain newlines: this will gain a bit of speed.

EXPORTS

LoadPatterns

expects a reference to an array of references to arrays of type [ $pattern, $fg, $bold, $bg ]. Loads patterns to be processed.

LoadArgs

expects an array of references to strings. Loads patterns to be processed. This is just a convenient version of LoadPatterns. Example of array to be loaded: [ "-46", "-25.1", "-i", "\bw.*?\b", "-100" ].

GetPatterns

returns a reference to the loaded patterns.

ClearPatterns

clears the loaded patterns.

Process

expects a reference to a string. Makes substitution of color tags inside the string. Returns count of found matches.

SEE ALSO

hl(1)

AUTHOR

A. Radkov, <alexey.radkov@gmail.com>

COPYRIGHT AND LICENSE

Copyright (C) 2008-2023 by A. Radkov.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.