X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FMeta%2FClass.pm;h=dba5c8c8b1c21e0222f9115660476edf0ac62f41;hp=cea2064030148f3e3d68c929e5719d03bdb949a9;hb=733f404b1631c344ec33fc9b23a90558cf06d781;hpb=87ca293be7ca0041bbb86ad9609a498fb2010f4f diff --git a/lib/Mouse/Meta/Class.pm b/lib/Mouse/Meta/Class.pm index cea2064..dba5c8c 100644 --- a/lib/Mouse/Meta/Class.pm +++ b/lib/Mouse/Meta/Class.pm @@ -1,35 +1,41 @@ package Mouse::Meta::Class; -use strict; -use warnings; +use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings use Scalar::Util qw/blessed weaken/; -use Mouse::Util qw/get_linear_isa not_supported/; - -use Mouse::Meta::Method::Constructor; -use Mouse::Meta::Method::Destructor; use Mouse::Meta::Module; +our @ISA = qw(Mouse::Meta::Module); + +sub attribute_metaclass; +sub method_metaclass; -use base qw(Mouse::Meta::Module); +sub constructor_class; +sub destructor_class; -sub method_metaclass(){ 'Mouse::Meta::Method' } # required for get_method() +my @MetaClassTypes = qw( + attribute_metaclass + method_metaclass + constructor_class + destructor_class +); sub _construct_meta { my($class, %args) = @_; - $args{attributes} ||= {}; - $args{methods} ||= {}; - $args{roles} ||= []; + $args{attributes} = {}; + $args{methods} = {}; + $args{roles} = []; $args{superclasses} = do { no strict 'refs'; \@{ $args{package} . '::ISA' }; }; - #return Mouse::Meta::Class->initialize($class)->new_object(%args) - # if $class ne __PACKAGE__; - - return bless \%args, ref($class) || $class; + my $self = bless \%args, ref($class) || $class; + if(ref($self) ne __PACKAGE__){ + $self->meta->_initialize_object($self, \%args); + } + return $self; } sub create_anon_class{ @@ -37,27 +43,79 @@ sub create_anon_class{ return $self->create(undef, @_); } -sub is_anon_class{ - return exists $_[0]->{anon_serial_id}; -} +sub is_anon_class; -sub roles { $_[0]->{roles} } +sub roles; + +sub calculate_all_roles { + my $self = shift; + my %seen; + return grep { !$seen{ $_->name }++ } + map { $_->calculate_all_roles } @{ $self->roles }; +} sub superclasses { my $self = shift; if (@_) { - Mouse::load_class($_) for @_; + foreach my $super(@_){ + Mouse::Util::load_class($super); + my $meta = Mouse::Util::get_metaclass_by_name($super); + + next if not defined $meta; + + if(Mouse::Util::is_a_metarole($meta)){ + $self->throw_error("You cannot inherit from a Mouse Role ($super)"); + } + + next if $self->isa(ref $meta); # _superclass_meta_is_compatible + + $self->_reconcile_with_superclass_meta($meta); + } @{ $self->{superclasses} } = @_; } return @{ $self->{superclasses} }; } +sub _reconcile_with_superclass_meta { + my($self, $super_meta) = @_; + + # find incompatible traits + my @incompatibles; + foreach my $metaclass_type(@MetaClassTypes){ + my $super_c = $super_meta->$metaclass_type(); + my $self_c = $self->$metaclass_type(); + + if(!$super_c->isa($self_c)){ + push @incompatibles, ($metaclass_type => $super_c); + } + } + + my @roles; + foreach my $role($super_meta->meta->calculate_all_roles){ + if(!$self->meta->does_role($role->name)){ + push @roles, $role->name; + } + } + + #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n"; + + require Mouse::Util::MetaRole; + Mouse::Util::MetaRole::apply_metaclass_roles( + for_class => $self, + metaclass => ref $super_meta, + metaclass_roles => \@roles, + @incompatibles, + ); + return; +} + sub find_method_by_name{ my($self, $method_name) = @_; defined($method_name) or $self->throw_error('You must define a method name to find'); + foreach my $class( $self->linearized_isa ){ my $method = $self->initialize($class)->get_method($method_name); return $method if defined $method; @@ -67,7 +125,7 @@ sub find_method_by_name{ sub get_all_methods { my($self) = @_; - return map{ $self->find_method_by_name($self) } $self->get_all_method_names; + return map{ $self->find_method_by_name($_) } $self->get_all_method_names; } sub get_all_method_names { @@ -78,6 +136,16 @@ sub get_all_method_names { $self->linearized_isa; } +sub find_attribute_by_name{ + my($self, $name) = @_; + my $attr; + foreach my $class($self->linearized_isa){ + my $meta = Mouse::Util::get_metaclass_by_name($class) or next; + $attr = $meta->get_attribute($name) and last; + } + return $attr; +} + sub add_attribute { my $self = shift; @@ -101,23 +169,16 @@ sub add_attribute { or $self->throw_error('You must provide a name for the attribute'); if ($name =~ s/^\+//) { # inherited attributes - my $inherited_attr; - - foreach my $class($self->linearized_isa){ - my $meta = Mouse::Meta::Module::get_metaclass_by_name($class) or next; - $inherited_attr = $meta->get_attribute($name) and last; - } - - defined($inherited_attr) + my $inherited_attr = $self->find_attribute_by_name($name) or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name); - $attr = $inherited_attr->clone_and_inherit_options($name, \%args); + $attr = $inherited_attr->clone_and_inherit_options(%args); } else{ - my($attribute_class, @traits) = Mouse::Meta::Attribute->interpolate_class($name, \%args); + my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args); $args{traits} = \@traits if @traits; - $attr = $attribute_class->new($name, \%args); + $attr = $attribute_class->new($name, %args); } } @@ -126,224 +187,250 @@ sub add_attribute { $self->{attributes}{$attr->name} = $attr; $attr->install_accessors(); - if(!$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){ + if(Mouse::Util::_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){ Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)}); } return $attr; } -sub compute_all_applicable_attributes { shift->get_all_attributes(@_) } -sub get_all_attributes { - my $self = shift; - my (@attr, %seen); +sub compute_all_applicable_attributes { # DEPRECATED + Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead'); - for my $class ($self->linearized_isa) { - my $meta = $self->_metaclass_cache($class) - or next; + return shift->get_all_attributes(@_) +} - for my $name (keys %{ $meta->get_attribute_map }) { - next if $seen{$name}++; - push @attr, $meta->get_attribute($name); - } - } +sub linearized_isa; - return @attr; -} +sub new_object; -sub linearized_isa { @{ get_linear_isa($_[0]->name) } } +sub clone_object { + my $class = shift; + my $object = shift; + my $args = $object->Mouse::Object::BUILDARGS(@_); -sub new_object { - my $self = shift; - my %args = (@_ == 1 ? %{$_[0]} : @_); + (blessed($object) && $object->isa($class->name)) + || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)"); - my $instance = bless {}, $self->name; + my $cloned = bless { %$object }, ref $object; + $class->_initialize_object($cloned, $args); - $self->_initialize_instance($instance, \%args); - return $instance; + return $cloned; } -sub _initialize_instance{ - my($self, $instance, $args) = @_; +sub clone_instance { # DEPRECATED + my ($class, $instance, %params) = @_; - my @triggers_queue; + Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead'); - foreach my $attribute ($self->get_all_attributes) { - my $from = $attribute->init_arg; - my $key = $attribute->name; + return $class->clone_object($instance, %params); +} - if (defined($from) && exists($args->{$from})) { - $args->{$from} = $attribute->coerce_constraint($args->{$from}) - if $attribute->should_coerce; - $attribute->verify_against_type_constraint($args->{$from}); +sub immutable_options { + my ( $self, @args ) = @_; - $instance->{$key} = $args->{$from}; + return ( + inline_constructor => 1, + inline_destructor => 1, + constructor_name => 'new', + @args, + ); +} - weaken($instance->{$key}) - if ref($instance->{$key}) && $attribute->is_weak_ref; - if ($attribute->has_trigger) { - push @triggers_queue, [ $attribute->trigger, $args->{$from} ]; - } - } - else { - if ($attribute->has_default || $attribute->has_builder) { - unless ($attribute->is_lazy) { - my $default = $attribute->default; - my $builder = $attribute->builder; - my $value = $attribute->has_builder - ? $instance->$builder - : ref($default) eq 'CODE' - ? $default->($instance) - : $default; - - $value = $attribute->coerce_constraint($value) - if $attribute->should_coerce; - $attribute->verify_against_type_constraint($value); - - $instance->{$key} = $value; - - weaken($instance->{$key}) - if ref($instance->{$key}) && $attribute->is_weak_ref; - } - } - else { - if ($attribute->is_required) { - $self->throw_error("Attribute (".$attribute->name.") is required"); - } - } - } - } +sub make_immutable { + my $self = shift; + my %args = $self->immutable_options(@_); + + $self->{is_immutable}++; - foreach my $trigger_and_value(@triggers_queue){ - my($trigger, $value) = @{$trigger_and_value}; - $trigger->($instance, $value); + if ($args{inline_constructor}) { + my $c = $self->constructor_class; + Mouse::Util::load_class($c); + $self->add_method($args{constructor_name} => + $c->_generate_constructor($self, \%args)); } - if($self->is_anon_class){ - $instance->{__METACLASS__} = $self; + if ($args{inline_destructor}) { + my $c = $self->destructor_class; + Mouse::Util::load_class($c); + $self->add_method(DESTROY => + $c->_generate_destructor($self, \%args)); } - return $instance; + # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value + # at the end of a source file. + return 1; } -sub clone_object { - my $class = shift; - my $instance = shift; +sub make_mutable { + my($self) = @_; + $self->{is_immutable} = 0; + return; +} - (blessed($instance) && $instance->isa($class->name)) - || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($instance)"); +sub is_immutable; +sub is_mutable { !$_[0]->is_immutable } - $class->clone_instance($instance, @_); -} +sub _install_modifier_pp{ + my( $self, $type, $name, $code ) = @_; + my $into = $self->name; -sub clone_instance { - my ($class, $instance, %params) = @_; + my $original = $into->can($name) + or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into"); + + my $modifier_table = $self->{modifiers}{$name}; - (blessed($instance)) - || $class->throw_error("You can only clone instances, ($instance) is not a blessed instance"); + if(!$modifier_table){ + my(@before, @after, @around, $cache, $modified); - my $clone = bless { %$instance }, ref $instance; + $cache = $original; - foreach my $attr ($class->get_all_attributes()) { - if ( defined( my $init_arg = $attr->init_arg ) ) { - if (exists $params{$init_arg}) { - $clone->{ $attr->name } = $params{$init_arg}; + $modified = sub { + for my $c (@before) { $c->(@_) } + + if(wantarray){ # list context + my @rval = $cache->(@_); + + for my $c(@after){ $c->(@_) } + return @rval; } - } - } + elsif(defined wantarray){ # scalar context + my $rval = $cache->(@_); - return $clone; + for my $c(@after){ $c->(@_) } + return $rval; + } + else{ # void context + $cache->(@_); -} + for my $c(@after){ $c->(@_) } + return; + } + }; -sub make_immutable { - my $self = shift; - my %args = ( - inline_constructor => 1, - inline_destructor => 1, - @_, - ); + $self->{modifiers}{$name} = $modifier_table = { + original => $original, - $self->{is_immutable}++; + before => \@before, + after => \@after, + around => \@around, - if ($args{inline_constructor}) { - $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self )); - } + cache => \$cache, # cache for around modifiers + }; - if ($args{inline_destructor}) { - $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self )); + $self->add_method($name => $modified); } - # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value - # at the end of a source file. - return 1; -} + if($type eq 'before'){ + unshift @{$modifier_table->{before}}, $code; + } + elsif($type eq 'after'){ + push @{$modifier_table->{after}}, $code; + } + else{ # around + push @{$modifier_table->{around}}, $code; -sub make_mutable { not_supported } + my $next = ${ $modifier_table->{cache} }; + ${ $modifier_table->{cache} } = sub{ $code->($next, @_) }; + } -sub is_immutable { $_[0]->{is_immutable} } -sub is_mutable { !$_[0]->{is_immutable} } + return; +} sub _install_modifier { - my ( $self, $into, $type, $name, $code ) = @_; - - # which is modifer class available? - my $modifier_class = do { - if (eval "require Class::Method::Modifiers::Fast; 1") { - 'Class::Method::Modifiers::Fast'; - } elsif (eval "require Class::Method::Modifiers; 1") { - 'Class::Method::Modifiers'; - } else { - Carp::croak("Method modifiers require the use of Class::Method::Modifiers or Class::Method::Modifiers::Fast. Please install it from CPAN and file a bug report with this application."); - } + my ( $self, $type, $name, $code ) = @_; + + # load Class::Method::Modifiers first + my $no_cmm_fast = do{ + local $@; + eval q{ use Class::Method::Modifiers::Fast 0.041 () }; + $@; }; - my $modifier = $modifier_class->can('_install_modifier'); + + my $impl; + if($no_cmm_fast){ + $impl = \&_install_modifier_pp; + } + else{ + my $install_modifier = Class::Method::Modifiers::Fast->can('install_modifier'); + $impl = sub { + my ( $self, $type, $name, $code ) = @_; + my $into = $self->name; + $install_modifier->($into, $type, $name, $code); + + $self->add_method($name => do{ + no strict 'refs'; + \&{ $into . '::' . $name }; + }); + return; + }; + } # replace this method itself :) { no warnings 'redefine'; - *_install_modifier = sub { - my ( $self, $into, $type, $name, $code ) = @_; - $modifier->( - $into, - $type, - $name, - $code - ); - $self->{methods}{$name}++; # register it to the method map - return; - }; + *_install_modifier = $impl; } - # call me. for first time. - $self->_install_modifier( $into, $type, $name, $code ); + $self->$impl( $type, $name, $code ); } sub add_before_method_modifier { my ( $self, $name, $code ) = @_; - $self->_install_modifier( $self->name, 'before', $name, $code ); + $self->_install_modifier( 'before', $name, $code ); } sub add_around_method_modifier { my ( $self, $name, $code ) = @_; - $self->_install_modifier( $self->name, 'around', $name, $code ); + $self->_install_modifier( 'around', $name, $code ); } sub add_after_method_modifier { my ( $self, $name, $code ) = @_; - $self->_install_modifier( $self->name, 'after', $name, $code ); + $self->_install_modifier( 'after', $name, $code ); } sub add_override_method_modifier { my ($self, $name, $code) = @_; + if($self->has_method($name)){ + $self->throw_error("Cannot add an override method if a local method is already present"); + } + my $package = $self->name; - my $body = $package->can($name) + my $super_body = $package->can($name) or $self->throw_error("You cannot override '$name' because it has no super method"); - $self->add_method($name => sub { $code->($package, $body, @_) }); + $self->add_method($name => sub { + local $Mouse::SUPER_PACKAGE = $package; + local $Mouse::SUPER_BODY = $super_body; + local @Mouse::SUPER_ARGS = @_; + + $code->(@_); + }); + return; +} + +sub add_augment_method_modifier { + my ($self, $name, $code) = @_; + if($self->has_method($name)){ + $self->throw_error("Cannot add an augment method if a local method is already present"); + } + + my $super = $self->find_method_by_name($name) + or $self->throw_error("You cannot augment '$name' because it has no super method"); + + my $super_package = $super->package_name; + my $super_body = $super->body; + + $self->add_method($name => sub{ + local $Mouse::INNER_BODY{$super_package} = $code; + local $Mouse::INNER_ARGS{$super_package} = [@_]; + $super_body->(@_); + }); + return; } sub does_role { @@ -353,8 +440,8 @@ sub does_role { || $self->throw_error("You must supply a role name to look for"); for my $class ($self->linearized_isa) { - my $meta = Mouse::Meta::Module::class_of($class); - next unless $meta && $meta->can('roles'); + my $meta = Mouse::Util::get_metaclass_by_name($class) + or next; for my $role (@{ $meta->roles }) { @@ -366,74 +453,104 @@ sub does_role { } 1; - __END__ =head1 NAME -Mouse::Meta::Class - hook into the Mouse MOP +Mouse::Meta::Class - The Mouse class metaclass -=head1 METHODS +=head1 VERSION -=head2 initialize ClassName -> Mouse::Meta::Class +This document describes Mouse version 0.49 -Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only -one instance should exist for a given class. +=head1 METHODS -=head2 new %args -> Mouse::Meta::Class +=head2 C<< initialize(ClassName) -> Mouse::Meta::Class >> -Creates a new Mouse::Meta::Class. Don't call this directly. +Finds or creates a C instance for the given ClassName. Only +one instance should exist for a given class. -=head2 name -> ClassName +=head2 C<< name -> ClassName >> Returns the name of the owner class. -=head2 superclasses -> [ClassName] +=head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >> Gets (or sets) the list of superclasses of the owner class. -=head2 add_attribute (Mouse::Meta::Attribute| name => spec) +=head2 C<< add_method(name => CodeRef) >> + +Adds a method to the owner class. + +=head2 C<< has_method(name) -> Bool >> + +Returns whether we have a method with the given name. + +=head2 C<< get_method(name) -> Mouse::Meta::Method | undef >> + +Returns a L with the given name. + +Note that you can also use C<< $metaclass->name->can($name) >> for a method body. + +=head2 C<< get_method_list -> Names >> + +Returns a list of method names which are defined in the local class. +If you want a list of all applicable methods for a class, use the +C method. + +=head2 C<< get_all_methods -> (Mouse::Meta::Method) >> + +Return the list of all L instances associated with +the class and its superclasses. + +=head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >> Begins keeping track of the existing L for the owner class. -=head2 get_all_attributes -> (Mouse::Meta::Attribute) +=head2 C<< has_attribute(Name) -> Bool >> -Returns the list of all L instances associated with -this class and its superclasses. +Returns whether we have a L with the given name. -=head2 get_attribute_map -> { name => Mouse::Meta::Attribute } +=head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >> -Returns a mapping of attribute names to their corresponding -L objects. +Returns the L with the given name. -=head2 get_attribute_list -> { name => Mouse::Meta::Attribute } +=head2 C<< get_attribute_list -> Names >> -This returns a list of attribute names which are defined in the local +Returns a list of attribute names which are defined in the local class. If you want a list of all applicable attributes for a class, use the C method. -=head2 has_attribute Name -> Bool +=head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >> -Returns whether we have a L with the given name. +Returns the list of all L instances associated with +this class and its superclasses. -=head2 get_attribute Name -> Mouse::Meta::Attribute | undef +=head2 C<< linearized_isa -> [ClassNames] >> -Returns the L with the given name. +Returns the list of classes in method dispatch order, with duplicates removed. -=head2 linearized_isa -> [ClassNames] +=head2 C<< new_object(Parameters) -> Instance >> -Returns the list of classes in method dispatch order, with duplicates removed. +Creates a new instance. -=head2 clone_object Instance -> Instance +=head2 C<< clone_object(Instance, Parameters) -> Instance >> -Clones the given C which must be an instance governed by this +Clones the given instance which must be an instance governed by this metaclass. -=head2 clone_instance Instance, Parameters -> Instance +=head2 C<< throw_error(Message, Parameters) >> + +Throws an error with the given message. + +=head1 SEE ALSO + +L + +L -The clone_instance method has been made private. -The public version is deprecated. +L =cut