Commit | Line | Data |
94b19069 |
1 | |
2 | package Class::MOP; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
5a2932cf |
7 | use 5.008; |
8 | |
3cf322a0 |
9 | use MRO::Compat; |
10 | |
4c105333 |
11 | use Carp 'confess'; |
b1a46f91 |
12 | use Scalar::Util 'weaken', 'reftype', 'blessed'; |
fc4f8f91 |
13 | |
0531f510 |
14 | use Class::MOP::Class; |
15 | use Class::MOP::Attribute; |
16 | use Class::MOP::Method; |
17 | |
b1f5f41d |
18 | BEGIN { |
c7e28c19 |
19 | *IS_RUNNING_ON_5_10 = ($] < 5.009_005) |
11b56828 |
20 | ? sub () { 0 } |
c7e28c19 |
21 | : sub () { 1 }; |
46b23b44 |
22 | |
f9bd8fe2 |
23 | sub HAVE_ISAREV () { |
c7e28c19 |
24 | Carp::cluck("Class::MOP::HAVE_ISAREV is deprecated and will be removed in a future release. It has always returned 1 anyway."); |
f9bd8fe2 |
25 | return 1; |
26 | } |
3ecd1b25 |
27 | |
28 | # this is either part of core or set up appropriately by MRO::Compat |
29 | *check_package_cache_flag = \&mro::get_pkg_gen; |
b1f5f41d |
30 | } |
e0e4674a |
31 | |
47d35fba |
32 | our $VERSION = '0.84'; |
8a7085c1 |
33 | our $XS_VERSION = $VERSION; |
d519662a |
34 | $VERSION = eval $VERSION; |
c7e28c19 |
35 | our $AUTHORITY = 'cpan:STEVAN'; |
9d655b6d |
36 | |
4bfa5ddb |
37 | require XSLoader; |
38 | XSLoader::load( __PACKAGE__, $XS_VERSION ); |
d7bda114 |
39 | |
40 | |
be7677c7 |
41 | { |
42 | # Metaclasses are singletons, so we cache them here. |
43 | # there is no need to worry about destruction though |
44 | # because they should die only when the program dies. |
45 | # After all, do package definitions even get reaped? |
1d68af04 |
46 | my %METAS; |
47 | |
48 | # means of accessing all the metaclasses that have |
be7677c7 |
49 | # been initialized thus far (for mugwumps obj browser) |
1d68af04 |
50 | sub get_all_metaclasses { %METAS } |
51 | sub get_all_metaclass_instances { values %METAS } |
52 | sub get_all_metaclass_names { keys %METAS } |
be7677c7 |
53 | sub get_metaclass_by_name { $METAS{$_[0]} } |
1d68af04 |
54 | sub store_metaclass_by_name { $METAS{$_[0]} = $_[1] } |
55 | sub weaken_metaclass { weaken($METAS{$_[0]}) } |
be7677c7 |
56 | sub does_metaclass_exist { exists $METAS{$_[0]} && defined $METAS{$_[0]} } |
1d68af04 |
57 | sub remove_metaclass_by_name { $METAS{$_[0]} = undef } |
58 | |
86866fb5 |
59 | # This handles instances as well as class names |
60 | sub class_of { |
82999986 |
61 | return unless defined $_[0]; |
86866fb5 |
62 | my $class = blessed($_[0]) || $_[0]; |
63 | return $METAS{$class}; |
64 | } |
65 | |
be7677c7 |
66 | # NOTE: |
1d68af04 |
67 | # We only cache metaclasses, meaning instances of |
68 | # Class::MOP::Class. We do not cache instance of |
be7677c7 |
69 | # Class::MOP::Package or Class::MOP::Module. Mostly |
1d68af04 |
70 | # because I don't yet see a good reason to do so. |
be7677c7 |
71 | } |
72 | |
44da14be |
73 | sub _class_to_pmfile { |
74 | my $class = shift; |
75 | |
76 | my $file = $class . '.pm'; |
77 | $file =~ s{::}{/}g; |
78 | |
79 | return $file; |
80 | } |
81 | |
063ad0c5 |
82 | sub load_first_existing_class { |
f280f05c |
83 | my @classes = @_ |
84 | or return; |
5a24cf8a |
85 | |
86 | foreach my $class (@classes) { |
87 | unless ( _is_valid_class_name($class) ) { |
88 | my $display = defined($class) ? $class : 'undef'; |
89 | confess "Invalid class name ($display)"; |
90 | } |
ab5e2f48 |
91 | } |
92 | |
063ad0c5 |
93 | my $found; |
5a24cf8a |
94 | my %exceptions; |
063ad0c5 |
95 | for my $class (@classes) { |
44da14be |
96 | my $pmfile = _class_to_pmfile($class); |
063ad0c5 |
97 | my $e = _try_load_one_class($class); |
98 | |
5a24cf8a |
99 | if ($e) { |
063ad0c5 |
100 | $exceptions{$class} = $e; |
44da14be |
101 | last if $e !~ /^Can't locate \Q$pmfile\E in \@INC/; |
5a24cf8a |
102 | } |
103 | else { |
063ad0c5 |
104 | $found = $class; |
105 | last; |
5a24cf8a |
106 | } |
063ad0c5 |
107 | } |
5a24cf8a |
108 | |
1d8153bd |
109 | return $found if $found; |
07940968 |
110 | |
063ad0c5 |
111 | confess join( |
112 | "\n", |
113 | map { |
114 | sprintf( |
fea44045 |
115 | "Could not load class (%s) because : %s", $_, |
063ad0c5 |
116 | $exceptions{$_} |
117 | ) |
44da14be |
118 | } |
119 | grep { |
120 | exists $exceptions{$_} |
063ad0c5 |
121 | } @classes |
f280f05c |
122 | ); |
5a24cf8a |
123 | } |
124 | |
063ad0c5 |
125 | sub _try_load_one_class { |
126 | my $class = shift; |
127 | |
128 | return if is_class_loaded($class); |
2beec805 |
129 | |
44da14be |
130 | my $file = _class_to_pmfile($class); |
063ad0c5 |
131 | |
132 | return do { |
133 | local $@; |
b3813a8c |
134 | local $SIG{__DIE__}; |
063ad0c5 |
135 | eval { require($file) }; |
136 | $@; |
137 | }; |
138 | } |
139 | |
5a24cf8a |
140 | sub load_class { |
1d8153bd |
141 | my $class = load_first_existing_class($_[0]); |
142 | return get_metaclass_by_name($class) || $class; |
448b6e55 |
143 | } |
144 | |
2c0fb064 |
145 | sub _is_valid_class_name { |
146 | my $class = shift; |
147 | |
148 | return 0 if ref($class); |
149 | return 0 unless defined($class); |
150 | return 0 unless length($class); |
151 | |
152 | return 1 if $class =~ /^\w+(?:::\w+)*$/; |
153 | |
154 | return 0; |
155 | } |
156 | |
d5ed91ad |
157 | sub subname { |
158 | require Sub::Name; |
159 | Carp::carp("Class::MOP::subname is deprecated. Please use Sub::Name directly."); |
160 | goto \&Sub::Name::subname; |
161 | } |
162 | |
163 | sub in_global_destruction { |
164 | require Devel::GlobalDestruction; |
165 | Carp::carp("Class::MOP::in_global_destruction is deprecated. Please use Devel::GlobalDestruction directly."); |
166 | goto \&Devel::GlobalDestruction::in_global_destruction; |
167 | } |
168 | |
aa448b16 |
169 | ## ---------------------------------------------------------------------------- |
170 | ## Setting up our environment ... |
171 | ## ---------------------------------------------------------------------------- |
1d68af04 |
172 | ## Class::MOP needs to have a few things in the global perl environment so |
aa448b16 |
173 | ## that it can operate effectively. Those things are done here. |
174 | ## ---------------------------------------------------------------------------- |
175 | |
3bf7644b |
176 | # ... nothing yet actually ;) |
8b978dd5 |
177 | |
b51af7f9 |
178 | ## ---------------------------------------------------------------------------- |
1d68af04 |
179 | ## Bootstrapping |
b51af7f9 |
180 | ## ---------------------------------------------------------------------------- |
1d68af04 |
181 | ## The code below here is to bootstrap our MOP with itself. This is also |
b51af7f9 |
182 | ## sometimes called "tying the knot". By doing this, we make it much easier |
183 | ## to extend the MOP through subclassing and such since now you can use the |
1d68af04 |
184 | ## MOP itself to extend itself. |
185 | ## |
b51af7f9 |
186 | ## Yes, I know, thats weird and insane, but it's a good thing, trust me :) |
1d68af04 |
187 | ## ---------------------------------------------------------------------------- |
727919c5 |
188 | |
1d68af04 |
189 | # We need to add in the meta-attributes here so that |
190 | # any subclass of Class::MOP::* will be able to |
c2b256bc |
191 | # inherit them using _construct_instance |
727919c5 |
192 | |
f0480c45 |
193 | ## -------------------------------------------------------- |
6d5355c3 |
194 | ## Class::MOP::Package |
727919c5 |
195 | |
6d5355c3 |
196 | Class::MOP::Package->meta->add_attribute( |
8683db0e |
197 | Class::MOP::Attribute->new('package' => ( |
b880e0de |
198 | reader => { |
1d68af04 |
199 | # NOTE: we need to do this in order |
200 | # for the instance meta-object to |
b880e0de |
201 | # not fall into meta-circular death |
1d68af04 |
202 | # |
ce2ae40f |
203 | # we just alias the original method |
1d68af04 |
204 | # rather than re-produce it here |
ce2ae40f |
205 | 'name' => \&Class::MOP::Package::name |
b880e0de |
206 | }, |
727919c5 |
207 | )) |
208 | ); |
209 | |
a5e51f0b |
210 | Class::MOP::Package->meta->add_attribute( |
8683db0e |
211 | Class::MOP::Attribute->new('namespace' => ( |
a5e51f0b |
212 | reader => { |
56dcfc1a |
213 | # NOTE: |
ce2ae40f |
214 | # we just alias the original method |
215 | # rather than re-produce it here |
216 | 'namespace' => \&Class::MOP::Package::namespace |
a5e51f0b |
217 | }, |
2e877f58 |
218 | init_arg => undef, |
c4260b45 |
219 | default => sub { \undef } |
a5e51f0b |
220 | )) |
221 | ); |
222 | |
f0480c45 |
223 | ## -------------------------------------------------------- |
224 | ## Class::MOP::Module |
225 | |
226 | # NOTE: |
1d68af04 |
227 | # yeah this is kind of stretching things a bit, |
f0480c45 |
228 | # but truthfully the version should be an attribute |
1d68af04 |
229 | # of the Module, the weirdness comes from having to |
230 | # stick to Perl 5 convention and store it in the |
231 | # $VERSION package variable. Basically if you just |
232 | # squint at it, it will look how you want it to look. |
f0480c45 |
233 | # Either as a package variable, or as a attribute of |
234 | # the metaclass, isn't abstraction great :) |
235 | |
236 | Class::MOP::Module->meta->add_attribute( |
8683db0e |
237 | Class::MOP::Attribute->new('version' => ( |
f0480c45 |
238 | reader => { |
ce2ae40f |
239 | # NOTE: |
240 | # we just alias the original method |
1d68af04 |
241 | # rather than re-produce it here |
ce2ae40f |
242 | 'version' => \&Class::MOP::Module::version |
f0480c45 |
243 | }, |
2e877f58 |
244 | init_arg => undef, |
c4260b45 |
245 | default => sub { \undef } |
f0480c45 |
246 | )) |
247 | ); |
248 | |
249 | # NOTE: |
1d68af04 |
250 | # By following the same conventions as version here, |
251 | # we are opening up the possibility that people can |
252 | # use the $AUTHORITY in non-Class::MOP modules as |
253 | # well. |
f0480c45 |
254 | |
255 | Class::MOP::Module->meta->add_attribute( |
8683db0e |
256 | Class::MOP::Attribute->new('authority' => ( |
f0480c45 |
257 | reader => { |
ce2ae40f |
258 | # NOTE: |
259 | # we just alias the original method |
1d68af04 |
260 | # rather than re-produce it here |
ce2ae40f |
261 | 'authority' => \&Class::MOP::Module::authority |
1d68af04 |
262 | }, |
2e877f58 |
263 | init_arg => undef, |
c4260b45 |
264 | default => sub { \undef } |
f0480c45 |
265 | )) |
266 | ); |
267 | |
268 | ## -------------------------------------------------------- |
6d5355c3 |
269 | ## Class::MOP::Class |
270 | |
727919c5 |
271 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
272 | Class::MOP::Attribute->new('attributes' => ( |
f7259199 |
273 | reader => { |
1d68af04 |
274 | # NOTE: we need to do this in order |
275 | # for the instance meta-object to |
276 | # not fall into meta-circular death |
277 | # |
ce2ae40f |
278 | # we just alias the original method |
1d68af04 |
279 | # rather than re-produce it here |
ce2ae40f |
280 | 'get_attribute_map' => \&Class::MOP::Class::get_attribute_map |
f7259199 |
281 | }, |
727919c5 |
282 | default => sub { {} } |
283 | )) |
284 | ); |
285 | |
351bd7d4 |
286 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
287 | Class::MOP::Attribute->new('methods' => ( |
1d68af04 |
288 | reader => { |
ce2ae40f |
289 | # NOTE: |
290 | # we just alias the original method |
1d68af04 |
291 | # rather than re-produce it here |
ce2ae40f |
292 | 'get_method_map' => \&Class::MOP::Class::get_method_map |
92330ee2 |
293 | }, |
7855ddba |
294 | default => sub { {} } |
c4260b45 |
295 | )) |
296 | ); |
297 | |
298 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
299 | Class::MOP::Attribute->new('superclasses' => ( |
c23184fc |
300 | accessor => { |
301 | # NOTE: |
302 | # we just alias the original method |
1d68af04 |
303 | # rather than re-produce it here |
c23184fc |
304 | 'superclasses' => \&Class::MOP::Class::superclasses |
305 | }, |
2e877f58 |
306 | init_arg => undef, |
c23184fc |
307 | default => sub { \undef } |
308 | )) |
309 | ); |
310 | |
311 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
312 | Class::MOP::Attribute->new('attribute_metaclass' => ( |
1d68af04 |
313 | reader => { |
6d2118a4 |
314 | # NOTE: |
315 | # we just alias the original method |
1d68af04 |
316 | # rather than re-produce it here |
6d2118a4 |
317 | 'attribute_metaclass' => \&Class::MOP::Class::attribute_metaclass |
1d68af04 |
318 | }, |
351bd7d4 |
319 | default => 'Class::MOP::Attribute', |
320 | )) |
321 | ); |
322 | |
323 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
324 | Class::MOP::Attribute->new('method_metaclass' => ( |
1d68af04 |
325 | reader => { |
6d2118a4 |
326 | # NOTE: |
327 | # we just alias the original method |
1d68af04 |
328 | # rather than re-produce it here |
6d2118a4 |
329 | 'method_metaclass' => \&Class::MOP::Class::method_metaclass |
330 | }, |
1d68af04 |
331 | default => 'Class::MOP::Method', |
351bd7d4 |
332 | )) |
333 | ); |
334 | |
2bab2be6 |
335 | Class::MOP::Class->meta->add_attribute( |
77373da8 |
336 | Class::MOP::Attribute->new('wrapped_method_metaclass' => ( |
337 | reader => { |
338 | # NOTE: |
339 | # we just alias the original method |
340 | # rather than re-produce it here |
341 | 'wrapped_method_metaclass' => \&Class::MOP::Class::wrapped_method_metaclass |
342 | }, |
343 | default => 'Class::MOP::Method::Wrapped', |
344 | )) |
345 | ); |
346 | |
347 | Class::MOP::Class->meta->add_attribute( |
8683db0e |
348 | Class::MOP::Attribute->new('instance_metaclass' => ( |
b880e0de |
349 | reader => { |
1d68af04 |
350 | # NOTE: we need to do this in order |
351 | # for the instance meta-object to |
352 | # not fall into meta-circular death |
353 | # |
ce2ae40f |
354 | # we just alias the original method |
1d68af04 |
355 | # rather than re-produce it here |
ce2ae40f |
356 | 'instance_metaclass' => \&Class::MOP::Class::instance_metaclass |
b880e0de |
357 | }, |
1d68af04 |
358 | default => 'Class::MOP::Instance', |
2bab2be6 |
359 | )) |
360 | ); |
361 | |
44d6ea77 |
362 | Class::MOP::Class->meta->add_attribute( |
f5d08022 |
363 | Class::MOP::Attribute->new('immutable_trait' => ( |
364 | reader => { |
365 | 'immutable_trait' => \&Class::MOP::Class::immutable_trait |
366 | }, |
367 | default => "Class::MOP::Class::Immutable::Trait", |
368 | )) |
369 | ); |
370 | |
371 | Class::MOP::Class->meta->add_attribute( |
372 | Class::MOP::Attribute->new('constructor_name' => ( |
44d6ea77 |
373 | reader => { |
f5d08022 |
374 | 'constructor_name' => \&Class::MOP::Class::constructor_name, |
44d6ea77 |
375 | }, |
f5d08022 |
376 | default => "new", |
377 | )) |
378 | ); |
379 | |
380 | Class::MOP::Class->meta->add_attribute( |
381 | Class::MOP::Attribute->new('constructor_class' => ( |
44d6ea77 |
382 | reader => { |
f5d08022 |
383 | 'constructor_class' => \&Class::MOP::Class::constructor_class, |
44d6ea77 |
384 | }, |
f5d08022 |
385 | default => "Class::MOP::Method::Constructor", |
386 | )) |
387 | ); |
388 | |
389 | |
390 | Class::MOP::Class->meta->add_attribute( |
391 | Class::MOP::Attribute->new('destructor_class' => ( |
392 | reader => { |
393 | 'destructor_class' => \&Class::MOP::Class::destructor_class, |
44d6ea77 |
394 | }, |
395 | )) |
396 | ); |
397 | |
9d6dce77 |
398 | # NOTE: |
1d68af04 |
399 | # we don't actually need to tie the knot with |
400 | # Class::MOP::Class here, it is actually handled |
401 | # within Class::MOP::Class itself in the |
c2b256bc |
402 | # _construct_class_instance method. |
9d6dce77 |
403 | |
f0480c45 |
404 | ## -------------------------------------------------------- |
727919c5 |
405 | ## Class::MOP::Attribute |
406 | |
7b31baf4 |
407 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
408 | Class::MOP::Attribute->new('name' => ( |
c23184fc |
409 | reader => { |
1d68af04 |
410 | # NOTE: we need to do this in order |
411 | # for the instance meta-object to |
412 | # not fall into meta-circular death |
413 | # |
ce2ae40f |
414 | # we just alias the original method |
1d68af04 |
415 | # rather than re-produce it here |
ce2ae40f |
416 | 'name' => \&Class::MOP::Attribute::name |
b880e0de |
417 | } |
7b31baf4 |
418 | )) |
419 | ); |
420 | |
421 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
422 | Class::MOP::Attribute->new('associated_class' => ( |
c23184fc |
423 | reader => { |
1d68af04 |
424 | # NOTE: we need to do this in order |
425 | # for the instance meta-object to |
426 | # not fall into meta-circular death |
427 | # |
ce2ae40f |
428 | # we just alias the original method |
1d68af04 |
429 | # rather than re-produce it here |
ce2ae40f |
430 | 'associated_class' => \&Class::MOP::Attribute::associated_class |
b880e0de |
431 | } |
7b31baf4 |
432 | )) |
433 | ); |
434 | |
435 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
436 | Class::MOP::Attribute->new('accessor' => ( |
6d2118a4 |
437 | reader => { 'accessor' => \&Class::MOP::Attribute::accessor }, |
438 | predicate => { 'has_accessor' => \&Class::MOP::Attribute::has_accessor }, |
7b31baf4 |
439 | )) |
440 | ); |
441 | |
442 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
443 | Class::MOP::Attribute->new('reader' => ( |
6d2118a4 |
444 | reader => { 'reader' => \&Class::MOP::Attribute::reader }, |
445 | predicate => { 'has_reader' => \&Class::MOP::Attribute::has_reader }, |
7b31baf4 |
446 | )) |
447 | ); |
448 | |
449 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
450 | Class::MOP::Attribute->new('initializer' => ( |
8ee74136 |
451 | reader => { 'initializer' => \&Class::MOP::Attribute::initializer }, |
452 | predicate => { 'has_initializer' => \&Class::MOP::Attribute::has_initializer }, |
0ab65f99 |
453 | )) |
454 | ); |
455 | |
456 | Class::MOP::Attribute->meta->add_attribute( |
d9d99689 |
457 | Class::MOP::Attribute->new('definition_context' => ( |
458 | reader => { 'definition_context' => \&Class::MOP::Attribute::definition_context }, |
459 | )) |
460 | ); |
461 | |
462 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
463 | Class::MOP::Attribute->new('writer' => ( |
6d2118a4 |
464 | reader => { 'writer' => \&Class::MOP::Attribute::writer }, |
465 | predicate => { 'has_writer' => \&Class::MOP::Attribute::has_writer }, |
7b31baf4 |
466 | )) |
467 | ); |
468 | |
469 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
470 | Class::MOP::Attribute->new('predicate' => ( |
6d2118a4 |
471 | reader => { 'predicate' => \&Class::MOP::Attribute::predicate }, |
472 | predicate => { 'has_predicate' => \&Class::MOP::Attribute::has_predicate }, |
7b31baf4 |
473 | )) |
474 | ); |
475 | |
476 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
477 | Class::MOP::Attribute->new('clearer' => ( |
6d2118a4 |
478 | reader => { 'clearer' => \&Class::MOP::Attribute::clearer }, |
479 | predicate => { 'has_clearer' => \&Class::MOP::Attribute::has_clearer }, |
7d28758b |
480 | )) |
481 | ); |
482 | |
483 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
484 | Class::MOP::Attribute->new('builder' => ( |
1d68af04 |
485 | reader => { 'builder' => \&Class::MOP::Attribute::builder }, |
486 | predicate => { 'has_builder' => \&Class::MOP::Attribute::has_builder }, |
487 | )) |
488 | ); |
489 | |
490 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
491 | Class::MOP::Attribute->new('init_arg' => ( |
6d2118a4 |
492 | reader => { 'init_arg' => \&Class::MOP::Attribute::init_arg }, |
493 | predicate => { 'has_init_arg' => \&Class::MOP::Attribute::has_init_arg }, |
7b31baf4 |
494 | )) |
495 | ); |
496 | |
497 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
498 | Class::MOP::Attribute->new('default' => ( |
7b31baf4 |
499 | # default has a custom 'reader' method ... |
1d68af04 |
500 | predicate => { 'has_default' => \&Class::MOP::Attribute::has_default }, |
7b31baf4 |
501 | )) |
502 | ); |
503 | |
3545c727 |
504 | Class::MOP::Attribute->meta->add_attribute( |
8683db0e |
505 | Class::MOP::Attribute->new('associated_methods' => ( |
c23184fc |
506 | reader => { 'associated_methods' => \&Class::MOP::Attribute::associated_methods }, |
1d68af04 |
507 | default => sub { [] } |
3545c727 |
508 | )) |
509 | ); |
727919c5 |
510 | |
95b67145 |
511 | Class::MOP::Attribute->meta->add_attribute( |
512 | Class::MOP::Attribute->new('insertion_order' => ( |
513 | reader => { 'insertion_order' => \&Class::MOP::Attribute::insertion_order }, |
943cbe2d |
514 | writer => { '_set_insertion_order' => \&Class::MOP::Attribute::_set_insertion_order }, |
95b67145 |
515 | predicate => { 'has_insertion_order' => \&Class::MOP::Attribute::has_insertion_order }, |
516 | )) |
517 | ); |
518 | |
5659d76e |
519 | Class::MOP::Attribute->meta->add_method('clone' => sub { |
a740253a |
520 | my $self = shift; |
1d68af04 |
521 | $self->meta->clone_object($self, @_); |
727919c5 |
522 | }); |
523 | |
f0480c45 |
524 | ## -------------------------------------------------------- |
b6164407 |
525 | ## Class::MOP::Method |
b6164407 |
526 | Class::MOP::Method->meta->add_attribute( |
8683db0e |
527 | Class::MOP::Attribute->new('body' => ( |
c23184fc |
528 | reader => { 'body' => \&Class::MOP::Method::body }, |
b6164407 |
529 | )) |
530 | ); |
531 | |
4c105333 |
532 | Class::MOP::Method->meta->add_attribute( |
5e607260 |
533 | Class::MOP::Attribute->new('associated_metaclass' => ( |
5e607260 |
534 | reader => { 'associated_metaclass' => \&Class::MOP::Method::associated_metaclass }, |
535 | )) |
536 | ); |
537 | |
538 | Class::MOP::Method->meta->add_attribute( |
8683db0e |
539 | Class::MOP::Attribute->new('package_name' => ( |
4c105333 |
540 | reader => { 'package_name' => \&Class::MOP::Method::package_name }, |
541 | )) |
542 | ); |
543 | |
544 | Class::MOP::Method->meta->add_attribute( |
8683db0e |
545 | Class::MOP::Attribute->new('name' => ( |
4c105333 |
546 | reader => { 'name' => \&Class::MOP::Method::name }, |
547 | )) |
548 | ); |
549 | |
2226a8b0 |
550 | Class::MOP::Method->meta->add_attribute( |
551 | Class::MOP::Attribute->new('original_method' => ( |
552 | reader => { 'original_method' => \&Class::MOP::Method::original_method }, |
553 | writer => { '_set_original_method' => \&Class::MOP::Method::_set_original_method }, |
554 | )) |
555 | ); |
556 | |
4c105333 |
557 | Class::MOP::Method->meta->add_method('clone' => sub { |
558 | my $self = shift; |
2226a8b0 |
559 | my $clone = $self->meta->clone_object($self, @_); |
560 | $clone->_set_original_method($self); |
561 | return $clone; |
4c105333 |
562 | }); |
563 | |
b6164407 |
564 | ## -------------------------------------------------------- |
565 | ## Class::MOP::Method::Wrapped |
566 | |
567 | # NOTE: |
1d68af04 |
568 | # the way this item is initialized, this |
569 | # really does not follow the standard |
570 | # practices of attributes, but we put |
b6164407 |
571 | # it here for completeness |
572 | Class::MOP::Method::Wrapped->meta->add_attribute( |
8683db0e |
573 | Class::MOP::Attribute->new('modifier_table') |
b6164407 |
574 | ); |
575 | |
576 | ## -------------------------------------------------------- |
565f0cbb |
577 | ## Class::MOP::Method::Generated |
578 | |
579 | Class::MOP::Method::Generated->meta->add_attribute( |
8683db0e |
580 | Class::MOP::Attribute->new('is_inline' => ( |
565f0cbb |
581 | reader => { 'is_inline' => \&Class::MOP::Method::Generated::is_inline }, |
4c105333 |
582 | default => 0, |
1d68af04 |
583 | )) |
565f0cbb |
584 | ); |
585 | |
d9d99689 |
586 | Class::MOP::Method::Generated->meta->add_attribute( |
587 | Class::MOP::Attribute->new('definition_context' => ( |
588 | reader => { 'definition_context' => \&Class::MOP::Method::Generated::definition_context }, |
589 | )) |
590 | ); |
591 | |
29d4e92a |
592 | |
593 | ## -------------------------------------------------------- |
594 | ## Class::MOP::Method::Inlined |
595 | |
596 | Class::MOP::Method::Inlined->meta->add_attribute( |
597 | Class::MOP::Attribute->new('_expected_method_class' => ( |
598 | reader => { '_expected_method_class' => \&Class::MOP::Method::Inlined::_expected_method_class }, |
599 | )) |
600 | ); |
601 | |
565f0cbb |
602 | ## -------------------------------------------------------- |
d90b42a6 |
603 | ## Class::MOP::Method::Accessor |
604 | |
605 | Class::MOP::Method::Accessor->meta->add_attribute( |
8683db0e |
606 | Class::MOP::Attribute->new('attribute' => ( |
1d68af04 |
607 | reader => { |
608 | 'associated_attribute' => \&Class::MOP::Method::Accessor::associated_attribute |
d90b42a6 |
609 | }, |
1d68af04 |
610 | )) |
d90b42a6 |
611 | ); |
612 | |
613 | Class::MOP::Method::Accessor->meta->add_attribute( |
8683db0e |
614 | Class::MOP::Attribute->new('accessor_type' => ( |
c23184fc |
615 | reader => { 'accessor_type' => \&Class::MOP::Method::Accessor::accessor_type }, |
1d68af04 |
616 | )) |
d90b42a6 |
617 | ); |
618 | |
d90b42a6 |
619 | ## -------------------------------------------------------- |
620 | ## Class::MOP::Method::Constructor |
621 | |
622 | Class::MOP::Method::Constructor->meta->add_attribute( |
8683db0e |
623 | Class::MOP::Attribute->new('options' => ( |
1d68af04 |
624 | reader => { |
625 | 'options' => \&Class::MOP::Method::Constructor::options |
d90b42a6 |
626 | }, |
4c105333 |
627 | default => sub { +{} } |
1d68af04 |
628 | )) |
d90b42a6 |
629 | ); |
630 | |
631 | Class::MOP::Method::Constructor->meta->add_attribute( |
8683db0e |
632 | Class::MOP::Attribute->new('associated_metaclass' => ( |
e8a38403 |
633 | init_arg => "metaclass", # FIXME alias and rename |
1d68af04 |
634 | reader => { |
635 | 'associated_metaclass' => \&Class::MOP::Method::Constructor::associated_metaclass |
636 | }, |
637 | )) |
d90b42a6 |
638 | ); |
639 | |
640 | ## -------------------------------------------------------- |
86482605 |
641 | ## Class::MOP::Instance |
642 | |
643 | # NOTE: |
1d68af04 |
644 | # these don't yet do much of anything, but are just |
86482605 |
645 | # included for completeness |
646 | |
647 | Class::MOP::Instance->meta->add_attribute( |
74890687 |
648 | Class::MOP::Attribute->new('associated_metaclass', |
649 | reader => { associated_metaclass => \&Class::MOP::Instance::associated_metaclass }, |
650 | ), |
86482605 |
651 | ); |
652 | |
653 | Class::MOP::Instance->meta->add_attribute( |
74890687 |
654 | Class::MOP::Attribute->new('_class_name', |
655 | init_arg => undef, |
656 | reader => { _class_name => \&Class::MOP::Instance::_class_name }, |
657 | #lazy => 1, # not yet supported by Class::MOP but out our version does it anyway |
658 | #default => sub { $_[0]->associated_metaclass->name }, |
659 | ), |
660 | ); |
661 | |
662 | Class::MOP::Instance->meta->add_attribute( |
663 | Class::MOP::Attribute->new('attributes', |
0b5d46da |
664 | reader => { attributes => \&Class::MOP::Instance::get_all_attributes }, |
74890687 |
665 | ), |
32bfc810 |
666 | ); |
667 | |
668 | Class::MOP::Instance->meta->add_attribute( |
74890687 |
669 | Class::MOP::Attribute->new('slots', |
670 | reader => { slots => \&Class::MOP::Instance::slots }, |
671 | ), |
86482605 |
672 | ); |
673 | |
63d08a9e |
674 | Class::MOP::Instance->meta->add_attribute( |
74890687 |
675 | Class::MOP::Attribute->new('slot_hash', |
676 | reader => { slot_hash => \&Class::MOP::Instance::slot_hash }, |
677 | ), |
63d08a9e |
678 | ); |
679 | |
680 | |
caa051fa |
681 | # we need the meta instance of the meta instance to be created now, in order |
682 | # for the constructor to be able to use it |
683 | Class::MOP::Instance->meta->get_meta_instance; |
684 | |
caa051fa |
685 | # pretend the add_method never happenned. it hasn't yet affected anything |
686 | undef Class::MOP::Instance->meta->{_package_cache_flag}; |
687 | |
86482605 |
688 | ## -------------------------------------------------------- |
f0480c45 |
689 | ## Now close all the Class::MOP::* classes |
4d47b77f |
690 | |
1aa13cf4 |
691 | # NOTE: we don't need to inline the the accessors this only lengthens |
692 | # the compile time of the MOP, and gives us no actual benefits. |
0b9372a2 |
693 | |
a7b17d6f |
694 | # this is just nitpicking to ensure Class::MOP::Class->meta == ->meta->meta |
e1c7a1b7 |
695 | Class::MOP::Class->meta->_immutable_metaclass; |
a7b17d6f |
696 | $Class::MOP::Class::immutable_metaclass_cache{"Class::MOP::Class"}{"Class::MOP::Class::Immutable::Trait"} = Class::MOP::Class::Immutable::Class::MOP::Class->meta; |
697 | |
0b9372a2 |
698 | $_->meta->make_immutable( |
6c2f6b5c |
699 | inline_constructor => 1, |
700 | replace_constructor => 1, |
701 | constructor_name => "_new", |
45582002 |
702 | inline_accessors => 0, |
0b9372a2 |
703 | ) for qw/ |
1d68af04 |
704 | Class::MOP::Package |
705 | Class::MOP::Module |
706 | Class::MOP::Class |
f5d08022 |
707 | Class::MOP::Class::Immutable::Trait |
a7b17d6f |
708 | Class::MOP::Class::Immutable::Class::MOP::Class |
1d68af04 |
709 | |
0b9372a2 |
710 | Class::MOP::Attribute |
1d68af04 |
711 | Class::MOP::Method |
712 | Class::MOP::Instance |
713 | |
714 | Class::MOP::Object |
0b9372a2 |
715 | |
565f0cbb |
716 | Class::MOP::Method::Generated |
29d4e92a |
717 | Class::MOP::Method::Inlined |
1d68af04 |
718 | |
ba38bf08 |
719 | Class::MOP::Method::Accessor |
1d68af04 |
720 | Class::MOP::Method::Constructor |
721 | Class::MOP::Method::Wrapped |
0b9372a2 |
722 | /; |
b6164407 |
723 | |
94b19069 |
724 | 1; |
725 | |
726 | __END__ |
727 | |
728 | =pod |
729 | |
1d68af04 |
730 | =head1 NAME |
94b19069 |
731 | |
732 | Class::MOP - A Meta Object Protocol for Perl 5 |
733 | |
5b60bf98 |
734 | =head1 DESCRIPTION |
94b19069 |
735 | |
127d39a7 |
736 | This module is a fully functioning meta object protocol for the |
1d68af04 |
737 | Perl 5 object system. It makes no attempt to change the behavior or |
738 | characteristics of the Perl 5 object system, only to create a |
27e31eaf |
739 | protocol for its manipulation and introspection. |
94b19069 |
740 | |
828ecf13 |
741 | That said, it does attempt to create the tools for building a rich set |
742 | of extensions to the Perl 5 object system. Every attempt has been made |
743 | to abide by the spirit of the Perl 5 object system that we all know |
744 | and love. |
94b19069 |
745 | |
828ecf13 |
746 | This documentation is sparse on conceptual details. We suggest looking |
747 | at the items listed in the L<SEE ALSO> section for more |
748 | information. In particular the book "The Art of the Meta Object |
749 | Protocol" was very influential in the development of this system. |
40483095 |
750 | |
bfe4d0fc |
751 | =head2 What is a Meta Object Protocol? |
752 | |
1d68af04 |
753 | A meta object protocol is an API to an object system. |
bfe4d0fc |
754 | |
828ecf13 |
755 | To be more specific, it abstracts the components of an object system |
756 | (classes, object, methods, object attributes, etc.). These |
757 | abstractions can then be used to inspect and manipulate the object |
758 | system which they describe. |
bfe4d0fc |
759 | |
1d68af04 |
760 | It can be said that there are two MOPs for any object system; the |
828ecf13 |
761 | implicit MOP and the explicit MOP. The implicit MOP handles things |
1d68af04 |
762 | like method dispatch or inheritance, which happen automatically as |
763 | part of how the object system works. The explicit MOP typically |
764 | handles the introspection/reflection features of the object system. |
bfe4d0fc |
765 | |
828ecf13 |
766 | All object systems have implicit MOPs. Without one, they would not |
5b60bf98 |
767 | work. Explicit MOPs are much less common, and depending on the |
768 | language can vary from restrictive (Reflection in Java or C#) to wide |
769 | open (CLOS is a perfect example). |
e16da3e6 |
770 | |
828ecf13 |
771 | =head2 Yet Another Class Builder! Why? |
772 | |
773 | This is B<not> a class builder so much as a I<class builder |
774 | B<builder>>. The intent is that an end user will not use this module |
775 | directly, but instead this module is used by module authors to build |
776 | extensions and features onto the Perl 5 object system. |
777 | |
778 | This system is used by L<Moose>, which supplies a powerful class |
779 | builder system built entirely on top of C<Class::MOP>. |
e16da3e6 |
780 | |
94b19069 |
781 | =head2 Who is this module for? |
782 | |
828ecf13 |
783 | This module is for anyone who has ever created or wanted to create a |
784 | module for the Class:: namespace. The tools which this module provides |
785 | make doing complex Perl 5 wizardry simpler, by removing such barriers |
786 | as the need to hack symbol tables, or understand the fine details of |
787 | method dispatch. |
94b19069 |
788 | |
bfe4d0fc |
789 | =head2 What changes do I have to make to use this module? |
790 | |
828ecf13 |
791 | This module was designed to be as unintrusive as possible. Many of its |
5b60bf98 |
792 | features are accessible without B<any> change to your existing |
828ecf13 |
793 | code. It is meant to be a compliment to your existing code and not an |
794 | intrusion on your code base. Unlike many other B<Class::> modules, |
795 | this module B<does not> require you subclass it, or even that you |
796 | C<use> it in within your module's package. |
bfe4d0fc |
797 | |
1d68af04 |
798 | The only features which requires additions to your code are the |
2eb717d5 |
799 | attribute handling and instance construction features, and these are |
1d68af04 |
800 | both completely optional features. The only reason for this is because |
801 | Perl 5's object system does not actually have these features built |
2eb717d5 |
802 | in. More information about this feature can be found below. |
bfe4d0fc |
803 | |
828ecf13 |
804 | =head2 About Performance |
805 | |
5b60bf98 |
806 | It is a common misconception that explicit MOPs are a performance hit. |
828ecf13 |
807 | This is not a universal truth, it is a side-effect of some specific |
808 | implementations. For instance, using Java reflection is slow because |
809 | the JVM cannot take advantage of any compiler optimizations, and the |
810 | JVM has to deal with much more runtime type information as well. |
bfe4d0fc |
811 | |
828ecf13 |
812 | Reflection in C# is marginally better as it was designed into the |
813 | language and runtime (the CLR). In contrast, CLOS (the Common Lisp |
814 | Object System) was built to support an explicit MOP, and so |
815 | performance is tuned for it. |
1d68af04 |
816 | |
828ecf13 |
817 | This library in particular does its absolute best to avoid putting |
1d68af04 |
818 | B<any> drain at all upon your code's performance. In fact, by itself |
828ecf13 |
819 | it does nothing to affect your existing code. So you only pay for what |
820 | you actually use. |
bfe4d0fc |
821 | |
550d56db |
822 | =head2 About Metaclass compatibility |
823 | |
1d68af04 |
824 | This module makes sure that all metaclasses created are both upwards |
825 | and downwards compatible. The topic of metaclass compatibility is |
826 | highly esoteric and is something only encountered when doing deep and |
827 | involved metaclass hacking. There are two basic kinds of metaclass |
828 | incompatibility; upwards and downwards. |
550d56db |
829 | |
1d68af04 |
830 | Upwards metaclass compatibility means that the metaclass of a |
831 | given class is either the same as (or a subclass of) all of the |
550d56db |
832 | class's ancestors. |
833 | |
1d68af04 |
834 | Downward metaclass compatibility means that the metaclasses of a |
828ecf13 |
835 | given class's ancestors are all either the same as (or a subclass |
550d56db |
836 | of) that metaclass. |
837 | |
1d68af04 |
838 | Here is a diagram showing a set of two classes (C<A> and C<B>) and |
839 | two metaclasses (C<Meta::A> and C<Meta::B>) which have correct |
550d56db |
840 | metaclass compatibility both upwards and downwards. |
841 | |
842 | +---------+ +---------+ |
843 | | Meta::A |<----| Meta::B | <....... (instance of ) |
1d68af04 |
844 | +---------+ +---------+ <------- (inherits from) |
550d56db |
845 | ^ ^ |
846 | : : |
847 | +---------+ +---------+ |
848 | | A |<----| B | |
849 | +---------+ +---------+ |
850 | |
1d68af04 |
851 | As I said this is a highly esoteric topic and one you will only run |
828ecf13 |
852 | into if you do a lot of subclassing of L<Class::MOP::Class>. If you |
853 | are interested in why this is an issue see the paper I<Uniform and |
854 | safe metaclass composition> linked to in the L<SEE ALSO> section of |
855 | this document. |
550d56db |
856 | |
aa448b16 |
857 | =head2 Using custom metaclasses |
858 | |
828ecf13 |
859 | Always use the L<metaclass> pragma when using a custom metaclass, this |
5b60bf98 |
860 | will ensure the proper initialization order and not accidentally |
861 | create an incorrect type of metaclass for you. This is a very rare |
862 | problem, and one which can only occur if you are doing deep metaclass |
aa448b16 |
863 | programming. So in other words, don't worry about it. |
864 | |
828ecf13 |
865 | Note that if you're using L<Moose> we encourage you to I<not> use |
866 | L<metaclass> pragma, and instead use L<Moose::Util::MetaRole> to apply |
867 | roles to a class's metaclasses. This topic is covered at length in |
868 | various L<Moose::Cookbook> recipes. |
869 | |
94b19069 |
870 | =head1 PROTOCOLS |
871 | |
828ecf13 |
872 | The meta-object protocol is divided into 4 main sub-protocols: |
94b19069 |
873 | |
828ecf13 |
874 | =head2 The Class protocol |
94b19069 |
875 | |
1d68af04 |
876 | This provides a means of manipulating and introspecting a Perl 5 |
828ecf13 |
877 | class. It handles symbol table hacking for you, and provides a rich |
878 | set of methods that go beyond simple package introspection. |
94b19069 |
879 | |
552e3d24 |
880 | See L<Class::MOP::Class> for more details. |
881 | |
828ecf13 |
882 | =head2 The Attribute protocol |
94b19069 |
883 | |
828ecf13 |
884 | This provides a consistent representation for an attribute of a Perl 5 |
885 | class. Since there are so many ways to create and handle attributes in |
886 | Perl 5 OO, the Attribute protocol provide as much of a unified |
887 | approach as possible. Of course, you are always free to extend this |
888 | protocol by subclassing the appropriate classes. |
94b19069 |
889 | |
552e3d24 |
890 | See L<Class::MOP::Attribute> for more details. |
891 | |
828ecf13 |
892 | =head2 The Method protocol |
94b19069 |
893 | |
828ecf13 |
894 | This provides a means of manipulating and introspecting methods in the |
895 | Perl 5 object system. As with attributes, there are many ways to |
1d68af04 |
896 | approach this topic, so we try to keep it pretty basic, while still |
94b19069 |
897 | making it possible to extend the system in many ways. |
898 | |
552e3d24 |
899 | See L<Class::MOP::Method> for more details. |
94b19069 |
900 | |
828ecf13 |
901 | =head2 The Instance protocol |
127d39a7 |
902 | |
828ecf13 |
903 | This provides a layer of abstraction for creating object instances. |
904 | Since the other layers use this protocol, it is relatively easy to |
905 | change the type of your instances from the default hash reference to |
906 | some other type of reference. Several examples are provided in the |
907 | F<examples/> directory included in this distribution. |
127d39a7 |
908 | |
909 | See L<Class::MOP::Instance> for more details. |
910 | |
be7677c7 |
911 | =head1 FUNCTIONS |
912 | |
828ecf13 |
913 | Note that this module does not export any constants or functions. |
914 | |
c1d5345a |
915 | =head2 Constants |
916 | |
917 | =over 4 |
918 | |
828ecf13 |
919 | =item I<Class::MOP::IS_RUNNING_ON_5_10> |
c1d5345a |
920 | |
828ecf13 |
921 | We set this constant depending on what version perl we are on, this |
922 | allows us to take advantage of new 5.10 features and stay backwards |
5b60bf98 |
923 | compatible. |
c1d5345a |
924 | |
925 | =back |
926 | |
448b6e55 |
927 | =head2 Utility functions |
928 | |
bd07fbdb |
929 | Note that these are all called as B<functions, not methods>. |
081a927b |
930 | |
448b6e55 |
931 | =over 4 |
932 | |
828ecf13 |
933 | =item B<Class::MOP::load_class($class_name)> |
448b6e55 |
934 | |
9d441c23 |
935 | This will load the specified C<$class_name>, if it is not already |
936 | loaded (as reported by C<is_class_loaded>). This function can be used |
828ecf13 |
937 | in place of tricks like C<eval "use $module"> or using C<require> |
828de8f4 |
938 | unconditionally. This will return the metaclass of C<$class_name> if |
939 | one exists, otherwise it will return C<$class_name>. |
448b6e55 |
940 | |
828ecf13 |
941 | =item B<Class::MOP::is_class_loaded($class_name)> |
448b6e55 |
942 | |
15ab5451 |
943 | Returns a boolean indicating whether or not C<$class_name> has been |
944 | loaded. |
448b6e55 |
945 | |
828ecf13 |
946 | This does a basic check of the symbol table to try and determine as |
947 | best it can if the C<$class_name> is loaded, it is probably correct |
948 | about 99% of the time, but it can be fooled into reporting false |
9d441c23 |
949 | positives. In particular, loading any of the core L<IO> modules will |
950 | cause most of the rest of the core L<IO> modules to falsely report |
951 | having been loaded, due to the way the base L<IO> module works. |
448b6e55 |
952 | |
cdac22cc |
953 | =item B<Class::MOP::get_code_info($code)> |
954 | |
955 | This function returns two values, the name of the package the C<$code> |
956 | is from and the name of the C<$code> itself. This is used by several |
5b60bf98 |
957 | elements of the MOP to determine where a given C<$code> reference is |
cdac22cc |
958 | from. |
959 | |
44ba77a3 |
960 | =item B<Class::MOP::class_of($instance_or_class_name)> |
961 | |
3fa5b3f9 |
962 | This will return the metaclass of the given instance or class name. If the |
963 | class lacks a metaclass, no metaclass will be initialized, and C<undef> will be |
964 | returned. |
44ba77a3 |
965 | |
828ecf13 |
966 | =item B<Class::MOP::check_package_cache_flag($pkg)> |
e0e4674a |
967 | |
bd07fbdb |
968 | B<NOTE: DO NOT USE THIS FUNCTION, IT IS FOR INTERNAL USE ONLY!> |
969 | |
828ecf13 |
970 | This will return an integer that is managed by L<Class::MOP::Class> to |
971 | determine if a module's symbol table has been altered. |
127d39a7 |
972 | |
828ecf13 |
973 | In Perl 5.10 or greater, this flag is package specific. However in |
974 | versions prior to 5.10, this will use the C<PL_sub_generation> |
975 | variable which is not package specific. |
127d39a7 |
976 | |
828ecf13 |
977 | =item B<Class::MOP::load_first_existing_class(@class_names)> |
063ad0c5 |
978 | |
979 | B<NOTE: DO NOT USE THIS FUNCTION, IT IS FOR INTERNAL USE ONLY!> |
980 | |
981 | Given a list of class names, this function will attempt to load each |
982 | one in turn. |
983 | |
828ecf13 |
984 | If it finds a class it can load, it will return that class' name. If |
985 | none of the classes can be loaded, it will throw an exception. |
063ad0c5 |
986 | |
448b6e55 |
987 | =back |
988 | |
989 | =head2 Metaclass cache functions |
990 | |
6c842677 |
991 | Class::MOP holds a cache of metaclasses. The following are functions |
1d68af04 |
992 | (B<not methods>) which can be used to access that cache. It is not |
6c842677 |
993 | recommended that you mess with these. Bad things could happen, but if |
994 | you are brave and willing to risk it: go for it! |
be7677c7 |
995 | |
996 | =over 4 |
997 | |
828ecf13 |
998 | =item B<Class::MOP::get_all_metaclasses> |
be7677c7 |
999 | |
6c842677 |
1000 | This will return a hash of all the metaclass instances that have |
828ecf13 |
1001 | been cached by L<Class::MOP::Class>, keyed by the package name. |
b9d9fc0b |
1002 | |
828ecf13 |
1003 | =item B<Class::MOP::get_all_metaclass_instances> |
be7677c7 |
1004 | |
6c842677 |
1005 | This will return a list of all the metaclass instances that have |
828ecf13 |
1006 | been cached by L<Class::MOP::Class>. |
b9d9fc0b |
1007 | |
828ecf13 |
1008 | =item B<Class::MOP::get_all_metaclass_names> |
be7677c7 |
1009 | |
6c842677 |
1010 | This will return a list of all the metaclass names that have |
828ecf13 |
1011 | been cached by L<Class::MOP::Class>. |
b9d9fc0b |
1012 | |
828ecf13 |
1013 | =item B<Class::MOP::get_metaclass_by_name($name)> |
be7677c7 |
1014 | |
828ecf13 |
1015 | This will return a cached L<Class::MOP::Class> instance, or nothing |
6c842677 |
1016 | if no metaclass exists with that C<$name>. |
127d39a7 |
1017 | |
828ecf13 |
1018 | =item B<Class::MOP::store_metaclass_by_name($name, $meta)> |
be7677c7 |
1019 | |
127d39a7 |
1020 | This will store a metaclass in the cache at the supplied C<$key>. |
1021 | |
828ecf13 |
1022 | =item B<Class::MOP::weaken_metaclass($name)> |
be7677c7 |
1023 | |
6c842677 |
1024 | In rare cases (e.g. anonymous metaclasses) it is desirable to |
1025 | store a weakened reference in the metaclass cache. This |
1026 | function will weaken the reference to the metaclass stored |
1027 | in C<$name>. |
127d39a7 |
1028 | |
828ecf13 |
1029 | =item B<Class::MOP::does_metaclass_exist($name)> |
be7677c7 |
1030 | |
828ecf13 |
1031 | This will return true of there exists a metaclass stored in the |
6c842677 |
1032 | C<$name> key, and return false otherwise. |
127d39a7 |
1033 | |
828ecf13 |
1034 | =item B<Class::MOP::remove_metaclass_by_name($name)> |
be7677c7 |
1035 | |
6c842677 |
1036 | This will remove the metaclass stored in the C<$name> key. |
127d39a7 |
1037 | |
be7677c7 |
1038 | =back |
1039 | |
552e3d24 |
1040 | =head1 SEE ALSO |
8b978dd5 |
1041 | |
552e3d24 |
1042 | =head2 Books |
8b978dd5 |
1043 | |
1d68af04 |
1044 | There are very few books out on Meta Object Protocols and Metaclasses |
1045 | because it is such an esoteric topic. The following books are really |
1046 | the only ones I have found. If you know of any more, B<I<please>> |
a2e85e6c |
1047 | email me and let me know, I would love to hear about them. |
1048 | |
8b978dd5 |
1049 | =over 4 |
1050 | |
15ab5451 |
1051 | =item I<The Art of the Meta Object Protocol> |
8b978dd5 |
1052 | |
15ab5451 |
1053 | =item I<Advances in Object-Oriented Metalevel Architecture and Reflection> |
8b978dd5 |
1054 | |
15ab5451 |
1055 | =item I<Putting MetaClasses to Work> |
b51af7f9 |
1056 | |
15ab5451 |
1057 | =item I<Smalltalk: The Language> |
a2e85e6c |
1058 | |
94b19069 |
1059 | =back |
1060 | |
550d56db |
1061 | =head2 Papers |
1062 | |
1063 | =over 4 |
1064 | |
15ab5451 |
1065 | =item "Uniform and safe metaclass composition" |
550d56db |
1066 | |
1d68af04 |
1067 | An excellent paper by the people who brought us the original Traits paper. |
1068 | This paper is on how Traits can be used to do safe metaclass composition, |
1069 | and offers an excellent introduction section which delves into the topic of |
550d56db |
1070 | metaclass compatibility. |
1071 | |
1072 | L<http://www.iam.unibe.ch/~scg/Archive/Papers/Duca05ySafeMetaclassTrait.pdf> |
1073 | |
15ab5451 |
1074 | =item "Safe Metaclass Programming" |
550d56db |
1075 | |
1d68af04 |
1076 | This paper seems to precede the above paper, and propose a mix-in based |
1077 | approach as opposed to the Traits based approach. Both papers have similar |
1078 | information on the metaclass compatibility problem space. |
550d56db |
1079 | |
1080 | L<http://citeseer.ist.psu.edu/37617.html> |
1081 | |
1082 | =back |
1083 | |
552e3d24 |
1084 | =head2 Prior Art |
8b978dd5 |
1085 | |
1086 | =over 4 |
1087 | |
7184ca14 |
1088 | =item The Perl 6 MetaModel work in the Pugs project |
8b978dd5 |
1089 | |
1090 | =over 4 |
1091 | |
552e3d24 |
1092 | =item L<http://svn.openfoundry.org/pugs/perl5/Perl6-MetaModel> |
8b978dd5 |
1093 | |
552e3d24 |
1094 | =item L<http://svn.openfoundry.org/pugs/perl5/Perl6-ObjectSpace> |
8b978dd5 |
1095 | |
1096 | =back |
1097 | |
94b19069 |
1098 | =back |
1099 | |
1d68af04 |
1100 | =head2 Articles |
f8dfcfb7 |
1101 | |
1102 | =over 4 |
1103 | |
1d68af04 |
1104 | =item CPAN Module Review of Class::MOP |
f8dfcfb7 |
1105 | |
1106 | L<http://www.oreillynet.com/onlamp/blog/2006/06/cpan_module_review_classmop.html> |
1107 | |
1108 | =back |
1109 | |
a2e85e6c |
1110 | =head1 SIMILAR MODULES |
1111 | |
1d68af04 |
1112 | As I have said above, this module is a class-builder-builder, so it is |
1113 | not the same thing as modules like L<Class::Accessor> and |
1114 | L<Class::MethodMaker>. That being said there are very few modules on CPAN |
1115 | with similar goals to this module. The one I have found which is most |
1116 | like this module is L<Class::Meta>, although it's philosophy and the MOP it |
1117 | creates are very different from this modules. |
94b19069 |
1118 | |
a2e85e6c |
1119 | =head1 BUGS |
1120 | |
1d68af04 |
1121 | All complex software has bugs lurking in it, and this module is no |
53702399 |
1122 | exception. |
1123 | |
1124 | Please report any bugs to C<bug-class-mop@rt.cpan.org>, or through the |
1125 | web interface at L<http://rt.cpan.org>. |
1126 | |
1127 | You can also discuss feature requests or possible bugs on the Moose |
1128 | mailing list (moose@perl.org) or on IRC at |
1129 | L<irc://irc.perl.org/#moose>. |
a2e85e6c |
1130 | |
1131 | =head1 ACKNOWLEDGEMENTS |
1132 | |
1133 | =over 4 |
1134 | |
b9d9fc0b |
1135 | =item Rob Kinyon |
a2e85e6c |
1136 | |
1d68af04 |
1137 | Thanks to Rob for actually getting the development of this module kick-started. |
a2e85e6c |
1138 | |
1139 | =back |
1140 | |
1a09d9cc |
1141 | =head1 AUTHORS |
94b19069 |
1142 | |
a2e85e6c |
1143 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
552e3d24 |
1144 | |
9c8cda90 |
1145 | B<with contributions from:> |
1146 | |
1147 | Brandon (blblack) Black |
1148 | |
4f116037 |
1149 | Florian (rafl) Ragwitz |
1150 | |
9c8cda90 |
1151 | Guillermo (groditi) Roditi |
1152 | |
53702399 |
1153 | Dave (autarch) Rolsky |
1154 | |
9195ddff |
1155 | Matt (mst) Trout |
1156 | |
9c8cda90 |
1157 | Rob (robkinyon) Kinyon |
1158 | |
1159 | Yuval (nothingmuch) Kogman |
1a09d9cc |
1160 | |
f430cfa4 |
1161 | Scott (konobi) McWhirter |
1162 | |
94b19069 |
1163 | =head1 COPYRIGHT AND LICENSE |
1164 | |
070bb6c9 |
1165 | Copyright 2006-2009 by Infinity Interactive, Inc. |
94b19069 |
1166 | |
1167 | L<http://www.iinteractive.com> |
1168 | |
1169 | This library is free software; you can redistribute it and/or modify |
1d68af04 |
1170 | it under the same terms as Perl itself. |
94b19069 |
1171 | |
1172 | =cut |