/usr/lib/perl5/Scope/Upper.pm is in libscope-upper-perl 0.18-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | package Scope::Upper;
use strict;
use warnings;
=head1 NAME
Scope::Upper - Act on upper scopes.
=head1 VERSION
Version 0.18
=cut
our $VERSION;
BEGIN {
$VERSION = '0.18';
}
=head1 SYNOPSIS
L</reap>, L</localize>, L</localize_elem>, L</localize_delete> and L</WORDS> :
package Scope;
use Scope::Upper qw<
reap localize localize_elem localize_delete
:words
>;
sub new {
my ($class, $name) = @_;
localize '$tag' => bless({ name => $name }, $class) => UP;
reap { print Scope->tag->name, ": end\n" } UP;
}
# Get the tag stored in the caller namespace
sub tag {
my $l = 0;
my $pkg = __PACKAGE__;
$pkg = caller $l++ while $pkg eq __PACKAGE__;
no strict 'refs';
${$pkg . '::tag'};
}
sub name { shift->{name} }
# Locally capture warnings and reprint them with the name prefixed
sub catch {
localize_elem '%SIG', '__WARN__' => sub {
print Scope->tag->name, ': ', @_;
} => UP;
}
# Locally clear @INC
sub private {
for (reverse 0 .. $#INC) {
# First UP is the for loop, second is the sub boundary
localize_delete '@INC', $_ => UP UP;
}
}
...
package UserLand;
{
Scope->new("top"); # initializes $UserLand::tag
{
Scope->catch;
my $one = 1 + undef; # prints "top: Use of uninitialized value..."
{
Scope->private;
eval { require Cwd };
print $@; # prints "Can't locate Cwd.pm in @INC
} # (@INC contains:) at..."
require Cwd; # loads Cwd.pm
}
} # prints "top: done"
L</unwind> and L</want_at> :
package Try;
use Scope::Upper qw<unwind want_at :words>;
sub try (&) {
my @result = shift->();
my $cx = SUB UP; # Point to the sub above this one
unwind +(want_at($cx) ? @result : scalar @result) => $cx;
}
...
sub zap {
try {
my @things = qw<a b c>;
return @things; # returns to try() and then outside zap()
# not reached
};
# not reached
}
my @stuff = zap(); # @stuff contains qw<a b c>
my $stuff = zap(); # $stuff contains 3
L</uplevel> :
package Uplevel;
use Scope::Upper qw<uplevel CALLER>;
sub target {
faker(@_);
}
sub faker {
uplevel {
my $sub = (caller 0)[3];
print "$_[0] from $sub()";
} @_ => CALLER(1);
}
target('hello'); # "hello from Uplevel::target()"
L</uid> and L</validate_uid> :
use Scope::Upper qw<uid validate_uid>;
my $uid;
{
$uid = uid();
{
if ($uid eq uid(UP)) { # yes
...
}
if (validate_uid($uid)) { # yes
...
}
}
}
if (validate_uid($uid)) { # no
...
}
=head1 DESCRIPTION
This module lets you defer actions I<at run-time> that will take place when the control flow returns into an upper scope.
Currently, you can:
=over 4
=item *
hook an upper scope end with L</reap> ;
=item *
localize variables, array/hash values or deletions of elements in higher contexts with respectively L</localize>, L</localize_elem> and L</localize_delete> ;
=item *
return values immediately to an upper level with L</unwind>, and know which context was in use then with L</want_at> ;
=item *
execute a subroutine in the setting of an upper subroutine stack frame with L</uplevel> ;
=item *
uniquely identify contextes with L</uid> and L</validate_uid>.
=back
=head1 FUNCTIONS
In all those functions, C<$context> refers to the target scope.
You have to use one or a combination of L</WORDS> to build the C<$context> passed to these functions.
This is needed in order to ensure that the module still works when your program is ran in the debugger.
The only thing you can assume is that it is an I<absolute> indicator of the frame, which means that you can safely store it at some point and use it when needed, and it will still denote the original scope.
=cut
BEGIN {
require XSLoader;
XSLoader::load(__PACKAGE__, $VERSION);
}
=head2 C<reap $callback, $context>
Adds a destructor that calls C<$callback> (in void context) when the upper scope represented by C<$context> ends.
=head2 C<localize $what, $value, $context>
Introduces a C<local> delayed to the time of first return into the upper scope denoted by C<$context>.
C<$what> can be :
=over 4
=item *
A glob, in which case C<$value> can either be a glob or a reference.
L</localize> follows then the same syntax as C<local *x = $value>.
For example, if C<$value> is a scalar reference, then the C<SCALAR> slot of the glob will be set to C<$$value> - just like C<local *x = \1> sets C<$x> to C<1>.
=item *
A string beginning with a sigil, representing the symbol to localize and to assign to.
If the sigil is C<'$'>, L</localize> follows the same syntax as C<local $x = $value>, i.e. C<$value> isn't dereferenced.
For example,
localize '$x', \'foo' => HERE;
will set C<$x> to a reference to the string C<'foo'>.
Other sigils (C<'@'>, C<'%'>, C<'&'> and C<'*'>) require C<$value> to be a reference of the corresponding type.
When the symbol is given by a string, it is resolved when the actual localization takes place and not when L</localize> is called.
Thus, if the symbol name is not qualified, it will refer to the variable in the package where the localization actually takes place and not in the one where the L</localize> call was compiled.
For example,
{
package Scope;
sub new { localize '$tag', $_[0] => UP }
}
{
package Tool;
{
Scope->new;
...
}
}
will localize C<$Tool::tag> and not C<$Scope::tag>.
If you want the other behaviour, you just have to specify C<$what> as a glob or a qualified name.
Note that if C<$what> is a string denoting a variable that wasn't declared beforehand, the relevant slot will be vivified as needed and won't be deleted from the glob when the localization ends.
This situation never arises with C<local> because it only compiles when the localized variable is already declared.
Although I believe it shouldn't be a problem as glob slots definedness is pretty much an implementation detail, this behaviour may change in the future if proved harmful.
=back
=head2 C<localize_elem $what, $key, $value, $context>
Introduces a C<local $what[$key] = $value> or C<local $what{$key} = $value> delayed to the time of first return into the upper scope denoted by C<$context>.
Unlike L</localize>, C<$what> must be a string and the type of localization is inferred from its sigil.
The two only valid types are array and hash ; for anything besides those, L</localize_elem> will throw an exception.
C<$key> is either an array index or a hash key, depending of which kind of variable you localize.
If C<$what> is a string pointing to an undeclared variable, the variable will be vivified as soon as the localization occurs and emptied when it ends, although it will still exist in its glob.
=head2 C<localize_delete $what, $key, $context>
Introduces the deletion of a variable or an array/hash element delayed to the time of first return into the upper scope denoted by C<$context>.
C<$what> can be:
=over 4
=item *
A glob, in which case C<$key> is ignored and the call is equivalent to C<local *x>.
=item *
A string beginning with C<'@'> or C<'%'>, for which the call is equivalent to respectiveley C<local $a[$key]; delete $a[$key]> and C<local $h{$key}; delete $h{$key}>.
=item *
A string beginning with C<'&'>, which more or less does C<undef &func> in the upper scope.
It's actually more powerful, as C<&func> won't even C<exists> anymore.
C<$key> is ignored.
=back
=head2 C<unwind @values, $context>
Returns C<@values> I<from> the context pointed by C<$context>, i.e. from the subroutine, eval or format at or just above C<$context>, and immediately restart the program flow at this point - thus effectively returning to an upper scope.
The upper context isn't coerced onto C<@values>, which is hence always evaluated in list context.
This means that
my $num = sub {
my @a = ('a' .. 'z');
unwind @a => HERE;
# not reached
}->();
will set C<$num> to C<'z'>.
You can use L</want_at> to handle these cases.
=head2 C<want_at $context>
Like C<wantarray>, but for the subroutine/eval/format at or just above C<$context>.
The previous example can then be "corrected" :
my $num = sub {
my @a = ('a' .. 'z');
unwind +(want_at(HERE) ? @a : scalar @a) => HERE;
# not reached
}->();
will rightfully set C<$num> to C<26>.
=head2 C<uplevel $code, @args, $context>
Executes the code reference C<$code> with arguments C<@args> as if it were located at the subroutine stack frame pointed by C<$context>, effectively fooling C<caller> and C<die> into believing that the call actually happened higher in the stack.
The code is executed in the context of the C<uplevel> call, and what it returns is returned as-is by C<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); # $count is 3
L<Sub::Uplevel> also implements a pure-Perl version of C<uplevel>.
Both are identical, with the following caveats :
=over 4
=item *
The L<Sub::Uplevel> implementation of C<uplevel> may execute a code reference in the context of B<any> upper stack frame.
The L<Scope::Upper> version can only uplevel to a B<subroutine> stack frame, and will croak if you try to target an C<eval> or a format.
=item *
Exceptions thrown from the code called by this version of C<uplevel> will not be caught by C<eval> blocks between the target frame and the uplevel call, while they will for L<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 L<Sub::Uplevel> and "outer block: wut..." with L<Scope::Upper>.
=item *
L<Sub::Uplevel> globally overrides the Perl keyword C<caller>, while L<Scope::Upper> does not.
=back
A simple wrapper lets you mimic the interface of L<Sub::Uplevel/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 L<Sub::Uplevel>.
=head2 C<uid $context>
Returns an unique identifier (UID) for the context (or dynamic scope) pointed by C<$context>, or for the current context if C<$context> is omitted.
This UID will only be valid for the life time of the context it represents, and another UID will be generated next time the same scope is executed.
my $uid;
{
$uid = uid;
if ($uid eq uid()) { # yes, this is the same context
...
}
{
if ($uid eq uid()) { # no, we are one scope below
...
}
if ($uid eq uid(UP)) { # yes, UP points to the same scope as $uid
...
}
}
}
# $uid is now invalid
{
if ($uid eq uid()) { # no, this is another block
...
}
}
For example, each loop iteration gets its own UID :
my %uids;
for (1 .. 5) {
my $uid = uid;
$uids{$uid} = $_;
}
# %uids has 5 entries
The UIDs are not guaranteed to be numbers, so you must use the C<eq> operator to compare them.
To check whether a given UID is valid, you can use the L</validate_uid> function.
=head2 C<validate_uid $uid>
Returns true if and only if C<$uid> is the UID of a currently valid context (that is, it designates a scope that is higher than the current one in the call stack).
my $uid;
{
$uid = uid();
if (validate_uid($uid)) { # yes
...
}
{
if (validate_uid($uid)) { # yes
...
}
}
}
if (validate_uid($uid)) { # no
...
}
=head1 CONSTANTS
=head2 C<SU_THREADSAFE>
True iff the module could have been built when thread-safety features.
=head1 WORDS
=head2 Constants
=head3 C<TOP>
Returns the context that currently represents the highest scope.
=head3 C<HERE>
The context of the current scope.
=head2 Getting a context from a context
For any of those functions, C<$from> is expected to be a context.
When omitted, it defaults to the the current context.
=head3 C<UP $from>
The context of the scope just above C<$from>.
=head3 C<SUB $from>
The context of the closest subroutine above C<$from>.
Note that C<$from> is returned if it is already a subroutine context ; hence C<SUB SUB == SUB>.
=head3 C<EVAL $from>
The context of the closest eval above C<$from>.
Note that C<$from> is returned if it is already an eval context ; hence C<EVAL EVAL == EVAL>.
=head2 Getting a context from a level
Here, C<$level> should denote a number of scopes above the current one.
When omitted, it defaults to C<0> and those functions return the same context as L</HERE>.
=head3 C<SCOPE $level>
The C<$level>-th upper context, regardless of its type.
=head3 C<CALLER $level>
The context of the C<$level>-th upper subroutine/eval/format.
It kind of corresponds to the context represented by C<caller $level>, but while e.g. C<caller 0> refers to the caller context, C<CALLER 0> will refer to the top scope in the current context.
=head2 Examples
Where L</reap> fires depending on the C<$cxt> :
sub {
eval {
sub {
{
reap \&cleanup => $cxt;
...
} # $cxt = SCOPE(0) = HERE
...
}->(); # $cxt = SCOPE(1) = UP = SUB = CALLER(0)
...
}; # $cxt = SCOPE(2) = UP UP = UP SUB = EVAL = CALLER(1)
...
}->(); # $cxt = SCOPE(3) = SUB UP SUB = SUB EVAL = CALLER(2)
...
Where L</localize>, L</localize_elem> and L</localize_delete> act depending on the C<$cxt> :
sub {
eval {
sub {
{
localize '$x' => 1 => $cxt;
# $cxt = SCOPE(0) = HERE
...
}
# $cxt = SCOPE(1) = UP = SUB = CALLER(0)
...
}->();
# $cxt = SCOPE(2) = UP UP = UP SUB = EVAL = CALLER(1)
...
};
# $cxt = SCOPE(3) = SUB UP SUB = SUB EVAL = CALLER(2)
...
}->();
# $cxt = SCOPE(4), UP SUB UP SUB = UP SUB EVAL = UP CALLER(2) = TOP
...
Where L</unwind>, L</want_at> and L</uplevel> point to depending on the C<$cxt>:
sub {
eval {
sub {
{
unwind @things => $cxt; # or uplevel { ... } $cxt;
...
}
...
}->(); # $cxt = SCOPE(0) = SCOPE(1) = HERE = UP = SUB = CALLER(0)
...
}; # $cxt = SCOPE(2) = UP UP = UP SUB = EVAL = CALLER(1) (*)
...
}->(); # $cxt = SCOPE(3) = SUB UP SUB = SUB EVAL = CALLER(2)
...
# (*) Note that uplevel() will croak if you pass that scope frame,
# because it cannot target eval scopes.
=head1 EXPORT
The functions L</reap>, L</localize>, L</localize_elem>, L</localize_delete>, L</unwind>, L</want_at> and L</uplevel> are only exported on request, either individually or by the tags C<':funcs'> and C<':all'>.
The constant L</SU_THREADSAFE> is also only exported on request, individually or by the tags C<':consts'> and C<':all'>.
Same goes for the words L</TOP>, L</HERE>, L</UP>, L</SUB>, L</EVAL>, L</SCOPE> and L</CALLER> that are only exported on request, individually or by the tags C<':words'> and C<':all'>.
=cut
use base qw<Exporter>;
our @EXPORT = ();
our %EXPORT_TAGS = (
funcs => [ qw<
reap
localize localize_elem localize_delete
unwind want_at
uplevel
uid validate_uid
> ],
words => [ qw<TOP HERE UP SUB EVAL SCOPE CALLER> ],
consts => [ qw<SU_THREADSAFE> ],
);
our @EXPORT_OK = map { @$_ } values %EXPORT_TAGS;
$EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
=head1 CAVEATS
Be careful that local variables are restored in the reverse order in which they were localized.
Consider those examples:
local $x = 0;
{
reap sub { print $x } => HERE;
local $x = 1;
...
}
# prints '0'
...
{
local $x = 1;
reap sub { $x = 2 } => HERE;
...
}
# $x is 0
The first case is "solved" by moving the C<local> before the C<reap>, and the second by using L</localize> instead of L</reap>.
The effects of L</reap>, L</localize> and L</localize_elem> can't cross C<BEGIN> blocks, hence calling those functions in C<import> is deemed to be useless.
This is an hopeless case because C<BEGIN> blocks are executed once while localizing constructs should do their job at each run.
However, it's possible to hook the end of the current scope compilation with L<B::Hooks::EndOfScope>.
Some rare oddities may still happen when running inside the debugger.
It may help to use a perl higher than 5.8.9 or 5.10.0, as they contain some context-related fixes.
Calling C<goto> to replace an L</uplevel>'d code frame does not work :
=over 4
=item *
for a C<perl> older than the 5.8 series ;
=item *
for a C<DEBUGGING> C<perl> run with debugging flags set (as in C<perl -D ...>) ;
=item *
when the runloop callback is replaced by another module.
=back
In those three cases, L</uplevel> will look for a C<goto &sub> statement in its callback and, if there is one, throw an exception before executing the code.
Moreover, in order to handle C<goto> statements properly, L</uplevel> currently has to suffer a run-time overhead proportional to the size of the the callback in every case (with a small ratio), and proportional to the size of B<all> the code executed as the result of the L</uplevel> call (including subroutine calls inside the callback) when a C<goto> statement is found in the L</uplevel> callback.
Despite this shortcoming, this XS version of L</uplevel> should still run way faster than the pure-Perl version from L<Sub::Uplevel>.
=head1 DEPENDENCIES
L<XSLoader> (standard since perl 5.006).
=head1 SEE ALSO
L<perlfunc/local>, L<perlsub/"Temporary Values via local()">.
L<Alias>, L<Hook::Scope>, L<Scope::Guard>, L<Guard>.
L<Sub::Uplevel>.
L<Continuation::Escape> is a thin wrapper around L<Scope::Upper> that gives you a continuation passing style interface to L</unwind>.
It's easier to use, but it requires you to have control over the scope where you want to return.
L<Scope::Escape>.
=head1 AUTHOR
Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
You can contact me by mail or on C<irc.perl.org> (vincent).
=head1 BUGS
Please report any bugs or feature requests to C<bug-scope-upper at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Scope-Upper>.
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Scope::Upper
Tests code coverage report is available at L<http://www.profvince.com/perl/cover/Scope-Upper>.
=head1 ACKNOWLEDGEMENTS
Inspired by Ricardo Signes.
Thanks to Shawn M. Moore for motivation.
=head1 COPYRIGHT & LICENSE
Copyright 2008,2009,2010,2011 Vincent Pit, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
=cut
1; # End of Scope::Upper
|