X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=0a16c255895efd57e6a3bfa1d714917d9f6b51ea;hb=81c8a65bf02bb1b0e240d8f5b626b0ceabf9a37c;hp=b2cb51d9e665aca776a84672703039d0c4e5ceeb;hpb=9d6dce77cd867d92c418eb4fcfd199eaca6efc10;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index b2cb51d..0a16c25 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -4,157 +4,157 @@ package Class::MOP::Class; use strict; use warnings; +use Class::MOP::Instance; +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.17'; +our $VERSION = '0.21'; +our $AUTHORITY = 'cpan:STEVAN'; use base 'Class::MOP::Module'; -use Class::MOP::Instance; - # Self-introspection sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) } -# Class globals ... - -# NOTE: -# we need a sufficiently annoying prefix -# this should suffice for now, this is -# used in a couple of places below, so -# need to put it up here for now. -my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::'; - # Creation - -{ - # Metaclasses are singletons, so we cache them here. - # there is no need to worry about destruction though - # because they should die only when the program dies. - # After all, do package definitions even get reaped? - my %METAS; - # means of accessing all the metaclasses that have - # been initialized thus far (for mugwumps obj browser) - sub get_all_metaclasses { %METAS } - sub get_all_metaclass_instances { values %METAS } - sub get_all_metaclass_names { keys %METAS } +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, @_); +} + +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, @_); +} - 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, @_); +# NOTE: (meta-circularity) +# this is a special form of &construct_instance +# (see below), which is used to construct class +# meta-object instances for any Class::MOP::* +# class. All other classes will use the more +# normal &construct_instance. +sub construct_class_instance { + my $class = shift; + my %options = @_; + my $package_name = $options{'package'}; + (defined $package_name && $package_name) + || confess "You must pass a package name"; + # NOTE: + # return the metaclass if we have it cached, + # 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); + + # 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->is_immutable + ? $class->get_mutable_metaclass_name() + : blessed($class)) + : $class); + + # now create the metaclass + my $meta; + if ($class =~ /^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; + } + 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) } - 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"; - $METAS{$package_name} = undef; - $class->construct_class_instance(':package' => $package_name, @_); - } + # and check the metaclass compatibility + $meta->check_metaclass_compatability(); - # NOTE: (meta-circularity) - # this is a special form of &construct_instance - # (see below), which is used to construct class - # meta-object instances for any Class::MOP::* - # class. All other classes will use the more - # normal &construct_instance. - sub construct_class_instance { - my $class = shift; - my %options = @_; - my $package_name = $options{':package'}; - (defined $package_name && $package_name) - || confess "You must pass a package name"; - # NOTE: - # return the metaclass if we have it cached, - # and it is still defined (it has not been - # reaped by DESTROY yet, which can happen - # annoyingly enough during global destruction) - return $METAS{$package_name} - if exists $METAS{$package_name} && defined $METAS{$package_name}; + Class::MOP::store_metaclass_by_name($package_name, $meta); + + # NOTE: + # we need to weaken any anon classes + # so that they can call DESTROY properly + Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class; + + $meta; +} + +sub check_metaclass_compatability { + my $self = shift; + + # this is always okay ... + return if blessed($self) eq 'Class::MOP::Class' && + $self->instance_metaclass eq 'Class::MOP::Instance'; + my @class_list = $self->class_precedence_list; + shift @class_list; # shift off $self->name + + foreach my $class_name (@class_list) { + my $meta = Class::MOP::get_metaclass_by_name($class_name) || next; + # 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->is_immutable - ? $class->get_mutable_metaclass_name() - : blessed($class)) - : $class); - - $class = blessed($class) || $class; - # now create the metaclass - my $meta; - if ($class =~ /^Class::MOP::Class$/) { - $meta = bless { - '$:package' => $package_name, - '%: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; - } - 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) - } - # and check the metaclass compatibility - $meta->check_metaclass_compatability(); - $METAS{$package_name} = $meta; + # get the name of the class appropriately + my $meta_type = ($meta->is_immutable + ? $meta->get_mutable_metaclass_name() + : blessed($meta)); + + ($self->isa($meta_type)) + || confess $self->name . "->meta => (" . (blessed($self)) . ")" . + " is not compatible with the " . + $class_name . "->meta => (" . ($meta_type) . ")"; # NOTE: - # we need to weaken any anon classes - # so that they can call DESTROY properly - weaken($METAS{$package_name}) - if $package_name =~ /^$ANON_CLASS_PREFIX/; - $meta; - } - - sub check_metaclass_compatability { - my $self = shift; - - # this is always okay ... - return if blessed($self) eq 'Class::MOP::Class' && - $self->instance_metaclass eq 'Class::MOP::Instance'; - - my @class_list = $self->class_precedence_list; - shift @class_list; # shift off $self->name - - foreach my $class_name (@class_list) { - my $meta = $METAS{$class_name} || next; - - # NOTE: - # we need to deal with the possibility - # of class immutability here, and then - # get the name of the class appropriately - my $meta_type = ($meta->is_immutable - ? $meta->get_mutable_metaclass_name() - : blessed($meta)); - - ($self->isa($meta_type)) - || confess $self->name . "->meta => (" . (blessed($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. - ($self->instance_metaclass->isa($meta->instance_metaclass)) - || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" . - " is not compatible with the " . - $class_name . "->meta => (" . ($meta->instance_metaclass) . ")"; - } - } -} + # we also need to check that instance metaclasses + # are compatabile in the same the class. + ($self->instance_metaclass->isa($meta->instance_metaclass)) + || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" . + " is not compatible with the " . + $class_name . "->meta => (" . ($meta->instance_metaclass) . ")"; + } +} ## ANON classes @@ -164,42 +164,70 @@ my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::'; # use case where it is not, write a test and # I will change it. my $ANON_CLASS_SERIAL = 0; + + # NOTE: + # we need a sufficiently annoying prefix + # this should suffice for now, this is + # used in a couple of places below, so + # need to put it up here for now. + my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::'; + + sub is_anon_class { + my $self = shift; + no warnings 'uninitialized'; + $self->name =~ /^$ANON_CLASS_PREFIX/ ? 1 : 0; + } sub create_anon_class { my ($class, %options) = @_; my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL; - return $class->create($package_name, '0.00', %options); - } -} + return $class->create($package_name, %options); + } -# NOTE: -# this will only get called for -# anon-classes, all other calls -# are assumed to occur during -# global destruction and so don't -# really need to be handled explicitly -sub DESTROY { - my $self = shift; - return unless $self->name =~ /^$ANON_CLASS_PREFIX/; - my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/); - no strict 'refs'; - foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) { - delete ${$ANON_CLASS_PREFIX . $serial_id}{$key}; + # NOTE: + # this will only get called for + # anon-classes, all other calls + # are assumed to occur during + # global destruction and so don't + # really need to be handled explicitly + sub DESTROY { + my $self = shift; + no warnings 'uninitialized'; + return unless $self->name =~ /^$ANON_CLASS_PREFIX/; + my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/); + no strict 'refs'; + foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) { + delete ${$ANON_CLASS_PREFIX . $serial_id}{$key}; + } + delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'}; } - delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'}; + } # creating classes with MOP ... sub create { - my ($class, $package_name, $package_version, %options) = @_; + my $class = shift; + my $package_name = shift; + (defined $package_name && $package_name) || confess "You must pass a package name"; + + (scalar @_ % 2 == 0) + || confess "You much pass all parameters as name => value pairs " . + "(I found an uneven number of params in \@_)"; + + my (%options) = @_; + my $code = "package $package_name;"; - $code .= "\$$package_name\:\:VERSION = '$package_version';" - if defined $package_version; + $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 $@; + my $meta = $class->initialize($package_name); $meta->add_method('meta' => sub { @@ -232,10 +260,36 @@ 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 $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); + + 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__'; + + $map->{$symbol} = $method_metaclass->wrap($code); + } + + return $map; +} # Instance Construction & Cloning @@ -287,11 +341,12 @@ sub clone_instance { (blessed($instance)) || confess "You can only clone instances, \$self is not a blessed instance"; my $meta_instance = $class->get_meta_instance(); - my $clone = $meta_instance->clone_instance($instance); - foreach my $key (keys %params) { - next unless $meta_instance->is_valid_slot($key); - $meta_instance->set_slot_value($clone, $key, $params{$key}); - } + my $clone = $meta_instance->clone_instance($instance); + foreach my $attr ($class->compute_all_applicable_attributes()) { + if ($params{$attr->init_arg}) { + $meta_instance->set_slot_value($clone, $attr->name, $params{$attr->init_arg}); + } + } return $clone; } @@ -336,16 +391,21 @@ sub add_method { my ($self, $method_name, $method) = @_; (defined $method_name && $method_name) || confess "You must define a method name"; - # use reftype here to allow for blessed subs ... - ('CODE' eq (reftype($method) || '')) - || confess "Your code block must be a CODE reference"; - my $full_method_name = ($self->name . '::' . $method_name); - - # FIXME: - # dont bless subs, its bad mkay - $method = $self->method_metaclass->wrap($method) unless blessed($method); - $self->add_package_symbol("&${method_name}" => subname $full_method_name => $method); + my $body; + if (blessed($method)) { + $body = $method->body; + } + else { + $body = $method; + ('CODE' eq (reftype($body) || '')) + || confess "Your code block must be a CODE reference"; + $method = $self->method_metaclass->wrap($body); + } + $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); } { @@ -359,7 +419,7 @@ sub add_method { $method = $self->find_next_method_by_name($method_name); # die if it does not exist (defined $method) - || confess "The method '$method_name' is not found in the inherience hierarchy for this class"; + || confess "The method '$method_name' is not found in the inherience hierarchy for class " . $self->name; # and now make sure to wrap it # even if it is already wrapped # because we need a new sub ref @@ -416,20 +476,12 @@ sub alias_method { my ($self, $method_name, $method) = @_; (defined $method_name && $method_name) || confess "You must define a method name"; - # use reftype here to allow for blessed subs ... - ('CODE' eq (reftype($method) || '')) - || confess "Your code block must be a CODE reference"; - # FIXME: - # dont bless subs, its bad mkay - $method = $self->method_metaclass->wrap($method) unless blessed($method); + my $body = (blessed($method) ? $method->body : $method); + ('CODE' eq (reftype($body) || '')) + || confess "Your code block must be a CODE reference"; - $self->add_package_symbol("&${method_name}" => $method); -} - -sub find_method_by_name { - my ($self, $method_name) = @_; - return $self->name->can($method_name); + $self->add_package_symbol("&${method_name}" => $body); } sub has_method { @@ -437,15 +489,7 @@ sub has_method { (defined $method_name && $method_name) || confess "You must define a method name"; - return 0 if !$self->has_package_symbol("&${method_name}"); - my $method = $self->get_package_symbol("&${method_name}"); - return 0 if (svref_2object($method)->GV->STASH->NAME || '') ne $self->name && - (svref_2object($method)->GV->NAME || '') ne '__ANON__'; - - # FIXME: - # dont bless subs, its bad mkay - $self->method_metaclass->wrap($method) unless blessed($method); - + return 0 unless exists $self->get_method_map->{$method_name}; return 1; } @@ -453,10 +497,14 @@ sub get_method { my ($self, $method_name) = @_; (defined $method_name && $method_name) || confess "You must define a method name"; - - return unless $self->has_method($method_name); + + # NOTE: + # I don't really need this here, because + # if the method_map is missing a key it + # will just return undef for me now + # return unless $self->has_method($method_name); - return $self->get_package_symbol("&${method_name}"); + return $self->get_method_map->{$method_name}; } sub remove_method { @@ -466,15 +514,38 @@ sub remove_method { my $removed_method = $self->get_method($method_name); - $self->remove_package_symbol("&${method_name}") - if defined $removed_method; + do { + $self->remove_package_symbol("&${method_name}"); + delete $self->get_method_map->{$method_name}; + } if defined $removed_method; return $removed_method; } sub get_method_list { my $self = shift; - grep { $self->has_method($_) } $self->list_all_package_symbols; + keys %{$self->get_method_map}; +} + +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}++; + # fetch the meta-class ... + my $meta = $self->initialize($class); + return $meta->get_method($method_name) + if $meta->has_method($method_name); + } + return; } sub compute_all_applicable_methods { @@ -559,7 +630,20 @@ sub add_attribute { # make sure it is derived from the correct type though ($attribute->isa('Class::MOP::Attribute')) || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)"; + + # first we attach our new attribute + # because it might need certain information + # about the class which it is attached to $attribute->attach_to_class($self); + + # then we remove attributes of a conflicting + # 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); + + # then onto installing the new accessors $attribute->install_accessors(); $self->get_attribute_map->{$attribute->name} = $attribute; } @@ -576,8 +660,10 @@ sub get_attribute { (defined $attribute_name && $attribute_name) || confess "You must define an attribute name"; return $self->get_attribute_map->{$attribute_name} - if $self->has_attribute($attribute_name); - return; + # NOTE: + # this will return undef anyway, so no need ... + # if $self->has_attribute($attribute_name); + #return; } sub remove_attribute { @@ -642,8 +728,35 @@ sub find_attribute_by_name { sub is_mutable { 1 } sub is_immutable { 0 } -sub make_immutable { - return Class::MOP::Class::Immutable->make_metaclass_immutable(@_); +{ + use Class::MOP::Immutable; + + my $IMMUTABLE_META; + + sub make_immutable { + my ($self) = @_; + + $IMMUTABLE_META ||= Class::MOP::Immutable->new($self->meta, { + 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', + } + })->create_immutable_metaclass; + + $IMMUTABLE_META->make_metaclass_immutable(@_); + } } 1; @@ -675,7 +788,8 @@ Class::MOP::Class - Class Meta Object # or use this to actually create classes ... - Class::MOP::Class->create('Bar' => '0.01' => ( + Class::MOP::Class->create('Bar' => ( + version => '0.01', superclasses => [ 'Foo' ], attributes => [ Class::MOP:::Attribute->new('$bar'), @@ -712,21 +826,6 @@ bootstrap this module by installing a number of attribute meta-objects into it's metaclass. This will allow this class to reap all the benifits of the MOP when subclassing it. -=item B - -This will return an hash of all the metaclass instances that have -been cached by B keyed by the package name. - -=item B - -This will return an array of all the metaclass instances that have -been cached by B. - -=item B - -This will return an array of all the metaclass names that have -been cached by B. - =back =head2 Class construction @@ -741,15 +840,17 @@ created any more than nessecary. Basically, they are singletons. =over 4 -=item B ?$version, + authority =E ?$authority, superclasses =E ?@superclasses, methods =E ?%methods, attributes =E ?%attributes)> This returns a B object, bringing the specified -C<$package_name> into existence and adding any of the -C<$package_version>, C<@superclasses>, C<%methods> and C<%attributes> -to it. +C<$package_name> into existence and adding any of the C<$version>, +C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to +it. =item B ?@superclasses, methods =E ?%methods, @@ -864,17 +965,15 @@ is too I to be part of the MOP. =head2 Informational -=over 4 +These are a few predicate methods for asking information about the class. -=item B +=over 4 -This is a read-only attribute which returns the package name for the -given B instance. +=item B -=item B +=item B -This is a read-only attribute which returns the C<$VERSION> of the -package for the given B instance. +=item B =back @@ -907,6 +1006,8 @@ what B does, but we don't remove duplicate names. =over 4 +=item B + =item B =item B @@ -956,8 +1057,11 @@ C<$method_name> is actually a method. However, it will DWIM about =item B -This will return a CODE reference of the specified C<$method_name>, -or return undef if that method does not exist. +This will return a Class::MOP::Method instance related to the specified +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 @@ -1135,6 +1239,11 @@ It should be noted that any accessor, reader/writer or predicate methods which the C<$attribute_meta_object> has will be installed into the class at this time. +B +If an attribute already exists for C<$attribute_name>, the old one +will be removed (as well as removing all it's accessors), and then +the new one added. + =item B Checks to see if this class has an attribute by the name of @@ -1184,47 +1293,10 @@ It will return undef if nothing is found. =back -=head2 Package Variables - -Since Perl's classes are built atop the Perl package system, it is -fairly common to use package scoped variables for things like static -class variables. The following methods are convience methods for -the creation and inspection of package scoped variables. - -=over 4 - -=item B - -Given a C<$variable_name>, which must contain a leading sigil, this -method will create that variable within the package which houses the -class. It also takes an optional C<$initial_value>, which must be a -reference of the same type as the sigil of the C<$variable_name> -implies. - -=item B - -This will return a reference to the package variable in -C<$variable_name>. - -=item B - -Returns true (C<1>) if there is a package variable defined for -C<$variable_name>, and false (C<0>) otherwise. - -=item B - -This will attempt to remove the package variable at C<$variable_name>. - -=back - =head2 Class closing =over 4 -=item B - -=item B - =item B =back