Commit | Line | Data |
8b978dd5 |
1 | |
2 | package Class::MOP::Class; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
c23184fc |
7 | use Class::MOP::Immutable; |
ba38bf08 |
8 | use Class::MOP::Instance; |
9 | use Class::MOP::Method::Wrapped; |
10 | |
8b978dd5 |
11 | use Carp 'confess'; |
7f63694d |
12 | use Scalar::Util 'blessed', 'reftype', 'weaken'; |
8b978dd5 |
13 | use Sub::Name 'subname'; |
8b978dd5 |
14 | |
c1d5345a |
15 | our $VERSION = '0.26'; |
f0480c45 |
16 | our $AUTHORITY = 'cpan:STEVAN'; |
8b978dd5 |
17 | |
2243a22b |
18 | use base 'Class::MOP::Module'; |
19 | |
0ac992ee |
20 | # Self-introspection |
2eb717d5 |
21 | |
aa448b16 |
22 | sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) } |
2eb717d5 |
23 | |
8b978dd5 |
24 | # Creation |
0ac992ee |
25 | |
be7677c7 |
26 | sub initialize { |
27 | my $class = shift; |
28 | my $package_name = shift; |
29 | (defined $package_name && $package_name && !blessed($package_name)) |
0ac992ee |
30 | || confess "You must pass a package name and it cannot be blessed"; |
3af3cbbd |
31 | if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) { |
32 | return $meta; |
33 | } |
c23184fc |
34 | $class->construct_class_instance('package' => $package_name, @_); |
be7677c7 |
35 | } |
36 | |
37 | sub reinitialize { |
38 | my $class = shift; |
39 | my $package_name = shift; |
40 | (defined $package_name && $package_name && !blessed($package_name)) |
0ac992ee |
41 | || confess "You must pass a package name and it cannot be blessed"; |
be7677c7 |
42 | Class::MOP::remove_metaclass_by_name($package_name); |
c23184fc |
43 | $class->construct_class_instance('package' => $package_name, @_); |
0ac992ee |
44 | } |
45 | |
46 | # NOTE: (meta-circularity) |
47 | # this is a special form of &construct_instance |
be7677c7 |
48 | # (see below), which is used to construct class |
0ac992ee |
49 | # meta-object instances for any Class::MOP::* |
50 | # class. All other classes will use the more |
be7677c7 |
51 | # normal &construct_instance. |
52 | sub construct_class_instance { |
53 | my $class = shift; |
54 | my %options = @_; |
c23184fc |
55 | my $package_name = $options{'package'}; |
be7677c7 |
56 | (defined $package_name && $package_name) |
0ac992ee |
57 | || confess "You must pass a package name"; |
be7677c7 |
58 | # NOTE: |
0ac992ee |
59 | # return the metaclass if we have it cached, |
60 | # and it is still defined (it has not been |
61 | # reaped by DESTROY yet, which can happen |
be7677c7 |
62 | # annoyingly enough during global destruction) |
3af3cbbd |
63 | |
64 | if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) { |
65 | return $meta; |
66 | } |
be7677c7 |
67 | |
68 | # NOTE: |
0ac992ee |
69 | # we need to deal with the possibility |
70 | # of class immutability here, and then |
be7677c7 |
71 | # get the name of the class appropriately |
72 | $class = (blessed($class) |
73 | ? ($class->is_immutable |
74 | ? $class->get_mutable_metaclass_name() |
75 | : blessed($class)) |
76 | : $class); |
77 | |
be7677c7 |
78 | # now create the metaclass |
79 | my $meta; |
9c6877f4 |
80 | if ($class eq 'Class::MOP::Class') { |
0ac992ee |
81 | no strict 'refs'; |
82 | $meta = bless { |
be7677c7 |
83 | # inherited from Class::MOP::Package |
0ac992ee |
84 | '$!package' => $package_name, |
85 | |
c4260b45 |
86 | # NOTE: |
0ac992ee |
87 | # since the following attributes will |
88 | # actually be loaded from the symbol |
c4260b45 |
89 | # table, and actually bypass the instance |
90 | # entirely, we can just leave these things |
91 | # listed here for reference, because they |
0ac992ee |
92 | # should not actually have a value associated |
c4260b45 |
93 | # with the slot. |
0ac992ee |
94 | '%!namespace' => \undef, |
be7677c7 |
95 | # inherited from Class::MOP::Module |
c23184fc |
96 | '$!version' => \undef, |
97 | '$!authority' => \undef, |
c4260b45 |
98 | # defined in Class::MOP::Class |
c23184fc |
99 | '@!superclasses' => \undef, |
0ac992ee |
100 | |
c23184fc |
101 | '%!methods' => {}, |
0ac992ee |
102 | '%!attributes' => {}, |
c23184fc |
103 | '$!attribute_metaclass' => $options{'attribute_metaclass'} || 'Class::MOP::Attribute', |
104 | '$!method_metaclass' => $options{'method_metaclass'} || 'Class::MOP::Method', |
105 | '$!instance_metaclass' => $options{'instance_metaclass'} || 'Class::MOP::Instance', |
e0e4674a |
106 | |
107 | ## uber-private variables |
108 | # NOTE: |
109 | # this starts out as undef so that |
110 | # we can tell the first time the |
111 | # methods are fetched |
112 | # - SL |
113 | '$!_package_cache_flag' => undef, |
be7677c7 |
114 | } => $class; |
115 | } |
116 | else { |
117 | # NOTE: |
118 | # it is safe to use meta here because |
0ac992ee |
119 | # class will always be a subclass of |
be7677c7 |
120 | # Class::MOP::Class, which defines meta |
121 | $meta = $class->meta->construct_instance(%options) |
727919c5 |
122 | } |
0ac992ee |
123 | |
be7677c7 |
124 | # and check the metaclass compatibility |
715adbb7 |
125 | $meta->check_metaclass_compatability(); |
0ac992ee |
126 | |
be7677c7 |
127 | Class::MOP::store_metaclass_by_name($package_name, $meta); |
0ac992ee |
128 | |
be7677c7 |
129 | # NOTE: |
130 | # we need to weaken any anon classes |
131 | # so that they can call DESTROY properly |
b9d9fc0b |
132 | Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class; |
0ac992ee |
133 | |
134 | $meta; |
135 | } |
136 | |
715adbb7 |
137 | sub reset_package_cache_flag { (shift)->{'$!_package_cache_flag'} = undef } |
138 | sub update_package_cache_flag { |
b1f5f41d |
139 | my $self = shift; |
e0e4674a |
140 | # NOTE: |
141 | # we can manually update the cache number |
142 | # since we are actually adding the method |
143 | # to our cache as well. This avoids us |
144 | # having to regenerate the method_map. |
145 | # - SL |
b1f5f41d |
146 | $self->{'$!_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name); |
e0e4674a |
147 | } |
148 | |
be7677c7 |
149 | sub check_metaclass_compatability { |
150 | my $self = shift; |
151 | |
152 | # this is always okay ... |
0ac992ee |
153 | return if blessed($self) eq 'Class::MOP::Class' && |
be7677c7 |
154 | $self->instance_metaclass eq 'Class::MOP::Instance'; |
155 | |
b7bdffc3 |
156 | my @class_list = $self->linearized_isa; |
be7677c7 |
157 | shift @class_list; # shift off $self->name |
373a16ae |
158 | |
0ac992ee |
159 | foreach my $class_name (@class_list) { |
be7677c7 |
160 | my $meta = Class::MOP::get_metaclass_by_name($class_name) || next; |
0ac992ee |
161 | |
373a16ae |
162 | # NOTE: |
0ac992ee |
163 | # we need to deal with the possibility |
164 | # of class immutability here, and then |
165 | # get the name of the class appropriately |
be7677c7 |
166 | my $meta_type = ($meta->is_immutable |
167 | ? $meta->get_mutable_metaclass_name() |
0ac992ee |
168 | : blessed($meta)); |
169 | |
be7677c7 |
170 | ($self->isa($meta_type)) |
0ac992ee |
171 | || confess $self->name . "->meta => (" . (blessed($self)) . ")" . |
172 | " is not compatible with the " . |
be7677c7 |
173 | $class_name . "->meta => (" . ($meta_type) . ")"; |
77e5fce4 |
174 | # NOTE: |
be7677c7 |
175 | # we also need to check that instance metaclasses |
176 | # are compatabile in the same the class. |
177 | ($self->instance_metaclass->isa($meta->instance_metaclass)) |
0ac992ee |
178 | || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" . |
179 | " is not compatible with the " . |
180 | $class_name . "->meta => (" . ($meta->instance_metaclass) . ")"; |
181 | } |
182 | } |
8b978dd5 |
183 | |
6d5355c3 |
184 | ## ANON classes |
185 | |
186 | { |
187 | # NOTE: |
0ac992ee |
188 | # this should be sufficient, if you have a |
189 | # use case where it is not, write a test and |
6d5355c3 |
190 | # I will change it. |
191 | my $ANON_CLASS_SERIAL = 0; |
0ac992ee |
192 | |
b9d9fc0b |
193 | # NOTE: |
194 | # we need a sufficiently annoying prefix |
0ac992ee |
195 | # this should suffice for now, this is |
196 | # used in a couple of places below, so |
b9d9fc0b |
197 | # need to put it up here for now. |
0ac992ee |
198 | my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::'; |
b9d9fc0b |
199 | |
200 | sub is_anon_class { |
201 | my $self = shift; |
a651e249 |
202 | no warnings 'uninitialized'; |
0ac992ee |
203 | $self->name =~ /^$ANON_CLASS_PREFIX/ ? 1 : 0; |
b9d9fc0b |
204 | } |
6d5355c3 |
205 | |
206 | sub create_anon_class { |
0ac992ee |
207 | my ($class, %options) = @_; |
6d5355c3 |
208 | my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL; |
88dd563c |
209 | return $class->create($package_name, %options); |
0ac992ee |
210 | } |
6d5355c3 |
211 | |
b9d9fc0b |
212 | # NOTE: |
0ac992ee |
213 | # this will only get called for |
214 | # anon-classes, all other calls |
215 | # are assumed to occur during |
b9d9fc0b |
216 | # global destruction and so don't |
217 | # really need to be handled explicitly |
218 | sub DESTROY { |
219 | my $self = shift; |
0ac992ee |
220 | no warnings 'uninitialized'; |
b9d9fc0b |
221 | return unless $self->name =~ /^$ANON_CLASS_PREFIX/; |
222 | my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/); |
0ac992ee |
223 | no strict 'refs'; |
b9d9fc0b |
224 | foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) { |
225 | delete ${$ANON_CLASS_PREFIX . $serial_id}{$key}; |
226 | } |
0ac992ee |
227 | delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'}; |
6d5355c3 |
228 | } |
b9d9fc0b |
229 | |
6d5355c3 |
230 | } |
231 | |
232 | # creating classes with MOP ... |
233 | |
8b978dd5 |
234 | sub create { |
88dd563c |
235 | my $class = shift; |
236 | my $package_name = shift; |
0ac992ee |
237 | |
bfe4d0fc |
238 | (defined $package_name && $package_name) |
8b978dd5 |
239 | || confess "You must pass a package name"; |
88dd563c |
240 | |
241 | (scalar @_ % 2 == 0) |
0ac992ee |
242 | || confess "You much pass all parameters as name => value pairs " . |
88dd563c |
243 | "(I found an uneven number of params in \@_)"; |
244 | |
245 | my (%options) = @_; |
0ac992ee |
246 | |
8b978dd5 |
247 | my $code = "package $package_name;"; |
0ac992ee |
248 | $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" |
88dd563c |
249 | if exists $options{version}; |
0ac992ee |
250 | $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';" |
251 | if exists $options{authority}; |
252 | |
8b978dd5 |
253 | eval $code; |
0ac992ee |
254 | confess "creation of $package_name failed : $@" if $@; |
255 | |
bfe4d0fc |
256 | my $meta = $class->initialize($package_name); |
0ac992ee |
257 | |
258 | $meta->add_method('meta' => sub { |
df7b4119 |
259 | $class->initialize(blessed($_[0]) || $_[0]); |
aa448b16 |
260 | }); |
0ac992ee |
261 | |
8b978dd5 |
262 | $meta->superclasses(@{$options{superclasses}}) |
263 | if exists $options{superclasses}; |
2eb717d5 |
264 | # NOTE: |
0ac992ee |
265 | # process attributes first, so that they can |
2eb717d5 |
266 | # install accessors, but locally defined methods |
267 | # can then overwrite them. It is maybe a little odd, but |
268 | # I think this should be the order of things. |
269 | if (exists $options{attributes}) { |
cbd9f942 |
270 | foreach my $attr (@{$options{attributes}}) { |
271 | $meta->add_attribute($attr); |
2eb717d5 |
272 | } |
0ac992ee |
273 | } |
bfe4d0fc |
274 | if (exists $options{methods}) { |
275 | foreach my $method_name (keys %{$options{methods}}) { |
276 | $meta->add_method($method_name, $options{methods}->{$method_name}); |
277 | } |
0ac992ee |
278 | } |
8b978dd5 |
279 | return $meta; |
280 | } |
281 | |
7b31baf4 |
282 | ## Attribute readers |
283 | |
284 | # NOTE: |
0ac992ee |
285 | # all these attribute readers will be bootstrapped |
7b31baf4 |
286 | # away in the Class::MOP bootstrap section |
287 | |
c23184fc |
288 | sub get_attribute_map { $_[0]->{'%!attributes'} } |
289 | sub attribute_metaclass { $_[0]->{'$!attribute_metaclass'} } |
290 | sub method_metaclass { $_[0]->{'$!method_metaclass'} } |
291 | sub instance_metaclass { $_[0]->{'$!instance_metaclass'} } |
7b31baf4 |
292 | |
0f71bc80 |
293 | # FIXME: |
294 | # this is a prime canidate for conversion to XS |
0ac992ee |
295 | sub get_method_map { |
c4260b45 |
296 | my $self = shift; |
e0e4674a |
297 | |
298 | if (defined $self->{'$!_package_cache_flag'} && |
b1f5f41d |
299 | $self->{'$!_package_cache_flag'} == Class::MOP::check_package_cache_flag($self->name)) { |
e0e4674a |
300 | return $self->{'%!methods'}; |
301 | } |
302 | |
0ac992ee |
303 | my $map = $self->{'%!methods'}; |
304 | |
0f71bc80 |
305 | my $class_name = $self->name; |
306 | my $method_metaclass = $self->method_metaclass; |
0ac992ee |
307 | |
92330ee2 |
308 | foreach my $symbol ($self->list_all_package_symbols('CODE')) { |
91e0eb4a |
309 | my $code = $self->get_package_symbol('&' . $symbol); |
0ac992ee |
310 | |
311 | next if exists $map->{$symbol} && |
312 | defined $map->{$symbol} && |
313 | $map->{$symbol}->body == $code; |
314 | |
e0e4674a |
315 | my ($pkg, $name) = Class::MOP::get_code_info($code); |
316 | next if ($pkg || '') ne $class_name && |
317 | ($name || '') ne '__ANON__'; |
0ac992ee |
318 | |
0f71bc80 |
319 | $map->{$symbol} = $method_metaclass->wrap($code); |
7855ddba |
320 | } |
0ac992ee |
321 | |
7855ddba |
322 | return $map; |
c4260b45 |
323 | } |
324 | |
c9e77dbb |
325 | # Instance Construction & Cloning |
326 | |
5f3c057a |
327 | sub new_object { |
328 | my $class = shift; |
651955fb |
329 | # NOTE: |
0ac992ee |
330 | # we need to protect the integrity of the |
651955fb |
331 | # Class::MOP::Class singletons here, so we |
332 | # delegate this to &construct_class_instance |
333 | # which will deal with the singletons |
334 | return $class->construct_class_instance(@_) |
335 | if $class->name->isa('Class::MOP::Class'); |
24869f62 |
336 | return $class->construct_instance(@_); |
5f3c057a |
337 | } |
e16da3e6 |
338 | |
339 | sub construct_instance { |
cbd9f942 |
340 | my ($class, %params) = @_; |
0e76a376 |
341 | my $meta_instance = $class->get_meta_instance(); |
342 | my $instance = $meta_instance->create_instance(); |
c9e77dbb |
343 | foreach my $attr ($class->compute_all_applicable_attributes()) { |
f892c0f0 |
344 | $attr->initialize_instance_slot($meta_instance, $instance, \%params); |
cbd9f942 |
345 | } |
0ac992ee |
346 | # NOTE: |
d4ba1677 |
347 | # this will only work for a HASH instance type |
348 | if ($class->is_anon_class) { |
349 | (reftype($instance) eq 'HASH') |
350 | || confess "Currently only HASH based instances are supported with instance of anon-classes"; |
351 | # NOTE: |
352 | # At some point we should make this official |
0ac992ee |
353 | # as a reserved slot name, but right now I am |
d4ba1677 |
354 | # going to keep it here. |
355 | # my $RESERVED_MOP_SLOT = '__MOP__'; |
356 | $instance->{'__MOP__'} = $class; |
357 | } |
2d711cc8 |
358 | return $instance; |
359 | } |
360 | |
361 | sub get_meta_instance { |
362 | my $class = shift; |
052c2a1a |
363 | return $class->instance_metaclass->new( |
0ac992ee |
364 | $class, |
052c2a1a |
365 | $class->compute_all_applicable_attributes() |
366 | ); |
e16da3e6 |
367 | } |
368 | |
5f3c057a |
369 | sub clone_object { |
370 | my $class = shift; |
0ac992ee |
371 | my $instance = shift; |
651955fb |
372 | (blessed($instance) && $instance->isa($class->name)) |
373 | || confess "You must pass an instance ($instance) of the metaclass (" . $class->name . ")"; |
374 | # NOTE: |
0ac992ee |
375 | # we need to protect the integrity of the |
376 | # Class::MOP::Class singletons here, they |
a740253a |
377 | # should not be cloned. |
0ac992ee |
378 | return $instance if $instance->isa('Class::MOP::Class'); |
f7259199 |
379 | $class->clone_instance($instance, @_); |
5f3c057a |
380 | } |
381 | |
c9e77dbb |
382 | sub clone_instance { |
651955fb |
383 | my ($class, $instance, %params) = @_; |
384 | (blessed($instance)) |
c9e77dbb |
385 | || confess "You can only clone instances, \$self is not a blessed instance"; |
f7259199 |
386 | my $meta_instance = $class->get_meta_instance(); |
0ac992ee |
387 | my $clone = $meta_instance->clone_instance($instance); |
c23184fc |
388 | foreach my $attr ($class->compute_all_applicable_attributes()) { |
795a0c8b |
389 | if (exists $params{$attr->init_arg}) { |
0ac992ee |
390 | $meta_instance->set_slot_value($clone, $attr->name, $params{$attr->init_arg}); |
c23184fc |
391 | } |
0ac992ee |
392 | } |
393 | return $clone; |
c9e77dbb |
394 | } |
395 | |
3d9e4646 |
396 | sub rebless_instance { |
3cd40f5e |
397 | my ($self, $instance) = @_; |
398 | my $old_metaclass = $instance->meta(); |
1a720916 |
399 | my $meta_instance = $self->get_meta_instance(); |
3d9e4646 |
400 | |
3cd40f5e |
401 | $self->name->isa($old_metaclass->name) |
402 | || confess "You may rebless only into a subclass. (". $self->name .") is not a subclass of (". $old_metaclass->name .")."; |
9b71b643 |
403 | |
1a720916 |
404 | # rebless! |
3cd40f5e |
405 | $meta_instance->rebless_instance_structure($instance, $self); |
1a720916 |
406 | |
407 | # check and upgrade all attributes |
a93136d1 |
408 | my %params = map { $_->name => $meta_instance->get_slot_value($instance, $_->name) } |
1a720916 |
409 | grep { $meta_instance->is_slot_initialized($instance, $_->name) } |
3cd40f5e |
410 | $self->compute_all_applicable_attributes; |
1a720916 |
411 | |
3cd40f5e |
412 | foreach my $attr ($self->compute_all_applicable_attributes) { |
1a720916 |
413 | $attr->initialize_instance_slot($meta_instance, $instance, \%params); |
414 | } |
3d9e4646 |
415 | } |
416 | |
8b978dd5 |
417 | # Inheritance |
418 | |
419 | sub superclasses { |
420 | my $self = shift; |
8b978dd5 |
421 | if (@_) { |
422 | my @supers = @_; |
9d6dce77 |
423 | @{$self->get_package_symbol('@ISA')} = @supers; |
d82060fe |
424 | # NOTE: |
0ac992ee |
425 | # we need to check the metaclass |
84086365 |
426 | # compatibility here so that we can |
0ac992ee |
427 | # be sure that the superclass is |
428 | # not potentially creating an issues |
d82060fe |
429 | # we don't know about |
430 | $self->check_metaclass_compatability(); |
8b978dd5 |
431 | } |
9d6dce77 |
432 | @{$self->get_package_symbol('@ISA')}; |
8b978dd5 |
433 | } |
434 | |
7160cad4 |
435 | sub subclasses { |
436 | my $self = shift; |
437 | |
438 | my $super_class = $self->name; |
439 | my @derived_classes; |
440 | |
441 | my $find_derived_classes; |
442 | $find_derived_classes = sub { |
443 | my ($outer_class) = @_; |
444 | |
445 | my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} }; |
446 | |
c1d5345a |
447 | SYMBOL: |
7160cad4 |
448 | for my $symbol ( keys %$symbol_table_hashref ) { |
449 | next SYMBOL if $symbol !~ /\A (\w+):: \z/x; |
450 | my $inner_class = $1; |
451 | |
452 | next SYMBOL if $inner_class eq 'SUPER'; # skip '*::SUPER' |
453 | |
454 | my $class = |
455 | $outer_class |
456 | ? "${outer_class}::$inner_class" |
457 | : $inner_class; |
458 | |
459 | if ( $class->isa($super_class) and $class ne $super_class ) { |
460 | push @derived_classes, $class; |
461 | } |
462 | |
463 | next SYMBOL if $class eq 'main'; # skip 'main::*' |
464 | |
465 | $find_derived_classes->($class); |
466 | } |
467 | }; |
468 | |
469 | my $root_class = q{}; |
470 | $find_derived_classes->($root_class); |
471 | |
472 | undef $find_derived_classes; |
473 | |
474 | @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes; |
475 | |
476 | return @derived_classes; |
477 | } |
478 | |
479 | |
b7bdffc3 |
480 | sub linearized_isa { |
c1d5345a |
481 | if (Class::MOP::IS_RUNNING_ON_5_10()) { |
482 | return @{ mro::get_linear_isa( (shift)->name ) }; |
483 | } |
484 | else { |
485 | my %seen; |
486 | return grep { !($seen{$_}++) } (shift)->class_precedence_list; |
487 | } |
b7bdffc3 |
488 | } |
489 | |
8b978dd5 |
490 | sub class_precedence_list { |
491 | my $self = shift; |
c1d5345a |
492 | |
493 | unless (Class::MOP::IS_RUNNING_ON_5_10()) { |
494 | # NOTE: |
495 | # We need to check for circular inheritance here |
496 | # if we are are not on 5.10, cause 5.8 detects it |
497 | # late. This will do nothing if all is well, and |
498 | # blow up otherwise. Yes, it's an ugly hack, better |
499 | # suggestions are welcome. |
500 | # - SL |
501 | ($self->name || return)->isa('This is a test for circular inheritance') |
502 | } |
0ac992ee |
503 | |
8b978dd5 |
504 | ( |
0ac992ee |
505 | $self->name, |
506 | map { |
f7259199 |
507 | $self->initialize($_)->class_precedence_list() |
8b978dd5 |
508 | } $self->superclasses() |
0ac992ee |
509 | ); |
8b978dd5 |
510 | } |
511 | |
0882828e |
512 | ## Methods |
513 | |
514 | sub add_method { |
515 | my ($self, $method_name, $method) = @_; |
516 | (defined $method_name && $method_name) |
517 | || confess "You must define a method name"; |
0ac992ee |
518 | |
7855ddba |
519 | my $body; |
7855ddba |
520 | if (blessed($method)) { |
0ac992ee |
521 | $body = $method->body; |
7855ddba |
522 | } |
0ac992ee |
523 | else { |
7855ddba |
524 | $body = $method; |
7855ddba |
525 | ('CODE' eq (reftype($body) || '')) |
0ac992ee |
526 | || confess "Your code block must be a CODE reference"; |
527 | $method = $self->method_metaclass->wrap($body); |
7855ddba |
528 | } |
0f71bc80 |
529 | $self->get_method_map->{$method_name} = $method; |
0ac992ee |
530 | |
531 | my $full_method_name = ($self->name . '::' . $method_name); |
7855ddba |
532 | $self->add_package_symbol("&${method_name}" => subname $full_method_name => $body); |
715adbb7 |
533 | $self->update_package_cache_flag; |
0882828e |
534 | } |
535 | |
a4258ffd |
536 | { |
2d711cc8 |
537 | my $fetch_and_prepare_method = sub { |
538 | my ($self, $method_name) = @_; |
539 | # fetch it locally |
540 | my $method = $self->get_method($method_name); |
541 | # if we dont have local ... |
542 | unless ($method) { |
195f5bf8 |
543 | # try to find the next method |
544 | $method = $self->find_next_method_by_name($method_name); |
545 | # die if it does not exist |
546 | (defined $method) |
804f7d24 |
547 | || confess "The method '$method_name' is not found in the inheritance hierarchy for class " . $self->name; |
0ac992ee |
548 | # and now make sure to wrap it |
195f5bf8 |
549 | # even if it is already wrapped |
550 | # because we need a new sub ref |
2d711cc8 |
551 | $method = Class::MOP::Method::Wrapped->wrap($method); |
195f5bf8 |
552 | } |
553 | else { |
0ac992ee |
554 | # now make sure we wrap it properly |
195f5bf8 |
555 | $method = Class::MOP::Method::Wrapped->wrap($method) |
0ac992ee |
556 | unless $method->isa('Class::MOP::Method::Wrapped'); |
557 | } |
558 | $self->add_method($method_name => $method); |
2d711cc8 |
559 | return $method; |
560 | }; |
561 | |
562 | sub add_before_method_modifier { |
563 | my ($self, $method_name, $method_modifier) = @_; |
564 | (defined $method_name && $method_name) |
0ac992ee |
565 | || confess "You must pass in a method name"; |
2d711cc8 |
566 | my $method = $fetch_and_prepare_method->($self, $method_name); |
567 | $method->add_before_modifier(subname ':before' => $method_modifier); |
568 | } |
569 | |
570 | sub add_after_method_modifier { |
571 | my ($self, $method_name, $method_modifier) = @_; |
572 | (defined $method_name && $method_name) |
0ac992ee |
573 | || confess "You must pass in a method name"; |
2d711cc8 |
574 | my $method = $fetch_and_prepare_method->($self, $method_name); |
575 | $method->add_after_modifier(subname ':after' => $method_modifier); |
576 | } |
0ac992ee |
577 | |
2d711cc8 |
578 | sub add_around_method_modifier { |
579 | my ($self, $method_name, $method_modifier) = @_; |
580 | (defined $method_name && $method_name) |
581 | || confess "You must pass in a method name"; |
582 | my $method = $fetch_and_prepare_method->($self, $method_name); |
583 | $method->add_around_modifier(subname ':around' => $method_modifier); |
0ac992ee |
584 | } |
a4258ffd |
585 | |
0ac992ee |
586 | # NOTE: |
8c936afc |
587 | # the methods above used to be named like this: |
588 | # ${pkg}::${method}:(before|after|around) |
589 | # but this proved problematic when using one modifier |
590 | # to wrap multiple methods (something which is likely |
591 | # to happen pretty regularly IMO). So instead of naming |
0ac992ee |
592 | # it like this, I have chosen to just name them purely |
8c936afc |
593 | # with their modifier names, like so: |
594 | # :(before|after|around) |
0ac992ee |
595 | # The fact is that in a stack trace, it will be fairly |
8c936afc |
596 | # evident from the context what method they are attached |
597 | # to, and so don't need the fully qualified name. |
ee5e71d4 |
598 | } |
599 | |
663f8198 |
600 | sub alias_method { |
601 | my ($self, $method_name, $method) = @_; |
602 | (defined $method_name && $method_name) |
603 | || confess "You must define a method name"; |
de19f115 |
604 | |
0f71bc80 |
605 | my $body = (blessed($method) ? $method->body : $method); |
606 | ('CODE' eq (reftype($body) || '')) |
0ac992ee |
607 | || confess "Your code block must be a CODE reference"; |
608 | |
7855ddba |
609 | $self->add_package_symbol("&${method_name}" => $body); |
715adbb7 |
610 | $self->update_package_cache_flag; |
16e960bd |
611 | } |
612 | |
de19f115 |
613 | sub has_method { |
614 | my ($self, $method_name) = @_; |
615 | (defined $method_name && $method_name) |
0ac992ee |
616 | || confess "You must define a method name"; |
617 | |
618 | return 0 unless exists $self->get_method_map->{$method_name}; |
de19f115 |
619 | return 1; |
0882828e |
620 | } |
621 | |
622 | sub get_method { |
c9b8b7f9 |
623 | my ($self, $method_name) = @_; |
0882828e |
624 | (defined $method_name && $method_name) |
625 | || confess "You must define a method name"; |
0ac992ee |
626 | |
0f71bc80 |
627 | # NOTE: |
628 | # I don't really need this here, because |
0ac992ee |
629 | # if the method_map is missing a key it |
0f71bc80 |
630 | # will just return undef for me now |
631 | # return unless $self->has_method($method_name); |
0ac992ee |
632 | |
7855ddba |
633 | return $self->get_method_map->{$method_name}; |
c9b8b7f9 |
634 | } |
635 | |
636 | sub remove_method { |
637 | my ($self, $method_name) = @_; |
638 | (defined $method_name && $method_name) |
639 | || confess "You must define a method name"; |
0ac992ee |
640 | |
e0e4674a |
641 | my $removed_method = delete $self->get_method_map->{$method_name}; |
642 | |
643 | $self->remove_package_symbol("&${method_name}"); |
644 | |
715adbb7 |
645 | $self->update_package_cache_flag; |
0ac992ee |
646 | |
c9b8b7f9 |
647 | return $removed_method; |
648 | } |
649 | |
650 | sub get_method_list { |
651 | my $self = shift; |
0f71bc80 |
652 | keys %{$self->get_method_map}; |
7855ddba |
653 | } |
654 | |
655 | sub find_method_by_name { |
656 | my ($self, $method_name) = @_; |
b9575695 |
657 | (defined $method_name && $method_name) |
0ac992ee |
658 | || confess "You must define a method name to find"; |
b7bdffc3 |
659 | foreach my $class ($self->linearized_isa) { |
b9575695 |
660 | # fetch the meta-class ... |
661 | my $meta = $self->initialize($class); |
0ac992ee |
662 | return $meta->get_method($method_name) |
b9575695 |
663 | if $meta->has_method($method_name); |
664 | } |
665 | return; |
a5eca695 |
666 | } |
667 | |
668 | sub compute_all_applicable_methods { |
669 | my $self = shift; |
b7bdffc3 |
670 | my (@methods, %seen_method); |
671 | foreach my $class ($self->linearized_isa) { |
a5eca695 |
672 | # fetch the meta-class ... |
673 | my $meta = $self->initialize($class); |
0ac992ee |
674 | foreach my $method_name ($meta->get_method_list()) { |
a5eca695 |
675 | next if exists $seen_method{$method_name}; |
676 | $seen_method{$method_name}++; |
677 | push @methods => { |
0ac992ee |
678 | name => $method_name, |
a5eca695 |
679 | class => $class, |
680 | code => $meta->get_method($method_name) |
681 | }; |
682 | } |
683 | } |
684 | return @methods; |
685 | } |
686 | |
a5eca695 |
687 | sub find_all_methods_by_name { |
688 | my ($self, $method_name) = @_; |
689 | (defined $method_name && $method_name) |
0ac992ee |
690 | || confess "You must define a method name to find"; |
a5eca695 |
691 | my @methods; |
b7bdffc3 |
692 | foreach my $class ($self->linearized_isa) { |
a5eca695 |
693 | # fetch the meta-class ... |
96ceced8 |
694 | my $meta = $self->initialize($class); |
a5eca695 |
695 | push @methods => { |
0ac992ee |
696 | name => $method_name, |
a5eca695 |
697 | class => $class, |
698 | code => $meta->get_method($method_name) |
699 | } if $meta->has_method($method_name); |
700 | } |
701 | return @methods; |
8b978dd5 |
702 | } |
703 | |
96ceced8 |
704 | sub find_next_method_by_name { |
705 | my ($self, $method_name) = @_; |
706 | (defined $method_name && $method_name) |
0ac992ee |
707 | || confess "You must define a method name to find"; |
b7bdffc3 |
708 | my @cpl = $self->linearized_isa; |
2d711cc8 |
709 | shift @cpl; # discard ourselves |
96ceced8 |
710 | foreach my $class (@cpl) { |
96ceced8 |
711 | # fetch the meta-class ... |
712 | my $meta = $self->initialize($class); |
0ac992ee |
713 | return $meta->get_method($method_name) |
2d711cc8 |
714 | if $meta->has_method($method_name); |
96ceced8 |
715 | } |
2d711cc8 |
716 | return; |
96ceced8 |
717 | } |
718 | |
552e3d24 |
719 | ## Attributes |
720 | |
e16da3e6 |
721 | sub add_attribute { |
2e41896e |
722 | my $self = shift; |
723 | # either we have an attribute object already |
724 | # or we need to create one from the args provided |
725 | my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_); |
726 | # make sure it is derived from the correct type though |
727 | ($attribute->isa('Class::MOP::Attribute')) |
0ac992ee |
728 | || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)"; |
b1897d4d |
729 | |
730 | # first we attach our new attribute |
0ac992ee |
731 | # because it might need certain information |
b1897d4d |
732 | # about the class which it is attached to |
9ec169fe |
733 | $attribute->attach_to_class($self); |
0ac992ee |
734 | |
735 | # then we remove attributes of a conflicting |
736 | # name here so that we can properly detach |
737 | # the old attr object, and remove any |
b1897d4d |
738 | # accessors it would have generated |
739 | $self->remove_attribute($attribute->name) |
740 | if $self->has_attribute($attribute->name); |
0ac992ee |
741 | |
b1897d4d |
742 | # then onto installing the new accessors |
2d711cc8 |
743 | $attribute->install_accessors(); |
291073fc |
744 | $self->get_attribute_map->{$attribute->name} = $attribute; |
e16da3e6 |
745 | } |
746 | |
747 | sub has_attribute { |
748 | my ($self, $attribute_name) = @_; |
749 | (defined $attribute_name && $attribute_name) |
750 | || confess "You must define an attribute name"; |
0ac992ee |
751 | exists $self->get_attribute_map->{$attribute_name} ? 1 : 0; |
752 | } |
e16da3e6 |
753 | |
754 | sub get_attribute { |
755 | my ($self, $attribute_name) = @_; |
756 | (defined $attribute_name && $attribute_name) |
757 | || confess "You must define an attribute name"; |
0ac992ee |
758 | return $self->get_attribute_map->{$attribute_name} |
b1897d4d |
759 | # NOTE: |
760 | # this will return undef anyway, so no need ... |
0ac992ee |
761 | # if $self->has_attribute($attribute_name); |
762 | #return; |
763 | } |
e16da3e6 |
764 | |
765 | sub remove_attribute { |
766 | my ($self, $attribute_name) = @_; |
767 | (defined $attribute_name && $attribute_name) |
768 | || confess "You must define an attribute name"; |
0ac992ee |
769 | my $removed_attribute = $self->get_attribute_map->{$attribute_name}; |
22286063 |
770 | return unless defined $removed_attribute; |
0ac992ee |
771 | delete $self->get_attribute_map->{$attribute_name}; |
772 | $removed_attribute->remove_accessors(); |
2d711cc8 |
773 | $removed_attribute->detach_from_class(); |
e16da3e6 |
774 | return $removed_attribute; |
0ac992ee |
775 | } |
e16da3e6 |
776 | |
777 | sub get_attribute_list { |
778 | my $self = shift; |
f7259199 |
779 | keys %{$self->get_attribute_map}; |
0ac992ee |
780 | } |
e16da3e6 |
781 | |
782 | sub compute_all_applicable_attributes { |
783 | my $self = shift; |
b7bdffc3 |
784 | my (@attrs, %seen_attr); |
785 | foreach my $class ($self->linearized_isa) { |
e16da3e6 |
786 | # fetch the meta-class ... |
f7259199 |
787 | my $meta = $self->initialize($class); |
0ac992ee |
788 | foreach my $attr_name ($meta->get_attribute_list()) { |
e16da3e6 |
789 | next if exists $seen_attr{$attr_name}; |
790 | $seen_attr{$attr_name}++; |
c9e77dbb |
791 | push @attrs => $meta->get_attribute($attr_name); |
e16da3e6 |
792 | } |
793 | } |
0ac992ee |
794 | return @attrs; |
e16da3e6 |
795 | } |
2eb717d5 |
796 | |
058c1cf5 |
797 | sub find_attribute_by_name { |
798 | my ($self, $attr_name) = @_; |
b7bdffc3 |
799 | foreach my $class ($self->linearized_isa) { |
058c1cf5 |
800 | # fetch the meta-class ... |
801 | my $meta = $self->initialize($class); |
802 | return $meta->get_attribute($attr_name) |
803 | if $meta->has_attribute($attr_name); |
804 | } |
805 | return; |
806 | } |
807 | |
857f87a7 |
808 | ## Class closing |
809 | |
810 | sub is_mutable { 1 } |
811 | sub is_immutable { 0 } |
812 | |
b817e248 |
813 | # NOTE: |
814 | # Why I changed this (groditi) |
815 | # - One Metaclass may have many Classes through many Metaclass instances |
816 | # - One Metaclass should only have one Immutable Transformer instance |
817 | # - Each Class may have different Immutabilizing options |
818 | # - Therefore each Metaclass instance may have different Immutabilizing options |
819 | # - We need to store one Immutable Transformer instance per Metaclass |
820 | # - We need to store one set of Immutable Transformer options per Class |
821 | # - Upon make_mutable we may delete the Immutabilizing options |
822 | # - We could clean the immutable Transformer instance when there is no more |
823 | # immutable Classes of that type, but we can also keep it in case |
824 | # another class with this same Metaclass becomes immutable. It is a case |
825 | # of trading of storing an instance to avoid unnecessary instantiations of |
826 | # Immutable Transformers. You may view this as a memory leak, however |
827 | # Because we have few Metaclasses, in practice it seems acceptable |
828 | # - To allow Immutable Transformers instances to be cleaned up we could weaken |
829 | # the reference stored in $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM |
04dd7510 |
830 | |
c23184fc |
831 | { |
d9586da2 |
832 | my %IMMUTABLE_TRANSFORMERS; |
0ac992ee |
833 | my %IMMUTABLE_OPTIONS; |
c23184fc |
834 | sub make_immutable { |
0ac992ee |
835 | my $self = shift; |
04dd7510 |
836 | my %options = @_; |
d9586da2 |
837 | my $class = blessed $self || $self; |
838 | |
839 | $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer; |
840 | my $transformer = $IMMUTABLE_TRANSFORMERS{$class}; |
841 | |
229910b5 |
842 | $transformer->make_metaclass_immutable($self, \%options); |
7f63694d |
843 | $IMMUTABLE_OPTIONS{$self->name} = |
d9586da2 |
844 | { %options, IMMUTABLE_TRANSFORMER => $transformer }; |
04dd7510 |
845 | |
846 | if( exists $options{debug} && $options{debug} ){ |
d9586da2 |
847 | print STDERR "# of Metaclass options: ", keys %IMMUTABLE_OPTIONS; |
848 | print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS; |
04dd7510 |
849 | } |
c23184fc |
850 | } |
0ac992ee |
851 | |
852 | sub make_mutable{ |
853 | my $self = shift; |
854 | return if $self->is_mutable; |
7f63694d |
855 | my $options = delete $IMMUTABLE_OPTIONS{$self->name}; |
1d68af04 |
856 | confess "unable to find immutabilizing options" unless ref $options; |
d9586da2 |
857 | my $transformer = delete $options->{IMMUTABLE_TRANSFORMER}; |
229910b5 |
858 | $transformer->make_metaclass_mutable($self, $options); |
0ac992ee |
859 | } |
d9586da2 |
860 | } |
0ac992ee |
861 | |
d9586da2 |
862 | sub create_immutable_transformer { |
863 | my $self = shift; |
864 | my $class = Class::MOP::Immutable->new($self, { |
865 | read_only => [qw/superclasses/], |
866 | cannot_call => [qw/ |
867 | add_method |
868 | alias_method |
869 | remove_method |
870 | add_attribute |
871 | remove_attribute |
872 | add_package_symbol |
873 | remove_package_symbol |
874 | /], |
875 | memoize => { |
876 | class_precedence_list => 'ARRAY', |
b7bdffc3 |
877 | linearized_isa => 'ARRAY', |
d9586da2 |
878 | compute_all_applicable_attributes => 'ARRAY', |
879 | get_meta_instance => 'SCALAR', |
880 | get_method_map => 'SCALAR', |
881 | } |
882 | }); |
883 | return $class; |
857f87a7 |
884 | } |
885 | |
8b978dd5 |
886 | 1; |
887 | |
888 | __END__ |
889 | |
890 | =pod |
891 | |
0ac992ee |
892 | =head1 NAME |
8b978dd5 |
893 | |
894 | Class::MOP::Class - Class Meta Object |
895 | |
896 | =head1 SYNOPSIS |
897 | |
0ac992ee |
898 | # assuming that class Foo |
8c936afc |
899 | # has been defined, you can |
0ac992ee |
900 | |
fe122940 |
901 | # use this for introspection ... |
0ac992ee |
902 | |
fe122940 |
903 | # add a method to Foo ... |
904 | Foo->meta->add_method('bar' => sub { ... }) |
0ac992ee |
905 | |
906 | # get a list of all the classes searched |
907 | # the method dispatcher in the correct order |
fe122940 |
908 | Foo->meta->class_precedence_list() |
0ac992ee |
909 | |
fe122940 |
910 | # remove a method from Foo |
911 | Foo->meta->remove_method('bar'); |
0ac992ee |
912 | |
fe122940 |
913 | # or use this to actually create classes ... |
0ac992ee |
914 | |
88dd563c |
915 | Class::MOP::Class->create('Bar' => ( |
916 | version => '0.01', |
fe122940 |
917 | superclasses => [ 'Foo' ], |
918 | attributes => [ |
919 | Class::MOP:::Attribute->new('$bar'), |
0ac992ee |
920 | Class::MOP:::Attribute->new('$baz'), |
fe122940 |
921 | ], |
922 | methods => { |
923 | calculate_bar => sub { ... }, |
0ac992ee |
924 | construct_baz => sub { ... } |
fe122940 |
925 | } |
926 | )); |
927 | |
8b978dd5 |
928 | =head1 DESCRIPTION |
929 | |
0ac992ee |
930 | This is the largest and currently most complex part of the Perl 5 |
931 | meta-object protocol. It controls the introspection and |
932 | manipulation of Perl 5 classes (and it can create them too). The |
933 | best way to understand what this module can do, is to read the |
fe122940 |
934 | documentation for each of it's methods. |
935 | |
552e3d24 |
936 | =head1 METHODS |
937 | |
2eb717d5 |
938 | =head2 Self Introspection |
939 | |
940 | =over 4 |
941 | |
942 | =item B<meta> |
943 | |
0ac992ee |
944 | This will return a B<Class::MOP::Class> instance which is related |
945 | to this class. Thereby allowing B<Class::MOP::Class> to actually |
fe122940 |
946 | introspect itself. |
947 | |
0ac992ee |
948 | As with B<Class::MOP::Attribute>, B<Class::MOP> will actually |
949 | bootstrap this module by installing a number of attribute meta-objects |
950 | into it's metaclass. This will allow this class to reap all the benifits |
951 | of the MOP when subclassing it. |
2eb717d5 |
952 | |
953 | =back |
954 | |
552e3d24 |
955 | =head2 Class construction |
956 | |
0ac992ee |
957 | These methods will handle creating B<Class::MOP::Class> objects, |
958 | which can be used to both create new classes, and analyze |
959 | pre-existing classes. |
552e3d24 |
960 | |
0ac992ee |
961 | This module will internally store references to all the instances |
962 | you create with these methods, so that they do not need to be |
552e3d24 |
963 | created any more than nessecary. Basically, they are singletons. |
964 | |
965 | =over 4 |
966 | |
0ac992ee |
967 | =item B<create ($package_name, |
968 | version =E<gt> ?$version, |
969 | authority =E<gt> ?$authority, |
970 | superclasses =E<gt> ?@superclasses, |
971 | methods =E<gt> ?%methods, |
a2e85e6c |
972 | attributes =E<gt> ?%attributes)> |
552e3d24 |
973 | |
0ac992ee |
974 | This returns a B<Class::MOP::Class> object, bringing the specified |
975 | C<$package_name> into existence and adding any of the C<$version>, |
976 | C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to |
88dd563c |
977 | it. |
552e3d24 |
978 | |
0ac992ee |
979 | =item B<create_anon_class (superclasses =E<gt> ?@superclasses, |
980 | methods =E<gt> ?%methods, |
587aca23 |
981 | attributes =E<gt> ?%attributes)> |
982 | |
0ac992ee |
983 | This will create an anonymous class, it works much like C<create> but |
984 | it does not need a C<$package_name>. Instead it will create a suitably |
587aca23 |
985 | unique package name for you to stash things into. |
986 | |
0ac992ee |
987 | On very important distinction is that anon classes are destroyed once |
988 | the metaclass they are attached to goes out of scope. In the DESTROY |
989 | method, the created package will be removed from the symbol table. |
823a5d31 |
990 | |
d4ba1677 |
991 | It is also worth noting that any instances created with an anon-class |
0ac992ee |
992 | will keep a special reference to the anon-meta which will prevent the |
993 | anon-class from going out of scope until all instances of it have also |
994 | been destroyed. This however only works for HASH based instance types, |
995 | as we use a special reserved slot (C<__MOP__>) to store this. |
d4ba1677 |
996 | |
66b3dded |
997 | =item B<initialize ($package_name, %options)> |
552e3d24 |
998 | |
0ac992ee |
999 | This initializes and returns returns a B<Class::MOP::Class> object |
a2e85e6c |
1000 | for a given a C<$package_name>. |
1001 | |
66b3dded |
1002 | =item B<reinitialize ($package_name, %options)> |
1003 | |
1004 | This removes the old metaclass, and creates a new one in it's place. |
0ac992ee |
1005 | Do B<not> use this unless you really know what you are doing, it could |
1006 | very easily make a very large mess of your program. |
66b3dded |
1007 | |
651955fb |
1008 | =item B<construct_class_instance (%options)> |
a2e85e6c |
1009 | |
0ac992ee |
1010 | This will construct an instance of B<Class::MOP::Class>, it is |
1011 | here so that we can actually "tie the knot" for B<Class::MOP::Class> |
1012 | to use C<construct_instance> once all the bootstrapping is done. This |
a2e85e6c |
1013 | method is used internally by C<initialize> and should never be called |
1014 | from outside of that method really. |
552e3d24 |
1015 | |
550d56db |
1016 | =item B<check_metaclass_compatability> |
1017 | |
0ac992ee |
1018 | This method is called as the very last thing in the |
1019 | C<construct_class_instance> method. This will check that the |
1020 | metaclass you are creating is compatible with the metaclasses of all |
1021 | your ancestors. For more inforamtion about metaclass compatibility |
550d56db |
1022 | see the C<About Metaclass compatibility> section in L<Class::MOP>. |
1023 | |
715adbb7 |
1024 | =item B<update_package_cache_flag> |
e0e4674a |
1025 | |
1026 | This will reset the package cache flag for this particular metaclass |
1027 | it is basically the value of the C<Class::MOP::get_package_cache_flag> |
1028 | function. This is very rarely needed from outside of C<Class::MOP::Class> |
1029 | but in some cases you might want to use it, so it is here. |
1030 | |
715adbb7 |
1031 | =item B<reset_package_cache_flag> |
1032 | |
1033 | Clear this flag, used in Moose. |
1034 | |
552e3d24 |
1035 | =back |
1036 | |
c9e77dbb |
1037 | =head2 Object instance construction and cloning |
a2e85e6c |
1038 | |
0ac992ee |
1039 | These methods are B<entirely optional>, it is up to you whether you want |
c9e77dbb |
1040 | to use them or not. |
552e3d24 |
1041 | |
1042 | =over 4 |
1043 | |
2bab2be6 |
1044 | =item B<instance_metaclass> |
1045 | |
2d711cc8 |
1046 | =item B<get_meta_instance> |
1047 | |
5f3c057a |
1048 | =item B<new_object (%params)> |
1049 | |
0ac992ee |
1050 | This is a convience method for creating a new object of the class, and |
1051 | blessing it into the appropriate package as well. Ideally your class |
5f3c057a |
1052 | would call a C<new> this method like so: |
1053 | |
0ac992ee |
1054 | sub MyClass::new { |
5f3c057a |
1055 | my ($class, %param) = @_; |
1056 | $class->meta->new_object(%params); |
1057 | } |
1058 | |
0ac992ee |
1059 | Of course the ideal place for this would actually be in C<UNIVERSAL::> |
5f3c057a |
1060 | but that is considered bad style, so we do not do that. |
1061 | |
cbd9f942 |
1062 | =item B<construct_instance (%params)> |
552e3d24 |
1063 | |
0ac992ee |
1064 | This method is used to construct an instace structure suitable for |
1065 | C<bless>-ing into your package of choice. It works in conjunction |
c9e77dbb |
1066 | with the Attribute protocol to collect all applicable attributes. |
1067 | |
0ac992ee |
1068 | This will construct and instance using a HASH ref as storage |
1069 | (currently only HASH references are supported). This will collect all |
1070 | the applicable attributes and layout out the fields in the HASH ref, |
1071 | it will then initialize them using either use the corresponding key |
1072 | in C<%params> or any default value or initializer found in the |
a2e85e6c |
1073 | attribute meta-object. |
727919c5 |
1074 | |
5f3c057a |
1075 | =item B<clone_object ($instance, %params)> |
1076 | |
0ac992ee |
1077 | This is a convience method for cloning an object instance, then |
1078 | blessing it into the appropriate package. This method will call |
1079 | C<clone_instance>, which performs a shallow copy of the object, |
1080 | see that methods documentation for more details. Ideally your |
19d4b5b8 |
1081 | class would call a C<clone> this method like so: |
5f3c057a |
1082 | |
1083 | sub MyClass::clone { |
1084 | my ($self, %param) = @_; |
1085 | $self->meta->clone_object($self, %params); |
1086 | } |
1087 | |
0ac992ee |
1088 | Of course the ideal place for this would actually be in C<UNIVERSAL::> |
5f3c057a |
1089 | but that is considered bad style, so we do not do that. |
1090 | |
c9e77dbb |
1091 | =item B<clone_instance($instance, %params)> |
1092 | |
0ac992ee |
1093 | This method is a compliment of C<construct_instance> (which means if |
1094 | you override C<construct_instance>, you need to override this one too), |
19d4b5b8 |
1095 | and clones the instance shallowly. |
a27ae83f |
1096 | |
0ac992ee |
1097 | The cloned structure returned is (like with C<construct_instance>) an |
1098 | unC<bless>ed HASH reference, it is your responsibility to then bless |
a27ae83f |
1099 | this cloned structure into the right class (which C<clone_object> will |
1100 | do for you). |
c9e77dbb |
1101 | |
0ac992ee |
1102 | As of 0.11, this method will clone the C<$instance> structure shallowly, |
1103 | as opposed to the deep cloning implemented in prior versions. After much |
1104 | thought, research and discussion, I have decided that anything but basic |
1105 | shallow cloning is outside the scope of the meta-object protocol. I |
1106 | think Yuval "nothingmuch" Kogman put it best when he said that cloning |
19d4b5b8 |
1107 | is too I<context-specific> to be part of the MOP. |
1108 | |
552e3d24 |
1109 | =back |
1110 | |
0ac992ee |
1111 | =head2 Informational |
552e3d24 |
1112 | |
b9d9fc0b |
1113 | These are a few predicate methods for asking information about the class. |
552e3d24 |
1114 | |
b9d9fc0b |
1115 | =over 4 |
552e3d24 |
1116 | |
b9d9fc0b |
1117 | =item B<is_anon_class> |
552e3d24 |
1118 | |
96e38ba6 |
1119 | This returns true if the class is a C<Class::MOP::Class> created anon class. |
1120 | |
b9d9fc0b |
1121 | =item B<is_mutable> |
552e3d24 |
1122 | |
96e38ba6 |
1123 | This returns true if the class is still mutable. |
1124 | |
b9d9fc0b |
1125 | =item B<is_immutable> |
552e3d24 |
1126 | |
96e38ba6 |
1127 | This returns true if the class has been made immutable. |
1128 | |
552e3d24 |
1129 | =back |
1130 | |
1131 | =head2 Inheritance Relationships |
1132 | |
1133 | =over 4 |
1134 | |
1135 | =item B<superclasses (?@superclasses)> |
1136 | |
0ac992ee |
1137 | This is a read-write attribute which represents the superclass |
a2e85e6c |
1138 | relationships of the class the B<Class::MOP::Class> instance is |
1139 | associated with. Basically, it can get and set the C<@ISA> for you. |
552e3d24 |
1140 | |
343203ee |
1141 | B<NOTE:> |
0ac992ee |
1142 | Perl will occasionally perform some C<@ISA> and method caching, if |
1143 | you decide to change your superclass relationship at runtime (which |
1144 | is quite insane and very much not recommened), then you should be |
1145 | aware of this and the fact that this module does not make any |
343203ee |
1146 | attempt to address this issue. |
1147 | |
552e3d24 |
1148 | =item B<class_precedence_list> |
1149 | |
0ac992ee |
1150 | This computes the a list of all the class's ancestors in the same order |
1151 | in which method dispatch will be done. This is similair to |
a2e85e6c |
1152 | what B<Class::ISA::super_path> does, but we don't remove duplicate names. |
552e3d24 |
1153 | |
b7bdffc3 |
1154 | =item B<linearized_isa> |
1155 | |
1156 | This returns a list based on C<class_precedence_list> but with all |
1157 | duplicates removed. |
1158 | |
6c9f390e |
1159 | =item B<subclasses> |
1160 | |
1161 | This returns a list of subclasses for this class. |
1162 | |
552e3d24 |
1163 | =back |
1164 | |
1165 | =head2 Methods |
1166 | |
1167 | =over 4 |
1168 | |
c4260b45 |
1169 | =item B<get_method_map> |
1170 | |
2e41896e |
1171 | =item B<method_metaclass> |
1172 | |
552e3d24 |
1173 | =item B<add_method ($method_name, $method)> |
1174 | |
0ac992ee |
1175 | This will take a C<$method_name> and CODE reference to that |
1176 | C<$method> and install it into the class's package. |
552e3d24 |
1177 | |
0ac992ee |
1178 | B<NOTE>: |
1179 | This does absolutely nothing special to C<$method> |
1180 | other than use B<Sub::Name> to make sure it is tagged with the |
1181 | correct name, and therefore show up correctly in stack traces and |
552e3d24 |
1182 | such. |
1183 | |
663f8198 |
1184 | =item B<alias_method ($method_name, $method)> |
1185 | |
0ac992ee |
1186 | This will take a C<$method_name> and CODE reference to that |
1187 | C<$method> and alias the method into the class's package. |
663f8198 |
1188 | |
0ac992ee |
1189 | B<NOTE>: |
1190 | Unlike C<add_method>, this will B<not> try to name the |
1191 | C<$method> using B<Sub::Name>, it only aliases the method in |
1192 | the class's package. |
663f8198 |
1193 | |
552e3d24 |
1194 | =item B<has_method ($method_name)> |
1195 | |
0ac992ee |
1196 | This just provides a simple way to check if the class implements |
1197 | a specific C<$method_name>. It will I<not> however, attempt to check |
a2e85e6c |
1198 | if the class inherits the method (use C<UNIVERSAL::can> for that). |
552e3d24 |
1199 | |
0ac992ee |
1200 | This will correctly handle functions defined outside of the package |
552e3d24 |
1201 | that use a fully qualified name (C<sub Package::name { ... }>). |
1202 | |
0ac992ee |
1203 | This will correctly handle functions renamed with B<Sub::Name> and |
1204 | installed using the symbol tables. However, if you are naming the |
1205 | subroutine outside of the package scope, you must use the fully |
1206 | qualified name, including the package name, for C<has_method> to |
1207 | correctly identify it. |
552e3d24 |
1208 | |
0ac992ee |
1209 | This will attempt to correctly ignore functions imported from other |
1210 | packages using B<Exporter>. It breaks down if the function imported |
1211 | is an C<__ANON__> sub (such as with C<use constant>), which very well |
1212 | may be a valid method being applied to the class. |
552e3d24 |
1213 | |
0ac992ee |
1214 | In short, this method cannot always be trusted to determine if the |
1215 | C<$method_name> is actually a method. However, it will DWIM about |
a2e85e6c |
1216 | 90% of the time, so it's a small trade off I think. |
552e3d24 |
1217 | |
1218 | =item B<get_method ($method_name)> |
1219 | |
0ac992ee |
1220 | This will return a Class::MOP::Method instance related to the specified |
86482605 |
1221 | C<$method_name>, or return undef if that method does not exist. |
1222 | |
0ac992ee |
1223 | The Class::MOP::Method is codifiable, so you can use it like a normal |
86482605 |
1224 | CODE reference, see L<Class::MOP::Method> for more information. |
552e3d24 |
1225 | |
16e960bd |
1226 | =item B<find_method_by_name ($method_name> |
1227 | |
1228 | This will return a CODE reference of the specified C<$method_name>, |
1229 | or return undef if that method does not exist. |
1230 | |
1231 | Unlike C<get_method> this will also look in the superclasses. |
1232 | |
552e3d24 |
1233 | =item B<remove_method ($method_name)> |
1234 | |
0ac992ee |
1235 | This will attempt to remove a given C<$method_name> from the class. |
1236 | It will return the CODE reference that it has removed, and will |
552e3d24 |
1237 | attempt to use B<Sub::Name> to clear the methods associated name. |
1238 | |
1239 | =item B<get_method_list> |
1240 | |
0ac992ee |
1241 | This will return a list of method names for all I<locally> defined |
1242 | methods. It does B<not> provide a list of all applicable methods, |
1243 | including any inherited ones. If you want a list of all applicable |
552e3d24 |
1244 | methods, use the C<compute_all_applicable_methods> method. |
1245 | |
1246 | =item B<compute_all_applicable_methods> |
1247 | |
0ac992ee |
1248 | This will return a list of all the methods names this class will |
1249 | respond to, taking into account inheritance. The list will be a list of |
1250 | HASH references, each one containing the following information; method |
1251 | name, the name of the class in which the method lives and a CODE |
552e3d24 |
1252 | reference for the actual method. |
1253 | |
1254 | =item B<find_all_methods_by_name ($method_name)> |
1255 | |
0ac992ee |
1256 | This will traverse the inheritence hierarchy and locate all methods |
1257 | with a given C<$method_name>. Similar to |
1258 | C<compute_all_applicable_methods> it returns a list of HASH references |
1259 | with the following information; method name (which will always be the |
1260 | same as C<$method_name>), the name of the class in which the method |
552e3d24 |
1261 | lives and a CODE reference for the actual method. |
1262 | |
0ac992ee |
1263 | The list of methods produced is a distinct list, meaning there are no |
1264 | duplicates in it. This is especially useful for things like object |
1265 | initialization and destruction where you only want the method called |
552e3d24 |
1266 | once, and in the correct order. |
1267 | |
96ceced8 |
1268 | =item B<find_next_method_by_name ($method_name)> |
1269 | |
0ac992ee |
1270 | This will return the first method to match a given C<$method_name> in |
1271 | the superclasses, this is basically equivalent to calling |
96ceced8 |
1272 | C<SUPER::$method_name>, but it can be dispatched at runtime. |
1273 | |
552e3d24 |
1274 | =back |
1275 | |
a4258ffd |
1276 | =head2 Method Modifiers |
1277 | |
0ac992ee |
1278 | Method modifiers are a concept borrowed from CLOS, in which a method |
1279 | can be wrapped with I<before>, I<after> and I<around> method modifiers |
1280 | that will be called everytime the method is called. |
96ceced8 |
1281 | |
1282 | =head3 How method modifiers work? |
1283 | |
0ac992ee |
1284 | Method modifiers work by wrapping the original method and then replacing |
1285 | it in the classes symbol table. The wrappers will handle calling all the |
1286 | modifiers in the appropariate orders and preserving the calling context |
1287 | for the original method. |
1288 | |
1289 | Each method modifier serves a particular purpose, which may not be |
1290 | obvious to users of other method wrapping modules. To start with, the |
1291 | return values of I<before> and I<after> modifiers are ignored. This is |
1292 | because thier purpose is B<not> to filter the input and output of the |
1293 | primary method (this is done with an I<around> modifier). This may seem |
1294 | like an odd restriction to some, but doing this allows for simple code |
1295 | to be added at the begining or end of a method call without jeapordizing |
1296 | the normal functioning of the primary method or placing any extra |
1297 | responsibility on the code of the modifier. Of course if you have more |
1298 | complex needs, then use the I<around> modifier, which uses a variation |
1299 | of continutation passing style to allow for a high degree of flexibility. |
1300 | |
1301 | Before and around modifiers are called in last-defined-first-called order, |
1302 | while after modifiers are called in first-defined-first-called order. So |
96ceced8 |
1303 | the call tree might looks something like this: |
0ac992ee |
1304 | |
96ceced8 |
1305 | before 2 |
1306 | before 1 |
1307 | around 2 |
1308 | around 1 |
1309 | primary |
1310 | after 1 |
1311 | after 2 |
1312 | |
0ac992ee |
1313 | To see examples of using method modifiers, see the following examples |
1314 | included in the distribution; F<InstanceCountingClass>, F<Perl6Attribute>, |
1315 | F<AttributesWithHistory> and F<C3MethodDispatchOrder>. There is also a |
96ceced8 |
1316 | classic CLOS usage example in the test F<017_add_method_modifier.t>. |
1317 | |
1318 | =head3 What is the performance impact? |
1319 | |
0ac992ee |
1320 | Of course there is a performance cost associated with method modifiers, |
1321 | but we have made every effort to make that cost be directly proportional |
96ceced8 |
1322 | to the amount of modifier features you utilize. |
1323 | |
0ac992ee |
1324 | The wrapping method does it's best to B<only> do as much work as it |
1325 | absolutely needs to. In order to do this we have moved some of the |
96ceced8 |
1326 | performance costs to set-up time, where they are easier to amortize. |
1327 | |
1328 | All this said, my benchmarks have indicated the following: |
1329 | |
1330 | simple wrapper with no modifiers 100% slower |
1331 | simple wrapper with simple before modifier 400% slower |
1332 | simple wrapper with simple after modifier 450% slower |
1333 | simple wrapper with simple around modifier 500-550% slower |
1334 | simple wrapper with all 3 modifiers 1100% slower |
1335 | |
0ac992ee |
1336 | These numbers may seem daunting, but you must remember, every feature |
1337 | comes with some cost. To put things in perspective, just doing a simple |
96ceced8 |
1338 | C<AUTOLOAD> which does nothing but extract the name of the method called |
0ac992ee |
1339 | and return it costs about 400% over a normal method call. |
96ceced8 |
1340 | |
a4258ffd |
1341 | =over 4 |
1342 | |
1343 | =item B<add_before_method_modifier ($method_name, $code)> |
1344 | |
0ac992ee |
1345 | This will wrap the method at C<$method_name> and the supplied C<$code> |
1346 | will be passed the C<@_> arguments, and called before the original |
1347 | method is called. As specified above, the return value of the I<before> |
1348 | method modifiers is ignored, and it's ability to modify C<@_> is |
1349 | fairly limited. If you need to do either of these things, use an |
96ceced8 |
1350 | C<around> method modifier. |
1351 | |
a4258ffd |
1352 | =item B<add_after_method_modifier ($method_name, $code)> |
1353 | |
0ac992ee |
1354 | This will wrap the method at C<$method_name> so that the original |
1355 | method will be called, it's return values stashed, and then the |
96ceced8 |
1356 | supplied C<$code> will be passed the C<@_> arguments, and called. |
0ac992ee |
1357 | As specified above, the return value of the I<after> method |
1358 | modifiers is ignored, and it cannot modify the return values of |
1359 | the original method. If you need to do either of these things, use an |
96ceced8 |
1360 | C<around> method modifier. |
1361 | |
a4258ffd |
1362 | =item B<add_around_method_modifier ($method_name, $code)> |
1363 | |
0ac992ee |
1364 | This will wrap the method at C<$method_name> so that C<$code> |
1365 | will be called and passed the original method as an extra argument |
1366 | at the begining of the C<@_> argument list. This is a variation of |
1367 | continuation passing style, where the function prepended to C<@_> |
1368 | can be considered a continuation. It is up to C<$code> if it calls |
1369 | the original method or not, there is no restriction on what the |
96ceced8 |
1370 | C<$code> can or cannot do. |
1371 | |
a4258ffd |
1372 | =back |
1373 | |
552e3d24 |
1374 | =head2 Attributes |
1375 | |
0ac992ee |
1376 | It should be noted that since there is no one consistent way to define |
1377 | the attributes of a class in Perl 5. These methods can only work with |
1378 | the information given, and can not easily discover information on |
a2e85e6c |
1379 | their own. See L<Class::MOP::Attribute> for more details. |
552e3d24 |
1380 | |
1381 | =over 4 |
1382 | |
2e41896e |
1383 | =item B<attribute_metaclass> |
1384 | |
7b31baf4 |
1385 | =item B<get_attribute_map> |
1386 | |
8203616d |
1387 | =item B<add_attribute ($attribute_meta_object | $attribute_name, %attribute_spec)> |
552e3d24 |
1388 | |
8203616d |
1389 | This stores the C<$attribute_meta_object> (or creates one from the |
0ac992ee |
1390 | C<$attribute_name> and C<%attribute_spec>) in the B<Class::MOP::Class> |
1391 | instance associated with the given class. Unlike methods, attributes |
1392 | within the MOP are stored as meta-information only. They will be used |
8203616d |
1393 | later to construct instances from (see C<construct_instance> above). |
0ac992ee |
1394 | More details about the attribute meta-objects can be found in the |
a2e85e6c |
1395 | L<Class::MOP::Attribute> or the L<Class::MOP/The Attribute protocol> |
1396 | section. |
1397 | |
0ac992ee |
1398 | It should be noted that any accessor, reader/writer or predicate |
1399 | methods which the C<$attribute_meta_object> has will be installed |
a2e85e6c |
1400 | into the class at this time. |
552e3d24 |
1401 | |
86482605 |
1402 | B<NOTE> |
0ac992ee |
1403 | If an attribute already exists for C<$attribute_name>, the old one |
1404 | will be removed (as well as removing all it's accessors), and then |
86482605 |
1405 | the new one added. |
1406 | |
552e3d24 |
1407 | =item B<has_attribute ($attribute_name)> |
1408 | |
0ac992ee |
1409 | Checks to see if this class has an attribute by the name of |
552e3d24 |
1410 | C<$attribute_name> and returns a boolean. |
1411 | |
1412 | =item B<get_attribute ($attribute_name)> |
1413 | |
0ac992ee |
1414 | Returns the attribute meta-object associated with C<$attribute_name>, |
1415 | if none is found, it will return undef. |
552e3d24 |
1416 | |
1417 | =item B<remove_attribute ($attribute_name)> |
1418 | |
0ac992ee |
1419 | This will remove the attribute meta-object stored at |
1420 | C<$attribute_name>, then return the removed attribute meta-object. |
552e3d24 |
1421 | |
0ac992ee |
1422 | B<NOTE:> |
1423 | Removing an attribute will only affect future instances of |
1424 | the class, it will not make any attempt to remove the attribute from |
552e3d24 |
1425 | any existing instances of the class. |
1426 | |
0ac992ee |
1427 | It should be noted that any accessor, reader/writer or predicate |
1428 | methods which the attribute meta-object stored at C<$attribute_name> |
1429 | has will be removed from the class at this time. This B<will> make |
1430 | these attributes somewhat inaccessable in previously created |
1431 | instances. But if you are crazy enough to do this at runtime, then |
a2e85e6c |
1432 | you are crazy enough to deal with something like this :). |
1433 | |
552e3d24 |
1434 | =item B<get_attribute_list> |
1435 | |
0ac992ee |
1436 | This returns a list of attribute names which are defined in the local |
1437 | class. If you want a list of all applicable attributes for a class, |
552e3d24 |
1438 | use the C<compute_all_applicable_attributes> method. |
1439 | |
1440 | =item B<compute_all_applicable_attributes> |
1441 | |
0ac992ee |
1442 | This will traverse the inheritance heirachy and return a list of all |
1443 | the applicable attributes for this class. It does not construct a |
1444 | HASH reference like C<compute_all_applicable_methods> because all |
1445 | that same information is discoverable through the attribute |
c9e77dbb |
1446 | meta-object itself. |
552e3d24 |
1447 | |
058c1cf5 |
1448 | =item B<find_attribute_by_name ($attr_name)> |
1449 | |
0ac992ee |
1450 | This method will traverse the inheritance heirachy and find the |
1451 | first attribute whose name matches C<$attr_name>, then return it. |
058c1cf5 |
1452 | It will return undef if nothing is found. |
1453 | |
552e3d24 |
1454 | =back |
1455 | |
96e38ba6 |
1456 | =head2 Class Immutability |
857f87a7 |
1457 | |
1458 | =over 4 |
1459 | |
96e38ba6 |
1460 | =item B<make_immutable (%options)> |
1461 | |
0ac992ee |
1462 | This method will invoke a tranforamtion upon the class which will |
1463 | make it immutable. Details of this transformation can be found in |
96e38ba6 |
1464 | the L<Class::MOP::Immutable> documentation. |
857f87a7 |
1465 | |
0ac992ee |
1466 | =item B<make_mutable> |
1467 | |
1468 | This method will reverse tranforamtion upon the class which |
1469 | made it immutable. |
1470 | |
b817e248 |
1471 | =item B<create_immutable_transformer> |
1472 | |
1473 | Create a transformer suitable for making this class immutable |
1474 | |
857f87a7 |
1475 | =back |
1476 | |
1a09d9cc |
1477 | =head1 AUTHORS |
8b978dd5 |
1478 | |
a2e85e6c |
1479 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
8b978dd5 |
1480 | |
1481 | =head1 COPYRIGHT AND LICENSE |
1482 | |
69e3ab0a |
1483 | Copyright 2006-2008 by Infinity Interactive, Inc. |
8b978dd5 |
1484 | |
1485 | L<http://www.iinteractive.com> |
1486 | |
1487 | This library is free software; you can redistribute it and/or modify |
0ac992ee |
1488 | it under the same terms as Perl itself. |
8b978dd5 |
1489 | |
798baea5 |
1490 | =cut |