Commit | Line | Data |
94b19069 |
1 | |
2 | package Class::MOP; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
727919c5 |
7 | use Carp 'confess'; |
be7677c7 |
8 | use Scalar::Util 'weaken'; |
8b978dd5 |
9 | |
2eb717d5 |
10 | use Class::MOP::Class; |
11 | use Class::MOP::Attribute; |
12 | use Class::MOP::Method; |
13 | |
857f87a7 |
14 | use Class::MOP::Class::Immutable; |
15 | |
b1897d4d |
16 | our $VERSION = '0.35'; |
f0480c45 |
17 | our $AUTHORITY = 'cpan:STEVAN'; |
94b19069 |
18 | |
be7677c7 |
19 | { |
20 | # Metaclasses are singletons, so we cache them here. |
21 | # there is no need to worry about destruction though |
22 | # because they should die only when the program dies. |
23 | # After all, do package definitions even get reaped? |
24 | my %METAS; |
25 | |
26 | # means of accessing all the metaclasses that have |
27 | # been initialized thus far (for mugwumps obj browser) |
28 | sub get_all_metaclasses { %METAS } |
29 | sub get_all_metaclass_instances { values %METAS } |
30 | sub get_all_metaclass_names { keys %METAS } |
31 | sub get_metaclass_by_name { $METAS{$_[0]} } |
32 | sub store_metaclass_by_name { $METAS{$_[0]} = $_[1] } |
33 | sub weaken_metaclass { weaken($METAS{$_[0]}) } |
34 | sub does_metaclass_exist { exists $METAS{$_[0]} && defined $METAS{$_[0]} } |
35 | sub remove_metaclass_by_name { $METAS{$_[0]} = undef } |
36 | |
37 | # NOTE: |
38 | # We only cache metaclasses, meaning instances of |
39 | # Class::MOP::Class. We do not cache instance of |
40 | # Class::MOP::Package or Class::MOP::Module. Mostly |
41 | # because I don't yet see a good reason to do so. |
42 | } |
43 | |
aa448b16 |
44 | ## ---------------------------------------------------------------------------- |
45 | ## Setting up our environment ... |
46 | ## ---------------------------------------------------------------------------- |
47 | ## Class::MOP needs to have a few things in the global perl environment so |
48 | ## that it can operate effectively. Those things are done here. |
49 | ## ---------------------------------------------------------------------------- |
50 | |
3bf7644b |
51 | # ... nothing yet actually ;) |
8b978dd5 |
52 | |
b51af7f9 |
53 | ## ---------------------------------------------------------------------------- |
54 | ## Bootstrapping |
55 | ## ---------------------------------------------------------------------------- |
56 | ## The code below here is to bootstrap our MOP with itself. This is also |
57 | ## sometimes called "tying the knot". By doing this, we make it much easier |
58 | ## to extend the MOP through subclassing and such since now you can use the |
59 | ## MOP itself to extend itself. |
60 | ## |
61 | ## Yes, I know, thats weird and insane, but it's a good thing, trust me :) |
62 | ## ---------------------------------------------------------------------------- |
727919c5 |
63 | |
64 | # We need to add in the meta-attributes here so that |
65 | # any subclass of Class::MOP::* will be able to |
66 | # inherit them using &construct_instance |
67 | |
f0480c45 |
68 | ## -------------------------------------------------------- |
6d5355c3 |
69 | ## Class::MOP::Package |
727919c5 |
70 | |
6d5355c3 |
71 | Class::MOP::Package->meta->add_attribute( |
351bd7d4 |
72 | Class::MOP::Attribute->new('$:package' => ( |
b880e0de |
73 | reader => { |
74 | # NOTE: we need to do this in order |
75 | # for the instance meta-object to |
76 | # not fall into meta-circular death |
ce2ae40f |
77 | # |
78 | # we just alias the original method |
79 | # rather than re-produce it here |
80 | 'name' => \&Class::MOP::Package::name |
b880e0de |
81 | }, |
7b31baf4 |
82 | init_arg => ':package', |
727919c5 |
83 | )) |
84 | ); |
85 | |
a5e51f0b |
86 | Class::MOP::Package->meta->add_attribute( |
87 | Class::MOP::Attribute->new('%:namespace' => ( |
88 | reader => { |
56dcfc1a |
89 | # NOTE: |
ce2ae40f |
90 | # we just alias the original method |
91 | # rather than re-produce it here |
92 | 'namespace' => \&Class::MOP::Package::namespace |
a5e51f0b |
93 | }, |
94 | # NOTE: |
95 | # protect this from silliness |
a2ee6c61 |
96 | init_arg => '!............( DO NOT DO THIS )............!', |
c4260b45 |
97 | default => sub { \undef } |
a5e51f0b |
98 | )) |
99 | ); |
100 | |
9d6dce77 |
101 | # NOTE: |
102 | # use the metaclass to construct the meta-package |
103 | # which is a superclass of the metaclass itself :P |
104 | Class::MOP::Package->meta->add_method('initialize' => sub { |
105 | my $class = shift; |
106 | my $package_name = shift; |
107 | $class->meta->new_object(':package' => $package_name, @_); |
108 | }); |
109 | |
f0480c45 |
110 | ## -------------------------------------------------------- |
111 | ## Class::MOP::Module |
112 | |
113 | # NOTE: |
114 | # yeah this is kind of stretching things a bit, |
115 | # but truthfully the version should be an attribute |
116 | # of the Module, the weirdness comes from having to |
117 | # stick to Perl 5 convention and store it in the |
118 | # $VERSION package variable. Basically if you just |
119 | # squint at it, it will look how you want it to look. |
120 | # Either as a package variable, or as a attribute of |
121 | # the metaclass, isn't abstraction great :) |
122 | |
123 | Class::MOP::Module->meta->add_attribute( |
124 | Class::MOP::Attribute->new('$:version' => ( |
125 | reader => { |
ce2ae40f |
126 | # NOTE: |
127 | # we just alias the original method |
128 | # rather than re-produce it here |
129 | 'version' => \&Class::MOP::Module::version |
f0480c45 |
130 | }, |
131 | # NOTE: |
132 | # protect this from silliness |
133 | init_arg => '!............( DO NOT DO THIS )............!', |
c4260b45 |
134 | default => sub { \undef } |
f0480c45 |
135 | )) |
136 | ); |
137 | |
138 | # NOTE: |
139 | # By following the same conventions as version here, |
140 | # we are opening up the possibility that people can |
141 | # use the $AUTHORITY in non-Class::MOP modules as |
142 | # well. |
143 | |
144 | Class::MOP::Module->meta->add_attribute( |
145 | Class::MOP::Attribute->new('$:authority' => ( |
146 | reader => { |
ce2ae40f |
147 | # NOTE: |
148 | # we just alias the original method |
149 | # rather than re-produce it here |
150 | 'authority' => \&Class::MOP::Module::authority |
f0480c45 |
151 | }, |
152 | # NOTE: |
153 | # protect this from silliness |
154 | init_arg => '!............( DO NOT DO THIS )............!', |
c4260b45 |
155 | default => sub { \undef } |
f0480c45 |
156 | )) |
157 | ); |
158 | |
159 | ## -------------------------------------------------------- |
6d5355c3 |
160 | ## Class::MOP::Class |
161 | |
727919c5 |
162 | Class::MOP::Class->meta->add_attribute( |
351bd7d4 |
163 | Class::MOP::Attribute->new('%:attributes' => ( |
f7259199 |
164 | reader => { |
165 | # NOTE: we need to do this in order |
166 | # for the instance meta-object to |
ce2ae40f |
167 | # not fall into meta-circular death |
168 | # |
169 | # we just alias the original method |
170 | # rather than re-produce it here |
171 | 'get_attribute_map' => \&Class::MOP::Class::get_attribute_map |
f7259199 |
172 | }, |
351bd7d4 |
173 | init_arg => ':attributes', |
727919c5 |
174 | default => sub { {} } |
175 | )) |
176 | ); |
177 | |
351bd7d4 |
178 | Class::MOP::Class->meta->add_attribute( |
c4260b45 |
179 | Class::MOP::Attribute->new('%:methods' => ( |
92330ee2 |
180 | reader => { |
ce2ae40f |
181 | # NOTE: |
182 | # we just alias the original method |
183 | # rather than re-produce it here |
184 | 'get_method_map' => \&Class::MOP::Class::get_method_map |
92330ee2 |
185 | }, |
7855ddba |
186 | default => sub { {} } |
c4260b45 |
187 | )) |
188 | ); |
189 | |
190 | Class::MOP::Class->meta->add_attribute( |
351bd7d4 |
191 | Class::MOP::Attribute->new('$:attribute_metaclass' => ( |
6d2118a4 |
192 | reader => { |
193 | # NOTE: |
194 | # we just alias the original method |
195 | # rather than re-produce it here |
196 | 'attribute_metaclass' => \&Class::MOP::Class::attribute_metaclass |
197 | }, |
351bd7d4 |
198 | init_arg => ':attribute_metaclass', |
199 | default => 'Class::MOP::Attribute', |
200 | )) |
201 | ); |
202 | |
203 | Class::MOP::Class->meta->add_attribute( |
204 | Class::MOP::Attribute->new('$:method_metaclass' => ( |
6d2118a4 |
205 | reader => { |
206 | # NOTE: |
207 | # we just alias the original method |
208 | # rather than re-produce it here |
209 | 'method_metaclass' => \&Class::MOP::Class::method_metaclass |
210 | }, |
351bd7d4 |
211 | init_arg => ':method_metaclass', |
212 | default => 'Class::MOP::Method', |
213 | )) |
214 | ); |
215 | |
2bab2be6 |
216 | Class::MOP::Class->meta->add_attribute( |
217 | Class::MOP::Attribute->new('$:instance_metaclass' => ( |
b880e0de |
218 | reader => { |
219 | # NOTE: we need to do this in order |
220 | # for the instance meta-object to |
ce2ae40f |
221 | # not fall into meta-circular death |
222 | # |
223 | # we just alias the original method |
224 | # rather than re-produce it here |
225 | 'instance_metaclass' => \&Class::MOP::Class::instance_metaclass |
b880e0de |
226 | }, |
2bab2be6 |
227 | init_arg => ':instance_metaclass', |
228 | default => 'Class::MOP::Instance', |
229 | )) |
230 | ); |
231 | |
9d6dce77 |
232 | # NOTE: |
233 | # we don't actually need to tie the knot with |
234 | # Class::MOP::Class here, it is actually handled |
235 | # within Class::MOP::Class itself in the |
236 | # construct_class_instance method. |
237 | |
f0480c45 |
238 | ## -------------------------------------------------------- |
727919c5 |
239 | ## Class::MOP::Attribute |
240 | |
7b31baf4 |
241 | Class::MOP::Attribute->meta->add_attribute( |
242 | Class::MOP::Attribute->new('name' => ( |
b880e0de |
243 | reader => { |
244 | # NOTE: we need to do this in order |
245 | # for the instance meta-object to |
ce2ae40f |
246 | # not fall into meta-circular death |
247 | # |
248 | # we just alias the original method |
249 | # rather than re-produce it here |
250 | 'name' => \&Class::MOP::Attribute::name |
b880e0de |
251 | } |
7b31baf4 |
252 | )) |
253 | ); |
254 | |
255 | Class::MOP::Attribute->meta->add_attribute( |
256 | Class::MOP::Attribute->new('associated_class' => ( |
b880e0de |
257 | reader => { |
258 | # NOTE: we need to do this in order |
259 | # for the instance meta-object to |
ce2ae40f |
260 | # not fall into meta-circular death |
261 | # |
262 | # we just alias the original method |
263 | # rather than re-produce it here |
264 | 'associated_class' => \&Class::MOP::Attribute::associated_class |
b880e0de |
265 | } |
7b31baf4 |
266 | )) |
267 | ); |
268 | |
269 | Class::MOP::Attribute->meta->add_attribute( |
270 | Class::MOP::Attribute->new('accessor' => ( |
6d2118a4 |
271 | reader => { 'accessor' => \&Class::MOP::Attribute::accessor }, |
272 | predicate => { 'has_accessor' => \&Class::MOP::Attribute::has_accessor }, |
7b31baf4 |
273 | )) |
274 | ); |
275 | |
276 | Class::MOP::Attribute->meta->add_attribute( |
277 | Class::MOP::Attribute->new('reader' => ( |
6d2118a4 |
278 | reader => { 'reader' => \&Class::MOP::Attribute::reader }, |
279 | predicate => { 'has_reader' => \&Class::MOP::Attribute::has_reader }, |
7b31baf4 |
280 | )) |
281 | ); |
282 | |
283 | Class::MOP::Attribute->meta->add_attribute( |
284 | Class::MOP::Attribute->new('writer' => ( |
6d2118a4 |
285 | reader => { 'writer' => \&Class::MOP::Attribute::writer }, |
286 | predicate => { 'has_writer' => \&Class::MOP::Attribute::has_writer }, |
7b31baf4 |
287 | )) |
288 | ); |
289 | |
290 | Class::MOP::Attribute->meta->add_attribute( |
291 | Class::MOP::Attribute->new('predicate' => ( |
6d2118a4 |
292 | reader => { 'predicate' => \&Class::MOP::Attribute::predicate }, |
293 | predicate => { 'has_predicate' => \&Class::MOP::Attribute::has_predicate }, |
7b31baf4 |
294 | )) |
295 | ); |
296 | |
297 | Class::MOP::Attribute->meta->add_attribute( |
7d28758b |
298 | Class::MOP::Attribute->new('clearer' => ( |
6d2118a4 |
299 | reader => { 'clearer' => \&Class::MOP::Attribute::clearer }, |
300 | predicate => { 'has_clearer' => \&Class::MOP::Attribute::has_clearer }, |
7d28758b |
301 | )) |
302 | ); |
303 | |
304 | Class::MOP::Attribute->meta->add_attribute( |
7b31baf4 |
305 | Class::MOP::Attribute->new('init_arg' => ( |
6d2118a4 |
306 | reader => { 'init_arg' => \&Class::MOP::Attribute::init_arg }, |
307 | predicate => { 'has_init_arg' => \&Class::MOP::Attribute::has_init_arg }, |
7b31baf4 |
308 | )) |
309 | ); |
310 | |
311 | Class::MOP::Attribute->meta->add_attribute( |
312 | Class::MOP::Attribute->new('default' => ( |
313 | # default has a custom 'reader' method ... |
6d2118a4 |
314 | predicate => { 'has_default' => \&Class::MOP::Attribute::has_default }, |
7b31baf4 |
315 | )) |
316 | ); |
317 | |
727919c5 |
318 | |
319 | # NOTE: (meta-circularity) |
320 | # This should be one of the last things done |
321 | # it will "tie the knot" with Class::MOP::Attribute |
322 | # so that it uses the attributes meta-objects |
323 | # to construct itself. |
324 | Class::MOP::Attribute->meta->add_method('new' => sub { |
325 | my $class = shift; |
326 | my $name = shift; |
327 | my %options = @_; |
328 | |
329 | (defined $name && $name) |
330 | || confess "You must provide a name for the attribute"; |
5659d76e |
331 | $options{init_arg} = $name |
332 | if not exists $options{init_arg}; |
148b4697 |
333 | |
334 | (Class::MOP::Attribute::is_default_a_coderef(\%options)) |
335 | || confess("References are not allowed as default values, you must ". |
336 | "wrap then in a CODE reference (ex: sub { [] } and not [])") |
337 | if exists $options{default} && ref $options{default}; |
651955fb |
338 | |
5659d76e |
339 | # return the new object |
340 | $class->meta->new_object(name => $name, %options); |
341 | }); |
342 | |
343 | Class::MOP::Attribute->meta->add_method('clone' => sub { |
a740253a |
344 | my $self = shift; |
a27ae83f |
345 | $self->meta->clone_object($self, @_); |
727919c5 |
346 | }); |
347 | |
f0480c45 |
348 | ## -------------------------------------------------------- |
b6164407 |
349 | ## Class::MOP::Method |
350 | |
351 | Class::MOP::Method->meta->add_attribute( |
352 | Class::MOP::Attribute->new('body' => ( |
6d2118a4 |
353 | reader => { 'body' => \&Class::MOP::Method::body }, |
b6164407 |
354 | )) |
355 | ); |
356 | |
357 | ## -------------------------------------------------------- |
358 | ## Class::MOP::Method::Wrapped |
359 | |
360 | # NOTE: |
361 | # the way this item is initialized, this |
362 | # really does not follow the standard |
363 | # practices of attributes, but we put |
364 | # it here for completeness |
365 | Class::MOP::Method::Wrapped->meta->add_attribute( |
366 | Class::MOP::Attribute->new('modifier_table') |
367 | ); |
368 | |
369 | ## -------------------------------------------------------- |
86482605 |
370 | ## Class::MOP::Instance |
371 | |
372 | # NOTE: |
373 | # these don't yet do much of anything, but are just |
374 | # included for completeness |
375 | |
376 | Class::MOP::Instance->meta->add_attribute( |
377 | Class::MOP::Attribute->new('meta') |
378 | ); |
379 | |
380 | Class::MOP::Instance->meta->add_attribute( |
381 | Class::MOP::Attribute->new('slots') |
382 | ); |
383 | |
384 | ## -------------------------------------------------------- |
f0480c45 |
385 | ## Now close all the Class::MOP::* classes |
4d47b77f |
386 | |
0b9372a2 |
387 | # NOTE: |
388 | # we don't need to inline the |
389 | # constructors or the accessors |
390 | # this only lengthens the compile |
391 | # time of the MOP, and gives us |
392 | # no actual benefits. |
393 | |
394 | $_->meta->make_immutable( |
395 | inline_constructor => 0, |
396 | inline_accessors => 0, |
397 | ) for qw/ |
398 | Class::MOP::Package |
399 | Class::MOP::Module |
400 | Class::MOP::Class |
86482605 |
401 | |
0b9372a2 |
402 | Class::MOP::Attribute |
403 | Class::MOP::Method |
404 | Class::MOP::Instance |
86482605 |
405 | |
0b9372a2 |
406 | Class::MOP::Object |
407 | |
408 | Class::MOP::Attribute::Accessor |
409 | Class::MOP::Method::Wrapped |
410 | /; |
b6164407 |
411 | |
94b19069 |
412 | 1; |
413 | |
414 | __END__ |
415 | |
416 | =pod |
417 | |
418 | =head1 NAME |
419 | |
420 | Class::MOP - A Meta Object Protocol for Perl 5 |
421 | |
422 | =head1 SYNOPSIS |
423 | |
a2e85e6c |
424 | # ... This will come later, for now see |
425 | # the other SYNOPSIS for more information |
94b19069 |
426 | |
427 | =head1 DESCRIPTON |
428 | |
429 | This module is an attempt to create a meta object protocol for the |
430 | Perl 5 object system. It makes no attempt to change the behavior or |
431 | characteristics of the Perl 5 object system, only to create a |
27e31eaf |
432 | protocol for its manipulation and introspection. |
94b19069 |
433 | |
434 | That said, it does attempt to create the tools for building a rich |
435 | set of extensions to the Perl 5 object system. Every attempt has been |
436 | made for these tools to keep to the spirit of the Perl 5 object |
437 | system that we all know and love. |
438 | |
40483095 |
439 | This documentation is admittedly sparse on details, as time permits |
440 | I will try to improve them. For now, I suggest looking at the items |
441 | listed in the L<SEE ALSO> section for more information. In particular |
442 | the book "The Art of the Meta Object Protocol" was very influential |
443 | in the development of this system. |
444 | |
bfe4d0fc |
445 | =head2 What is a Meta Object Protocol? |
446 | |
447 | A meta object protocol is an API to an object system. |
448 | |
449 | To be more specific, it is a set of abstractions of the components of |
450 | an object system (typically things like; classes, object, methods, |
451 | object attributes, etc.). These abstractions can then be used to both |
452 | inspect and manipulate the object system which they describe. |
453 | |
454 | It can be said that there are two MOPs for any object system; the |
455 | implicit MOP, and the explicit MOP. The implicit MOP handles things |
456 | like method dispatch or inheritance, which happen automatically as |
457 | part of how the object system works. The explicit MOP typically |
458 | handles the introspection/reflection features of the object system. |
459 | All object systems have implicit MOPs, without one, they would not |
460 | work. Explict MOPs however as less common, and depending on the |
461 | language can vary from restrictive (Reflection in Java or C#) to |
462 | wide open (CLOS is a perfect example). |
463 | |
e16da3e6 |
464 | =head2 Yet Another Class Builder!! Why? |
465 | |
466 | This is B<not> a class builder so much as it is a I<class builder |
467 | B<builder>>. My intent is that an end user does not use this module |
468 | directly, but instead this module is used by module authors to |
469 | build extensions and features onto the Perl 5 object system. |
470 | |
94b19069 |
471 | =head2 Who is this module for? |
472 | |
473 | This module is specifically for anyone who has ever created or |
474 | wanted to create a module for the Class:: namespace. The tools which |
475 | this module will provide will hopefully make it easier to do more |
476 | complex things with Perl 5 classes by removing such barriers as |
477 | the need to hack the symbol tables, or understand the fine details |
478 | of method dispatch. |
479 | |
bfe4d0fc |
480 | =head2 What changes do I have to make to use this module? |
481 | |
2eb717d5 |
482 | This module was designed to be as unintrusive as possible. Many of |
343203ee |
483 | its features are accessible without B<any> change to your existsing |
bfe4d0fc |
484 | code at all. It is meant to be a compliment to your existing code and |
2eb717d5 |
485 | not an intrusion on your code base. Unlike many other B<Class::> |
a2e85e6c |
486 | modules, this module B<does not> require you subclass it, or even that |
487 | you C<use> it in within your module's package. |
bfe4d0fc |
488 | |
2eb717d5 |
489 | The only features which requires additions to your code are the |
490 | attribute handling and instance construction features, and these are |
a2e85e6c |
491 | both completely optional features. The only reason for this is because |
2eb717d5 |
492 | Perl 5's object system does not actually have these features built |
493 | in. More information about this feature can be found below. |
bfe4d0fc |
494 | |
495 | =head2 A Note about Performance? |
496 | |
497 | It is a common misconception that explict MOPs are performance drains. |
498 | But this is not a universal truth at all, it is an side-effect of |
499 | specific implementations. For instance, using Java reflection is much |
500 | slower because the JVM cannot take advantage of any compiler |
501 | optimizations, and the JVM has to deal with much more runtime type |
502 | information as well. Reflection in C# is marginally better as it was |
503 | designed into the language and runtime (the CLR). In contrast, CLOS |
504 | (the Common Lisp Object System) was built to support an explicit MOP, |
505 | and so performance is tuned for it. |
506 | |
507 | This library in particular does it's absolute best to avoid putting |
2eb717d5 |
508 | B<any> drain at all upon your code's performance. In fact, by itself |
509 | it does nothing to affect your existing code. So you only pay for |
510 | what you actually use. |
bfe4d0fc |
511 | |
550d56db |
512 | =head2 About Metaclass compatibility |
513 | |
514 | This module makes sure that all metaclasses created are both upwards |
515 | and downwards compatible. The topic of metaclass compatibility is |
516 | highly esoteric and is something only encountered when doing deep and |
517 | involved metaclass hacking. There are two basic kinds of metaclass |
518 | incompatibility; upwards and downwards. |
519 | |
520 | Upwards metaclass compatibility means that the metaclass of a |
521 | given class is either the same as (or a subclass of) all of the |
522 | class's ancestors. |
523 | |
524 | Downward metaclass compatibility means that the metaclasses of a |
525 | given class's anscestors are all either the same as (or a subclass |
526 | of) that metaclass. |
527 | |
528 | Here is a diagram showing a set of two classes (C<A> and C<B>) and |
529 | two metaclasses (C<Meta::A> and C<Meta::B>) which have correct |
530 | metaclass compatibility both upwards and downwards. |
531 | |
532 | +---------+ +---------+ |
533 | | Meta::A |<----| Meta::B | <....... (instance of ) |
534 | +---------+ +---------+ <------- (inherits from) |
535 | ^ ^ |
536 | : : |
537 | +---------+ +---------+ |
538 | | A |<----| B | |
539 | +---------+ +---------+ |
540 | |
541 | As I said this is a highly esoteric topic and one you will only run |
542 | into if you do a lot of subclassing of B<Class::MOP::Class>. If you |
543 | are interested in why this is an issue see the paper |
544 | I<Uniform and safe metaclass composition> linked to in the |
545 | L<SEE ALSO> section of this document. |
546 | |
aa448b16 |
547 | =head2 Using custom metaclasses |
548 | |
549 | Always use the metaclass pragma when using a custom metaclass, this |
550 | will ensure the proper initialization order and not accidentely |
551 | create an incorrect type of metaclass for you. This is a very rare |
552 | problem, and one which can only occur if you are doing deep metaclass |
553 | programming. So in other words, don't worry about it. |
554 | |
94b19069 |
555 | =head1 PROTOCOLS |
556 | |
557 | The protocol is divided into 3 main sub-protocols: |
558 | |
559 | =over 4 |
560 | |
561 | =item The Class protocol |
562 | |
563 | This provides a means of manipulating and introspecting a Perl 5 |
564 | class. It handles all of symbol table hacking for you, and provides |
565 | a rich set of methods that go beyond simple package introspection. |
566 | |
552e3d24 |
567 | See L<Class::MOP::Class> for more details. |
568 | |
94b19069 |
569 | =item The Attribute protocol |
570 | |
571 | This provides a consistent represenation for an attribute of a |
572 | Perl 5 class. Since there are so many ways to create and handle |
573 | atttributes in Perl 5 OO, this attempts to provide as much of a |
574 | unified approach as possible, while giving the freedom and |
575 | flexibility to subclass for specialization. |
576 | |
552e3d24 |
577 | See L<Class::MOP::Attribute> for more details. |
578 | |
94b19069 |
579 | =item The Method protocol |
580 | |
581 | This provides a means of manipulating and introspecting methods in |
582 | the Perl 5 object system. As with attributes, there are many ways to |
583 | approach this topic, so we try to keep it pretty basic, while still |
584 | making it possible to extend the system in many ways. |
585 | |
552e3d24 |
586 | See L<Class::MOP::Method> for more details. |
94b19069 |
587 | |
588 | =back |
589 | |
be7677c7 |
590 | =head1 FUNCTIONS |
591 | |
592 | Class::MOP holds a cache of metaclasses, the following are functions |
593 | (B<not methods>) which can be used to access that cache. It is not |
594 | recommended that you mess with this, bad things could happen. But if |
595 | you are brave and willing to risk it, go for it. |
596 | |
597 | =over 4 |
598 | |
599 | =item B<get_all_metaclasses> |
600 | |
b9d9fc0b |
601 | This will return an hash of all the metaclass instances that have |
602 | been cached by B<Class::MOP::Class> keyed by the package name. |
603 | |
be7677c7 |
604 | =item B<get_all_metaclass_instances> |
605 | |
b9d9fc0b |
606 | This will return an array of all the metaclass instances that have |
607 | been cached by B<Class::MOP::Class>. |
608 | |
be7677c7 |
609 | =item B<get_all_metaclass_names> |
610 | |
b9d9fc0b |
611 | This will return an array of all the metaclass names that have |
612 | been cached by B<Class::MOP::Class>. |
613 | |
be7677c7 |
614 | =item B<get_metaclass_by_name ($name)> |
615 | |
616 | =item B<store_metaclass_by_name ($name, $meta)> |
617 | |
618 | =item B<weaken_metaclass ($name)> |
619 | |
620 | =item B<does_metaclass_exist ($name)> |
621 | |
622 | =item B<remove_metaclass_by_name ($name)> |
623 | |
624 | =back |
625 | |
552e3d24 |
626 | =head1 SEE ALSO |
8b978dd5 |
627 | |
552e3d24 |
628 | =head2 Books |
8b978dd5 |
629 | |
a2e85e6c |
630 | There are very few books out on Meta Object Protocols and Metaclasses |
631 | because it is such an esoteric topic. The following books are really |
632 | the only ones I have found. If you know of any more, B<I<please>> |
633 | email me and let me know, I would love to hear about them. |
634 | |
8b978dd5 |
635 | =over 4 |
636 | |
552e3d24 |
637 | =item "The Art of the Meta Object Protocol" |
8b978dd5 |
638 | |
552e3d24 |
639 | =item "Advances in Object-Oriented Metalevel Architecture and Reflection" |
8b978dd5 |
640 | |
b51af7f9 |
641 | =item "Putting MetaClasses to Work" |
642 | |
a2e85e6c |
643 | =item "Smalltalk: The Language" |
644 | |
94b19069 |
645 | =back |
646 | |
550d56db |
647 | =head2 Papers |
648 | |
649 | =over 4 |
650 | |
651 | =item Uniform and safe metaclass composition |
652 | |
653 | An excellent paper by the people who brought us the original Traits paper. |
654 | This paper is on how Traits can be used to do safe metaclass composition, |
655 | and offers an excellent introduction section which delves into the topic of |
656 | metaclass compatibility. |
657 | |
658 | L<http://www.iam.unibe.ch/~scg/Archive/Papers/Duca05ySafeMetaclassTrait.pdf> |
659 | |
660 | =item Safe Metaclass Programming |
661 | |
662 | This paper seems to precede the above paper, and propose a mix-in based |
663 | approach as opposed to the Traits based approach. Both papers have similar |
664 | information on the metaclass compatibility problem space. |
665 | |
666 | L<http://citeseer.ist.psu.edu/37617.html> |
667 | |
668 | =back |
669 | |
552e3d24 |
670 | =head2 Prior Art |
8b978dd5 |
671 | |
672 | =over 4 |
673 | |
7184ca14 |
674 | =item The Perl 6 MetaModel work in the Pugs project |
8b978dd5 |
675 | |
676 | =over 4 |
677 | |
552e3d24 |
678 | =item L<http://svn.openfoundry.org/pugs/perl5/Perl6-MetaModel> |
8b978dd5 |
679 | |
552e3d24 |
680 | =item L<http://svn.openfoundry.org/pugs/perl5/Perl6-ObjectSpace> |
8b978dd5 |
681 | |
682 | =back |
683 | |
94b19069 |
684 | =back |
685 | |
f8dfcfb7 |
686 | =head2 Article |
687 | |
688 | =over 4 |
689 | |
690 | =item CPAN Module Review of Class::MOP |
691 | |
692 | L<http://www.oreillynet.com/onlamp/blog/2006/06/cpan_module_review_classmop.html> |
693 | |
694 | =back |
695 | |
a2e85e6c |
696 | =head1 SIMILAR MODULES |
697 | |
698 | As I have said above, this module is a class-builder-builder, so it is |
699 | not the same thing as modules like L<Class::Accessor> and |
700 | L<Class::MethodMaker>. That being said there are very few modules on CPAN |
701 | with similar goals to this module. The one I have found which is most |
550d56db |
702 | like this module is L<Class::Meta>, although it's philosophy and the MOP it |
703 | creates are very different from this modules. |
94b19069 |
704 | |
a2e85e6c |
705 | =head1 BUGS |
706 | |
707 | All complex software has bugs lurking in it, and this module is no |
708 | exception. If you find a bug please either email me, or add the bug |
709 | to cpan-RT. |
710 | |
22286063 |
711 | =head1 CODE COVERAGE |
712 | |
713 | I use L<Devel::Cover> to test the code coverage of my tests, below is the |
714 | L<Devel::Cover> report on this module's test suite. |
715 | |
716 | ---------------------------- ------ ------ ------ ------ ------ ------ ------ |
717 | File stmt bran cond sub pod time total |
718 | ---------------------------- ------ ------ ------ ------ ------ ------ ------ |
b9d9fc0b |
719 | Class/MOP.pm 78.0 87.5 55.6 71.4 100.0 12.4 76.8 |
720 | Class/MOP/Attribute.pm 83.4 75.6 86.7 94.4 100.0 8.9 85.2 |
721 | Class/MOP/Class.pm 96.9 75.8 43.2 98.0 100.0 55.3 83.6 |
722 | Class/MOP/Class/Immutable.pm 88.5 53.8 n/a 95.8 100.0 1.1 84.7 |
723 | Class/MOP/Instance.pm 87.9 75.0 33.3 89.7 100.0 10.1 89.1 |
724 | Class/MOP/Method.pm 97.6 60.0 57.9 76.9 100.0 1.5 82.8 |
725 | Class/MOP/Module.pm 87.5 n/a 11.1 83.3 100.0 0.3 66.7 |
726 | Class/MOP/Object.pm 100.0 n/a 33.3 100.0 100.0 0.1 89.5 |
727 | Class/MOP/Package.pm 95.1 69.0 33.3 100.0 100.0 9.9 85.5 |
728 | metaclass.pm 100.0 100.0 83.3 100.0 n/a 0.5 97.7 |
22286063 |
729 | ---------------------------- ------ ------ ------ ------ ------ ------ ------ |
b9d9fc0b |
730 | Total 91.5 72.1 48.8 90.7 100.0 100.0 84.2 |
22286063 |
731 | ---------------------------- ------ ------ ------ ------ ------ ------ ------ |
732 | |
a2e85e6c |
733 | =head1 ACKNOWLEDGEMENTS |
734 | |
735 | =over 4 |
736 | |
b9d9fc0b |
737 | =item Rob Kinyon |
a2e85e6c |
738 | |
739 | Thanks to Rob for actually getting the development of this module kick-started. |
740 | |
741 | =back |
742 | |
1a09d9cc |
743 | =head1 AUTHORS |
94b19069 |
744 | |
a2e85e6c |
745 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
552e3d24 |
746 | |
1a09d9cc |
747 | Yuval Kogman E<lt>nothingmuch@woobling.comE<gt> |
748 | |
94b19069 |
749 | =head1 COPYRIGHT AND LICENSE |
750 | |
751 | Copyright 2006 by Infinity Interactive, Inc. |
752 | |
753 | L<http://www.iinteractive.com> |
754 | |
755 | This library is free software; you can redistribute it and/or modify |
756 | it under the same terms as Perl itself. |
757 | |
758 | =cut |