package Sub::Prototype::Util;
+use 5.006;
+
use strict;
use warnings;
=head1 VERSION
-Version 0.08
+Version 0.09
=cut
use vars qw/$VERSION/;
-$VERSION = '0.08';
+$VERSION = '0.09';
=head1 SYNOPSIS
=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.
=head2 C<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<flatten> 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<flatten> 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) {
=head2 C<wrap $name, %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>.
+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</wrap>. Valid keys are :
+Others arguments are seen as key / value pairs that are meant to tune the code generated by L</wrap>.
+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<Scalar::Util::reftype>.
+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<Scalar::Util/reftype>.
=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<croak> or C<die> 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<croak> or C<die> too.
=item C<< sub => $bool >>
-Encloses the code into a C<sub { }> block. Default is true.
+Encloses the code into a C<sub { }> block.
+Default is true.
=item C<< compile => $bool >>
-Makes L</wrap> compile the code generated and return the resulting code reference. Be careful that in this case C<ref> must be a fully qualified function name. Defaults to true, but turned off when C<sub> is false.
+Makes L</wrap> compile the code generated and return the resulting code reference.
+Be careful that in this case C<ref> must be a fully qualified function name.
+Defaults to true, but turned off when C<sub> is false.
=back
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{$_} ."') { "
=head2 C<recall $name, @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
=head1 BUGS
-Please report any bugs or feature requests to C<bug-sub-prototype-util at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Prototype-Util>. 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<bug-sub-prototype-util at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Prototype-Util>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
=head1 COPYRIGHT & LICENSE
-Copyright 2008 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010,2011 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.
projects / perl / modules / Sub-Prototype-Util.git / blobdiff