README

   1 NAME
   2     Sub::Prototype::Util - Prototype-related utility routines.
   3
   4 VERSION
   5     Version 0.06
   6
   7 SYNOPSIS
   8         use Sub::Prototype::Util qw/flatten recall/;
   9
  10         my @a = qw/a b c/;
  11         my @args = ( \@a, 1, { d => 2 }, undef, 3 );
  12
  13         my @flat = flatten '\@$;$', @args; # ('a', 'b', 'c', 1, { d => 2 })
  14         recall 'CORE::push', @args; # @a contains 'a', 'b', 'c', 1, { d => 2 }, undef, 3
  15
  16 DESCRIPTION
  17     Prototypes are evil, but sometimes you just have to bear with them,
  18     especially when messing with core functions. This module provides
  19     several utilities aimed at facilitating "overloading" of prototyped
  20     functions.
  21
  22     They all handle 5.10's "_" prototype.
  23
  24 FUNCTIONS
  25   "flatten $proto, @args"
  26     Flattens the array @args according to the prototype $proto. When @args
  27     is what @_ is after calling a subroutine with prototype $proto,
  28     "flatten" returns the list of what @_ would have been if there were no
  29     prototype.
  30
  31   "recall $name, @args"
  32     Calls the function $name with the prototyped argument list @args. That
  33     is, @args should be what @_ is when you define a subroutine with the
  34     same prototype as $name. For example,
  35
  36         my $a = [ ];
  37         recall 'CORE::push', $a, 1, 2, 3;
  38
  39     will call "push @$a, 1, 2, 3" and so fill the arrayref $a with "1, 2,
  40     3". This is especially needed for core functions because you can't
  41     "goto" into them.
  42
  43     You can also force the use of a specific prototype. In this case, $name
  44     must be a hash reference that holds exactly one key/value pair, the key
  45     being the function name and the value the prototpye that should be used
  46     to call it.
  47
  48         recall { 'CORE::push' => '\@$' }, $a, 1, 2, 3; # will only push 1
  49
  50     This allows you to recall into "CORE::grep" and "CORE::map" by using the
  51     "\&@" prototype :
  52
  53         sub mygrep (&@) { recall { 'CORE::grep' => '\&@' }, @_ } # the prototypes are intentionally different
  54
  55   "wrap $name, %opts"
  56     Generates a wrapper that does the same thing as "recall", but
  57     specialized for a given function. This wrapper can be compiled once for
  58     all to avoid calling "eval" at each run (like "recall" does). You can
  59     still force the prototype by passing "{ $name => $proto }" as the first
  60     argument. Others arguments are seen as key / value pairs and tune the
  61     code generated by "wrap". Valid keys are :
  62
  63     "ref => $func"
  64         Specifies the function used in the generated code to test the
  65         reference type of scalars. Defaults to 'ref'. You may also want to
  66         use "Scalar::Util::reftype".
  67
  68     "wrong_ref => $code"
  69         The code executed when a reference of incorrect type is encountered.
  70         The result of this snippet is also the result of the generated code,
  71         hence it defaults to 'undef'. It's a good place to "croak" or "die"
  72         too.
  73
  74     "sub => $bool"
  75         Encloses the code into a "sub { }" block. Default is true.
  76
  77     "compile => $bool"
  78         Makes "wrap" compile the code generated and return the resulting
  79         code reference. Implies "sub => 1". Be careful that in this case
  80         "ref" must be a fully qualified function name. Defaults to false.
  81
  82     This is how you make your own "push" that pushes into array references :
  83
  84         my @a = (0 .. 2);
  85         my $push = wrap 'CORE::push', compile => 1;
  86         $push->(\@a, 3 .. 7); # returns 3 + 5 = 8, and @a now contains 0 .. 7
  87
  88 EXPORT
  89     The functions "flatten", "recall" and "wrap" are only exported on
  90     request, either by providing their name or by the ':funcs' and ':all'
  91     tags.
  92
  93 DEPENDENCIES
  94     Carp, Exporter (core modules since perl 5), Scalar::Util (since 5.7.3).
  95
  96 AUTHOR
  97     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
  98
  99     You can contact me by mail or on #perl @ FreeNode (vincent or
 100     Prof_Vince).
 101
 102 BUGS
 103     Please report any bugs or feature requests to "bug-sub-prototype-util at
 104     rt.cpan.org", or through the web interface at
 105     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Prototype-Util>. I
 106     will be notified, and then you'll automatically be notified of progress
 107     on your bug as I make changes.
 108
 109 SUPPORT
 110     You can find documentation for this module with the perldoc command.
 111
 112         perldoc Sub::Prototype::Util
 113
 114     Tests code coverage report is available at
 115     <http://www.profvince.com/perl/cover/Sub-Prototype-Util>.
 116
 117 COPYRIGHT & LICENSE
 118     Copyright 2008 Vincent Pit, all rights reserved.
 119
 120     This program is free software; you can redistribute it and/or modify it
 121     under the same terms as Perl itself.
 122