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
|
package Package::Stash;
use strict;
use warnings;
use 5.008001;
# ABSTRACT: routines for manipulating stashes
our $IMPLEMENTATION;
use Module::Implementation 0.06;
BEGIN {
local $ENV{PACKAGE_STASH_IMPLEMENTATION} = $IMPLEMENTATION
if ( $IMPLEMENTATION and not $ENV{PACKAGE_STASH_IMPLEMENTATION} );
Module::Implementation::build_loader_sub(
implementations => [ 'XS', 'PP' ]
)->();
$IMPLEMENTATION = Module::Implementation::implementation_for(__PACKAGE__);
my $impl = "Package::Stash::$IMPLEMENTATION";
my $from = $impl->new($impl);
my $to = $impl->new(__PACKAGE__);
my $methods = $from->get_all_symbols('CODE');
for my $meth (keys %$methods) {
$to->add_symbol("&$meth" => $methods->{$meth});
}
}
=head1 SYNOPSIS
my $stash = Package::Stash->new('Foo');
$stash->add_symbol('%foo', {bar => 1});
# $Foo::foo{bar} == 1
$stash->has_symbol('$foo') # false
my $namespace = $stash->namespace;
*{ $namespace->{foo} }{HASH} # {bar => 1}
=head1 DESCRIPTION
Manipulating stashes (Perl's symbol tables) is occasionally necessary, but
incredibly messy, and easy to get wrong. This module hides all of that behind a
simple API.
NOTE: Most methods in this class require a variable specification that includes
a sigil. If this sigil is absent, it is assumed to represent the IO slot.
Due to limitations in the typeglob API available to perl code, and to typeglob
manipulation in perl being quite slow, this module provides two
implementations - one in pure perl, and one using XS. The XS implementation is
to be preferred for most usages; the pure perl one is provided for cases where
XS modules are not a possibility. The current implementation in use can be set
by setting C<$ENV{PACKAGE_STASH_IMPLEMENTATION}> or
C<$Package::Stash::IMPLEMENTATION> before loading Package::Stash (with the
environment variable taking precedence), otherwise, it will use the XS
implementation if possible, falling back to the pure perl one.
=method new $package_name
Creates a new C<Package::Stash> object, for the package given as the only
argument.
=method name
Returns the name of the package that this object represents.
=method namespace
Returns the raw stash itself.
=method add_symbol $variable $value %opts
Adds a new package symbol, for the symbol given as C<$variable>, and optionally
gives it an initial value of C<$value>. C<$variable> should be the name of
variable including the sigil, so
Package::Stash->new('Foo')->add_symbol('%foo')
will create C<%Foo::foo>.
Valid options (all optional) are C<filename>, C<first_line_num>, and
C<last_line_num>.
C<$opts{filename}>, C<$opts{first_line_num}>, and C<$opts{last_line_num}> can
be used to indicate where the symbol should be regarded as having been defined.
Currently these values are only used if the symbol is a subroutine ('C<&>'
sigil) and only if C<$^P & 0x10> is true, in which case the special C<%DB::sub>
hash is updated to record the values of C<filename>, C<first_line_num>, and
C<last_line_num> for the subroutine. If these are not passed, their values are
inferred (as much as possible) from C<caller> information.
This is especially useful for debuggers and profilers, which use C<%DB::sub> to
determine where the source code for a subroutine can be found. See
L<http://perldoc.perl.org/perldebguts.html#Debugger-Internals> for more
information about C<%DB::sub>.
=method remove_glob $name
Removes all package variables with the given name, regardless of sigil.
=method has_symbol $variable
Returns whether or not the given package variable (including sigil) exists.
=method get_symbol $variable
Returns the value of the given package variable (including sigil).
=method get_or_add_symbol $variable
Like C<get_symbol>, except that it will return an empty hashref or
arrayref if the variable doesn't exist.
=method remove_symbol $variable
Removes the package variable described by C<$variable> (which includes the
sigil); other variables with the same name but different sigils will be
untouched.
=method list_all_symbols $type_filter
Returns a list of package variable names in the package, without sigils. If a
C<type_filter> is passed, it is used to select package variables of a given
type, where valid types are the slots of a typeglob ('SCALAR', 'CODE', 'HASH',
etc). Note that if the package contained any C<BEGIN> blocks, perl will leave
an empty typeglob in the C<BEGIN> slot, so this will show up if no filter is
used (and similarly for C<INIT>, C<END>, etc).
=method get_all_symbols $type_filter
Returns a hashref, keyed by the variable names in the package. If
C<$type_filter> is passed, the hash will contain every variable of that type in
the package as values, otherwise, it will contain the typeglobs corresponding
to the variable names (basically, a clone of the stash).
=head1 WORKING WITH VARIABLES
It is important to note, that when working with scalar variables, default behavior is to B<copy> values.
my $stash = Package::Stash->new('Some::Namespace');
my $variable = 1;
# $Some::Namespace::name is a copy of $variable
$stash->add_symbol('$name', $variable);
$variable++
# $Some::Namespace::name == 1 , $variable == 2
This will likely confuse people who expect it to work the same as Perl's own stash mechanism, which simply
creates new references to existing variables.
my $variable = 1;
{
no strict 'refs';
# assign $Package::Stash::name = $variable
*{'Package::Stash::name'} = \$variable;
}
$variable++ # affects both names
If this behaviour is desired when working with C<Package::Stash>, simply pass C<Package::Stash> a C<SCALAR> C<REF>
my $stash = Package::Stash->new('Some::Namespace');
my $variable = 1;
# $Some::Namespace::name is now $variable
$stash->add_symbol('$name', \$variable);
$variable++
# $Some::Namespace::name == 2 , $variable == 2
This will be what you want as well if you're ever working with creating C<Readonly> variables
use Readonly;
Readonly my $value, 'hello';
$stash->add_symbol('$name', \$value); # reference
print $Some::Namespace::name; # hello
$Some::Namespace::name .= " world"; # Tries to modify the read-only 'hello' and dies.
$stash->add_symbol('$name', $value); # copy
print $Some::Namespace::name; # hello
$Some::Namespace::name .= " world"; # No problem, modifying a copy, not the original
=head1 BUGS / CAVEATS
=over 4
=item * Prior to perl 5.10, scalar slots are only considered to exist if they are defined
This is due to a shortcoming within perl itself. See
L<perlref/Making References> point 7 for more information.
=item * GLOB and FORMAT variables are not (yet) accessible through this module.
=item * Also, see the BUGS section for the specific backends (L<Package::Stash::XS> and L<Package::Stash::PP>)
=back
Please report any bugs through RT: email
C<bug-package-stash at rt.cpan.org>, or browse to
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Package-Stash>.
=head1 SEE ALSO
=over 4
=item * L<Class::MOP::Package>
This module is a factoring out of code that used to live here
=back
=head1 SUPPORT
You can find this documentation for this module with the perldoc command.
perldoc Package::Stash
You can also look for information at:
=over 4
=item * MetaCPAN
L<https://metacpan.org/release/Package-Stash>
=item * Github
L<https://github.com/doy/package-stash>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Package-Stash>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Package-Stash>
=back
=head1 HISTORY
Based on code from L<Class::MOP::Package>, by Stevan Little and the Moose
Cabal.
=cut
1;
|
