X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=06914b4584c65a57d3d29a155b94f81e523f33ba;hb=4c1053331a179a6d1dd8e71d49ef05852a81387e;hp=cbfa745c0eead53eda641b38948a0444a972bc4a;hpb=0ac992ee5992b68d0019cf1c1fd16000adf9b71f;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index cbfa745..06914b4 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -10,18 +10,12 @@ use Class::MOP::Method::Wrapped; use Carp 'confess'; use Scalar::Util 'blessed', 'reftype', 'weaken'; -use Sub::Name 'subname'; -use B 'svref_2object'; -our $VERSION = '0.22'; +our $VERSION = '0.31'; our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Module'; -# Self-introspection - -sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) } - # Creation sub initialize { @@ -29,6 +23,9 @@ sub initialize { my $package_name = shift; (defined $package_name && $package_name && !blessed($package_name)) || confess "You must pass a package name and it cannot be blessed"; + if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) { + return $meta; + } $class->construct_class_instance('package' => $package_name, @_); } @@ -58,8 +55,10 @@ sub construct_class_instance { # and it is still defined (it has not been # reaped by DESTROY yet, which can happen # annoyingly enough during global destruction) - return Class::MOP::get_metaclass_by_name($package_name) - if Class::MOP::does_metaclass_exist($package_name); + + if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) { + return $meta; + } # NOTE: # we need to deal with the possibility @@ -73,7 +72,7 @@ sub construct_class_instance { # now create the metaclass my $meta; - if ($class =~ /^Class::MOP::Class$/) { + if ($class eq 'Class::MOP::Class') { no strict 'refs'; $meta = bless { # inherited from Class::MOP::Package @@ -99,6 +98,14 @@ sub construct_class_instance { '$!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, } => $class; } else { @@ -110,7 +117,7 @@ sub construct_class_instance { } # and check the metaclass compatibility - $meta->check_metaclass_compatability(); + $meta->check_metaclass_compatability(); Class::MOP::store_metaclass_by_name($package_name, $meta); @@ -122,6 +129,18 @@ sub construct_class_instance { $meta; } +sub reset_package_cache_flag { (shift)->{'$!_package_cache_flag'} = undef } +sub update_package_cache_flag { + my $self = shift; + # NOTE: + # we can manually update the cache number + # since we are actually adding the method + # to our cache as well. This avoids us + # having to regenerate the method_map. + # - SL + $self->{'$!_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name); +} + sub check_metaclass_compatability { my $self = shift; @@ -129,7 +148,7 @@ sub check_metaclass_compatability { return if blessed($self) eq 'Class::MOP::Class' && $self->instance_metaclass eq 'Class::MOP::Instance'; - my @class_list = $self->class_precedence_list; + my @class_list = $self->linearized_isa; shift @class_list; # shift off $self->name foreach my $class_name (@class_list) { @@ -219,6 +238,18 @@ sub create { "(I found an uneven number of params in \@_)"; my (%options) = @_; + + (ref $options{superclasses} eq 'ARRAY') + || confess "You must pass an ARRAY ref of superclasses" + if exists $options{superclasses}; + + (ref $options{attributes} eq 'ARRAY') + || confess "You must pass an ARRAY ref of attributes" + if exists $options{attributes}; + + (ref $options{methods} eq 'HASH') + || confess "You must pass an HASH ref of methods" + if exists $options{methods}; my $code = "package $package_name;"; $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" @@ -270,6 +301,12 @@ sub instance_metaclass { $_[0]->{'$!instance_metaclass'} } # this is a prime canidate for conversion to XS sub get_method_map { my $self = shift; + + if (defined $self->{'$!_package_cache_flag'} && + $self->{'$!_package_cache_flag'} == Class::MOP::check_package_cache_flag($self->name)) { + return $self->{'%!methods'}; + } + my $map = $self->{'%!methods'}; my $class_name = $self->name; @@ -282,9 +319,12 @@ sub get_method_map { defined $map->{$symbol} && $map->{$symbol}->body == $code; - my $gv = svref_2object($code)->GV; - next if ($gv->STASH->NAME || '') ne $class_name && - ($gv->NAME || '') ne '__ANON__'; + my ($pkg, $name) = Class::MOP::get_code_info($code); + + next if ($pkg || '') ne $class_name || + (($name || '') ne '__ANON__' && ($pkg || '') ne $class_name); + + #warn "Checking $pkg against $class_name && $name against __ANON__"; $map->{$symbol} = $method_metaclass->wrap($code); } @@ -356,13 +396,55 @@ sub clone_instance { my $meta_instance = $class->get_meta_instance(); my $clone = $meta_instance->clone_instance($instance); foreach my $attr ($class->compute_all_applicable_attributes()) { - if (exists $params{$attr->init_arg}) { - $meta_instance->set_slot_value($clone, $attr->name, $params{$attr->init_arg}); + if ( defined( my $init_arg = $attr->init_arg ) ) { + if (exists $params{$init_arg}) { + $attr->set_value($clone, $params{$init_arg}); + } } } return $clone; } +sub rebless_instance { + my ($self, $instance, %params) = @_; + + my $old_metaclass; + if ($instance->can('meta')) { + ($instance->meta->isa('Class::MOP::Class')) + || confess 'Cannot rebless instance if ->meta is not an instance of Class::MOP::Class'; + $old_metaclass = $instance->meta; + } + else { + $old_metaclass = $self->initialize(blessed($instance)); + } + + my $meta_instance = $self->get_meta_instance(); + + $self->name->isa($old_metaclass->name) + || confess "You may rebless only into a subclass of (". $old_metaclass->name ."), of which (". $self->name .") isn't."; + + # rebless! + $meta_instance->rebless_instance_structure($instance, $self); + + foreach my $attr ( $self->compute_all_applicable_attributes ) { + if ( $attr->has_value($instance) ) { + if ( defined( my $init_arg = $attr->init_arg ) ) { + $params{$init_arg} = $attr->get_value($instance) + unless exists $params{$init_arg}; + } + else { + $attr->set_value($instance, $attr->get_value($instance)); + } + } + } + + foreach my $attr ($self->compute_all_applicable_attributes) { + $attr->initialize_instance_slot($meta_instance, $instance, \%params); + } + + $instance; +} + # Inheritance sub superclasses { @@ -372,7 +454,7 @@ sub superclasses { @{$self->get_package_symbol('@ISA')} = @supers; # NOTE: # we need to check the metaclass - # compatability here so that we can + # compatibility here so that we can # be sure that the superclass is # not potentially creating an issues # we don't know about @@ -381,21 +463,87 @@ sub superclasses { @{$self->get_package_symbol('@ISA')}; } +sub subclasses { + my $self = shift; + + my $super_class = $self->name; + my @derived_classes; + + my $find_derived_classes; + $find_derived_classes = sub { + my ($outer_class) = @_; + + my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} }; + + SYMBOL: + for my $symbol ( keys %$symbol_table_hashref ) { + next SYMBOL if $symbol !~ /\A (\w+):: \z/x; + my $inner_class = $1; + + next SYMBOL if $inner_class eq 'SUPER'; # skip '*::SUPER' + + my $class = + $outer_class + ? "${outer_class}::$inner_class" + : $inner_class; + + if ( $class->isa($super_class) and $class ne $super_class ) { + push @derived_classes, $class; + } + + next SYMBOL if $class eq 'main'; # skip 'main::*' + + $find_derived_classes->($class); + } + }; + + my $root_class = q{}; + $find_derived_classes->($root_class); + + undef $find_derived_classes; + + @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes; + + return @derived_classes; +} + + +sub linearized_isa { + return @{ mro::get_linear_isa( (shift)->name ) }; +} + sub class_precedence_list { my $self = shift; - # NOTE: - # We need to check for ciruclar inheirtance here. - # This will do nothing if all is well, and blow - # up otherwise. Yes, it's an ugly hack, better - # suggestions are welcome. - { ($self->name || return)->isa('This is a test for circular inheritance') } - - ( - $self->name, - map { - $self->initialize($_)->class_precedence_list() - } $self->superclasses() - ); + my $name = $self->name; + + unless (Class::MOP::IS_RUNNING_ON_5_10()) { + # NOTE: + # We need to check for circular inheritance here + # if we are are not on 5.10, cause 5.8 detects it + # late. This will do nothing if all is well, and + # blow up otherwise. Yes, it's an ugly hack, better + # suggestions are welcome. + # - SL + ($name || return)->isa('This is a test for circular inheritance') + } + + # if our mro is c3, we can + # just grab the linear_isa + if (mro::get_mro($name) eq 'c3') { + return @{ mro::get_linear_isa($name) } + } + else { + # NOTE: + # we can't grab the linear_isa for dfs + # since it has all the duplicates + # already removed. + return ( + $name, + map { + $self->initialize($_)->class_precedence_list() + } $self->superclasses() + ); + } } ## Methods @@ -408,17 +556,35 @@ 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 somethig for you." + . " Method says " . $method->package_name . " " . $method->name + . " Class says " . $self->name . " " . $method_name; + $method = $method->clone( + package_name => $self->name, + name => $method_name + ) if $method->can('clone'); + } } else { $body = $method; ('CODE' eq (reftype($body) || '')) || confess "Your code block must be a CODE reference"; - $method = $self->method_metaclass->wrap($body); + $method = $self->method_metaclass->wrap( + $body => ( + package_name => $self->name, + name => $method_name + ) + ); } $self->get_method_map->{$method_name} = $method; - - my $full_method_name = ($self->name . '::' . $method_name); - $self->add_package_symbol("&${method_name}" => subname $full_method_name => $body); + + my $full_method_name = ($self->name . '::' . $method_name); + $self->add_package_symbol("&${method_name}" => + Class::MOP::subname($full_method_name => $body) + ); + $self->update_package_cache_flag; } { @@ -452,7 +618,9 @@ sub add_method { (defined $method_name && $method_name) || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); - $method->add_before_modifier(subname ':before' => $method_modifier); + $method->add_before_modifier( + Class::MOP::subname(':before' => $method_modifier) + ); } sub add_after_method_modifier { @@ -460,7 +628,9 @@ sub add_method { (defined $method_name && $method_name) || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); - $method->add_after_modifier(subname ':after' => $method_modifier); + $method->add_after_modifier( + Class::MOP::subname(':after' => $method_modifier) + ); } sub add_around_method_modifier { @@ -468,7 +638,9 @@ sub add_method { (defined $method_name && $method_name) || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); - $method->add_around_modifier(subname ':around' => $method_modifier); + $method->add_around_modifier( + Class::MOP::subname(':around' => $method_modifier) + ); } # NOTE: @@ -495,6 +667,7 @@ sub alias_method { || confess "Your code block must be a CODE reference"; $self->add_package_symbol("&${method_name}" => $body); + $self->update_package_cache_flag; } sub has_method { @@ -525,12 +698,11 @@ sub remove_method { (defined $method_name && $method_name) || confess "You must define a method name"; - my $removed_method = $self->get_method($method_name); - - do { - $self->remove_package_symbol("&${method_name}"); - delete $self->get_method_map->{$method_name}; - } if defined $removed_method; + my $removed_method = delete $self->get_method_map->{$method_name}; + + $self->remove_package_symbol("&${method_name}"); + + $self->update_package_cache_flag; return $removed_method; } @@ -544,15 +716,7 @@ sub find_method_by_name { my ($self, $method_name) = @_; (defined $method_name && $method_name) || confess "You must define a method name to find"; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my %seen_class; - my @cpl = $self->class_precedence_list(); - foreach my $class (@cpl) { - next if $seen_class{$class}; - $seen_class{$class}++; + foreach my $class ($self->linearized_isa) { # fetch the meta-class ... my $meta = $self->initialize($class); return $meta->get_method($method_name) @@ -563,15 +727,8 @@ sub find_method_by_name { sub compute_all_applicable_methods { my $self = shift; - my @methods; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my (%seen_class, %seen_method); - foreach my $class ($self->class_precedence_list()) { - next if $seen_class{$class}; - $seen_class{$class}++; + 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()) { @@ -592,14 +749,7 @@ sub find_all_methods_by_name { (defined $method_name && $method_name) || confess "You must define a method name to find"; my @methods; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my %seen_class; - foreach my $class ($self->class_precedence_list()) { - next if $seen_class{$class}; - $seen_class{$class}++; + foreach my $class ($self->linearized_isa) { # fetch the meta-class ... my $meta = $self->initialize($class); push @methods => { @@ -615,16 +765,9 @@ sub find_next_method_by_name { my ($self, $method_name) = @_; (defined $method_name && $method_name) || confess "You must define a method name to find"; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my %seen_class; - my @cpl = $self->class_precedence_list(); + my @cpl = $self->linearized_isa; shift @cpl; # discard ourselves foreach my $class (@cpl) { - next if $seen_class{$class}; - $seen_class{$class}++; # fetch the meta-class ... my $meta = $self->initialize($class); return $meta->get_method($method_name) @@ -698,15 +841,8 @@ sub get_attribute_list { sub compute_all_applicable_attributes { my $self = shift; - my @attrs; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my (%seen_class, %seen_attr); - foreach my $class ($self->class_precedence_list()) { - next if $seen_class{$class}; - $seen_class{$class}++; + 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()) { @@ -720,14 +856,7 @@ sub compute_all_applicable_attributes { sub find_attribute_by_name { my ($self, $attr_name) = @_; - # keep a record of what we have seen - # here, this will handle all the - # inheritence issues because we are - # using the &class_precedence_list - my %seen_class; - foreach my $class ($self->class_precedence_list()) { - next if $seen_class{$class}; - $seen_class{$class}++; + foreach my $class ($self->linearized_isa) { # fetch the meta-class ... my $meta = $self->initialize($class); return $meta->get_attribute($attr_name) @@ -741,47 +870,91 @@ sub find_attribute_by_name { sub is_mutable { 1 } sub is_immutable { 0 } +# NOTE: +# Why I changed this (groditi) +# - One Metaclass may have many Classes through many Metaclass instances +# - One Metaclass should only have one Immutable Transformer instance +# - Each Class may have different Immutabilizing options +# - Therefore each Metaclass instance may have different Immutabilizing options +# - We need to store one Immutable Transformer instance per Metaclass +# - We need to store one set of Immutable Transformer options per Class +# - Upon make_mutable we may delete the Immutabilizing options +# - We could clean the immutable Transformer instance when there is no more +# immutable Classes of that type, but we can also keep it in case +# another class with this same Metaclass becomes immutable. It is a case +# of trading of storing an instance to avoid unnecessary instantiations of +# Immutable Transformers. You may view this as a memory leak, however +# Because we have few Metaclasses, in practice it seems acceptable +# - To allow Immutable Transformers instances to be cleaned up we could weaken +# the reference stored in $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM + { - # NOTE: - # the immutable version of a - # particular metaclass is - # really class-level data so - # we don't want to regenerate - # it any more than we need to - my $IMMUTABLE_METACLASS; + my %IMMUTABLE_TRANSFORMERS; my %IMMUTABLE_OPTIONS; sub make_immutable { my $self = shift; - %IMMUTABLE_OPTIONS = @_; - - $IMMUTABLE_METACLASS ||= Class::MOP::Immutable->new($self, { - read_only => [qw/superclasses/], - cannot_call => [qw/ - add_method - alias_method - remove_method - add_attribute - remove_attribute - add_package_symbol - remove_package_symbol - /], - memoize => { - class_precedence_list => 'ARRAY', - compute_all_applicable_attributes => 'ARRAY', - get_meta_instance => 'SCALAR', - get_method_map => 'SCALAR', - } - }); + my %options = @_; + my $class = blessed $self || $self; + + $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer; + my $transformer = $IMMUTABLE_TRANSFORMERS{$class}; + + $transformer->make_metaclass_immutable($self, \%options); + $IMMUTABLE_OPTIONS{$self->name} = + { %options, IMMUTABLE_TRANSFORMER => $transformer }; - $IMMUTABLE_METACLASS->make_metaclass_immutable($self, %IMMUTABLE_OPTIONS); + if( exists $options{debug} && $options{debug} ){ + print STDERR "# of Metaclass options: ", keys %IMMUTABLE_OPTIONS; + print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS; + } + + 1; } sub make_mutable{ my $self = shift; return if $self->is_mutable; - $IMMUTABLE_METACLASS->make_metaclass_mutable($self, %IMMUTABLE_OPTIONS); + my $options = delete $IMMUTABLE_OPTIONS{$self->name}; + confess "unable to find immutabilizing options" unless ref $options; + my $transformer = delete $options->{IMMUTABLE_TRANSFORMER}; + $transformer->make_metaclass_mutable($self, $options); + 1; } +} +sub create_immutable_transformer { + my $self = shift; + my $class = Class::MOP::Immutable->new($self, { + read_only => [qw/superclasses/], + cannot_call => [qw/ + add_method + alias_method + remove_method + add_attribute + remove_attribute + remove_package_symbol + /], + memoize => { + class_precedence_list => 'ARRAY', + linearized_isa => 'ARRAY', + compute_all_applicable_attributes => 'ARRAY', + get_meta_instance => 'SCALAR', + get_method_map => 'SCALAR', + }, + # NOTE: + # this is ugly, but so are typeglobs, + # so whattayahgonnadoboutit + # - SL + wrapped => { + add_package_symbol => sub { + 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; + }, + }, + }); + return $class; } 1; @@ -922,6 +1095,18 @@ metaclass you are creating is compatible with the metaclasses of all your ancestors. For more inforamtion about metaclass compatibility see the C section in L. +=item B + +This will reset the package cache flag for this particular metaclass +it is basically the value of the C +function. This is very rarely needed from outside of C +but in some cases you might want to use it, so it is here. + +=item B + +Clears the package cache flag to announce to the internals that we need +to rebuild the method map. + =back =head2 Object instance construction and cloning @@ -933,8 +1118,14 @@ to use them or not. =item B +Returns the class name of the instance metaclass, see L +for more information on the instance metaclasses. + =item B +Returns an instance of L to be used in the construction +of a new instance of the class. + =item B This is a convience method for creating a new object of the class, and @@ -946,12 +1137,9 @@ would call a C this method like so: $class->meta->new_object(%params); } -Of course the ideal place for this would actually be in C -but that is considered bad style, so we do not do that. - =item B -This method is used to construct an instace structure suitable for +This method is used to construct an instance structure suitable for C-ing into your package of choice. It works in conjunction with the Attribute protocol to collect all applicable attributes. @@ -975,9 +1163,6 @@ class would call a C this method like so: $self->meta->clone_object($self, %params); } -Of course the ideal place for this would actually be in C -but that is considered bad style, so we do not do that. - =item B This method is a compliment of C (which means if @@ -996,6 +1181,13 @@ shallow cloning is outside the scope of the meta-object protocol. I think Yuval "nothingmuch" Kogman put it best when he said that cloning is too I to be part of the MOP. +=item B + +This will change the class of C<$instance> to the class of the invoking +C. You may only rebless the instance to a subclass of +itself. You may pass in optional C<%params> which are like constructor +params and will override anything already defined in the instance. + =back =head2 Informational @@ -1028,18 +1220,20 @@ This is a read-write attribute which represents the superclass relationships of the class the B instance is associated with. Basically, it can get and set the C<@ISA> for you. -B -Perl will occasionally perform some C<@ISA> and method caching, if -you decide to change your superclass relationship at runtime (which -is quite insane and very much not recommened), then you should be -aware of this and the fact that this module does not make any -attempt to address this issue. - =item B This computes the a list of all the class's ancestors in the same order -in which method dispatch will be done. This is similair to -what B does, but we don't remove duplicate names. +in which method dispatch will be done. This is similair to what +B does, but we don't remove duplicate names. + +=item B + +This returns a list based on C but with all +duplicates removed. + +=item B + +This returns a list of subclasses for this class. =back @@ -1049,8 +1243,13 @@ what B does, but we don't remove duplicate names. =item B +Returns a HASH ref of name to CODE reference mapping for this class. + =item B +Returns the class name of the method metaclass, see L +for more information on the method metaclasses. + =item B This will take a C<$method_name> and CODE reference to that @@ -1104,7 +1303,7 @@ C<$method_name>, or return undef if that method does not exist. The Class::MOP::Method is codifiable, so you can use it like a normal CODE reference, see L for more information. -=item B +=item B This will return a CODE reference of the specified C<$method_name>, or return undef if that method does not exist. @@ -1263,9 +1462,14 @@ their own. See L for more details. =item B +Returns the class name of the attribute metaclass, see L +for more information on the attribute metaclasses. + =item B -=item B +This returns a HASH ref of name to attribute meta-object mapping. + +=item B This stores the C<$attribute_meta_object> (or creates one from the C<$attribute_name> and C<%attribute_spec>) in the B @@ -1349,6 +1553,10 @@ the L documentation. This method will reverse tranforamtion upon the class which made it immutable. +=item B + +Create a transformer suitable for making this class immutable + =back =head1 AUTHORS @@ -1357,7 +1565,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006, 2007 by Infinity Interactive, Inc. +Copyright 2006-2008 by Infinity Interactive, Inc. L