X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FPackage.pm;h=36e3dbd57543874e01f619d1cb6064a47bf60e00;hb=41ffa8a4aa857c1af10e51521b1b37c7d33826c8;hp=dd43d6b57d24754ce943bef16c58f1b7473303c5;hpb=d7b2249e7fbce92cc716fea172cf338727478b78;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Package.pm b/lib/Class/MOP/Package.pm index dd43d6b..36e3dbd 100644 --- a/lib/Class/MOP/Package.pm +++ b/lib/Class/MOP/Package.pm @@ -4,10 +4,11 @@ package Class::MOP::Package; use strict; use warnings; -use Scalar::Util 'blessed'; +use Scalar::Util 'blessed', 'reftype'; use Carp 'confess'; -our $VERSION = '0.08'; +our $VERSION = '0.90'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Object'; @@ -15,21 +16,67 @@ 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, + 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; + + return Class::MOP::Class->initialize($class)->new_object(@_) + if $class ne __PACKAGE__; + + my $params = @_ == 1 ? $_[0] : {@_}; + + return bless { + package => $params->{package}, + # 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 + # 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, + + namespace => \undef, + } => $class; } @@ -39,7 +86,6 @@ sub initialize { # 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 @@ -49,7 +95,7 @@ sub namespace { # we could just store a ref and it would # Just Work, but oh well :\ no strict 'refs'; - \%{$_[0]->name . '::'} + \%{$_[0]->{'package'} . '::'} } # utility methods @@ -87,11 +133,15 @@ sub namespace { 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'}; no strict 'refs'; - no warnings 'redefine', 'misc'; - *{$self->name . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value; + no warnings 'redefine', 'misc', 'prototype'; + *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value; } sub remove_package_glob { @@ -103,84 +153,101 @@ sub remove_package_glob { # ... these functions deal with stuff on the namespace level sub has_package_symbol { - my ($self, $variable) = @_; + my ( $self, $variable ) = @_; - my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable); - - return 0 unless exists $self->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($self->namespace->{$name}) eq 'SCALAR') { - return ($type eq 'CODE' ? 1 : 0); - } - elsif ($type eq 'SCALAR') { - my $val = *{$self->namespace->{$name}}{$type}; - return defined(${$val}) ? 1 : 0; + 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}; + + 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 { - defined(*{$self->namespace->{$name}}{$type}) ? 1 : 0; + + # a symbol table entry can be -1 (stub), string (stub with prototype), + # or reference (constant) + return $type eq 'CODE'; } } 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; + # FIXME $self->add_package_symbol($variable) - unless exists $self->namespace->{$name}; + unless exists $namespace->{$name}; + + my $entry_ref = \$namespace->{$name}; - if (ref($self->namespace->{$name}) eq 'SCALAR') { - if ($type eq 'CODE') { + if ( ref($entry_ref) eq 'GLOB' ) { + return *{$entry_ref}{$type}; + } + else { + if ( $type eq 'CODE' ) { no strict 'refs'; - return \&{$self->name.'::'.$name}; + return \&{ $self->name . '::' . $name }; } else { return undef; } } - else { - return *{$self->namespace->{$name}}{$type}; - } } 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"; @@ -188,25 +255,31 @@ sub remove_package_symbol { $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 { my ($self, $type_filter) = @_; - return keys %{$self->namespace} unless defined $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) - my $namespace = $self->namespace; - return 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; @@ -221,68 +294,84 @@ Class::MOP::Package - Package Meta Object =head1 DESCRIPTION -This is an abstraction of a Perl 5 package, it is a superclass of -L 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 +=item B<< Class::MOP::Package->initialize($package_name) >> + +This method creates a new C 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 + +Do not call this unless you know what you are doing. + +=item B<< $metapackage->name >> + +This is returns the package's name, as passed to the constructor. -Returns a metaclass for this package. +=item B<< $metapackage->namespace >> -=item B +This returns a hash reference to the package's symbol table. The keys +are symbol names and the values are typeglob references. -This will initialize a Class::MOP::Package instance which represents -the package of C<$package_name>. +=item B<< $metapackage->add_package_symbol($variable_name, $initial_value) >> -=item B +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 +=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 +=item B<< $metapackage->has_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. +Returns true if there is a package variable defined for +C<$variable_name>. The C<$variable_name> must contain a leading sigil. -=item B +=item B<< $metapackage->remove_package_symbol($variable_name) >> -This will return a reference to the package variable in -C<$variable_name>. +This will remove the package variable specified C<$variable_name>. The +C<$variable_name> must contain a leading sigil. -=item B +=item B<< $metapackage->remove_package_glob($glob_name) >> -Returns true (C<1>) if there is a package variable defined for -C<$variable_name>, and false (C<0>) otherwise. +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 +=item B<< $metapackage->list_all_package_symbols($type_filter) >> -This will attempt to remove the package variable at C<$variable_name>. +This will list all the glob names associated with the current +package. These names do not have leading sigils. -=item B +You can provide an optional type filter, which should be one of +'SCALAR', 'ARRAY', 'HASH', or 'CODE'. -This will attempt to remove the entire typeglob associated with -C<$glob_name> from the package. +=item B<< $metapackage->get_all_package_symbols($type_filter) >> -=item B +This works much like C, but it returns a +hash reference. The keys are glob names and the values are references +to the value for that name. -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<< Class::MOP::Package->meta >> -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 will return a L instance for this class. =back @@ -292,7 +381,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L