use strict;
use warnings;
+use B;
use Scalar::Util 'blessed';
use Carp 'confess';
-our $VERSION = '0.09';
+our $VERSION = '0.79';
+$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
use base 'Class::MOP::Object';
# creation ...
sub initialize {
- my $class = shift;
- my $package_name = shift;
+ my ( $class, @args ) = @_;
+
+ unshift @args, "package" if @args % 2;
+
+ my %options = @args;
+ my $package_name = $options{package};
+
+
# we hand-construct the class
# until we can bootstrap it
- no strict 'refs';
- return bless {
- '$!package' => $package_name,
- # 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 :\
- '%!namespace' => \undef,
- } => $class;
+ if ( my $meta = Class::MOP::get_metaclass_by_name($package_name) ) {
+ return $meta;
+ } else {
+ my $meta = ( ref $class || $class )->_new({
+ 'package' => $package_name,
+ %options,
+ });
+
+ Class::MOP::store_metaclass_by_name($package_name, $meta);
+
+ return $meta;
+ }
+}
+
+sub reinitialize {
+ my ( $class, @args ) = @_;
+
+ unshift @args, "package" if @args % 2;
+
+ 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";
+
+ Class::MOP::remove_metaclass_by_name($package_name);
+
+ $class->initialize($package_name, %options); # call with first arg form for compat
+}
+
+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
# all these attribute readers will be bootstrapped
# away in the Class::MOP bootstrap section
-sub name { $_[0]->{'$!package'} }
sub namespace {
# NOTE:
# because of issues with the Perl API
# we could just store a ref and it would
# Just Work, but oh well :\
no strict 'refs';
- \%{$_[0]->{'$!package'} . '::'}
+ \%{$_[0]->{'package'} . '::'}
}
# utility methods
sub add_package_symbol {
my ($self, $variable, $initial_value) = @_;
- my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
+ my ($name, $sigil, $type) = ref $variable eq 'HASH'
+ ? @{$variable}{qw[name sigil type]}
+ : $self->_deconstruct_variable_name($variable);
- my $pkg = $self->{'$!package'};
+ my $pkg = $self->{'package'};
no strict 'refs';
no warnings 'redefine', 'misc';
sub has_package_symbol {
my ($self, $variable) = @_;
- my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
+ my ($name, $sigil, $type) = ref $variable eq 'HASH'
+ ? @{$variable}{qw[name sigil type]}
+ : $self->_deconstruct_variable_name($variable);
my $namespace = $self->namespace;
# then this is broken.
if (ref($namespace->{$name}) eq 'SCALAR') {
- return ($type eq 'CODE' ? 1 : 0);
+ return ($type eq 'CODE');
}
elsif ($type eq 'SCALAR') {
my $val = *{$namespace->{$name}}{$type};
- return defined(${$val}) ? 1 : 0;
+ return defined(${$val});
}
else {
- defined(*{$namespace->{$name}}{$type}) ? 1 : 0;
+ defined(*{$namespace->{$name}}{$type});
}
}
sub get_package_symbol {
my ($self, $variable) = @_;
- my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
+ my ($name, $sigil, $type) = ref $variable eq 'HASH'
+ ? @{$variable}{qw[name sigil type]}
+ : $self->_deconstruct_variable_name($variable);
my $namespace = $self->namespace;
sub remove_package_symbol {
my ($self, $variable) = @_;
- my ($name, $sigil, $type) = $self->_deconstruct_variable_name($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('@' . $name) if $self->has_package_symbol('@' . $name);
- $hash = $self->get_package_symbol('%' . $name) if $self->has_package_symbol('%' . $name);
- $code = $self->get_package_symbol('&' . $name) if $self->has_package_symbol('&' . $name);
+ $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('$' . $name) if $self->has_package_symbol('$' . $name);
- $hash = $self->get_package_symbol('%' . $name) if $self->has_package_symbol('%' . $name);
- $code = $self->get_package_symbol('&' . $name) if $self->has_package_symbol('&' . $name);
+ $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('$' . $name) if $self->has_package_symbol('$' . $name);
- $array = $self->get_package_symbol('@' . $name) if $self->has_package_symbol('@' . $name);
- $code = $self->get_package_symbol('&' . $name) if $self->has_package_symbol('&' . $name);
+ $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('$' . $name) if $self->has_package_symbol('$' . $name);
- $array = $self->get_package_symbol('@' . $name) if $self->has_package_symbol('@' . $name);
- $hash = $self->get_package_symbol('%' . $name) if $self->has_package_symbol('%' . $name);
+ $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(('$' . $name) => $scalar) if defined $scalar;
- $self->add_package_symbol(('@' . $name) => $array) if defined $array;
- $self->add_package_symbol(('%' . $name) => $hash) if defined $hash;
- $self->add_package_symbol(('&' . $name) => $code) if defined $code;
+ $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;
}
sub list_all_package_symbols {
# NOTE:
# or we can filter based on
# type (SCALAR|ARRAY|HASH|CODE)
- return grep {
- (ref($namespace->{$_})
- ? (ref($namespace->{$_}) eq 'SCALAR' && $type_filter eq 'CODE')
- : (ref(\$namespace->{$_}) eq 'GLOB'
- && defined(*{$namespace->{$_}}{$type_filter})));
- } keys %{$namespace};
-}
-
-sub get_all_package_symbols {
- my ($self, $type_filter) = @_;
- my $namespace = $self->namespace;
- return %{$namespace} unless defined $type_filter;
-
- # NOTE:
- # or we can filter based on
- # type (SCALAR|ARRAY|HASH|CODE)
- no strict 'refs';
- return map {
- $_ => (ref($namespace->{$_}) eq 'SCALAR'
- ? ($type_filter eq 'CODE' ? \&{$self->name . '::' . $_} : undef)
- : *{$namespace->{$_}}{$type_filter})
- } grep {
+ if ( $type_filter eq 'CODE' ) {
+ return grep {
(ref($namespace->{$_})
- ? (ref($namespace->{$_}) eq 'SCALAR' && $type_filter eq 'CODE')
- : (ref(\$namespace->{$_}) eq 'GLOB'
- && defined(*{$namespace->{$_}}{$type_filter})));
- } keys %{$namespace};
+ ? (ref($namespace->{$_}) eq 'SCALAR')
+ : (ref(\$namespace->{$_}) eq 'GLOB'
+ && defined(*{$namespace->{$_}}{CODE})));
+ } keys %{$namespace};
+ } else {
+ return grep { *{$namespace->{$_}}{$type_filter} } keys %{$namespace};
+ }
}
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.
+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_name) >>
+
+This method forcibly removes any existing metaclass for the package
+before calling C<initialize>
+
+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<name>
+This returns a hash reference to the package's symbol table. The keys
+are symbol names and the values are typeglob references.
-This is a read-only attribute which returns the package name for the
-given instance.
+=item B<< $metapackage->add_package_symbol($variable_name, $initial_value) >>
-=item B<namespace>
+This method accepts a variable name and an optional initial value. The
+C<$variable_name> must contain a leading sigil.
-This returns a HASH reference to the symbol table. The keys of the
-HASH are the symbol names, and the values are typeglob references.
+This method creates the variable in the package's symbol table, and
+sets it to the initial value if one was provided.
-=item B<add_package_symbol ($variable_name, ?$initial_value)>
+=item B<< $metapackage->get_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
+or undef if it does not exist. 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-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Class-MOP.git / blobdiff