1PPIx::Regexp::Token::GrUosueprTyCpoen(t3r)ibuted Perl DoPcPuImxe:n:tRaetgieoxnp::Token::GroupType(3)
2
3
4

NAME

6       PPIx::Regexp::Token::GroupType - Represent a grouping parenthesis type.
7

SYNOPSIS

9        use PPIx::Regexp::Dumper;
10        PPIx::Regexp::Dumper->new( 'qr{(?i:foo)}smx' )
11            ->print();
12

INHERITANCE

14       "PPIx::Regexp::Token::GroupType" is a PPIx::Regexp::Token.
15
16       "PPIx::Regexp::Token::GroupType" is the parent of
17       PPIx::Regexp::Token::GroupType::Assertion,
18       PPIx::Regexp::Token::GroupType::BranchReset,
19       PPIx::Regexp::Token::GroupType::Code,
20       PPIx::Regexp::Token::GroupType::Modifier,
21       PPIx::Regexp::Token::GroupType::NamedCapture,
22       PPIx::Regexp::Token::GroupType::Subexpression and
23       PPIx::Regexp::Token::GroupType::Switch.
24

DESCRIPTION

26       This class represents any of the magic sequences of characters that can
27       follow an open parenthesis. This particular class is intended to be
28       abstract.
29

METHODS

31       This class provides no public methods beyond those provided by its
32       superclass.
33
34   __defining_string
35        my $string = $class->__defining_string();
36
37       This method is private to the "PPIx-Regexp" package, and is documented
38       for the author's benefit only. It may be changed or revoked without
39       notice.
40
41       This method returns an array of strings that define the specific group
42       type.  These strings will normally start with '?'.
43
44       Optionally, the first returned item may be a hash reference. The only
45       supported key is "{suffix}", which is a string to be suffixed to each
46       of the regular expressions made by "__make_group_type_matcher()" out of
47       the defining strings, inside a "(?= ... )", so that it is not included
48       in the match.
49
50       This method must be overridden, unless "__make_group_type_matcher()"
51       is.
52
53   __make_group_type_matcher
54        my $hash_ref = $class->__make_group_type_matcher();
55
56       This method is private to the "PPIx-Regexp" package, and is documented
57       for the author's benefit only. It may be changed or revoked without
58       notice.
59
60       This method returns a reference to a hash. The keys are regexp
61       delimiter characters which appear in the defining strings for the group
62       type. For each key, the value is a reference to an array of "Regexp"
63       objects, properly escaped for the key character. Key '' provides the
64       regular expressions to be used if the regexp delimiter does not appear
65       in any of the defining strings.
66
67       If this method is overridden by the subclass, method
68       "__defining_string()" need not be, unless the overridden
69       "__make_group_type_matcher()" calls "__defining_string()".
70
71   __match_setup
72        $class->__match_setup( $tokenizer );
73
74       This method is private to the "PPIx-Regexp" package, and is documented
75       for the author's benefit only. It may be changed or revoked without
76       notice.
77
78       This method performs whatever setup is needed once it is determined
79       that the given group type has been detected.  This method is called
80       only if the class matched at the current position in the string being
81       parsed. It must perform whatever extra setup is needed for the match.
82       It returns nothing.
83
84       This method need not be overridden. The default does nothing.
85

SUPPORT

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

AUTHOR

91       Thomas R. Wyant, III wyant at cpan dot org
92

94       Copyright (C) 2009-2013 by Thomas R. Wyant, III
95
96       This program is free software; you can redistribute it and/or modify it
97       under the same terms as Perl 5.10.0. For more details, see the full
98       text of the licenses in the directory LICENSES.
99
100       This program is distributed in the hope that it will be useful, but
101       without any warranty; without even the implied warranty of
102       merchantability or fitness for a particular purpose.
103
104
105
106perl v5.16.3                      2014-06-10 PPIx::Regexp::Token::GroupType(3)
Impressum