lib/Scope/Upper.pm

   1 package Scope::Upper;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Scope::Upper - Act on upper scopes.
   9
  10 =head1 VERSION
  11
  12 Version 0.02
  13
  14 =cut
  15
  16 our $VERSION;
  17 BEGIN {
  18  $VERSION = '0.02';
  19 }
  20
  21 =head1 SYNOPSIS
  22
  23     package X;
  24
  25     use Scope::Upper qw/reap localize localize_elem/;
  26
  27     sub desc { shift->{desc} }
  28
  29     sub set_tag {
  30      my ($desc) = @_;
  31
  32      # First localize $x so that it gets destroyed last
  33      localize '$x' => bless({ desc => $desc }, __PACKAGE__) => 1;
  34
  35      reap sub {
  36       my $pkg = caller;
  37       my $x = do { no strict 'refs'; ${$pkg.'::x'} }; # Get the $x in the scope
  38       print $x->desc . ": done\n";
  39      } => 1;
  40
  41      localize_elem '%SIG', '__WARN__' => sub {
  42       my $pkg = caller;
  43       my $x = do { no strict 'refs'; ${$pkg.'::x'} }; # Get the $x in the scope
  44       CORE::warn($x->desc . ': ' . join('', @_));
  45      } => 1;
  46     }
  47
  48     package Y;
  49
  50     {
  51      X::set_tag('pie');
  52      # $x is now a X object
  53      warn 'what'; # warns "pie: what at ..."
  54      ...
  55     } # "pie: done" is printed
  56
  57 =head1 DESCRIPTION
  58
  59 This module lets you defer actions that will take place when the control flow returns into an upper scope.
  60 Currently, you can hook an upper scope end, or localize variables and array/hash values in higher contexts.
  61
  62 =head1 FUNCTIONS
  63
  64 =cut
  65
  66 BEGIN {
  67  require XSLoader;
  68  XSLoader::load(__PACKAGE__, $VERSION);
  69 }
  70
  71 =head2 C<reap $callback, $level>
  72
  73 Add a destructor that calls C<$callback> when the C<$level>-th upper scope ends, where C<0> corresponds to the current scope.
  74
  75 =head2 C<localize $what, $value, $level>
  76
  77 A C<local> delayed to the time of first return into the C<$level>-th upper scope.
  78 C<$what> can be :
  79
  80 =over 4
  81
  82 =item *
  83
  84 A glob, in which case C<$value> can either be a glob or a reference.
  85 L</localize> follows then the same syntax as C<local *x = $value>.
  86 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>.
  87
  88 =item *
  89
  90 A string beginning with a sigil, representing the symbol to localize and to assign to.
  91 If the sigil is C<'$'>, L</localize> follows the same syntax as C<local $x = $value>, i.e. C<$value> isn't dereferenced.
  92 For example,
  93
  94     localize '$x', \'foo' => 0;
  95
  96 will set C<$x> to a reference to the string C<'foo'>.
  97 Other sigils (C<'@'>, C<'%'>, C<'&'> and C<'*'>) require C<$value> to be a reference of the corresponding type.
  98
  99 When the symbol is given by a string, it is resolved when the actual localization takes place and not when C<localize> is called.
 100 This means that
 101
 102     sub tag { localize '$x', $_[0] => 1; }
 103
 104 will localize in the caller's namespace.
 105
 106 =back
 107
 108 =head2 C<localize_elem $what, $key, $value, $level>
 109
 110 Similar to L</localize> but for array and hash elements.
 111 If C<$what> is a glob, the slot to fill is determined from which type of reference C<$value> is ; otherwise it's inferred from the sigil.
 112 C<$key> is either an array index or a hash key, depending of which kind of variable you localize.
 113
 114 =head2 C<TOPLEVEL>
 115
 116 Returns the level that currently represents the highest scope.
 117
 118 =head1 EXPORT
 119
 120 The functions L</reap>, L</localize>, L</localize_elem> and L</TOPLEVEL> are only exported on request, either individually or by the tags C<':funcs'> and C<':all'>.
 121
 122 =cut
 123
 124 use base qw/Exporter/;
 125
 126 our @EXPORT      = ();
 127 our %EXPORT_TAGS = (
 128  funcs => [ qw/reap localize localize_elem TOPLEVEL/ ],
 129 );
 130 our @EXPORT_OK   = map { @$_ } values %EXPORT_TAGS;
 131 $EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
 132
 133 =head1 CAVEATS
 134
 135 Be careful that local variables are restored in the reverse order in which they were localized.
 136 Consider those examples:
 137
 138     local $x = 0;
 139     {
 140      reap sub { print $x } => 0;
 141      local $x = 1;
 142      ...
 143     }
 144     # prints '0'
 145     ...
 146     {
 147      local $x = 1;
 148      reap sub { $x = 2 } => 0;
 149      ...
 150     }
 151     # $x is 0
 152
 153 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>.
 154
 155 L</reap>, L</localize> and L</localize_elem> effects can't cross C<BEGIN> blocks, hence calling those functions in C<import> is deemed to be useless.
 156 This is an hopeless case because C<BEGIN> blocks are executed once while localizing constructs should do their job at each run.
 157
 158 =head1 DEPENDENCIES
 159
 160 L<XSLoader> (standard since perl 5.006).
 161
 162 =head1 SEE ALSO
 163
 164 L<Alias>, L<Hook::Scope>, L<Scope::Guard>, L<Guard>.
 165
 166 =head1 AUTHOR
 167
 168 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 169
 170 You can contact me by mail or on C<irc.perl.org> (vincent).
 171
 172 =head1 BUGS
 173
 174 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.
 175
 176 =head1 SUPPORT
 177
 178 You can find documentation for this module with the perldoc command.
 179
 180     perldoc Scope::Upper
 181
 182 Tests code coverage report is available at L<http://www.profvince.com/perl/cover/Scope-Upper>.
 183
 184 =head1 ACKNOWLEDGEMENTS
 185
 186 Inspired by Ricardo Signes.
 187
 188 =head1 COPYRIGHT & LICENSE
 189
 190 Copyright 2008 Vincent Pit, all rights reserved.
 191
 192 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 193
 194 =cut
 195
 196 1; # End of Scope::Upper