1 package Package::Stash;
4 # ABSTRACT: routines for manipulating stashes
7 use Scalar::Util qw(reftype);
13 # we need to be careful not to touch $VERSION at compile time, otherwise
14 # DynaLoader will assume it's set and check against it, which will cause
15 # fail when being run in the checkout without dzil having set the actual
17 exists $Package::Stash::{VERSION}
18 ? ${ $Package::Stash::{VERSION} } : (),
21 # before 5.12, assigning to the ISA glob would make it lose its magical ->isa
23 use constant BROKEN_ISA_ASSIGNMENT => ($] < 5.012);
27 my $stash = Package::Stash->new('Foo');
28 $stash->add_package_symbol('%foo', {bar => 1});
30 $stash->has_package_symbol('$foo') # false
31 my $namespace = $stash->namespace;
32 *{ $namespace->{foo} }{HASH} # {bar => 1}
36 Manipulating stashes (Perl's symbol tables) is occasionally necessary, but
37 incredibly messy, and easy to get wrong. This module hides all of that behind a
40 NOTE: Most methods in this class require a variable specification that includes
41 a sigil. If this sigil is absent, it is assumed to represent the IO slot.
43 =method new $package_name
45 Creates a new C<Package::Stash> object, for the package given as the only
50 Returns the name of the package that this object represents.
54 Returns the raw stash itself.
67 sub _deconstruct_variable_name {
68 my ($self, $variable) = @_;
70 (defined $variable && length $variable)
71 || confess "You must pass a variable name";
73 my $sigil = substr($variable, 0, 1, '');
75 if (exists $SIGIL_MAP{$sigil}) {
76 return ($variable, $sigil, $SIGIL_MAP{$sigil});
79 return ("${sigil}${variable}", '', $SIGIL_MAP{''});
84 =method add_package_symbol $variable $value %opts
86 Adds a new package symbol, for the symbol given as C<$variable>, and optionally
87 gives it an initial value of C<$value>. C<$variable> should be the name of
88 variable including the sigil, so
90 Package::Stash->new('Foo')->add_package_symbol('%foo')
92 will create C<%Foo::foo>.
94 Valid options (all optional) are C<filename>, C<first_line_num>, and
97 C<$opts{filename}>, C<$opts{first_line_num}>, and C<$opts{last_line_num}> can
98 be used to indicate where the symbol should be regarded as having been defined.
99 Currently these values are only used if the symbol is a subroutine ('C<&>'
100 sigil) and only if C<$^P & 0x10> is true, in which case the special C<%DB::sub>
101 hash is updated to record the values of C<filename>, C<first_line_num>, and
102 C<last_line_num> for the subroutine. If these are not passed, their values are
103 inferred (as much as possible) from C<caller> information.
105 This is especially useful for debuggers and profilers, which use C<%DB::sub> to
106 determine where the source code for a subroutine can be found. See
107 L<http://perldoc.perl.org/perldebguts.html#Debugger-Internals> for more
108 information about C<%DB::sub>.
112 sub _valid_for_type {
114 my ($value, $type) = @_;
115 if ($type eq 'HASH' || $type eq 'ARRAY'
116 || $type eq 'IO' || $type eq 'CODE') {
117 return reftype($value) eq $type;
120 my $ref = reftype($value);
121 return !defined($ref) || $ref eq 'SCALAR' || $ref eq 'REF' || $ref eq 'LVALUE';
125 sub add_package_symbol {
126 my ($self, $variable, $initial_value, %opts) = @_;
128 my ($name, $sigil, $type) = ref $variable eq 'HASH'
129 ? @{$variable}{qw[name sigil type]}
130 : $self->_deconstruct_variable_name($variable);
132 my $pkg = $self->name;
135 $self->_valid_for_type($initial_value, $type)
136 || confess "$initial_value is not of type $type";
138 # cheap fail-fast check for PERLDBf_SUBLINE and '&'
139 if ($^P and $^P & 0x10 && $sigil eq '&') {
140 my $filename = $opts{filename};
141 my $first_line_num = $opts{first_line_num};
143 (undef, $filename, $first_line_num) = caller
144 if not defined $filename;
146 my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
148 # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
149 $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
154 no warnings 'redefine', 'misc', 'prototype';
155 *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
158 =method remove_package_glob $name
160 Removes all package variables with the given name, regardless of sigil.
162 =method has_package_symbol $variable
164 Returns whether or not the given package variable (including sigil) exists.
168 sub has_package_symbol {
169 my ($self, $variable) = @_;
171 my ($name, $sigil, $type) = ref $variable eq 'HASH'
172 ? @{$variable}{qw[name sigil type]}
173 : $self->_deconstruct_variable_name($variable);
175 my $namespace = $self->namespace;
177 return unless exists $namespace->{$name};
179 my $entry_ref = \$namespace->{$name};
180 if (reftype($entry_ref) eq 'GLOB') {
181 # XXX: assigning to any typeglob slot also initializes the SCALAR slot,
182 # and saying that an undef scalar variable doesn't exist is probably
183 # vaguely less surprising than a scalar variable popping into existence
184 # without anyone defining it
185 if ($type eq 'SCALAR') {
186 return defined ${ *{$entry_ref}{$type} };
189 return defined *{$entry_ref}{$type};
193 # a symbol table entry can be -1 (stub), string (stub with prototype),
194 # or reference (constant)
195 return $type eq 'CODE';
199 =method get_package_symbol $variable
201 Returns the value of the given package variable (including sigil).
205 sub get_package_symbol {
206 my ($self, $variable, %opts) = @_;
208 my ($name, $sigil, $type) = ref $variable eq 'HASH'
209 ? @{$variable}{qw[name sigil type]}
210 : $self->_deconstruct_variable_name($variable);
212 my $namespace = $self->namespace;
214 if (!exists $namespace->{$name}) {
216 if ($type eq 'ARRAY') {
217 if (BROKEN_ISA_ASSIGNMENT) {
218 $self->add_package_symbol(
220 $name eq 'ISA' ? () : ([])
224 $self->add_package_symbol($variable, []);
227 elsif ($type eq 'HASH') {
228 $self->add_package_symbol($variable, {});
230 elsif ($type eq 'SCALAR') {
231 $self->add_package_symbol($variable);
233 elsif ($type eq 'IO') {
234 $self->add_package_symbol($variable, Symbol::geniosym);
236 elsif ($type eq 'CODE') {
237 confess "Don't know how to vivify CODE variables";
240 confess "Unknown type $type in vivication";
244 if ($type eq 'CODE') {
245 # this effectively "de-vivifies" the code slot. if we don't do
246 # this, referencing the coderef at the end of this function
247 # will cause perl to auto-vivify a stub coderef in the slot,
248 # which isn't what we want
249 $self->add_package_symbol($variable);
254 my $entry_ref = \$namespace->{$name};
256 if (ref($entry_ref) eq 'GLOB') {
257 return *{$entry_ref}{$type};
260 if ($type eq 'CODE') {
262 return \&{ $self->name . '::' . $name };
270 =method get_or_add_package_symbol $variable
272 Like C<get_package_symbol>, except that it will return an empty hashref or
273 arrayref if the variable doesn't exist.
277 sub get_or_add_package_symbol {
279 $self->get_package_symbol(@_, vivify => 1);
282 =method remove_package_symbol $variable
284 Removes the package variable described by C<$variable> (which includes the
285 sigil); other variables with the same name but different sigils will be
290 sub remove_package_symbol {
291 my ($self, $variable) = @_;
293 my ($name, $sigil, $type) = ref $variable eq 'HASH'
294 ? @{$variable}{qw[name sigil type]}
295 : $self->_deconstruct_variable_name($variable);
298 # no doubt this is grossly inefficient and
299 # could be done much easier and faster in XS
301 my ($scalar_desc, $array_desc, $hash_desc, $code_desc, $io_desc) = (
302 { sigil => '$', type => 'SCALAR', name => $name },
303 { sigil => '@', type => 'ARRAY', name => $name },
304 { sigil => '%', type => 'HASH', name => $name },
305 { sigil => '&', type => 'CODE', name => $name },
306 { sigil => '', type => 'IO', name => $name },
309 my ($scalar, $array, $hash, $code, $io);
310 if ($type eq 'SCALAR') {
311 $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
312 $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
313 $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
314 $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
316 elsif ($type eq 'ARRAY') {
317 $scalar = $self->get_package_symbol($scalar_desc);
318 $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
319 $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
320 $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
322 elsif ($type eq 'HASH') {
323 $scalar = $self->get_package_symbol($scalar_desc);
324 $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
325 $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
326 $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
328 elsif ($type eq 'CODE') {
329 $scalar = $self->get_package_symbol($scalar_desc);
330 $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
331 $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
332 $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
334 elsif ($type eq 'IO') {
335 $scalar = $self->get_package_symbol($scalar_desc);
336 $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
337 $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
338 $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
341 confess "This should never ever ever happen";
344 $self->remove_package_glob($name);
346 $self->add_package_symbol($scalar_desc => $scalar);
347 $self->add_package_symbol($array_desc => $array) if defined $array;
348 $self->add_package_symbol($hash_desc => $hash) if defined $hash;
349 $self->add_package_symbol($code_desc => $code) if defined $code;
350 $self->add_package_symbol($io_desc => $io) if defined $io;
353 =method list_all_package_symbols $type_filter
355 Returns a list of package variable names in the package, without sigils. If a
356 C<type_filter> is passed, it is used to select package variables of a given
357 type, where valid types are the slots of a typeglob ('SCALAR', 'CODE', 'HASH',
358 etc). Note that if the package contained any C<BEGIN> blocks, perl will leave
359 an empty typeglob in the C<BEGIN> slot, so this will show up if no filter is
360 used (and similarly for C<INIT>, C<END>, etc).
364 sub list_all_package_symbols {
365 my ($self, $type_filter) = @_;
367 my $namespace = $self->namespace;
368 return keys %{$namespace} unless defined $type_filter;
371 # or we can filter based on
372 # type (SCALAR|ARRAY|HASH|CODE)
373 if ($type_filter eq 'CODE') {
375 # any non-typeglob in the symbol table is a constant or stub
376 ref(\$namespace->{$_}) ne 'GLOB'
377 # regular subs are stored in the CODE slot of the typeglob
378 || defined(*{$namespace->{$_}}{CODE})
379 } keys %{$namespace};
381 elsif ($type_filter eq 'SCALAR') {
383 ref(\$namespace->{$_}) eq 'GLOB'
384 && defined(${*{$namespace->{$_}}{'SCALAR'}})
385 } keys %{$namespace};
389 ref(\$namespace->{$_}) eq 'GLOB'
390 && defined(*{$namespace->{$_}}{$type_filter})
391 } keys %{$namespace};
399 Please report any bugs through RT: email
400 C<bug-package-stash at rt.cpan.org>, or browse to
401 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Package-Stash>.
407 =item * L<Class::MOP::Package>
409 This module is a factoring out of code that used to live here
415 You can find this documentation for this module with the perldoc command.
417 perldoc Package::Stash
419 You can also look for information at:
423 =item * AnnoCPAN: Annotated CPAN documentation
425 L<http://annocpan.org/dist/Package-Stash>
429 L<http://cpanratings.perl.org/d/Package-Stash>
431 =item * RT: CPAN's request tracker
433 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Package-Stash>
437 L<http://search.cpan.org/dist/Package-Stash>
443 Jesse Luehrs <doy at tozt dot net>
445 Mostly copied from code from L<Class::MOP::Package>, by Stevan Little and the