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;
90 $attr->isa('Mouse::Meta::Attribute')
91 || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
99 my %args = (@_ == 1) ? %{$_[0]} : @_;
102 or $self->throw_error('You must provide a name for the attribute');
104 if ($name =~ s/^\+//) { # inherited attributes
107 # find_attribute_by_name
108 foreach my $class($self->linearized_isa){
109 my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
110 $inherited_attr = $meta->get_attribute($name) and last;
113 defined($inherited_attr)
114 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
116 $attr = $inherited_attr->clone_and_inherit_options(%args);
119 my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
120 $args{traits} = \@traits if @traits;
122 $attr = $attribute_class->new($name, %args);
126 weaken( $attr->{associated_class} = $self );
128 $self->{attributes}{$attr->name} = $attr;
129 $attr->install_accessors();
131 if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
132 Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
137 sub compute_all_applicable_attributes {
138 Carp::cluck('compute_all_applicable_attributes() has been deprecated');
139 return shift->get_all_attributes(@_)
142 sub get_all_attributes {
146 for my $class ($self->linearized_isa) {
147 my $meta = Mouse::Util::get_metaclass_by_name($class)
150 for my $name ($meta->get_attribute_list) {
151 next if $seen{$name}++;
152 push @attr, $meta->get_attribute($name);
159 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
163 my %args = (@_ == 1 ? %{$_[0]} : @_);
165 my $object = bless {}, $self->name;
167 $self->_initialize_object($object, \%args);
171 sub _initialize_object{
172 my($self, $object, $args) = @_;
176 foreach my $attribute ($self->get_all_attributes) {
177 my $from = $attribute->init_arg;
178 my $key = $attribute->name;
180 if (defined($from) && exists($args->{$from})) {
181 $object->{$key} = $attribute->_coerce_and_verify($args->{$from});
183 weaken($object->{$key})
184 if ref($object->{$key}) && $attribute->is_weak_ref;
186 if ($attribute->has_trigger) {
187 push @triggers_queue, [ $attribute->trigger, $object->{$key} ];
191 if ($attribute->has_default || $attribute->has_builder) {
192 unless ($attribute->is_lazy) {
193 my $default = $attribute->default;
194 my $builder = $attribute->builder;
195 my $value = $builder ? $object->$builder()
196 : ref($default) eq 'CODE' ? $object->$default()
199 # XXX: we cannot use $attribute->set_value() because it invokes triggers.
200 $object->{$key} = $attribute->_coerce_and_verify($value, $object);;
202 weaken($object->{$key})
203 if ref($object->{$key}) && $attribute->is_weak_ref;
207 if ($attribute->is_required) {
208 $self->throw_error("Attribute (".$attribute->name.") is required");
214 foreach my $trigger_and_value(@triggers_queue){
215 my($trigger, $value) = @{$trigger_and_value};
216 $trigger->($object, $value);
219 if($self->is_anon_class){
220 $object->{__METACLASS__} = $self;
229 my %params = (@_ == 1) ? %{$_[0]} : @_;
231 (blessed($object) && $object->isa($class->name))
232 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
234 my $cloned = bless { %$object }, ref $object;
235 $class->_initialize_object($cloned, \%params);
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,
253 constructor_name => 'new',
257 $self->{is_immutable}++;
259 if ($args{inline_constructor}) {
260 # generate and install
261 Mouse::Meta::Method::Constructor->_generate_constructor_method($self, \%args);
264 if ($args{inline_destructor}) {
265 # generate and install
266 Mouse::Meta::Method::Destructor->_generate_destructor_method($self, \%args);
269 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
270 # at the end of a source file.
274 sub make_mutable { not_supported }
276 sub is_immutable { $_[0]->{is_immutable} }
277 sub is_mutable { !$_[0]->{is_immutable} }
279 sub _install_modifier_pp{
280 my( $self, $into, $type, $name, $code ) = @_;
282 my $original = $into->can($name)
283 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
285 my $modifier_table = $self->{modifiers}{$name};
287 if(!$modifier_table){
288 my(@before, @after, @around, $cache, $modified);
293 for my $c (@before) { $c->(@_) }
295 if(wantarray){ # list context
296 my @rval = $cache->(@_);
298 for my $c(@after){ $c->(@_) }
301 elsif(defined wantarray){ # scalar context
302 my $rval = $cache->(@_);
304 for my $c(@after){ $c->(@_) }
310 for my $c(@after){ $c->(@_) }
315 $self->{modifiers}{$name} = $modifier_table = {
316 original => $original,
322 cache => \$cache, # cache for around modifiers
325 $self->add_method($name => $modified);
328 if($type eq 'before'){
329 unshift @{$modifier_table->{before}}, $code;
331 elsif($type eq 'after'){
332 push @{$modifier_table->{after}}, $code;
335 push @{$modifier_table->{around}}, $code;
337 my $next = ${ $modifier_table->{cache} };
338 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
344 sub _install_modifier {
345 my ( $self, $into, $type, $name, $code ) = @_;
347 # load Class::Method::Modifiers first
348 my $no_cmm_fast = do{
350 eval q{ require Class::Method::Modifiers::Fast };
356 $impl = \&_install_modifier_pp;
359 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
361 my ( $self, $into, $type, $name, $code ) = @_;
368 $self->{methods}{$name}++; # register it to the method map
373 # replace this method itself :)
375 no warnings 'redefine';
376 *_install_modifier = $impl;
379 $self->$impl( $into, $type, $name, $code );
382 sub add_before_method_modifier {
383 my ( $self, $name, $code ) = @_;
384 $self->_install_modifier( $self->name, 'before', $name, $code );
387 sub add_around_method_modifier {
388 my ( $self, $name, $code ) = @_;
389 $self->_install_modifier( $self->name, 'around', $name, $code );
392 sub add_after_method_modifier {
393 my ( $self, $name, $code ) = @_;
394 $self->_install_modifier( $self->name, 'after', $name, $code );
397 sub add_override_method_modifier {
398 my ($self, $name, $code) = @_;
400 if($self->has_method($name)){
401 $self->throw_error("Cannot add an override method if a local method is already present");
404 my $package = $self->name;
406 my $super_body = $package->can($name)
407 or $self->throw_error("You cannot override '$name' because it has no super method");
409 $self->add_method($name => sub {
410 local $Mouse::SUPER_PACKAGE = $package;
411 local $Mouse::SUPER_BODY = $super_body;
412 local @Mouse::SUPER_ARGS = @_;
419 sub add_augment_method_modifier {
420 my ($self, $name, $code) = @_;
421 if($self->has_method($name)){
422 $self->throw_error("Cannot add an augment method if a local method is already present");
425 my $super = $self->find_method_by_name($name)
426 or $self->throw_error("You cannot augment '$name' because it has no super method");
428 my $super_package = $super->package_name;
429 my $super_body = $super->body;
431 $self->add_method($name => sub{
432 local $Mouse::INNER_BODY{$super_package} = $code;
433 local $Mouse::INNER_ARGS{$super_package} = [@_];
440 my ($self, $role_name) = @_;
443 || $self->throw_error("You must supply a role name to look for");
445 for my $class ($self->linearized_isa) {
446 my $meta = Mouse::Util::get_metaclass_by_name($class);
447 next unless $meta && $meta->can('roles');
449 for my $role (@{ $meta->roles }) {
451 return 1 if $role->does_role($role_name);
464 Mouse::Meta::Class - The Mouse class metaclass
468 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
470 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
471 one instance should exist for a given class.
473 =head2 C<< name -> ClassName >>
475 Returns the name of the owner class.
477 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
479 Gets (or sets) the list of superclasses of the owner class.
481 =head2 C<< add_method(name => CodeRef) >>
483 Adds a method to the owner class.
485 =head2 C<< has_method(name) -> Bool >>
487 Returns whether we have a method with the given name.
489 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
491 Returns a L<Mouse::Meta::Method> with the given name.
493 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
495 =head2 C<< get_method_list -> Names >>
497 Returns a list of method names which are defined in the local class.
498 If you want a list of all applicable methods for a class, use the
499 C<get_all_methods> method.
501 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
503 Return the list of all L<Mouse::Meta::Method> instances associated with
504 the class and its superclasses.
506 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
508 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
511 =head2 C<< has_attribute(Name) -> Bool >>
513 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
515 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
517 Returns the L<Mouse::Meta::Attribute> with the given name.
519 =head2 C<< get_attribute_list -> Names >>
521 Returns a list of attribute names which are defined in the local
522 class. If you want a list of all applicable attributes for a class,
523 use the C<get_all_attributes> method.
525 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
527 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
528 this class and its superclasses.
530 =head2 C<< linearized_isa -> [ClassNames] >>
532 Returns the list of classes in method dispatch order, with duplicates removed.
534 =head2 C<< new_object(Parameters) -> Instance >>
536 Creates a new instance.
538 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
540 Clones the given instance which must be an instance governed by this
543 =head2 C<< throw_error(Message, Parameters) >>
545 Throws an error with the given message.
549 L<Moose::Meta::Class>