1 package Mouse::Meta::Class;
5 use Scalar::Util qw/blessed weaken/;
7 use Mouse::Util qw/:meta get_linear_isa not_supported/;
9 use Mouse::Meta::Method::Constructor;
10 use Mouse::Meta::Method::Destructor;
11 use Mouse::Meta::Module;
12 our @ISA = qw(Mouse::Meta::Module);
14 sub method_metaclass() { 'Mouse::Meta::Method' }
15 sub attribute_metaclass() { 'Mouse::Meta::Attribute' }
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 Mouse::load_class($_) for @_;
52 @{ $self->{superclasses} } = @_;
55 return @{ $self->{superclasses} };
58 sub find_method_by_name{
59 my($self, $method_name) = @_;
61 or $self->throw_error('You must define a method name to find');
62 foreach my $class( $self->linearized_isa ){
63 my $method = $self->initialize($class)->get_method($method_name);
64 return $method if defined $method;
71 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
74 sub get_all_method_names {
77 return grep { $uniq{$_}++ == 0 }
78 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
79 $self->linearized_isa;
82 sub find_attribute_by_name{
83 my($self, $name) = @_;
85 foreach my $class($self->linearized_isa){
86 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
87 $attr = $meta->get_attribute($name) and last;
100 $attr->isa('Mouse::Meta::Attribute')
101 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
109 my %args = (@_ == 1) ? %{$_[0]} : @_;
112 or $self->throw_error('You must provide a name for the attribute');
114 if ($name =~ s/^\+//) { # inherited attributes
115 my $inherited_attr = $self->find_attribute_by_name($name)
116 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
118 $attr = $inherited_attr->clone_and_inherit_options(%args);
121 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
122 $args{traits} = \@traits if @traits;
124 $attr = $attribute_class->new($name, %args);
128 weaken( $attr->{associated_class} = $self );
130 $self->{attributes}{$attr->name} = $attr;
131 $attr->install_accessors();
133 if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
134 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
139 sub compute_all_applicable_attributes {
140 Carp::cluck('compute_all_applicable_attributes() has been deprecated');
141 return shift->get_all_attributes(@_)
144 sub get_all_attributes {
148 for my $class ($self->linearized_isa) {
149 my $meta = Mouse::Util::get_metaclass_by_name($class)
152 for my $name ($meta->get_attribute_list) {
153 next if $seen{$name}++;
154 push @attr, $meta->get_attribute($name);
161 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
165 my %args = (@_ == 1 ? %{$_[0]} : @_);
167 my $object = bless {}, $self->name;
169 $self->_initialize_object($object, \%args);
173 sub _initialize_object{
174 my($self, $object, $args) = @_;
178 foreach my $attribute ($self->get_all_attributes) {
179 my $from = $attribute->init_arg;
180 my $key = $attribute->name;
182 if (defined($from) && exists($args->{$from})) {
183 $object->{$key} = $attribute->_coerce_and_verify($args->{$from});
185 weaken($object->{$key})
186 if ref($object->{$key}) && $attribute->is_weak_ref;
188 if ($attribute->has_trigger) {
189 push @triggers_queue, [ $attribute->trigger, $object->{$key} ];
193 if ($attribute->has_default || $attribute->has_builder) {
194 unless ($attribute->is_lazy) {
195 my $default = $attribute->default;
196 my $builder = $attribute->builder;
197 my $value = $builder ? $object->$builder()
198 : ref($default) eq 'CODE' ? $object->$default()
201 # XXX: we cannot use $attribute->set_value() because it invokes triggers.
202 $object->{$key} = $attribute->_coerce_and_verify($value, $object);;
204 weaken($object->{$key})
205 if ref($object->{$key}) && $attribute->is_weak_ref;
209 if ($attribute->is_required) {
210 $self->throw_error("Attribute (".$attribute->name.") is required");
216 foreach my $trigger_and_value(@triggers_queue){
217 my($trigger, $value) = @{$trigger_and_value};
218 $trigger->($object, $value);
221 if($self->is_anon_class){
222 $object->{__METACLASS__} = $self;
231 my %params = (@_ == 1) ? %{$_[0]} : @_;
233 (blessed($object) && $object->isa($class->name))
234 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
236 my $cloned = bless { %$object }, ref $object;
237 $class->_initialize_object($cloned, \%params);
243 my ($class, $instance, %params) = @_;
245 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
247 return $class->clone_object($instance, %params);
253 inline_constructor => 1,
254 inline_destructor => 1,
255 constructor_name => 'new',
259 $self->{is_immutable}++;
261 if ($args{inline_constructor}) {
262 # generate and install
263 Mouse::Meta::Method::Constructor->_generate_constructor_method($self, \%args);
266 if ($args{inline_destructor}) {
267 # generate and install
268 Mouse::Meta::Method::Destructor->_generate_destructor_method($self, \%args);
271 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
272 # at the end of a source file.
276 sub make_mutable { not_supported }
278 sub is_immutable { $_[0]->{is_immutable} }
279 sub is_mutable { !$_[0]->{is_immutable} }
281 sub _install_modifier_pp{
282 my( $self, $into, $type, $name, $code ) = @_;
284 my $original = $into->can($name)
285 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
287 my $modifier_table = $self->{modifiers}{$name};
289 if(!$modifier_table){
290 my(@before, @after, @around, $cache, $modified);
295 for my $c (@before) { $c->(@_) }
297 if(wantarray){ # list context
298 my @rval = $cache->(@_);
300 for my $c(@after){ $c->(@_) }
303 elsif(defined wantarray){ # scalar context
304 my $rval = $cache->(@_);
306 for my $c(@after){ $c->(@_) }
312 for my $c(@after){ $c->(@_) }
317 $self->{modifiers}{$name} = $modifier_table = {
318 original => $original,
324 cache => \$cache, # cache for around modifiers
327 $self->add_method($name => $modified);
330 if($type eq 'before'){
331 unshift @{$modifier_table->{before}}, $code;
333 elsif($type eq 'after'){
334 push @{$modifier_table->{after}}, $code;
337 push @{$modifier_table->{around}}, $code;
339 my $next = ${ $modifier_table->{cache} };
340 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
346 sub _install_modifier {
347 my ( $self, $into, $type, $name, $code ) = @_;
349 # load Class::Method::Modifiers first
350 my $no_cmm_fast = do{
352 eval q{ require Class::Method::Modifiers::Fast };
358 $impl = \&_install_modifier_pp;
361 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
363 my ( $self, $into, $type, $name, $code ) = @_;
370 $self->{methods}{$name}++; # register it to the method map
375 # replace this method itself :)
377 no warnings 'redefine';
378 *_install_modifier = $impl;
381 $self->$impl( $into, $type, $name, $code );
384 sub add_before_method_modifier {
385 my ( $self, $name, $code ) = @_;
386 $self->_install_modifier( $self->name, 'before', $name, $code );
389 sub add_around_method_modifier {
390 my ( $self, $name, $code ) = @_;
391 $self->_install_modifier( $self->name, 'around', $name, $code );
394 sub add_after_method_modifier {
395 my ( $self, $name, $code ) = @_;
396 $self->_install_modifier( $self->name, 'after', $name, $code );
399 sub add_override_method_modifier {
400 my ($self, $name, $code) = @_;
402 if($self->has_method($name)){
403 $self->throw_error("Cannot add an override method if a local method is already present");
406 my $package = $self->name;
408 my $super_body = $package->can($name)
409 or $self->throw_error("You cannot override '$name' because it has no super method");
411 $self->add_method($name => sub {
412 local $Mouse::SUPER_PACKAGE = $package;
413 local $Mouse::SUPER_BODY = $super_body;
414 local @Mouse::SUPER_ARGS = @_;
421 sub add_augment_method_modifier {
422 my ($self, $name, $code) = @_;
423 if($self->has_method($name)){
424 $self->throw_error("Cannot add an augment method if a local method is already present");
427 my $super = $self->find_method_by_name($name)
428 or $self->throw_error("You cannot augment '$name' because it has no super method");
430 my $super_package = $super->package_name;
431 my $super_body = $super->body;
433 $self->add_method($name => sub{
434 local $Mouse::INNER_BODY{$super_package} = $code;
435 local $Mouse::INNER_ARGS{$super_package} = [@_];
442 my ($self, $role_name) = @_;
445 || $self->throw_error("You must supply a role name to look for");
447 for my $class ($self->linearized_isa) {
448 my $meta = Mouse::Util::get_metaclass_by_name($class);
449 next unless $meta && $meta->can('roles');
451 for my $role (@{ $meta->roles }) {
453 return 1 if $role->does_role($role_name);
466 Mouse::Meta::Class - The Mouse class metaclass
470 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
472 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
473 one instance should exist for a given class.
475 =head2 C<< name -> ClassName >>
477 Returns the name of the owner class.
479 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
481 Gets (or sets) the list of superclasses of the owner class.
483 =head2 C<< add_method(name => CodeRef) >>
485 Adds a method to the owner class.
487 =head2 C<< has_method(name) -> Bool >>
489 Returns whether we have a method with the given name.
491 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
493 Returns a L<Mouse::Meta::Method> with the given name.
495 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
497 =head2 C<< get_method_list -> Names >>
499 Returns a list of method names which are defined in the local class.
500 If you want a list of all applicable methods for a class, use the
501 C<get_all_methods> method.
503 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
505 Return the list of all L<Mouse::Meta::Method> instances associated with
506 the class and its superclasses.
508 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
510 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
513 =head2 C<< has_attribute(Name) -> Bool >>
515 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
517 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
519 Returns the L<Mouse::Meta::Attribute> with the given name.
521 =head2 C<< get_attribute_list -> Names >>
523 Returns a list of attribute names which are defined in the local
524 class. If you want a list of all applicable attributes for a class,
525 use the C<get_all_attributes> method.
527 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
529 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
530 this class and its superclasses.
532 =head2 C<< linearized_isa -> [ClassNames] >>
534 Returns the list of classes in method dispatch order, with duplicates removed.
536 =head2 C<< new_object(Parameters) -> Instance >>
538 Creates a new instance.
540 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
542 Clones the given instance which must be an instance governed by this
545 =head2 C<< throw_error(Message, Parameters) >>
547 Throws an error with the given message.
551 L<Moose::Meta::Class>