remove the outstanding queue from Sub::Quote; benchamarks show it didn't actually...
[gitmo/Moo.git] / lib / Sub / Quote.pm
index 07a7b11..8567d78 100644 (file)
@@ -6,14 +6,15 @@ sub _clean_eval { eval $_[0] }
 
 use Sub::Defer;
 use B 'perlstring';
+use Scalar::Util qw(weaken);
 use base qw(Exporter);
 
 our @EXPORT = qw(quote_sub unquote_sub quoted_from_sub);
 
-our %QUOTE_OUTSTANDING;
-
 our %QUOTED;
 
+our %WEAK_REFS;
+
 sub capture_unroll {
   my ($from, $captures, $indent) = @_;
   join(
@@ -40,60 +41,6 @@ sub inlinify {
   }
 }
 
-sub _unquote_all_outstanding {
-  return unless %QUOTE_OUTSTANDING;
-  my ($assembled_code, @assembled_captures, @localize_these) = '';
-  # we sort the keys in order to make debugging more predictable
-  foreach my $outstanding (sort keys %QUOTE_OUTSTANDING) {
-    my ($name, $code, $captures) = @{$QUOTE_OUTSTANDING{$outstanding}};
-
-    push @localize_these, $name if $name;
-
-    my $make_sub = "{\n";
-
-    if (keys %$captures) {
-      my $ass_cap_count = @assembled_captures;
-      $make_sub .= capture_unroll("\$_[1][${ass_cap_count}]", $captures, 2);
-      push @assembled_captures, $captures;
-    }
-
-    my $o_quoted = perlstring $outstanding;
-    $make_sub .= (
-      $name
-          # disable the 'variable $x will not stay shared' warning since
-          # we're not letting it escape from this scope anyway so there's
-          # nothing trying to share it
-        ? "  no warnings 'closure';\n  sub ${name} {\n"
-        : "  \$Sub::Quote::QUOTED{${o_quoted}}[3] = sub {\n"
-    );
-    $make_sub .= $code;
-    $make_sub .= "  }".($name ? '' : ';')."\n";
-    if ($name) {
-      $make_sub .= "  \$Sub::Quote::QUOTED{${o_quoted}}[3] = \\&${name}\n";
-    }
-    $make_sub .= "}\n";
-    $assembled_code .= $make_sub;
-  }
-  my $debug_code = $assembled_code;
-  if (@localize_these) {
-    $debug_code =
-      "# localizing: ".join(', ', @localize_these)."\n"
-      .$assembled_code;
-    $assembled_code = join("\n",
-      (map { "local *${_};" } @localize_these),
-      'eval '.perlstring($assembled_code).'; die $@ if $@;'
-    );
-  } else {
-    $ENV{SUB_QUOTE_DEBUG} && warn $assembled_code;
-  }
-  $assembled_code .= "\n1;";
-  unless (_clean_eval $assembled_code, \@assembled_captures) {
-    die "Eval went very, very wrong:\n\n${debug_code}\n\n$@";
-  }
-  $ENV{SUB_QUOTE_DEBUG} && warn $debug_code;
-  %QUOTE_OUTSTANDING = ();
-}
-
 sub quote_sub {
   # HOLY DWIMMERY, BATMAN!
   # $name => $code => \%captures => \%options
@@ -114,26 +61,60 @@ sub quote_sub {
     unquote_sub($outstanding);
   };
   $outstanding = "$deferred";
-  $QUOTE_OUTSTANDING{$outstanding} = $QUOTED{$outstanding} = [
-    $name, $code, $captures
-  ];
+  $QUOTED{$outstanding} = [ $name, $code, $captures ];
+  weaken($WEAK_REFS{$outstanding} = $deferred);
   return $deferred;
 }
 
 sub quoted_from_sub {
   my ($sub) = @_;
-  $QUOTED{$sub||''};
+  $WEAK_REFS{$sub||''} and $QUOTED{$sub||''};
 }
 
 sub unquote_sub {
   my ($sub) = @_;
-  _unquote_all_outstanding;
+  unless ($QUOTED{$sub}[3]) {
+    my ($name, $code, $captures) = @{$QUOTED{$sub}};
+
+    my $make_sub = "{\n";
+
+    if (keys %$captures) {
+      $make_sub .= capture_unroll("\$_[1]", $captures, 2);
+    }
+
+    my $o_quoted = perlstring $sub;
+    $make_sub .= (
+      $name
+          # disable the 'variable $x will not stay shared' warning since
+          # we're not letting it escape from this scope anyway so there's
+          # nothing trying to share it
+        ? "  no warnings 'closure';\n  sub ${name} {\n"
+        : "  \$Sub::Quote::QUOTED{${o_quoted}}[3] = sub {\n"
+    );
+    $make_sub .= $code;
+    $make_sub .= "  }".($name ? '' : ';')."\n";
+    if ($name) {
+      $make_sub .= "  \$Sub::Quote::QUOTED{${o_quoted}}[3] = \\&${name}\n";
+    }
+    $make_sub .= "}\n1;\n";
+    $ENV{SUB_QUOTE_DEBUG} && warn $make_sub;
+    {
+      local $@;
+      no strict 'refs';
+      local *{$name} if $name;
+      unless (_clean_eval $make_sub, $captures) {
+        die "Eval went very, very wrong:\n\n${make_sub}\n\n$@";
+      }
+    }
+  }
   $QUOTED{$sub}[3];
 }
 
 1;
 
-=pod
+=head1 NAME
+
+Sub::Quote - efficient generation of subroutines via string eval
 
 =head1 SYNOPSIS
 
@@ -145,10 +126,10 @@ sub unquote_sub {
 
  quote_sub 'Silly::doggy', q{ print "woof" };
 
- my $sound; $$sound = 0;
+ my $sound = 0;
 
  quote_sub 'Silly::dagron',
-   q{ print ++$$sound % 2 ? 'burninate' : 'roar' },
+   q{ print ++$sound % 2 ? 'burninate' : 'roar' },
    { '$sound' => \$sound };
 
 And elsewhere:
@@ -167,7 +148,7 @@ This package provides performant ways to generate subroutines from strings.
 
 =head2 quote_sub
 
- my $coderef = quote_sub 'Foo:bar', q{ print $x++ . "\n" }, { '$x' => \0 };
+ my $coderef = quote_sub 'Foo::bar', q{ print $x++ . "\n" }, { '$x' => \0 };
 
 Arguments: ?$name, $code, ?\%captures, ?\%options
 
@@ -185,24 +166,32 @@ code.  See the L</SYNOPSIS>'s C<Silly::dagron> for an example using captures.
 =item * no_install
 
 B<Boolean>.  Set this option to not install the generated coderef into the
-passed subroutine.
+passed subroutine name on undefer.
 
 =back
 
 =head2 unquote_sub
 
- my $coderef = unquote_sub 'Foo::bar';
+ my $coderef = unquote_sub $sub;
 
-Forcibly replace subroutine with actual code.  Note that as many subs are
-unquoted at a time for performance reasons.  This means that if you have a
-syntax error in one of your quoted subs you may find out when some other sub
-is unquoted.
+Forcibly replace subroutine with actual code.  Note that for performance
+reasons all quoted subs declared so far will be globally unquoted/parsed in
+a single eval. This means that if you have a syntax error in one of your
+quoted subs you may find out when some other sub is unquoted.
+
+If $sub is not a quoted sub, this is a no-op.
 
 =head2 quoted_from_sub
 
- my $coderef = quoted_from_sub 'Foo::bar';
+ my $data = quoted_from_sub $sub;
+
+ my ($name, $code, $captures, $compiled_sub) = @$data;
+
+Returns original arguments to quote_sub, plus the compiled version if this
+sub has already been unquoted.
 
-Returns quoted coderef based on subroutine name.
+Note that $sub can be either the original quoted version or the compiled
+version for convenience.
 
 =head2 inlinify