=head1 NAME
-Stash::Manip -
+Stash::Manip - routines for manipulating stashes
=head1 SYNOPSIS
+ my $stash = Stash::Manip->new('Foo');
+ $stash->add_package_symbol('%foo', {bar => 1});
+ # $Foo::foo{bar} == 1
+ $stash->has_package_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.
+
+=head1 METHODS
+
+=cut
+
+=head2 new $package_name
+
+Creates a new C<Stash::Manip> object, for the package given as the only
+argument.
=cut
sub new {
my $class = shift;
my ($namespace) = @_;
- return bless { package => $namespace }, $class;
+ return bless { 'package' => $namespace }, $class;
}
+=head2 name
+
+Returns the name of the package that this object represents.
+
+=cut
+
sub name {
return $_[0]->{package};
}
+=head2 namespace
+
+Returns the raw stash itself.
+
+=cut
+
sub namespace {
# NOTE:
# because of issues with the Perl API
'@' => 'ARRAY',
'%' => 'HASH',
'&' => 'CODE',
+ '' => 'IO',
);
sub _deconstruct_variable_name {
my ($self, $variable) = @_;
- (defined $variable)
+ (defined $variable && length $variable)
|| confess "You must pass a variable name";
my $sigil = substr($variable, 0, 1, '');
- (defined $sigil)
- || confess "The variable name must include a sigil";
+ if (exists $SIGIL_MAP{$sigil}) {
+ return ($variable, $sigil, $SIGIL_MAP{$sigil});
+ }
+ else {
+ return ("${sigil}${variable}", '', $SIGIL_MAP{''});
+ }
+ }
+}
+
+=head2 add_package_symbol $variable $value
+
+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
+
+ Stash::Manip->new('Foo')->add_package_symbol('%foo')
- (exists $SIGIL_MAP{$sigil})
- || confess "I do not recognize that sigil '$sigil'";
+will create C<%Foo::foo>.
- return ($variable, $sigil, $SIGIL_MAP{$sigil});
+=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';
}
}
? @{$variable}{qw[name sigil type]}
: $self->_deconstruct_variable_name($variable);
+ if (@_ > 2) {
+ $self->_valid_for_type($initial_value, $type)
+ || confess "$initial_value is not of type $type";
+ }
+
my $pkg = $self->name;
no strict 'refs';
*{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
}
+=head2 remove_package_glob $name
+
+Removes all package variables with the given name, regardless of sigil.
+
+=cut
+
sub remove_package_glob {
my ($self, $name) = @_;
no strict 'refs';
# ... these functions deal with stuff on the namespace level
+=head2 has_package_symbol $variable
+
+Returns whether or not the given package variable (including sigil) exists.
+
+=cut
+
sub has_package_symbol {
my ($self, $variable) = @_;
}
}
+=head2 get_package_symbol $variable
+
+Returns the value of the given package variable (including sigil).
+
+=cut
+
sub get_package_symbol {
my ($self, $variable) = @_;
my $namespace = $self->namespace;
- # FIXME
- $self->add_package_symbol($variable)
- unless exists $namespace->{$name};
+ if (!exists $namespace->{$name}) {
+ # assigning to the result of this function like
+ # @{$stash->get_package_symbol('@ISA')} = @new_ISA
+ # makes the result not visible until the variable is explicitly
+ # accessed... in the case of @ISA, this might never happen
+ # for instance, assigning like that and then calling $obj->isa
+ # will fail. see t/005-isa.t
+ if ($type eq 'ARRAY' && $name ne 'ISA') {
+ $self->add_package_symbol($variable, []);
+ }
+ elsif ($type eq 'HASH') {
+ $self->add_package_symbol($variable, {});
+ }
+ else {
+ # FIXME
+ $self->add_package_symbol($variable)
+ }
+ }
my $entry_ref = \$namespace->{$name};
}
}
+=head2 remove_package_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
+
sub remove_package_symbol {
my ($self, $variable) = @_;
# 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) = (
+ 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);
+ 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) if $self->has_package_symbol($scalar_desc);
+ $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) if $self->has_package_symbol($scalar_desc);
+ $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) if $self->has_package_symbol($scalar_desc);
+ $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";
$self->remove_package_glob($name);
- $self->add_package_symbol($scalar_desc => $scalar) if defined $scalar;
+ $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;
}
+=head2 list_all_package_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).
+
+=cut
+
sub list_all_package_symbols {
my ($self, $type_filter) = @_;
=head1 SEE ALSO
+L<Class::MOP::Package> - this module is a factoring out of code that used to
+live here
=head1 SUPPORT
Jesse Luehrs <doy at tozt dot net>
+Mostly copied from code from L<Class::MOP::Package>, by Stevan Little and the
+Moose Cabal.
+
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Jesse Luehrs.
projects / gitmo/Package-Stash-PP.git / blobdiff