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::Method::Constructor;
7 use Mouse::Meta::Method::Destructor;
8 use Mouse::Meta::Module;
9 our @ISA = qw(Mouse::Meta::Module);
11 sub method_metaclass() { 'Mouse::Meta::Method' }
12 sub attribute_metaclass() { 'Mouse::Meta::Attribute' }
14 sub constructor_class() { 'Mouse::Meta::Method::Constructor' }
15 sub destructor_class() { 'Mouse::Meta::Method::Destructor' }
18 my($class, %args) = @_;
20 $args{attributes} ||= {};
21 $args{methods} ||= {};
24 $args{superclasses} = do {
26 \@{ $args{package} . '::ISA' };
29 my $self = bless \%args, ref($class) || $class;
30 if(ref($self) ne __PACKAGE__){
31 $self->meta->_initialize_object($self, \%args);
36 sub create_anon_class{
38 return $self->create(undef, @_);
42 return exists $_[0]->{anon_serial_id};
45 sub roles { $_[0]->{roles} }
51 foreach my $super(@_){
52 Mouse::Util::load_class($super);
53 my $meta = Mouse::Util::get_metaclass_by_name($super);
54 if($meta && $meta->isa('Mouse::Meta::Role')){
55 $self->throw_error("You cannot inherit from a Mouse Role ($super)");
58 @{ $self->{superclasses} } = @_;
61 return @{ $self->{superclasses} };
64 sub find_method_by_name{
65 my($self, $method_name) = @_;
67 or $self->throw_error('You must define a method name to find');
68 foreach my $class( $self->linearized_isa ){
69 my $method = $self->initialize($class)->get_method($method_name);
70 return $method if defined $method;
77 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
80 sub get_all_method_names {
83 return grep { $uniq{$_}++ == 0 }
84 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
85 $self->linearized_isa;
88 sub find_attribute_by_name{
89 my($self, $name) = @_;
91 foreach my $class($self->linearized_isa){
92 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
93 $attr = $meta->get_attribute($name) and last;
106 $attr->isa('Mouse::Meta::Attribute')
107 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
115 my %args = (@_ == 1) ? %{$_[0]} : @_;
118 or $self->throw_error('You must provide a name for the attribute');
120 if ($name =~ s/^\+//) { # inherited attributes
121 my $inherited_attr = $self->find_attribute_by_name($name)
122 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
124 $attr = $inherited_attr->clone_and_inherit_options(%args);
127 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
128 $args{traits} = \@traits if @traits;
130 $attr = $attribute_class->new($name, %args);
134 weaken( $attr->{associated_class} = $self );
136 $self->{attributes}{$attr->name} = $attr;
137 $attr->install_accessors();
139 if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
140 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
145 sub compute_all_applicable_attributes {
146 Carp::cluck('compute_all_applicable_attributes() has been deprecated');
147 return shift->get_all_attributes(@_)
150 sub get_all_attributes {
154 for my $class ($self->linearized_isa) {
155 my $meta = Mouse::Util::get_metaclass_by_name($class)
158 for my $name ($meta->get_attribute_list) {
159 next if $seen{$name}++;
160 push @attr, $meta->get_attribute($name);
167 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
171 my %args = (@_ == 1 ? %{$_[0]} : @_);
173 my $object = bless {}, $self->name;
175 $self->_initialize_object($object, \%args);
179 sub _initialize_object{
180 my($self, $object, $args) = @_;
184 foreach my $attribute ($self->get_all_attributes) {
185 my $from = $attribute->init_arg;
186 my $key = $attribute->name;
188 if (defined($from) && exists($args->{$from})) {
189 $object->{$key} = $attribute->_coerce_and_verify($args->{$from});
191 weaken($object->{$key})
192 if ref($object->{$key}) && $attribute->is_weak_ref;
194 if ($attribute->has_trigger) {
195 push @triggers_queue, [ $attribute->trigger, $object->{$key} ];
199 if ($attribute->has_default || $attribute->has_builder) {
200 unless ($attribute->is_lazy) {
201 my $default = $attribute->default;
202 my $builder = $attribute->builder;
203 my $value = $builder ? $object->$builder()
204 : ref($default) eq 'CODE' ? $object->$default()
207 # XXX: we cannot use $attribute->set_value() because it invokes triggers.
208 $object->{$key} = $attribute->_coerce_and_verify($value, $object);;
210 weaken($object->{$key})
211 if ref($object->{$key}) && $attribute->is_weak_ref;
215 if ($attribute->is_required) {
216 $self->throw_error("Attribute (".$attribute->name.") is required");
222 foreach my $trigger_and_value(@triggers_queue){
223 my($trigger, $value) = @{$trigger_and_value};
224 $trigger->($object, $value);
227 if($self->is_anon_class){
228 $object->{__METACLASS__} = $self;
237 my %params = (@_ == 1) ? %{$_[0]} : @_;
239 (blessed($object) && $object->isa($class->name))
240 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
242 my $cloned = bless { %$object }, ref $object;
243 $class->_initialize_object($cloned, \%params);
249 my ($class, $instance, %params) = @_;
251 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
253 return $class->clone_object($instance, %params);
259 inline_constructor => 1,
260 inline_destructor => 1,
261 constructor_name => 'new',
265 $self->{is_immutable}++;
267 if ($args{inline_constructor}) {
268 $self->add_method($args{constructor_name} =>
269 $self->constructor_class->_generate_constructor($self, \%args));
272 if ($args{inline_destructor}) {
273 $self->add_method(DESTROY =>
274 $self->destructor_class->_generate_destructor($self, \%args));
277 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
278 # at the end of a source file.
282 sub make_mutable { not_supported }
284 sub is_immutable { $_[0]->{is_immutable} }
285 sub is_mutable { !$_[0]->{is_immutable} }
287 sub _install_modifier_pp{
288 my( $self, $type, $name, $code ) = @_;
289 my $into = $self->name;
291 my $original = $into->can($name)
292 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
294 my $modifier_table = $self->{modifiers}{$name};
296 if(!$modifier_table){
297 my(@before, @after, @around, $cache, $modified);
302 for my $c (@before) { $c->(@_) }
304 if(wantarray){ # list context
305 my @rval = $cache->(@_);
307 for my $c(@after){ $c->(@_) }
310 elsif(defined wantarray){ # scalar context
311 my $rval = $cache->(@_);
313 for my $c(@after){ $c->(@_) }
319 for my $c(@after){ $c->(@_) }
324 $self->{modifiers}{$name} = $modifier_table = {
325 original => $original,
331 cache => \$cache, # cache for around modifiers
334 $self->add_method($name => $modified);
337 if($type eq 'before'){
338 unshift @{$modifier_table->{before}}, $code;
340 elsif($type eq 'after'){
341 push @{$modifier_table->{after}}, $code;
344 push @{$modifier_table->{around}}, $code;
346 my $next = ${ $modifier_table->{cache} };
347 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
353 sub _install_modifier {
354 my ( $self, $type, $name, $code ) = @_;
356 # load Class::Method::Modifiers first
357 my $no_cmm_fast = do{
359 eval q{ require Class::Method::Modifiers::Fast };
365 $impl = \&_install_modifier_pp;
368 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
370 my ( $self, $type, $name, $code ) = @_;
371 my $into = $self->name;
372 $install_modifier->($into, $type, $name, $code);
374 $self->add_method($name => do{
376 \&{ $into . '::' . $name };
382 # replace this method itself :)
384 no warnings 'redefine';
385 *_install_modifier = $impl;
388 $self->$impl( $type, $name, $code );
391 sub add_before_method_modifier {
392 my ( $self, $name, $code ) = @_;
393 $self->_install_modifier( 'before', $name, $code );
396 sub add_around_method_modifier {
397 my ( $self, $name, $code ) = @_;
398 $self->_install_modifier( 'around', $name, $code );
401 sub add_after_method_modifier {
402 my ( $self, $name, $code ) = @_;
403 $self->_install_modifier( 'after', $name, $code );
406 sub add_override_method_modifier {
407 my ($self, $name, $code) = @_;
409 if($self->has_method($name)){
410 $self->throw_error("Cannot add an override method if a local method is already present");
413 my $package = $self->name;
415 my $super_body = $package->can($name)
416 or $self->throw_error("You cannot override '$name' because it has no super method");
418 $self->add_method($name => sub {
419 local $Mouse::SUPER_PACKAGE = $package;
420 local $Mouse::SUPER_BODY = $super_body;
421 local @Mouse::SUPER_ARGS = @_;
428 sub add_augment_method_modifier {
429 my ($self, $name, $code) = @_;
430 if($self->has_method($name)){
431 $self->throw_error("Cannot add an augment method if a local method is already present");
434 my $super = $self->find_method_by_name($name)
435 or $self->throw_error("You cannot augment '$name' because it has no super method");
437 my $super_package = $super->package_name;
438 my $super_body = $super->body;
440 $self->add_method($name => sub{
441 local $Mouse::INNER_BODY{$super_package} = $code;
442 local $Mouse::INNER_ARGS{$super_package} = [@_];
449 my ($self, $role_name) = @_;
452 || $self->throw_error("You must supply a role name to look for");
454 for my $class ($self->linearized_isa) {
455 my $meta = Mouse::Util::get_metaclass_by_name($class)
458 for my $role (@{ $meta->roles }) {
460 return 1 if $role->does_role($role_name);
472 Mouse::Meta::Class - The Mouse class metaclass
476 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
478 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
479 one instance should exist for a given class.
481 =head2 C<< name -> ClassName >>
483 Returns the name of the owner class.
485 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
487 Gets (or sets) the list of superclasses of the owner class.
489 =head2 C<< add_method(name => CodeRef) >>
491 Adds a method to the owner class.
493 =head2 C<< has_method(name) -> Bool >>
495 Returns whether we have a method with the given name.
497 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
499 Returns a L<Mouse::Meta::Method> with the given name.
501 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
503 =head2 C<< get_method_list -> Names >>
505 Returns a list of method names which are defined in the local class.
506 If you want a list of all applicable methods for a class, use the
507 C<get_all_methods> method.
509 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
511 Return the list of all L<Mouse::Meta::Method> instances associated with
512 the class and its superclasses.
514 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
516 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
519 =head2 C<< has_attribute(Name) -> Bool >>
521 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
523 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
525 Returns the L<Mouse::Meta::Attribute> with the given name.
527 =head2 C<< get_attribute_list -> Names >>
529 Returns a list of attribute names which are defined in the local
530 class. If you want a list of all applicable attributes for a class,
531 use the C<get_all_attributes> method.
533 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
535 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
536 this class and its superclasses.
538 =head2 C<< linearized_isa -> [ClassNames] >>
540 Returns the list of classes in method dispatch order, with duplicates removed.
542 =head2 C<< new_object(Parameters) -> Instance >>
544 Creates a new instance.
546 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
548 Clones the given instance which must be an instance governed by this
551 =head2 C<< throw_error(Message, Parameters) >>
553 Throws an error with the given message.
557 L<Moose::Meta::Class>