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.01
  13
  14 =cut
  15
  16 our $VERSION;
  17 BEGIN {
  18  $VERSION = '0.01';
  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 assign to.
  91 If the sigil is C<'$'>, then C<$value> isn't dereferenced, that is
  92
  93     localize '$x', \'foo' => 0;
  94
  95 will set C<$x> to a reference to the string C<'foo'>.
  96 Other sigils behave as if a glob was passed.
  97
  98 The symbol is resolved when the actual localization takes place and not when C<localize> is called.
  99 This means that
 100
 101     sub tag { localize '$x', $_[0] => 1; }
 102
 103 will localize in the caller's namespace.
 104
 105 =back
 106
 107 =head2 C<localize_elem $what, $key, $value, $level>
 108
 109 Similar to L</localize> but for array and hash elements.
 110 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.
 111 C<$key> is either an array index or a hash key, depending of which kind of variable you localize.
 112
 113 =head2 C<TOPLEVEL>
 114
 115 Returns the level that currently represents the highest scope.
 116
 117 =head1 EXPORT
 118
 119 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'>.
 120
 121 =cut
 122
 123 use base qw/Exporter/;
 124
 125 our @EXPORT      = ();
 126 our %EXPORT_TAGS = (
 127  funcs => [ qw/reap localize localize_elem TOPLEVEL/ ],
 128 );
 129 our @EXPORT_OK   = map { @$_ } values %EXPORT_TAGS;
 130 $EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
 131
 132 =head1 DEPENDENCIES
 133
 134 L<XSLoader> (standard since perl 5.006).
 135
 136 =head1 SEE ALSO
 137
 138 L<Alias>, L<Hook::Scope>, L<Scope::Guard>, L<Guard>.
 139
 140 =head1 AUTHOR
 141
 142 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 143
 144 You can contact me by mail or on C<irc.perl.org> (vincent).
 145
 146 =head1 BUGS
 147
 148 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.
 149
 150 =head1 SUPPORT
 151
 152 You can find documentation for this module with the perldoc command.
 153
 154     perldoc Scope::Upper
 155
 156 =head1 ACKNOWLEDGEMENTS
 157
 158 Inspired by Ricardo Signes.
 159
 160 =head1 COPYRIGHT & LICENSE
 161
 162 Copyright 2008 Vincent Pit, all rights reserved.
 163
 164 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 165
 166 =cut
 167
 168 1; # End of Scope::Upper