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' } # required for get_method()
17 my($class, %args) = @_;
19 $args{attributes} ||= {};
20 $args{methods} ||= {};
23 $args{superclasses} = do {
25 \@{ $args{package} . '::ISA' };
28 #return Mouse::Meta::Class->initialize($class)->new_object(%args)
29 # if $class ne __PACKAGE__;
31 return bless \%args, ref($class) || $class;
34 sub create_anon_class{
36 return $self->create(undef, @_);
40 return exists $_[0]->{anon_serial_id};
43 sub roles { $_[0]->{roles} }
49 Mouse::load_class($_) for @_;
50 @{ $self->{superclasses} } = @_;
53 return @{ $self->{superclasses} };
56 sub find_method_by_name{
57 my($self, $method_name) = @_;
59 or $self->throw_error('You must define a method name to find');
60 foreach my $class( $self->linearized_isa ){
61 my $method = $self->initialize($class)->get_method($method_name);
62 return $method if defined $method;
69 return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
72 sub get_all_method_names {
75 return grep { $uniq{$_}++ == 0 }
76 map { Mouse::Meta::Class->initialize($_)->get_method_list() }
77 $self->linearized_isa;
88 $attr->isa('Mouse::Meta::Attribute')
89 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
97 my %args = (@_ == 1) ? %{$_[0]} : @_;
100 or $self->throw_error('You must provide a name for the attribute');
102 if ($name =~ s/^\+//) { # inherited attributes
105 foreach my $class($self->linearized_isa){
106 my $meta = Mouse::Meta::Module::get_metaclass_by_name($class) or next;
107 $inherited_attr = $meta->get_attribute($name) and last;
110 defined($inherited_attr)
111 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
113 $attr = $inherited_attr->clone_and_inherit_options($name, \%args);
116 my($attribute_class, @traits) = Mouse::Meta::Attribute->interpolate_class($name, \%args);
117 $args{traits} = \@traits if @traits;
119 $attr = $attribute_class->new($name, \%args);
123 weaken( $attr->{associated_class} = $self );
125 $self->{attributes}{$attr->name} = $attr;
126 $attr->install_accessors();
128 if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
129 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
134 sub compute_all_applicable_attributes { shift->get_all_attributes(@_) }
135 sub get_all_attributes {
139 for my $class ($self->linearized_isa) {
140 my $meta = $self->_metaclass_cache($class)
143 for my $name (keys %{ $meta->get_attribute_map }) {
144 next if $seen{$name}++;
145 push @attr, $meta->get_attribute($name);
152 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
156 my %args = (@_ == 1 ? %{$_[0]} : @_);
158 my $instance = bless {}, $self->name;
160 $self->_initialize_instance($instance, \%args);
164 sub _initialize_instance{
165 my($self, $instance, $args) = @_;
169 foreach my $attribute ($self->get_all_attributes) {
170 my $from = $attribute->init_arg;
171 my $key = $attribute->name;
173 if (defined($from) && exists($args->{$from})) {
174 $args->{$from} = $attribute->coerce_constraint($args->{$from})
175 if $attribute->should_coerce;
177 $attribute->verify_against_type_constraint($args->{$from});
179 $instance->{$key} = $args->{$from};
181 weaken($instance->{$key})
182 if ref($instance->{$key}) && $attribute->is_weak_ref;
184 if ($attribute->has_trigger) {
185 push @triggers_queue, [ $attribute->trigger, $args->{$from} ];
189 if ($attribute->has_default || $attribute->has_builder) {
190 unless ($attribute->is_lazy) {
191 my $default = $attribute->default;
192 my $builder = $attribute->builder;
193 my $value = $attribute->has_builder
194 ? $instance->$builder
195 : ref($default) eq 'CODE'
196 ? $default->($instance)
199 $value = $attribute->coerce_constraint($value)
200 if $attribute->should_coerce;
201 $attribute->verify_against_type_constraint($value);
203 $instance->{$key} = $value;
205 weaken($instance->{$key})
206 if ref($instance->{$key}) && $attribute->is_weak_ref;
210 if ($attribute->is_required) {
211 $self->throw_error("Attribute (".$attribute->name.") is required");
217 foreach my $trigger_and_value(@triggers_queue){
218 my($trigger, $value) = @{$trigger_and_value};
219 $trigger->($instance, $value);
222 if($self->is_anon_class){
223 $instance->{__METACLASS__} = $self;
231 my $instance = shift;
232 my %params = (@_ == 1) ? %{$_[0]} : @_;
234 (blessed($instance) && $instance->isa($class->name))
235 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($instance)");
237 my $clone = bless { %$instance }, ref $instance;
239 foreach my $attr ($class->get_all_attributes()) {
240 if ( defined( my $init_arg = $attr->init_arg ) ) {
241 if (exists $params{$init_arg}) {
242 $clone->{ $attr->name } = $params{$init_arg};
251 my ($class, $instance, %params) = @_;
253 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
255 return $class->clone_object($instance, %params);
261 inline_constructor => 1,
262 inline_destructor => 1,
266 $self->{is_immutable}++;
268 if ($args{inline_constructor}) {
269 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
272 if ($args{inline_destructor}) {
273 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
276 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
277 # at the end of a source file.
281 sub make_mutable { not_supported }
283 sub is_immutable { $_[0]->{is_immutable} }
284 sub is_mutable { !$_[0]->{is_immutable} }
286 sub _install_modifier_pp{
287 my( $self, $into, $type, $name, $code ) = @_;
289 my $original = $into->can($name)
290 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
292 my $modifier_table = $self->{modifiers}{$name};
294 if(!$modifier_table){
295 my(@before, @after, @around, $cache, $modified);
300 for my $c (@before) { $c->(@_) }
302 if(wantarray){ # list context
303 my @rval = $cache->(@_);
305 for my $c(@after){ $c->(@_) }
308 elsif(defined wantarray){ # scalar context
309 my $rval = $cache->(@_);
311 for my $c(@after){ $c->(@_) }
317 for my $c(@after){ $c->(@_) }
322 $self->{modifiers}{$name} = $modifier_table = {
323 original => $original,
329 cache => \$cache, # cache for around modifiers
332 $self->add_method($name => $modified);
335 if($type eq 'before'){
336 unshift @{$modifier_table->{before}}, $code;
338 elsif($type eq 'after'){
339 push @{$modifier_table->{after}}, $code;
342 push @{$modifier_table->{around}}, $code;
344 my $next = ${ $modifier_table->{cache} };
345 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
351 sub _install_modifier {
352 my ( $self, $into, $type, $name, $code ) = @_;
354 # load Class::Method::Modifiers first
355 my $no_cmm_fast = do{
357 eval q{ require Class::Method::Modifiers::Fast };
363 $impl = \&_install_modifier_pp;
366 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
368 my ( $self, $into, $type, $name, $code ) = @_;
375 $self->{methods}{$name}++; # register it to the method map
380 # replace this method itself :)
382 no warnings 'redefine';
383 *_install_modifier = $impl;
386 $self->$impl( $into, $type, $name, $code );
389 sub add_before_method_modifier {
390 my ( $self, $name, $code ) = @_;
391 $self->_install_modifier( $self->name, 'before', $name, $code );
394 sub add_around_method_modifier {
395 my ( $self, $name, $code ) = @_;
396 $self->_install_modifier( $self->name, 'around', $name, $code );
399 sub add_after_method_modifier {
400 my ( $self, $name, $code ) = @_;
401 $self->_install_modifier( $self->name, 'after', $name, $code );
404 sub add_override_method_modifier {
405 my ($self, $name, $code) = @_;
407 my $package = $self->name;
409 my $body = $package->can($name)
410 or $self->throw_error("You cannot override '$name' because it has no super method");
412 $self->add_method($name => sub { $code->($package, $body, @_) });
416 my ($self, $role_name) = @_;
419 || $self->throw_error("You must supply a role name to look for");
421 for my $class ($self->linearized_isa) {
422 my $meta = Mouse::Meta::Module::class_of($class);
423 next unless $meta && $meta->can('roles');
425 for my $role (@{ $meta->roles }) {
427 return 1 if $role->does_role($role_name);
440 Mouse::Meta::Class - The Mouse class metaclass
444 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
446 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
447 one instance should exist for a given class.
449 =head2 C<< name -> ClassName >>
451 Returns the name of the owner class.
453 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
455 Gets (or sets) the list of superclasses of the owner class.
457 =head2 C<< add_method(name => CodeRef) >>
459 Adds a method to the owner class.
461 =head2 C<< has_method(name) -> Bool >>
463 Returns whether we have a method with the given name.
465 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
467 Returns a L<Mouse::Meta::Method> with the given name.
469 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
471 =head2 C<< get_method_list -> Names >>
473 Returns a list of method names which are defined in the local class.
474 If you want a list of all applicable methods for a class, use the
475 C<get_all_methods> method.
477 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
479 Return the list of all L<Mouse::Meta::Method> instances associated with
480 the class and its superclasses.
482 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
484 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
487 =head2 C<< has_attribute(Name) -> Bool >>
489 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
491 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
493 Returns the L<Mouse::Meta::Attribute> with the given name.
495 =head2 C<< get_attribute_list -> Names >>
497 Returns a list of attribute names which are defined in the local
498 class. If you want a list of all applicable attributes for a class,
499 use the C<get_all_attributes> method.
501 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
503 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
504 this class and its superclasses.
506 =head2 C<< linearized_isa -> [ClassNames] >>
508 Returns the list of classes in method dispatch order, with duplicates removed.
510 =head2 C<< new_object(Parameters) -> Instance >>
512 Creates a new instance.
514 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
516 Clones the given instance which must be an instance governed by this
519 =head2 C<< throw_error(Message, Parameters) >>
521 Throws an error with the given message.
525 L<Moose::Meta::Class>