9 use List::Util qw/reduce sum/;
11 use B qw/class ppname svref_2object OPf_KIDS/;
15 Sub::Nary - Try to count how many elements a subroutine can return in list context.
32 my $sn = Sub::Nary->new();
33 my $r = $sn->nary(\&hlagh);
37 This module uses the L<B> framework to walk into subroutines and try to guess how many scalars are likely to be returned in list context. It's not always possible to give a definitive answer to this question at compile time, so the results are given in terms of "probability of return" (to be understood in a sense described below).
43 The usual constructor. Currently takes no argument.
45 =head2 C<nary $coderef>
47 Takes a code reference to a named or anonymous subroutine, and returns a hash reference whose keys are the possible numbers of returning scalars, and the corresponding values the "probability" to get them. The special key C<'list'> is used to denote a possibly infinite number of returned arguments. The return value hence would look at
49 { 1 => 0.2, 2 => 0.4, 4 => 0.3, list => 0.1 }
51 that is, we should get C<1> scalar C<1> time over C<5> and so on. The sum of all values is C<1>. The returned result, and all the results obtained from intermediate subs, are cached into the object.
55 Flushes the L<Sub::Nary> object cache. Returns the object itself.
57 =head1 PROBABILITY OF RETURN
59 The probability is computed as such :
63 =item * All the returning points in the same subroutine (i.e. all the explicit C<return> and the last computed value) are considered equally possible.
65 For example, the subroutine
75 is seen returning one or two arguments each with probability C<1/2>.
87 it is considered to return C<1> (when the two tests fail, the last computed value is returned, which here is C<< $x > 0.9 >> evaluated in the scalar context of the test), C<2> or C<3> arguments each with probability C<1/3>.
89 =item * The total probability law for a given returning point is the convolution product of the probabilities of its list elements.
97 returns C<3> or C<4> arguments with probability C<1/2> ; and
100 return simple(), simple()
103 never returns C<1> argument but returns C<2> with probability C<1/2 * 1/2 = 1/4>, C<3> with probability C<1/2 * 1/2 + 1/2 * 1/2 = 1/2> and C<4> with probability C<1/4> too.
105 =item * The C<list> state is absorbing in regard of all the other ones.
107 This is just a pedantic way to say that "list + fixed length = list".
111 return 1, simple(), @_
114 is considered as always returning an unbounded list.
116 Also, the convolution law does not behave the same when C<list> elements are involved : in the following example,
127 return oneorlist(), oneorlist()
130 C<composed> returns C<2> scalars with probability C<1/2 * 1/2 = 1/4> and a C<list> with probability C<3/4>.
138 XSLoader::load(__PACKAGE__, $VERSION);
142 croak 'First argument isn\'t a valid ' . __PACKAGE__ . ' object'
143 unless ref $_[0] and $_[0]->isa(__PACKAGE__);
148 $class = ref($class) || $class || __PACKAGE__;
149 bless { cache => { } }, $class;
155 $self->{cache} = { };
164 return $self->enter(svref_2object($sub));
169 $n eq 'null' ? substr(ppname($_[0]->targ), 3) : $n
175 my $la = delete $a->{list};
176 my $lb = delete $b->{list};
177 if (defined $la || defined $lb) {
180 $res{list} = $la + $lb - $la * $lb;
182 while (my ($ka, $va) = each %$a) {
184 while (my ($kb, $vb) = each %$b) {
185 my $key = $ka + int $kb;
186 $res{$key} += $va * $vb;
190 }} map { (ref) ? $_ : { $_ => 1 } } grep defined, @_;
195 $a->{$_} += $b->{$_} for keys %$b;
197 } map { (ref) ? $_ : { $_ => 1 } } grep defined, @_;
201 $ops{$_} = 1 for scalops;
202 $ops{$_} = 0 for qw/stub nextstate/;
203 $ops{$_} = 1 for qw/padsv/;
204 $ops{$_} = 'list' for qw/padav/;
205 $ops{$_} = 'list' for qw/padhv rv2hv/;
206 $ops{$_} = 'list' for qw/padany flip match entereval readline/;
207 $ops{each} = { 0 => 0.5, 2 => 0.5 };
208 $ops{stat} = { 0 => 0.5, 13 => 0.5 };
209 $ops{caller} = sub { my @a = caller 0; scalar @a }->();
210 $ops{localtime} = do { my @a = localtime; scalar @a };
211 $ops{gmtime} = do { my @a = gmtime; scalar @a };
214 my ($self, $cv) = @_;
216 return 'list' if class($cv) ne 'CV';
220 return { %{$self->{cache}->{$tag}} } if exists $self->{cache}->{$tag};
222 # Anything can happen with recursion
223 for (@{$self->{cv}}) {
224 return 'list' if $tag == tag($_->ROOT);
227 unshift @{$self->{cv}}, $cv;
228 (my $r, undef) = $self->expect_any($op->first);
229 shift @{$self->{cv}};
231 $r = { $r => 1} unless ref $r;
232 my $total = sum values %$r;
233 $r = { map { $_ => $r->{$_} / $total } keys %$r };
234 $self->{cache}->{$tag} = { %$r };
239 my ($self, $op) = @_;
241 return ($self->expect_list($op))[0] => 1 if name($op) eq 'return';
243 if ($op->flags & OPf_KIDS) {
244 for ($op = $op->first; not null $op; $op = $op->sibling) {
245 my ($p, $r) = $self->expect_return($op);
246 return $p => 1 if $r;
254 my ($self, $op) = @_;
257 my $meth = $self->can('pp_' . $n);
258 return $self->$meth($op) if $meth;
259 if (exists $ops{$n}) {
261 $r = { %$r } if ref $r eq 'HASH';
265 if ($op->flags & OPf_KIDS) {
268 for ($op = $op->first; not null $op; $op = $op->sibling) {
270 next if $n eq 'pushmark';
271 if ($n eq 'nextstate'
272 and not null(($op = $op->sibling)->sibling)) {
273 ($p, $r) = $self->expect_return($op);
274 return $p => 1 if $r;
276 ($p, $r) = $self->expect_any($op);
277 return $p => 1 if $r;
281 return (combine @res) => 0;
288 my ($self, $op) = @_;
290 return ($self->expect_list($op))[0] => 1 if name($op) eq 'return';
292 if (class($op) eq 'LOGOP' and not null $op->first) {
297 ($p, $r) = $self->expect_return($op);
298 return $p => 1 if $r;
301 push @res, ($self->expect_any($op))[0];
303 # If the logop has no else branch, it can also return the *scalar* result of
309 push @res, ($self->expect_any($op))[0];
312 return (add @res) => 0;
315 return $self->expect_list($op);
318 # Stolen from B::Deparse
320 sub padval { $_[0]->{cv}->[0]->PADLIST->ARRAYelt(1)->ARRAYelt($_[1]) }
323 my ($self, $op) = @_;
324 if (class($op) eq 'PADOP') {
325 return $self->padval($op->padix)
326 } else { # class($op) eq "SVOP"
332 my ($self, $op) = @_;
334 # the constant could be in the pad (under useithreads)
335 $sv = $self->padval($op->targ) unless $$sv;
340 my ($self, $op, $exp) = @_;
343 while ($next->flags & OPf_KIDS) {
344 $next = $next->first;
346 while (not null $next) {
348 my ($p, $r) = $self->expect_return($op, $exp);
349 return $p => 1 if $r;
350 $next = $op->sibling;
353 if (name($op) eq 'rv2cv') {
357 my $next = $op->sibling;
358 while (not null $next) {
360 $next = $next->sibling;
363 } while ($op->flags & OPf_KIDS and { map { $_ => 1 } qw/null leave/ }->{$n});
364 return 'list' unless { map { $_ => 1 } qw/gv refgen/ }->{$n};
365 local $self->{sub} = 1;
366 return $self->expect_any($op, $exp);
374 my ($self, $op) = @_;
376 return $self->{sub} ? $self->enter($self->gv_or_padgv($op)->CV) : 1
380 my ($self, $op) = @_;
382 return $self->{sub} ? $self->enter($self->const_sv($op)) : 1
386 my ($self, $op) = @_;
389 while ($op->flags & OPf_KIDS) {
390 my $nop = $op->first;
392 if ($nn eq 'pushmark') {
393 $nop = $nop->sibling;
396 if ($n eq 'rv2cv' and $nn eq 'gv') {
397 return $self->enter($self->gv_or_padgv($nop)->CV);
407 my ($self, $op) = @_;
409 if (class($op) eq 'SVOP' and (my $sv = $self->const_sv($op))) {
412 return $sv->FILL + 1;
413 } elsif ($c eq 'HV') {
414 return 2 * $sv->FILL;
421 sub pp_aslice { $_[0]->expect_any($_[1]->first->sibling) }
424 *pp_hslice = *pp_aslice{CODE};
426 sub pp_lslice { $_[0]->expect_any($_[1]->first) }
429 my ($self, $op) = @_;
432 return (name($op) eq 'const') ? $self->expect_any($op) : 'list';
435 sub pp_aassign { $_[0]->expect_any($_[1]->first) }
437 sub pp_leaveloop { $_[0]->expect_return($_[1]->first->sibling) }
441 An object-oriented module shouldn't export any function, and so does this one.
445 The algorithm may be pessimistic (things seen as C<list> while they are of fixed length) but not optimistic (the opposite, duh).
447 C<wantarray> isn't specialized when encountered in the optree.
453 L<Carp> (standard since perl 5), L<B> (since perl 5.005), L<XSLoader> (since perl 5.006) and L<List::Util> (since perl 5.007003).
457 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
459 You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).
463 Please report any bugs or feature requests to C<bug-b-nary at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Nary>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
467 You can find documentation for this module with the perldoc command.
471 Tests code coverage report is available at L<http://www.profvince.com/perl/cover/Sub-Nary>.
473 =head1 ACKNOWLEDGEMENTS
475 Thanks to Sebastien Aperghis-Tramoni for helping to name this module.
477 =head1 COPYRIGHT & LICENSE
479 Copyright 2008 Vincent Pit, all rights reserved.
481 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
485 1; # End of Sub::Nary