X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FPackage.pm;h=72ae74529bef373f1a23f86220e41c85d6f54add;hb=b1ff395fc3ef6d0c559507cee9424803aa5f41c8;hp=0e09c7f82bd1a34620bc94a8e5be206f9cf3af64;hpb=127d39a79d936afd136ccfd8ff8271eea2bc0cbb;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Package.pm b/lib/Class/MOP/Package.pm index 0e09c7f..72ae745 100644 --- a/lib/Class/MOP/Package.pm +++ b/lib/Class/MOP/Package.pm @@ -6,38 +6,71 @@ use warnings; use Scalar::Util 'blessed'; use Carp 'confess'; +use Sub::Name 'subname'; -our $VERSION = '0.07'; +our $VERSION = '0.89'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Object'; -# introspection - -sub meta { - require Class::MOP::Class; - Class::MOP::Class->initialize(blessed($_[0]) || $_[0]); -} - # 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 @@ -46,7 +79,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 @@ -56,9 +88,12 @@ sub namespace { # we could just store a ref and it would # Just Work, but oh well :\ no strict 'refs'; - \%{$_[0]->name . '::'} + \%{$_[0]->{'package'} . '::'} } +sub method_metaclass { $_[0]->{'method_metaclass'} } +sub wrapped_method_metaclass { $_[0]->{'wrapped_method_metaclass'} } + # utility methods { @@ -94,11 +129,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 { @@ -112,9 +151,13 @@ sub remove_package_glob { 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); - return 0 unless exists $self->namespace->{$name}; + my $namespace = $self->namespace; + + return 0 unless exists $namespace->{$name}; # FIXME: # For some really stupid reason @@ -125,27 +168,31 @@ sub has_package_symbol { # if you put \undef in your scalar # then this is broken. - if (ref($self->namespace->{$name}) eq 'SCALAR') { - return ($type eq 'CODE' ? 1 : 0); + if (ref($namespace->{$name}) eq 'SCALAR') { + return ($type eq 'CODE'); } elsif ($type eq 'SCALAR') { - my $val = *{$self->namespace->{$name}}{$type}; - return defined(${$val}) ? 1 : 0; + my $val = *{$namespace->{$name}}{$type}; + return defined(${$val}); } else { - defined(*{$self->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; $self->add_package_symbol($variable) - unless exists $self->namespace->{$name}; + unless exists $namespace->{$name}; - if (ref($self->namespace->{$name}) eq 'SCALAR') { + if (ref($namespace->{$name}) eq 'SCALAR') { if ($type eq 'CODE') { no strict 'refs'; return \&{$self->name.'::'.$name}; @@ -155,39 +202,48 @@ sub get_package_symbol { } } else { - return *{$self->namespace->{$name}}{$type}; + return *{$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"; @@ -195,27 +251,124 @@ 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}; + } } +## Methods + +sub wrap_method_body { + my ( $self, %args ) = @_; + + ('CODE' eq ref $args{body}) + || confess "Your code block must be a CODE reference"; + + $self->method_metaclass->wrap( + package_name => $self->name, + %args, + ); +} + +sub add_method { + my ($self, $method_name, $method) = @_; + (defined $method_name && $method_name) + || confess "You must define a method name"; + + my $body; + if (blessed($method)) { + $body = $method->body; + if ($method->package_name ne $self->name) { + $method = $method->clone( + package_name => $self->name, + name => $method_name + ) if $method->can('clone'); + } + } + else { + $body = $method; + $method = $self->wrap_method_body( body => $body, name => $method_name ); + } + + $method->attach_to_class($self); + + $self->get_method_map->{$method_name} = $method; + + my ( $current_package, $current_name ) = Class::MOP::get_code_info($body); + + if ( !defined $current_name || $current_name eq '__ANON__' ) { + my $full_method_name = ($self->name . '::' . $method_name); + subname($full_method_name => $body); + } + + $self->add_package_symbol( + { sigil => '&', type => 'CODE', name => $method_name }, + $body, + ); +} + +sub has_method { + my ($self, $method_name) = @_; + (defined $method_name && $method_name) + || confess "You must define a method name"; + + exists $self->get_method_map->{$method_name}; +} + +sub get_method { + my ($self, $method_name) = @_; + (defined $method_name && $method_name) + || confess "You must define a method name"; + + return $self->get_method_map->{$method_name}; +} + +sub remove_method { + my ($self, $method_name) = @_; + (defined $method_name && $method_name) + || confess "You must define a method name"; + + my $removed_method = delete $self->get_method_map->{$method_name}; + + $self->remove_package_symbol( + { sigil => '&', type => 'CODE', name => $method_name } + ); + + $removed_method->detach_from_class if $removed_method; + + $self->update_package_cache_flag; # still valid, since we just removed the method from the map + + return $removed_method; +} + +sub get_method_list { + my $self = shift; + keys %{$self->get_method_map}; +} + + 1; __END__ @@ -228,68 +381,162 @@ 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. + +=item B<< $metapackage->namespace >> + +This returns a hash reference to the package's symbol table. The keys +are symbol names and the values are typeglob references. + +=item B<< $metapackage->add_package_symbol($variable_name, $initial_value) >> + +This method accepts a variable name and an optional initial value. The +C<$variable_name> must contain a leading sigil. + +This method creates the variable in the package's symbol table, and +sets it to the initial value if one was provided. + +=item B<< $metapackage->get_package_symbol($variable_name) >> + +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<< $metapackage->has_package_symbol($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<< $metapackage->remove_package_symbol($variable_name) >> + +This will remove the package variable specified C<$variable_name>. The +C<$variable_name> must contain a leading sigil. + +=item B<< $metapackage->remove_package_glob($glob_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<< $metapackage->list_all_package_symbols($type_filter) >> + +This will list all the glob names associated with the current +package. These names do not have leading sigils. + +You can provide an optional type filter, which should be one of +'SCALAR', 'ARRAY', 'HASH', or 'CODE'. + +=item B<< $metapackage->get_all_package_symbols($type_filter) >> + +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. + +=back + +=head2 Method introspection and creation + +These methods allow you to introspect a class's methods, as well as +add, remove, or change methods. + +Determining what is truly a method in a Perl 5 class requires some +heuristics (aka guessing). + +Methods defined outside the package with a fully qualified name (C) will be included. Similarly, methods named +with a fully qualified name using L are also included. + +However, we attempt to ignore imported functions. + +Ultimately, we are using heuristics to determine what truly is a +method in a class, and these heuristics may get the wrong answer in +some edge cases. However, for most "normal" cases the heuristics work +correctly. + +=over 4 -Returns a metaclass for this package. +=item B<< $metapackage->get_method($method_name) >> -=item B +This will return a L for the specified +C<$method_name>. If the class does not have the specified method, it +returns C -This will initialize a Class::MOP::Package instance which represents -the package of C<$package_name>. +=item B<< $metapackage->has_method($method_name) >> -=item B +Returns a boolean indicating whether or not the class defines the +named method. It does not include methods inherited from parent +classes. -This is a read-only attribute which returns the package name for the -given instance. +=item B<< $metapackage->get_method_map >> -=item B +Returns a hash reference representing the methods defined in this +class. The keys are method names and the values are +L objects. -This returns a HASH reference to the symbol table. The keys of the -HASH are the symbol names, and the values are typeglob references. +=item B<< $metapackage->get_method_list >> -=item B +This will return a list of method I for all methods defined in +this class. -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. +=item B<< $metapackage->add_method($method_name, $method) >> -=item B +This method takes a method name and a subroutine reference, and adds +the method to the class. -This will return a reference to the package variable in -C<$variable_name>. +The subroutine reference can be a L, and you are +strongly encouraged to pass a meta method object instead of a code +reference. If you do so, that object gets stored as part of the +class's method map directly. If not, the meta information will have to +be recreated later, and may be incorrect. -=item B +If you provide a method object, this method will clone that object if +the object's package name does not match the class name. This lets us +track the original source of any methods added from other classes +(notably Moose roles). -Returns true (C<1>) if there is a package variable defined for -C<$variable_name>, and false (C<0>) otherwise. +=item B<< $metapackage->remove_method($method_name) >> -=item B +Remove the named method from the class. This method returns the +L object for the method. -This will attempt to remove the package variable at C<$variable_name>. +=item B<< $metapackage->method_metaclass >> -=item B +Returns the class name of the method metaclass, see +L for more information on the method metaclass. -This will attempt to remove the entire typeglob associated with -C<$glob_name> from the package. +=item B<< $metapackage->wrapped_method_metaclass >> -=item B +Returns the class name of the wrapped method metaclass, see +L for more information on the wrapped +method metaclass. -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 @@ -299,7 +546,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