From: Vincent Pit Date: Sat, 3 Sep 2011 23:00:26 +0000 (+0200) Subject: This is 0.16 X-Git-Tag: v0.16 X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=d09fe7588cfbcaf52d7f8e59be4aebdabd1d1f38;p=perl%2Fmodules%2FScope-Upper.git This is 0.16 --- diff --git a/Changes b/Changes index 401dc7d..5fd9db0 100644 --- a/Changes +++ b/Changes @@ -1,5 +1,14 @@ Revision history for Scope-Upper +0.16 2011-09-03 23:00 UTC + + Add : uplevel($code, @args, $cxt) executes $code with arguments @args + in the upper context pointed by $cxt. + This is an XS version of the well-known uplevel() routine from + Sub::Uplevel. There are a few differences between both + implmentations that are listed in the documentation. + The XS version is roughly 10 times faster than the pure-Perl + version. + 0.15 2011-08-24 14:20 UTC + Fix : Localizing subroutines in an higher scope will now correctly update the method cache. diff --git a/META.json b/META.json index 2aaa7aa..8c9b300 100644 --- a/META.json +++ b/META.json @@ -57,5 +57,5 @@ "url" : "http://git.profvince.com/?p=perl%2Fmodules%2FScope-Upper.git" } }, - "version" : "0.15" + "version" : "0.16" } diff --git a/META.yml b/META.yml index 55e7233..ee2d607 100644 --- a/META.yml +++ b/META.yml @@ -32,4 +32,4 @@ resources: homepage: http://search.cpan.org/dist/Scope-Upper/ license: http://dev.perl.org/licenses/ repository: http://git.profvince.com/?p=perl%2Fmodules%2FScope-Upper.git -version: 0.15 +version: 0.16 diff --git a/README b/README index 54b68ff..3a5d767 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ NAME Scope::Upper - Act on upper scopes. VERSION - Version 0.15 + Version 0.16 SYNOPSIS "reap", "localize", "localize_elem", "localize_delete" and "WORDS" : @@ -94,6 +94,25 @@ SYNOPSIS my @stuff = zap(); # @stuff contains qw my $stuff = zap(); # $stuff contains 3 + "uplevel" : + + package Uplevel; + + use Scope::Upper qw; + + sub target { + faker(@_); + } + + sub faker { + uplevel { + my $sub = (caller 0)[3]; + print "$_[0] from $sub()"; + } @_ => CALLER(1); + } + + target('hello'); # "hello from Uplevel::target()" + DESCRIPTION This module lets you defer actions *at run-time* that will take place when the control flow returns into an upper scope. Currently, you can: @@ -105,7 +124,10 @@ DESCRIPTION "localize_delete" ; * return values immediately to an upper level with "unwind", and know - which context was in use then with "want_at". + which context was in use then with "want_at" ; + + * execute a subroutine in the context of an upper subroutine stack + frame with "uplevel". FUNCTIONS In all those functions, $context refers to the target scope. @@ -234,6 +256,75 @@ FUNCTIONS will rightfully set $num to 26. + "uplevel $code, @args, $context" + Executes the code reference $code with arguments @args as if it were + located at the subroutine stack frame pointed by $context, effectively + fooling "caller" and "die" into believing that the call actually + happened higher in the stack. The code is executed in the context of the + "uplevel" call, and what it returns is returned as-is by "uplevel". + + sub target { + faker(@_); + } + + sub faker { + uplevel { + map { 1 / $_ } @_; + } @_ => CALLER(1); + } + + my @inverses = target(1, 2, 4); # @inverses contains (0, 0.5, 0.25) + my $count = target(1, 2, 4); # $target is 3 + + Sub::Uplevel also implements a pure-Perl version of "uplevel". Both are + identical, with the following caveats : + + * The Sub::Uplevel implementation of "uplevel" may execute a code + reference in the context of any upper stack frame. The Scope::Upper + version only allows to uplevel to a subroutine stack frame, and will + croak if you try to target an "eval" or a format. + + * Exceptions thrown from the code called by this version of "uplevel" + will not be caught by "eval" blocks between the target frame and the + uplevel call, while they will for Sub::Uplevel's version. This means + that : + + eval { + sub { + local $@; + eval { + sub { + uplevel { die 'wut' } CALLER(2); # for Scope::Upper + # uplevel(3, sub { die 'wut' }) # for Sub::Uplevel + }->(); + }; + print "inner block: $@"; + $@ and exit; + }->(); + }; + print "outer block: $@"; + + will print "inner block: wut..." with Sub::Uplevel and "outer block: + wut..." with Scope::Upper. + + * Sub::Uplevel globally overrides "CORE::GLOBAL::caller", while + Scope::Upper does not. + + A simple wrapper lets you mimic the interface of "uplevel" in + Sub::Uplevel : + + use Scope::Upper; + + sub uplevel { + my $frame = shift; + my $code = shift; + my $cxt = Scope::Upper::CALLER($frame); + &Scope::Upper::uplevel($code => @_ => $cxt); + } + + Albeit the three exceptions listed above, it passes all the tests of + Sub::Uplevel. + CONSTANTS "SU_THREADSAFE" True iff the module could have been built when thread-safety features. @@ -316,27 +407,30 @@ WORDS # $cxt = SCOPE(4), UP SUB UP SUB, or UP SUB EVAL, or UP CALLER(2), or TOP ... - Where "unwind" and "want_at" point to depending on the $cxt: + Where "unwind", "want_at" and "uplevel" point to depending on the $cxt: sub { eval { sub { { - unwind @things => $cxt; + unwind @things => $cxt; # or uplevel { ... } $cxt; ... } ... }->(); # $cxt = SCOPE(0 .. 1), or HERE, or UP, or SUB, or CALLER(0) ... - }; # $cxt = SCOPE(2), or UP UP, or UP SUB, or EVAL, or CALLER(1) + }; # $cxt = SCOPE(2), or UP UP, or UP SUB, or EVAL, or CALLER(1) (*) ... }->(); # $cxt = SCOPE(3), or SUB UP SUB, or SUB EVAL, or CALLER(2) ... + # (*) Note that uplevel() will croak if you pass that scope frame, + # because it can't target eval scopes. + EXPORT The functions "reap", "localize", "localize_elem", "localize_delete", - "unwind" and "want_at" are only exported on request, either individually - or by the tags ':funcs' and ':all'. + "unwind", "want_at" and "uplevel" are only exported on request, either + individually or by the tags ':funcs' and ':all'. The constant "SU_THREADSAFE" is also only exported on request, individually or by the tags ':consts' and ':all'. @@ -393,6 +487,8 @@ SEE ALSO Scope::Escape. + Sub::Uplevel provides a pure-Perl implementation of "uplevel". + AUTHOR Vincent Pit, "", . diff --git a/lib/Scope/Upper.pm b/lib/Scope/Upper.pm index 7396188..34fe41f 100644 --- a/lib/Scope/Upper.pm +++ b/lib/Scope/Upper.pm @@ -9,13 +9,13 @@ Scope::Upper - Act on upper scopes. =head1 VERSION -Version 0.15 +Version 0.16 =cut our $VERSION; BEGIN { - $VERSION = '0.15'; + $VERSION = '0.16'; } =head1 SYNOPSIS