1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
=head1 NAME
PPIx::Regexp::Support - Basis for the PPIx::Regexp support classes
=head1 SYNOPSIS
use PPIx::Regexp::Dumper;
PPIx::Regexp::Dumper->new( 'qr{foo}smx' )
->print();
=head1 INHERITANCE
C<PPIx::Regexp::Support> is not descended from any other class.
C<PPIx::Regexp::Support> is the parent of
L<PPIx::Regexp::Dumper|PPIx::Regexp::Dumper>,
L<PPIx::Regexp::Lexer|PPIx::Regexp::Lexer> and
L<PPIx::Regexp::Tokenizer|PPIx::Regexp::Tokenizer>.
=head1 DESCRIPTION
This abstract class provides methods for the C<PPIx::Regexp> support
classes.
=head1 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.
=cut
package PPIx::Regexp::Support;
use strict;
use warnings;
use PPIx::Regexp::Constant qw{ @CARP_NOT };
use PPIx::Regexp::Util qw{ __instance };
our $VERSION = '0.090';
=head2 close_bracket
This method takes as its argument a character. If this character is an
open bracket the corresponding close bracket is returned. Otherwise
C<undef> is returned. Only the ASCII bracket characters are considered
brackets: (), {}, [], and <>.
=cut
{
my %bracket = (
'(' => ')',
'{' => '}',
'<' => '>',
'[' => ']',
);
sub close_bracket {
my ( undef, $char ) = @_; # Invocant unused
defined $char or return;
__instance( $char, 'PPIx::Regexp::Element' )
and $char = $char->content();
return $bracket{$char};
}
}
=head2 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.
=cut
sub decode {
my ( $self, $data ) = @_;
defined $self->{encoding} or return $data;
encode_available() or return $data;
return Encode::decode( $self->{encoding}, $data );
}
=head2 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.
=cut
sub encode {
my ( $self, $data ) = @_;
defined $self->{encoding} or return $data;
encode_available() or return $data;
return Encode::encode( $self->{encoding}, $data );
}
=head2 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.
=cut
{
my $encode_available;
sub encode_available {
defined $encode_available and return $encode_available;
return ( $encode_available = eval {
require Encode;
1;
} ? 1 : 0
);
}
}
# This method is to be used only by the PPIx-Regexp package. It returns
# the first of its arguments which is defined. It will go away when
# (or if!) these modules get 'use 5.010;' at the top.
sub __defined_or {
my ( undef, @args ) = @_; # Invocant unused
foreach my $arg ( @args ) {
defined $arg and return $arg;
}
return;
}
1;
__END__
=head1 SUPPORT
Support is by the author. Please file bug reports at
L<https://rt.cpan.org/Public/Dist/Display.html?Name=PPIx-Regexp>,
L<https://github.com/trwyant/perl-PPIx-Regexp/issues>, or in
electronic mail to the author.
=head1 AUTHOR
Thomas R. Wyant, III F<wyant at cpan dot org>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2009-2023, 2025 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.
=cut
# ex: set textwidth=72 :
|
