/ 
PPIx-Regexp-0.014
River stage three • 9 direct dependents • 169 total dependents
/ PPIx::Regexp::Token::Modifier

NAME

PPIx::Regexp::Token::Modifier - Represent modifiers.

SYNOPSIS

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

INHERITANCE

PPIx::Regexp::Token::Modifier is a PPIx::Regexp::Token.

PPIx::Regexp::Token::Modifier is the parent of PPIx::Regexp::Token::GroupType::Modifier.

DESCRIPTION

This class represents modifier characters at the end of the regular expression. For example, in qr{foo}smx this class would represent the terminal smx.

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.

asserts

$token->asserts( 'i' ) and print "token asserts i";
foreach ( $token->asserts() ) { print "token asserts $_\n" }

This method returns true if the token explicitly asserts the given modifier. The example would return true for the modifier in (?i:foo), but false for (?-i:foo).

If called without an argument, or with an undef argument, all modifiers explicitly asserted by this token are returned.

modifiers

my %mods = $token->modifiers();

Returns all modifiers asserted or negated by this token, and the values set (true for asserted, false for negated). If called in scalar context, returns a reference to a hash containing the values.

negates

$token->negates( 'i' ) and print "token negates i\n";
foreach ( $token->negates() ) { print "token negates $_\n" }

This method returns true if the token explicitly negates the given modifier. The example would return true for the modifier in (?-i:foo), but false for (?i:foo).

If called without an argument, or with an undef argument, all modifiers explicitly negated by this token are returned.

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