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
|
package autovivification;
use 5.008;
use strict;
use warnings;
=head1 NAME
autovivification - Lexically disable autovivification.
=head1 VERSION
Version 0.06
=cut
our $VERSION;
BEGIN {
$VERSION = '0.06';
}
=head1 SYNOPSIS
no autovivification;
my $hashref;
my $a = $hashref->{key_a}; # $hashref stays undef
if (exists $hashref->{option}) { # Still undef
...
}
delete $hashref->{old}; # Still undef again
$hashref->{new} = $value; # Vivifies to { new => $value }
=head1 DESCRIPTION
When an undefined variable is dereferenced, it gets silently upgraded to an array or hash reference (depending of the type of the dereferencing).
This behaviour is called I<autovivification> and usually does what you mean (e.g. when you store a value) but it's sometimes unnatural or surprising because your variables gets populated behind your back.
This is especially true when several levels of dereferencing are involved, in which case all levels are vivified up to the last, or when it happens in intuitively read-only constructs like C<exists>.
This pragma lets you disable autovivification for some constructs and optionally throws a warning or an error when it would have happened.
=cut
BEGIN {
require XSLoader;
XSLoader::load(__PACKAGE__, $VERSION);
}
=head1 METHODS
=head2 C<unimport @opts>
Magically called when C<no autovivification> is encountered.
Enables the features given in C<@opts>, which can be :
=over 4
=item *
C<'fetch'>
Turn off autovivification for rvalue dereferencing expressions, such as C<< $value = $hashref->{key}[$idx]{$field} >>, C<< keys %{$hashref->{key}} >> or C<< values %{$hashref->{key}} >>.
Starting from perl C<5.11>, it also covers C<keys> and C<values> on array references.
When the expression would have autovivified, C<undef> is returned for a plain fetch, while C<keys> and C<values> return C<0> in scalar context and the empty list in list context.
=item *
C<'exists'>
Turn off autovivification for dereferencing expressions that are parts of an C<exists>, such as C<< exists $hashref->{key}[$idx]{$field} >>.
C<''> is returned when the expression would have autovivified.
=item *
C<'delete'>
Turn off autovivification for dereferencing expressions that are parts of a C<delete>, such as C<< delete $hashref->{key}[$idx]{$field} >>.
C<undef> is returned when the expression would have autovivified.
=item *
C<'store'>
Turn off autovivification for lvalue dereferencing expressions, such as C<< $hashref->{key}[$idx]{$field} = $value >> or C<< for ($hashref->{key}[$idx]{$field}) { ... } >>.
An exception is thrown if vivification is needed to store the value, which means that effectively you can only assign to levels that are already defined (in the example, this would require C<< $hashref->{key}[$idx] >> to already be a hash reference).
=item *
C<'warn'>
Emit a warning when an autovivification is avoided.
=item *
C<'strict'>
Throw an exception when an autovivification is avoided.
=back
Each call to C<unimport> adds the specified features to the ones already in use in the current lexical scope.
When C<@opts> is empty, it defaults to C<qw/fetch exists delete/>.
=cut
my %bits = (
strict => A_HINT_STRICT,
warn => A_HINT_WARN,
fetch => A_HINT_FETCH,
store => A_HINT_STORE,
exists => A_HINT_EXISTS,
delete => A_HINT_DELETE,
);
sub unimport {
shift;
my $hint = _detag($^H{+(__PACKAGE__)}) || 0;
@_ = qw/fetch exists delete/ unless @_;
$hint |= $bits{$_} for grep exists $bits{$_}, @_;
$^H |= 0x00020000;
$^H{+(__PACKAGE__)} = _tag($hint);
();
}
=head2 C<import @opts>
Magically called when C<use autovivification> is encountered.
Disables the features given in C<@opts>, which can be the same as for L</unimport>.
Each call to C<import> removes the specified features to the ones already in use in the current lexical scope.
When C<@opts> is empty, it defaults to restoring the original Perl autovivification behaviour.
=cut
sub import {
shift;
my $hint = 0;
if (@_) {
$hint = _detag($^H{+(__PACKAGE__)}) || 0;
$hint &= ~$bits{$_} for grep exists $bits{$_}, @_;
}
$^H |= 0x00020000;
$^H{+(__PACKAGE__)} = _tag($hint);
();
}
=head1 CONSTANTS
=head2 C<A_THREADSAFE>
True iff the module could have been built with thread-safety features enabled.
This constant only has a meaning with your perl is threaded ; otherwise, it'll always be false.
=head2 C<A_FORKSAFE>
True iff this module could have been built with fork-safety features enabled.
This will always be true except on Windows where it's false for perl 5.10.0 and below .
=head1 CAVEATS
The pragma doesn't apply when one dereferences the returned value of an array or hash slice, as in C<< @array[$id]->{member} >> or C<< @hash{$key}->{member} >>.
This syntax is valid Perl, yet it's discouraged as the slice is here useless since the dereferencing enforces scalar context.
If warnings are turned on, Perl will complain about one-element slices.
=head1 DEPENDENCIES
L<perl> 5.8.
L<XSLoader> (standard since perl 5.006).
=head1 SEE ALSO
L<perlref>.
=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-autovivification at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=autovivification>.
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 autovivification
Tests code coverage report is available at L<http://www.profvince.com/perl/cover/autovivification>.
=head1 ACKNOWLEDGEMENTS
Matt S. Trout asked for it.
=head1 COPYRIGHT & LICENSE
Copyright 2009,2010 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 autovivification
|
