Commit | Line | Data |
306290e8 |
1 | package Mouse::Meta::Class; |
bc69ee88 |
2 | use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings |
c3398f5b |
3 | |
cecfb973 |
4 | use Scalar::Util qw/blessed weaken/; |
6d28c5cf |
5 | |
6d28c5cf |
6 | use Mouse::Meta::Method::Constructor; |
7 | use Mouse::Meta::Method::Destructor; |
8 | use Mouse::Meta::Module; |
f3bb863f |
9 | our @ISA = qw(Mouse::Meta::Module); |
3a63a2e7 |
10 | |
deb9a0f3 |
11 | sub method_metaclass() { 'Mouse::Meta::Method' } |
12 | sub attribute_metaclass() { 'Mouse::Meta::Attribute' } |
3a63a2e7 |
13 | |
8e64d0fa |
14 | sub _construct_meta { |
88ed7189 |
15 | my($class, %args) = @_; |
c3398f5b |
16 | |
8536d351 |
17 | $args{attributes} ||= {}; |
18 | $args{methods} ||= {}; |
19 | $args{roles} ||= []; |
20 | |
c3398f5b |
21 | $args{superclasses} = do { |
22 | no strict 'refs'; |
88ed7189 |
23 | \@{ $args{package} . '::ISA' }; |
c3398f5b |
24 | }; |
25 | |
8d40c3b8 |
26 | my $self = bless \%args, ref($class) || $class; |
7eb3a8d5 |
27 | if(ref($self) ne __PACKAGE__){ |
9009aca1 |
28 | $self->meta->_initialize_object($self, \%args); |
8d40c3b8 |
29 | } |
30 | return $self; |
7a50b450 |
31 | } |
32 | |
33 | sub create_anon_class{ |
34 | my $self = shift; |
35 | return $self->create(undef, @_); |
36 | } |
37 | |
38 | sub is_anon_class{ |
39 | return exists $_[0]->{anon_serial_id}; |
c3398f5b |
40 | } |
41 | |
afc73948 |
42 | sub roles { $_[0]->{roles} } |
c3398f5b |
43 | |
44 | sub superclasses { |
45 | my $self = shift; |
46 | |
47 | if (@_) { |
48 | Mouse::load_class($_) for @_; |
49 | @{ $self->{superclasses} } = @_; |
50 | } |
51 | |
8e64d0fa |
52 | return @{ $self->{superclasses} }; |
53 | } |
54 | |
55 | sub find_method_by_name{ |
56 | my($self, $method_name) = @_; |
57 | defined($method_name) |
58 | or $self->throw_error('You must define a method name to find'); |
59 | foreach my $class( $self->linearized_isa ){ |
60 | my $method = $self->initialize($class)->get_method($method_name); |
61 | return $method if defined $method; |
62 | } |
63 | return undef; |
64 | } |
65 | |
66 | sub get_all_methods { |
67 | my($self) = @_; |
612d3e1a |
68 | return map{ $self->find_method_by_name($_) } $self->get_all_method_names; |
c3398f5b |
69 | } |
70 | |
60cfc6ad |
71 | sub get_all_method_names { |
72 | my $self = shift; |
73 | my %uniq; |
74 | return grep { $uniq{$_}++ == 0 } |
3a63a2e7 |
75 | map { Mouse::Meta::Class->initialize($_)->get_method_list() } |
60cfc6ad |
76 | $self->linearized_isa; |
77 | } |
78 | |
2b908b79 |
79 | sub find_attribute_by_name{ |
80 | my($self, $name) = @_; |
81 | my $attr; |
82 | foreach my $class($self->linearized_isa){ |
83 | my $meta = Mouse::Util::get_metaclass_by_name($class) or next; |
84 | $attr = $meta->get_attribute($name) and last; |
85 | } |
86 | return $attr; |
87 | } |
88 | |
87ca293b |
89 | sub add_attribute { |
c3398f5b |
90 | my $self = shift; |
60f6eba9 |
91 | |
87ca293b |
92 | my($attr, $name); |
1b9e472d |
93 | |
87ca293b |
94 | if(blessed $_[0]){ |
95 | $attr = $_[0]; |
1b9e472d |
96 | |
87ca293b |
97 | $attr->isa('Mouse::Meta::Attribute') |
98 | || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)"); |
1b9e472d |
99 | |
87ca293b |
100 | $name = $attr->name; |
1b9e472d |
101 | } |
102 | else{ |
87ca293b |
103 | # _process_attribute |
104 | $name = shift; |
1b9e472d |
105 | |
87ca293b |
106 | my %args = (@_ == 1) ? %{$_[0]} : @_; |
1b9e472d |
107 | |
87ca293b |
108 | defined($name) |
109 | or $self->throw_error('You must provide a name for the attribute'); |
1b9e472d |
110 | |
87ca293b |
111 | if ($name =~ s/^\+//) { # inherited attributes |
2b908b79 |
112 | my $inherited_attr = $self->find_attribute_by_name($name) |
87ca293b |
113 | or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name); |
114 | |
8cf51b82 |
115 | $attr = $inherited_attr->clone_and_inherit_options(%args); |
87ca293b |
116 | } |
117 | else{ |
8cf51b82 |
118 | my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args); |
87ca293b |
119 | $args{traits} = \@traits if @traits; |
120 | |
2a464664 |
121 | $attr = $attribute_class->new($name, %args); |
87ca293b |
122 | } |
123 | } |
1b9e472d |
124 | |
125 | weaken( $attr->{associated_class} = $self ); |
126 | |
127 | $self->{attributes}{$attr->name} = $attr; |
128 | $attr->install_accessors(); |
129 | |
04493075 |
130 | if(_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){ |
1b9e472d |
131 | Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)}); |
60f6eba9 |
132 | } |
1b9e472d |
133 | return $attr; |
c3398f5b |
134 | } |
135 | |
3a683350 |
136 | sub compute_all_applicable_attributes { |
137 | Carp::cluck('compute_all_applicable_attributes() has been deprecated'); |
138 | return shift->get_all_attributes(@_) |
139 | } |
140 | |
d60824af |
141 | sub get_all_attributes { |
72b88a88 |
142 | my $self = shift; |
143 | my (@attr, %seen); |
144 | |
145 | for my $class ($self->linearized_isa) { |
3a683350 |
146 | my $meta = Mouse::Util::get_metaclass_by_name($class) |
72b88a88 |
147 | or next; |
148 | |
3a683350 |
149 | for my $name ($meta->get_attribute_list) { |
72b88a88 |
150 | next if $seen{$name}++; |
151 | push @attr, $meta->get_attribute($name); |
152 | } |
153 | } |
154 | |
155 | return @attr; |
156 | } |
157 | |
8536d351 |
158 | sub linearized_isa { @{ get_linear_isa($_[0]->name) } } |
159 | |
160 | sub new_object { |
c68b4110 |
161 | my $self = shift; |
7a50b450 |
162 | my %args = (@_ == 1 ? %{$_[0]} : @_); |
c3398f5b |
163 | |
926290ac |
164 | my $object = bless {}, $self->name; |
fce211ae |
165 | |
926290ac |
166 | $self->_initialize_object($object, \%args); |
167 | return $object; |
1b9e472d |
168 | } |
169 | |
926290ac |
170 | sub _initialize_object{ |
171 | my($self, $object, $args) = @_; |
1b9e472d |
172 | |
53c495ce |
173 | my @triggers_queue; |
174 | |
fce211ae |
175 | foreach my $attribute ($self->get_all_attributes) { |
8536d351 |
176 | my $from = $attribute->init_arg; |
177 | my $key = $attribute->name; |
178 | |
1b9e472d |
179 | if (defined($from) && exists($args->{$from})) { |
926290ac |
180 | $object->{$key} = $attribute->_coerce_and_verify($args->{$from}); |
8536d351 |
181 | |
926290ac |
182 | weaken($object->{$key}) |
183 | if ref($object->{$key}) && $attribute->is_weak_ref; |
8536d351 |
184 | |
185 | if ($attribute->has_trigger) { |
926290ac |
186 | push @triggers_queue, [ $attribute->trigger, $object->{$key} ]; |
8536d351 |
187 | } |
188 | } |
189 | else { |
190 | if ($attribute->has_default || $attribute->has_builder) { |
191 | unless ($attribute->is_lazy) { |
192 | my $default = $attribute->default; |
193 | my $builder = $attribute->builder; |
926290ac |
194 | my $value = $builder ? $object->$builder() |
195 | : ref($default) eq 'CODE' ? $object->$default() |
8215d725 |
196 | : $default; |
8536d351 |
197 | |
8215d725 |
198 | # XXX: we cannot use $attribute->set_value() because it invokes triggers. |
926290ac |
199 | $object->{$key} = $attribute->_coerce_and_verify($value, $object);; |
8536d351 |
200 | |
926290ac |
201 | weaken($object->{$key}) |
202 | if ref($object->{$key}) && $attribute->is_weak_ref; |
8536d351 |
203 | } |
204 | } |
205 | else { |
206 | if ($attribute->is_required) { |
fce211ae |
207 | $self->throw_error("Attribute (".$attribute->name.") is required"); |
8536d351 |
208 | } |
209 | } |
210 | } |
211 | } |
53c495ce |
212 | |
213 | foreach my $trigger_and_value(@triggers_queue){ |
214 | my($trigger, $value) = @{$trigger_and_value}; |
926290ac |
215 | $trigger->($object, $value); |
53c495ce |
216 | } |
217 | |
2efc0af1 |
218 | if($self->is_anon_class){ |
926290ac |
219 | $object->{__METACLASS__} = $self; |
2efc0af1 |
220 | } |
221 | |
926290ac |
222 | return $object; |
8536d351 |
223 | } |
c3398f5b |
224 | |
7a59f4e8 |
225 | sub clone_object { |
926290ac |
226 | my $class = shift; |
227 | my $object = shift; |
228 | my %params = (@_ == 1) ? %{$_[0]} : @_; |
7a59f4e8 |
229 | |
926290ac |
230 | (blessed($object) && $object->isa($class->name)) |
231 | || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)"); |
7a59f4e8 |
232 | |
926290ac |
233 | my $cloned = bless { %$object }, ref $object; |
234 | $class->_initialize_object($cloned, \%params); |
7a59f4e8 |
235 | |
926290ac |
236 | return $cloned; |
2cea7a5f |
237 | } |
7a59f4e8 |
238 | |
2cea7a5f |
239 | sub clone_instance { |
240 | my ($class, $instance, %params) = @_; |
241 | |
04493075 |
242 | Carp::cluck('clone_instance has been deprecated. Use clone_object instead') |
243 | if _MOUSE_VERBOSE; |
2cea7a5f |
244 | return $class->clone_object($instance, %params); |
7a59f4e8 |
245 | } |
246 | |
fc1d8369 |
247 | sub make_immutable { |
248 | my $self = shift; |
6a1d1835 |
249 | my %args = ( |
250 | inline_constructor => 1, |
e578d610 |
251 | inline_destructor => 1, |
2a464664 |
252 | constructor_name => 'new', |
6a1d1835 |
253 | @_, |
254 | ); |
255 | |
fc1d8369 |
256 | $self->{is_immutable}++; |
c7a6403f |
257 | |
6a1d1835 |
258 | if ($args{inline_constructor}) { |
2a464664 |
259 | # generate and install |
260 | Mouse::Meta::Method::Constructor->_generate_constructor_method($self, \%args); |
c7a6403f |
261 | } |
262 | |
8632b6fe |
263 | if ($args{inline_destructor}) { |
2a464664 |
264 | # generate and install |
265 | Mouse::Meta::Method::Destructor->_generate_destructor_method($self, \%args); |
8632b6fe |
266 | } |
2276cb14 |
267 | |
268 | # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value |
269 | # at the end of a source file. |
270 | return 1; |
fc1d8369 |
271 | } |
ad958001 |
272 | |
fce211ae |
273 | sub make_mutable { not_supported } |
ad958001 |
274 | |
6cfa1e5e |
275 | sub is_immutable { $_[0]->{is_immutable} } |
276 | sub is_mutable { !$_[0]->{is_immutable} } |
84ef660f |
277 | |
3fbade18 |
278 | sub _install_modifier_pp{ |
279 | my( $self, $into, $type, $name, $code ) = @_; |
280 | |
281 | my $original = $into->can($name) |
282 | or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into"); |
283 | |
284 | my $modifier_table = $self->{modifiers}{$name}; |
285 | |
286 | if(!$modifier_table){ |
287 | my(@before, @after, @around, $cache, $modified); |
288 | |
289 | $cache = $original; |
290 | |
291 | $modified = sub { |
292 | for my $c (@before) { $c->(@_) } |
293 | |
294 | if(wantarray){ # list context |
295 | my @rval = $cache->(@_); |
296 | |
297 | for my $c(@after){ $c->(@_) } |
298 | return @rval; |
299 | } |
300 | elsif(defined wantarray){ # scalar context |
301 | my $rval = $cache->(@_); |
302 | |
303 | for my $c(@after){ $c->(@_) } |
304 | return $rval; |
305 | } |
306 | else{ # void context |
307 | $cache->(@_); |
308 | |
309 | for my $c(@after){ $c->(@_) } |
310 | return; |
311 | } |
312 | }; |
313 | |
314 | $self->{modifiers}{$name} = $modifier_table = { |
315 | original => $original, |
316 | |
317 | before => \@before, |
318 | after => \@after, |
319 | around => \@around, |
320 | |
321 | cache => \$cache, # cache for around modifiers |
322 | }; |
323 | |
324 | $self->add_method($name => $modified); |
325 | } |
326 | |
327 | if($type eq 'before'){ |
328 | unshift @{$modifier_table->{before}}, $code; |
329 | } |
330 | elsif($type eq 'after'){ |
331 | push @{$modifier_table->{after}}, $code; |
332 | } |
333 | else{ # around |
334 | push @{$modifier_table->{around}}, $code; |
335 | |
336 | my $next = ${ $modifier_table->{cache} }; |
337 | ${ $modifier_table->{cache} } = sub{ $code->($next, @_) }; |
338 | } |
339 | |
340 | return; |
341 | } |
342 | |
4859d490 |
343 | sub _install_modifier { |
344 | my ( $self, $into, $type, $name, $code ) = @_; |
4f5b44a0 |
345 | |
3fbade18 |
346 | # load Class::Method::Modifiers first |
7ca5c5fb |
347 | my $no_cmm_fast = do{ |
3fbade18 |
348 | local $@; |
349 | eval q{ require Class::Method::Modifiers::Fast }; |
350 | $@; |
4f5b44a0 |
351 | }; |
4f5b44a0 |
352 | |
3fbade18 |
353 | my $impl; |
354 | if($no_cmm_fast){ |
355 | $impl = \&_install_modifier_pp; |
356 | } |
357 | else{ |
358 | my $install_modifier = Class::Method::Modifiers::Fast->can('_install_modifier'); |
359 | $impl = sub { |
4f5b44a0 |
360 | my ( $self, $into, $type, $name, $code ) = @_; |
3fbade18 |
361 | $install_modifier->( |
4f5b44a0 |
362 | $into, |
363 | $type, |
364 | $name, |
365 | $code |
366 | ); |
6cfa1e5e |
367 | $self->{methods}{$name}++; # register it to the method map |
368 | return; |
4f5b44a0 |
369 | }; |
1b79a118 |
370 | } |
4f5b44a0 |
371 | |
3fbade18 |
372 | # replace this method itself :) |
373 | { |
374 | no warnings 'redefine'; |
375 | *_install_modifier = $impl; |
376 | } |
377 | |
378 | $self->$impl( $into, $type, $name, $code ); |
4859d490 |
379 | } |
380 | |
50dc6ee5 |
381 | sub add_before_method_modifier { |
4859d490 |
382 | my ( $self, $name, $code ) = @_; |
383 | $self->_install_modifier( $self->name, 'before', $name, $code ); |
50dc6ee5 |
384 | } |
385 | |
386 | sub add_around_method_modifier { |
4859d490 |
387 | my ( $self, $name, $code ) = @_; |
388 | $self->_install_modifier( $self->name, 'around', $name, $code ); |
50dc6ee5 |
389 | } |
390 | |
391 | sub add_after_method_modifier { |
4859d490 |
392 | my ( $self, $name, $code ) = @_; |
393 | $self->_install_modifier( $self->name, 'after', $name, $code ); |
50dc6ee5 |
394 | } |
395 | |
67199842 |
396 | sub add_override_method_modifier { |
397 | my ($self, $name, $code) = @_; |
398 | |
768804c0 |
399 | if($self->has_method($name)){ |
400 | $self->throw_error("Cannot add an override method if a local method is already present"); |
85bd3f44 |
401 | } |
402 | |
6cfa1e5e |
403 | my $package = $self->name; |
67199842 |
404 | |
85bd3f44 |
405 | my $super_body = $package->can($name) |
6cfa1e5e |
406 | or $self->throw_error("You cannot override '$name' because it has no super method"); |
67199842 |
407 | |
85bd3f44 |
408 | $self->add_method($name => sub { |
409 | local $Mouse::SUPER_PACKAGE = $package; |
410 | local $Mouse::SUPER_BODY = $super_body; |
411 | local @Mouse::SUPER_ARGS = @_; |
412 | |
413 | $code->(@_); |
414 | }); |
415 | return; |
67199842 |
416 | } |
417 | |
768804c0 |
418 | sub add_augment_method_modifier { |
419 | my ($self, $name, $code) = @_; |
420 | if($self->has_method($name)){ |
421 | $self->throw_error("Cannot add an augment method if a local method is already present"); |
422 | } |
423 | |
424 | my $super = $self->find_method_by_name($name) |
425 | or $self->throw_error("You cannot augment '$name' because it has no super method"); |
426 | |
427 | my $super_package = $super->package_name; |
428 | my $super_body = $super->body; |
429 | |
430 | $self->add_method($name => sub{ |
431 | local $Mouse::INNER_BODY{$super_package} = $code; |
432 | local $Mouse::INNER_ARGS{$super_package} = [@_]; |
433 | $super_body->(@_); |
434 | }); |
435 | return; |
436 | } |
437 | |
47f36c05 |
438 | sub does_role { |
439 | my ($self, $role_name) = @_; |
ad958001 |
440 | |
47f36c05 |
441 | (defined $role_name) |
fce211ae |
442 | || $self->throw_error("You must supply a role name to look for"); |
ad958001 |
443 | |
f7fec86c |
444 | for my $class ($self->linearized_isa) { |
739525d0 |
445 | my $meta = Mouse::Util::get_metaclass_by_name($class); |
3a63a2e7 |
446 | next unless $meta && $meta->can('roles'); |
447 | |
448 | for my $role (@{ $meta->roles }) { |
ff687069 |
449 | |
3a63a2e7 |
450 | return 1 if $role->does_role($role_name); |
f7fec86c |
451 | } |
47f36c05 |
452 | } |
ad958001 |
453 | |
47f36c05 |
454 | return 0; |
455 | } |
456 | |
c3398f5b |
457 | 1; |
458 | |
459 | __END__ |
460 | |
461 | =head1 NAME |
462 | |
1820fffe |
463 | Mouse::Meta::Class - The Mouse class metaclass |
c3398f5b |
464 | |
465 | =head1 METHODS |
466 | |
612d3e1a |
467 | =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >> |
c3398f5b |
468 | |
31c5194b |
469 | Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only |
306290e8 |
470 | one instance should exist for a given class. |
c3398f5b |
471 | |
612d3e1a |
472 | =head2 C<< name -> ClassName >> |
c3398f5b |
473 | |
474 | Returns the name of the owner class. |
475 | |
612d3e1a |
476 | =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >> |
c3398f5b |
477 | |
478 | Gets (or sets) the list of superclasses of the owner class. |
479 | |
31c5194b |
480 | =head2 C<< add_method(name => CodeRef) >> |
c3398f5b |
481 | |
31c5194b |
482 | Adds a method to the owner class. |
c3398f5b |
483 | |
31c5194b |
484 | =head2 C<< has_method(name) -> Bool >> |
72b88a88 |
485 | |
31c5194b |
486 | Returns whether we have a method with the given name. |
72b88a88 |
487 | |
31c5194b |
488 | =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >> |
c68b4110 |
489 | |
31c5194b |
490 | Returns a L<Mouse::Meta::Method> with the given name. |
491 | |
492 | Note that you can also use C<< $metaclass->name->can($name) >> for a method body. |
493 | |
494 | =head2 C<< get_method_list -> Names >> |
495 | |
496 | Returns a list of method names which are defined in the local class. |
497 | If you want a list of all applicable methods for a class, use the |
498 | C<get_all_methods> method. |
499 | |
500 | =head2 C<< get_all_methods -> (Mouse::Meta::Method) >> |
501 | |
502 | Return the list of all L<Mouse::Meta::Method> instances associated with |
503 | the class and its superclasses. |
504 | |
505 | =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >> |
506 | |
507 | Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner |
508 | class. |
c68b4110 |
509 | |
612d3e1a |
510 | =head2 C<< has_attribute(Name) -> Bool >> |
66eea168 |
511 | |
512 | Returns whether we have a L<Mouse::Meta::Attribute> with the given name. |
513 | |
31c5194b |
514 | =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >> |
c3398f5b |
515 | |
306290e8 |
516 | Returns the L<Mouse::Meta::Attribute> with the given name. |
c3398f5b |
517 | |
31c5194b |
518 | =head2 C<< get_attribute_list -> Names >> |
519 | |
520 | Returns a list of attribute names which are defined in the local |
521 | class. If you want a list of all applicable attributes for a class, |
522 | use the C<get_all_attributes> method. |
523 | |
524 | =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >> |
525 | |
526 | Returns the list of all L<Mouse::Meta::Attribute> instances associated with |
527 | this class and its superclasses. |
528 | |
612d3e1a |
529 | =head2 C<< linearized_isa -> [ClassNames] >> |
c3398f5b |
530 | |
531 | Returns the list of classes in method dispatch order, with duplicates removed. |
532 | |
612d3e1a |
533 | =head2 C<< new_object(Parameters) -> Instance >> |
2cea7a5f |
534 | |
612d3e1a |
535 | Creates a new instance. |
2cea7a5f |
536 | |
612d3e1a |
537 | =head2 C<< clone_object(Instance, Parameters) -> Instance >> |
f7b11a21 |
538 | |
31c5194b |
539 | Clones the given instance which must be an instance governed by this |
f7b11a21 |
540 | metaclass. |
541 | |
31c5194b |
542 | =head2 C<< throw_error(Message, Parameters) >> |
543 | |
544 | Throws an error with the given message. |
545 | |
1820fffe |
546 | =head1 SEE ALSO |
f7b11a21 |
547 | |
1820fffe |
548 | L<Moose::Meta::Class> |
f7b11a21 |
549 | |
31c5194b |
550 | L<Class::MOP::Class> |
551 | |
c3398f5b |
552 | =cut |
553 | |