X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=d4f01037409f4121a3793d18632afa7e62f70013;hb=cacb672eae8fe9b02d53dc4e82c39091d401b4f8;hp=63636bad83f2343242cb608925de2bf3efcffd26;hpb=5e607260c836a5f08e30867701738be2d151a535;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index 63636ba..d4f0103 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -11,7 +11,8 @@ use Class::MOP::Method::Wrapped; use Carp 'confess'; use Scalar::Util 'blessed', 'weaken'; -our $VERSION = '0.65'; +our $VERSION = '0.72'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Module'; @@ -37,15 +38,6 @@ sub initialize { || $class->construct_class_instance(package => $package_name, @_); } -sub reinitialize { - my $class = shift; - my $package_name = shift; - (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->construct_class_instance('package' => $package_name, @_); -} - # NOTE: (meta-circularity) # this is a special form of &construct_instance # (see below), which is used to construct class @@ -54,8 +46,8 @@ sub reinitialize { # normal &construct_instance. sub construct_class_instance { my $class = shift; - my %options = @_; - my $package_name = $options{'package'}; + my $options = @_ == 1 ? $_[0] : {@_}; + my $package_name = $options->{package}; (defined $package_name && $package_name) || confess "You must pass a package name"; # NOTE: @@ -72,61 +64,28 @@ sub construct_class_instance { # we need to deal with the possibility # of class immutability here, and then # get the name of the class appropriately - $class = (blessed($class) + $class = (ref($class) ? ($class->is_immutable ? $class->get_mutable_metaclass_name() - : blessed($class)) + : ref($class)) : $class); # now create the metaclass my $meta; if ($class eq 'Class::MOP::Class') { no strict 'refs'; - $meta = bless { - # inherited from Class::MOP::Package - 'package' => $package_name, - - # NOTE: - # since the following attributes will - # actually be loaded from the symbol - # table, and actually bypass the instance - # entirely, we can just leave these things - # listed here for reference, because they - # should not actually have a value associated - # with the slot. - 'namespace' => \undef, - # inherited from Class::MOP::Module - 'version' => \undef, - 'authority' => \undef, - # defined in Class::MOP::Class - 'superclasses' => \undef, - - 'methods' => {}, - 'attributes' => {}, - 'attribute_metaclass' => $options{'attribute_metaclass'} || 'Class::MOP::Attribute', - 'method_metaclass' => $options{'method_metaclass'} || 'Class::MOP::Method', - 'instance_metaclass' => $options{'instance_metaclass'} || 'Class::MOP::Instance', - - ## uber-private variables - # NOTE: - # this starts out as undef so that - # we can tell the first time the - # methods are fetched - # - SL - '_package_cache_flag' => undef, - '_meta_instance' => undef, - } => $class; + $meta = $class->_new($options) } else { # NOTE: # it is safe to use meta here because # class will always be a subclass of # Class::MOP::Class, which defines meta - $meta = $class->meta->construct_instance(%options) + $meta = $class->meta->construct_instance($options) } # and check the metaclass compatibility - $meta->check_metaclass_compatability(); + $meta->check_metaclass_compatibility(); Class::MOP::store_metaclass_by_name($package_name, $meta); @@ -138,6 +97,37 @@ sub construct_class_instance { $meta; } +sub _new { + my $class = shift; + my $options = @_ == 1 ? $_[0] : {@_}; + + bless { + # inherited from Class::MOP::Package + 'package' => $options->{package}, + + # NOTE: + # since the following attributes will + # actually be loaded from the symbol + # table, and actually bypass the instance + # entirely, we can just leave these things + # listed here for reference, because they + # should not actually have a value associated + # with the slot. + 'namespace' => \undef, + # inherited from Class::MOP::Module + 'version' => \undef, + 'authority' => \undef, + # defined in Class::MOP::Class + 'superclasses' => \undef, + + 'methods' => {}, + 'attributes' => {}, + 'attribute_metaclass' => $options->{'attribute_metaclass'} || 'Class::MOP::Attribute', + 'method_metaclass' => $options->{'method_metaclass'} || 'Class::MOP::Method', + 'instance_metaclass' => $options->{'instance_metaclass'} || 'Class::MOP::Instance', + }, $class; +} + sub reset_package_cache_flag { (shift)->{'_package_cache_flag'} = undef } sub update_package_cache_flag { my $self = shift; @@ -150,11 +140,11 @@ sub update_package_cache_flag { $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name); } -sub check_metaclass_compatability { +sub check_metaclass_compatibility { my $self = shift; # this is always okay ... - return if blessed($self) eq 'Class::MOP::Class' && + return if ref($self) eq 'Class::MOP::Class' && $self->instance_metaclass eq 'Class::MOP::Instance'; my @class_list = $self->linearized_isa; @@ -169,22 +159,28 @@ sub check_metaclass_compatability { # get the name of the class appropriately my $meta_type = ($meta->is_immutable ? $meta->get_mutable_metaclass_name() - : blessed($meta)); + : ref($meta)); ($self->isa($meta_type)) - || confess $self->name . "->meta => (" . (blessed($self)) . ")" . + || confess $self->name . "->meta => (" . (ref($self)) . ")" . " is not compatible with the " . $class_name . "->meta => (" . ($meta_type) . ")"; # NOTE: # we also need to check that instance metaclasses - # are compatabile in the same the class. + # are compatibile in the same the class. ($self->instance_metaclass->isa($meta->instance_metaclass)) - || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" . + || confess $self->name . "->meta->instance_metaclass => (" . ($self->instance_metaclass) . ")" . " is not compatible with the " . - $class_name . "->meta => (" . ($meta->instance_metaclass) . ")"; + $class_name . "->meta->instance_metaclass => (" . ($meta->instance_metaclass) . ")"; } } +# backwards compat for stevan's inability to spell ;) +sub check_metaclass_compatability { + my $self = shift; + $self->check_metaclass_compatibility(@_); +} + ## ANON classes { @@ -204,7 +200,7 @@ sub check_metaclass_compatability { sub is_anon_class { my $self = shift; no warnings 'uninitialized'; - $self->name =~ /^$ANON_CLASS_PREFIX/ ? 1 : 0; + $self->name =~ /^$ANON_CLASS_PREFIX/; } sub create_anon_class { @@ -213,15 +209,6 @@ sub check_metaclass_compatability { return $class->create($package_name, %options); } - BEGIN { - local $@; - eval { - require Devel::GlobalDestruction; - Devel::GlobalDestruction->import("in_global_destruction"); - 1; - } or *in_global_destruction = sub () { '' }; - } - # NOTE: # this will only get called for # anon-classes, all other calls @@ -231,10 +218,18 @@ sub check_metaclass_compatability { sub DESTROY { my $self = shift; - return if in_global_destruction; # it'll happen soon anyway and this just makes things more complicated + return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated no warnings 'uninitialized'; return unless $self->name =~ /^$ANON_CLASS_PREFIX/; + # Moose does a weird thing where it replaces the metaclass for + # class when fixing metaclass incompatibility. In that case, + # we don't want to clean out the namespace now. We can detect + # that because Moose will explicitly update the singleton + # cache in Class::MOP. + my $current_meta = Class::MOP::get_metaclass_by_name($self->name); + return if $current_meta ne $self; + my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/); no strict 'refs'; foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) { @@ -255,9 +250,6 @@ sub create { my (%options) = @args; my $package_name = $options{package}; - (defined $package_name && $package_name) - || confess "You must pass a package name"; - (ref $options{superclasses} eq 'ARRAY') || confess "You must pass an ARRAY ref of superclasses" if exists $options{superclasses}; @@ -267,23 +259,25 @@ sub create { if exists $options{attributes}; (ref $options{methods} eq 'HASH') - || confess "You must pass an HASH ref of methods" + || confess "You must pass a HASH ref of methods" if exists $options{methods}; - my $code = "package $package_name;"; - $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" - if exists $options{version}; - $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';" - if exists $options{authority}; - - eval $code; - confess "creation of $package_name failed : $@" if $@; + $class->SUPER::create(%options); - my $meta = $class->initialize($package_name); + my (%initialize_options) = @args; + delete @initialize_options{qw( + package + superclasses + attributes + methods + version + authority + )}; + my $meta = $class->initialize( $package_name => %initialize_options ); # FIXME totally lame $meta->add_method('meta' => sub { - $class->initialize(blessed($_[0]) || $_[0]); + $class->initialize(ref($_[0]) || $_[0]); }); $meta->superclasses(@{$options{superclasses}}) @@ -317,28 +311,27 @@ sub attribute_metaclass { $_[0]->{'attribute_metaclass'} } sub method_metaclass { $_[0]->{'method_metaclass'} } sub instance_metaclass { $_[0]->{'instance_metaclass'} } -# FIXME: -# this is a prime canidate for conversion to XS sub get_method_map { my $self = shift; - - my $current = Class::MOP::check_package_cache_flag($self->name); + + my $class_name = $self->name; + + my $current = Class::MOP::check_package_cache_flag($class_name); if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) { - return $self->{'methods'}; + return $self->{'methods'} ||= {}; } $self->{_package_cache_flag} = $current; - my $map = $self->{'methods'}; + my $map = $self->{'methods'} ||= {}; - my $class_name = $self->name; my $method_metaclass = $self->method_metaclass; - my %all_code = $self->get_all_package_symbols('CODE'); + my $all_code = $self->get_all_package_symbols('CODE'); - foreach my $symbol (keys %all_code) { - my $code = $all_code{$symbol}; + foreach my $symbol (keys %{ $all_code }) { + my $code = $all_code->{$symbol}; next if exists $map->{$symbol} && defined $map->{$symbol} && @@ -385,11 +378,12 @@ sub new_object { } sub construct_instance { - my ($class, %params) = @_; + my $class = shift; + my $params = @_ == 1 ? $_[0] : {@_}; my $meta_instance = $class->get_meta_instance(); my $instance = $meta_instance->create_instance(); foreach my $attr ($class->compute_all_applicable_attributes()) { - $attr->initialize_instance_slot($meta_instance, $instance, \%params); + $attr->initialize_instance_slot($meta_instance, $instance, $params); } # NOTE: # this will only work for a HASH instance type @@ -430,7 +424,7 @@ sub clone_object { my $class = shift; my $instance = shift; (blessed($instance) && $instance->isa($class->name)) - || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)"; + || confess "You must pass an instance of the metaclass (" . (ref $class ? $class->name : $class) . "), not ($instance)"; # NOTE: # we need to protect the integrity of the @@ -466,7 +460,7 @@ sub rebless_instance { $old_metaclass = $instance->meta; } else { - $old_metaclass = $self->initialize(blessed($instance)); + $old_metaclass = $self->initialize(ref($instance)); } my $meta_instance = $self->get_meta_instance(); @@ -504,13 +498,22 @@ sub superclasses { if (@_) { my @supers = @_; @{$self->get_package_symbol($var_spec)} = @supers; + + # NOTE: + # on 5.8 and below, we need to call + # a method to get Perl to detect + # a cycle in the class hierarchy + my $class = $self->name; + $class->isa($class); + # NOTE: # we need to check the metaclass # compatibility here so that we can # be sure that the superclass is # not potentially creating an issues # we don't know about - $self->check_metaclass_compatability(); + + $self->check_metaclass_compatibility(); $self->update_meta_instance_dependencies(); } @{$self->get_package_symbol($var_spec)}; @@ -606,6 +609,18 @@ sub class_precedence_list { ## 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) @@ -614,11 +629,7 @@ sub add_method { my $body; if (blessed($method)) { $body = $method->body; - if ($method->package_name ne $self->name && - $method->name ne $method_name) { - warn "Hello there, got something for you." - . " Method says " . $method->package_name . " " . $method->name - . " Class says " . $self->name . " " . $method_name; + if ($method->package_name ne $self->name) { $method = $method->clone( package_name => $self->name, name => $method_name @@ -627,27 +638,21 @@ sub add_method { } else { $body = $method; - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; - $method = $self->method_metaclass->wrap( - $body => ( - package_name => $self->name, - name => $method_name - ) - ); + $method = $self->wrap_method_body( body => $body, name => $method_name ); } $method->attach_to_class($self); - $self->get_method_map->{$method_name} = $method; + # This used to call get_method_map, which meant we would build all + # the method objects for the class just because we added one + # method. This is hackier, but quicker too. + $self->{methods}{$method_name} = $method; my $full_method_name = ($self->name . '::' . $method_name); $self->add_package_symbol( { sigil => '&', type => 'CODE', name => $method_name }, Class::MOP::subname($full_method_name => $body) ); - - $self->update_package_cache_flag; # still valid, since we just added the method to the map, and if it was invalid before that then get_method_map updated it } { @@ -721,17 +726,9 @@ sub add_method { } sub alias_method { - my ($self, $method_name, $method) = @_; - (defined $method_name && $method_name) - || confess "You must define a method name"; - - my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq ref($body)) - || confess "Your code block must be a CODE reference"; + my $self = shift; - $self->add_package_symbol( - { sigil => '&', type => 'CODE', name => $method_name } => $body - ); + $self->add_method(@_); } sub has_method { @@ -739,8 +736,7 @@ sub has_method { (defined $method_name && $method_name) || confess "You must define a method name"; - return 0 unless exists $self->get_method_map->{$method_name}; - return 1; + exists $self->{methods}{$method_name} || exists $self->get_method_map->{$method_name}; } sub get_method { @@ -754,7 +750,7 @@ sub get_method { # will just return undef for me now # return unless $self->has_method($method_name); - return $self->get_method_map->{$method_name}; + return $self->{methods}{$method_name} || $self->get_method_map->{$method_name}; } sub remove_method { @@ -793,23 +789,21 @@ sub find_method_by_name { return; } -sub compute_all_applicable_methods { +sub get_all_methods { my $self = shift; - my (@methods, %seen_method); - foreach my $class ($self->linearized_isa) { - # fetch the meta-class ... - my $meta = $self->initialize($class); - foreach my $method_name ($meta->get_method_list()) { - next if exists $seen_method{$method_name}; - $seen_method{$method_name}++; - push @methods => { - name => $method_name, - class => $class, - code => $meta->get_method($method_name) - }; - } - } - return @methods; + my %methods = map { %{ $self->initialize($_)->get_method_map } } reverse $self->linearized_isa; + return values %methods; +} + +# compatibility +sub compute_all_applicable_methods { + return map { + { + name => $_->name, + class => $_->package_name, + code => $_, # sigh, overloading + }, + } shift->get_all_methods(@_); } sub find_all_methods_by_name { @@ -948,7 +942,7 @@ sub has_attribute { my ($self, $attribute_name) = @_; (defined $attribute_name && $attribute_name) || confess "You must define an attribute name"; - exists $self->get_attribute_map->{$attribute_name} ? 1 : 0; + exists $self->get_attribute_map->{$attribute_name}; } sub get_attribute { @@ -980,19 +974,14 @@ sub get_attribute_list { keys %{$self->get_attribute_map}; } +sub get_all_attributes { + shift->compute_all_applicable_attributes(@_); +} + sub compute_all_applicable_attributes { my $self = shift; - my (@attrs, %seen_attr); - foreach my $class ($self->linearized_isa) { - # fetch the meta-class ... - my $meta = $self->initialize($class); - foreach my $attr_name ($meta->get_attribute_list()) { - next if exists $seen_attr{$attr_name}; - $seen_attr{$attr_name}++; - push @attrs => $meta->get_attribute($attr_name); - } - } - return @attrs; + my %attrs = map { %{ $self->initialize($_)->get_attribute_map } } reverse $self->linearized_isa; + return values %attrs; } sub find_attribute_by_name { @@ -1006,6 +995,25 @@ sub find_attribute_by_name { return; } +# check if we can reinitialize +sub is_pristine { + my $self = shift; + + # if any local attr is defined + return if $self->get_attribute_list; + + # or any non-declared methods + if ( my @methods = values %{ $self->get_method_map } ) { + my $metaclass = $self->method_metaclass; + foreach my $method ( @methods ) { + return if $method->isa("Class::MOP::Method::Generated"); + # FIXME do we need to enforce this too? return unless $method->isa($metaclass); + } + } + + return 1; +} + ## Class closing sub is_mutable { 1 } @@ -1047,7 +1055,7 @@ sub is_immutable { 0 } sub get_immutable_transformer { my $self = shift; if( $self->is_mutable ){ - my $class = blessed $self || $self; + my $class = ref $self || $self; return $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer; } confess "unable to find transformer for immutable class" @@ -1097,7 +1105,9 @@ sub create_immutable_transformer { /], memoize => { class_precedence_list => 'ARRAY', - linearized_isa => 'ARRAY', + linearized_isa => 'ARRAY', # FIXME perl 5.10 memoizes this on its own, no need? + get_all_methods => 'ARRAY', + #get_all_attributes => 'ARRAY', # it's an alias, no need, but maybe in the future compute_all_applicable_attributes => 'ARRAY', get_meta_instance => 'SCALAR', get_method_map => 'SCALAR', @@ -1111,7 +1121,12 @@ sub create_immutable_transformer { my $original = shift; confess "Cannot add package symbols to an immutable metaclass" unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol'; - goto $original->body; + + # This is a workaround for a bug in 5.8.1 which thinks that + # goto $original->body + # is trying to go to a label + my $body = $original->body; + goto $body; }, }, }); @@ -1234,12 +1249,6 @@ as we use a special reserved slot (C<__MOP__>) to store this. This initializes and returns returns a B object for a given a C<$package_name>. -=item B - -This removes the old metaclass, and creates a new one in it's place. -Do B use this unless you really know what you are doing, it could -very easily make a very large mess of your program. - =item B This will construct an instance of B, it is @@ -1248,7 +1257,7 @@ to use C once all the bootstrapping is done. This method is used internally by C and should never be called from outside of that method really. -=item B +=item B This method is called as the very last thing in the C method. This will check that the @@ -1407,6 +1416,11 @@ This returns true if the class is still mutable. This returns true if the class has been made immutable. +=item B + +Checks whether the class has any data that will be lost if C is +called. + =back =head2 Inheritance Relationships @@ -1449,10 +1463,24 @@ Returns a HASH ref of name to CODE reference mapping for this class. Returns the class name of the method metaclass, see L for more information on the method metaclasses. +=item B + +Wrap a code ref (C<$attrs{body>) with C. + =item B -This will take a C<$method_name> and CODE reference to that -C<$method> and install it into the class's package. +This will take a C<$method_name> and CODE reference or meta method +objectand install it into the class's package. + +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, providing more useful information about the method +for introspection. + +When 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). B: This does absolutely nothing special to C<$method> @@ -1460,16 +1488,6 @@ other than use B to make sure it is tagged with the correct name, and therefore show up correctly in stack traces and such. -=item B - -This will take a C<$method_name> and CODE reference to that -C<$method> and alias the method into the class's package. - -B: -Unlike C, this will B try to name the -C<$method> using B, it only aliases the method in -the class's package. - =item B This just provides a simple way to check if the class implements @@ -1522,13 +1540,20 @@ methods. It does B provide a list of all applicable methods, including any inherited ones. If you want a list of all applicable methods, use the C method. +=item B + +This will traverse the inheritance heirachy and return a list of all +the applicable L objects for this class. + =item B -This will return a list of all the methods names this class will -respond to, taking into account inheritance. The list will be a list of -HASH references, each one containing the following information; method -name, the name of the class in which the method lives and a CODE -reference for the actual method. +Deprecated. + +This method returns a list of hashes describing the all the methods of the +class. + +Use L, which is easier/better/faster. This method predates +L. =item B @@ -1550,6 +1575,11 @@ This will return the first method to match a given C<$method_name> in the superclasses, this is basically equivalent to calling C, but it can be dispatched at runtime. +=item B + +B: This method is now deprecated. Just use C +instead. + =back =head2 Method Modifiers @@ -1723,11 +1753,12 @@ use the C method. =item B +=item B + This will traverse the inheritance heirachy and return a list of all -the applicable attributes for this class. It does not construct a -HASH reference like C because all -that same information is discoverable through the attribute -meta-object itself. +the applicable L objects for this class. + +C is an alias for consistency with C. =item B