X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FSub%2FPrototype%2FUtil.pm;h=b2f67a7f81aa703868e3d5217232265446aeaa87;hb=909c371df9ff98e4f100b9451219275970a93dbd;hp=91520b823361f417e9d715e1d3f7f63d4888a04e;hpb=4e977a0b1db65e44cf4c6184792208a7930c34f4;p=perl%2Fmodules%2FSub-Prototype-Util.git diff --git a/lib/Sub/Prototype/Util.pm b/lib/Sub/Prototype/Util.pm index 91520b8..b2f67a7 100644 --- a/lib/Sub/Prototype/Util.pm +++ b/lib/Sub/Prototype/Util.pm @@ -1,10 +1,12 @@ package Sub::Prototype::Util; +use 5.006; + use strict; use warnings; -use Carp qw/croak/; -use Scalar::Util qw/reftype/; +use Carp qw; +use Scalar::Util qw; =head1 NAME @@ -12,29 +14,37 @@ Sub::Prototype::Util - Prototype-related utility routines. =head1 VERSION -Version 0.08 +Version 0.10 =cut -use vars qw/$VERSION/; +use vars qw<$VERSION>; -$VERSION = '0.08'; +$VERSION = '0.10'; =head1 SYNOPSIS - use Sub::Prototype::Util qw/flatten wrap recall/; + use Sub::Prototype::Util qw; - my @a = qw/a b c/; + my @a = qw; my @args = ( \@a, 1, { d => 2 }, undef, 3 ); - my @flat = flatten '\@$;$', @args; # ('a', 'b', 'c', 1, { d => 2 }) - recall 'CORE::push', @args; # @a contains 'a', 'b', 'c', 1, { d => 2 }, undef, 3 + my @flat = flatten '\@$;$', @args; + # @flat contains now ('a', 'b', 'c', 1, { d => 2 }) + + my $res = recall 'CORE::push', @args; + # @a contains now 'a', 'b', 'c', 1, { d => 2 }, undef, 3 + # and $res is 7 + my $splice = wrap 'CORE::splice'; - my @b = $splice->(\@a, 4, 2); # @a is now ('a', 'b', 'c', 1, 3) and @b is ({ d => 2 }, undef) + my @b = $splice->(\@a, 4, 2); + # @a contains now ('a', 'b', 'c', 1, 3) + # and @b is ({ d => 2 }, undef) =head1 DESCRIPTION -Prototypes are evil, but sometimes you just have to bear with them, especially when messing with core functions. This module provides several utilities aimed at facilitating "overloading" of prototyped functions. +Prototypes are evil, but sometimes you just have to bear with them, especially when messing with core functions. +This module provides several utilities aimed at facilitating "overloading" of prototyped functions. They all handle C<5.10>'s C<_> prototype. @@ -42,146 +52,197 @@ They all handle C<5.10>'s C<_> prototype. =cut -my %sigils = qw/SCALAR $ ARRAY @ HASH % GLOB * CODE &/; +my %sigils = qw; my %reftypes = reverse %sigils; sub _check_ref { - my ($a, $p) = @_; - my $r; - if (!defined $a || !defined($r = reftype $a)) { # not defined or plain scalar - croak 'Got ' . ((defined $a) ? 'a plain scalar' : 'undef') - . ' where a reference was expected'; + my ($arg, $sigil) = @_; + + my $reftype; + if (not defined $arg or not defined($reftype = reftype $arg)) { + # not defined or plain scalar + my $that = (defined $arg) ? 'a plain scalar' : 'undef'; + croak "Got $that where a reference was expected"; } - croak 'Unexpected ' . $r . ' reference' unless exists $sigils{$r} - and $p =~ /\Q$sigils{$r}\E/; - return $r; + + croak "Unexpected $reftype reference" unless exists $sigils{$reftype} + and $sigil =~ /\Q$sigils{$reftype}\E/; + + $reftype; } -=head2 C +sub _clean_msg { + my ($msg) = @_; -Flattens the array C<@args> according to the prototype C<$proto>. When C<@args> is what C<@_> is after calling a subroutine with prototype C<$proto>, C returns the list of what C<@_> would have been if there were no prototype. + $msg =~ s/(?:\s+called)?\s+at\s+.*$//s; + + $msg; +} + +=head2 C + + my @flattened = flatten($proto, @args); + +Flattens the array C<@args> according to the prototype C<$proto>. +When C<@args> is what C<@_> is after calling a subroutine with prototype C<$proto>, C returns the list of what C<@_> would have been if there were no prototype. +It croaks if the arguments can't possibly match the required prototype, e.g. when a reference type is wrong or when not enough elements were provided. =cut sub flatten { my $proto = shift; + return @_ unless defined $proto; - my @args; + + my @args; while ($proto =~ /(\\?)(\[[^\]]+\]|[^\];])/g) { - my $p = $2; + my $sigil = $2; + if ($1) { - my $a = shift; - my $r = _check_ref $a, $p; - my %deref = ( - SCALAR => sub { push @args, $$a }, - ARRAY => sub { push @args, @$a }, - HASH => sub { push @args, %$a }, - GLOB => sub { push @args, *$a }, - CODE => sub { push @args, &$a } - ); - $deref{$r}->(); - } elsif ($p =~ /[\@\%]/) { + my $arg = shift; + my $reftype = _check_ref $arg, $sigil; + + push @args, $reftype eq 'SCALAR' + ? $$arg + : ($reftype eq 'ARRAY' + ? @$arg + : ($reftype eq 'HASH' + ? %$arg + : ($reftype eq 'GLOB' + ? *$arg + : &$arg # _check_ref ensures this must be a code ref + ) + ) + ); + + } elsif ($sigil =~ /[\@\%]/) { push @args, @_; last; - } elsif ($p eq '_' && @_ == 0) { - push @args, $_; } else { + croak 'Not enough arguments to match this prototype' unless @_; push @args, shift; } } + return @args; } -=head2 C +=head2 C -Generates a wrapper that calls the function C<$name> with a prototyped argument list. That is, the wrapper's arguments should be what C<@_> is when you define a subroutine with the same prototype as C<$name>. + my $wrapper = wrap($name, %opts); + my $wrapper = wrap({ $name => $proto }, %opts); + +Generates a wrapper that calls the function C<$name> with a prototyped argument list. +That is, the wrapper's arguments should be what C<@_> is when you define a subroutine with the same prototype as C<$name>. my $a = [ 0 .. 2 ]; my $push = wrap 'CORE::push'; $push->($a, 3, 4); # returns 3 + 2 = 5 and $a now contains 0 .. 4 -You can force the use of a specific prototype. In this case, C<$name> must be a hash reference that holds exactly one key / value pair, the key being the function name and the value the prototpye that should be used to call it. +You can force the use of a specific prototype. +In this case, C<$name> must be a hash reference that holds exactly one key / value pair, the key being the function name and the value the prototpye that should be used to call it. my $push = wrap { 'CORE::push' => '\@$' }; # only pushes 1 arg -Others arguments are seen as key / value pairs that are meant to tune the code generated by L. Valid keys are : +The remaining arguments C<%opts> are treated as key / value pairs that are meant to tune the code generated by L. +Valid keys are : =over 4 -=item C<< ref => $func >> +=item * + +C<< ref => $func >> + +Specifies the function used in the generated code to test the reference type of scalars. +Defaults to C<'ref'>. +You may also want to use L. -Specifies the function used in the generated code to test the reference type of scalars. Defaults to C<'ref'>. You may also want to use C. +=item * -=item C<< wrong_ref => $code >> +C<< wrong_ref => $code >> -The code executed when a reference of incorrect type is encountered. The result of this snippet is also the result of the generated code, hence it defaults to C<'undef'>. It's a good place to C or C too. +The code executed when a reference of incorrect type is encountered. +The result of this snippet is also the result of the generated code, hence it defaults to C<'undef'>. +It's a good place to C or C too. -=item C<< sub => $bool >> +=item * -Encloses the code into a C block. Default is true. +C<< sub => $bool >> -=item C<< compile => $bool >> +Encloses the code into a C block. +Default is true. -Makes L compile the code generated and return the resulting code reference. Be careful that in this case C must be a fully qualified function name. Defaults to true, but turned off when C is false. +=item * + +C<< compile => $bool >> + +Makes L compile the code generated and return the resulting code reference. +Be careful that in this case C must be a fully qualified function name. +Defaults to true, but turned off when C is false. =back For example, this allows you to recall into C and C by using the C<\&@> prototype : my $grep = wrap { 'CORE::grep' => '\&@' }; - sub mygrep (&@) { $grep->(@_) } # the prototypes are intentionally different + # the prototypes are intentionally different + sub mygrep (&@) { $grep->(@_) } =cut sub _wrap { - my ($name, $proto, $i, $args, $cr, $opts) = @_; - if ($proto =~ /(\\?)(\[[^\]]+\]|[^\];])(.*)/g) { - my ($ref, $p) = ($1, $2); - $proto = $3; - $p = $1 if $p =~ /^\[([^\]]+)\]/; - my $cur = '$_[' . $i . ']'; + my ($name, $proto, $i, $args, $coderefs, $opts) = @_; + + while ($proto =~ s/(\\?)(\[[^\]]+\]|[^\];])//) { + my ($ref, $sigil) = ($1, $2); + $sigil = $1 if $sigil =~ /^\[([^\]]+)\]/; + + my $cur = "\$_[$i]"; + if ($ref) { - if (length $p > 1) { - return 'my $r = ' . $opts->{ref} . '(' . $cur . '); ' - . join ' els', - map( { - "if (\$r eq '" . $reftypes{$_} ."') { " - . _wrap($name, $proto, ($i + 1), - $args . $_ . '{' . $cur . '}, ', - $cr, $opts) - . ' }' - } split //, $p), - 'e { ' . $opts->{wrong_ref} . ' }' + if (length $sigil > 1) { + my $code = "my \$r = $opts->{ref}($cur); "; + my @branches = map { + my $subcall = _wrap( + $name, $proto, ($i + 1), $args . "$_\{$cur}, ", $coderefs, $opts + ); + "if (\$r eq '$reftypes{$_}') { $subcall }"; + } split //, $sigil; + $code .= join ' els', @branches, "e { $opts->{wrong_ref} }"; + return $code; } else { - $args .= $p . '{' . $cur . '}, '; + $args .= "$sigil\{$cur}, "; } - } elsif ($p =~ /[\@\%]/) { + } elsif ($sigil =~ /[\@\%]/) { $args .= '@_[' . $i . '..$#_]'; - } elsif ($p =~ /\&/) { - my %h = do { my $c; map { $_ => $c++ } @$cr }; + } elsif ($sigil =~ /\&/) { + my %h = do { my $c; map { $_ => $c++ } @$coderefs }; my $j; - if (not exists $h{$i}) { - push @$cr, $i; - $j = $#{$cr}; - } else { + if (exists $h{$i}) { $j = int $h{$i}; + } else { + push @$coderefs, $i; + $j = $#{$coderefs}; } - $args .= 'sub{&{$c[' . $j . ']}}, '; - } elsif ($p eq '_') { - $args .= '((@_ > ' . $i . ') ? ' . $cur . ' : $_), '; + $args .= "sub{&{\$c[$j]}}, "; + } elsif ($sigil eq '_') { + $args .= "((\@_ > $i) ? $cur : \$_), "; } else { - $args .= $cur . ', '; + $args .= "$cur, "; } - return _wrap($name, $proto, ($i + 1), $args, $cr, $opts); - } else { - $args =~ s/,\s*$//; - return $name . '(' . $args . ')'; + } continue { + ++$i; } + + $args =~ s/,\s*$//; + + return "$name($args)"; } sub _check_name { - my $name = $_[0]; + my ($name) = @_; croak 'No subroutine specified' unless $name; + my $proto; my $r = ref $name; if (!$r) { @@ -192,8 +253,10 @@ sub _check_name { } else { croak 'Unhandled ' . $r . ' reference as first argument'; } + $name =~ s/^\s+//; $name =~ s/[\s\$\@\%\*\&;].*//; + return $name, $proto; } @@ -201,34 +264,50 @@ sub wrap { my ($name, $proto) = _check_name shift; croak 'Optional arguments must be passed as key => value pairs' if @_ % 2; my %opts = @_; + $opts{ref} ||= 'ref'; - $opts{sub} = 1 if not defined $opts{sub}; - $opts{compile} = 1 if not defined $opts{compile} and $opts{sub}; - $opts{wrong_ref} = 'undef' if not defined $opts{wrong_ref}; - my @cr; + $opts{sub} = 1 unless defined $opts{sub}; + $opts{compile} = 1 if not defined $opts{compile} and $opts{sub}; + $opts{wrong_ref} = 'undef' unless defined $opts{wrong_ref}; + + my @coderefs; my $call; if (defined $proto) { - $call = _wrap $name, $proto, 0, '', \@cr, \%opts; + $call = _wrap $name, $proto, 0, '', \@coderefs, \%opts; } else { $call = _wrap $name, '', 0, '@_'; } - if (@cr) { - $call = 'my @c; ' - . join('', map { 'push @c, $_[' . $_ . ']; ' } @cr) - . $call + + if (@coderefs) { + my $decls = @coderefs > 1 ? 'my @c = @_[' . join(', ', @coderefs) . ']; ' + : 'my @c = ($_[' . $coderefs[0] . ']); '; + $call = $decls . $call; } - $call = '{ ' . $call . ' }'; - $call = 'sub ' . $call if $opts{sub}; + + $call = "{ $call }"; + $call = "sub $call" if $opts{sub}; + if ($opts{compile}) { - $call = eval $call; - croak $@ if $@; + my $err; + { + local $@; + $call = eval $call; + $err = $@; + } + croak _clean_msg $err if $err; } + return $call; } -=head2 C +=head2 C + + my @res = recall($name, @args); + my @res = recall({ $name => $proto }, @args); -Calls the function C<$name> with the prototyped argument list C<@args>. That is, C<@args> should be what C<@_> is when you define a subroutine with the same prototype as C<$name>. You can still force the prototype by passing C<< { $name => $proto } >> as the first argument. +Calls the function C<$name> with the prototyped argument list C<@args>. +That is, C<@args> should be what C<@_> is when you call a subroutine with C<$name> as prototype. +You can still force the prototype by passing C<< { $name => $proto } >> as the first argument. my $a = [ ]; recall { 'CORE::push' => '\@$' }, $a, 1, 2, 3; # $a just contains 1 @@ -238,10 +317,36 @@ If you plan to recall several times, consider using L instead. =cut -sub recall { - my $wrap = eval { wrap shift }; - croak $@ if $@; - return $wrap->(@_); +sub recall; + +BEGIN { + my $safe_wrap = sub { + my $name = shift; + + my ($wrap, $err); + { + local $@; + $wrap = eval { wrap $name }; + $err = $@; + } + + $wrap, $err; + }; + + if ("$]" == 5.008) { + # goto tends to crash a lot on perl 5.8.0 + *recall = sub { + my ($wrap, $err) = $safe_wrap->(shift); + croak _clean_msg $err if $err; + $wrap->(@_) + } + } else { + *recall = sub { + my ($wrap, $err) = $safe_wrap->(shift); + croak _clean_msg $err if $err; + goto $wrap; + } + } } =head1 EXPORT @@ -250,13 +355,13 @@ The functions L, L and L are only exported on request, =cut -use base qw/Exporter/; +use base qw; -use vars qw/@EXPORT @EXPORT_OK %EXPORT_TAGS/; +use vars qw<@EXPORT @EXPORT_OK %EXPORT_TAGS>; @EXPORT = (); %EXPORT_TAGS = ( - 'funcs' => [ qw/flatten wrap recall/ ] + 'funcs' => [ qw ] ); @EXPORT_OK = map { @$_ } values %EXPORT_TAGS; $EXPORT_TAGS{'all'} = [ @EXPORT_OK ]; @@ -273,7 +378,8 @@ You can contact me by mail or on C (vincent). =head1 BUGS -Please report any bugs or feature requests to C, or through the web interface at L. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. +Please report any bugs or feature requests to C, or through the web interface at L. +I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT @@ -285,7 +391,7 @@ Tests code coverage report is available at L