PPIx::Regexp::Constant - Constants for the PPIx::Regexp system

PPIx-Regexp documentation Contained in the PPIx-Regexp distribution.

Index

Code Index:

NAME

Top

PPIx::Regexp::Constant - Constants for the PPIx::Regexp system

SYNOPSIS

Top

 use PPIx::Regexp::Constant qw{ TOKEN_UNKNOWN }
 print "An unknown token's class is TOKEN_UNKNOWN\n";

INHERITANCE

Top

PPIx::Regexp::Constant is an Exporter.

PPIx::Regexp::Constant has no descendants.

DETAILS

Top

This module defines manifest constants for use by the various PPIx::Regexp modules. These constants are to be considered private to the PPIx::Regexp system, and the author reserves the right to change them without notice.

This module exports the following manifest constants:

The name of the cookie used to control the construction of character classes.

This cookie is set in PPIx::Regexp::Token::Structure when the left square bracket is encountered, and cleared in the same module when a right square bracket is encountered.

The name of the cookie used to control the construction of curly bracketed quantifiers.

This cookie is set in PPIx::Regexp::Token::Structure when a left curly bracket is encountered. It requests itself to be cleared on encountering anything other than a literal comma, a literal digit, or an interpolation, or if more than one comma is encountered. If it survives until PPIx::Regexp::Token::Structure processes the right curly bracket, it is cleared there.

The name of the cookie used to control the parsing of \Q ... \E quoted literals.

This cookie is set in PPIx::Regexp::Token::Control when a \Q is encountered, and it persists until the next \E.

MINIMUM_PERL

The minimum version of Perl understood by this parser, as a float. It is currently set to 5.006, since that is the minimum version of Perl accessible to the author.

MODIFIER_GROUP_MATCH_SEMANTICS

The name of the PPIx::Regexp::Token::Modifier group used to control match semantics.

RE_CAPTURE_NAME

A string representation of a regular expression that matches the name of a named capture buffer.

STRUCTURE_UNKNOWN

The name of the class that represents the unknown structure. That is, PPIx::Regexp::Structure::Unknown.

TOKEN_LITERAL

The name of the class that represents a literal token. That is, PPIx::Regexp::Token::Literal.

TOKEN_UNKNOWN

The name of the class that represents the unknown token. That is, PPIx::Regexp::Token::Unknown.

SUPPORT

Top

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

AUTHOR

Top

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Top

Copyright (C) 2009-2011 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.

PPIx-Regexp documentation Contained in the PPIx-Regexp distribution. 
package PPIx::Regexp::Constant;

use strict;
use warnings;

our $VERSION = '0.020';

use base qw{ Exporter };

our @EXPORT_OK = qw{
    COOKIE_CLASS
    COOKIE_QUANT
    COOKIE_QUOTE
    MINIMUM_PERL
    MODIFIER_GROUP_MATCH_SEMANTICS
    RE_CAPTURE_NAME
    STRUCTURE_UNKNOWN
    TOKEN_LITERAL
    TOKEN_UNKNOWN
};

use constant COOKIE_CLASS	=> ']';
use constant COOKIE_QUANT	=> '}';
use constant COOKIE_QUOTE	=> '\\E';

use constant MINIMUM_PERL	=> '5.000';

use constant MODIFIER_GROUP_MATCH_SEMANTICS => 'match_semantics';

# The perlre for Perl 5.010 says:
#
#      Currently NAME is restricted to simple identifiers only.  In
#      other words, it must match "/^[_A-Za-z][_A-Za-z0-9]*\z/" or
#      its Unicode extension (see utf8), though it isn't extended by
#      the locale (see perllocale).

use constant RE_CAPTURE_NAME => ' [_[:alpha:]] \w* ';

use constant STRUCTURE_UNKNOWN	=> 'PPIx::Regexp::Structure::Unknown';

use constant TOKEN_LITERAL	=> 'PPIx::Regexp::Token::Literal';
use constant TOKEN_UNKNOWN	=> 'PPIx::Regexp::Token::Unknown';

1;

__END__


# ex: set textwidth=72 :