X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FScope%2FUpper.pm;h=6e02d2cc7d83004c609b9ff98f89a3d683aea727;hb=1e8a530156ab09a816d8afc37692d1b46032eb32;hp=91219ff91e5b7fcd63cf1027d022412d35bce5d1;hpb=3ccbf65d886255fab86d078e7807d78c576290f3;p=perl%2Fmodules%2FScope-Upper.git

diff --git a/lib/Scope/Upper.pm b/lib/Scope/Upper.pm
index 91219ff..6e02d2c 100644
--- a/lib/Scope/Upper.pm
+++ b/lib/Scope/Upper.pm
@@ -117,11 +117,11 @@ BEGIN {
 
 =head2 C<reap $callback, $context>
 
-Add a destructor that calls C<$callback> (in void context) when the upper scope represented by C<$context> ends.
+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>
 
-A C<local> delayed to the time of first return into the upper scope denoted by C<$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
@@ -161,18 +161,25 @@ For example,
     }
 
 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>
 
-Similar to L</localize> but for array and hash elements.
-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.
+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>.
+Just like for L</localize>, the type of localization is determined from which kind of reference C<$value> is when C<$what> is a glob, and from the sigil when it's a string.
 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>
 
-Similiar to L</localize>, but for deleting variables or array/hash elements.
+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
@@ -195,7 +202,7 @@ C<$key> is ignored.
 
 =head2 C<unwind @values, $context>
 
-Returns C<@values> I<from> the context pointed by C<$context>, i.e. from the subroutine, eval or format just above C<$context>, and immediately restart the program flow at this point - thus effectively returning to (or from, depending on how you see it) an upper 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
@@ -211,7 +218,7 @@ You can use L</want_at> to handle these cases.
 
 =head2 C<want_at $context>
 
-Like C<wantarray>, but for the subroutine/eval/format just above C<$context>.
+Like C<wantarray>, but for the subroutine/eval/format at or just above C<$context>.
 
 The previous example can then be "corrected" :