use warnings;
# ABSTRACT: routines for manipulating stashes
-use Carp qw(confess);
-use Scalar::Util qw(reftype);
-use Symbol;
-# before 5.12, assigning to the ISA glob would make it lose its magical ->isa
-# powers
-use constant BROKEN_ISA_ASSIGNMENT => ($] < 5.012);
+our $IMPLEMENTATION;
+
+BEGIN {
+ $IMPLEMENTATION = $ENV{PACKAGE_STASH_IMPLEMENTATION}
+ if exists $ENV{PACKAGE_STASH_IMPLEMENTATION};
+
+ my $err;
+ if ($IMPLEMENTATION) {
+ if (!eval "require Package::Stash::$IMPLEMENTATION; 1") {
+ require Carp;
+ Carp::croak("Could not load Package::Stash::$IMPLEMENTATION: $@");
+ }
+ }
+ else {
+ for my $impl ('XS', 'PP') {
+ if (eval "require Package::Stash::$impl; 1;") {
+ $IMPLEMENTATION = $impl;
+ last;
+ }
+ else {
+ $err .= $@;
+ }
+ }
+ }
+
+ if (!$IMPLEMENTATION) {
+ require Carp;
+ Carp::croak("Could not find a suitable Package::Stash implementation: $err");
+ }
+
+ 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});
+ }
+}
+
+use Package::DeprecationManager -deprecations => {
+ 'Package::Stash::add_package_symbol' => 0.14,
+ 'Package::Stash::remove_package_glob' => 0.14,
+ 'Package::Stash::has_package_symbol' => 0.14,
+ 'Package::Stash::get_package_symbol' => 0.14,
+ 'Package::Stash::get_or_add_package_symbol' => 0.14,
+ 'Package::Stash::remove_package_symbol' => 0.14,
+ 'Package::Stash::list_all_package_symbols' => 0.14,
+};
+
+sub add_package_symbol {
+ deprecated('add_package_symbol is deprecated, please use add_symbol');
+ shift->add_symbol(@_);
+}
+
+sub remove_package_glob {
+ deprecated('remove_package_glob is deprecated, please use remove_glob');
+ shift->remove_glob(@_);
+}
+
+sub has_package_symbol {
+ deprecated('has_package_symbol is deprecated, please use has_symbol');
+ shift->has_symbol(@_);
+}
+
+sub get_package_symbol {
+ deprecated('get_package_symbol is deprecated, please use get_symbol');
+ shift->get_symbol(@_);
+}
+
+sub get_or_add_package_symbol {
+ deprecated('get_or_add_package_symbol is deprecated, please use get_or_add_symbol');
+ shift->get_or_add_symbol(@_);
+}
+
+sub remove_package_symbol {
+ deprecated('remove_package_symbol is deprecated, please use remove_symbol');
+ shift->remove_symbol(@_);
+}
+
+sub list_all_package_symbols {
+ deprecated('list_all_package_symbols is deprecated, please use list_all_symbols');
+ shift->list_all_symbols(@_);
+}
=head1 SYNOPSIS
my $stash = Package::Stash->new('Foo');
- $stash->add_package_symbol('%foo', {bar => 1});
+ $stash->add_symbol('%foo', {bar => 1});
# $Foo::foo{bar} == 1
- $stash->has_package_symbol('$foo') # false
+ $stash->has_symbol('$foo') # false
my $namespace = $stash->namespace;
*{ $namespace->{foo} }{HASH} # {bar => 1}
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.
-=cut
-
-sub new {
- my $class = shift;
- my ($package) = @_;
- my $namespace;
- {
- no strict 'refs';
- # supposedly this caused a bug in earlier perls, but I can't reproduce
- # it, so re-enabling the caching
- $namespace = \%{$package . '::'};
- }
- return bless {
- 'package' => $package,
- 'namespace' => $namespace,
- }, $class;
-}
-
=method name
Returns the name of the package that this object represents.
-=cut
-
-sub name {
- return $_[0]->{package};
-}
-
=method namespace
Returns the raw stash itself.
-=cut
-
-sub namespace {
- return $_[0]->{namespace};
-}
-
-{
- my %SIGIL_MAP = (
- '$' => 'SCALAR',
- '@' => 'ARRAY',
- '%' => 'HASH',
- '&' => 'CODE',
- '' => 'IO',
- );
-
- sub _deconstruct_variable_name {
- my ($self, $variable) = @_;
-
- (defined $variable && length $variable)
- || confess "You must pass a variable name";
-
- my $sigil = substr($variable, 0, 1, '');
-
- if (exists $SIGIL_MAP{$sigil}) {
- return ($variable, $sigil, $SIGIL_MAP{$sigil});
- }
- else {
- return ("${sigil}${variable}", '', $SIGIL_MAP{''});
- }
- }
-}
-
-=method add_package_symbol $variable $value %opts
+=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_package_symbol('%foo')
+ Package::Stash->new('Foo')->add_symbol('%foo')
will create C<%Foo::foo>.
L<http://perldoc.perl.org/perldebguts.html#Debugger-Internals> for more
information about C<%DB::sub>.
-=cut
-
-sub _valid_for_type {
- my $self = shift;
- my ($value, $type) = @_;
- if ($type eq 'HASH' || $type eq 'ARRAY'
- || $type eq 'IO' || $type eq 'CODE') {
- return reftype($value) eq $type;
- }
- else {
- my $ref = reftype($value);
- return !defined($ref) || $ref eq 'SCALAR' || $ref eq 'REF' || $ref eq 'LVALUE';
- }
-}
-
-sub add_package_symbol {
- my ($self, $variable, $initial_value, %opts) = @_;
-
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
- ? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
-
- my $pkg = $self->name;
-
- if (@_ > 2) {
- $self->_valid_for_type($initial_value, $type)
- || confess "$initial_value is not of type $type";
-
- # cheap fail-fast check for PERLDBf_SUBLINE and '&'
- if ($^P and $^P & 0x10 && $sigil eq '&') {
- my $filename = $opts{filename};
- my $first_line_num = $opts{first_line_num};
-
- (undef, $filename, $first_line_num) = caller
- if not defined $filename;
-
- my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
-
- # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
- $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
- }
- }
-
- no strict 'refs';
- no warnings 'redefine', 'misc', 'prototype';
- *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
-}
-
-=method remove_package_glob $name
+=method remove_glob $name
Removes all package variables with the given name, regardless of sigil.
-=cut
-
-sub remove_package_glob {
- my ($self, $name) = @_;
- no strict 'refs';
- delete ${$self->name . '::'}{$name};
-}
-
-# ... these functions deal with stuff on the namespace level
-
-=method has_package_symbol $variable
+=method has_symbol $variable
Returns whether or not the given package variable (including sigil) exists.
-=cut
-
-sub has_package_symbol {
- my ($self, $variable) = @_;
-
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
- ? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
-
- my $namespace = $self->namespace;
-
- return unless exists $namespace->{$name};
-
- my $entry_ref = \$namespace->{$name};
- if (reftype($entry_ref) eq 'GLOB') {
- if ( $type eq 'SCALAR' ) {
- return defined ${ *{$entry_ref}{SCALAR} };
- }
- else {
- return defined *{$entry_ref}{$type};
- }
- }
- else {
- # a symbol table entry can be -1 (stub), string (stub with prototype),
- # or reference (constant)
- return $type eq 'CODE';
- }
-}
-
-=method get_package_symbol $variable
+=method get_symbol $variable
Returns the value of the given package variable (including sigil).
-=cut
+=method get_or_add_symbol $variable
-sub get_package_symbol {
- my ($self, $variable, %opts) = @_;
-
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
- ? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
-
- my $namespace = $self->namespace;
-
- if (!exists $namespace->{$name}) {
- if ($opts{vivify}) {
- if ($type eq 'ARRAY') {
- if (BROKEN_ISA_ASSIGNMENT) {
- $self->add_package_symbol(
- $variable,
- $name eq 'ISA' ? () : ([])
- );
- }
- else {
- $self->add_package_symbol($variable, []);
- }
- }
- elsif ($type eq 'HASH') {
- $self->add_package_symbol($variable, {});
- }
- elsif ($type eq 'SCALAR') {
- $self->add_package_symbol($variable);
- }
- elsif ($type eq 'IO') {
- $self->add_package_symbol($variable, Symbol::geniosym);
- }
- elsif ($type eq 'CODE') {
- confess "Don't know how to vivify CODE variables";
- }
- else {
- confess "Unknown type $type in vivication";
- }
- }
- else {
- if ($type eq 'CODE') {
- # this effectively "de-vivifies" the code slot. if we don't do
- # this, referencing the coderef at the end of this function
- # will cause perl to auto-vivify a stub coderef in the slot,
- # which isn't what we want
- $self->add_package_symbol($variable);
- }
- }
- }
-
- my $entry_ref = \$namespace->{$name};
-
- if (ref($entry_ref) eq 'GLOB') {
- return *{$entry_ref}{$type};
- }
- else {
- if ($type eq 'CODE') {
- no strict 'refs';
- return \&{ $self->name . '::' . $name };
- }
- else {
- return undef;
- }
- }
-}
-
-=method get_or_add_package_symbol $variable
-
-Like C<get_package_symbol>, except that it will return an empty hashref or
+Like C<get_symbol>, except that it will return an empty hashref or
arrayref if the variable doesn't exist.
-=cut
-
-sub get_or_add_package_symbol {
- my $self = shift;
- $self->get_package_symbol(@_, vivify => 1);
-}
-
-=method remove_package_symbol $variable
+=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.
-=cut
+=method list_all_symbols $type_filter
-sub remove_package_symbol {
- my ($self, $variable) = @_;
-
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
- ? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
-
- # FIXME:
- # no doubt this is grossly inefficient and
- # could be done much easier and faster in XS
-
- my ($scalar_desc, $array_desc, $hash_desc, $code_desc, $io_desc) = (
- { sigil => '$', type => 'SCALAR', name => $name },
- { sigil => '@', type => 'ARRAY', name => $name },
- { sigil => '%', type => 'HASH', name => $name },
- { sigil => '&', type => 'CODE', name => $name },
- { sigil => '', type => 'IO', name => $name },
- );
-
- my ($scalar, $array, $hash, $code, $io);
- if ($type eq 'SCALAR') {
- $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
- $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
- $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
- $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
- }
- elsif ($type eq 'ARRAY') {
- $scalar = $self->get_package_symbol($scalar_desc);
- $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
- $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
- $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
- }
- elsif ($type eq 'HASH') {
- $scalar = $self->get_package_symbol($scalar_desc);
- $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
- $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
- $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
- }
- elsif ($type eq 'CODE') {
- $scalar = $self->get_package_symbol($scalar_desc);
- $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
- $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
- $io = $self->get_package_symbol($io_desc) if $self->has_package_symbol($io_desc);
- }
- elsif ($type eq 'IO') {
- $scalar = $self->get_package_symbol($scalar_desc);
- $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc);
- $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc);
- $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc);
- }
- else {
- confess "This should never ever ever happen";
- }
+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).
- $self->remove_package_glob($name);
+=method get_all_symbols $type_filter
- $self->add_package_symbol($scalar_desc => $scalar);
- $self->add_package_symbol($array_desc => $array) if defined $array;
- $self->add_package_symbol($hash_desc => $hash) if defined $hash;
- $self->add_package_symbol($code_desc => $code) if defined $code;
- $self->add_package_symbol($io_desc => $io) if defined $io;
-}
+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).
-=method list_all_package_symbols $type_filter
+=head1 BUGS / CAVEATS
-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).
+=over 4
-=cut
+=item * Prior to perl 5.10, scalar slots are only considered to exist if they are defined
-sub list_all_package_symbols {
- my ($self, $type_filter) = @_;
-
- my $namespace = $self->namespace;
- return keys %{$namespace} unless defined $type_filter;
-
- # NOTE:
- # or we can filter based on
- # type (SCALAR|ARRAY|HASH|CODE)
- if ($type_filter eq 'CODE') {
- return grep {
- (ref($namespace->{$_})
- ? (ref($namespace->{$_}) eq 'SCALAR')
- : (ref(\$namespace->{$_}) eq 'GLOB'
- && defined(*{$namespace->{$_}}{CODE})));
- } keys %{$namespace};
- } else {
- return grep { *{$namespace->{$_}}{$type_filter} } keys %{$namespace};
- }
-}
+This is due to a shortcoming within perl itself. See
+L<perlref/Making References> point 7 for more information.
-=head1 BUGS
+=item * GLOB and FORMAT variables are not (yet) accessible through this module.
-No known bugs.
+=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
Jesse Luehrs <doy at tozt dot net>
-Mostly copied from code from L<Class::MOP::Package>, by Stevan Little and the
-Moose Cabal.
+Based on code from L<Class::MOP::Package>, by Stevan Little and the Moose
+Cabal.
+
+=begin Pod::Coverage
+
+add_package_symbol
+remove_package_glob
+has_package_symbol
+get_package_symbol
+get_or_add_package_symbol
+remove_package_symbol
+list_all_package_symbols
+
+=end Pod::Coverage
=cut
projects / gitmo/Package-Stash.git / blobdiff