1 package Mouse::Meta::Class;
2 use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings
4 use Scalar::Util qw/blessed weaken/;
6 use Mouse::Meta::Module;
7 our @ISA = qw(Mouse::Meta::Module);
9 our @CARP_NOT = qw(Mouse); # trust Mouse
11 sub attribute_metaclass;
14 sub constructor_class;
17 my @MetaClassTypes = qw(
25 my($class, %args) = @_;
27 $args{attributes} = {};
31 $args{superclasses} = do {
33 \@{ $args{package} . '::ISA' };
36 my $self = bless \%args, ref($class) || $class;
37 if(ref($self) ne __PACKAGE__){
38 $self->meta->_initialize_object($self, \%args);
43 sub create_anon_class{
45 return $self->create(undef, @_);
52 sub calculate_all_roles {
55 return grep { !$seen{ $_->name }++ }
56 map { $_->calculate_all_roles } @{ $self->roles };
63 foreach my $super(@_){
64 Mouse::Util::load_class($super);
65 my $meta = Mouse::Util::get_metaclass_by_name($super);
67 next if not defined $meta;
69 if(Mouse::Util::is_a_metarole($meta)){
70 $self->throw_error("You cannot inherit from a Mouse Role ($super)");
73 next if $self->isa(ref $meta); # _superclass_meta_is_compatible
75 $self->_reconcile_with_superclass_meta($meta);
77 @{ $self->{superclasses} } = @_;
80 return @{ $self->{superclasses} };
83 sub _reconcile_with_superclass_meta {
84 my($self, $super_meta) = @_;
86 # find incompatible traits
88 foreach my $metaclass_type(@MetaClassTypes){
89 my $super_c = $super_meta->$metaclass_type();
90 my $self_c = $self->$metaclass_type();
92 if(!$super_c->isa($self_c)){
93 push @incompatibles, ($metaclass_type => $super_c);
98 foreach my $role($super_meta->meta->calculate_all_roles){
99 if(!$self->meta->does_role($role)){
100 push @roles, $role->name;
104 #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n";
106 require Mouse::Util::MetaRole;
107 Mouse::Util::MetaRole::apply_metaclass_roles(
109 metaclass => ref $super_meta,
110 metaclass_roles => \@roles,
116 sub find_method_by_name{
117 my($self, $method_name) = @_;
118 defined($method_name)
119 or $self->throw_error('You must define a method name to find');
121 foreach my $class( $self->linearized_isa ){
122 my $method = $self->initialize($class)->get_method($method_name);
123 return $method if defined $method;
128 sub get_all_methods {
130 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
133 sub get_all_method_names {
136 return grep { $uniq{$_}++ == 0 }
137 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
138 $self->linearized_isa;
141 sub find_attribute_by_name{
142 my($self, $name) = @_;
144 foreach my $class($self->linearized_isa){
145 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
146 $attr = $meta->get_attribute($name) and last;
159 $attr->isa('Mouse::Meta::Attribute')
160 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
168 my %args = (@_ == 1) ? %{$_[0]} : @_;
171 or $self->throw_error('You must provide a name for the attribute');
173 if ($name =~ s/^\+//) { # inherited attributes
174 my $inherited_attr = $self->find_attribute_by_name($name)
175 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
177 $attr = $inherited_attr->clone_and_inherit_options(%args);
180 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
181 $args{traits} = \@traits if @traits;
183 $attr = $attribute_class->new($name, %args);
187 weaken( $attr->{associated_class} = $self );
189 $self->{attributes}{$attr->name} = $attr;
190 $attr->install_accessors();
192 if(!$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
193 Carp::carp(qq{Attribute ($name) of class }.$self->name
194 .qq{ has no associated methods (did you mean to provide an "is" argument?)});
199 sub compute_all_applicable_attributes { # DEPRECATED
200 Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead');
202 return shift->get_all_attributes(@_)
212 my $args = $object->Mouse::Object::BUILDARGS(@_);
214 (blessed($object) && $object->isa($class->name))
215 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
217 my $cloned = bless { %$object }, ref $object;
218 $class->_initialize_object($cloned, $args);
223 sub clone_instance { # DEPRECATED
224 my ($class, $instance, %params) = @_;
226 Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead');
228 return $class->clone_object($instance, %params);
232 sub immutable_options {
233 my ( $self, @args ) = @_;
236 inline_constructor => 1,
237 inline_destructor => 1,
238 constructor_name => 'new',
246 my %args = $self->immutable_options(@_);
248 $self->{is_immutable}++;
250 $self->{strict_constructor} = $args{strict_constructor};
252 if ($args{inline_constructor}) {
253 $self->add_method($args{constructor_name} =>
254 Mouse::Util::load_class($self->constructor_class)
255 ->_generate_constructor($self, \%args));
258 if ($args{inline_destructor}) {
259 $self->add_method(DESTROY =>
260 Mouse::Util::load_class($self->destructor_class)
261 ->_generate_destructor($self, \%args));
264 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
265 # at the end of a source file.
271 $self->{is_immutable} = 0;
276 sub is_mutable { !$_[0]->is_immutable }
278 sub _install_modifier_pp{
279 my( $self, $type, $name, $code ) = @_;
280 my $into = $self->name;
282 my $original = $into->can($name)
283 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
285 my $modifier_table = $self->{modifiers}{$name};
287 if(!$modifier_table){
288 my(@before, @after, @around, $cache, $modified);
293 for my $c (@before) { $c->(@_) }
295 if(wantarray){ # list context
296 my @rval = $cache->(@_);
298 for my $c(@after){ $c->(@_) }
301 elsif(defined wantarray){ # scalar context
302 my $rval = $cache->(@_);
304 for my $c(@after){ $c->(@_) }
310 for my $c(@after){ $c->(@_) }
315 $self->{modifiers}{$name} = $modifier_table = {
316 original => $original,
322 cache => \$cache, # cache for around modifiers
325 $self->add_method($name => $modified);
328 if($type eq 'before'){
329 unshift @{$modifier_table->{before}}, $code;
331 elsif($type eq 'after'){
332 push @{$modifier_table->{after}}, $code;
335 push @{$modifier_table->{around}}, $code;
337 my $next = ${ $modifier_table->{cache} };
338 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
344 sub _install_modifier {
345 my ( $self, $type, $name, $code ) = @_;
347 # load Class::Method::Modifiers first
348 my $no_cmm_fast = do{
350 eval q{ use Class::Method::Modifiers::Fast 0.041 () };
356 $impl = \&_install_modifier_pp;
359 my $install_modifier = Class::Method::Modifiers::Fast->can('install_modifier');
361 my ( $self, $type, $name, $code ) = @_;
362 my $into = $self->name;
363 $install_modifier->($into, $type, $name, $code);
365 $self->add_method($name => Mouse::Util::get_code_ref($into, $name));
370 # replace this method itself :)
372 no warnings 'redefine';
373 *_install_modifier = $impl;
376 $self->$impl( $type, $name, $code );
379 sub add_before_method_modifier {
380 my ( $self, $name, $code ) = @_;
381 $self->_install_modifier( 'before', $name, $code );
384 sub add_around_method_modifier {
385 my ( $self, $name, $code ) = @_;
386 $self->_install_modifier( 'around', $name, $code );
389 sub add_after_method_modifier {
390 my ( $self, $name, $code ) = @_;
391 $self->_install_modifier( 'after', $name, $code );
394 sub add_override_method_modifier {
395 my ($self, $name, $code) = @_;
397 if($self->has_method($name)){
398 $self->throw_error("Cannot add an override method if a local method is already present");
401 my $package = $self->name;
403 my $super_body = $package->can($name)
404 or $self->throw_error("You cannot override '$name' because it has no super method");
406 $self->add_method($name => sub {
407 local $Mouse::SUPER_PACKAGE = $package;
408 local $Mouse::SUPER_BODY = $super_body;
409 local @Mouse::SUPER_ARGS = @_;
416 sub add_augment_method_modifier {
417 my ($self, $name, $code) = @_;
418 if($self->has_method($name)){
419 $self->throw_error("Cannot add an augment method if a local method is already present");
422 my $super = $self->find_method_by_name($name)
423 or $self->throw_error("You cannot augment '$name' because it has no super method");
425 my $super_package = $super->package_name;
426 my $super_body = $super->body;
428 $self->add_method($name => sub{
429 local $Mouse::INNER_BODY{$super_package} = $code;
430 local $Mouse::INNER_ARGS{$super_package} = [@_];
437 my ($self, $role_name) = @_;
440 || $self->throw_error("You must supply a role name to look for");
442 $role_name = $role_name->name if ref $role_name;
444 for my $class ($self->linearized_isa) {
445 my $meta = Mouse::Util::get_metaclass_by_name($class)
448 for my $role (@{ $meta->roles }) {
450 return 1 if $role->does_role($role_name);
462 Mouse::Meta::Class - The Mouse class metaclass
466 This document describes Mouse version 0.50_04
470 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
472 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
473 one instance should exist for a given class.
475 =head2 C<< name -> ClassName >>
477 Returns the name of the owner class.
479 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
481 Gets (or sets) the list of superclasses of the owner class.
483 =head2 C<< add_method(name => CodeRef) >>
485 Adds a method to the owner class.
487 =head2 C<< has_method(name) -> Bool >>
489 Returns whether we have a method with the given name.
491 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
493 Returns a L<Mouse::Meta::Method> with the given name.
495 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
497 =head2 C<< get_method_list -> Names >>
499 Returns a list of method names which are defined in the local class.
500 If you want a list of all applicable methods for a class, use the
501 C<get_all_methods> method.
503 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
505 Return the list of all L<Mouse::Meta::Method> instances associated with
506 the class and its superclasses.
508 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
510 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
513 =head2 C<< has_attribute(Name) -> Bool >>
515 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
517 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
519 Returns the L<Mouse::Meta::Attribute> with the given name.
521 =head2 C<< get_attribute_list -> Names >>
523 Returns a list of attribute names which are defined in the local
524 class. If you want a list of all applicable attributes for a class,
525 use the C<get_all_attributes> method.
527 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
529 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
530 this class and its superclasses.
532 =head2 C<< linearized_isa -> [ClassNames] >>
534 Returns the list of classes in method dispatch order, with duplicates removed.
536 =head2 C<< new_object(Parameters) -> Instance >>
538 Creates a new instance.
540 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
542 Clones the given instance which must be an instance governed by this
545 =head2 C<< throw_error(Message, Parameters) >>
547 Throws an error with the given message.
551 L<Mouse::Meta::Module>
553 L<Moose::Meta::Class>