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);
230 sub immutable_options {
231 my ( $self, @args ) = @_;
234 inline_constructor => 1,
235 inline_destructor => 1,
236 constructor_name => 'new',
244 my %args = $self->immutable_options(@_);
246 $self->{is_immutable}++;
248 if ($args{inline_constructor}) {
249 my $c = $self->constructor_class;
250 Mouse::Util::load_class($c);
251 $self->add_method($args{constructor_name} =>
252 $c->_generate_constructor($self, \%args));
255 if ($args{inline_destructor}) {
256 my $c = $self->destructor_class;
257 Mouse::Util::load_class($c);
258 $self->add_method(DESTROY =>
259 $c->_generate_destructor($self, \%args));
262 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
263 # at the end of a source file.
269 $self->{is_immutable} = 0;
274 sub is_mutable { !$_[0]->is_immutable }
276 sub _install_modifier_pp{
277 my( $self, $type, $name, $code ) = @_;
278 my $into = $self->name;
280 my $original = $into->can($name)
281 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
283 my $modifier_table = $self->{modifiers}{$name};
285 if(!$modifier_table){
286 my(@before, @after, @around, $cache, $modified);
291 for my $c (@before) { $c->(@_) }
293 if(wantarray){ # list context
294 my @rval = $cache->(@_);
296 for my $c(@after){ $c->(@_) }
299 elsif(defined wantarray){ # scalar context
300 my $rval = $cache->(@_);
302 for my $c(@after){ $c->(@_) }
308 for my $c(@after){ $c->(@_) }
313 $self->{modifiers}{$name} = $modifier_table = {
314 original => $original,
320 cache => \$cache, # cache for around modifiers
323 $self->add_method($name => $modified);
326 if($type eq 'before'){
327 unshift @{$modifier_table->{before}}, $code;
329 elsif($type eq 'after'){
330 push @{$modifier_table->{after}}, $code;
333 push @{$modifier_table->{around}}, $code;
335 my $next = ${ $modifier_table->{cache} };
336 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
342 sub _install_modifier {
343 my ( $self, $type, $name, $code ) = @_;
345 # load Class::Method::Modifiers first
346 my $no_cmm_fast = do{
348 eval q{ require Class::Method::Modifiers::Fast };
354 $impl = \&_install_modifier_pp;
357 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
359 my ( $self, $type, $name, $code ) = @_;
360 my $into = $self->name;
361 $install_modifier->($into, $type, $name, $code);
363 $self->add_method($name => do{
365 \&{ $into . '::' . $name };
371 # replace this method itself :)
373 no warnings 'redefine';
374 *_install_modifier = $impl;
377 $self->$impl( $type, $name, $code );
380 sub add_before_method_modifier {
381 my ( $self, $name, $code ) = @_;
382 $self->_install_modifier( 'before', $name, $code );
385 sub add_around_method_modifier {
386 my ( $self, $name, $code ) = @_;
387 $self->_install_modifier( 'around', $name, $code );
390 sub add_after_method_modifier {
391 my ( $self, $name, $code ) = @_;
392 $self->_install_modifier( 'after', $name, $code );
395 sub add_override_method_modifier {
396 my ($self, $name, $code) = @_;
398 if($self->has_method($name)){
399 $self->throw_error("Cannot add an override method if a local method is already present");
402 my $package = $self->name;
404 my $super_body = $package->can($name)
405 or $self->throw_error("You cannot override '$name' because it has no super method");
407 $self->add_method($name => sub {
408 local $Mouse::SUPER_PACKAGE = $package;
409 local $Mouse::SUPER_BODY = $super_body;
410 local @Mouse::SUPER_ARGS = @_;
417 sub add_augment_method_modifier {
418 my ($self, $name, $code) = @_;
419 if($self->has_method($name)){
420 $self->throw_error("Cannot add an augment method if a local method is already present");
423 my $super = $self->find_method_by_name($name)
424 or $self->throw_error("You cannot augment '$name' because it has no super method");
426 my $super_package = $super->package_name;
427 my $super_body = $super->body;
429 $self->add_method($name => sub{
430 local $Mouse::INNER_BODY{$super_package} = $code;
431 local $Mouse::INNER_ARGS{$super_package} = [@_];
438 my ($self, $role_name) = @_;
441 || $self->throw_error("You must supply a role name to look for");
443 for my $class ($self->linearized_isa) {
444 my $meta = Mouse::Util::get_metaclass_by_name($class)
447 for my $role (@{ $meta->roles }) {
449 return 1 if $role->does_role($role_name);
461 Mouse::Meta::Class - The Mouse class metaclass
465 This document describes Mouse version 0.4501
469 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
471 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
472 one instance should exist for a given class.
474 =head2 C<< name -> ClassName >>
476 Returns the name of the owner class.
478 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
480 Gets (or sets) the list of superclasses of the owner class.
482 =head2 C<< add_method(name => CodeRef) >>
484 Adds a method to the owner class.
486 =head2 C<< has_method(name) -> Bool >>
488 Returns whether we have a method with the given name.
490 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
492 Returns a L<Mouse::Meta::Method> with the given name.
494 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
496 =head2 C<< get_method_list -> Names >>
498 Returns a list of method names which are defined in the local class.
499 If you want a list of all applicable methods for a class, use the
500 C<get_all_methods> method.
502 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
504 Return the list of all L<Mouse::Meta::Method> instances associated with
505 the class and its superclasses.
507 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
509 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
512 =head2 C<< has_attribute(Name) -> Bool >>
514 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
516 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
518 Returns the L<Mouse::Meta::Attribute> with the given name.
520 =head2 C<< get_attribute_list -> Names >>
522 Returns a list of attribute names which are defined in the local
523 class. If you want a list of all applicable attributes for a class,
524 use the C<get_all_attributes> method.
526 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
528 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
529 this class and its superclasses.
531 =head2 C<< linearized_isa -> [ClassNames] >>
533 Returns the list of classes in method dispatch order, with duplicates removed.
535 =head2 C<< new_object(Parameters) -> Instance >>
537 Creates a new instance.
539 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
541 Clones the given instance which must be an instance governed by this
544 =head2 C<< throw_error(Message, Parameters) >>
546 Throws an error with the given message.
550 L<Mouse::Meta::Module>
552 L<Moose::Meta::Class>