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