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');
69 foreach my $class( $self->linearized_isa ){
70 my $method = $self->initialize($class)->get_method($method_name);
71 return $method if defined $method;
78 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
81 sub get_all_method_names {
84 return grep { $uniq{$_}++ == 0 }
85 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
86 $self->linearized_isa;
89 sub find_attribute_by_name{
90 my($self, $name) = @_;
92 foreach my $class($self->linearized_isa){
93 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
94 $attr = $meta->get_attribute($name) and last;
107 $attr->isa('Mouse::Meta::Attribute')
108 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
116 my %args = (@_ == 1) ? %{$_[0]} : @_;
119 or $self->throw_error('You must provide a name for the attribute');
121 if ($name =~ s/^\+//) { # inherited attributes
122 my $inherited_attr = $self->find_attribute_by_name($name)
123 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
125 $attr = $inherited_attr->clone_and_inherit_options(%args);
128 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
129 $args{traits} = \@traits if @traits;
131 $attr = $attribute_class->new($name, %args);
135 weaken( $attr->{associated_class} = $self );
137 $self->{attributes}{$attr->name} = $attr;
138 $attr->install_accessors();
140 if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
141 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
146 sub compute_all_applicable_attributes {
147 Carp::cluck('compute_all_applicable_attributes() has been deprecated')
149 return shift->get_all_attributes(@_)
152 sub get_all_attributes {
156 for my $class ($self->linearized_isa) {
157 my $meta = Mouse::Util::get_metaclass_by_name($class)
160 for my $name ($meta->get_attribute_list) {
161 next if $seen{$name}++;
162 push @attr, $meta->get_attribute($name);
169 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
173 my %args = (@_ == 1 ? %{$_[0]} : @_);
175 my $object = bless {}, $self->name;
177 $self->_initialize_object($object, \%args);
181 sub _initialize_object{
182 my($self, $object, $args) = @_;
186 foreach my $attribute ($self->get_all_attributes) {
187 my $from = $attribute->init_arg;
188 my $key = $attribute->name;
190 if (defined($from) && exists($args->{$from})) {
191 $object->{$key} = $attribute->_coerce_and_verify($args->{$from}, $object);
193 weaken($object->{$key})
194 if ref($object->{$key}) && $attribute->is_weak_ref;
196 if ($attribute->has_trigger) {
197 push @triggers_queue, [ $attribute->trigger, $object->{$key} ];
201 if ($attribute->has_default || $attribute->has_builder) {
202 unless ($attribute->is_lazy) {
203 my $default = $attribute->default;
204 my $builder = $attribute->builder;
205 my $value = $builder ? $object->$builder()
206 : ref($default) eq 'CODE' ? $object->$default()
209 $object->{$key} = $attribute->_coerce_and_verify($value, $object);
211 weaken($object->{$key})
212 if ref($object->{$key}) && $attribute->is_weak_ref;
216 if ($attribute->is_required) {
217 $self->throw_error("Attribute (".$attribute->name.") is required");
223 foreach my $trigger_and_value(@triggers_queue){
224 my($trigger, $value) = @{$trigger_and_value};
225 $trigger->($object, $value);
228 if($self->is_anon_class){
229 $object->{__METACLASS__} = $self;
238 my %params = (@_ == 1) ? %{$_[0]} : @_;
240 (blessed($object) && $object->isa($class->name))
241 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
243 my $cloned = bless { %$object }, ref $object;
244 $class->_initialize_object($cloned, \%params);
250 my ($class, $instance, %params) = @_;
252 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
254 return $class->clone_object($instance, %params);
260 inline_constructor => 1,
261 inline_destructor => 1,
262 constructor_name => 'new',
266 $self->{is_immutable}++;
268 if ($args{inline_constructor}) {
269 $self->add_method($args{constructor_name} =>
270 $self->constructor_class->_generate_constructor($self, \%args));
273 if ($args{inline_destructor}) {
274 $self->add_method(DESTROY =>
275 $self->destructor_class->_generate_destructor($self, \%args));
278 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
279 # at the end of a source file.
283 sub make_mutable { not_supported }
285 sub is_immutable { $_[0]->{is_immutable} }
286 sub is_mutable { !$_[0]->{is_immutable} }
288 sub _install_modifier_pp{
289 my( $self, $type, $name, $code ) = @_;
290 my $into = $self->name;
292 my $original = $into->can($name)
293 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
295 my $modifier_table = $self->{modifiers}{$name};
297 if(!$modifier_table){
298 my(@before, @after, @around, $cache, $modified);
303 for my $c (@before) { $c->(@_) }
305 if(wantarray){ # list context
306 my @rval = $cache->(@_);
308 for my $c(@after){ $c->(@_) }
311 elsif(defined wantarray){ # scalar context
312 my $rval = $cache->(@_);
314 for my $c(@after){ $c->(@_) }
320 for my $c(@after){ $c->(@_) }
325 $self->{modifiers}{$name} = $modifier_table = {
326 original => $original,
332 cache => \$cache, # cache for around modifiers
335 $self->add_method($name => $modified);
338 if($type eq 'before'){
339 unshift @{$modifier_table->{before}}, $code;
341 elsif($type eq 'after'){
342 push @{$modifier_table->{after}}, $code;
345 push @{$modifier_table->{around}}, $code;
347 my $next = ${ $modifier_table->{cache} };
348 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
354 sub _install_modifier {
355 my ( $self, $type, $name, $code ) = @_;
357 # load Class::Method::Modifiers first
358 my $no_cmm_fast = do{
360 eval q{ require Class::Method::Modifiers::Fast };
366 $impl = \&_install_modifier_pp;
369 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
371 my ( $self, $type, $name, $code ) = @_;
372 my $into = $self->name;
373 $install_modifier->($into, $type, $name, $code);
375 $self->add_method($name => do{
377 \&{ $into . '::' . $name };
383 # replace this method itself :)
385 no warnings 'redefine';
386 *_install_modifier = $impl;
389 $self->$impl( $type, $name, $code );
392 sub add_before_method_modifier {
393 my ( $self, $name, $code ) = @_;
394 $self->_install_modifier( 'before', $name, $code );
397 sub add_around_method_modifier {
398 my ( $self, $name, $code ) = @_;
399 $self->_install_modifier( 'around', $name, $code );
402 sub add_after_method_modifier {
403 my ( $self, $name, $code ) = @_;
404 $self->_install_modifier( 'after', $name, $code );
407 sub add_override_method_modifier {
408 my ($self, $name, $code) = @_;
410 if($self->has_method($name)){
411 $self->throw_error("Cannot add an override method if a local method is already present");
414 my $package = $self->name;
416 my $super_body = $package->can($name)
417 or $self->throw_error("You cannot override '$name' because it has no super method");
419 $self->add_method($name => sub {
420 local $Mouse::SUPER_PACKAGE = $package;
421 local $Mouse::SUPER_BODY = $super_body;
422 local @Mouse::SUPER_ARGS = @_;
429 sub add_augment_method_modifier {
430 my ($self, $name, $code) = @_;
431 if($self->has_method($name)){
432 $self->throw_error("Cannot add an augment method if a local method is already present");
435 my $super = $self->find_method_by_name($name)
436 or $self->throw_error("You cannot augment '$name' because it has no super method");
438 my $super_package = $super->package_name;
439 my $super_body = $super->body;
441 $self->add_method($name => sub{
442 local $Mouse::INNER_BODY{$super_package} = $code;
443 local $Mouse::INNER_ARGS{$super_package} = [@_];
450 my ($self, $role_name) = @_;
453 || $self->throw_error("You must supply a role name to look for");
455 for my $class ($self->linearized_isa) {
456 my $meta = Mouse::Util::get_metaclass_by_name($class)
459 for my $role (@{ $meta->roles }) {
461 return 1 if $role->does_role($role_name);
473 Mouse::Meta::Class - The Mouse class metaclass
477 This document describes Mouse version 0.37_06
481 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
483 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
484 one instance should exist for a given class.
486 =head2 C<< name -> ClassName >>
488 Returns the name of the owner class.
490 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
492 Gets (or sets) the list of superclasses of the owner class.
494 =head2 C<< add_method(name => CodeRef) >>
496 Adds a method to the owner class.
498 =head2 C<< has_method(name) -> Bool >>
500 Returns whether we have a method with the given name.
502 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
504 Returns a L<Mouse::Meta::Method> with the given name.
506 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
508 =head2 C<< get_method_list -> Names >>
510 Returns a list of method names which are defined in the local class.
511 If you want a list of all applicable methods for a class, use the
512 C<get_all_methods> method.
514 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
516 Return the list of all L<Mouse::Meta::Method> instances associated with
517 the class and its superclasses.
519 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
521 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
524 =head2 C<< has_attribute(Name) -> Bool >>
526 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
528 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
530 Returns the L<Mouse::Meta::Attribute> with the given name.
532 =head2 C<< get_attribute_list -> Names >>
534 Returns a list of attribute names which are defined in the local
535 class. If you want a list of all applicable attributes for a class,
536 use the C<get_all_attributes> method.
538 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
540 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
541 this class and its superclasses.
543 =head2 C<< linearized_isa -> [ClassNames] >>
545 Returns the list of classes in method dispatch order, with duplicates removed.
547 =head2 C<< new_object(Parameters) -> Instance >>
549 Creates a new instance.
551 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
553 Clones the given instance which must be an instance governed by this
556 =head2 C<< throw_error(Message, Parameters) >>
558 Throws an error with the given message.
562 L<Moose::Meta::Class>