X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=52cd74ce15b2bfe17a2f4c110f227ea8efbd9f83;hb=78f6e9c6a73ff3dd985a1cebaafd0b81e543beb8;hp=2cbf3ccb0cf270a2735e55ee1ecddd09b7417283;hpb=cacc09fa989cfbe02bf2b9a16e5bcf953293379a;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index 2cbf3cc..52cd74c 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -4,14 +4,17 @@ package Class::MOP::Class; use strict; use warnings; -use Class::MOP::Immutable; use Class::MOP::Instance; use Class::MOP::Method::Wrapped; +use Class::MOP::Method::Accessor; +use Class::MOP::Method::Constructor; use Carp 'confess'; use Scalar::Util 'blessed', 'weaken'; +use Sub::Name 'subname'; +use Devel::GlobalDestruction 'in_global_destruction'; -our $VERSION = '0.80'; +our $VERSION = '0.88'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -39,9 +42,9 @@ sub initialize { } sub construct_class_instance { - warn 'The construct_class_instance method has been made private.' - . " The public version is deprecated and will be removed in a future release.\n"; - shift->_construct_class_instance; + Carp::cluck('The construct_class_instance method has been made private.' + . " The public version is deprecated and will be removed in a future release.\n"); + shift->_construct_class_instance(@_); } # NOTE: (meta-circularity) @@ -127,16 +130,27 @@ sub _new { # 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', - 'wrapped_method_metaclass' => $options->{'wrapped_method_metaclass'} - || 'Class::MOP::Method::Wrapped', - 'instance_metaclass' => $options->{'instance_metaclass'} - || 'Class::MOP::Instance', + 'methods' => {}, + 'attributes' => {}, + 'attribute_metaclass' => + ( $options->{'attribute_metaclass'} || 'Class::MOP::Attribute' ), + 'method_metaclass' => + ( $options->{'method_metaclass'} || 'Class::MOP::Method' ), + 'wrapped_method_metaclass' => ( + $options->{'wrapped_method_metaclass'} + || 'Class::MOP::Method::Wrapped' + ), + 'instance_metaclass' => + ( $options->{'instance_metaclass'} || 'Class::MOP::Instance' ), + 'immutable_trait' => ( + $options->{'immutable_trait'} + || 'Class::MOP::Class::Immutable::Trait' + ), + 'constructor_name' => ( $options->{constructor_name} || 'new' ), + 'constructor_class' => ( + $options->{constructor_class} || 'Class::MOP::Method::Constructor' + ), + 'destructor_class' => $options->{destructor_class}, }, $class; } @@ -154,9 +168,9 @@ sub update_package_cache_flag { sub check_metaclass_compatibility { - warn 'The check_metaclass_compatibility method has been made private.' - . " The public version is deprecated and will be removed in a future release.\n"; - shift->_check_metaclass_compatibility; + Carp::cluck('The check_metaclass_compatibility method has been made private.' + . " The public version is deprecated and will be removed in a future release.\n"); + shift->_check_metaclass_compatibility(@_); } sub _check_metaclass_compatibility { @@ -166,6 +180,8 @@ sub _check_metaclass_compatibility { return if ref($self) eq 'Class::MOP::Class' && $self->instance_metaclass eq 'Class::MOP::Instance'; + return if $self->can('get_mutable_metaclass_name'); + my @class_list = $self->linearized_isa; shift @class_list; # shift off $self->name @@ -182,17 +198,17 @@ sub _check_metaclass_compatibility { : ref($super_meta); ($self->isa($super_meta_type)) - || confess "Class::MOP::class_of(" . $self->name . ") => (" + || confess "The metaclass of " . $self->name . " (" . (ref($self)) . ")" . " is not compatible with the " . - "Class::MOP::class_of(".$superclass_name . ") => (" + "metaclass of its superclass, ".$superclass_name . " (" . ($super_meta_type) . ")"; # NOTE: # we also need to check that instance metaclasses # are compatibile in the same the class. ($self->instance_metaclass->isa($super_meta->instance_metaclass)) - || confess "Class::MOP::class_of(" . $self->name . ")->instance_metaclass => (" . ($self->instance_metaclass) . ")" . + || confess "The instance metaclass for " . $self->name . " (" . ($self->instance_metaclass) . ")" . " is not compatible with the " . - "Class::MOP::class_of(" . $superclass_name . ")->instance_metaclass => (" . ($super_meta->instance_metaclass) . ")"; + "instance metaclass of its superclass, " . $superclass_name . " (" . ($super_meta->instance_metaclass) . ")"; } } @@ -233,7 +249,7 @@ sub _check_metaclass_compatibility { sub DESTROY { my $self = shift; - return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated + return if 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/; @@ -326,6 +342,10 @@ sub attribute_metaclass { $_[0]->{'attribute_metaclass'} } sub method_metaclass { $_[0]->{'method_metaclass'} } sub wrapped_method_metaclass { $_[0]->{'wrapped_method_metaclass'} } sub instance_metaclass { $_[0]->{'instance_metaclass'} } +sub immutable_trait { $_[0]->{'immutable_trait'} } +sub constructor_class { $_[0]->{'constructor_class'} } +sub constructor_name { $_[0]->{'constructor_name'} } +sub destructor_class { $_[0]->{'destructor_class'} } # Instance Construction & Cloning @@ -343,16 +363,20 @@ sub new_object { } sub construct_instance { - warn 'The construct_instance method has been made private.' - . " The public version is deprecated and will be removed in a future release.\n"; - shift->_construct_instance; + Carp::cluck('The construct_instance method has been made private.' + . " The public version is deprecated and will be removed in a future release.\n"); + shift->_construct_instance(@_); } sub _construct_instance { my $class = shift; my $params = @_ == 1 ? $_[0] : {@_}; my $meta_instance = $class->get_meta_instance(); - my $instance = $meta_instance->create_instance(); + # FIXME: + # the code below is almost certainly incorrect + # but this is foreign inheritance, so we might + # have to kludge it in the end. + my $instance = $params->{__INSTANCE__} || $meta_instance->create_instance(); foreach my $attr ($class->get_all_attributes()) { $attr->initialize_instance_slot($meta_instance, $instance, $params); } @@ -378,9 +402,9 @@ sub get_meta_instance { } sub create_meta_instance { - warn 'The create_meta_instance method has been made private.' - . " The public version is deprecated and will be removed in a future release.\n"; - shift->_create_meta_instance; + Carp::cluck('The create_meta_instance method has been made private.' + . " The public version is deprecated and will be removed in a future release.\n"); + shift->_create_meta_instance(@_); } sub _create_meta_instance { @@ -412,9 +436,9 @@ sub clone_object { } sub clone_instance { - warn 'The clone_instance method has been made private.' - . " The public version is deprecated and will be removed in a future release.\n"; - shift->_clone_instance; + Carp::cluck('The clone_instance method has been made private.' + . " The public version is deprecated and will be removed in a future release.\n"); + shift->_clone_instance(@_); } sub _clone_instance { @@ -498,11 +522,16 @@ sub superclasses { # we don't know about $self->_check_metaclass_compatibility(); - $self->update_meta_instance_dependencies(); + $self->_superclasses_updated(); } @{$self->get_package_symbol($var_spec)}; } +sub _superclasses_updated { + my $self = shift; + $self->update_meta_instance_dependencies(); +} + sub subclasses { my $self = shift; my $super_class = $self->name; @@ -510,6 +539,16 @@ sub subclasses { return @{ $super_class->mro::get_isarev() }; } +sub direct_subclasses { + my $self = shift; + my $super_class = $self->name; + + return grep { + grep { + $_ eq $super_class + } Class::MOP::Class->initialize($_)->superclasses + } $self->subclasses; +} sub linearized_isa { return @{ mro::get_linear_isa( (shift)->name ) }; @@ -585,15 +624,18 @@ sub add_method { $method->attach_to_class($self); - # 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->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 }, - Class::MOP::subname($full_method_name => $body) + { sigil => '&', type => 'CODE', name => $method_name }, + $body, ); } @@ -630,7 +672,7 @@ sub add_method { || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); $method->add_before_modifier( - Class::MOP::subname(':before' => $method_modifier) + subname(':before' => $method_modifier) ); } @@ -640,7 +682,7 @@ sub add_method { || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); $method->add_after_modifier( - Class::MOP::subname(':after' => $method_modifier) + subname(':after' => $method_modifier) ); } @@ -650,7 +692,7 @@ sub add_method { || confess "You must pass in a method name"; my $method = $fetch_and_prepare_method->($self, $method_name); $method->add_around_modifier( - Class::MOP::subname(':around' => $method_modifier) + subname(':around' => $method_modifier) ); } @@ -669,9 +711,9 @@ sub add_method { } sub alias_method { - warn "The alias_method method is deprecated. Use add_method instead.\n"; + Carp::cluck("The alias_method method is deprecated. Use add_method instead.\n"); - shift->add_method; + shift->add_method(@_); } sub has_method { @@ -679,7 +721,7 @@ sub has_method { (defined $method_name && $method_name) || confess "You must define a method name"; - exists $self->{methods}{$method_name} || exists $self->get_method_map->{$method_name}; + exists $self->get_method_map->{$method_name}; } sub get_method { @@ -687,7 +729,7 @@ sub get_method { (defined $method_name && $method_name) || confess "You must define a method name"; - return $self->{methods}{$method_name} || $self->get_method_map->{$method_name}; + return $self->get_method_map->{$method_name}; } sub remove_method { @@ -733,8 +775,8 @@ sub get_all_methods { } sub compute_all_applicable_methods { - warn 'The compute_all_applicable_methods method is deprecated.' - . " Use get_all_methods instead.\n"; + Carp::cluck('The compute_all_applicable_methods method is deprecated.' + . " Use get_all_methods instead.\n"); return map { { @@ -808,12 +850,22 @@ sub add_attribute { } else { $self->invalidate_meta_instances(); } + + # get our count of previously inserted attributes and + # increment by one so this attribute knows its order + my $order = (scalar keys %{$self->get_attribute_map}) - 1; + $attribute->_set_insertion_order($order + 1); # then onto installing the new accessors $self->get_attribute_map->{$attribute->name} = $attribute; # invalidate package flag here - my $e = do { local $@; eval { $attribute->install_accessors() }; $@ }; + my $e = do { + local $@; + local $SIG{__DIE__}; + eval { $attribute->install_accessors() }; + $@; + }; if ( $e ) { $self->remove_attribute($attribute->name); die $e; @@ -926,10 +978,10 @@ sub get_all_attributes { } sub compute_all_applicable_attributes { - warn 'The construct_class_instance method has been deprecated.' - . " Use get_all_attributes instead.\n"; + Carp::cluck('The compute_all_applicable_attributes method has been deprecated.' + . " Use get_all_attributes instead.\n"); - shift->get_all_attributes; + shift->get_all_attributes(@_); } sub find_attribute_by_name { @@ -967,87 +1019,217 @@ sub is_pristine { sub is_mutable { 1 } sub is_immutable { 0 } -sub immutable_transformer { $_[0]->{immutable_transformer} } -sub _set_immutable_transformer { $_[0]->{immutable_transformer} = $_[1] } +sub _immutable_options { + my ( $self, @args ) = @_; + + return ( + inline_accessors => 1, + inline_constructor => 1, + inline_destructor => 0, + debug => 0, + immutable_trait => $self->immutable_trait, + constructor_name => $self->constructor_name, + constructor_class => $self->constructor_class, + destructor_class => $self->destructor_class, + @args, + ); +} sub make_immutable { + my ( $self, @args ) = @_; + + if ( $self->is_mutable ) { + $self->_initialize_immutable( $self->_immutable_options(@args) ); + $self->_rebless_as_immutable(@args); + return $self; + } + else { + return; + } +} + +sub make_mutable { my $self = shift; - return if $self->is_immutable; + if ( $self->is_immutable ) { + my @args = $self->immutable_options; + $self->_rebless_as_mutable(); + $self->_remove_inlined_code(@args); + delete $self->{__immutable}; + return $self; + } + else { + return; + } +} - my $transformer = $self->immutable_transformer - || $self->_make_immutable_transformer(@_); +sub _rebless_as_immutable { + my ( $self, @args ) = @_; - $self->_set_immutable_transformer($transformer); + $self->{__immutable}{original_class} = ref $self; - $transformer->make_metaclass_immutable; + bless $self => $self->_immutable_metaclass(@args); } -{ - my %Default_Immutable_Options = ( - 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', - # FIXME perl 5.10 memoizes this on its own, no need? - linearized_isa => 'ARRAY', - get_all_methods => 'ARRAY', - get_all_method_names => 'ARRAY', - get_all_attributes => 'ARRAY', - get_meta_instance => 'SCALAR', - get_method_map => 'SCALAR', - }, +sub _immutable_metaclass { + my ( $self, %args ) = @_; - # 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'; - - # 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; - }, - }, + if ( my $class = $args{immutable_metaclass} ) { + return $class; + } + + my $trait = $args{immutable_trait} = $self->immutable_trait + || confess "no immutable trait specified for $self"; + + my $meta_attr = $self->meta->find_attribute_by_name("immutable_trait"); + + my $class_name; + + if ( $meta_attr and $trait eq $meta_attr->default ) { + # if the trait is the same as the default we try and pick a + # predictable name for the immutable metaclass + $class_name = 'Class::MOP::Class::Immutable::' . ref($self); + } + else { + $class_name = join '::', 'Class::MOP::Class::Immutable::CustomTrait', + $trait, 'ForMetaClass', ref($self); + } + + return $class_name + if Class::MOP::is_class_loaded($class_name); + + my $meta = Class::MOP::Class->create( + $class_name, + superclasses => [ ref $self ], ); - sub _default_immutable_transformer_options { - return %Default_Immutable_Options; + Class::MOP::load_class($trait); + for my $meth ( Class::MOP::Class->initialize($trait)->get_all_methods ) { + next if $meta->has_method( $meth->name ); + + if ( $meta->find_method_by_name( $meth->name ) ) { + $meta->add_around_method_modifier( $meth->name, $meth->body ); + } + else { + $meta->add_method( $meth->name, $meth->clone ); + } } + + return $class_name; } -sub _make_immutable_transformer { +sub _remove_inlined_code { my $self = shift; - Class::MOP::Immutable->new( - $self, - $self->_default_immutable_transformer_options, - @_ - ); + $self->remove_method( $_->name ) for $self->_inlined_methods; + + delete $self->{__immutable}{inlined_methods}; } -sub make_mutable { +sub _inlined_methods { @{ $_[0]{__immutable}{inlined_methods} || [] } } + +sub _add_inlined_method { + my ( $self, $method ) = @_; + + push @{ $self->{__immutable}{inlined_methods} ||= [] }, $method; +} + +sub _initialize_immutable { + my ( $self, %args ) = @_; + + $self->{__immutable}{options} = \%args; + $self->_install_inlined_code(%args); +} + +sub _install_inlined_code { + my ( $self, %args ) = @_; + + # FIXME + $self->_inline_accessors(%args) if $args{inline_accessors}; + $self->_inline_constructor(%args) if $args{inline_constructor}; + $self->_inline_destructor(%args) if $args{inline_destructor}; +} + +sub _rebless_as_mutable { + my $self = shift; + + bless $self, $self->get_mutable_metaclass_name; + + return $self; +} + +sub _inline_accessors { my $self = shift; - return if $self->is_mutable; + foreach my $attr_name ( $self->get_attribute_list ) { + $self->get_attribute($attr_name)->install_accessors(1); + } +} + +sub _inline_constructor { + my ( $self, %args ) = @_; + + my $name = $args{constructor_name}; + + if ( $self->has_method($name) && !$args{replace_constructor} ) { + my $class = $self->name; + warn "Not inlining a constructor for $class since it defines" + . " its own constructor.\n" + . "If you are certain you don't need to inline your" + . " constructor, specify inline_constructor => 0 in your" + . " call to $class->meta->make_immutable\n"; + return; + } + + my $constructor_class = $args{constructor_class}; + + Class::MOP::load_class($constructor_class); - $self->immutable_transformer->make_metaclass_mutable; + my $constructor = $constructor_class->new( + options => \%args, + metaclass => $self, + is_inline => 1, + package_name => $self->name, + name => $name, + ); + + if ( $args{replace_constructor} or $constructor->can_be_inlined ) { + $self->add_method( $name => $constructor ); + $self->_add_inlined_method($constructor); + } +} + +sub _inline_destructor { + my ( $self, %args ) = @_; + + ( exists $args{destructor_class} && defined $args{destructor_class} ) + || confess "The 'inline_destructor' option is present, but " + . "no destructor class was specified"; + + if ( $self->has_method('DESTROY') && ! $args{replace_destructor} ) { + my $class = $self->name; + warn "Not inlining a destructor for $class since it defines" + . " its own destructor.\n"; + return; + } + + my $destructor_class = $args{destructor_class}; + + Class::MOP::load_class($destructor_class); + + return unless $destructor_class->is_needed($self); + + my $destructor = $destructor_class->new( + options => \%args, + metaclass => $self, + package_name => $self->name, + name => 'DESTROY' + ); + + if ( $args{replace_destructor} or $destructor->can_be_inlined ) { + $self->add_method( 'DESTROY' => $destructor ); + $self->_add_inlined_method($destructor); + } } 1; @@ -1070,12 +1252,12 @@ Class::MOP::Class - Class Meta Object # add a method to Foo ... Foo->meta->add_method( 'bar' => sub {...} ) - # get a list of all the classes searched - # the method dispatcher in the correct order - Foo->meta->class_precedence_list() + # get a list of all the classes searched + # the method dispatcher in the correct order + Foo->meta->class_precedence_list() - # remove a method from Foo - Foo->meta->remove_method('bar'); + # remove a method from Foo + Foo->meta->remove_method('bar'); # or use this to actually create classes ... @@ -1084,8 +1266,8 @@ Class::MOP::Class - Class Meta Object version => '0.01', superclasses => ['Foo'], attributes => [ - Class::MOP:: : Attribute->new('$bar'), - Class::MOP:: : Attribute->new('$baz'), + Class::MOP::Attribute->new('$bar'), + Class::MOP::Attribute->new('$baz'), ], methods => { calculate_bar => sub {...}, @@ -1238,7 +1420,11 @@ does nothing; it is merely a hook. This method is used to create a new object of the metaclass's class. Any parameters you provide are used to initialize the -instance's attributes. +instance's attributes. A special C<__INSTANCE__> key can be passed to +provide an already generated instance, rather than having Class::MOP +generate it for you. This is mostly useful for using Class::MOP with +foreign classes, which generally generate instances using their own +constructor. =item B<< $metaclass->instance_metaclass >> @@ -1303,7 +1489,13 @@ duplicates removed. =item B<< $metaclass->subclasses >> -This returns a list of subclasses for this class. +This returns a list of all subclasses for this class, even indirect +subclasses. + +=item B<< $metaclass->direct_subclasses >> + +This returns a list of immediate subclasses for this class, which does not +include indirect subclasses. =back @@ -1435,7 +1627,10 @@ attributes which are defined in terms of "regular" Perl 5 methods. This will return a L for the specified C<$attribute_name>. If the class does not have the specified -attribute, it returns C +attribute, it returns C. + +NOTE that get_attribute does not search superclasses, for that you +need to use C. =item B<< $metaclass->has_attribute($attribute_name) >> @@ -1510,6 +1705,12 @@ Making a class immutable lets us optimize the class by inlining some methods, and also allows us to optimize some methods on the metaclass object itself. +After immutabilization, the metaclass object will cache most +informational methods such as C and +C. Methods which would alter the class, such as +C, C, and so on will throw an error on an +immutable metaclass object. + The immutabilization system in L takes much greater advantage of the inlining features than Class::MOP itself does. @@ -1520,20 +1721,62 @@ of the inlining features than Class::MOP itself does. This method will create an immutable transformer and uses it to make the class and its metaclass object immutable. -Details of how immutabilization works are in L -documentation. +This method accepts the following options: -=item B<< $metaclass->make_mutable >> +=over 8 -Calling this method reverse the immutabilization transformation. +=item * inline_accessors + +=item * inline_constructor + +=item * inline_destructor + +These are all booleans indicating whether the specified method(s) +should be inlined. + +By default, accessors and the constructor are inlined, but not the +destructor. + +=item * immutable_trait -=item B<< $metaclass->immutable_transformer >> +The name of a class which will be used as a parent class for the +metaclass object being made immutable. This "trait" implements the +post-immutability functionality of the metaclass (but not the +transformation itself). -If the class has been made immutable previously, this returns the -L object that was created to do the -transformation. +This defaults to L. -If the class was never made immutable, this method will die. +=item * constructor_name + +This is the constructor method name. This defaults to "new". + +=item * constructor_class + +The name of the method metaclass for constructors. It will be used to +generate the inlined constructor. This defaults to +"Class::MOP::Method::Constructor". + +=item * replace_constructor + +This is a boolean indicating whether an existing constructor should be +replaced when inlining a constructor. This defaults to false. + +=item * destructor_class + +The name of the method metaclass for destructors. It will be used to +generate the inlined destructor. This defaults to +"Class::MOP::Method::Denstructor". + +=item * replace_destructor + +This is a boolean indicating whether an existing destructor should be +replaced when inlining a destructor. This defaults to false. + +=back + +=item B<< $metaclass->make_mutable >> + +Calling this method reverse the immutabilization transformation. =back