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::Module; |
f3bb863f |
7 | our @ISA = qw(Mouse::Meta::Module); |
3a63a2e7 |
8 | |
e058b279 |
9 | sub attribute_metaclass; |
d9659f80 |
10 | sub method_metaclass; |
3a63a2e7 |
11 | |
e058b279 |
12 | sub constructor_class; |
13 | sub destructor_class; |
380e1cd7 |
14 | |
d9659f80 |
15 | my @MetaClassTypes = qw( |
16 | attribute_metaclass |
17 | method_metaclass |
18 | constructor_class |
19 | destructor_class |
20 | ); |
21 | |
8e64d0fa |
22 | sub _construct_meta { |
88ed7189 |
23 | my($class, %args) = @_; |
c3398f5b |
24 | |
5132ec42 |
25 | $args{attributes} = {}; |
26 | $args{methods} = {}; |
27 | $args{roles} = []; |
8536d351 |
28 | |
c3398f5b |
29 | $args{superclasses} = do { |
30 | no strict 'refs'; |
88ed7189 |
31 | \@{ $args{package} . '::ISA' }; |
c3398f5b |
32 | }; |
33 | |
8d40c3b8 |
34 | my $self = bless \%args, ref($class) || $class; |
7eb3a8d5 |
35 | if(ref($self) ne __PACKAGE__){ |
9009aca1 |
36 | $self->meta->_initialize_object($self, \%args); |
8d40c3b8 |
37 | } |
38 | return $self; |
7a50b450 |
39 | } |
40 | |
41 | sub create_anon_class{ |
42 | my $self = shift; |
43 | return $self->create(undef, @_); |
44 | } |
45 | |
43165725 |
46 | sub is_anon_class; |
c3398f5b |
47 | |
43165725 |
48 | sub roles; |
c3398f5b |
49 | |
e7264861 |
50 | sub calculate_all_roles { |
51 | my $self = shift; |
52 | my %seen; |
53 | return grep { !$seen{ $_->name }++ } |
54 | map { $_->calculate_all_roles } @{ $self->roles }; |
55 | } |
56 | |
c3398f5b |
57 | sub superclasses { |
58 | my $self = shift; |
59 | |
60 | if (@_) { |
9d0686b2 |
61 | foreach my $super(@_){ |
62 | Mouse::Util::load_class($super); |
63 | my $meta = Mouse::Util::get_metaclass_by_name($super); |
b6369395 |
64 | |
65 | next if not defined $meta; |
66 | |
f48920c1 |
67 | if(Mouse::Util::is_a_metarole($meta)){ |
9d0686b2 |
68 | $self->throw_error("You cannot inherit from a Mouse Role ($super)"); |
69 | } |
b6369395 |
70 | |
71 | next if $self->isa(ref $meta); # _superclass_meta_is_compatible |
72 | |
b6369395 |
73 | $self->_reconcile_with_superclass_meta($meta); |
9d0686b2 |
74 | } |
c3398f5b |
75 | @{ $self->{superclasses} } = @_; |
76 | } |
77 | |
8e64d0fa |
78 | return @{ $self->{superclasses} }; |
79 | } |
80 | |
b6369395 |
81 | sub _reconcile_with_superclass_meta { |
82 | my($self, $super_meta) = @_; |
83 | |
733f404b |
84 | # find incompatible traits |
b6369395 |
85 | my @incompatibles; |
86 | foreach my $metaclass_type(@MetaClassTypes){ |
87 | my $super_c = $super_meta->$metaclass_type(); |
88 | my $self_c = $self->$metaclass_type(); |
89 | |
90 | if(!$super_c->isa($self_c)){ |
29422d00 |
91 | push @incompatibles, ($metaclass_type => $super_c); |
b6369395 |
92 | } |
93 | } |
94 | |
d9659f80 |
95 | my @roles; |
733f404b |
96 | foreach my $role($super_meta->meta->calculate_all_roles){ |
97 | if(!$self->meta->does_role($role->name)){ |
d9659f80 |
98 | push @roles, $role->name; |
99 | } |
100 | } |
101 | |
102 | #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n"; |
103 | |
104 | require Mouse::Util::MetaRole; |
105 | Mouse::Util::MetaRole::apply_metaclass_roles( |
106 | for_class => $self, |
107 | metaclass => ref $super_meta, |
108 | metaclass_roles => \@roles, |
109 | @incompatibles, |
110 | ); |
b6369395 |
111 | return; |
112 | } |
113 | |
8e64d0fa |
114 | sub find_method_by_name{ |
115 | my($self, $method_name) = @_; |
116 | defined($method_name) |
117 | or $self->throw_error('You must define a method name to find'); |
0126c27c |
118 | |
8e64d0fa |
119 | foreach my $class( $self->linearized_isa ){ |
120 | my $method = $self->initialize($class)->get_method($method_name); |
121 | return $method if defined $method; |
122 | } |
123 | return undef; |
124 | } |
125 | |
126 | sub get_all_methods { |
127 | my($self) = @_; |
612d3e1a |
128 | return map{ $self->find_method_by_name($_) } $self->get_all_method_names; |
c3398f5b |
129 | } |
130 | |
60cfc6ad |
131 | sub get_all_method_names { |
132 | my $self = shift; |
133 | my %uniq; |
134 | return grep { $uniq{$_}++ == 0 } |
3a63a2e7 |
135 | map { Mouse::Meta::Class->initialize($_)->get_method_list() } |
60cfc6ad |
136 | $self->linearized_isa; |
137 | } |
138 | |
2b908b79 |
139 | sub find_attribute_by_name{ |
140 | my($self, $name) = @_; |
141 | my $attr; |
142 | foreach my $class($self->linearized_isa){ |
143 | my $meta = Mouse::Util::get_metaclass_by_name($class) or next; |
144 | $attr = $meta->get_attribute($name) and last; |
145 | } |
146 | return $attr; |
147 | } |
148 | |
87ca293b |
149 | sub add_attribute { |
c3398f5b |
150 | my $self = shift; |
60f6eba9 |
151 | |
87ca293b |
152 | my($attr, $name); |
1b9e472d |
153 | |
87ca293b |
154 | if(blessed $_[0]){ |
155 | $attr = $_[0]; |
1b9e472d |
156 | |
87ca293b |
157 | $attr->isa('Mouse::Meta::Attribute') |
158 | || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)"); |
1b9e472d |
159 | |
87ca293b |
160 | $name = $attr->name; |
1b9e472d |
161 | } |
162 | else{ |
87ca293b |
163 | # _process_attribute |
164 | $name = shift; |
1b9e472d |
165 | |
87ca293b |
166 | my %args = (@_ == 1) ? %{$_[0]} : @_; |
1b9e472d |
167 | |
87ca293b |
168 | defined($name) |
169 | or $self->throw_error('You must provide a name for the attribute'); |
1b9e472d |
170 | |
87ca293b |
171 | if ($name =~ s/^\+//) { # inherited attributes |
2b908b79 |
172 | my $inherited_attr = $self->find_attribute_by_name($name) |
87ca293b |
173 | or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name); |
174 | |
8cf51b82 |
175 | $attr = $inherited_attr->clone_and_inherit_options(%args); |
87ca293b |
176 | } |
177 | else{ |
8cf51b82 |
178 | my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args); |
87ca293b |
179 | $args{traits} = \@traits if @traits; |
180 | |
2a464664 |
181 | $attr = $attribute_class->new($name, %args); |
87ca293b |
182 | } |
183 | } |
1b9e472d |
184 | |
185 | weaken( $attr->{associated_class} = $self ); |
186 | |
187 | $self->{attributes}{$attr->name} = $attr; |
188 | $attr->install_accessors(); |
189 | |
8aba926d |
190 | if(Mouse::Util::_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){ |
1b9e472d |
191 | 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 |
192 | } |
1b9e472d |
193 | return $attr; |
c3398f5b |
194 | } |
195 | |
8b0573c6 |
196 | sub compute_all_applicable_attributes { # DEPRECATED |
197 | Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead'); |
198 | |
3a683350 |
199 | return shift->get_all_attributes(@_) |
200 | } |
201 | |
cccb83de |
202 | sub linearized_isa; |
8536d351 |
203 | |
ba153b33 |
204 | sub new_object; |
1b9e472d |
205 | |
7a59f4e8 |
206 | sub clone_object { |
926290ac |
207 | my $class = shift; |
208 | my $object = shift; |
2053291d |
209 | my $args = $object->Mouse::Object::BUILDARGS(@_); |
7a59f4e8 |
210 | |
926290ac |
211 | (blessed($object) && $object->isa($class->name)) |
212 | || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)"); |
7a59f4e8 |
213 | |
926290ac |
214 | my $cloned = bless { %$object }, ref $object; |
2053291d |
215 | $class->_initialize_object($cloned, $args); |
7a59f4e8 |
216 | |
926290ac |
217 | return $cloned; |
2cea7a5f |
218 | } |
7a59f4e8 |
219 | |
8b0573c6 |
220 | sub clone_instance { # DEPRECATED |
2cea7a5f |
221 | my ($class, $instance, %params) = @_; |
222 | |
8b0573c6 |
223 | Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead'); |
224 | |
2cea7a5f |
225 | return $class->clone_object($instance, %params); |
7a59f4e8 |
226 | } |
227 | |
cfef75f0 |
228 | |
229 | sub immutable_options { |
230 | my ( $self, @args ) = @_; |
231 | |
232 | return ( |
7efbc77d |
233 | inline_constructor => 1, |
e578d610 |
234 | inline_destructor => 1, |
2a464664 |
235 | constructor_name => 'new', |
cfef75f0 |
236 | @args, |
6a1d1835 |
237 | ); |
cfef75f0 |
238 | } |
239 | |
240 | |
241 | sub make_immutable { |
242 | my $self = shift; |
243 | my %args = $self->immutable_options(@_); |
6a1d1835 |
244 | |
fc1d8369 |
245 | $self->{is_immutable}++; |
c7a6403f |
246 | |
e128626c |
247 | $self->{strict_constructor} = $args{strict_constructor}; |
248 | |
6a1d1835 |
249 | if ($args{inline_constructor}) { |
380e1cd7 |
250 | $self->add_method($args{constructor_name} => |
637d4f17 |
251 | Mouse::Util::load_class($self->constructor_class) |
252 | ->_generate_constructor($self, \%args)); |
c7a6403f |
253 | } |
254 | |
8632b6fe |
255 | if ($args{inline_destructor}) { |
380e1cd7 |
256 | $self->add_method(DESTROY => |
637d4f17 |
257 | Mouse::Util::load_class($self->destructor_class) |
258 | ->_generate_destructor($self, \%args)); |
8632b6fe |
259 | } |
2276cb14 |
260 | |
261 | # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value |
262 | # at the end of a source file. |
263 | return 1; |
fc1d8369 |
264 | } |
ad958001 |
265 | |
32490a72 |
266 | sub make_mutable { |
267 | my($self) = @_; |
268 | $self->{is_immutable} = 0; |
269 | return; |
270 | } |
ad958001 |
271 | |
80efe911 |
272 | sub is_immutable; |
273 | sub is_mutable { !$_[0]->is_immutable } |
84ef660f |
274 | |
3fbade18 |
275 | sub _install_modifier_pp{ |
8d59c723 |
276 | my( $self, $type, $name, $code ) = @_; |
277 | my $into = $self->name; |
3fbade18 |
278 | |
279 | my $original = $into->can($name) |
280 | or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into"); |
281 | |
282 | my $modifier_table = $self->{modifiers}{$name}; |
283 | |
284 | if(!$modifier_table){ |
285 | my(@before, @after, @around, $cache, $modified); |
286 | |
287 | $cache = $original; |
288 | |
289 | $modified = sub { |
290 | for my $c (@before) { $c->(@_) } |
291 | |
292 | if(wantarray){ # list context |
293 | my @rval = $cache->(@_); |
294 | |
295 | for my $c(@after){ $c->(@_) } |
296 | return @rval; |
297 | } |
298 | elsif(defined wantarray){ # scalar context |
299 | my $rval = $cache->(@_); |
300 | |
301 | for my $c(@after){ $c->(@_) } |
302 | return $rval; |
303 | } |
304 | else{ # void context |
305 | $cache->(@_); |
306 | |
307 | for my $c(@after){ $c->(@_) } |
308 | return; |
309 | } |
310 | }; |
311 | |
312 | $self->{modifiers}{$name} = $modifier_table = { |
313 | original => $original, |
314 | |
315 | before => \@before, |
316 | after => \@after, |
317 | around => \@around, |
318 | |
319 | cache => \$cache, # cache for around modifiers |
320 | }; |
321 | |
322 | $self->add_method($name => $modified); |
323 | } |
324 | |
325 | if($type eq 'before'){ |
326 | unshift @{$modifier_table->{before}}, $code; |
327 | } |
328 | elsif($type eq 'after'){ |
329 | push @{$modifier_table->{after}}, $code; |
330 | } |
331 | else{ # around |
332 | push @{$modifier_table->{around}}, $code; |
333 | |
334 | my $next = ${ $modifier_table->{cache} }; |
335 | ${ $modifier_table->{cache} } = sub{ $code->($next, @_) }; |
336 | } |
337 | |
338 | return; |
339 | } |
340 | |
4859d490 |
341 | sub _install_modifier { |
8d59c723 |
342 | my ( $self, $type, $name, $code ) = @_; |
4f5b44a0 |
343 | |
3fbade18 |
344 | # load Class::Method::Modifiers first |
7ca5c5fb |
345 | my $no_cmm_fast = do{ |
3fbade18 |
346 | local $@; |
d0773d24 |
347 | eval q{ use Class::Method::Modifiers::Fast 0.041 () }; |
3fbade18 |
348 | $@; |
4f5b44a0 |
349 | }; |
4f5b44a0 |
350 | |
3fbade18 |
351 | my $impl; |
352 | if($no_cmm_fast){ |
353 | $impl = \&_install_modifier_pp; |
354 | } |
355 | else{ |
d0773d24 |
356 | my $install_modifier = Class::Method::Modifiers::Fast->can('install_modifier'); |
3fbade18 |
357 | $impl = sub { |
8d59c723 |
358 | my ( $self, $type, $name, $code ) = @_; |
359 | my $into = $self->name; |
95ecd6f1 |
360 | $install_modifier->($into, $type, $name, $code); |
361 | |
8d59c723 |
362 | $self->add_method($name => do{ |
363 | no strict 'refs'; |
364 | \&{ $into . '::' . $name }; |
365 | }); |
6cfa1e5e |
366 | return; |
4f5b44a0 |
367 | }; |
1b79a118 |
368 | } |
4f5b44a0 |
369 | |
3fbade18 |
370 | # replace this method itself :) |
371 | { |
372 | no warnings 'redefine'; |
373 | *_install_modifier = $impl; |
374 | } |
375 | |
8d59c723 |
376 | $self->$impl( $type, $name, $code ); |
4859d490 |
377 | } |
378 | |
50dc6ee5 |
379 | sub add_before_method_modifier { |
4859d490 |
380 | my ( $self, $name, $code ) = @_; |
8d59c723 |
381 | $self->_install_modifier( 'before', $name, $code ); |
50dc6ee5 |
382 | } |
383 | |
384 | sub add_around_method_modifier { |
4859d490 |
385 | my ( $self, $name, $code ) = @_; |
8d59c723 |
386 | $self->_install_modifier( 'around', $name, $code ); |
50dc6ee5 |
387 | } |
388 | |
389 | sub add_after_method_modifier { |
4859d490 |
390 | my ( $self, $name, $code ) = @_; |
8d59c723 |
391 | $self->_install_modifier( 'after', $name, $code ); |
50dc6ee5 |
392 | } |
393 | |
67199842 |
394 | sub add_override_method_modifier { |
395 | my ($self, $name, $code) = @_; |
396 | |
768804c0 |
397 | if($self->has_method($name)){ |
398 | $self->throw_error("Cannot add an override method if a local method is already present"); |
85bd3f44 |
399 | } |
400 | |
6cfa1e5e |
401 | my $package = $self->name; |
67199842 |
402 | |
85bd3f44 |
403 | my $super_body = $package->can($name) |
6cfa1e5e |
404 | or $self->throw_error("You cannot override '$name' because it has no super method"); |
67199842 |
405 | |
85bd3f44 |
406 | $self->add_method($name => sub { |
407 | local $Mouse::SUPER_PACKAGE = $package; |
408 | local $Mouse::SUPER_BODY = $super_body; |
409 | local @Mouse::SUPER_ARGS = @_; |
410 | |
411 | $code->(@_); |
412 | }); |
413 | return; |
67199842 |
414 | } |
415 | |
768804c0 |
416 | sub add_augment_method_modifier { |
417 | my ($self, $name, $code) = @_; |
418 | if($self->has_method($name)){ |
419 | $self->throw_error("Cannot add an augment method if a local method is already present"); |
420 | } |
421 | |
422 | my $super = $self->find_method_by_name($name) |
423 | or $self->throw_error("You cannot augment '$name' because it has no super method"); |
424 | |
425 | my $super_package = $super->package_name; |
426 | my $super_body = $super->body; |
427 | |
428 | $self->add_method($name => sub{ |
429 | local $Mouse::INNER_BODY{$super_package} = $code; |
430 | local $Mouse::INNER_ARGS{$super_package} = [@_]; |
431 | $super_body->(@_); |
432 | }); |
433 | return; |
434 | } |
435 | |
47f36c05 |
436 | sub does_role { |
437 | my ($self, $role_name) = @_; |
ad958001 |
438 | |
47f36c05 |
439 | (defined $role_name) |
fce211ae |
440 | || $self->throw_error("You must supply a role name to look for"); |
ad958001 |
441 | |
f7fec86c |
442 | for my $class ($self->linearized_isa) { |
95ecd6f1 |
443 | my $meta = Mouse::Util::get_metaclass_by_name($class) |
444 | or next; |
3a63a2e7 |
445 | |
446 | for my $role (@{ $meta->roles }) { |
ff687069 |
447 | |
3a63a2e7 |
448 | return 1 if $role->does_role($role_name); |
f7fec86c |
449 | } |
47f36c05 |
450 | } |
ad958001 |
451 | |
47f36c05 |
452 | return 0; |
453 | } |
454 | |
c3398f5b |
455 | 1; |
c3398f5b |
456 | __END__ |
457 | |
458 | =head1 NAME |
459 | |
1820fffe |
460 | Mouse::Meta::Class - The Mouse class metaclass |
c3398f5b |
461 | |
a25ca8d6 |
462 | =head1 VERSION |
463 | |
4bc73e47 |
464 | This document describes Mouse version 0.50_03 |
a25ca8d6 |
465 | |
c3398f5b |
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 | |
6b82419e |
549 | L<Mouse::Meta::Module> |
550 | |
1820fffe |
551 | L<Moose::Meta::Class> |
f7b11a21 |
552 | |
31c5194b |
553 | L<Class::MOP::Class> |
554 | |
c3398f5b |
555 | =cut |
556 | |