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 sub attribute_metaclass;
12 sub constructor_class;
15 my @MetaClassTypes = qw(
23 my($class, %args) = @_;
25 $args{attributes} = {};
29 $args{superclasses} = do {
31 \@{ $args{package} . '::ISA' };
34 my $self = bless \%args, ref($class) || $class;
35 if(ref($self) ne __PACKAGE__){
36 $self->meta->_initialize_object($self, \%args);
41 sub create_anon_class{
43 return $self->create(undef, @_);
50 sub calculate_all_roles {
53 return grep { !$seen{ $_->name }++ }
54 map { $_->calculate_all_roles } @{ $self->roles };
61 foreach my $super(@_){
62 Mouse::Util::load_class($super);
63 my $meta = Mouse::Util::get_metaclass_by_name($super);
65 next if not defined $meta;
67 if(Mouse::Util::is_a_metarole($meta)){
68 $self->throw_error("You cannot inherit from a Mouse Role ($super)");
71 next if $self->isa(ref $meta); # _superclass_meta_is_compatible
73 $self->_reconcile_with_superclass_meta($meta);
75 @{ $self->{superclasses} } = @_;
78 return @{ $self->{superclasses} };
81 sub _reconcile_with_superclass_meta {
82 my($self, $super_meta) = @_;
86 foreach my $metaclass_type(@MetaClassTypes){
87 my $super_c = $super_meta->$metaclass_type();
88 my $self_c = $self->$metaclass_type();
90 if(!$super_c->isa($self_c)){
91 push @incompatibles, ($metaclass_type => $super_c);
97 foreach my $role($self->meta->calculate_all_roles){
98 if(!$super_meta->meta->does_role($role->name)){
99 push @roles, $role->name;
103 #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n";
105 require Mouse::Util::MetaRole;
106 Mouse::Util::MetaRole::apply_metaclass_roles(
108 metaclass => ref $super_meta,
109 metaclass_roles => \@roles,
115 sub find_method_by_name{
116 my($self, $method_name) = @_;
117 defined($method_name)
118 or $self->throw_error('You must define a method name to find');
120 foreach my $class( $self->linearized_isa ){
121 my $method = $self->initialize($class)->get_method($method_name);
122 return $method if defined $method;
127 sub get_all_methods {
129 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
132 sub get_all_method_names {
135 return grep { $uniq{$_}++ == 0 }
136 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
137 $self->linearized_isa;
140 sub find_attribute_by_name{
141 my($self, $name) = @_;
143 foreach my $class($self->linearized_isa){
144 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
145 $attr = $meta->get_attribute($name) and last;
158 $attr->isa('Mouse::Meta::Attribute')
159 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
167 my %args = (@_ == 1) ? %{$_[0]} : @_;
170 or $self->throw_error('You must provide a name for the attribute');
172 if ($name =~ s/^\+//) { # inherited attributes
173 my $inherited_attr = $self->find_attribute_by_name($name)
174 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
176 $attr = $inherited_attr->clone_and_inherit_options(%args);
179 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
180 $args{traits} = \@traits if @traits;
182 $attr = $attribute_class->new($name, %args);
186 weaken( $attr->{associated_class} = $self );
188 $self->{attributes}{$attr->name} = $attr;
189 $attr->install_accessors();
191 if(Mouse::Util::_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
192 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
197 sub compute_all_applicable_attributes {
198 Carp::cluck('compute_all_applicable_attributes() has been deprecated')
199 if Mouse::Util::_MOUSE_VERBOSE;
200 return shift->get_all_attributes(@_)
210 my %params = (@_ == 1) ? %{$_[0]} : @_;
212 (blessed($object) && $object->isa($class->name))
213 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
215 my $cloned = bless { %$object }, ref $object;
216 $class->_initialize_object($cloned, \%params);
222 my ($class, $instance, %params) = @_;
224 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
225 if Mouse::Util::_MOUSE_VERBOSE;
226 return $class->clone_object($instance, %params);
232 inline_constructor => 1,
233 inline_destructor => 1,
234 constructor_name => 'new',
238 $self->{is_immutable}++;
240 if ($args{inline_constructor}) {
241 my $c = $self->constructor_class;
242 Mouse::Util::load_class($c);
243 $self->add_method($args{constructor_name} =>
244 $c->_generate_constructor($self, \%args));
247 if ($args{inline_destructor}) {
248 my $c = $self->destructor_class;
249 Mouse::Util::load_class($c);
250 $self->add_method(DESTROY =>
251 $c->_generate_destructor($self, \%args));
254 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
255 # at the end of a source file.
259 sub make_mutable { not_supported }
261 sub is_immutable { $_[0]->{is_immutable} }
262 sub is_mutable { !$_[0]->{is_immutable} }
264 sub _install_modifier_pp{
265 my( $self, $type, $name, $code ) = @_;
266 my $into = $self->name;
268 my $original = $into->can($name)
269 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
271 my $modifier_table = $self->{modifiers}{$name};
273 if(!$modifier_table){
274 my(@before, @after, @around, $cache, $modified);
279 for my $c (@before) { $c->(@_) }
281 if(wantarray){ # list context
282 my @rval = $cache->(@_);
284 for my $c(@after){ $c->(@_) }
287 elsif(defined wantarray){ # scalar context
288 my $rval = $cache->(@_);
290 for my $c(@after){ $c->(@_) }
296 for my $c(@after){ $c->(@_) }
301 $self->{modifiers}{$name} = $modifier_table = {
302 original => $original,
308 cache => \$cache, # cache for around modifiers
311 $self->add_method($name => $modified);
314 if($type eq 'before'){
315 unshift @{$modifier_table->{before}}, $code;
317 elsif($type eq 'after'){
318 push @{$modifier_table->{after}}, $code;
321 push @{$modifier_table->{around}}, $code;
323 my $next = ${ $modifier_table->{cache} };
324 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
330 sub _install_modifier {
331 my ( $self, $type, $name, $code ) = @_;
333 # load Class::Method::Modifiers first
334 my $no_cmm_fast = do{
336 eval q{ require Class::Method::Modifiers::Fast };
342 $impl = \&_install_modifier_pp;
345 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
347 my ( $self, $type, $name, $code ) = @_;
348 my $into = $self->name;
349 $install_modifier->($into, $type, $name, $code);
351 $self->add_method($name => do{
353 \&{ $into . '::' . $name };
359 # replace this method itself :)
361 no warnings 'redefine';
362 *_install_modifier = $impl;
365 $self->$impl( $type, $name, $code );
368 sub add_before_method_modifier {
369 my ( $self, $name, $code ) = @_;
370 $self->_install_modifier( 'before', $name, $code );
373 sub add_around_method_modifier {
374 my ( $self, $name, $code ) = @_;
375 $self->_install_modifier( 'around', $name, $code );
378 sub add_after_method_modifier {
379 my ( $self, $name, $code ) = @_;
380 $self->_install_modifier( 'after', $name, $code );
383 sub add_override_method_modifier {
384 my ($self, $name, $code) = @_;
386 if($self->has_method($name)){
387 $self->throw_error("Cannot add an override method if a local method is already present");
390 my $package = $self->name;
392 my $super_body = $package->can($name)
393 or $self->throw_error("You cannot override '$name' because it has no super method");
395 $self->add_method($name => sub {
396 local $Mouse::SUPER_PACKAGE = $package;
397 local $Mouse::SUPER_BODY = $super_body;
398 local @Mouse::SUPER_ARGS = @_;
405 sub add_augment_method_modifier {
406 my ($self, $name, $code) = @_;
407 if($self->has_method($name)){
408 $self->throw_error("Cannot add an augment method if a local method is already present");
411 my $super = $self->find_method_by_name($name)
412 or $self->throw_error("You cannot augment '$name' because it has no super method");
414 my $super_package = $super->package_name;
415 my $super_body = $super->body;
417 $self->add_method($name => sub{
418 local $Mouse::INNER_BODY{$super_package} = $code;
419 local $Mouse::INNER_ARGS{$super_package} = [@_];
426 my ($self, $role_name) = @_;
429 || $self->throw_error("You must supply a role name to look for");
431 for my $class ($self->linearized_isa) {
432 my $meta = Mouse::Util::get_metaclass_by_name($class)
435 for my $role (@{ $meta->roles }) {
437 return 1 if $role->does_role($role_name);
449 Mouse::Meta::Class - The Mouse class metaclass
453 This document describes Mouse version 0.40_08
457 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
459 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
460 one instance should exist for a given class.
462 =head2 C<< name -> ClassName >>
464 Returns the name of the owner class.
466 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
468 Gets (or sets) the list of superclasses of the owner class.
470 =head2 C<< add_method(name => CodeRef) >>
472 Adds a method to the owner class.
474 =head2 C<< has_method(name) -> Bool >>
476 Returns whether we have a method with the given name.
478 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
480 Returns a L<Mouse::Meta::Method> with the given name.
482 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
484 =head2 C<< get_method_list -> Names >>
486 Returns a list of method names which are defined in the local class.
487 If you want a list of all applicable methods for a class, use the
488 C<get_all_methods> method.
490 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
492 Return the list of all L<Mouse::Meta::Method> instances associated with
493 the class and its superclasses.
495 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
497 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
500 =head2 C<< has_attribute(Name) -> Bool >>
502 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
504 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
506 Returns the L<Mouse::Meta::Attribute> with the given name.
508 =head2 C<< get_attribute_list -> Names >>
510 Returns a list of attribute names which are defined in the local
511 class. If you want a list of all applicable attributes for a class,
512 use the C<get_all_attributes> method.
514 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
516 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
517 this class and its superclasses.
519 =head2 C<< linearized_isa -> [ClassNames] >>
521 Returns the list of classes in method dispatch order, with duplicates removed.
523 =head2 C<< new_object(Parameters) -> Instance >>
525 Creates a new instance.
527 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
529 Clones the given instance which must be an instance governed by this
532 =head2 C<< throw_error(Message, Parameters) >>
534 Throws an error with the given message.
538 L<Mouse::Meta::Module>
540 L<Moose::Meta::Class>