X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FSub-Prototype-Util.git;a=blobdiff_plain;f=lib%2FSub%2FPrototype%2FUtil.pm;h=d52b905f8c8370fad0e2b7f218952da99b52e30f;hp=91520b823361f417e9d715e1d3f7f63d4888a04e;hb=26e43a265dbd585d36cc6b3fc48c423e17421a62;hpb=4e977a0b1db65e44cf4c6184792208a7930c34f4 diff --git a/lib/Sub/Prototype/Util.pm b/lib/Sub/Prototype/Util.pm index 91520b8..d52b905 100644 --- a/lib/Sub/Prototype/Util.pm +++ b/lib/Sub/Prototype/Util.pm @@ -1,5 +1,7 @@ package Sub::Prototype::Util; +use 5.006; + use strict; use warnings; @@ -12,13 +14,13 @@ Sub::Prototype::Util - Prototype-related utility routines. =head1 VERSION -Version 0.08 +Version 0.09 =cut use vars qw/$VERSION/; -$VERSION = '0.08'; +$VERSION = '0.09'; =head1 SYNOPSIS @@ -34,7 +36,8 @@ $VERSION = '0.08'; =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. @@ -57,35 +60,46 @@ sub _check_ref { return $r; } +sub _clean_msg { + my ($msg) = @_; + $msg =~ s/(?:\s+called)?\s+at\s+.*$//s; + return $msg; +} + =head2 C -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. +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; 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}->(); + push @args, $r eq 'SCALAR' + ? $$a + : ($r eq 'ARRAY' + ? @$a + : ($r eq 'HASH' + ? %$a + : ($r eq 'GLOB' + ? *$a + : &$a # _check_ref ensures this must be a code ref + ) + ) + ); } elsif ($p =~ /[\@\%]/) { push @args, @_; last; - } elsif ($p eq '_' && @_ == 0) { - push @args, $_; } else { + croak 'Not enough arguments to match this prototype' unless @_; push @args, shift; } } @@ -94,35 +108,45 @@ sub flatten { =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>. +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 : +Others arguments are seen as key / value pairs that are meant to tune the code generated by L. +Valid keys are : =over 4 =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 C. +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. =item 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 >> -Encloses the code into a C block. Default is true. +Encloses the code into a C block. +Default is true. =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. +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 @@ -135,14 +159,13 @@ For example, this allows you to recall into C and C by us sub _wrap { my ($name, $proto, $i, $args, $cr, $opts) = @_; - if ($proto =~ /(\\?)(\[[^\]]+\]|[^\];])(.*)/g) { + while ($proto =~ s/(\\?)(\[[^\]]+\]|[^\];])//) { my ($ref, $p) = ($1, $2); - $proto = $3; $p = $1 if $p =~ /^\[([^\]]+)\]/; my $cur = '$_[' . $i . ']'; if ($ref) { if (length $p > 1) { - return 'my $r = ' . $opts->{ref} . '(' . $cur . '); ' + return 'my $r = ' . $opts->{ref} . '(' . $cur . '); ' . join ' els', map( { "if (\$r eq '" . $reftypes{$_} ."') { " @@ -172,11 +195,10 @@ sub _wrap { } else { $args .= $cur . ', '; } - return _wrap($name, $proto, ($i + 1), $args, $cr, $opts); - } else { - $args =~ s/,\s*$//; - return $name . '(' . $args . ')'; + ++$i; } + $args =~ s/,\s*$//; + return $name . '(' . $args . ')'; } sub _check_name { @@ -221,14 +243,16 @@ sub wrap { $call = 'sub ' . $call if $opts{sub}; if ($opts{compile}) { $call = eval $call; - croak $@ if $@; + croak _clean_msg $@ if $@; } return $call; } =head2 C -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 @@ -240,7 +264,7 @@ If you plan to recall several times, consider using L instead. sub recall { my $wrap = eval { wrap shift }; - croak $@ if $@; + croak _clean_msg $@ if $@; return $wrap->(@_); } @@ -273,7 +297,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 +310,7 @@ Tests code coverage report is available at L