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=7d7d1a0ecd01c9deca6c7c5207d5a3540e1cb674;hb=733f404b1631c344ec33fc9b23a90558cf06d781;hpb=23264b5b200f08d7258efc1509846d0a161194e1 diff --git a/lib/Mouse/Meta/Class.pm b/lib/Mouse/Meta/Class.pm index 7d7d1a0..dba5c8c 100644 --- a/lib/Mouse/Meta/Class.pm +++ b/lib/Mouse/Meta/Class.pm @@ -1,86 +1,131 @@ package Mouse::Meta::Class; -use strict; -use warnings; +use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings -use Mouse::Meta::Method::Constructor; -use Mouse::Meta::Method::Destructor; use Scalar::Util qw/blessed weaken/; -use Mouse::Util qw/get_linear_isa/; -use Carp 'confess'; -use base qw(Mouse::Meta::Module); +use Mouse::Meta::Module; +our @ISA = qw(Mouse::Meta::Module); -do { - my %METACLASS_CACHE; +sub attribute_metaclass; +sub method_metaclass; - # because Mouse doesn't introspect existing classes, we're forced to - # only pay attention to other Mouse classes - sub _metaclass_cache { - my $class = shift; - my $name = shift; - return $METACLASS_CACHE{$name}; - } - - sub initialize { - my($class, $package_name, @args) = @_; - - ($package_name && !ref($package_name)) - || confess("You must pass a package name and it cannot be blessed"); - - return $METACLASS_CACHE{$package_name} - ||= $class->_construct_class_instance(package => $package_name, @args); - } +sub constructor_class; +sub destructor_class; - sub class_of{ - my($class_or_instance) = @_; - return undef unless defined $class_or_instance; - return $METACLASS_CACHE{ blessed($class_or_instance) || $class_or_instance }; - } +my @MetaClassTypes = qw( + attribute_metaclass + method_metaclass + constructor_class + destructor_class +); - # Means of accessing all the metaclasses that have - # been initialized thus far - sub get_all_metaclasses { %METACLASS_CACHE } - sub get_all_metaclass_instances { values %METACLASS_CACHE } - sub get_all_metaclass_names { keys %METACLASS_CACHE } - sub get_metaclass_by_name { $METACLASS_CACHE{$_[0]} } - sub store_metaclass_by_name { $METACLASS_CACHE{$_[0]} = $_[1] } - sub weaken_metaclass { weaken($METACLASS_CACHE{$_[0]}) } - sub does_metaclass_exist { exists $METACLASS_CACHE{$_[0]} && defined $METACLASS_CACHE{$_[0]} } - sub remove_metaclass_by_name { $METACLASS_CACHE{$_[0]} = undef } -}; - -sub _construct_class_instance { +sub _construct_meta { my($class, %args) = @_; - $args{attributes} = {}; + $args{attributes} = {}; + $args{methods} = {}; + $args{roles} = []; + $args{superclasses} = do { no strict 'refs'; \@{ $args{package} . '::ISA' }; }; - $args{roles} ||= []; - $args{methods} ||= {}; - bless \%args, $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{ + my $self = shift; + return $self->create(undef, @_); } -sub name { $_[0]->{package} } -sub _method_map{ $_[0]->{methods} } +sub is_anon_class; + +sub roles; -sub namespace{ - my $name = $_[0]->{package}; - no strict 'refs'; - return \%{ $name . '::' }; +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} } = @_; } - @{ $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; + } + return undef; +} + +sub get_all_methods { + my($self) = @_; + return map{ $self->find_method_by_name($_) } $self->get_all_method_names; } sub get_all_method_names { @@ -91,114 +136,126 @@ 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; - if (@_ == 1 && blessed($_[0])) { - my $attr = shift @_; - $self->{'attributes'}{$attr->name} = $attr; - } else { - my $names = shift @_; - $names = [$names] if !ref($names); - my $metaclass = 'Mouse::Meta::Attribute'; - my %options = @_; - - if ( my $metaclass_name = delete $options{metaclass} ) { - my $new_class = Mouse::Util::resolve_metaclass_alias( - 'Attribute', - $metaclass_name - ); - if ( $metaclass ne $new_class ) { - $metaclass = $new_class; - } - } + my($attr, $name); - for my $name (@$names) { - if ($name =~ s/^\+//) { - $metaclass->clone_parent($self, $name, @_); - } - else { - $metaclass->create($self, $name, @_); - } - } + if(blessed $_[0]){ + $attr = $_[0]; + + $attr->isa('Mouse::Meta::Attribute') + || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)"); + + $name = $attr->name; } -} + else{ + # _process_attribute + $name = shift; -sub compute_all_applicable_attributes { shift->get_all_attributes(@_) } -sub get_all_attributes { - my $self = shift; - my (@attr, %seen); + my %args = (@_ == 1) ? %{$_[0]} : @_; - for my $class ($self->linearized_isa) { - my $meta = $self->_metaclass_cache($class) - or next; + defined($name) + or $self->throw_error('You must provide a name for the attribute'); + + if ($name =~ s/^\+//) { # inherited attributes + 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(%args); + } + else{ + my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args); + $args{traits} = \@traits if @traits; - for my $name (keys %{ $meta->get_attribute_map }) { - next if $seen{$name}++; - push @attr, $meta->get_attribute($name); + $attr = $attribute_class->new($name, %args); } } - return @attr; + weaken( $attr->{associated_class} = $self ); + + $self->{attributes}{$attr->name} = $attr; + $attr->install_accessors(); + + 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 get_attribute_map { $_[0]->{attributes} } -sub has_attribute { exists $_[0]->{attributes}->{$_[1]} } -sub get_attribute { $_[0]->{attributes}->{$_[1]} } -sub get_attribute_list { - my $self = shift; - keys %{$self->get_attribute_map}; +sub compute_all_applicable_attributes { # DEPRECATED + Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead'); + + return shift->get_all_attributes(@_) } -sub linearized_isa { @{ get_linear_isa($_[0]->name) } } +sub linearized_isa; + +sub new_object; sub clone_object { - my $class = shift; - my $instance = shift; + my $class = shift; + my $object = shift; + my $args = $object->Mouse::Object::BUILDARGS(@_); + + (blessed($object) && $object->isa($class->name)) + || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)"); - (blessed($instance) && $instance->isa($class->name)) - || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)"; + my $cloned = bless { %$object }, ref $object; + $class->_initialize_object($cloned, $args); - $class->clone_instance($instance, @_); + return $cloned; } -sub clone_instance { +sub clone_instance { # DEPRECATED my ($class, $instance, %params) = @_; - (blessed($instance)) - || confess "You can only clone instances, ($instance) is not a blessed instance"; + Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead'); - my $clone = bless { %$instance }, ref $instance; + return $class->clone_object($instance, %params); +} - 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}; - } - } - } - return $clone; +sub immutable_options { + my ( $self, @args ) = @_; + return ( + inline_constructor => 1, + inline_destructor => 1, + constructor_name => 'new', + @args, + ); } + sub make_immutable { my $self = shift; - my %args = ( - inline_constructor => 1, - inline_destructor => 1, - @_, - ); + my %args = $self->immutable_options(@_); - my $name = $self->name; $self->{is_immutable}++; if ($args{inline_constructor}) { - $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self )); + my $c = $self->constructor_class; + Mouse::Util::load_class($c); + $self->add_method($args{constructor_name} => + $c->_generate_constructor($self, \%args)); } if ($args{inline_destructor}) { - $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self )); + my $c = $self->destructor_class; + Mouse::Util::load_class($c); + $self->add_method(DESTROY => + $c->_generate_destructor($self, \%args)); } # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value @@ -206,90 +263,188 @@ sub make_immutable { return 1; } -sub make_mutable { confess "Mouse does not currently support 'make_mutable'" } +sub make_mutable { + my($self) = @_; + $self->{is_immutable} = 0; + return; +} + +sub is_immutable; +sub is_mutable { !$_[0]->is_immutable } + +sub _install_modifier_pp{ + my( $self, $type, $name, $code ) = @_; + my $into = $self->name; + + 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}; + + if(!$modifier_table){ + my(@before, @after, @around, $cache, $modified); -sub is_immutable { $_[0]->{is_immutable} } + $cache = $original; -sub attribute_metaclass { "Mouse::Meta::Class" } + $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->(@_); + + for my $c(@after){ $c->(@_) } + return $rval; + } + else{ # void context + $cache->(@_); + + for my $c(@after){ $c->(@_) } + return; + } + }; + + $self->{modifiers}{$name} = $modifier_table = { + original => $original, + + before => \@before, + after => \@after, + around => \@around, + + cache => \$cache, # cache for around modifiers + }; + + $self->add_method($name => $modified); + } + + 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; + + my $next = ${ $modifier_table->{cache} }; + ${ $modifier_table->{cache} } = sub{ $code->($next, @_) }; + } + + 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 strict 'refs'; no warnings 'redefine'; - *{__PACKAGE__ . '::_install_modifier'} = sub { - my ( $self, $into, $type, $name, $code ) = @_; - $modifier->( - $into, - $type, - $name, - $code - ); - }; + *_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) = @_; - my $pkg = $self->name; - my $method = "${pkg}::${name}"; + if($self->has_method($name)){ + $self->throw_error("Cannot add an override method if a local method is already present"); + } - # Class::Method::Modifiers won't do this for us, so do it ourselves + my $package = $self->name; - my $body = $pkg->can($name) - or confess "You cannot override '$method' because it has no super method"; + my $super_body = $package->can($name) + or $self->throw_error("You cannot override '$name' because it has no super method"); - no strict 'refs'; - *$method = sub { $code->($pkg, $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"); -sub roles { $_[0]->{roles} } + 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 { my ($self, $role_name) = @_; (defined $role_name) - || confess "You must supply a role name to look for"; + || $self->throw_error("You must supply a role name to look for"); for my $class ($self->linearized_isa) { - my $meta = 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 }) { + return 1 if $role->does_role($role_name); } } @@ -297,150 +452,105 @@ sub does_role { return 0; } -sub create { - my ($class, $package_name, %options) = @_; +1; +__END__ - (ref $options{superclasses} eq 'ARRAY') - || confess "You must pass an ARRAY ref of superclasses" - if exists $options{superclasses}; +=head1 NAME - (ref $options{attributes} eq 'ARRAY') - || confess "You must pass an ARRAY ref of attributes" - if exists $options{attributes}; +Mouse::Meta::Class - The Mouse class metaclass - (ref $options{methods} eq 'HASH') - || confess "You must pass a HASH ref of methods" - if exists $options{methods}; +=head1 VERSION - do { - ( defined $package_name && $package_name ) - || confess "You must pass a package name"; +This document describes Mouse version 0.49 - my $code = "package $package_name;"; - $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" - if exists $options{version}; - $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';" - if exists $options{authority}; +=head1 METHODS - eval $code; - confess "creation of $package_name failed : $@" if $@; - }; +=head2 C<< initialize(ClassName) -> Mouse::Meta::Class >> - my %initialize_options = %options; - delete @initialize_options{qw( - package - superclasses - attributes - methods - version - authority - )}; - my $meta = $class->initialize( $package_name => %initialize_options ); - - # FIXME totally lame - $meta->add_method('meta' => sub { - Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]); - }); +Finds or creates a C instance for the given ClassName. Only +one instance should exist for a given class. - $meta->superclasses(@{$options{superclasses}}) - if exists $options{superclasses}; - # NOTE: - # process attributes first, so that they can - # install accessors, but locally defined methods - # can then overwrite them. It is maybe a little odd, but - # I think this should be the order of things. - if (exists $options{attributes}) { - foreach my $attr (@{$options{attributes}}) { - Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr); - } - } - if (exists $options{methods}) { - foreach my $method_name (keys %{$options{methods}}) { - $meta->add_method($method_name, $options{methods}->{$method_name}); - } - } - return $meta; -} +=head2 C<< name -> ClassName >> -{ - my $ANON_CLASS_SERIAL = 0; - my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::'; - sub create_anon_class { - my ( $class, %options ) = @_; - my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL; - return $class->create( $package_name, %options ); - } -} +Returns the name of the owner class. -1; +=head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >> -__END__ +Gets (or sets) the list of superclasses of the owner class. -=head1 NAME +=head2 C<< add_method(name => CodeRef) >> -Mouse::Meta::Class - hook into the Mouse MOP +Adds a method to the owner class. -=head1 METHODS +=head2 C<< has_method(name) -> Bool >> -=head2 initialize ClassName -> Mouse::Meta::Class +Returns whether we have a method with the given name. -Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only -one instance should exist for a given class. +=head2 C<< get_method(name) -> Mouse::Meta::Method | undef >> -=head2 new %args -> Mouse::Meta::Class +Returns a L with the given name. -Creates a new Mouse::Meta::Class. Don't call this directly. +Note that you can also use C<< $metaclass->name->can($name) >> for a method body. -=head2 name -> ClassName +=head2 C<< get_method_list -> Names >> -Returns the name of the owner class. +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 superclasses -> [ClassName] +=head2 C<< get_all_methods -> (Mouse::Meta::Method) >> -Gets (or sets) the list of superclasses of the owner class. +Return the list of all L instances associated with +the class and its superclasses. -=head2 add_attribute (Mouse::Meta::Attribute| name => spec) +=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