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