$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<?> shell 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. It can also keep original C<(...)> groups. Backspace (C<\>) is used as an escape character.
Typesets that mimic the behaviour of Windows and Unix shells are also provided.
my %escapes = (
jokers => '?*',
- sql => '%_',
+ sql => '_%',
commas => ',',
brackets => '{},',
groups => '()',
$self->capture($args{capture});
}
-=head2 C<< new [ do => $what | type => $type ], capture => $captures >>
+=head2 C<< new [ do => $what E<verbar> type => $type ], capture => $captures >>
Constructs a new L<Regexp::Wildcard> object.
C<do> lists all features that should be enabled when converting wildcards to regexps. Refer to L</do> for details on what can be passed in C<$what>.
-The C<type> specifies a predefined set of C<do> features to use.
+The C<type> specifies a predefined set of C<do> features to use. See L</type> for details on which types are valid. The C<do> option overrides C<type>.
+C<capture> lists which atoms should be capturing. Refer to L</capture> for more details.
-C<$type> can be any of C<'jokers'>, C<'sql'>, C<'commas'>, C<'brackets'>, C<'win32'> or C<'unix'>. An unknown value defaults to C<'unix'>, except for C<'dos'>, C<'os2'>, C<'MSWin32'> and C<'cygwin'> that default to C<'win32'>. With this set of options, you can pass C<$^O> as the C<$type> so that you get the corresponding shell behaviour.
+=head2 C<< do [ $what E<verbar> set => $c1, add => $c2, rem => $c3 ] >>
-=over 4
+Specifies the list of metacharacters to convert.
+They are classified into five classes :
-=item C<>
+=over 4
-For the C<$capture> syntax, refer to the L</capture> method.
+=item C<'jokers'> converts C<?> to C<.> and C<*> to C<.*> ;
-=head3 C<type>
+ 'a**\\*b??\\?c' ==> 'a.*\\*b..\\?c'
-=head3 C<capture>
+=item C<'sql'> converts C<_> to C<.> and C<%> to C<.*> ;
-=over 4
+ 'a%%\\%b__\\_c' ==> 'a.*\\%b..\\_c'
-=head2 C<$CaptureSingle>
+=item C<'commas'> converts all C<,> to C<|> and puts the complete resulting regular expression inside C<(?: ... )> ;
-When this variable is true, each occurence of unescaped I<"exactly one"> wildcards (i.e. C<?> jokers or C<_> for SQL wildcards) are made capturing in the resulting regexp (they are be replaced by C<(.)>). Otherwise, they are just replaced by C<.>. Default is the latter.
+ 'a,b{c,d},e' ==> '(?:a|b\\{c|d\\}|e)'
- For jokers :
- 'a???b\\??' is translated to 'a(.)(.)(.)b\\?(.)' if $CaptureSingle is true
- 'a...b\\?.' otherwise (default)
+=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 ;
- For SQL wildcards :
- 'a___b\\__' is translated to 'a(.)(.)(.)b\\_(.)' if $CaptureSingle is true
- 'a...b\\_.' otherwise (default)
+ '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<any>
+ 'a(b(c))d\\(\\)' ==> (no change)
-By default this variable is false, and successions of unescaped I<"any"> wildcards (i.e. C<*> jokers or C<%> for SQL wildcards) are replaced by B<one> single C<.*>. When it evalutes to true, those sequences of I<"any"> wildcards are made into B<one> capture, which is greedy (C<(.*)>) for C<$CaptureAny E<gt> 0> and otherwise non-greedy (C<(.*?)>).
+=back
- For jokers :
- 'a***b\\**' is translated to 'a.*b\\*.*' if $CaptureAny is false (default)
- 'a(.*)b\\*(.*)' if $CaptureAny > 0
- 'a(.*?)b\\*(.*?)' otherwise
+Each C<$c> can be any of :
- For SQL wildcards :
- 'a%%%b\\%%' is translated to 'a.*b\\%.*' if $CaptureAny is false (default)
- 'a(.*)b\\%(.*)' if $CaptureAny > 0
- 'a(.*?)b\\%(.*?)' otherwise
+=over 4
-=item C<brackets>
+=item A hash reference, with wanted metacharacter group names (described above) as keys and booleans as values ;
-If this variable is set to true, valid brackets constructs are made into C<( | )> captures, and otherwise they are replaced by non-capturing alternations (C<(?: | >)), which is the default.
+=item An array reference containing the list of wanted metacharacter classes ;
- 'a{b\\},\\{c}' is translated to 'a(b\\}|\\{c)' if $CaptureBrackets is true
- 'a(?:b\\}|\\{c)' otherwise (default)
+=item A plain scalar, when only one group is required.
=back
-=head2 C<jokers>
+When C<set> is present, the classes given as its value replace the current object options. Then the C<add> classes are added, and the C<rem> classes removed.
-This function takes as its only argument the wildcard string to process, and returns the corresponding regular expression where the jokers C<?> (I<"exactly one">) and C<*> (I<"any">) have been translated into their regexp equivalents (see L</VARIABLES> for more details). All other unprotected regexp metacharacters are escaped.
+Passing a sole scalar C<$what> is equivalent as passing C<< set => $what >>.
+No argument means C<< set => [ ] >>.
- # Everything is escaped.
- print 'ok' if wc2re_jokers('{a{b,c}d,e}') eq '\\{a\\{b\\,c\\}d\\,e\\}';
-
-=cut
-
-=head2 C<sql>
-
-Similar to the precedent, but for the SQL wildcards C<_> (I<"exactly one">) and C<%> (I<"any">). All other unprotected regexp metacharacters are escaped.
-
-=cut
-
-=head2 C<shell>
+ $rw->do(set => 'jokers'); # Only translate jokers.
+ $rw->do('jokers'); # Same.
+ $rw->do(add => [ qw/sql commas/ ]); # Translate also SQL and commas.
+ $rw->do(rem => 'jokers'); # Specifying both 'sql' and 'jokers' is useless.
+ $rw->do(); # Translate nothing.
-This function conforms to standard Unix shell wildcard rules. It successively escapes all unprotected regexp special characters that doesn't hold any meaning for wildcards, turns C<?> and C<*> jokers into their regexp equivalents (see L</wc2re_jokers>), and changes bracketed blocks into (possibly capturing) alternations as described in L</VARIABLES>. If brackets are unbalanced, it tries to substitute as many of them as possible, and then escape the remaining C<{> and C<}>. Commas outside of any bracket-delimited block are also escaped.
+=head2 C<type $type>
- # This is a valid bracket expression, and is completely translated.
- print 'ok' if wc2re_unix('{a{b,c}d,e}') eq '(?:a(?:b|c)d|e)';
+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.
-The function handles unbalanced bracket expressions, by escaping everything it can't recognize. For example :
+ $rw->type('win32'); # Set type to win32.
+ $rw->type(); # Set type to unix.
- # The first comma is replaced, and the remaining brackets and comma are escaped.
- print 'ok' if wc2re_unix('{a\\{b,c}d,e}') eq '(?:a\\{b|c)d\\,e\\}';
+=head2 C<< capture [ $captures E<verbar> set => $c1, add => $c2, rem => $c3 ] >>
- # All the brackets and commas are escaped.
- print 'ok' if wc2re_unix('{a{b,c\\}d,e}') eq '\\{a\\{b\\,c\\}d\\,e\\}';
+Specifies the list of atoms to capture.
+This method works like L</do>, except that the classes are different :
-This one works just like the one before, but for Windows wildcards. Bracketed blocks are no longer handled (which means that brackets are escaped), but you can provide a comma-separated list of items.
+=over 4
- # All the brackets are escaped, and commas are seen as list delimiters.
- print 'ok' if wc2re_win32('{a{b,c}d,e}') eq '(?:\\{a\\{b|c\\}d|e\\})';
+=item C<'single'> will capture all unescaped I<"exactly one"> metacharacters, i.e. C<?> for wildcards or C<_> for SQL ;
-=cut
+ 'a???b\\??' ==> 'a(.)(.)(.)b\\?(.)'
+ 'a___b\\__' ==> 'a(.)(.)(.)b\\_(.)'
-=head2 C<convert>
+=item C<'any'> will capture all unescaped I<"any"> metacharacters, i.e. C<*> for wildcards or C<%> for SQL ;
-A generic function that wraps around all the different rules. The first argument is the wildcard expression, and the second one is the type of rules to apply which can be :
+ 'a***b\\**' ==> 'a(.*)b\\*(.*)'
+ 'a%%%b\\%%' ==> 'a(.*)b\\%(.*)'
-=over 4
+=item C<'greedy'>, when used in conjunction with C<'any'>, will make the C<'any'> captures greedy (by default they are not) ;
-=item C<'unix'>, C<'win32'>, C<'jokers'>, C<'sql'>
+ 'a***b\\**' ==> 'a(.*?)b\\*(.*?)'
+ 'a%%%b\\%%' ==> 'a(.*?)b\\%(.*?)'
-For one of those raw rule names, C<wc2re> simply maps to C<wc2re_unix>, C<wc2re_win32>, C<wc2re_jokers> and C<wc2re_sql> respectively.
+=item C<'brackets'> will capture matching C<{ ... , ... }> alternations.
-=item C<$^O>
-
-If you supply the Perl operating system name, the call is deferred to C<wc2re_win32> for C< $^O> equal to C<'dos'>, C<'os2'>, C<'MSWin32'> or C<'cygwin'>, and to C<wc2re_unix> in all the other cases.
+ 'a{b\\},\\{c}' ==> 'a(b\\}|\\{c)'
=back
-If the type is undefined or not supported, it defaults to C<'unix'>.
+ $rw->capture(set => 'single'); # Only capture "exactly one" metacharacters.
+ $rw->capture('single'); # Same.
+ $rw->capture(add => [ qw/any greedy/ ]); # Also greedily capture "any" metacharacters.
+ $rw->capture(rem => 'greedy'); # No more greed please.
+ $rw->capture(); # Capture nothing.
- # Wraps to wc2re_jokers ($re eq 'a\\{b\\,c\\}.*').
- $re = wc2re 'a{b,c}*' => 'jokers';
+=head2 C<convert $wc [ , $type ]>
- # Wraps to wc2re_win32 ($re eq '(?:a\\{b|c\\}.*)')
- # or wc2re_unix ($re eq 'a(?:b|c).*') depending on $^O.
- $re = wc2re 'a{b,c}*' => $^O;
+Converts the wildcard expression C<$wc> into a regular expression according to the options stored into the L<Regexp::Wildcards> object, or to C<$type> if it's supplied. It successively escapes all unprotected regexp special characters that doesn't hold any meaning for wildcards, then replace C<'jokers'> or C<'sql'> and C<'commas'> or C<'brackets'> (depending on the L</do> or L</type> options), all of this by applying the C<'capture'> rules specified in the constructor or by L</capture>.
=cut
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
-
-Some modules provide incomplete alternatives as helper functions :
-
-L<Net::FTPServer> has a method for that. Only jokers are translated, and escaping won't preserve them.
-
-L<File::Find::Match::Util> has a C<wildcard> function that compiles a matcher. It only handles C<*>.
-
-L<Text::Buffer> has the C<convertWildcardToRegex> class method that handles jokers.
-
=head1 AUTHOR
Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
projects / perl / modules / Regexp-Wildcards.git / commitdiff