Port to B::Hooks::Parser.
[p5sagit/Devel-Declare.git] / lib / Devel / Declare.pm
index 2e1d443..210b6a8 100644 (file)
@@ -4,9 +4,7 @@ use strict;
 use warnings;
 use 5.008001;
 
-our $VERSION = '0.001004';
-
-# mirrored in Declare.xs as DD_HANDLE_*
+our $VERSION = '0.002002';
 
 use constant DECLARE_NAME => 1;
 use constant DECLARE_PROTO => 2;
@@ -16,11 +14,21 @@ use constant DECLARE_PACKAGE => 8+1; # name implicit
 use vars qw(%declarators %declarator_handlers @ISA);
 use base qw(DynaLoader);
 use Scalar::Util 'set_prototype';
+use B::Hooks::OP::Check;
+use B::Hooks::Parser;
 
 bootstrap Devel::Declare;
 
 @ISA = ();
 
+# temporary backcompat
+{
+    for (qw/get_linestr get_linestr_offset set_linestr/) {
+        no strict 'refs';
+        *{ $_ } = B::Hooks::Parser->can($_);
+    }
+}
+
 sub import {
   my ($class, %args) = @_;
   my $target = caller;
@@ -51,8 +59,11 @@ sub setup_for {
     } elsif (ref($info) eq 'CODE') {
       $flags = DECLARE_NAME;
       $sub = $info;
+    } elsif (ref($info) eq 'HASH') {
+      $flags = 1;
+      $sub = $info;
     } else {
-      die "Info for sub ${key} must be [ \$flags, \$sub ] or \$sub";
+      die "Info for sub ${key} must be [ \$flags, \$sub ] or \$sub or handler hashref";
     }
     $declarators{$target}{$key} = $flags;
     $declarator_handlers{$target}{$key} = $sub;
@@ -63,35 +74,24 @@ sub teardown_for {
   my ($class, $target) = @_;
   delete $declarators{$target};
   delete $declarator_handlers{$target};
-  teardown();
 }
 
 my $temp_name;
 my $temp_save;
 
 sub init_declare {
-  my ($usepack, $use, $inpack, $name, $proto) = @_;
+  my ($usepack, $use, $inpack, $name, $proto, $traits) = @_;
   my ($name_h, $XX_h, $extra_code)
        = $declarator_handlers{$usepack}{$use}->(
-           $usepack, $use, $inpack, $name, $proto, defined(wantarray)
+           $usepack, $use, $inpack, $name, $proto, defined(wantarray), $traits
          );
   ($temp_name, $temp_save) = ([], []);
   if ($name) {
     $name = "${inpack}::${name}" unless $name =~ /::/;
-    push(@$temp_name, $name);
-    no strict 'refs';
-    push(@$temp_save, \&{$name});
-    no warnings 'redefine';
-    no warnings 'prototype';
-    *{$name} = $name_h;
+    shadow_sub($name, $name_h);
   }
   if ($XX_h) {
-    push(@$temp_name, "${inpack}::X");
-    no strict 'refs';
-    push(@$temp_save, \&{"${inpack}::X"});
-    no warnings 'redefine';
-    no warnings 'prototype';
-    *{"${inpack}::X"} = $XX_h;
+    shadow_sub("${inpack}::X", $XX_h);
   }
   if (defined wantarray) {
     return $extra_code || '0;';
@@ -100,6 +100,19 @@ sub init_declare {
   }
 }
 
+sub shadow_sub {
+  my ($name, $cr) = @_;
+  push(@$temp_name, $name);
+  no strict 'refs';
+  my ($pack, $pname) = ($name =~ m/(.+)::([^:]+)/);
+  push(@$temp_save, $pack->can($pname));
+  delete ${"${pack}::"}{$pname};
+  no warnings 'redefine';
+  no warnings 'prototype';
+  *{$name} = $cr;
+  set_in_declare(~~@{$temp_name||[]});
+}
+
 sub done_declare {
   no strict 'refs';
   my $name = shift(@{$temp_name||[]});
@@ -112,6 +125,7 @@ sub done_declare {
     no warnings 'prototype';
     *{"${temp_pack}::${name}"} = $saved;
   }
+  set_in_declare(~~@{$temp_name||[]});
 }
 
 sub build_sub_installer {
@@ -121,8 +135,7 @@ sub build_sub_installer {
     my \$body;
     sub ${name} (${proto}) :lvalue {\n"
     .'  if (wantarray) {
-        my @ret = $body->(@_);
-        return @ret;
+        goto &$body;
       }
       my $ret = $body->(@_);
       return $ret;
@@ -166,9 +179,8 @@ sub setup_declarators {
     $setup_for_args{$name} = [
       $flags,
       sub {
-        my ($usepack, $use, $inpack, $name, $proto) = @_;
-        my $extra_code = $compile->($name, $proto);
-        my $shift_hashref = defined(wantarray);
+        my ($usepack, $use, $inpack, $name, $proto, $shift_hashref, $traits) = @_;
+        my $extra_code = $compile->($name, $proto, $traits);
         my $main_handler = sub { shift if $shift_hashref;
           ("DONE", $run->($name, $proto, @_));
         };
@@ -199,52 +211,298 @@ sub install_declarator {
   });
 }
 
-=head1 NAME
-
-Devel::Declare - 
-
-=head1 SYNOPSIS
+sub linestr_callback_rv2cv {
+  my ($name, $offset) = @_;
+  $offset += toke_move_past_token($offset);
+  my $pack = get_curstash_name();
+  my $flags = $declarators{$pack}{$name};
+  my ($found_name, $found_proto);
+  if ($flags & DECLARE_NAME) {
+    $offset += toke_skipspace($offset);
+    my $linestr = get_linestr();
+    if (substr($linestr, $offset, 2) eq '::') {
+      substr($linestr, $offset, 2) = '';
+      set_linestr($linestr);
+    }
+    if (my $len = toke_scan_word($offset, $flags & DECLARE_PACKAGE)) {
+      $found_name = substr($linestr, $offset, $len);
+      $offset += $len;
+    }
+  }
+  if ($flags & DECLARE_PROTO) {
+    $offset += toke_skipspace($offset);
+    my $linestr = get_linestr();
+    if (substr($linestr, $offset, 1) eq '(') {
+      my $length = toke_scan_str($offset);
+      $found_proto = get_lex_stuff();
+      clear_lex_stuff();
+      my $replace =
+        ($found_name ? ' ' : '=')
+        .'X'.(' ' x length($found_proto));
+      $linestr = get_linestr();
+      substr($linestr, $offset, $length) = $replace;
+      set_linestr($linestr);
+      $offset += $length;
+    }
+  }
+  my @args = ($pack, $name, $pack, $found_name, $found_proto);
+  $offset += toke_skipspace($offset);
+  my $linestr = get_linestr();
+  if (substr($linestr, $offset, 1) eq '{') {
+    my $ret = init_declare(@args);
+    $offset++;
+    if (defined $ret && length $ret) {
+      substr($linestr, $offset, 0) = $ret;
+      set_linestr($linestr);
+    }
+  } else {
+    init_declare(@args);
+  }
+  #warn "linestr now ${linestr}";
+}
 
-Look at the tests. This module is currently on CPAN to ease smoke testing
-and allow early adopters who've been involved in the design to experiment
-with it.
+sub linestr_callback_const {
+  my ($name, $offset) = @_;
+  my $pack = get_curstash_name();
+  my $flags = $declarators{$pack}{$name};
+  if ($flags & DECLARE_NAME) {
+    $offset += toke_move_past_token($offset);
+    $offset += toke_skipspace($offset);
+    if (toke_scan_word($offset, $flags & DECLARE_PACKAGE)) {
+      my $linestr = get_linestr();
+      substr($linestr, $offset, 0) = '::';
+      set_linestr($linestr);
+    }
+  }
+}
 
-=head1 DESCRIPTION
+sub linestr_callback {
+  my $type = shift;
+  my $name = $_[0];
+  my $pack = get_curstash_name();
+  my $handlers = $declarator_handlers{$pack}{$name};
+  if (ref $handlers eq 'CODE') {
+    my $meth = "linestr_callback_${type}";
+    __PACKAGE__->can($meth)->(@_);
+  } elsif (ref $handlers eq 'HASH') {
+    if ($handlers->{$type}) {
+      $handlers->{$type}->(@_);
+    }
+  } else {
+    die "PANIC: unknown thing in handlers for $pack $name: $handlers";
+  }
+}
 
-=head2 import
+=head1 NAME
 
-  use Devel::Declare qw(list of subs);
+Devel::Declare - 
 
-Calls Devel::Declare->setup_for(__PACKAGE__ => \@list_of_subs);
+=head1 SYNOPSIS
 
-=head2 unimport
+  use Devel::Declare ();
+  
+  {
+    package MethodHandlers;
+  
+    use strict;
+    use warnings;
+    use B::Hooks::EndOfScope;
+  
+    our ($Declarator, $Offset);
+  
+    sub skip_declarator {
+      $Offset += Devel::Declare::toke_move_past_token($Offset);
+    }
+  
+    sub skipspace {
+      $Offset += Devel::Declare::toke_skipspace($Offset);
+    }
+  
+    sub strip_name {
+      skipspace;
+      if (my $len = Devel::Declare::toke_scan_word($Offset, 1)) {
+        my $linestr = Devel::Declare::get_linestr();
+        my $name = substr($linestr, $Offset, $len);
+        substr($linestr, $Offset, $len) = '';
+        Devel::Declare::set_linestr($linestr);
+        return $name;
+      }
+      return;
+    }
+  
+    sub strip_proto {
+      skipspace;
+      
+      my $linestr = Devel::Declare::get_linestr();
+      if (substr($linestr, $Offset, 1) eq '(') {
+        my $length = Devel::Declare::toke_scan_str($Offset);
+        my $proto = Devel::Declare::get_lex_stuff();
+        Devel::Declare::clear_lex_stuff();
+        $linestr = Devel::Declare::get_linestr();
+        substr($linestr, $Offset, $length) = '';
+        Devel::Declare::set_linestr($linestr);
+        return $proto;
+      }
+      return;
+    }
+  
+    sub shadow {
+      my $pack = Devel::Declare::get_curstash_name;
+      Devel::Declare::shadow_sub("${pack}::${Declarator}", $_[0]);
+    }
+  
+    # undef  -> my ($self) = shift;
+    # ''     -> my ($self) = @_;
+    # '$foo' -> my ($self, $foo) = @_;
+  
+    sub make_proto_unwrap {
+      my ($proto) = @_;
+      my $inject = 'my ($self';
+      if (defined $proto) {
+        $inject .= ", $proto" if length($proto);
+        $inject .= ') = @_; ';
+      } else {
+        $inject .= ') = shift;';
+      }
+      return $inject;
+    }
+  
+    sub inject_if_block {
+      my $inject = shift;
+      skipspace;
+      my $linestr = Devel::Declare::get_linestr;
+      if (substr($linestr, $Offset, 1) eq '{') {
+        substr($linestr, $Offset+1, 0) = $inject;
+        Devel::Declare::set_linestr($linestr);
+      }
+    }
 
-  no Devel::Declare;
+    sub scope_injector_call {
+      return ' BEGIN { MethodHandlers::inject_scope }; ';
+    }
+  
+    sub parser {
+      local ($Declarator, $Offset) = @_;
+      skip_declarator;
+      my $name = strip_name;
+      my $proto = strip_proto;
+      my $inject = make_proto_unwrap($proto);
+      if (defined $name) {
+        $inject = scope_injector_call().$inject;
+      }
+      inject_if_block($inject);
+      if (defined $name) {
+        $name = join('::', Devel::Declare::get_curstash_name(), $name)
+          unless ($name =~ /::/);
+        shadow(sub (&) { no strict 'refs'; *{$name} = shift; });
+      } else {
+        shadow(sub (&) { shift });
+      }
+    }
+  
+    sub inject_scope {
+      on_scope_end {
+        my $linestr = Devel::Declare::get_linestr;
+        my $offset = Devel::Declare::get_linestr_offset;
+        substr($linestr, $offset, 0) = ';';
+        Devel::Declare::set_linestr($linestr);
+      };
+    }
+  }
+  
+  my ($test_method1, $test_method2, @test_list);
+  
+  {
+    package DeclareTest;
+  
+    sub method (&);
+  
+    BEGIN {
+      Devel::Declare->setup_for(
+        __PACKAGE__,
+        { method => { const => \&MethodHandlers::parser } }
+      );
+    }
+  
+    method new {
+      my $class = ref $self || $self;
+      return bless({ @_ }, $class);
+    }
+  
+    method foo ($foo) {
+      return (ref $self).': Foo: '.$foo;
+    }
+  
+    method upgrade(){ # no spaces to make case pathological
+      bless($self, 'DeclareTest2');
+    }
+  
+    method DeclareTest2::bar () {
+      return 'DeclareTest2: bar';
+    }
+  
+    $test_method1 = method {
+      return join(', ', $self->{attr}, $_[1]);
+    };
+  
+    $test_method2 = method ($what) {
+      return join(', ', ref $self, $what);
+    };
+  
+    method main () { return "main"; }
+  
+    @test_list = (method { 1 }, sub { 2 }, method () { 3 }, sub { 4 });
+  
+  }
+  
+  use Test::More 'no_plan';
+  
+  my $o = DeclareTest->new(attr => "value");
+  
+  isa_ok($o, 'DeclareTest');
+  
+  is($o->{attr}, 'value', '@_ args ok');
+  
+  is($o->foo('yay'), 'DeclareTest: Foo: yay', 'method with argument ok');
+  
+  is($o->main, 'main', 'declaration of package named method ok');
+  
+  $o->upgrade;
+  
+  isa_ok($o, 'DeclareTest2');
+  
+  is($o->bar, 'DeclareTest2: bar', 'absolute method declaration ok');
+  
+  is($o->$test_method1('no', 'yes'), 'value, yes', 'anon method with @_ ok');
+  
+  is($o->$test_method2('this'), 'DeclareTest2, this', 'anon method with proto ok');
+  
+  is_deeply([ map { $_->() } @test_list ], [ 1, 2, 3, 4], 'binding ok');
+
+(this is t/method-no-semi.t in this distribution)
 
-Calls Devel::Declare->teardown_for(__PACKAGE__);
+=head1 DESCRIPTION
 
 =head2 setup_for
 
-  Devel::Declare->setup_for($package => \@subnames);
-
-Installs declarator magic (unless already installed) and registers
-"${package}::$name" for each member of @subnames
-
-=head2 teardown_for
-
-  Devel::Declare->teardown_for($package);
+  Devel::Declare->setup_for(
+    $package,
+    {
+      $name => { $op_type => $sub }
+    }
+  );
 
-Deregisters all subs currently registered for $package and uninstalls
-declarator magic if number of teardown_for calls matches number of setup_for
-calls.
+Currently valid op types: 'check', 'rv2cv'
 
-=head1 AUTHOR
+=head1 AUTHORS
 
 Matt S Trout - <mst@shadowcat.co.uk>
 
 Company: http://www.shadowcat.co.uk/
 Blog: http://chainsawblues.vox.com/
 
+Florian Ragwitz E<lt>rafl@debian.orgE<gt>
+
 =head1 LICENSE
 
 This library is free software under the same terms as perl itself