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 $instance->{$key} = $attribute->_coerce_and_verify($args->{$from});
176 weaken($instance->{$key})
177 if ref($instance->{$key}) && $attribute->is_weak_ref;
179 if ($attribute->has_trigger) {
180 push @triggers_queue, [ $attribute->trigger, $instance->{$from} ];
184 if ($attribute->has_default || $attribute->has_builder) {
185 unless ($attribute->is_lazy) {
186 my $default = $attribute->default;
187 my $builder = $attribute->builder;
188 my $value = $builder ? $instance->$builder()
189 : ref($default) eq 'CODE' ? $instance->$default()
192 # XXX: we cannot use $attribute->set_value() because it invokes triggers.
193 $instance->{$key} = $attribute->_coerce_and_verify($value, $instance);;
195 weaken($instance->{$key})
196 if ref($instance->{$key}) && $attribute->is_weak_ref;
200 if ($attribute->is_required) {
201 $self->throw_error("Attribute (".$attribute->name.") is required");
207 foreach my $trigger_and_value(@triggers_queue){
208 my($trigger, $value) = @{$trigger_and_value};
209 $trigger->($instance, $value);
212 if($self->is_anon_class){
213 $instance->{__METACLASS__} = $self;
221 my $instance = shift;
222 my %params = (@_ == 1) ? %{$_[0]} : @_;
224 (blessed($instance) && $instance->isa($class->name))
225 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($instance)");
227 my $clone = bless { %$instance }, ref $instance;
229 foreach my $attr ($class->get_all_attributes()) {
230 if ( defined( my $init_arg = $attr->init_arg ) ) {
231 if (exists $params{$init_arg}) {
232 $clone->{ $attr->name } = $params{$init_arg};
241 my ($class, $instance, %params) = @_;
243 Carp::cluck('clone_instance has been deprecated. Use clone_object instead')
245 return $class->clone_object($instance, %params);
251 inline_constructor => 1,
252 inline_destructor => 1,
256 $self->{is_immutable}++;
258 if ($args{inline_constructor}) {
259 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
262 if ($args{inline_destructor}) {
263 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
266 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
267 # at the end of a source file.
271 sub make_mutable { not_supported }
273 sub is_immutable { $_[0]->{is_immutable} }
274 sub is_mutable { !$_[0]->{is_immutable} }
276 sub _install_modifier_pp{
277 my( $self, $into, $type, $name, $code ) = @_;
279 my $original = $into->can($name)
280 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
282 my $modifier_table = $self->{modifiers}{$name};
284 if(!$modifier_table){
285 my(@before, @after, @around, $cache, $modified);
290 for my $c (@before) { $c->(@_) }
292 if(wantarray){ # list context
293 my @rval = $cache->(@_);
295 for my $c(@after){ $c->(@_) }
298 elsif(defined wantarray){ # scalar context
299 my $rval = $cache->(@_);
301 for my $c(@after){ $c->(@_) }
307 for my $c(@after){ $c->(@_) }
312 $self->{modifiers}{$name} = $modifier_table = {
313 original => $original,
319 cache => \$cache, # cache for around modifiers
322 $self->add_method($name => $modified);
325 if($type eq 'before'){
326 unshift @{$modifier_table->{before}}, $code;
328 elsif($type eq 'after'){
329 push @{$modifier_table->{after}}, $code;
332 push @{$modifier_table->{around}}, $code;
334 my $next = ${ $modifier_table->{cache} };
335 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
341 sub _install_modifier {
342 my ( $self, $into, $type, $name, $code ) = @_;
344 # load Class::Method::Modifiers first
345 my $no_cmm_fast = do{
347 eval q{ require Class::Method::Modifiers::Fast };
353 $impl = \&_install_modifier_pp;
356 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
358 my ( $self, $into, $type, $name, $code ) = @_;
365 $self->{methods}{$name}++; # register it to the method map
370 # replace this method itself :)
372 no warnings 'redefine';
373 *_install_modifier = $impl;
376 $self->$impl( $into, $type, $name, $code );
379 sub add_before_method_modifier {
380 my ( $self, $name, $code ) = @_;
381 $self->_install_modifier( $self->name, 'before', $name, $code );
384 sub add_around_method_modifier {
385 my ( $self, $name, $code ) = @_;
386 $self->_install_modifier( $self->name, 'around', $name, $code );
389 sub add_after_method_modifier {
390 my ( $self, $name, $code ) = @_;
391 $self->_install_modifier( $self->name, 'after', $name, $code );
394 sub add_override_method_modifier {
395 my ($self, $name, $code) = @_;
397 my $package = $self->name;
399 my $body = $package->can($name)
400 or $self->throw_error("You cannot override '$name' because it has no super method");
402 $self->add_method($name => sub { $code->($package, $body, @_) });
406 my ($self, $role_name) = @_;
409 || $self->throw_error("You must supply a role name to look for");
411 for my $class ($self->linearized_isa) {
412 my $meta = Mouse::Meta::Module::get_metaclass_by_name($class);
413 next unless $meta && $meta->can('roles');
415 for my $role (@{ $meta->roles }) {
417 return 1 if $role->does_role($role_name);
430 Mouse::Meta::Class - The Mouse class metaclass
434 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
436 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
437 one instance should exist for a given class.
439 =head2 C<< name -> ClassName >>
441 Returns the name of the owner class.
443 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
445 Gets (or sets) the list of superclasses of the owner class.
447 =head2 C<< add_method(name => CodeRef) >>
449 Adds a method to the owner class.
451 =head2 C<< has_method(name) -> Bool >>
453 Returns whether we have a method with the given name.
455 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
457 Returns a L<Mouse::Meta::Method> with the given name.
459 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
461 =head2 C<< get_method_list -> Names >>
463 Returns a list of method names which are defined in the local class.
464 If you want a list of all applicable methods for a class, use the
465 C<get_all_methods> method.
467 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
469 Return the list of all L<Mouse::Meta::Method> instances associated with
470 the class and its superclasses.
472 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
474 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
477 =head2 C<< has_attribute(Name) -> Bool >>
479 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
481 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
483 Returns the L<Mouse::Meta::Attribute> with the given name.
485 =head2 C<< get_attribute_list -> Names >>
487 Returns a list of attribute names which are defined in the local
488 class. If you want a list of all applicable attributes for a class,
489 use the C<get_all_attributes> method.
491 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
493 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
494 this class and its superclasses.
496 =head2 C<< linearized_isa -> [ClassNames] >>
498 Returns the list of classes in method dispatch order, with duplicates removed.
500 =head2 C<< new_object(Parameters) -> Instance >>
502 Creates a new instance.
504 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
506 Clones the given instance which must be an instance governed by this
509 =head2 C<< throw_error(Message, Parameters) >>
511 Throws an error with the given message.
515 L<Moose::Meta::Class>