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