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;
19 my($class, %args) = @_;
21 $args{attributes} = {};
25 $args{superclasses} = do {
27 \@{ $args{package} . '::ISA' };
30 my $self = bless \%args, ref($class) || $class;
31 if(ref($self) ne __PACKAGE__){
32 $self->meta->_initialize_object($self, \%args);
37 sub create_anon_class{
39 return $self->create(undef, @_);
46 sub calculate_all_roles {
49 return grep { !$seen{ $_->name }++ }
50 map { $_->calculate_all_roles } @{ $self->roles };
57 foreach my $super(@_){
58 Mouse::Util::load_class($super);
59 my $meta = Mouse::Util::get_metaclass_by_name($super);
61 next if not defined $meta;
63 if(Mouse::Util::is_a_metarole($meta)){
64 $self->throw_error("You cannot inherit from a Mouse Role ($super)");
67 next if $self->isa(ref $meta); # _superclass_meta_is_compatible
69 $self->_reconcile_with_superclass_meta($meta);
71 @{ $self->{superclasses} } = @_;
74 return @{ $self->{superclasses} };
76 my @MetaClassTypes = (
77 'attribute', # Mouse::Meta::Attribute
78 'method', # Mouse::Meta::Method
79 'constructor', # Mouse::Meta::Method::Constructor
80 'destructor', # Mouse::Meta::Method::Destructor
83 sub _reconcile_with_superclass_meta {
84 my($self, $other) = @_;
86 # find incompatible traits
88 foreach my $metaclass_type(@MetaClassTypes){
89 my $accessor = $self->can($metaclass_type . '_metaclass')
90 || $self->can($metaclass_type . '_class');
92 my $other_c = $other->$accessor();
93 my $self_c = $self->$accessor();
95 if(!$self_c->isa($other_c)){
96 $metaroles{$metaclass_type}
97 = [ $self_c->meta->_collect_roles($other_c->meta) ];
101 $metaroles{class} = [$self->meta->_collect_roles($other->meta)];
103 #use Data::Dumper; print Data::Dumper->new([\%metaroles], ['*metaroles'])->Indent(1)->Dump;
105 require Mouse::Util::MetaRole;
106 $_[0] = Mouse::Util::MetaRole::apply_metaroles(
108 class_metaroles => \%metaroles,
114 my ($self, $other) = @_;
116 # find common ancestor
117 my @self_lin_isa = $self->linearized_isa;
118 my @other_lin_isa = $other->linearized_isa;
120 my(@self_anon_supers, @other_anon_supers);
121 push @self_anon_supers, shift @self_lin_isa while $self_lin_isa[0]->meta->is_anon_class;
122 push @other_anon_supers, shift @other_lin_isa while $other_lin_isa[0]->meta->is_anon_class;
124 my $common_ancestor = $self_lin_isa[0] eq $other_lin_isa[0] && $self_lin_isa[0];
126 if(!$common_ancestor){
127 $self->throw_error(sprintf '%s cannot have %s as a super class because of their metaclass incompatibility',
128 $self->name, $other->name);
132 return sort grep { !$seen{$_}++ } ## no critic
133 (map{ $_->name } map{ $_->meta->calculate_all_roles } @self_anon_supers),
134 (map{ $_->name } map{ $_->meta->calculate_all_roles } @other_anon_supers),
139 sub find_method_by_name{
140 my($self, $method_name) = @_;
141 defined($method_name)
142 or $self->throw_error('You must define a method name to find');
144 foreach my $class( $self->linearized_isa ){
145 my $method = $self->initialize($class)->get_method($method_name);
146 return $method if defined $method;
151 sub get_all_methods {
153 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
156 sub get_all_method_names {
159 return grep { $uniq{$_}++ == 0 }
160 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
161 $self->linearized_isa;
164 sub find_attribute_by_name{
165 my($self, $name) = @_;
167 foreach my $class($self->linearized_isa){
168 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
169 $attr = $meta->get_attribute($name) and last;
182 $attr->isa('Mouse::Meta::Attribute')
183 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
191 my %args = (@_ == 1) ? %{$_[0]} : @_;
194 or $self->throw_error('You must provide a name for the attribute');
196 if ($name =~ s/^\+//) { # inherited attributes
197 my $inherited_attr = $self->find_attribute_by_name($name)
198 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
200 $attr = $inherited_attr->clone_and_inherit_options(%args);
203 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
204 $args{traits} = \@traits if @traits;
206 $attr = $attribute_class->new($name, %args);
210 weaken( $attr->{associated_class} = $self );
212 # install accessors first
213 $attr->install_accessors();
215 # then register the attribute to the metaclass
216 $attr->{insertion_order} = keys %{ $self->{attributes} };
217 $self->{attributes}{$attr->name} = $attr;
219 if(!$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
220 Carp::carp(qq{Attribute ($name) of class }.$self->name
221 .qq{ has no associated methods (did you mean to provide an "is" argument?)});
231 sub immutable_options {
232 my ( $self, @args ) = @_;
235 inline_constructor => 1,
236 inline_destructor => 1,
237 constructor_name => 'new',
244 my %args = $self->immutable_options(@_);
246 $self->{is_immutable}++;
248 if ($args{inline_constructor}) {
249 $self->add_method($args{constructor_name} =>
250 Mouse::Util::load_class($self->constructor_class)
251 ->_generate_constructor($self, \%args));
254 if ($args{inline_destructor}) {
255 $self->add_method(DESTROY =>
256 Mouse::Util::load_class($self->destructor_class)
257 ->_generate_destructor($self, \%args));
260 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
261 # at the end of a source file.
267 $self->{is_immutable} = 0;
272 sub is_mutable { !$_[0]->is_immutable }
274 sub _install_modifier {
275 my( $self, $type, $name, $code ) = @_;
276 my $into = $self->name;
278 my $original = $into->can($name)
279 or $self->throw_error("The method '$name' was not found in the inheritance hierarchy for $into");
281 my $modifier_table = $self->{modifiers}{$name};
283 if(!$modifier_table){
284 my(@before, @after, @around, $cache, $modified);
289 for my $c (@before) { $c->(@_) }
291 if(wantarray){ # list context
292 my @rval = $cache->(@_);
294 for my $c(@after){ $c->(@_) }
297 elsif(defined wantarray){ # scalar context
298 my $rval = $cache->(@_);
300 for my $c(@after){ $c->(@_) }
306 for my $c(@after){ $c->(@_) }
311 $self->{modifiers}{$name} = $modifier_table = {
312 original => $original,
318 cache => \$cache, # cache for around modifiers
321 $self->add_method($name => $modified);
324 if($type eq 'before'){
325 unshift @{$modifier_table->{before}}, $code;
327 elsif($type eq 'after'){
328 push @{$modifier_table->{after}}, $code;
331 push @{$modifier_table->{around}}, $code;
333 my $next = ${ $modifier_table->{cache} };
334 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
340 sub add_before_method_modifier {
341 my ( $self, $name, $code ) = @_;
342 $self->_install_modifier( 'before', $name, $code );
345 sub add_around_method_modifier {
346 my ( $self, $name, $code ) = @_;
347 $self->_install_modifier( 'around', $name, $code );
350 sub add_after_method_modifier {
351 my ( $self, $name, $code ) = @_;
352 $self->_install_modifier( 'after', $name, $code );
355 sub add_override_method_modifier {
356 my ($self, $name, $code) = @_;
358 if($self->has_method($name)){
359 $self->throw_error("Cannot add an override method if a local method is already present");
362 my $package = $self->name;
364 my $super_body = $package->can($name)
365 or $self->throw_error("You cannot override '$name' because it has no super method");
367 $self->add_method($name => sub {
368 local $Mouse::SUPER_PACKAGE = $package;
369 local $Mouse::SUPER_BODY = $super_body;
370 local @Mouse::SUPER_ARGS = @_;
377 sub add_augment_method_modifier {
378 my ($self, $name, $code) = @_;
379 if($self->has_method($name)){
380 $self->throw_error("Cannot add an augment method if a local method is already present");
383 my $super = $self->find_method_by_name($name)
384 or $self->throw_error("You cannot augment '$name' because it has no super method");
386 my $super_package = $super->package_name;
387 my $super_body = $super->body;
389 $self->add_method($name => sub{
390 local $Mouse::INNER_BODY{$super_package} = $code;
391 local $Mouse::INNER_ARGS{$super_package} = [@_];
398 my ($self, $role_name) = @_;
401 || $self->throw_error("You must supply a role name to look for");
403 $role_name = $role_name->name if ref $role_name;
405 for my $class ($self->linearized_isa) {
406 my $meta = Mouse::Util::get_metaclass_by_name($class)
409 for my $role (@{ $meta->roles }) {
411 return 1 if $role->does_role($role_name);
423 Mouse::Meta::Class - The Mouse class metaclass
427 This document describes Mouse version 0.67
431 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
433 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
434 one instance should exist for a given class.
436 =head2 C<< name -> ClassName >>
438 Returns the name of the owner class.
440 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
442 Gets (or sets) the list of superclasses of the owner class.
444 =head2 C<< add_method(name => CodeRef) >>
446 Adds a method to the owner class.
448 =head2 C<< has_method(name) -> Bool >>
450 Returns whether we have a method with the given name.
452 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
454 Returns a L<Mouse::Meta::Method> with the given name.
456 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
458 =head2 C<< get_method_list -> Names >>
460 Returns a list of method names which are defined in the local class.
461 If you want a list of all applicable methods for a class, use the
462 C<get_all_methods> method.
464 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
466 Return the list of all L<Mouse::Meta::Method> instances associated with
467 the class and its superclasses.
469 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
471 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
474 =head2 C<< has_attribute(Name) -> Bool >>
476 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
478 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
480 Returns the L<Mouse::Meta::Attribute> with the given name.
482 =head2 C<< get_attribute_list -> Names >>
484 Returns a list of attribute names which are defined in the local
485 class. If you want a list of all applicable attributes for a class,
486 use the C<get_all_attributes> method.
488 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
490 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
491 this class and its superclasses.
493 =head2 C<< linearized_isa -> [ClassNames] >>
495 Returns the list of classes in method dispatch order, with duplicates removed.
497 =head2 C<< new_object(Parameters) -> Instance >>
499 Creates a new instance.
501 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
503 Clones the given instance which must be an instance governed by this
506 =head2 C<< throw_error(Message, Parameters) >>
508 Throws an error with the given message.
512 L<Mouse::Meta::Module>
514 L<Moose::Meta::Class>