/ 
PPIx-Regexp-0.025
River stage three • 9 direct dependents • 167 total dependents
/ PPIx::Regexp::Support

NAME

PPIx::Regexp::Support - Basis for the PPIx::Regexp support classes

SYNOPSIS

use PPIx::Regexp::Dumper;
PPIx::Regexp::Dumper->new( 'qr{foo}smx' )
    ->print();

INHERITANCE

PPIx::Regexp::Support is not descended from any other class.

PPIx::Regexp::Support is the parent of PPIx::Regexp::Dumper, PPIx::Regexp::Lexer and PPIx::Regexp::Tokenizer.

DESCRIPTION

This abstract class provides methods for the PPIx::Regexp support classes.

METHODS

This class provides the following public methods. Methods not documented here are private, and unsupported in the sense that the author reserves the right to change or remove them without notice.

close_bracket

This method takes as its argument a character. If this character is an open bracket the corresponding close bracket is returned. Otherwise undef is returned. Only the ASCII bracket characters are considered brackets: (), {}, [], and <>.

decode

This method wraps the Encode::decode subroutine. If the object specifies no encoding or encode_available() returns false, this method simply returns its input string.

encode

This method wraps the Encode::encode subroutine. If the object specifies no encoding or encode_available() returns false, this method simply returns its input string.

encode_available

This method returns true if the Encode module is available, and false otherwise. If it returns true, the Encode module has actually been loaded.

SUPPORT

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2009-2012 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

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.