1 package Mouse::Meta::Class;
5 use Scalar::Util qw/blessed weaken/;
7 use Mouse::Util qw/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(!$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');
254 return $class->clone_object($instance, %params);
260 inline_constructor => 1,
261 inline_destructor => 1,
265 $self->{is_immutable}++;
267 if ($args{inline_constructor}) {
268 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
271 if ($args{inline_destructor}) {
272 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
275 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
276 # at the end of a source file.
280 sub make_mutable { not_supported }
282 sub is_immutable { $_[0]->{is_immutable} }
283 sub is_mutable { !$_[0]->{is_immutable} }
285 sub _install_modifier_pp{
286 my( $self, $into, $type, $name, $code ) = @_;
288 my $original = $into->can($name)
289 or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
291 my $modifier_table = $self->{modifiers}{$name};
293 if(!$modifier_table){
294 my(@before, @after, @around, $cache, $modified);
299 for my $c (@before) { $c->(@_) }
301 if(wantarray){ # list context
302 my @rval = $cache->(@_);
304 for my $c(@after){ $c->(@_) }
307 elsif(defined wantarray){ # scalar context
308 my $rval = $cache->(@_);
310 for my $c(@after){ $c->(@_) }
316 for my $c(@after){ $c->(@_) }
321 $self->{modifiers}{$name} = $modifier_table = {
322 original => $original,
328 cache => \$cache, # cache for around modifiers
331 $self->add_method($name => $modified);
334 if($type eq 'before'){
335 unshift @{$modifier_table->{before}}, $code;
337 elsif($type eq 'after'){
338 push @{$modifier_table->{after}}, $code;
341 push @{$modifier_table->{around}}, $code;
343 my $next = ${ $modifier_table->{cache} };
344 ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
350 sub _install_modifier {
351 my ( $self, $into, $type, $name, $code ) = @_;
353 # load Class::Method::Modifiers first
354 my $no_cmm_fast = do{
356 eval q{ require Class::Method::Modifiers::Fast };
362 $impl = \&_install_modifier_pp;
365 my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier');
367 my ( $self, $into, $type, $name, $code ) = @_;
374 $self->{methods}{$name}++; # register it to the method map
379 # replace this method itself :)
381 no warnings 'redefine';
382 *_install_modifier = $impl;
385 $self->$impl( $into, $type, $name, $code );
388 sub add_before_method_modifier {
389 my ( $self, $name, $code ) = @_;
390 $self->_install_modifier( $self->name, 'before', $name, $code );
393 sub add_around_method_modifier {
394 my ( $self, $name, $code ) = @_;
395 $self->_install_modifier( $self->name, 'around', $name, $code );
398 sub add_after_method_modifier {
399 my ( $self, $name, $code ) = @_;
400 $self->_install_modifier( $self->name, 'after', $name, $code );
403 sub add_override_method_modifier {
404 my ($self, $name, $code) = @_;
406 my $package = $self->name;
408 my $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 { $code->($package, $body, @_) });
415 my ($self, $role_name) = @_;
418 || $self->throw_error("You must supply a role name to look for");
420 for my $class ($self->linearized_isa) {
421 my $meta = Mouse::Meta::Module::class_of($class);
422 next unless $meta && $meta->can('roles');
424 for my $role (@{ $meta->roles }) {
426 return 1 if $role->does_role($role_name);
439 Mouse::Meta::Class - The Mouse class metaclass
443 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
445 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
446 one instance should exist for a given class.
448 =head2 C<< name -> ClassName >>
450 Returns the name of the owner class.
452 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
454 Gets (or sets) the list of superclasses of the owner class.
456 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
458 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
461 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
463 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
464 this class and its superclasses.
466 =head2 C<< get_attribute_list -> { name => Mouse::Meta::Attribute } >>
468 This returns a list of attribute names which are defined in the local
469 class. If you want a list of all applicable attributes for a class,
470 use the C<get_all_attributes> method.
472 =head2 C<< has_attribute(Name) -> Bool >>
474 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
476 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
478 Returns the L<Mouse::Meta::Attribute> with the given name.
480 =head2 C<< linearized_isa -> [ClassNames] >>
482 Returns the list of classes in method dispatch order, with duplicates removed.
484 =head2 C<< new_object(Parameters) -> Instance >>
486 Creates a new instance.
488 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
490 Clones the given C<Instance> which must be an instance governed by this
495 L<Moose::Meta::Class>