]> git.vpit.fr Git - perl/modules/Regexp-Wildcards.git/blobdiff - lib/Regexp/Wildcards.pm
Use Scalar::Util::blessed() to check if our objects are blessed
[perl/modules/Regexp-Wildcards.git] / lib / Regexp / Wildcards.pm
index 1b3b4e9271d6aa1b4e0e69e742494ad9a678ca34..15b42c79fccf5f0b8122a5db5938bc2d846e1eb0 100644 (file)
@@ -3,8 +3,9 @@ package Regexp::Wildcards;
 use strict;
 use warnings;
 
-use Carp qw/croak/;
-use Text::Balanced qw/extract_bracketed/;
+use Carp           qw<croak>;
+use Scalar::Util   qw<blessed>;
+use Text::Balanced qw<extract_bracketed>;
 
 =head1 NAME
 
@@ -12,13 +13,13 @@ Regexp::Wildcards - Converts wildcard expressions to Perl regular expressions.
 
 =head1 VERSION
 
-Version 1.02
+Version 1.03
 
 =cut
 
-use vars qw/$VERSION/;
+use vars qw<$VERSION>;
 BEGIN {
- $VERSION = '1.02';
+ $VERSION = '1.03';
 }
 
 =head1 SYNOPSIS
@@ -34,12 +35,12 @@ BEGIN {
     $re = $rw->convert('%a_c%',   'sql');    # Turn SQL wildcards into regexps.
 
     $rw = Regexp::Wildcards->new(
-     do      => [ qw/jokers brackets/ ], # Do jokers and brackets.
-     capture => [ qw/any greedy/ ],      # Capture *'s greedily.
+     do      => [ qw<jokers brackets> ], # Do jokers and brackets.
+     capture => [ qw<any greedy> ],      # Capture *'s greedily.
     );
 
     $rw->do(add => 'groups');            # Don't escape groups.
-    $rw->capture(rem => [ qw/greedy/ ]); # Actually we want non-greedy matches.
+    $rw->capture(rem => [ qw<greedy> ]); # Actually we want non-greedy matches.
     $re = $rw->convert('*a{,(b)?}?c*');  # '(.*?)a(?:|(b).).c(.*?)'
     $rw->capture();                      # No more captures.
 
@@ -61,24 +62,24 @@ Typesets that mimic the behaviour of Windows and Unix shells are also provided.
 
 sub _check_self {
  croak 'First argument isn\'t a valid ' . __PACKAGE__ . ' object'
-  unless ref $_[0] and $_[0]->isa(__PACKAGE__);
+  unless blessed $_[0] and $_[0]->isa(__PACKAGE__);
 }
 
 my %types = (
- jokers   => [ qw/jokers/ ],
- sql      => [ qw/sql/ ],
- commas   => [ qw/commas/ ],
- brackets => [ qw/brackets/ ],
- unix     => [ qw/jokers brackets/ ],
- win32    => [ qw/jokers commas/ ],
+ jokers   => [ qw<jokers> ],
+ sql      => [ qw<sql> ],
+ commas   => [ qw<commas> ],
+ brackets => [ qw<brackets> ],
+ unix     => [ qw<jokers brackets> ],
+ win32    => [ qw<jokers commas> ],
 );
-$types{$_} = $types{win32} for qw/dos os2 MSWin32 cygwin/;
-$types{$_} = $types{unix}  for qw/linux
+$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/;
+                                  sco_sv unicos unicosmk>;
 
 my %escapes = (
  jokers   => '?*',
@@ -115,7 +116,7 @@ sub _validate {
  }
 
  my %checked;
- for (qw/set add rem/) {
+ for (qw<set add rem>) {
   my $opt = $opts{$_};
   next unless defined $opt;
   my $cb = {
@@ -230,27 +231,35 @@ They fit into six classes :
 
 =item *
 
-C<'jokers'> converts C<?> to C<.> and C<*> to C<.*> ;
+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<.*> ;
+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<(?: ... )> ;
+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.
+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 ;
+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\\}'
@@ -258,14 +267,18 @@ Commas outside of any bracket-delimited block are also escaped ;
 
 =item *
 
-C<'groups'> keeps the parenthesis C<( ... )> of the original string without escaping them.
+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.
+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)
@@ -298,7 +311,7 @@ No argument means C<< set => [ ] >>.
 
     $rw->do(set => 'jokers');           # Only translate jokers.
     $rw->do('jokers');                  # Same.
-    $rw->do(add => [ qw/sql commas/ ]); # Translate also SQL and commas.
+    $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.
 
@@ -366,28 +379,36 @@ This method works like L</do>, except that the classes are different :
 
 =item *
 
-C<'single'> will capture all unescaped I<"exactly one"> metacharacters, i.e. C<?> for wildcards or C<_> for SQL ;
+C<'single'>
+
+Captures 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 ;
+C<'any'>
+
+Captures 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) ;
+C<'greedy'>
+
+When used in conjunction with C<'any'>, it makes 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.
+C<'brackets'>
+
+Capture matching C<{ ... , ... }> alternations.
 
     'a{b\\},\\{c}' ==> 'a(b\\}|\\{c)'
 
@@ -395,7 +416,7 @@ C<'brackets'> will capture matching C<{ ... , ... }> alternations.
 
     $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(add => [ qw<any greedy> ]); # Also greedily capture "any" metacharacters.
     $rw->capture(rem => 'greedy');           # No more greed please.
     $rw->capture();                          # Capture nothing.
 
@@ -404,7 +425,7 @@ The C<capture> method returns the L<Regexp::Wildcards> object.
 =head2 C<convert $wc [ , $type ]>
 
 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>.
+It successively escapes all unprotected regexp special characters that doesn't hold any meaning for wildcards, then replace C<'jokers'>, 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
 
@@ -413,21 +434,32 @@ sub convert {
  _check_self $self;
  my $config = (defined $type) ? $self->_type($type) : $self;
  return unless defined $wc;
+
+ my $e = $config->{escape};
+ # Escape :
+ # - an even number of \ that doesn't protect a regexp/wildcard metachar
+ # - an odd number of \ that doesn't protect a wildcard metachar
+ $wc =~ s/
+  (?<!\\)(
+   (?:\\\\)*
+   (?:
+     [^\w\s\\$e]
+    |
+     \\
+     (?: [^\W$e] | \s | $ )
+   )
+  )
+ /\\$1/gx;
+
  my $do = $config->{do};
- my $e  = $config->{escape};
- $wc =~ s/(?<!\\)((?:\\\\)*[^\w\s\\$e])/\\$1/g;
- if ($do->{jokers}) {
-  $wc = $self->_jokers($wc);
- } elsif ($do->{sql}) {
-  $wc = $self->_sql($wc);
- }
+ $wc = $self->_jokers($wc) if $do->{jokers};
+ $wc = $self->_sql($wc)    if $do->{sql};
  if ($do->{brackets}) {
   $wc = $self->_bracketed($wc);
- } elsif ($do->{commas}) {
-  if ($wc =~ /(?<!\\)(?:\\\\)*,/) { # win32 allows comma-separated lists
-   $wc = $self->{'c_brackets'} . $self->_commas($wc) . ')';
-  }
+ } elsif ($do->{commas} and $wc =~ /(?<!\\)(?:\\\\)*,/) {
+  $wc = $self->{'c_brackets'} . $self->_commas($wc) . ')';
  }
+
  return $wc;
 }
 
@@ -437,7 +469,7 @@ An object module shouldn't export any function, and so does this one.
 
 =head1 DEPENDENCIES
 
-L<Carp> (core module since perl 5), L<Text::Balanced> (since 5.7.3).
+L<Carp> (core module since perl 5), L<Scalar::Util>, L<Text::Balanced> (since 5.7.3).
 
 =head1 CAVEATS
 
@@ -468,7 +500,7 @@ Tests code coverage report is available at L<http://www.profvince.com/perl/cover
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2007-2008 Vincent Pit, all rights reserved.
+Copyright 2007-2009 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.
@@ -480,8 +512,6 @@ sub _extract ($) { extract_bracketed $_[0], '{',  qr/.*?(?<!\\)(?:\\\\)*(?={)/ }
 sub _jokers {
  my $self = shift;
  local $_ = $_[0];
- # escape an odd number of \ that doesn't protect a regexp/wildcard special char
- s/(?<!\\)((?:\\\\)*\\(?:[\w\s]|$))/\\$1/g;
  # substitute ? preceded by an even number of \
  my $s = $self->{c_single};
  s/(?<!\\)((?:\\\\)*)\?/$1$s/g;
@@ -494,8 +524,6 @@ sub _jokers {
 sub _sql {
  my $self = shift;
  local $_ = $_[0];
- # escape an odd number of \ that doesn't protect a regexp/wildcard special char
- s/(?<!\\)((?:\\\\)*\\(?:[^\W_]|\s|$))/\\$1/g;
  # substitute _ preceded by an even number of \
  my $s = $self->{c_single};
  s/(?<!\\)((?:\\\\)*)_/$1$s/g;