use strict;
use warnings;
-use B;
-use Scalar::Util 'blessed';
+use Scalar::Util 'blessed', 'reftype';
use Carp 'confess';
+use Package::Stash;
-our $VERSION = '0.72';
+our $VERSION = '1.12';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
'package' => $package_name,
%options,
});
-
Class::MOP::store_metaclass_by_name($package_name, $meta);
return $meta;
my %options = @args;
my $package_name = delete $options{package};
- (defined $package_name && $package_name && !blessed($package_name))
- || confess "You must pass a package name and it cannot be blessed";
+ (defined $package_name && $package_name
+ && (!blessed $package_name || $package_name->isa('Class::MOP::Package')))
+ || confess "You must pass a package name or an existing Class::MOP::Package instance";
+
+ $package_name = $package_name->name
+ if blessed $package_name;
Class::MOP::remove_metaclass_by_name($package_name);
sub _new {
my $class = shift;
- my $options = @_ == 1 ? $_[0] : {@_};
-
- # NOTE:
- # because of issues with the Perl API
- # to the typeglob in some versions, we
- # need to just always grab a new
- # reference to the hash in the accessor.
- # Ideally we could just store a ref and
- # it would Just Work, but oh well :\
- $options->{namespace} ||= \undef;
-
- bless $options, $class;
-}
-# Attributes
+ return Class::MOP::Class->initialize($class)->new_object(@_)
+ if $class ne __PACKAGE__;
-# NOTE:
-# all these attribute readers will be bootstrapped
-# away in the Class::MOP bootstrap section
+ my $params = @_ == 1 ? $_[0] : {@_};
-sub name { $_[0]->{'package'} }
-sub namespace {
- # NOTE:
- # because of issues with the Perl API
- # to the typeglob in some versions, we
- # need to just always grab a new
- # reference to the hash here. Ideally
- # we could just store a ref and it would
- # Just Work, but oh well :\
- no strict 'refs';
- \%{$_[0]->{'package'} . '::'}
-}
+ return bless {
+ package => $params->{package},
-# utility methods
+ # NOTE:
+ # because of issues with the Perl API
+ # to the typeglob in some versions, we
+ # need to just always grab a new
+ # reference to the hash in the accessor.
+ # Ideally we could just store a ref and
+ # it would Just Work, but oh well :\
-{
- my %SIGIL_MAP = (
- '$' => 'SCALAR',
- '@' => 'ARRAY',
- '%' => 'HASH',
- '&' => 'CODE',
- );
-
- sub _deconstruct_variable_name {
- my ($self, $variable) = @_;
+ namespace => \undef,
- (defined $variable)
- || confess "You must pass a variable name";
+ } => $class;
+}
- my $sigil = substr($variable, 0, 1, '');
+# Attributes
- (defined $sigil)
- || confess "The variable name must include a sigil";
+# NOTE:
+# all these attribute readers will be bootstrapped
+# away in the Class::MOP bootstrap section
- (exists $SIGIL_MAP{$sigil})
- || confess "I do not recognize that sigil '$sigil'";
-
- return ($variable, $sigil, $SIGIL_MAP{$sigil});
- }
+sub _package_stash {
+ $_[0]->{_package_stash} ||= Package::Stash->new($_[0]->name)
+}
+sub namespace {
+ $_[0]->_package_stash->namespace
}
# Class attributes
# ... these functions have to touch the symbol table itself,.. yuk
sub add_package_symbol {
- my ($self, $variable, $initial_value) = @_;
-
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
- ? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
-
- my $pkg = $self->{'package'};
-
- no strict 'refs';
- no warnings 'redefine', 'misc';
- *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
+ my $self = shift;
+ $self->_package_stash->add_symbol(@_);
}
sub remove_package_glob {
- my ($self, $name) = @_;
- no strict 'refs';
- delete ${$self->name . '::'}{$name};
+ my $self = shift;
+ $self->_package_stash->remove_glob(@_);
}
# ... these functions deal with stuff on the namespace level
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 0 unless exists $namespace->{$name};
-
- # FIXME:
- # For some really stupid reason
- # a typeglob will have a default
- # value of \undef in the SCALAR
- # slot, so we need to work around
- # this. Which of course means that
- # if you put \undef in your scalar
- # then this is broken.
-
- if (ref($namespace->{$name}) eq 'SCALAR') {
- return ($type eq 'CODE');
- }
- elsif ($type eq 'SCALAR') {
- my $val = *{$namespace->{$name}}{$type};
- return defined(${$val});
- }
- else {
- defined(*{$namespace->{$name}}{$type});
- }
+ my $self = shift;
+ $self->_package_stash->has_symbol(@_);
}
sub get_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;
-
- $self->add_package_symbol($variable)
- unless exists $namespace->{$name};
+ my $self = shift;
+ $self->_package_stash->get_symbol(@_);
+}
- if (ref($namespace->{$name}) eq 'SCALAR') {
- if ($type eq 'CODE') {
- no strict 'refs';
- return \&{$self->name.'::'.$name};
- }
- else {
- return undef;
- }
- }
- else {
- return *{$namespace->{$name}}{$type};
- }
+sub get_or_add_package_symbol {
+ my $self = shift;
+ $self->_package_stash->get_or_add_symbol(@_);
}
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) = (
- { sigil => '$', type => 'SCALAR', name => $name },
- { sigil => '@', type => 'ARRAY', name => $name },
- { sigil => '%', type => 'HASH', name => $name },
- { sigil => '&', type => 'CODE', name => $name },
- );
-
- my ($scalar, $array, $hash, $code);
- 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);
- }
- elsif ($type eq 'ARRAY') {
- $scalar = $self->get_package_symbol($scalar_desc) if $self->has_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);
- }
- elsif ($type eq 'HASH') {
- $scalar = $self->get_package_symbol($scalar_desc) if $self->has_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);
- }
- elsif ($type eq 'CODE') {
- $scalar = $self->get_package_symbol($scalar_desc) if $self->has_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);
- }
- 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($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;
+ my $self = shift;
+ $self->_package_stash->remove_symbol(@_);
}
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};
- }
+ my $self = shift;
+ $self->_package_stash->list_all_symbols(@_);
}
sub get_all_package_symbols {
- my ($self, $type_filter) = @_;
-
- die "Cannot call get_all_package_symbols as a class method"
- unless ref $self;
-
- my $namespace = $self->namespace;
-
- if (wantarray) {
- warn 'Class::MOP::Package::get_all_package_symbols in list context is deprecated. use scalar context instead.';
- }
-
- return (wantarray ? %$namespace : $namespace) unless defined $type_filter;
-
- my %ret;
- # for some reason this nasty impl is orders of magnitude faster than a clean version
- if ( $type_filter eq 'CODE' ) {
- my $pkg;
- no strict 'refs';
- %ret = map {
- (ref($namespace->{$_})
- ? ( $_ => \&{$pkg ||= $self->name . "::$_"} )
- : ( ref \$namespace->{$_} eq 'GLOB' # don't use {CODE} unless it's really a glob to prevent stringification of stubs
- && (*{$namespace->{$_}}{CODE}) # the extra parents prevent breakage on 5.8.2
- ? ( $_ => *{$namespace->{$_}}{CODE} )
- : (do {
- my $sym = B::svref_2object(\$namespace->{$_});
- my $svt = ref $sym if $sym;
- ($sym && ($svt eq 'B::PV' || $svt eq 'B::IV'))
- ? ($_ => ($pkg ||= $self->name)->can($_))
- : () }) ) )
- } keys %$namespace;
- } else {
- %ret = map {
- $_ => *{$namespace->{$_}}{$type_filter}
- } grep {
- !ref($namespace->{$_}) && *{$namespace->{$_}}{$type_filter}
- } keys %$namespace;
- }
-
- return wantarray ? %ret : \%ret;
+ my $self = shift;
+ $self->_package_stash->get_all_symbols(@_);
}
1;
=head1 DESCRIPTION
-This is an abstraction of a Perl 5 package, it is a superclass of
-L<Class::MOP::Class> and provides all of the symbol table
-introspection methods.
-
-=head1 INHERITANCE
-
-B<Class::MOP::Package> is a subclass of L<Class::MOP::Object>
+The Package Protocol provides an abstraction of a Perl 5 package. A
+package is basically namespace, and this module provides methods for
+looking at and changing that namespace's symbol table.
=head1 METHODS
=over 4
-=item B<meta>
+=item B<< Class::MOP::Package->initialize($package_name) >>
+
+This method creates a new C<Class::MOP::Package> instance which
+represents specified package. If an existing metaclass object exists
+for the package, that will be returned instead.
+
+=item B<< Class::MOP::Package->reinitialize($package) >>
+
+This method forcibly removes any existing metaclass for the package
+before calling C<initialize>. In contrast to C<initialize>, you may
+also pass an existing C<Class::MOP::Package> instance instead of just
+a package name as C<$package>.
+
+Do not call this unless you know what you are doing.
-Returns a metaclass for this package.
+=item B<< $metapackage->name >>
-=item B<initialize ($package_name)>
+This is returns the package's name, as passed to the constructor.
-This will initialize a Class::MOP::Package instance which represents
-the package of C<$package_name>.
+=item B<< $metapackage->namespace >>
-=item B<reinitialize ($package_name, %options)>
+This returns a hash reference to the package's symbol table. The keys
+are symbol names and the values are typeglob references.
-This removes the old metaclass, and creates a new one in it's place.
-Do B<not> use this unless you really know what you are doing, it could
-very easily make a very large mess of your program.
+=item B<< $metapackage->add_package_symbol($variable_name, $initial_value) >>
-=item B<name>
+This method accepts a variable name and an optional initial value. The
+C<$variable_name> must contain a leading sigil.
-This is a read-only attribute which returns the package name for the
-given instance.
+This method creates the variable in the package's symbol table, and
+sets it to the initial value if one was provided.
-=item B<namespace>
+=item B<< $metapackage->get_package_symbol($variable_name) >>
-This returns a HASH reference to the symbol table. The keys of the
-HASH are the symbol names, and the values are typeglob references.
+Given a variable name, this method returns the variable as a reference
+or undef if it does not exist. The C<$variable_name> must contain a
+leading sigil.
-=item B<add_package_symbol ($variable_name, ?$initial_value)>
+=item B<< $metapackage->get_or_add_package_symbol($variable_name) >>
-Given a C<$variable_name>, which must contain a leading sigil, this
-method will create that variable within the package which houses the
-class. It also takes an optional C<$initial_value>, which must be a
-reference of the same type as the sigil of the C<$variable_name>
-implies.
+Given a variable name, this method returns the variable as a reference.
+If it does not exist, a default value will be generated if possible. The
+C<$variable_name> must contain a leading sigil.
-=item B<get_package_symbol ($variable_name)>
+=item B<< $metapackage->has_package_symbol($variable_name) >>
-This will return a reference to the package variable in
-C<$variable_name>.
+Returns true if there is a package variable defined for
+C<$variable_name>. The C<$variable_name> must contain a leading sigil.
-=item B<has_package_symbol ($variable_name)>
+=item B<< $metapackage->remove_package_symbol($variable_name) >>
-Returns true (C<1>) if there is a package variable defined for
-C<$variable_name>, and false (C<0>) otherwise.
+This will remove the package variable specified C<$variable_name>. The
+C<$variable_name> must contain a leading sigil.
-=item B<remove_package_symbol ($variable_name)>
+=item B<< $metapackage->remove_package_glob($glob_name) >>
-This will attempt to remove the package variable at C<$variable_name>.
+Given the name of a glob, this will remove that glob from the
+package's symbol table. Glob names do not include a sigil. Removing
+the glob removes all variables and subroutines with the specified
+name.
-=item B<remove_package_glob ($glob_name)>
+=item B<< $metapackage->list_all_package_symbols($type_filter) >>
-This will attempt to remove the entire typeglob associated with
-C<$glob_name> from the package.
+This will list all the glob names associated with the current
+package. These names do not have leading sigils.
-=item B<list_all_package_symbols (?$type_filter)>
+You can provide an optional type filter, which should be one of
+'SCALAR', 'ARRAY', 'HASH', or 'CODE'.
-This will list all the glob names associated with the current package.
-By inspecting the globs returned you can discern all the variables in
-the package.
+=item B<< $metapackage->get_all_package_symbols($type_filter) >>
-By passing a C<$type_filter>, you can limit the list to only those
-which match the filter (either SCALAR, ARRAY, HASH or CODE).
+This works much like C<list_all_package_symbols>, but it returns a
+hash reference. The keys are glob names and the values are references
+to the value for that name.
-=item B<get_all_package_symbols (?$type_filter)>
+=item B<< Class::MOP::Package->meta >>
-Works exactly like C<list_all_package_symbols> but returns a HASH of
-name => thing mapping instead of just an ARRAY of names.
+This will return a L<Class::MOP::Class> instance for this class.
=back
=head1 COPYRIGHT AND LICENSE
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Class-MOP.git / blobdiff