=head1 VERSION
-Version 0.08
+Version 1.02
=cut
-our $VERSION = '0.08';
+use vars qw/$VERSION/;
+BEGIN {
+ $VERSION = '1.02';
+}
=head1 SYNOPSIS
$re = $rw->convert('a{b?,c}*'); # Do it Unix shell style.
$re = $rw->convert('a?,b*', 'win32'); # Do it Windows shell style.
$re = $rw->convert('*{x,y}?', 'jokers'); # Process the jokers and escape the rest.
- $re = $rw->convert('%a_c%', 'sql'); # Turn SQL wildcards into regexps.
+ $re = $rw->convert('%a_c%', 'sql'); # Turn SQL wildcards into regexps.
$rw = Regexp::Wildcards->new(
do => [ qw/jokers brackets/ ], # Do jokers and brackets.
In many situations, users may want to specify patterns to match but don't need the full power of regexps. Wildcards make one of those sets of simplified rules. This module converts wildcard expressions to Perl regular expressions, so that you can use them for matching.
-It handles the C<*> and C<?> jokers, as well as Unix bracketed alternatives C<{,}>, but also C<%> and C<_> SQL wildcards. It can also keep original C<(...)> groups. Backspace (C<\>) is used as an escape character.
+It handles the C<*> and C<?> jokers, as well as Unix bracketed alternatives C<{,}>, but also C<%> and C<_> SQL wildcards. If required, it can also keep original C<(...)> groups or C<^> and C<$> anchors. Backspace (C<\>) is used as an escape character.
Typesets that mimic the behaviour of Windows and Unix shells are also provided.
win32 => [ qw/jokers commas/ ],
);
$types{$_} = $types{win32} for qw/dos os2 MSWin32 cygwin/;
+$types{$_} = $types{unix} for qw/linux
+ darwin machten next
+ aix irix hpux dgux dynixptx
+ bsdos freebsd openbsd
+ svr4 solaris sunos dec_osf
+ sco_sv unicos unicosmk/;
my %escapes = (
jokers => '?*',
commas => ',',
brackets => '{},',
groups => '()',
+ anchors => '^$',
);
my %captures = (
=head2 C<< do [ $what E<verbar> set => $c1, add => $c2, rem => $c3 ] >>
-Specifies the list of metacharacters to convert.
-They are classified into five classes :
+Specifies the list of metacharacters to convert or to prevent for escaping.
+They fit into six classes :
=over 4
-=item C<'jokers'> converts C<?> to C<.> and C<*> to C<.*> ;
+=item *
+
+C<'jokers'> converts C<?> to C<.> and C<*> to C<.*> ;
'a**\\*b??\\?c' ==> 'a.*\\*b..\\?c'
-=item C<'sql'> converts C<_> to C<.> and C<%> to C<.*> ;
+=item *
+
+C<'sql'> converts C<_> to C<.> and C<%> to C<.*> ;
'a%%\\%b__\\_c' ==> 'a.*\\%b..\\_c'
-=item C<'commas'> converts all C<,> to C<|> and puts the complete resulting regular expression inside C<(?: ... )> ;
+=item *
+
+C<'commas'> converts all C<,> to C<|> and puts the complete resulting regular expression inside C<(?: ... )> ;
'a,b{c,d},e' ==> '(?:a|b\\{c|d\\}|e)'
-=item C<'brackets'> converts all matching C<{ ... , ... }> brackets to C<(?: ... | ... )> alternations. If some brackets are unbalanced, it tries to substitute as many of them as possible, and then escape the remaining unmatched C<{> and C<}>. Commas outside of any bracket-delimited block are also escaped ;
+=item *
+
+C<'brackets'> converts all matching C<{ ... , ... }> brackets to C<(?: ... | ... )> alternations. If some brackets are unbalanced, it tries to substitute as many of them as possible, and then escape the remaining unmatched C<{> and C<}>. Commas outside of any bracket-delimited block are also escaped ;
'a,b{c,d},e' ==> 'a\\,b(?:c|d)\\,e'
'{a\\{b,c}d,e}' ==> '(?:a\\{b|c)d\\,e\\}'
'{a{b,c\\}d,e}' ==> '\\{a\\{b\\,c\\}d\\,e\\}'
-=item C<'groups'> keeps the parenthesis C<( ... )> of the original string without escaping them. Currently, no check is done to ensure that the parenthesis are matching.
+=item *
+
+C<'groups'> keeps the parenthesis C<( ... )> of the original string without escaping them. Currently, no check is done to ensure that the parenthesis are matching.
'a(b(c))d\\(\\)' ==> (no change)
+=item *
+
+C<'anchors'> prevents the I<beginning-of-line> C<^> and I<end-of-line> C<$> anchors to be escaped. Since C<[...]> character class are currently escaped, a C<^> will always be interpreted as I<beginning-of-line>.
+
+ 'a^b$c' ==> (no change)
+
=back
Each C<$c> can be any of :
=over 4
-=item A hash reference, with wanted metacharacter group names (described above) as keys and booleans as values ;
+=item *
+
+A hash reference, with wanted metacharacter group names (described above) as keys and booleans as values ;
+
+=item *
-=item An array reference containing the list of wanted metacharacter classes ;
+An array reference containing the list of wanted metacharacter classes ;
-=item A plain scalar, when only one group is required.
+=item *
+
+A plain scalar, when only one group is required.
=back
=head2 C<type $type>
-Notifies to convert the metacharacters that corresponds to the predefined type C<$type>. C<$type> can be any of C<'jokers'>, C<'sql'>, C<'commas'>, C<'brackets'>, C<'win32'> or C<'unix'>. An unknown or undefined value defaults to C<'unix'>, except for C<'dos'>, C<'os2'>, C<'MSWin32'> and C<'cygwin'> that default to C<'win32'>. This means that you can pass C<$^O> as the C<$type> and get the corresponding shell behaviour. Returns the object.
+Notifies to convert the metacharacters that corresponds to the predefined type C<$type>.
+C<$type> can be any of :
+
+=over 4
+
+=item *
+
+C<'jokers'>, C<'sql'>, C<'commas'>, C<'brackets'>
+
+Singleton types that enable the corresponding C<do> classes.
+
+=item *
+
+C<'unix'>
+
+Covers typical Unix shell globbing features (effectively C<'jokers'> and C<'brackets'>).
+
+=item *
+
+C<$^O> values for common Unix systems
+
+Wrap to C<'unix'> (see L<perlport> for the list).
+
+=item *
+
+C<undef>
+
+Defaults to C<'unix'>.
+
+=item *
+
+C<'win32'>
+
+Covers typical Windows shell globbing features (effectively C<'jokers'> and C<'commas'>).
+
+=item *
+
+C<'dos'>, C<'os2'>, C<'MSWin32'>, C<'cygwin'>
+
+Wrap to C<'win32'>.
+
+=back
+
+In particular, you can usually pass C<$^O> as the C<$type> and get the corresponding shell behaviour.
$rw->type('win32'); # Set type to win32.
+ $rw->type($^O); # Set type to unix on Unices and win32 on Windows
$rw->type(); # Set type to unix.
+The C<type> method returns the L<Regexp::Wildcards> object.
+
=head2 C<< capture [ $captures E<verbar> set => $c1, add => $c2, rem => $c3 ] >>
Specifies the list of atoms to capture.
=over 4
-=item C<'single'> will capture all unescaped I<"exactly one"> metacharacters, i.e. C<?> for wildcards or C<_> for SQL ;
+=item *
+
+C<'single'> will capture all unescaped I<"exactly one"> metacharacters, i.e. C<?> for wildcards or C<_> for SQL ;
'a???b\\??' ==> 'a(.)(.)(.)b\\?(.)'
'a___b\\__' ==> 'a(.)(.)(.)b\\_(.)'
-=item C<'any'> will capture all unescaped I<"any"> metacharacters, i.e. C<*> for wildcards or C<%> for SQL ;
+=item *
+
+C<'any'> will capture all unescaped I<"any"> metacharacters, i.e. C<*> for wildcards or C<%> for SQL ;
'a***b\\**' ==> 'a(.*)b\\*(.*)'
'a%%%b\\%%' ==> 'a(.*)b\\%(.*)'
-=item C<'greedy'>, when used in conjunction with C<'any'>, will make the C<'any'> captures greedy (by default they are not) ;
+=item *
+
+C<'greedy'>, when used in conjunction with C<'any'>, will make the C<'any'> captures greedy (by default they are not) ;
'a***b\\**' ==> 'a(.*?)b\\*(.*?)'
'a%%%b\\%%' ==> 'a(.*?)b\\%(.*?)'
-=item C<'brackets'> will capture matching C<{ ... , ... }> alternations.
+=item *
+
+C<'brackets'> will capture matching C<{ ... , ... }> alternations.
'a{b\\},\\{c}' ==> 'a(b\\}|\\{c)'
my $do = $config->{do};
my $e = $config->{escape};
$wc =~ s/(?<!\\)((?:\\\\)*[^\w\s\\$e])/\\$1/g;
- return $self->_sql($wc) if $do->{sql};
- $wc = $self->_jokers($wc) if $do->{jokers};
+ if ($do->{jokers}) {
+ $wc = $self->_jokers($wc);
+ } elsif ($do->{sql}) {
+ $wc = $self->_sql($wc);
+ }
if ($do->{brackets}) {
$wc = $self->_bracketed($wc);
} elsif ($do->{commas}) {
=head1 DEPENDENCIES
-L<Text::Balanced>, which is bundled with perl since version 5.7.3
+L<Carp> (core module since perl 5), L<Text::Balanced> (since 5.7.3).
=head1 CAVEATS
This module does not implement the strange behaviours of Windows shell that result from the special handling of the three last characters (for the file extension). For example, Windows XP shell matches C<*a> like C<.*a>, C<*a?> like C<.*a.?>, C<*a??> like C<.*a.{0,2}> and so on.
+=head1 SEE ALSO
+
+L<Text::Glob>.
+
=head1 AUTHOR
Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
-You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).
+You can contact me by mail or on C<irc.perl.org> (vincent).
=head1 BUGS
projects / perl / modules / Regexp-Wildcards.git / blobdiff