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