X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=c413292f09ba36c2969ce55294d8d8eaa6b98c10;hb=d519662a06488c8d15eecbb2858f9bad58986731;hp=946171be3ab661e1962f1bd1621961ae784407c1;hpb=04dd7510b9fc63582c7da4e249235f108f889975;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index 946171b..c413292 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -9,36 +9,33 @@ use Class::MOP::Instance; use Class::MOP::Method::Wrapped; use Carp 'confess'; -use Scalar::Util 'blessed', 'reftype', 'weaken', 'refaddr'; -use Sub::Name 'subname'; -use B 'svref_2object'; +use Scalar::Util 'blessed', 'weaken'; -our $VERSION = '0.22'; +our $VERSION = '0.64_01'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Module'; -# Self-introspection - -sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) } - # Creation sub initialize { - 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->construct_class_instance('package' => $package_name, @_); -} + my $class = shift; -sub reinitialize { - my $class = shift; - my $package_name = shift; - (defined $package_name && $package_name && !blessed($package_name)) + my $package_name; + + if ( @_ % 2 ) { + $package_name = shift; + } else { + my %options = @_; + $package_name = $options{package}; + } + + (defined $package_name && $package_name && !ref($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, @_); + + return Class::MOP::get_metaclass_by_name($package_name) + || $class->construct_class_instance(package => $package_name, @_); } # NOTE: (meta-circularity) @@ -49,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: @@ -58,59 +55,37 @@ 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 # 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 =~ /^Class::MOP::Class$/) { + 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', - } => $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_compatability(); Class::MOP::store_metaclass_by_name($package_name, $meta); @@ -122,14 +97,57 @@ 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; + # 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; # 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->class_precedence_list; + my @class_list = $self->linearized_isa; shift @class_list; # shift off $self->name foreach my $class_name (@class_list) { @@ -141,10 +159,10 @@ 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: @@ -176,7 +194,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 { @@ -193,6 +211,9 @@ sub check_metaclass_compatability { # really need to be handled explicitly sub DESTROY { my $self = shift; + + 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/; my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/); @@ -208,17 +229,27 @@ sub check_metaclass_compatability { # creating classes with MOP ... sub create { - my $class = shift; - my $package_name = shift; + my ( $class, @args ) = @_; - (defined $package_name && $package_name) - || confess "You must pass a package name"; + unshift @args, 'package' if @args % 2 == 1; - (scalar @_ % 2 == 0) - || confess "You much pass all parameters as name => value pairs " . - "(I found an uneven number of params in \@_)"; + my (%options) = @args; + my $package_name = $options{package}; - my (%options) = @_; + (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}; + + (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} . "';" @@ -231,8 +262,9 @@ sub create { my $meta = $class->initialize($package_name); + # FIXME totally lame $meta->add_method('meta' => sub { - $class->initialize(blessed($_[0]) || $_[0]); + $class->initialize(ref($_[0]) || $_[0]); }); $meta->superclasses(@{$options{superclasses}}) @@ -261,32 +293,58 @@ sub create { # all these attribute readers will be bootstrapped # away in the Class::MOP bootstrap section -sub get_attribute_map { $_[0]->{'%!attributes'} } -sub attribute_metaclass { $_[0]->{'$!attribute_metaclass'} } -sub method_metaclass { $_[0]->{'$!method_metaclass'} } -sub instance_metaclass { $_[0]->{'$!instance_metaclass'} } +sub get_attribute_map { $_[0]->{'attributes'} } +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 $map = $self->{'%!methods'}; + + my $current = Class::MOP::check_package_cache_flag($self->name); + + if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) { + return $self->{'methods'} ||= {}; + } + + $self->{_package_cache_flag} = $current; + + my $map = $self->{'methods'} ||= {}; my $class_name = $self->name; my $method_metaclass = $self->method_metaclass; - foreach my $symbol ($self->list_all_package_symbols('CODE')) { - my $code = $self->get_package_symbol('&' . $symbol); + my %all_code = $self->get_all_package_symbols('CODE'); + + foreach my $symbol (keys %all_code) { + my $code = $all_code{$symbol}; next if exists $map->{$symbol} && 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); + + # NOTE: + # in 5.10 constant.pm the constants show up + # as being in the right package, but in pre-5.10 + # they show up as constant::__ANON__ so we + # make an exception here to be sure that things + # work as expected in both. + # - SL + unless ($pkg eq 'constant' && $name eq '__ANON__') { + next if ($pkg || '') ne $class_name || + (($name || '') ne '__ANON__' && ($pkg || '') ne $class_name); + } - $map->{$symbol} = $method_metaclass->wrap($code); + $map->{$symbol} = $method_metaclass->wrap( + $code, + associated_metaclass => $self, + package_name => $class_name, + name => $symbol, + ); } return $map; @@ -296,6 +354,7 @@ sub get_method_map { sub new_object { my $class = shift; + # NOTE: # we need to protect the integrity of the # Class::MOP::Class singletons here, so we @@ -307,16 +366,17 @@ 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 if ($class->is_anon_class) { - (reftype($instance) eq 'HASH') + (Scalar::Util::reftype($instance) eq 'HASH') || confess "Currently only HASH based instances are supported with instance of anon-classes"; # NOTE: # At some point we should make this official @@ -328,19 +388,32 @@ sub construct_instance { return $instance; } + sub get_meta_instance { - my $class = shift; - return $class->instance_metaclass->new( - $class, - $class->compute_all_applicable_attributes() + my $self = shift; + $self->{'_meta_instance'} ||= $self->create_meta_instance(); +} + +sub create_meta_instance { + my $self = shift; + + my $instance = $self->instance_metaclass->new( + associated_metaclass => $self, + attributes => [ $self->compute_all_applicable_attributes() ], ); + + $self->add_meta_instance_dependencies() + if $instance->is_dependent_on_superclasses(); + + return $instance; } sub clone_object { my $class = shift; my $instance = shift; (blessed($instance) && $instance->isa($class->name)) - || confess "You must pass an instance ($instance) of the metaclass (" . $class->name . ")"; + || 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 # Class::MOP::Class singletons here, they @@ -352,54 +425,183 @@ sub clone_object { sub clone_instance { my ($class, $instance, %params) = @_; (blessed($instance)) - || confess "You can only clone instances, \$self is not a blessed instance"; + || confess "You can only clone instances, ($instance) is not a blessed 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(ref($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 { - my $self = shift; + my $self = shift; + my $var_spec = { sigil => '@', type => 'ARRAY', name => 'ISA' }; if (@_) { my @supers = @_; - @{$self->get_package_symbol('@ISA')} = @supers; + @{$self->get_package_symbol($var_spec)} = @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 $self->check_metaclass_compatability(); + $self->update_meta_instance_dependencies(); + } + @{$self->get_package_symbol($var_spec)}; +} + +sub subclasses { + my $self = shift; + + my $super_class = $self->name; + + if ( Class::MOP::HAVE_ISAREV() ) { + return @{ $super_class->mro::get_isarev() }; + } else { + 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; } - @{$self->get_package_symbol('@ISA')}; +} + + +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 +sub wrap_method_body { + my ( $self, %args ) = @_; + + my $body = delete $args{body}; # delete is for compat + + ('CODE' eq ref($body)) + || confess "Your code block must be a CODE reference"; + + $self->method_metaclass->wrap( $body => ( + package_name => $self->name, + %args, + )); +} + sub add_method { my ($self, $method_name, $method) = @_; (defined $method_name && $method_name) @@ -408,17 +610,33 @@ 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; + $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->wrap_method_body( body => $body, name => $method_name ); } + + $method->attach_to_class($self); + $self->get_method_map->{$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) + ); - my $full_method_name = ($self->name . '::' . $method_name); - $self->add_package_symbol("&${method_name}" => 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 } { @@ -452,7 +670,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 +680,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 +690,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: @@ -491,10 +715,14 @@ sub alias_method { || confess "You must define a method name"; my $body = (blessed($method) ? $method->body : $method); - ('CODE' eq (reftype($body) || '')) + ('CODE' eq ref($body)) || confess "Your code block must be a CODE reference"; - $self->add_package_symbol("&${method_name}" => $body); + $self->add_package_symbol( + { sigil => '&', type => 'CODE', name => $method_name } => $body + ); + + $self->update_package_cache_flag; # the method map will not list aliased methods } sub has_method { @@ -502,8 +730,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->get_method_map->{$method_name}; } sub get_method { @@ -525,12 +752,15 @@ sub remove_method { (defined $method_name && $method_name) || confess "You must define a method name"; - my $removed_method = $self->get_method($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; - do { - $self->remove_package_symbol("&${method_name}"); - delete $self->get_method_map->{$method_name}; - } if defined $removed_method; + $self->update_package_cache_flag; # still valid, since we just removed the method from the map return $removed_method; } @@ -544,15 +774,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) @@ -561,30 +783,21 @@ sub find_method_by_name { return; } -sub compute_all_applicable_methods { +sub get_all_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}++; - # 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 { @@ -592,14 +805,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 +821,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) @@ -653,19 +852,91 @@ sub add_attribute { # name here so that we can properly detach # the old attr object, and remove any # accessors it would have generated - $self->remove_attribute($attribute->name) - if $self->has_attribute($attribute->name); + if ( $self->has_attribute($attribute->name) ) { + $self->remove_attribute($attribute->name); + } else { + $self->invalidate_meta_instances(); + } # then onto installing the new accessors - $attribute->install_accessors(); $self->get_attribute_map->{$attribute->name} = $attribute; + + # invalidate package flag here + my $e = do { local $@; eval { $attribute->install_accessors() }; $@ }; + if ( $e ) { + $self->remove_attribute($attribute->name); + die $e; + } + + return $attribute; +} + +sub update_meta_instance_dependencies { + my $self = shift; + + if ( $self->{meta_instance_dependencies} ) { + return $self->add_meta_instance_dependencies; + } +} + +sub add_meta_instance_dependencies { + my $self = shift; + + $self->remove_meta_instance_depdendencies; + + my @attrs = $self->compute_all_applicable_attributes(); + + my %seen; + my @classes = grep { not $seen{$_->name}++ } map { $_->associated_class } @attrs; + + foreach my $class ( @classes ) { + $class->add_dependent_meta_instance($self); + } + + $self->{meta_instance_dependencies} = \@classes; +} + +sub remove_meta_instance_depdendencies { + my $self = shift; + + if ( my $classes = delete $self->{meta_instance_dependencies} ) { + foreach my $class ( @$classes ) { + $class->remove_dependent_meta_instance($self); + } + + return $classes; + } + + return; + +} + +sub add_dependent_meta_instance { + my ( $self, $metaclass ) = @_; + push @{ $self->{dependent_meta_instances} }, $metaclass; +} + +sub remove_dependent_meta_instance { + my ( $self, $metaclass ) = @_; + my $name = $metaclass->name; + @$_ = grep { $_->name ne $name } @$_ for $self->{dependent_meta_instances}; +} + +sub invalidate_meta_instances { + my $self = shift; + $_->invalidate_meta_instance() for $self, @{ $self->{dependent_meta_instances} }; +} + +sub invalidate_meta_instance { + my $self = shift; + undef $self->{_meta_instance}; } 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 { @@ -686,6 +957,7 @@ sub remove_attribute { my $removed_attribute = $self->get_attribute_map->{$attribute_name}; return unless defined $removed_attribute; delete $self->get_attribute_map->{$attribute_name}; + $self->invalidate_meta_instances(); $removed_attribute->remove_accessors(); $removed_attribute->detach_from_class(); return $removed_attribute; @@ -696,38 +968,19 @@ 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; - # 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}++; - # 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 { 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) @@ -736,79 +989,137 @@ 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 } sub is_immutable { 0 } -#Why I changed this (groditi) -# - One Metaclass may have many Classes through many Metaclass instances -# - One Metaclass should only have one Immutable Metaclass instance -# - Each Class may have different Immutabilizing options -# - Therefore each Metaclass instance may have different Immutabilizing options -# - We need to store one Immutable Metaclass instance per Metaclass -# - We need to store one set of Immutable Metaclass options per Class -# - Upon make_mutable we may delete the Immutabilizing options -# - We could clean the immutable Metaclass instance when there is no more -# immutable Classes with this Metaclass, 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 Metaclass instances. You may view this as a memory leak, however -# Because we have few Metaclasses, in practice it seems acceptable -# - To allow Immutable Metaclass instances to be cleaned up we could weaken -# the reference stored in $IMMUTABLE_METACLASSES{$class} and ||= should DWIM +# 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_METACLASSES; + + my %IMMUTABLE_TRANSFORMERS; my %IMMUTABLE_OPTIONS; + + sub get_immutable_options { + my $self = shift; + return if $self->is_mutable; + confess "unable to find immutabilizing options" + unless exists $IMMUTABLE_OPTIONS{$self->name}; + my %options = %{$IMMUTABLE_OPTIONS{$self->name}}; + delete $options{IMMUTABLE_TRANSFORMER}; + return \%options; + } + + sub get_immutable_transformer { + my $self = shift; + if( $self->is_mutable ){ + my $class = ref $self || $self; + return $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer; + } + confess "unable to find transformer for immutable class" + unless exists $IMMUTABLE_OPTIONS{$self->name}; + return $IMMUTABLE_OPTIONS{$self->name}->{IMMUTABLE_TRANSFORMER}; + } + sub make_immutable { my $self = shift; my %options = @_; - my $class = blessed $self || $self;; - - $IMMUTABLE_METACLASSES{$class} ||= 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', - } - }); - $IMMUTABLE_METACLASSES{$class}->make_metaclass_immutable($self, %options); - $IMMUTABLE_OPTIONS{refaddr $self} = - { %options, IMMUTABLE_METACLASS => $IMMUTABLE_METACLASSES{$class} }; + my $transformer = $self->get_immutable_transformer; + $transformer->make_metaclass_immutable($self, \%options); + $IMMUTABLE_OPTIONS{$self->name} = + { %options, IMMUTABLE_TRANSFORMER => $transformer }; if( exists $options{debug} && $options{debug} ){ - print STDERR "# of Metaclass options: ", keys %IMMUTABLE_OPTIONS; - print STDERR "# of Immutable metaclasses: ", keys %IMMUTABLE_METACLASSES; + 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; - my $options = delete $IMMUTABLE_OPTIONS{refaddr $self}; - my $immutable_metaclass = delete $options->{IMMUTABLE_METACLASS}; - $immutable_metaclass->make_metaclass_mutable($self, %$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', # 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', + }, + # 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; @@ -927,12 +1238,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 @@ -949,6 +1254,52 @@ 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. + +=item B + +Registers this class as dependent on its superclasses. + +Only superclasses from which this class inherits attributes will be added. + +=item B + +Unregisters this class from its superclasses. + +=item B + +Reregisters if necessary. + +=item B $metaclass + +Registers the class as having a meta instance dependent on this class. + +=item B $metaclass + +Remove the class from the list of dependent classes. + +=item B + +Clears the cached meta instance for this metaclass and all of the registered +classes with dependent meta instances. + +Called by C and C to recalculate the attribute +slots. + +=item B + +Used by C. + =back =head2 Object instance construction and cloning @@ -960,8 +1311,18 @@ 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 + +Called by C if necessary. + =item B This is a convience method for creating a new object of the class, and @@ -973,12 +1334,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. @@ -1002,9 +1360,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 @@ -1023,6 +1378,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 @@ -1043,6 +1405,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 @@ -1055,18 +1422,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 @@ -1076,9 +1445,18 @@ 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 -=item B +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. @@ -1131,7 +1509,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. @@ -1151,13 +1529,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 @@ -1290,9 +1675,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 @@ -1347,11 +1737,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 @@ -1376,6 +1767,19 @@ the L documentation. This method will reverse tranforamtion upon the class which made it immutable. +=item B + +Return a transformer suitable for making this class immutable or, if this +class is immutable, the transformer used to make it immutable. + +=item B + +If the class is immutable, return the options used to make it immutable. + +=item B + +Create a transformer suitable for making this class immutable + =back =head1 AUTHORS @@ -1384,7 +1788,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