groditis anon class fixup
[gitmo/Class-MOP.git] / lib / Class / MOP / Class.pm
1
2 package Class::MOP::Class;
3
4 use strict;
5 use warnings;
6
7 use Class::MOP::Immutable;
8 use Class::MOP::Instance;
9 use Class::MOP::Method::Wrapped;
10
11 use Carp         'confess';
12 use Scalar::Util 'blessed', 'reftype', 'weaken';
13 use Sub::Name    'subname';
14 use B            'svref_2object';
15
16 our $VERSION   = '0.23';
17 our $AUTHORITY = 'cpan:STEVAN';
18
19 use base 'Class::MOP::Module';
20
21 # Self-introspection 
22
23 sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) }
24
25 # Creation
26     
27 sub initialize {
28     my $class        = shift;
29     my $package_name = shift;
30     (defined $package_name && $package_name && !blessed($package_name))
31         || confess "You must pass a package name and it cannot be blessed";    
32     $class->construct_class_instance('package' => $package_name, @_);
33 }
34
35 sub reinitialize {
36     my $class        = shift;
37     my $package_name = shift;
38     (defined $package_name && $package_name && !blessed($package_name))
39         || confess "You must pass a package name and it cannot be blessed";    
40     Class::MOP::remove_metaclass_by_name($package_name);
41     $class->construct_class_instance('package' => $package_name, @_);
42 }       
43     
44 # NOTE: (meta-circularity) 
45 # this is a special form of &construct_instance 
46 # (see below), which is used to construct class
47 # meta-object instances for any Class::MOP::* 
48 # class. All other classes will use the more 
49 # normal &construct_instance.
50 sub construct_class_instance {
51     my $class        = shift;
52     my %options      = @_;
53     my $package_name = $options{'package'};
54     (defined $package_name && $package_name)
55         || confess "You must pass a package name";  
56     # NOTE:
57     # return the metaclass if we have it cached, 
58     # and it is still defined (it has not been 
59     # reaped by DESTROY yet, which can happen 
60     # annoyingly enough during global destruction)
61     return Class::MOP::get_metaclass_by_name($package_name)
62         if Class::MOP::does_metaclass_exist($package_name);  
63
64     # NOTE:
65     # we need to deal with the possibility 
66     # of class immutability here, and then 
67     # get the name of the class appropriately
68     $class = (blessed($class)
69                     ? ($class->is_immutable
70                         ? $class->get_mutable_metaclass_name()
71                         : blessed($class))
72                     : $class);
73
74     # now create the metaclass
75     my $meta;
76     if ($class =~ /^Class::MOP::Class$/) {
77         no strict 'refs';                
78         $meta = bless { 
79             # inherited from Class::MOP::Package
80             '$!package'             => $package_name, 
81             
82             # NOTE:
83             # since the following attributes will 
84             # actually be loaded from the symbol 
85             # table, and actually bypass the instance
86             # entirely, we can just leave these things
87             # listed here for reference, because they
88             # should not actually have a value associated 
89             # with the slot.
90             '%!namespace'           => \undef,                
91             # inherited from Class::MOP::Module
92             '$!version'             => \undef,
93             '$!authority'           => \undef,
94             # defined in Class::MOP::Class
95             '@!superclasses'        => \undef,
96             
97             '%!methods'             => {},
98             '%!attributes'          => {},            
99             '$!attribute_metaclass' => $options{'attribute_metaclass'} || 'Class::MOP::Attribute',
100             '$!method_metaclass'    => $options{'method_metaclass'}    || 'Class::MOP::Method',
101             '$!instance_metaclass'  => $options{'instance_metaclass'}  || 'Class::MOP::Instance',
102         } => $class;
103     }
104     else {
105         # NOTE:
106         # it is safe to use meta here because
107         # class will always be a subclass of 
108         # Class::MOP::Class, which defines meta
109         $meta = $class->meta->construct_instance(%options)
110     }
111     
112     # and check the metaclass compatibility
113     $meta->check_metaclass_compatability();
114     
115     Class::MOP::store_metaclass_by_name($package_name, $meta);
116     
117     # NOTE:
118     # we need to weaken any anon classes
119     # so that they can call DESTROY properly
120     Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class;
121     
122     $meta;        
123
124     
125 sub check_metaclass_compatability {
126     my $self = shift;
127
128     # this is always okay ...
129     return if blessed($self)            eq 'Class::MOP::Class'   && 
130               $self->instance_metaclass eq 'Class::MOP::Instance';
131
132     my @class_list = $self->class_precedence_list;
133     shift @class_list; # shift off $self->name
134
135     foreach my $class_name (@class_list) { 
136         my $meta = Class::MOP::get_metaclass_by_name($class_name) || next;
137         
138         # NOTE:
139         # we need to deal with the possibility 
140         # of class immutability here, and then 
141         # get the name of the class appropriately            
142         my $meta_type = ($meta->is_immutable
143                             ? $meta->get_mutable_metaclass_name()
144                             : blessed($meta));                
145                             
146         ($self->isa($meta_type))
147             || confess $self->name . "->meta => (" . (blessed($self)) . ")" . 
148                        " is not compatible with the " . 
149                        $class_name . "->meta => (" . ($meta_type)     . ")";
150         # NOTE:
151         # we also need to check that instance metaclasses
152         # are compatabile in the same the class.
153         ($self->instance_metaclass->isa($meta->instance_metaclass))
154             || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" . 
155                        " is not compatible with the " . 
156                        $class_name . "->meta => (" . ($meta->instance_metaclass) . ")";                           
157     }        
158
159
160 ## ANON classes
161
162 {
163     # NOTE:
164     # this should be sufficient, if you have a 
165     # use case where it is not, write a test and 
166     # I will change it.
167     my $ANON_CLASS_SERIAL = 0;
168     
169     # NOTE:
170     # we need a sufficiently annoying prefix
171     # this should suffice for now, this is 
172     # used in a couple of places below, so 
173     # need to put it up here for now.
174     my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';    
175
176     sub is_anon_class {
177         my $self = shift;
178         no warnings 'uninitialized';
179         $self->name =~ /^$ANON_CLASS_PREFIX/ ? 1 : 0;        
180     }
181
182     sub create_anon_class {
183         my ($class, %options) = @_;   
184         my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
185         return $class->create($package_name, %options);
186     } 
187
188     # NOTE:
189     # this will only get called for 
190     # anon-classes, all other calls 
191     # are assumed to occur during 
192     # global destruction and so don't
193     # really need to be handled explicitly
194     sub DESTROY {
195         my $self = shift;
196         no warnings 'uninitialized';        
197         return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
198         my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
199         no strict 'refs';     
200         foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
201             delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
202         }
203         delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};        
204     }
205
206 }
207
208 # creating classes with MOP ...
209
210 sub create {
211     my $class        = shift;
212     my $package_name = shift;
213     
214     (defined $package_name && $package_name)
215         || confess "You must pass a package name";
216
217     (scalar @_ % 2 == 0)
218         || confess "You much pass all parameters as name => value pairs " . 
219                    "(I found an uneven number of params in \@_)";
220
221     my (%options) = @_;
222     
223     my $code = "package $package_name;";
224     $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" 
225         if exists $options{version};
226     $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';" 
227         if exists $options{authority};  
228               
229     eval $code;
230     confess "creation of $package_name failed : $@" if $@;    
231     
232     my $meta = $class->initialize($package_name);
233     
234     $meta->add_method('meta' => sub { 
235         $class->initialize(blessed($_[0]) || $_[0]);
236     });
237     
238     $meta->superclasses(@{$options{superclasses}})
239         if exists $options{superclasses};
240     # NOTE:
241     # process attributes first, so that they can 
242     # install accessors, but locally defined methods
243     # can then overwrite them. It is maybe a little odd, but
244     # I think this should be the order of things.
245     if (exists $options{attributes}) {
246         foreach my $attr (@{$options{attributes}}) {
247             $meta->add_attribute($attr);
248         }
249     }        
250     if (exists $options{methods}) {
251         foreach my $method_name (keys %{$options{methods}}) {
252             $meta->add_method($method_name, $options{methods}->{$method_name});
253         }
254     }  
255     return $meta;
256 }
257
258 ## Attribute readers
259
260 # NOTE:
261 # all these attribute readers will be bootstrapped 
262 # away in the Class::MOP bootstrap section
263
264 sub get_attribute_map   { $_[0]->{'%!attributes'}          }
265 sub attribute_metaclass { $_[0]->{'$!attribute_metaclass'} }
266 sub method_metaclass    { $_[0]->{'$!method_metaclass'}    }
267 sub instance_metaclass  { $_[0]->{'$!instance_metaclass'}  }
268
269 # FIXME:
270 # this is a prime canidate for conversion to XS
271 sub get_method_map {    
272     my $self = shift;
273     my $map  = $self->{'%!methods'}; 
274     
275     my $class_name       = $self->name;
276     my $method_metaclass = $self->method_metaclass;
277     
278     foreach my $symbol ($self->list_all_package_symbols('CODE')) {
279         my $code = $self->get_package_symbol('&' . $symbol);
280         
281         next if exists  $map->{$symbol} && 
282                 defined $map->{$symbol} && 
283                         $map->{$symbol}->body == $code;        
284         
285         my $gv = svref_2object($code)->GV;
286         next if ($gv->STASH->NAME || '') ne $class_name &&
287                 ($gv->NAME        || '') ne '__ANON__';        
288         
289         $map->{$symbol} = $method_metaclass->wrap($code);
290     }
291     
292     return $map;
293 }
294
295 # Instance Construction & Cloning
296
297 sub new_object {
298     my $class = shift;
299     # NOTE:
300     # we need to protect the integrity of the 
301     # Class::MOP::Class singletons here, so we
302     # delegate this to &construct_class_instance
303     # which will deal with the singletons
304     return $class->construct_class_instance(@_)
305         if $class->name->isa('Class::MOP::Class');
306     return $class->construct_instance(@_);
307 }
308
309 sub construct_instance {
310     my ($class, %params) = @_;
311     my $meta_instance = $class->get_meta_instance();
312     my $instance = $meta_instance->create_instance();
313     foreach my $attr ($class->compute_all_applicable_attributes()) {
314         $attr->initialize_instance_slot($meta_instance, $instance, \%params);
315     }
316     # NOTE: 
317     # this will only work for a HASH instance type
318     if ($class->is_anon_class) {
319         (reftype($instance) eq 'HASH')
320             || confess "Currently only HASH based instances are supported with instance of anon-classes";
321         # NOTE:
322         # At some point we should make this official
323         # as a reserved slot name, but right now I am 
324         # going to keep it here.
325         # my $RESERVED_MOP_SLOT = '__MOP__';
326         $instance->{'__MOP__'} = $class;
327     }
328     return $instance;
329 }
330
331 sub get_meta_instance {
332     my $class = shift;
333     return $class->instance_metaclass->new(
334         $class, 
335         $class->compute_all_applicable_attributes()
336     );
337 }
338
339 sub clone_object {
340     my $class    = shift;
341     my $instance = shift; 
342     (blessed($instance) && $instance->isa($class->name))
343         || confess "You must pass an instance ($instance) of the metaclass (" . $class->name . ")";
344     # NOTE:
345     # we need to protect the integrity of the 
346     # Class::MOP::Class singletons here, they 
347     # should not be cloned.
348     return $instance if $instance->isa('Class::MOP::Class');   
349     $class->clone_instance($instance, @_);
350 }
351
352 sub clone_instance {
353     my ($class, $instance, %params) = @_;
354     (blessed($instance))
355         || confess "You can only clone instances, \$self is not a blessed instance";
356     my $meta_instance = $class->get_meta_instance();
357     my $clone = $meta_instance->clone_instance($instance);     
358     foreach my $attr ($class->compute_all_applicable_attributes()) {
359         if (exists $params{$attr->init_arg}) {
360             $meta_instance->set_slot_value($clone, $attr->name, $params{$attr->init_arg});                    
361         }
362     }       
363     return $clone;    
364 }
365
366 # Inheritance
367
368 sub superclasses {
369     my $self = shift;
370     if (@_) {
371         my @supers = @_;
372         @{$self->get_package_symbol('@ISA')} = @supers;
373         # NOTE:
374         # we need to check the metaclass 
375         # compatability here so that we can 
376         # be sure that the superclass is 
377         # not potentially creating an issues 
378         # we don't know about
379         $self->check_metaclass_compatability();
380     }
381     @{$self->get_package_symbol('@ISA')};
382 }
383
384 sub class_precedence_list {
385     my $self = shift;
386     # NOTE:
387     # We need to check for ciruclar inheirtance here.
388     # This will do nothing if all is well, and blow
389     # up otherwise. Yes, it's an ugly hack, better 
390     # suggestions are welcome.
391     { ($self->name || return)->isa('This is a test for circular inheritance') }
392     # ... and now back to our regularly scheduled program
393     (
394         $self->name, 
395         map { 
396             $self->initialize($_)->class_precedence_list()
397         } $self->superclasses()
398     );   
399 }
400
401 ## Methods
402
403 sub add_method {
404     my ($self, $method_name, $method) = @_;
405     (defined $method_name && $method_name)
406         || confess "You must define a method name";
407     
408     my $body;
409     if (blessed($method)) {
410         $body = $method->body;           
411     }
412     else {        
413         $body = $method;
414         ('CODE' eq (reftype($body) || ''))
415             || confess "Your code block must be a CODE reference";        
416         $method = $self->method_metaclass->wrap($body);        
417     }
418     $self->get_method_map->{$method_name} = $method;
419     
420     my $full_method_name = ($self->name . '::' . $method_name);        
421     $self->add_package_symbol("&${method_name}" => subname $full_method_name => $body);
422 }
423
424 {
425     my $fetch_and_prepare_method = sub {
426         my ($self, $method_name) = @_;
427         # fetch it locally
428         my $method = $self->get_method($method_name);
429         # if we dont have local ...
430         unless ($method) {
431             # try to find the next method
432             $method = $self->find_next_method_by_name($method_name);
433             # die if it does not exist
434             (defined $method)
435                 || confess "The method '$method_name' is not found in the inheritance hierarchy for class " . $self->name;
436             # and now make sure to wrap it 
437             # even if it is already wrapped
438             # because we need a new sub ref
439             $method = Class::MOP::Method::Wrapped->wrap($method);
440         }
441         else {
442             # now make sure we wrap it properly 
443             $method = Class::MOP::Method::Wrapped->wrap($method)
444                 unless $method->isa('Class::MOP::Method::Wrapped');  
445         }    
446         $self->add_method($method_name => $method);        
447         return $method;
448     };
449
450     sub add_before_method_modifier {
451         my ($self, $method_name, $method_modifier) = @_;
452         (defined $method_name && $method_name)
453             || confess "You must pass in a method name";    
454         my $method = $fetch_and_prepare_method->($self, $method_name);
455         $method->add_before_modifier(subname ':before' => $method_modifier);
456     }
457
458     sub add_after_method_modifier {
459         my ($self, $method_name, $method_modifier) = @_;
460         (defined $method_name && $method_name)
461             || confess "You must pass in a method name";    
462         my $method = $fetch_and_prepare_method->($self, $method_name);
463         $method->add_after_modifier(subname ':after' => $method_modifier);
464     }
465     
466     sub add_around_method_modifier {
467         my ($self, $method_name, $method_modifier) = @_;
468         (defined $method_name && $method_name)
469             || confess "You must pass in a method name";
470         my $method = $fetch_and_prepare_method->($self, $method_name);
471         $method->add_around_modifier(subname ':around' => $method_modifier);
472     }   
473
474     # NOTE: 
475     # the methods above used to be named like this:
476     #    ${pkg}::${method}:(before|after|around)
477     # but this proved problematic when using one modifier
478     # to wrap multiple methods (something which is likely
479     # to happen pretty regularly IMO). So instead of naming
480     # it like this, I have chosen to just name them purely 
481     # with their modifier names, like so:
482     #    :(before|after|around)
483     # The fact is that in a stack trace, it will be fairly 
484     # evident from the context what method they are attached
485     # to, and so don't need the fully qualified name.
486 }
487
488 sub alias_method {
489     my ($self, $method_name, $method) = @_;
490     (defined $method_name && $method_name)
491         || confess "You must define a method name";
492
493     my $body = (blessed($method) ? $method->body : $method);
494     ('CODE' eq (reftype($body) || ''))
495         || confess "Your code block must be a CODE reference";        
496         
497     $self->add_package_symbol("&${method_name}" => $body);
498 }
499
500 sub has_method {
501     my ($self, $method_name) = @_;
502     (defined $method_name && $method_name)
503         || confess "You must define a method name";    
504     
505     return 0 unless exists $self->get_method_map->{$method_name};    
506     return 1;
507 }
508
509 sub get_method {
510     my ($self, $method_name) = @_;
511     (defined $method_name && $method_name)
512         || confess "You must define a method name";
513      
514     # NOTE:
515     # I don't really need this here, because
516     # if the method_map is missing a key it 
517     # will just return undef for me now
518     # return unless $self->has_method($method_name);
519  
520     return $self->get_method_map->{$method_name};
521 }
522
523 sub remove_method {
524     my ($self, $method_name) = @_;
525     (defined $method_name && $method_name)
526         || confess "You must define a method name";
527     
528     my $removed_method = $self->get_method($method_name);    
529     
530     do { 
531         $self->remove_package_symbol("&${method_name}");
532         delete $self->get_method_map->{$method_name};
533     } if defined $removed_method;
534         
535     return $removed_method;
536 }
537
538 sub get_method_list {
539     my $self = shift;
540     keys %{$self->get_method_map};
541 }
542
543 sub find_method_by_name {
544     my ($self, $method_name) = @_;
545     (defined $method_name && $method_name)
546         || confess "You must define a method name to find"; 
547     # keep a record of what we have seen
548     # here, this will handle all the 
549     # inheritence issues because we are 
550     # using the &class_precedence_list
551     my %seen_class;
552     my @cpl = $self->class_precedence_list();
553     foreach my $class (@cpl) {
554         next if $seen_class{$class};
555         $seen_class{$class}++;
556         # fetch the meta-class ...
557         my $meta = $self->initialize($class);
558         return $meta->get_method($method_name) 
559             if $meta->has_method($method_name);
560     }
561     return;
562 }
563
564 sub compute_all_applicable_methods {
565     my $self = shift;
566     my @methods;
567     # keep a record of what we have seen
568     # here, this will handle all the 
569     # inheritence issues because we are 
570     # using the &class_precedence_list
571     my (%seen_class, %seen_method);
572     foreach my $class ($self->class_precedence_list()) {
573         next if $seen_class{$class};
574         $seen_class{$class}++;
575         # fetch the meta-class ...
576         my $meta = $self->initialize($class);
577         foreach my $method_name ($meta->get_method_list()) { 
578             next if exists $seen_method{$method_name};
579             $seen_method{$method_name}++;
580             push @methods => {
581                 name  => $method_name, 
582                 class => $class,
583                 code  => $meta->get_method($method_name)
584             };
585         }
586     }
587     return @methods;
588 }
589
590 sub find_all_methods_by_name {
591     my ($self, $method_name) = @_;
592     (defined $method_name && $method_name)
593         || confess "You must define a method name to find";    
594     my @methods;
595     # keep a record of what we have seen
596     # here, this will handle all the 
597     # inheritence issues because we are 
598     # using the &class_precedence_list
599     my %seen_class;
600     foreach my $class ($self->class_precedence_list()) {
601         next if $seen_class{$class};
602         $seen_class{$class}++;
603         # fetch the meta-class ...
604         my $meta = $self->initialize($class);
605         push @methods => {
606             name  => $method_name, 
607             class => $class,
608             code  => $meta->get_method($method_name)
609         } if $meta->has_method($method_name);
610     }
611     return @methods;
612 }
613
614 sub find_next_method_by_name {
615     my ($self, $method_name) = @_;
616     (defined $method_name && $method_name)
617         || confess "You must define a method name to find"; 
618     # keep a record of what we have seen
619     # here, this will handle all the 
620     # inheritence issues because we are 
621     # using the &class_precedence_list
622     my %seen_class;
623     my @cpl = $self->class_precedence_list();
624     shift @cpl; # discard ourselves
625     foreach my $class (@cpl) {
626         next if $seen_class{$class};
627         $seen_class{$class}++;
628         # fetch the meta-class ...
629         my $meta = $self->initialize($class);
630         return $meta->get_method($method_name) 
631             if $meta->has_method($method_name);
632     }
633     return;
634 }
635
636 ## Attributes
637
638 sub add_attribute {
639     my $self      = shift;
640     # either we have an attribute object already
641     # or we need to create one from the args provided
642     my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_);
643     # make sure it is derived from the correct type though
644     ($attribute->isa('Class::MOP::Attribute'))
645         || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";    
646
647     # first we attach our new attribute
648     # because it might need certain information 
649     # about the class which it is attached to
650     $attribute->attach_to_class($self);
651     
652     # then we remove attributes of a conflicting 
653     # name here so that we can properly detach 
654     # the old attr object, and remove any 
655     # accessors it would have generated
656     $self->remove_attribute($attribute->name)
657         if $self->has_attribute($attribute->name);
658         
659     # then onto installing the new accessors
660     $attribute->install_accessors();
661     $self->get_attribute_map->{$attribute->name} = $attribute;
662 }
663
664 sub has_attribute {
665     my ($self, $attribute_name) = @_;
666     (defined $attribute_name && $attribute_name)
667         || confess "You must define an attribute name";
668     exists $self->get_attribute_map->{$attribute_name} ? 1 : 0;    
669
670
671 sub get_attribute {
672     my ($self, $attribute_name) = @_;
673     (defined $attribute_name && $attribute_name)
674         || confess "You must define an attribute name";
675     return $self->get_attribute_map->{$attribute_name} 
676     # NOTE:
677     # this will return undef anyway, so no need ...
678     #    if $self->has_attribute($attribute_name);   
679     #return; 
680
681
682 sub remove_attribute {
683     my ($self, $attribute_name) = @_;
684     (defined $attribute_name && $attribute_name)
685         || confess "You must define an attribute name";
686     my $removed_attribute = $self->get_attribute_map->{$attribute_name};    
687     return unless defined $removed_attribute;
688     delete $self->get_attribute_map->{$attribute_name};        
689     $removed_attribute->remove_accessors(); 
690     $removed_attribute->detach_from_class();
691     return $removed_attribute;
692
693
694 sub get_attribute_list {
695     my $self = shift;
696     keys %{$self->get_attribute_map};
697
698
699 sub compute_all_applicable_attributes {
700     my $self = shift;
701     my @attrs;
702     # keep a record of what we have seen
703     # here, this will handle all the 
704     # inheritence issues because we are 
705     # using the &class_precedence_list
706     my (%seen_class, %seen_attr);
707     foreach my $class ($self->class_precedence_list()) {
708         next if $seen_class{$class};
709         $seen_class{$class}++;
710         # fetch the meta-class ...
711         my $meta = $self->initialize($class);
712         foreach my $attr_name ($meta->get_attribute_list()) { 
713             next if exists $seen_attr{$attr_name};
714             $seen_attr{$attr_name}++;
715             push @attrs => $meta->get_attribute($attr_name);
716         }
717     }
718     return @attrs;    
719 }
720
721 sub find_attribute_by_name {
722     my ($self, $attr_name) = @_;
723     # keep a record of what we have seen
724     # here, this will handle all the 
725     # inheritence issues because we are 
726     # using the &class_precedence_list
727     my %seen_class;
728     foreach my $class ($self->class_precedence_list()) {
729         next if $seen_class{$class};
730         $seen_class{$class}++;
731         # fetch the meta-class ...
732         my $meta = $self->initialize($class);
733         return $meta->get_attribute($attr_name)
734             if $meta->has_attribute($attr_name);
735     }
736     return;
737 }
738
739 ## Class closing
740
741 sub is_mutable   { 1 }
742 sub is_immutable { 0 }
743
744 {
745     # NOTE:
746     # the immutable version of a 
747     # particular metaclass is 
748     # really class-level data so 
749     # we don't want to regenerate 
750     # it any more than we need to
751     my $IMMUTABLE_METACLASS;
752     sub make_immutable {
753         my ($self) = @_;
754         
755         $IMMUTABLE_METACLASS ||= Class::MOP::Immutable->new($self, {
756             read_only   => [qw/superclasses/],
757             cannot_call => [qw/
758                 add_method
759                 alias_method
760                 remove_method
761                 add_attribute
762                 remove_attribute
763                 add_package_symbol
764                 remove_package_symbol            
765             /],
766             memoize     => {
767                 class_precedence_list             => 'ARRAY',
768                 compute_all_applicable_attributes => 'ARRAY',            
769                 get_meta_instance                 => 'SCALAR',     
770                 get_method_map                    => 'SCALAR',     
771             }
772         });   
773         
774         $IMMUTABLE_METACLASS->make_metaclass_immutable(@_)     
775     }
776 }
777
778 1;
779
780 __END__
781
782 =pod
783
784 =head1 NAME 
785
786 Class::MOP::Class - Class Meta Object
787
788 =head1 SYNOPSIS
789
790   # assuming that class Foo 
791   # has been defined, you can
792   
793   # use this for introspection ...
794   
795   # add a method to Foo ...
796   Foo->meta->add_method('bar' => sub { ... })
797   
798   # get a list of all the classes searched 
799   # the method dispatcher in the correct order 
800   Foo->meta->class_precedence_list()
801   
802   # remove a method from Foo
803   Foo->meta->remove_method('bar');
804   
805   # or use this to actually create classes ...
806   
807   Class::MOP::Class->create('Bar' => (
808       version      => '0.01',
809       superclasses => [ 'Foo' ],
810       attributes => [
811           Class::MOP:::Attribute->new('$bar'),
812           Class::MOP:::Attribute->new('$baz'),          
813       ],
814       methods => {
815           calculate_bar => sub { ... },
816           construct_baz => sub { ... }          
817       }
818   ));
819
820 =head1 DESCRIPTION
821
822 This is the largest and currently most complex part of the Perl 5 
823 meta-object protocol. It controls the introspection and 
824 manipulation of Perl 5 classes (and it can create them too). The 
825 best way to understand what this module can do, is to read the 
826 documentation for each of it's methods.
827
828 =head1 METHODS
829
830 =head2 Self Introspection
831
832 =over 4
833
834 =item B<meta>
835
836 This will return a B<Class::MOP::Class> instance which is related 
837 to this class. Thereby allowing B<Class::MOP::Class> to actually 
838 introspect itself.
839
840 As with B<Class::MOP::Attribute>, B<Class::MOP> will actually 
841 bootstrap this module by installing a number of attribute meta-objects 
842 into it's metaclass. This will allow this class to reap all the benifits 
843 of the MOP when subclassing it. 
844
845 =back
846
847 =head2 Class construction
848
849 These methods will handle creating B<Class::MOP::Class> objects, 
850 which can be used to both create new classes, and analyze 
851 pre-existing classes. 
852
853 This module will internally store references to all the instances 
854 you create with these methods, so that they do not need to be 
855 created any more than nessecary. Basically, they are singletons.
856
857 =over 4
858
859 =item B<create ($package_name, 
860                 version      =E<gt> ?$version,                 
861                 authority    =E<gt> ?$authority,                                 
862                 superclasses =E<gt> ?@superclasses, 
863                 methods      =E<gt> ?%methods, 
864                 attributes   =E<gt> ?%attributes)>
865
866 This returns a B<Class::MOP::Class> object, bringing the specified 
867 C<$package_name> into existence and adding any of the C<$version>, 
868 C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to 
869 it.
870
871 =item B<create_anon_class (superclasses =E<gt> ?@superclasses, 
872                            methods      =E<gt> ?%methods, 
873                            attributes   =E<gt> ?%attributes)>
874
875 This will create an anonymous class, it works much like C<create> but 
876 it does not need a C<$package_name>. Instead it will create a suitably 
877 unique package name for you to stash things into.
878
879 On very important distinction is that anon classes are destroyed once 
880 the metaclass they are attached to goes out of scope. In the DESTROY 
881 method, the created package will be removed from the symbol table. 
882
883 It is also worth noting that any instances created with an anon-class
884 will keep a special reference to the anon-meta which will prevent the 
885 anon-class from going out of scope until all instances of it have also 
886 been destroyed. This however only works for HASH based instance types, 
887 as we use a special reserved slot (C<__MOP__>) to store this. 
888
889 =item B<initialize ($package_name, %options)>
890
891 This initializes and returns returns a B<Class::MOP::Class> object 
892 for a given a C<$package_name>.
893
894 =item B<reinitialize ($package_name, %options)>
895
896 This removes the old metaclass, and creates a new one in it's place.
897 Do B<not> use this unless you really know what you are doing, it could 
898 very easily make a very large mess of your program. 
899
900 =item B<construct_class_instance (%options)>
901
902 This will construct an instance of B<Class::MOP::Class>, it is 
903 here so that we can actually "tie the knot" for B<Class::MOP::Class> 
904 to use C<construct_instance> once all the bootstrapping is done. This 
905 method is used internally by C<initialize> and should never be called
906 from outside of that method really.
907
908 =item B<check_metaclass_compatability>
909
910 This method is called as the very last thing in the 
911 C<construct_class_instance> method. This will check that the 
912 metaclass you are creating is compatible with the metaclasses of all 
913 your ancestors. For more inforamtion about metaclass compatibility 
914 see the C<About Metaclass compatibility> section in L<Class::MOP>.
915
916 =back
917
918 =head2 Object instance construction and cloning
919
920 These methods are B<entirely optional>, it is up to you whether you want 
921 to use them or not.
922
923 =over 4
924
925 =item B<instance_metaclass>
926
927 =item B<get_meta_instance>
928
929 =item B<new_object (%params)>
930
931 This is a convience method for creating a new object of the class, and 
932 blessing it into the appropriate package as well. Ideally your class 
933 would call a C<new> this method like so:
934
935   sub MyClass::new { 
936       my ($class, %param) = @_;
937       $class->meta->new_object(%params);
938   }
939
940 Of course the ideal place for this would actually be in C<UNIVERSAL::> 
941 but that is considered bad style, so we do not do that.
942
943 =item B<construct_instance (%params)>
944
945 This method is used to construct an instace structure suitable for 
946 C<bless>-ing into your package of choice. It works in conjunction 
947 with the Attribute protocol to collect all applicable attributes.
948
949 This will construct and instance using a HASH ref as storage 
950 (currently only HASH references are supported). This will collect all 
951 the applicable attributes and layout out the fields in the HASH ref, 
952 it will then initialize them using either use the corresponding key 
953 in C<%params> or any default value or initializer found in the 
954 attribute meta-object.
955
956 =item B<clone_object ($instance, %params)>
957
958 This is a convience method for cloning an object instance, then  
959 blessing it into the appropriate package. This method will call 
960 C<clone_instance>, which performs a shallow copy of the object, 
961 see that methods documentation for more details. Ideally your 
962 class would call a C<clone> this method like so:
963
964   sub MyClass::clone {
965       my ($self, %param) = @_;
966       $self->meta->clone_object($self, %params);
967   }
968
969 Of course the ideal place for this would actually be in C<UNIVERSAL::> 
970 but that is considered bad style, so we do not do that.
971
972 =item B<clone_instance($instance, %params)>
973
974 This method is a compliment of C<construct_instance> (which means if 
975 you override C<construct_instance>, you need to override this one too), 
976 and clones the instance shallowly.
977
978 The cloned structure returned is (like with C<construct_instance>) an 
979 unC<bless>ed HASH reference, it is your responsibility to then bless 
980 this cloned structure into the right class (which C<clone_object> will
981 do for you).
982
983 As of 0.11, this method will clone the C<$instance> structure shallowly, 
984 as opposed to the deep cloning implemented in prior versions. After much 
985 thought, research and discussion, I have decided that anything but basic 
986 shallow cloning is outside the scope of the meta-object protocol. I 
987 think Yuval "nothingmuch" Kogman put it best when he said that cloning 
988 is too I<context-specific> to be part of the MOP.
989
990 =back
991
992 =head2 Informational 
993
994 These are a few predicate methods for asking information about the class.
995
996 =over 4
997
998 =item B<is_anon_class>
999
1000 This returns true if the class is a C<Class::MOP::Class> created anon class.
1001
1002 =item B<is_mutable>
1003
1004 This returns true if the class is still mutable.
1005
1006 =item B<is_immutable>
1007
1008 This returns true if the class has been made immutable.
1009
1010 =back
1011
1012 =head2 Inheritance Relationships
1013
1014 =over 4
1015
1016 =item B<superclasses (?@superclasses)>
1017
1018 This is a read-write attribute which represents the superclass 
1019 relationships of the class the B<Class::MOP::Class> instance is
1020 associated with. Basically, it can get and set the C<@ISA> for you.
1021
1022 B<NOTE:>
1023 Perl will occasionally perform some C<@ISA> and method caching, if 
1024 you decide to change your superclass relationship at runtime (which 
1025 is quite insane and very much not recommened), then you should be 
1026 aware of this and the fact that this module does not make any 
1027 attempt to address this issue.
1028
1029 =item B<class_precedence_list>
1030
1031 This computes the a list of all the class's ancestors in the same order 
1032 in which method dispatch will be done. This is similair to 
1033 what B<Class::ISA::super_path> does, but we don't remove duplicate names.
1034
1035 =back
1036
1037 =head2 Methods
1038
1039 =over 4
1040
1041 =item B<get_method_map>
1042
1043 =item B<method_metaclass>
1044
1045 =item B<add_method ($method_name, $method)>
1046
1047 This will take a C<$method_name> and CODE reference to that 
1048 C<$method> and install it into the class's package. 
1049
1050 B<NOTE>: 
1051 This does absolutely nothing special to C<$method> 
1052 other than use B<Sub::Name> to make sure it is tagged with the 
1053 correct name, and therefore show up correctly in stack traces and 
1054 such.
1055
1056 =item B<alias_method ($method_name, $method)>
1057
1058 This will take a C<$method_name> and CODE reference to that 
1059 C<$method> and alias the method into the class's package. 
1060
1061 B<NOTE>: 
1062 Unlike C<add_method>, this will B<not> try to name the 
1063 C<$method> using B<Sub::Name>, it only aliases the method in 
1064 the class's package. 
1065
1066 =item B<has_method ($method_name)>
1067
1068 This just provides a simple way to check if the class implements 
1069 a specific C<$method_name>. It will I<not> however, attempt to check 
1070 if the class inherits the method (use C<UNIVERSAL::can> for that).
1071
1072 This will correctly handle functions defined outside of the package 
1073 that use a fully qualified name (C<sub Package::name { ... }>).
1074
1075 This will correctly handle functions renamed with B<Sub::Name> and 
1076 installed using the symbol tables. However, if you are naming the 
1077 subroutine outside of the package scope, you must use the fully 
1078 qualified name, including the package name, for C<has_method> to 
1079 correctly identify it. 
1080
1081 This will attempt to correctly ignore functions imported from other 
1082 packages using B<Exporter>. It breaks down if the function imported 
1083 is an C<__ANON__> sub (such as with C<use constant>), which very well 
1084 may be a valid method being applied to the class. 
1085
1086 In short, this method cannot always be trusted to determine if the 
1087 C<$method_name> is actually a method. However, it will DWIM about 
1088 90% of the time, so it's a small trade off I think.
1089
1090 =item B<get_method ($method_name)>
1091
1092 This will return a Class::MOP::Method instance related to the specified 
1093 C<$method_name>, or return undef if that method does not exist.
1094
1095 The Class::MOP::Method is codifiable, so you can use it like a normal 
1096 CODE reference, see L<Class::MOP::Method> for more information.
1097
1098 =item B<find_method_by_name ($method_name>
1099
1100 This will return a CODE reference of the specified C<$method_name>,
1101 or return undef if that method does not exist.
1102
1103 Unlike C<get_method> this will also look in the superclasses.
1104
1105 =item B<remove_method ($method_name)>
1106
1107 This will attempt to remove a given C<$method_name> from the class. 
1108 It will return the CODE reference that it has removed, and will 
1109 attempt to use B<Sub::Name> to clear the methods associated name.
1110
1111 =item B<get_method_list>
1112
1113 This will return a list of method names for all I<locally> defined 
1114 methods. It does B<not> provide a list of all applicable methods, 
1115 including any inherited ones. If you want a list of all applicable 
1116 methods, use the C<compute_all_applicable_methods> method.
1117
1118 =item B<compute_all_applicable_methods>
1119
1120 This will return a list of all the methods names this class will 
1121 respond to, taking into account inheritance. The list will be a list of 
1122 HASH references, each one containing the following information; method 
1123 name, the name of the class in which the method lives and a CODE 
1124 reference for the actual method.
1125
1126 =item B<find_all_methods_by_name ($method_name)>
1127
1128 This will traverse the inheritence hierarchy and locate all methods 
1129 with a given C<$method_name>. Similar to 
1130 C<compute_all_applicable_methods> it returns a list of HASH references 
1131 with the following information; method name (which will always be the 
1132 same as C<$method_name>), the name of the class in which the method 
1133 lives and a CODE reference for the actual method.
1134
1135 The list of methods produced is a distinct list, meaning there are no 
1136 duplicates in it. This is especially useful for things like object 
1137 initialization and destruction where you only want the method called 
1138 once, and in the correct order.
1139
1140 =item B<find_next_method_by_name ($method_name)>
1141
1142 This will return the first method to match a given C<$method_name> in 
1143 the superclasses, this is basically equivalent to calling 
1144 C<SUPER::$method_name>, but it can be dispatched at runtime.
1145
1146 =back
1147
1148 =head2 Method Modifiers
1149
1150 Method modifiers are a concept borrowed from CLOS, in which a method 
1151 can be wrapped with I<before>, I<after> and I<around> method modifiers 
1152 that will be called everytime the method is called. 
1153
1154 =head3 How method modifiers work?
1155
1156 Method modifiers work by wrapping the original method and then replacing 
1157 it in the classes symbol table. The wrappers will handle calling all the 
1158 modifiers in the appropariate orders and preserving the calling context 
1159 for the original method. 
1160
1161 Each method modifier serves a particular purpose, which may not be 
1162 obvious to users of other method wrapping modules. To start with, the 
1163 return values of I<before> and I<after> modifiers are ignored. This is 
1164 because thier purpose is B<not> to filter the input and output of the 
1165 primary method (this is done with an I<around> modifier). This may seem 
1166 like an odd restriction to some, but doing this allows for simple code 
1167 to be added at the begining or end of a method call without jeapordizing 
1168 the normal functioning of the primary method or placing any extra 
1169 responsibility on the code of the modifier. Of course if you have more 
1170 complex needs, then use the I<around> modifier, which uses a variation 
1171 of continutation passing style to allow for a high degree of flexibility. 
1172
1173 Before and around modifiers are called in last-defined-first-called order, 
1174 while after modifiers are called in first-defined-first-called order. So 
1175 the call tree might looks something like this:
1176   
1177   before 2
1178    before 1
1179     around 2
1180      around 1
1181       primary
1182      after 1
1183     after 2
1184
1185 To see examples of using method modifiers, see the following examples 
1186 included in the distribution; F<InstanceCountingClass>, F<Perl6Attribute>, 
1187 F<AttributesWithHistory> and F<C3MethodDispatchOrder>. There is also a 
1188 classic CLOS usage example in the test F<017_add_method_modifier.t>.
1189
1190 =head3 What is the performance impact?
1191
1192 Of course there is a performance cost associated with method modifiers, 
1193 but we have made every effort to make that cost be directly proportional 
1194 to the amount of modifier features you utilize.
1195
1196 The wrapping method does it's best to B<only> do as much work as it 
1197 absolutely needs to. In order to do this we have moved some of the 
1198 performance costs to set-up time, where they are easier to amortize.
1199
1200 All this said, my benchmarks have indicated the following:
1201
1202   simple wrapper with no modifiers             100% slower
1203   simple wrapper with simple before modifier   400% slower
1204   simple wrapper with simple after modifier    450% slower
1205   simple wrapper with simple around modifier   500-550% slower
1206   simple wrapper with all 3 modifiers          1100% slower
1207
1208 These numbers may seem daunting, but you must remember, every feature 
1209 comes with some cost. To put things in perspective, just doing a simple 
1210 C<AUTOLOAD> which does nothing but extract the name of the method called
1211 and return it costs about 400% over a normal method call. 
1212
1213 =over 4
1214
1215 =item B<add_before_method_modifier ($method_name, $code)>
1216
1217 This will wrap the method at C<$method_name> and the supplied C<$code> 
1218 will be passed the C<@_> arguments, and called before the original 
1219 method is called. As specified above, the return value of the I<before> 
1220 method modifiers is ignored, and it's ability to modify C<@_> is 
1221 fairly limited. If you need to do either of these things, use an 
1222 C<around> method modifier.
1223
1224 =item B<add_after_method_modifier ($method_name, $code)>
1225
1226 This will wrap the method at C<$method_name> so that the original 
1227 method will be called, it's return values stashed, and then the 
1228 supplied C<$code> will be passed the C<@_> arguments, and called.
1229 As specified above, the return value of the I<after> method 
1230 modifiers is ignored, and it cannot modify the return values of 
1231 the original method. If you need to do either of these things, use an 
1232 C<around> method modifier.
1233
1234 =item B<add_around_method_modifier ($method_name, $code)>
1235
1236 This will wrap the method at C<$method_name> so that C<$code> 
1237 will be called and passed the original method as an extra argument 
1238 at the begining of the C<@_> argument list. This is a variation of 
1239 continuation passing style, where the function prepended to C<@_> 
1240 can be considered a continuation. It is up to C<$code> if it calls 
1241 the original method or not, there is no restriction on what the 
1242 C<$code> can or cannot do.
1243
1244 =back
1245
1246 =head2 Attributes
1247
1248 It should be noted that since there is no one consistent way to define 
1249 the attributes of a class in Perl 5. These methods can only work with 
1250 the information given, and can not easily discover information on 
1251 their own. See L<Class::MOP::Attribute> for more details.
1252
1253 =over 4
1254
1255 =item B<attribute_metaclass>
1256
1257 =item B<get_attribute_map>
1258
1259 =item B<add_attribute ($attribute_meta_object | $attribute_name, %attribute_spec)>
1260
1261 This stores the C<$attribute_meta_object> (or creates one from the
1262 C<$attribute_name> and C<%attribute_spec>) in the B<Class::MOP::Class> 
1263 instance associated with the given class. Unlike methods, attributes 
1264 within the MOP are stored as meta-information only. They will be used 
1265 later to construct instances from (see C<construct_instance> above).
1266 More details about the attribute meta-objects can be found in the 
1267 L<Class::MOP::Attribute> or the L<Class::MOP/The Attribute protocol>
1268 section.
1269
1270 It should be noted that any accessor, reader/writer or predicate 
1271 methods which the C<$attribute_meta_object> has will be installed 
1272 into the class at this time.
1273
1274 B<NOTE>
1275 If an attribute already exists for C<$attribute_name>, the old one 
1276 will be removed (as well as removing all it's accessors), and then 
1277 the new one added.
1278
1279 =item B<has_attribute ($attribute_name)>
1280
1281 Checks to see if this class has an attribute by the name of 
1282 C<$attribute_name> and returns a boolean.
1283
1284 =item B<get_attribute ($attribute_name)>
1285
1286 Returns the attribute meta-object associated with C<$attribute_name>, 
1287 if none is found, it will return undef. 
1288
1289 =item B<remove_attribute ($attribute_name)>
1290
1291 This will remove the attribute meta-object stored at 
1292 C<$attribute_name>, then return the removed attribute meta-object. 
1293
1294 B<NOTE:> 
1295 Removing an attribute will only affect future instances of 
1296 the class, it will not make any attempt to remove the attribute from 
1297 any existing instances of the class.
1298
1299 It should be noted that any accessor, reader/writer or predicate 
1300 methods which the attribute meta-object stored at C<$attribute_name> 
1301 has will be removed from the class at this time. This B<will> make 
1302 these attributes somewhat inaccessable in previously created 
1303 instances. But if you are crazy enough to do this at runtime, then 
1304 you are crazy enough to deal with something like this :).
1305
1306 =item B<get_attribute_list>
1307
1308 This returns a list of attribute names which are defined in the local 
1309 class. If you want a list of all applicable attributes for a class, 
1310 use the C<compute_all_applicable_attributes> method.
1311
1312 =item B<compute_all_applicable_attributes>
1313
1314 This will traverse the inheritance heirachy and return a list of all 
1315 the applicable attributes for this class. It does not construct a 
1316 HASH reference like C<compute_all_applicable_methods> because all 
1317 that same information is discoverable through the attribute 
1318 meta-object itself.
1319
1320 =item B<find_attribute_by_name ($attr_name)>
1321
1322 This method will traverse the inheritance heirachy and find the 
1323 first attribute whose name matches C<$attr_name>, then return it. 
1324 It will return undef if nothing is found.
1325
1326 =back
1327
1328 =head2 Class Immutability
1329
1330 =over 4
1331
1332 =item B<make_immutable (%options)>
1333
1334 This method will invoke a tranforamtion upon the class which will 
1335 make it immutable. Details of this transformation can be found in 
1336 the L<Class::MOP::Immutable> documentation.
1337
1338 =back
1339
1340 =head1 AUTHORS
1341
1342 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1343
1344 =head1 COPYRIGHT AND LICENSE
1345
1346 Copyright 2006, 2007 by Infinity Interactive, Inc.
1347
1348 L<http://www.iinteractive.com>
1349
1350 This library is free software; you can redistribute it and/or modify
1351 it under the same terms as Perl itself. 
1352
1353 =cut