make CMOP::Class->clone_instance private
[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', 'weaken';
13
14 our $VERSION   = '0.78';
15 $VERSION = eval $VERSION;
16 our $AUTHORITY = 'cpan:STEVAN';
17
18 use base 'Class::MOP::Module';
19
20 # Creation
21
22 sub initialize {
23     my $class = shift;
24
25     my $package_name;
26     
27     if ( @_ % 2 ) {
28         $package_name = shift;
29     } else {
30         my %options = @_;
31         $package_name = $options{package};
32     }
33
34     (defined $package_name && $package_name && !ref($package_name))
35         || confess "You must pass a package name and it cannot be blessed";
36
37     return Class::MOP::get_metaclass_by_name($package_name)
38         || $class->_construct_class_instance(package => $package_name, @_);
39 }
40
41 sub construct_class_instance {
42     warn 'The construct_class_instance method has been made private.'
43         . " The public version is deprecated and will be removed in a future release.\n";
44     goto &_construct_class_instance;
45 }
46
47 # NOTE: (meta-circularity)
48 # this is a special form of &construct_instance
49 # (see below), which is used to construct class
50 # meta-object instances for any Class::MOP::*
51 # class. All other classes will use the more
52 # normal &construct_instance.
53 sub _construct_class_instance {
54     my $class        = shift;
55     my $options      = @_ == 1 ? $_[0] : {@_};
56     my $package_name = $options->{package};
57     (defined $package_name && $package_name)
58         || confess "You must pass a package name";
59     # NOTE:
60     # return the metaclass if we have it cached,
61     # and it is still defined (it has not been
62     # reaped by DESTROY yet, which can happen
63     # annoyingly enough during global destruction)
64
65     if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) {
66         return $meta;
67     }
68
69     # NOTE:
70     # we need to deal with the possibility
71     # of class immutability here, and then
72     # get the name of the class appropriately
73     $class = (ref($class)
74                     ? ($class->is_immutable
75                         ? $class->get_mutable_metaclass_name()
76                         : ref($class))
77                     : $class);
78
79     # now create the metaclass
80     my $meta;
81     if ($class eq 'Class::MOP::Class') {
82         no strict 'refs';
83         $meta = $class->_new($options)
84     }
85     else {
86         # NOTE:
87         # it is safe to use meta here because
88         # class will always be a subclass of
89         # Class::MOP::Class, which defines meta
90         $meta = $class->meta->construct_instance($options)
91     }
92
93     # and check the metaclass compatibility
94     $meta->_check_metaclass_compatibility();  
95
96     Class::MOP::store_metaclass_by_name($package_name, $meta);
97
98     # NOTE:
99     # we need to weaken any anon classes
100     # so that they can call DESTROY properly
101     Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class;
102
103     $meta;
104 }
105
106 sub _new {
107     my $class = shift;
108     my $options = @_ == 1 ? $_[0] : {@_};
109
110     bless {
111         # inherited from Class::MOP::Package
112         'package' => $options->{package},
113
114         # NOTE:
115         # since the following attributes will
116         # actually be loaded from the symbol
117         # table, and actually bypass the instance
118         # entirely, we can just leave these things
119         # listed here for reference, because they
120         # should not actually have a value associated
121         # with the slot.
122         'namespace' => \undef,
123
124         # inherited from Class::MOP::Module
125         'version'   => \undef,
126         'authority' => \undef,
127
128         # defined in Class::MOP::Class
129         'superclasses' => \undef,
130
131         'methods'             => {},
132         'attributes'          => {},
133         'attribute_metaclass' => $options->{'attribute_metaclass'}
134             || 'Class::MOP::Attribute',
135         'method_metaclass' => $options->{'method_metaclass'}
136             || 'Class::MOP::Method',
137         'wrapped_method_metaclass' => $options->{'wrapped_method_metaclass'}
138             || 'Class::MOP::Method::Wrapped',
139         'instance_metaclass' => $options->{'instance_metaclass'}
140             || 'Class::MOP::Instance',
141     }, $class;
142 }
143
144 sub reset_package_cache_flag  { (shift)->{'_package_cache_flag'} = undef } 
145 sub update_package_cache_flag {
146     my $self = shift;
147     # NOTE:
148     # we can manually update the cache number 
149     # since we are actually adding the method
150     # to our cache as well. This avoids us 
151     # having to regenerate the method_map.
152     # - SL    
153     $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name);    
154 }
155
156
157 sub check_metaclass_compatibility {
158     warn 'The check_metaclass_compatibility method has been made private.'
159         . " The public version is deprecated and will be removed in a future release.\n";
160     goto &_check_metaclass_compatibility;
161 }
162
163 sub _check_metaclass_compatibility {
164     my $self = shift;
165
166     # this is always okay ...
167     return if ref($self)                eq 'Class::MOP::Class'   &&
168               $self->instance_metaclass eq 'Class::MOP::Instance';
169
170     my @class_list = $self->linearized_isa;
171     shift @class_list; # shift off $self->name
172
173     foreach my $superclass_name (@class_list) {
174         my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name) || next;
175
176         # NOTE:
177         # we need to deal with the possibility
178         # of class immutability here, and then
179         # get the name of the class appropriately
180         my $super_meta_type
181             = $super_meta->is_immutable
182             ? $super_meta->get_mutable_metaclass_name()
183             : ref($super_meta);
184
185         ($self->isa($super_meta_type))
186             || confess $self->name . "->meta => (" . (ref($self)) . ")" .
187                        " is not compatible with the " .
188                        $superclass_name . "->meta => (" . ($super_meta_type)     . ")";
189         # NOTE:
190         # we also need to check that instance metaclasses
191         # are compatibile in the same the class.
192         ($self->instance_metaclass->isa($super_meta->instance_metaclass))
193             || confess $self->name . "->meta->instance_metaclass => (" . ($self->instance_metaclass) . ")" .
194                        " is not compatible with the " .
195                        $superclass_name . "->meta->instance_metaclass => (" . ($super_meta->instance_metaclass) . ")";
196     }
197 }
198
199 ## ANON classes
200
201 {
202     # NOTE:
203     # this should be sufficient, if you have a
204     # use case where it is not, write a test and
205     # I will change it.
206     my $ANON_CLASS_SERIAL = 0;
207
208     # NOTE:
209     # we need a sufficiently annoying prefix
210     # this should suffice for now, this is
211     # used in a couple of places below, so
212     # need to put it up here for now.
213     my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';
214
215     sub is_anon_class {
216         my $self = shift;
217         no warnings 'uninitialized';
218         $self->name =~ /^$ANON_CLASS_PREFIX/;
219     }
220
221     sub create_anon_class {
222         my ($class, %options) = @_;
223         my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
224         return $class->create($package_name, %options);
225     }
226
227     # NOTE:
228     # this will only get called for
229     # anon-classes, all other calls
230     # are assumed to occur during
231     # global destruction and so don't
232     # really need to be handled explicitly
233     sub DESTROY {
234         my $self = shift;
235
236         return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated
237
238         no warnings 'uninitialized';
239         return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
240         # Moose does a weird thing where it replaces the metaclass for
241         # class when fixing metaclass incompatibility. In that case,
242         # we don't want to clean out the namespace now. We can detect
243         # that because Moose will explicitly update the singleton
244         # cache in Class::MOP.
245         my $current_meta = Class::MOP::get_metaclass_by_name($self->name);
246         return if $current_meta ne $self;
247
248         my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
249         no strict 'refs';
250         foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
251             delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
252         }
253         delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};
254     }
255
256 }
257
258 # creating classes with MOP ...
259
260 sub create {
261     my ( $class, @args ) = @_;
262
263     unshift @args, 'package' if @args % 2 == 1;
264
265     my (%options) = @args;
266     my $package_name = $options{package};
267
268     (ref $options{superclasses} eq 'ARRAY')
269         || confess "You must pass an ARRAY ref of superclasses"
270             if exists $options{superclasses};
271             
272     (ref $options{attributes} eq 'ARRAY')
273         || confess "You must pass an ARRAY ref of attributes"
274             if exists $options{attributes};      
275             
276     (ref $options{methods} eq 'HASH')
277         || confess "You must pass a HASH ref of methods"
278             if exists $options{methods};                  
279
280     $class->SUPER::create(%options);
281
282     my (%initialize_options) = @args;
283     delete @initialize_options{qw(
284         package
285         superclasses
286         attributes
287         methods
288         version
289         authority
290     )};
291     my $meta = $class->initialize( $package_name => %initialize_options );
292
293     # FIXME totally lame
294     $meta->add_method('meta' => sub {
295         $class->initialize(ref($_[0]) || $_[0]);
296     });
297
298     $meta->superclasses(@{$options{superclasses}})
299         if exists $options{superclasses};
300     # NOTE:
301     # process attributes first, so that they can
302     # install accessors, but locally defined methods
303     # can then overwrite them. It is maybe a little odd, but
304     # I think this should be the order of things.
305     if (exists $options{attributes}) {
306         foreach my $attr (@{$options{attributes}}) {
307             $meta->add_attribute($attr);
308         }
309     }
310     if (exists $options{methods}) {
311         foreach my $method_name (keys %{$options{methods}}) {
312             $meta->add_method($method_name, $options{methods}->{$method_name});
313         }
314     }
315     return $meta;
316 }
317
318 ## Attribute readers
319
320 # NOTE:
321 # all these attribute readers will be bootstrapped
322 # away in the Class::MOP bootstrap section
323
324 sub get_attribute_map        { $_[0]->{'attributes'}                  }
325 sub attribute_metaclass      { $_[0]->{'attribute_metaclass'}         }
326 sub method_metaclass         { $_[0]->{'method_metaclass'}            }
327 sub wrapped_method_metaclass { $_[0]->{'wrapped_method_metaclass'}    }
328 sub instance_metaclass       { $_[0]->{'instance_metaclass'}          }
329
330 # Instance Construction & Cloning
331
332 sub new_object {
333     my $class = shift;
334
335     # NOTE:
336     # we need to protect the integrity of the
337     # Class::MOP::Class singletons here, so we
338     # delegate this to &construct_class_instance
339     # which will deal with the singletons
340     return $class->_construct_class_instance(@_)
341         if $class->name->isa('Class::MOP::Class');
342     return $class->construct_instance(@_);
343 }
344
345 sub construct_instance {
346     my $class = shift;
347     my $params = @_ == 1 ? $_[0] : {@_};
348     my $meta_instance = $class->get_meta_instance();
349     my $instance = $meta_instance->create_instance();
350     foreach my $attr ($class->compute_all_applicable_attributes()) {
351         $attr->initialize_instance_slot($meta_instance, $instance, $params);
352     }
353     # NOTE:
354     # this will only work for a HASH instance type
355     if ($class->is_anon_class) {
356         (Scalar::Util::reftype($instance) eq 'HASH')
357             || confess "Currently only HASH based instances are supported with instance of anon-classes";
358         # NOTE:
359         # At some point we should make this official
360         # as a reserved slot name, but right now I am
361         # going to keep it here.
362         # my $RESERVED_MOP_SLOT = '__MOP__';
363         $instance->{'__MOP__'} = $class;
364     }
365     return $instance;
366 }
367
368
369 sub get_meta_instance {
370     my $self = shift;
371     $self->{'_meta_instance'} ||= $self->_create_meta_instance();
372 }
373
374 sub create_meta_instance {
375     warn 'The create_meta_instance method has been made private.'
376         . " The public version is deprecated and will be removed in a future release.\n";
377     goto &_create_meta_instance;
378 }
379
380 sub _create_meta_instance {
381     my $self = shift;
382     
383     my $instance = $self->instance_metaclass->new(
384         associated_metaclass => $self,
385         attributes => [ $self->compute_all_applicable_attributes() ],
386     );
387
388     $self->add_meta_instance_dependencies()
389         if $instance->is_dependent_on_superclasses();
390
391     return $instance;
392 }
393
394 sub clone_object {
395     my $class    = shift;
396     my $instance = shift;
397     (blessed($instance) && $instance->isa($class->name))
398         || confess "You must pass an instance of the metaclass (" . (ref $class ? $class->name : $class) . "), not ($instance)";
399
400     # NOTE:
401     # we need to protect the integrity of the
402     # Class::MOP::Class singletons here, they
403     # should not be cloned.
404     return $instance if $instance->isa('Class::MOP::Class');
405     $class->_clone_instance($instance, @_);
406 }
407
408 sub clone_instance {
409     warn 'The clone_instance method has been made private.'
410         . " The public version is deprecated and will be removed in a future release.\n";
411     goto &_clone_instance;
412 }
413
414 sub _clone_instance {
415     my ($class, $instance, %params) = @_;
416     (blessed($instance))
417         || confess "You can only clone instances, ($instance) is not a blessed instance";
418     my $meta_instance = $class->get_meta_instance();
419     my $clone = $meta_instance->clone_instance($instance);
420     foreach my $attr ($class->compute_all_applicable_attributes()) {
421         if ( defined( my $init_arg = $attr->init_arg ) ) {
422             if (exists $params{$init_arg}) {
423                 $attr->set_value($clone, $params{$init_arg});
424             }
425         }
426     }
427     return $clone;
428 }
429
430 sub rebless_instance {
431     my ($self, $instance, %params) = @_;
432
433     my $old_metaclass;
434     if ($instance->can('meta')) {
435         ($instance->meta->isa('Class::MOP::Class'))
436             || confess 'Cannot rebless instance if ->meta is not an instance of Class::MOP::Class';
437         $old_metaclass = $instance->meta;
438     }
439     else {
440         $old_metaclass = $self->initialize(ref($instance));
441     }
442
443     my $meta_instance = $self->get_meta_instance();
444
445     $self->name->isa($old_metaclass->name)
446         || confess "You may rebless only into a subclass of (". $old_metaclass->name ."), of which (". $self->name .") isn't.";
447
448     # rebless!
449     # we use $_[1] here because of t/306_rebless_overload.t regressions on 5.8.8
450     $meta_instance->rebless_instance_structure($_[1], $self);
451
452     foreach my $attr ( $self->compute_all_applicable_attributes ) {
453         if ( $attr->has_value($instance) ) {
454             if ( defined( my $init_arg = $attr->init_arg ) ) {
455                 $params{$init_arg} = $attr->get_value($instance)
456                     unless exists $params{$init_arg};
457             } 
458             else {
459                 $attr->set_value($instance, $attr->get_value($instance));
460             }
461         }
462     }
463
464     foreach my $attr ($self->compute_all_applicable_attributes) {
465         $attr->initialize_instance_slot($meta_instance, $instance, \%params);
466     }
467     
468     $instance;
469 }
470
471 # Inheritance
472
473 sub superclasses {
474     my $self     = shift;
475     my $var_spec = { sigil => '@', type => 'ARRAY', name => 'ISA' };
476     if (@_) {
477         my @supers = @_;
478         @{$self->get_package_symbol($var_spec)} = @supers;
479
480         # NOTE:
481         # on 5.8 and below, we need to call
482         # a method to get Perl to detect
483         # a cycle in the class hierarchy
484         my $class = $self->name;
485         $class->isa($class);
486
487         # NOTE:
488         # we need to check the metaclass
489         # compatibility here so that we can
490         # be sure that the superclass is
491         # not potentially creating an issues
492         # we don't know about
493
494         $self->_check_metaclass_compatibility();
495         $self->update_meta_instance_dependencies();
496     }
497     @{$self->get_package_symbol($var_spec)};
498 }
499
500 sub subclasses {
501     my $self = shift;
502
503     my $super_class = $self->name;
504
505     if ( Class::MOP::HAVE_ISAREV() ) {
506         return @{ $super_class->mro::get_isarev() };
507     } else {
508         my @derived_classes;
509
510         my $find_derived_classes;
511         $find_derived_classes = sub {
512             my ($outer_class) = @_;
513
514             my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} };
515
516             SYMBOL:
517             for my $symbol ( keys %$symbol_table_hashref ) {
518                 next SYMBOL if $symbol !~ /\A (\w+):: \z/x;
519                 my $inner_class = $1;
520
521                 next SYMBOL if $inner_class eq 'SUPER';    # skip '*::SUPER'
522
523                 my $class =
524                 $outer_class
525                 ? "${outer_class}::$inner_class"
526                 : $inner_class;
527
528                 if ( $class->isa($super_class) and $class ne $super_class ) {
529                     push @derived_classes, $class;
530                 }
531
532                 next SYMBOL if $class eq 'main';           # skip 'main::*'
533
534                 $find_derived_classes->($class);
535             }
536         };
537
538         my $root_class = q{};
539         $find_derived_classes->($root_class);
540
541         undef $find_derived_classes;
542
543         @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes;
544
545         return @derived_classes;
546     }
547 }
548
549
550 sub linearized_isa {
551     return @{ mro::get_linear_isa( (shift)->name ) };
552 }
553
554 sub class_precedence_list {
555     my $self = shift;
556     my $name = $self->name;
557
558     unless (Class::MOP::IS_RUNNING_ON_5_10()) { 
559         # NOTE:
560         # We need to check for circular inheritance here
561         # if we are are not on 5.10, cause 5.8 detects it 
562         # late. This will do nothing if all is well, and 
563         # blow up otherwise. Yes, it's an ugly hack, better
564         # suggestions are welcome.        
565         # - SL
566         ($name || return)->isa('This is a test for circular inheritance') 
567     }
568
569     # if our mro is c3, we can 
570     # just grab the linear_isa
571     if (mro::get_mro($name) eq 'c3') {
572         return @{ mro::get_linear_isa($name) }
573     }
574     else {
575         # NOTE:
576         # we can't grab the linear_isa for dfs
577         # since it has all the duplicates 
578         # already removed.
579         return (
580             $name,
581             map {
582                 $self->initialize($_)->class_precedence_list()
583             } $self->superclasses()
584         );
585     }
586 }
587
588 ## Methods
589
590 sub wrap_method_body {
591     my ( $self, %args ) = @_;
592
593     ('CODE' eq ref $args{body})
594         || confess "Your code block must be a CODE reference";
595
596     $self->method_metaclass->wrap(
597         package_name => $self->name,
598         %args,
599     );
600 }
601
602 sub add_method {
603     my ($self, $method_name, $method) = @_;
604     (defined $method_name && $method_name)
605         || confess "You must define a method name";
606
607     my $body;
608     if (blessed($method)) {
609         $body = $method->body;
610         if ($method->package_name ne $self->name) {
611             $method = $method->clone(
612                 package_name => $self->name,
613                 name         => $method_name            
614             ) if $method->can('clone');
615         }
616     }
617     else {
618         $body = $method;
619         $method = $self->wrap_method_body( body => $body, name => $method_name );
620     }
621
622     $method->attach_to_class($self);
623
624     # This used to call get_method_map, which meant we would build all
625     # the method objects for the class just because we added one
626     # method. This is hackier, but quicker too.
627     $self->{methods}{$method_name} = $method;
628     
629     my $full_method_name = ($self->name . '::' . $method_name);    
630     $self->add_package_symbol(
631         { sigil => '&', type => 'CODE', name => $method_name }, 
632         Class::MOP::subname($full_method_name => $body)
633     );
634 }
635
636 {
637     my $fetch_and_prepare_method = sub {
638         my ($self, $method_name) = @_;
639         my $wrapped_metaclass = $self->wrapped_method_metaclass;
640         # fetch it locally
641         my $method = $self->get_method($method_name);
642         # if we dont have local ...
643         unless ($method) {
644             # try to find the next method
645             $method = $self->find_next_method_by_name($method_name);
646             # die if it does not exist
647             (defined $method)
648                 || confess "The method '$method_name' was not found in the inheritance hierarchy for " . $self->name;
649             # and now make sure to wrap it
650             # even if it is already wrapped
651             # because we need a new sub ref
652             $method = $wrapped_metaclass->wrap($method);
653         }
654         else {
655             # now make sure we wrap it properly
656             $method = $wrapped_metaclass->wrap($method)
657                 unless $method->isa($wrapped_metaclass);
658         }
659         $self->add_method($method_name => $method);
660         return $method;
661     };
662
663     sub add_before_method_modifier {
664         my ($self, $method_name, $method_modifier) = @_;
665         (defined $method_name && $method_name)
666             || confess "You must pass in a method name";
667         my $method = $fetch_and_prepare_method->($self, $method_name);
668         $method->add_before_modifier(
669             Class::MOP::subname(':before' => $method_modifier)
670         );
671     }
672
673     sub add_after_method_modifier {
674         my ($self, $method_name, $method_modifier) = @_;
675         (defined $method_name && $method_name)
676             || confess "You must pass in a method name";
677         my $method = $fetch_and_prepare_method->($self, $method_name);
678         $method->add_after_modifier(
679             Class::MOP::subname(':after' => $method_modifier)
680         );
681     }
682
683     sub add_around_method_modifier {
684         my ($self, $method_name, $method_modifier) = @_;
685         (defined $method_name && $method_name)
686             || confess "You must pass in a method name";
687         my $method = $fetch_and_prepare_method->($self, $method_name);
688         $method->add_around_modifier(
689             Class::MOP::subname(':around' => $method_modifier)
690         );
691     }
692
693     # NOTE:
694     # the methods above used to be named like this:
695     #    ${pkg}::${method}:(before|after|around)
696     # but this proved problematic when using one modifier
697     # to wrap multiple methods (something which is likely
698     # to happen pretty regularly IMO). So instead of naming
699     # it like this, I have chosen to just name them purely
700     # with their modifier names, like so:
701     #    :(before|after|around)
702     # The fact is that in a stack trace, it will be fairly
703     # evident from the context what method they are attached
704     # to, and so don't need the fully qualified name.
705 }
706
707 sub alias_method {
708     my $self = shift;
709
710     $self->add_method(@_);
711 }
712
713 sub has_method {
714     my ($self, $method_name) = @_;
715     (defined $method_name && $method_name)
716         || confess "You must define a method name";
717
718     exists $self->{methods}{$method_name} || exists $self->get_method_map->{$method_name};
719 }
720
721 sub get_method {
722     my ($self, $method_name) = @_;
723     (defined $method_name && $method_name)
724         || confess "You must define a method name";
725
726     return $self->{methods}{$method_name} || $self->get_method_map->{$method_name};
727 }
728
729 sub remove_method {
730     my ($self, $method_name) = @_;
731     (defined $method_name && $method_name)
732         || confess "You must define a method name";
733
734     my $removed_method = delete $self->get_method_map->{$method_name};
735     
736     $self->remove_package_symbol(
737         { sigil => '&', type => 'CODE', name => $method_name }
738     );
739
740     $removed_method->detach_from_class if $removed_method;
741
742     $self->update_package_cache_flag; # still valid, since we just removed the method from the map
743
744     return $removed_method;
745 }
746
747 sub get_method_list {
748     my $self = shift;
749     keys %{$self->get_method_map};
750 }
751
752 sub find_method_by_name {
753     my ($self, $method_name) = @_;
754     (defined $method_name && $method_name)
755         || confess "You must define a method name to find";
756     foreach my $class ($self->linearized_isa) {
757         # fetch the meta-class ...
758         my $meta = $self->initialize($class);
759         return $meta->get_method($method_name)
760             if $meta->has_method($method_name);
761     }
762     return;
763 }
764
765 sub get_all_methods {
766     my $self = shift;
767     my %methods = map { %{ $self->initialize($_)->get_method_map } } reverse $self->linearized_isa;
768     return values %methods;
769 }
770
771 # compatibility
772 sub compute_all_applicable_methods {
773     return map {
774         {
775             name  => $_->name,
776             class => $_->package_name,
777             code  => $_, # sigh, overloading
778         },
779     } shift->get_all_methods(@_);
780 }
781
782 sub get_all_method_names {
783     my $self = shift;
784     my %uniq;
785     grep { $uniq{$_}++ == 0 } map { $_->name } $self->get_all_methods;
786 }
787
788 sub find_all_methods_by_name {
789     my ($self, $method_name) = @_;
790     (defined $method_name && $method_name)
791         || confess "You must define a method name to find";
792     my @methods;
793     foreach my $class ($self->linearized_isa) {
794         # fetch the meta-class ...
795         my $meta = $self->initialize($class);
796         push @methods => {
797             name  => $method_name,
798             class => $class,
799             code  => $meta->get_method($method_name)
800         } if $meta->has_method($method_name);
801     }
802     return @methods;
803 }
804
805 sub find_next_method_by_name {
806     my ($self, $method_name) = @_;
807     (defined $method_name && $method_name)
808         || confess "You must define a method name to find";
809     my @cpl = $self->linearized_isa;
810     shift @cpl; # discard ourselves
811     foreach my $class (@cpl) {
812         # fetch the meta-class ...
813         my $meta = $self->initialize($class);
814         return $meta->get_method($method_name)
815             if $meta->has_method($method_name);
816     }
817     return;
818 }
819
820 ## Attributes
821
822 sub add_attribute {
823     my $self      = shift;
824     # either we have an attribute object already
825     # or we need to create one from the args provided
826     my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_);
827     # make sure it is derived from the correct type though
828     ($attribute->isa('Class::MOP::Attribute'))
829         || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";
830
831     # first we attach our new attribute
832     # because it might need certain information
833     # about the class which it is attached to
834     $attribute->attach_to_class($self);
835
836     # then we remove attributes of a conflicting
837     # name here so that we can properly detach
838     # the old attr object, and remove any
839     # accessors it would have generated
840     if ( $self->has_attribute($attribute->name) ) {
841         $self->remove_attribute($attribute->name);
842     } else {
843         $self->invalidate_meta_instances();
844     }
845
846     # then onto installing the new accessors
847     $self->get_attribute_map->{$attribute->name} = $attribute;
848
849     # invalidate package flag here
850     my $e = do { local $@; eval { $attribute->install_accessors() }; $@ };
851     if ( $e ) {
852         $self->remove_attribute($attribute->name);
853         die $e;
854     }
855
856     return $attribute;
857 }
858
859 sub update_meta_instance_dependencies {
860     my $self = shift;
861
862     if ( $self->{meta_instance_dependencies} ) {
863         return $self->add_meta_instance_dependencies;
864     }
865 }
866
867 sub add_meta_instance_dependencies {
868     my $self = shift;
869
870     $self->remove_meta_instance_dependencies;
871
872     my @attrs = $self->compute_all_applicable_attributes();
873
874     my %seen;
875     my @classes = grep { not $seen{$_->name}++ } map { $_->associated_class } @attrs;
876
877     foreach my $class ( @classes ) { 
878         $class->add_dependent_meta_instance($self);
879     }
880
881     $self->{meta_instance_dependencies} = \@classes;
882 }
883
884 sub remove_meta_instance_dependencies {
885     my $self = shift;
886
887     if ( my $classes = delete $self->{meta_instance_dependencies} ) {
888         foreach my $class ( @$classes ) {
889             $class->remove_dependent_meta_instance($self);
890         }
891
892         return $classes;
893     }
894
895     return;
896
897 }
898
899 sub add_dependent_meta_instance {
900     my ( $self, $metaclass ) = @_;
901     push @{ $self->{dependent_meta_instances} }, $metaclass;
902 }
903
904 sub remove_dependent_meta_instance {
905     my ( $self, $metaclass ) = @_;
906     my $name = $metaclass->name;
907     @$_ = grep { $_->name ne $name } @$_ for $self->{dependent_meta_instances};
908 }
909
910 sub invalidate_meta_instances {
911     my $self = shift;
912     $_->invalidate_meta_instance() for $self, @{ $self->{dependent_meta_instances} };
913 }
914
915 sub invalidate_meta_instance {
916     my $self = shift;
917     undef $self->{_meta_instance};
918 }
919
920 sub has_attribute {
921     my ($self, $attribute_name) = @_;
922     (defined $attribute_name && $attribute_name)
923         || confess "You must define an attribute name";
924     exists $self->get_attribute_map->{$attribute_name};
925 }
926
927 sub get_attribute {
928     my ($self, $attribute_name) = @_;
929     (defined $attribute_name && $attribute_name)
930         || confess "You must define an attribute name";
931     return $self->get_attribute_map->{$attribute_name}
932     # NOTE:
933     # this will return undef anyway, so no need ...
934     #    if $self->has_attribute($attribute_name);
935     #return;
936 }
937
938 sub remove_attribute {
939     my ($self, $attribute_name) = @_;
940     (defined $attribute_name && $attribute_name)
941         || confess "You must define an attribute name";
942     my $removed_attribute = $self->get_attribute_map->{$attribute_name};
943     return unless defined $removed_attribute;
944     delete $self->get_attribute_map->{$attribute_name};
945     $self->invalidate_meta_instances();
946     $removed_attribute->remove_accessors();
947     $removed_attribute->detach_from_class();
948     return $removed_attribute;
949 }
950
951 sub get_attribute_list {
952     my $self = shift;
953     keys %{$self->get_attribute_map};
954 }
955
956 sub get_all_attributes {
957     shift->compute_all_applicable_attributes(@_);
958 }
959
960 sub compute_all_applicable_attributes {
961     my $self = shift;
962     my %attrs = map { %{ $self->initialize($_)->get_attribute_map } } reverse $self->linearized_isa;
963     return values %attrs;
964 }
965
966 sub find_attribute_by_name {
967     my ($self, $attr_name) = @_;
968     foreach my $class ($self->linearized_isa) {
969         # fetch the meta-class ...
970         my $meta = $self->initialize($class);
971         return $meta->get_attribute($attr_name)
972             if $meta->has_attribute($attr_name);
973     }
974     return;
975 }
976
977 # check if we can reinitialize
978 sub is_pristine {
979     my $self = shift;
980
981     # if any local attr is defined
982     return if $self->get_attribute_list;
983
984     # or any non-declared methods
985     if ( my @methods = values %{ $self->get_method_map } ) {
986         my $metaclass = $self->method_metaclass;
987         foreach my $method ( @methods ) {
988             return if $method->isa("Class::MOP::Method::Generated");
989             # FIXME do we need to enforce this too? return unless $method->isa($metaclass);
990         }
991     }
992
993     return 1;
994 }
995
996 ## Class closing
997
998 sub is_mutable   { 1 }
999 sub is_immutable { 0 }
1000
1001 # NOTE:
1002 # Why I changed this (groditi)
1003 #  - One Metaclass may have many Classes through many Metaclass instances
1004 #  - One Metaclass should only have one Immutable Transformer instance
1005 #  - Each Class may have different Immutabilizing options
1006 #  - Therefore each Metaclass instance may have different Immutabilizing options
1007 #  - We need to store one Immutable Transformer instance per Metaclass
1008 #  - We need to store one set of Immutable Transformer options per Class
1009 #  - Upon make_mutable we may delete the Immutabilizing options
1010 #  - We could clean the immutable Transformer instance when there is no more
1011 #      immutable Classes of that type, but we can also keep it in case
1012 #      another class with this same Metaclass becomes immutable. It is a case
1013 #      of trading of storing an instance to avoid unnecessary instantiations of
1014 #      Immutable Transformers. You may view this as a memory leak, however
1015 #      Because we have few Metaclasses, in practice it seems acceptable
1016 #  - To allow Immutable Transformers instances to be cleaned up we could weaken
1017 #      the reference stored in  $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM
1018
1019 {
1020
1021     my %IMMUTABLE_TRANSFORMERS;
1022     my %IMMUTABLE_OPTIONS;
1023
1024     sub get_immutable_options {
1025         my $self = shift;
1026         return if $self->is_mutable;
1027         confess "unable to find immutabilizing options"
1028             unless exists $IMMUTABLE_OPTIONS{$self->name};
1029         my %options = %{$IMMUTABLE_OPTIONS{$self->name}};
1030         delete $options{IMMUTABLE_TRANSFORMER};
1031         return \%options;
1032     }
1033
1034     sub get_immutable_transformer {
1035         my $self = shift;
1036         if( $self->is_mutable ){
1037             return $IMMUTABLE_TRANSFORMERS{$self->name} ||= $self->create_immutable_transformer;
1038         }
1039         confess "unable to find transformer for immutable class"
1040             unless exists $IMMUTABLE_OPTIONS{$self->name};
1041         return $IMMUTABLE_OPTIONS{$self->name}->{IMMUTABLE_TRANSFORMER};
1042     }
1043
1044     sub make_immutable {
1045         my $self = shift;
1046         my %options = @_;
1047
1048         my $transformer = $self->get_immutable_transformer;
1049         $transformer->make_metaclass_immutable($self, \%options);
1050         $IMMUTABLE_OPTIONS{$self->name} =
1051             { %options,  IMMUTABLE_TRANSFORMER => $transformer };
1052
1053         if( exists $options{debug} && $options{debug} ){
1054             print STDERR "# of Metaclass options:      ", keys %IMMUTABLE_OPTIONS;
1055             print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS;
1056         }
1057
1058         1;
1059     }
1060
1061     sub make_mutable{
1062         my $self = shift;
1063         return if $self->is_mutable;
1064         my $options = delete $IMMUTABLE_OPTIONS{$self->name};
1065         confess "unable to find immutabilizing options" unless ref $options;
1066         my $transformer = delete $options->{IMMUTABLE_TRANSFORMER};
1067         $transformer->make_metaclass_mutable($self, $options);
1068         1;
1069     }
1070 }
1071
1072 sub create_immutable_transformer {
1073     my $self = shift;
1074     my $class = Class::MOP::Immutable->new($self, {
1075         read_only   => [qw/superclasses/],
1076         cannot_call => [qw/
1077            add_method
1078            alias_method
1079            remove_method
1080            add_attribute
1081            remove_attribute
1082            remove_package_symbol
1083         /],
1084         memoize     => {
1085            class_precedence_list             => 'ARRAY',
1086            linearized_isa                    => 'ARRAY', # FIXME perl 5.10 memoizes this on its own, no need?
1087            get_all_methods                   => 'ARRAY',
1088            get_all_method_names              => 'ARRAY',
1089            #get_all_attributes               => 'ARRAY', # it's an alias, no need, but maybe in the future
1090            compute_all_applicable_attributes => 'ARRAY',
1091            get_meta_instance                 => 'SCALAR',
1092            get_method_map                    => 'SCALAR',
1093         },
1094         # NOTE:
1095         # this is ugly, but so are typeglobs, 
1096         # so whattayahgonnadoboutit
1097         # - SL
1098         wrapped => { 
1099             add_package_symbol => sub {
1100                 my $original = shift;
1101                 confess "Cannot add package symbols to an immutable metaclass" 
1102                     unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol'; 
1103
1104                 # This is a workaround for a bug in 5.8.1 which thinks that
1105                 # goto $original->body
1106                 # is trying to go to a label
1107                 my $body = $original->body;
1108                 goto $body;
1109             },
1110         },
1111     });
1112     return $class;
1113 }
1114
1115 1;
1116
1117 __END__
1118
1119 =pod
1120
1121 =head1 NAME
1122
1123 Class::MOP::Class - Class Meta Object
1124
1125 =head1 SYNOPSIS
1126
1127   # assuming that class Foo
1128   # has been defined, you can
1129
1130   # use this for introspection ...
1131
1132   # add a method to Foo ...
1133   Foo->meta->add_method( 'bar' => sub {...} )
1134
1135       # get a list of all the classes searched
1136       # the method dispatcher in the correct order
1137       Foo->meta->class_precedence_list()
1138
1139       # remove a method from Foo
1140       Foo->meta->remove_method('bar');
1141
1142   # or use this to actually create classes ...
1143
1144   Class::MOP::Class->create(
1145       'Bar' => (
1146           version      => '0.01',
1147           superclasses => ['Foo'],
1148           attributes   => [
1149               Class::MOP:: : Attribute->new('$bar'),
1150               Class::MOP:: : Attribute->new('$baz'),
1151           ],
1152           methods => {
1153               calculate_bar => sub {...},
1154               construct_baz => sub {...}
1155           }
1156       )
1157   );
1158
1159 =head1 DESCRIPTION
1160
1161 This is the largest and most complex part of the Class::MOP
1162 meta-object protocol. It controls the introspection and manipulation
1163 of Perl 5 classes, and it can create them as wlel. The best way to
1164 understand what this module can do, is to read the documentation for
1165 each of its methods.
1166
1167 =head1 INHERITANCE
1168
1169 C<Class::MOP::Class> is a subclass of L<Class::MOP::Module>.
1170
1171 =head1 METHODS
1172
1173 =head2 Class construction
1174
1175 These methods all create new C<Class::MOP::Class> objects. These
1176 objects can represent existing classes, or they can be used to create
1177 new classes from scratch.
1178
1179 The metaclass object for a given class is a singleton. If you attempt
1180 to create a metaclass for the same class twice, you will just get the
1181 existing object.
1182
1183 =over 4
1184
1185 =item B<< Class::MOP::Class->create($package_name, %options) >>
1186
1187 This method creates a new C<Class::MOP::Class> object with the given
1188 package name. It accepts a number of options.
1189
1190 =over 8
1191
1192 =item * version
1193
1194 An optional version number for the newly created package.
1195
1196 =item * authority
1197
1198 An optional authority for the newly created package.
1199
1200 =item * superclasses
1201
1202 An optional array reference of superclass names.
1203
1204 =item * methods
1205
1206 An optional hash reference of methods for the class. The keys of the
1207 hash reference are method names, and values are subroutine references.
1208
1209 =item * attributes
1210
1211 An optional array reference of attributes.
1212
1213 An attribute can be passed as an existing L<Class::MOP::Attribute>
1214 object, I<or> or as a hash reference of options which will be passed
1215 to the attribute metaclass's constructor.
1216
1217 =back
1218
1219 =item B<< Class::MOP::Class->create_anon_class(%options) >>
1220
1221 This method works just like C<< Class::MOP::Class->create >> but it
1222 creates an "anonymous" class. In fact, the class does have a name, but
1223 that name is a unique name generated internally by this module.
1224
1225 It accepts the same C<superclasses>, C<methods>, and C<attributes>
1226 parameters that C<create> accepts.
1227
1228 Anonymous classes are destroyed once the metaclass they are attached
1229 to goes out of scope, and will be removed from Perl's internal symbol
1230 table.
1231
1232 All instances of an anonymous class keep a special reference to the
1233 metaclass object, which prevents the metaclass from going out of scope
1234 while any instances exist.
1235
1236 This only works if the instance if based on a hash reference, however.
1237
1238 =item B<< Class::MOP::Class->initialize($package_name, %options) >>
1239
1240 This method will initialize a C<Class::MOP::Class> object for the
1241 named package. Unlike C<create>, this method I<will not> create a new
1242 class.
1243
1244 The purpose of this method is to retrieve a C<Class::MOP::Class>
1245 object for introspecting an existing class.
1246
1247 If an existing C<Class::MOP::Class> object exists for the named
1248 package, it will be returned, and any options provided will be
1249 ignored!
1250
1251 If the object does not yet exist, it will be created.
1252
1253 The valid options that can be passed to this method are
1254 C<attribute_metaclass>, C<method_metaclass>,
1255 C<wrapped_method_metaclass>, and C<instance_metaclass>. These are all
1256 optional, and default to the appropriate class in the C<Class::MOP>
1257 distribution.
1258
1259 =back
1260
1261 =head2 Object instance construction and cloning
1262
1263 These methods are all related to creating and/or cloning object
1264 instances.
1265
1266 =over 4
1267
1268 =item B<< $metaclass->clone_object($instance, %params) >>
1269
1270 This method clones an existing object instance. Any parameters you
1271 provide are will override existing attribute values in the object.
1272
1273 This is a convience method for cloning an object instance, then
1274 blessing it into the appropriate package.
1275
1276 You could implement a clone method in your class, using this method:
1277
1278   sub clone {
1279       my ($self, %params) = @_;
1280       $self->meta->clone_object($self, %params);
1281   }
1282
1283 =item B<< $metaclass->rebless_instance($instance, %params) >>
1284
1285 This method changes the class of C<$instance> to the metaclass's class.
1286
1287 You can only rebless an instance into a subclass of its current
1288 class. If you pass any additional parameters, these will be treated
1289 like constructor parameters and used to initialize the object's
1290 attributes. Any existing attributes that are already set will be
1291 overwritten.
1292
1293 =item B<< $metaclass->new_object(%params) >>
1294
1295 This method is used to create a new object of the metaclass's
1296 class. Any parameters you provide are used to initialize the
1297 instance's attributes.
1298
1299 =item B<< $metaclass->instance_metaclass >>
1300
1301 Returns the class name of the instance metaclass, see
1302 L<Class::MOP::Instance> for more information on the instance
1303 metaclasses.
1304
1305 =item B<< $metaclass->get_meta_instance >>
1306
1307 Returns an instance of the C<instance_metaclass> to be used in the
1308 construction of a new instance of the class.
1309
1310 =back
1311
1312 =head2 Informational predicates
1313
1314 These are a few predicate methods for asking information about the
1315 class itself.
1316
1317 =over 4
1318
1319 =item B<< $metaclass->is_anon_class >>
1320
1321 This returns true if the class was created by calling C<<
1322 Class::MOP::Class->create_anon_class >>.
1323
1324 =item B<< $metaclass->is_mutable >>
1325
1326 This returns true if the class is still mutable.
1327
1328 =item B<< $metaclass->is_immutable >>
1329
1330 This returns true if the class has been made immutable.
1331
1332 =item B<< $metaclass->is_pristine >>
1333
1334 A class is I<not> pristine if it has non-inherited attributes or if it
1335 has any generated methods.
1336
1337 =back
1338
1339 =head2 Inheritance Relationships
1340
1341 =over 4
1342
1343 =item B<< $metaclass->superclasses(@superclasses) >>
1344
1345 This is a read-write accessor which represents the superclass
1346 relationships of the metaclass's class.
1347
1348 This is basically sugar around getting and setting C<@ISA>.
1349
1350 =item B<< $metaclass->class_precedence_list >>
1351
1352 This returns a list of all of the class's ancestor classes. The
1353 classes are returned in method dispatch order.
1354
1355 =item B<< $metaclass->linearized_isa >>
1356
1357 This returns a list based on C<class_precedence_list> but with all
1358 duplicates removed.
1359
1360 =item B<< $metaclass->subclasses >>
1361
1362 This returns a list of subclasses for this class.
1363
1364 =back
1365
1366 =head2 Method introspection and creation
1367
1368 These methods allow you to introspect a class's methods, as well as
1369 add, remove, or change methods.
1370
1371 Determining what is truly a method in a Perl 5 class requires some
1372 heuristics (aka guessing).
1373
1374 Methods defined outside the package with a fully qualified name (C<sub
1375 Package::name { ... }>) will be included. Similarly, methods named
1376 with a fully qualified name using L<Sub::Name> are also included.
1377
1378 However, we attempt to ignore imported functions.
1379
1380 Ultimately, we are using heuristics to determine what truly is a
1381 method in a class, and these heuristics may get the wrong answer in
1382 some edge cases. However, for most "normal" cases the heuristics work
1383 correctly.
1384
1385 =over 4
1386
1387 =item B<< $metaclass->get_method($method_name) >>
1388
1389 This will return a L<Class::MOP::Method> for the specified
1390 C<$method_name>. If the class does not have the specified method, it
1391 returns C<undef>
1392
1393 =item B<< $metaclass->has_method($method_name) >>
1394
1395 Returns a boolean indicating whether or not the class defines the
1396 named method. It does not include methods inherited from parent
1397 classes.
1398
1399 =item B<< $metaclass->get_method_map >>
1400
1401 Returns a hash reference representing the methods defined in this
1402 class. The keys are method names and the values are
1403 L<Class::MOP::Method> objects.
1404
1405 =item B<< $metaclass->get_method_list >>
1406
1407 This will return a list of method I<names> for all methods defined in
1408 this class.
1409
1410 =item B<< $metaclass->get_all_methods >>
1411
1412 This will traverse the inheritance hierarchy and return a list of all
1413 the L<Class::MOP::Method> objects for this class and its parents.
1414
1415 =item B<< $metaclass->find_method_by_name($method_name) >>
1416
1417 This will return a L<Class::MOP::Method> for the specified
1418 C<$method_name>. If the class does not have the specified method, it
1419 returns C<undef>
1420
1421 Unlike C<get_method>, this method I<will> look for the named method in
1422 superclasses.
1423
1424 =item B<< $metaclass->get_all_method_names >>
1425
1426 This will return a list of method I<names> for all of this class's
1427 methods, including inherited methods.
1428
1429 =item B<< $metaclass->find_all_methods_by_name($method_name) >>
1430
1431 This method looks for the named method in the class and all of its
1432 parents. It returns every matching method it finds in the inheritance
1433 tree, so it returns a list of methods.
1434
1435 Each method is returned as a hash reference with three keys. The keys
1436 are C<name>, C<class>, and C<code>. The C<code> key has a
1437 L<Class::MOP::Method> object as its value.
1438
1439 The list of methods is distinct.
1440
1441 =item B<< $metaclass->find_next_method_by_name($method_name) >>
1442
1443 This method returns the first method in any superclass matching the
1444 given name. It is effectively the method that C<SUPER::$method_name>
1445 would dispatch to.
1446
1447 =item B<< $metaclass->add_method($method_name, $method) >>
1448
1449 This method takes a method name and a subroutine reference, and adds
1450 the method to the class.
1451
1452 The subroutine reference can be a L<Class::MOP::Method>, and you are
1453 strongly encouraged to pass a meta method object instead of a code
1454 reference. If you do so, that object gets stored as part of the
1455 class's method map directly. If not, the meta information will have to
1456 be recreated later, and may be incorrect.
1457
1458 If you provide a method object, this method will clone that object if
1459 the object's package name does not match the class name. This lets us
1460 track the original source of any methods added from other classes
1461 (notably Moose roles).
1462
1463 =item B<< $metaclass->remove_method($method_name) >>
1464
1465 Remove the named method from the class. This method returns the
1466 L<Class::MOP::Method> object for the method.
1467
1468 =back
1469
1470 =head2 Attribute introspection and creation
1471
1472 Because Perl 5 does not have a core concept of attributes in classes,
1473 we can only return information about attributes which have been added
1474 via this class's methods. We cannot discover information about
1475 attributes which are defined in terms of "regular" Perl 5 methods.
1476
1477 =over 4
1478
1479 =item B<< $metaclass->get_attribute($attribute_name) >>
1480
1481 This will return a L<Class::MOP::Attribute> for the specified
1482 C<$attribute_name>. If the class does not have the specified
1483 attribute, it returns C<undef>
1484
1485 =item B<< $metaclass->has_attribute($attribute_name) >>
1486
1487 Returns a boolean indicating whether or not the class defines the
1488 named attribute. It does not include attributes inherited from parent
1489 classes.
1490
1491 =item B<< $metaclass->get_attribute_map >>
1492
1493 Returns a hash reference representing the attributes defined in this
1494 class. The keys are attribute names and the values are
1495 L<Class::MOP::Attribute> objects.
1496
1497 =item B<< $metaclass->get_attribute_list >>
1498
1499 This will return a list of attributes I<names> for all attributes
1500 defined in this class.
1501
1502 =item B<< $metaclass->get_all_attributes >>
1503
1504 This will traverse the inheritance hierarchy and return a list of all
1505 the L<Class::MOP::Attribute> objects for this class and its parents.
1506
1507 This method can also be called as C<compute_all_applicable_attributes>.
1508
1509 =item B<< $metaclass->find_attribute_by_name($attribute_name) >>
1510
1511 This will return a L<Class::MOP::Attribute> for the specified
1512 C<$attribute_name>. If the class does not have the specified
1513 attribute, it returns C<undef>
1514
1515 Unlike C<get_attribute>, this attribute I<will> look for the named
1516 attribute in superclasses.
1517
1518 =item B<< $metaclass->add_attribute(...) >>
1519
1520 This method accepts either an existing L<Class::MOP::Attribute>
1521 object, or parameters suitable for passing to that class's C<new>
1522 method.
1523
1524 The attribute provided will be added to the class.
1525
1526 Any accessor methods defined by the attribute will be added to the
1527 class when the attribute is added.
1528
1529 If an attribute of the same name already exists, the old attribute
1530 will be removed first.
1531
1532 =item B<< $metaclass->remove_attribute($attribute_name) >>
1533
1534 This will remove the named attribute from the class, and
1535 L<Class::MOP::Attribute> object.
1536
1537 Removing an attribute also removes any accessor methods defined by the
1538 attribute.
1539
1540 However, note that removing an attribute will only affect I<future>
1541 object instances created for this class, not existing instances.
1542
1543 =item B<< $metaclass->attribute_metaclass >>
1544
1545 Returns the class name of the attribute metaclass for this class. By
1546 default, this is L<Class::MOP::Attribute>.  for more information on
1547
1548 =back
1549
1550 =head2 Class Immutability
1551
1552 Making a class immutable "freezes" the class definition. You can no
1553 longer call methods which alter the class, such as adding or removing
1554 methods or attributes.
1555
1556 Making a class immutable lets us optimize the class by inlning some
1557 methods, and also allows us to optimize some methods on the metaclass
1558 object itself.
1559
1560 The immutabilization system in L<Moose> takes much greater advantage
1561 of the inlining features than Class::MOP itself does.
1562
1563 =over 4
1564
1565 =item B<< $metaclass->make_immutable(%options) >>
1566
1567 This method will create an immutable transformer and uses it to make
1568 the class and its metaclass object immutable.
1569
1570 Details of how immutabilization works are in L<Class::MOP::Immutable>
1571 documentation.
1572
1573 =item B<< $metaclass->make_mutable >>
1574
1575 Calling this method reverse the immutabilization transformation.
1576
1577 =item B<< $metaclass->get_immutable_transformer >>
1578
1579 If the class has been made immutable previously, this returns the
1580 L<Class::MOP::Immutable> object that was created to do the
1581 transformation.
1582
1583 If the class was never made immutable, this method will die.
1584
1585 =back
1586
1587 =head2 Method Modifiers
1588
1589 Method modifiers are hooks which allow a method to be wrapped with
1590 I<before>, I<after> and I<around> method modifiers. Every time a
1591 method is called, it's modifiers are also called.
1592
1593 A class can modify its own methods, as well as methods defined in
1594 parent classes.
1595
1596 =head3 How method modifiers work?
1597
1598 Method modifiers work by wrapping the original method and then
1599 replacing it in the class's symbol table. The wrappers will handle
1600 calling all the modifiers in the appropariate orders and preserving
1601 the calling context for the original method.
1602
1603 The return values of C<before> and C<after> modifiers are
1604 ignored. This is because their purpose is B<not> to filter the input
1605 and output of the primary method (this is done with an I<around>
1606 modifier).
1607
1608 This may seem like an odd restriction to some, but doing this allows
1609 for simple code to be added at the beginning or end of a method call
1610 without altering the function of the wrapped method or placing any
1611 extra responsibility on the code of the modifier.
1612
1613 Of course if you have more complex needs, you can use the C<around>
1614 modifier which allows you to change both the parameters passed to the
1615 wrapped method, as well as its return value.
1616
1617 Before and around modifiers are called in last-defined-first-called
1618 order, while after modifiers are called in first-defined-first-called
1619 order. So the call tree might looks something like this:
1620
1621   before 2
1622    before 1
1623     around 2
1624      around 1
1625       primary
1626      around 1
1627     around 2
1628    after 1
1629   after 2
1630
1631 =head3 What is the performance impact?
1632
1633 Of course there is a performance cost associated with method
1634 modifiers, but we have made every effort to make that cost directly
1635 proportional to the number of modifier features you utilize.
1636
1637 The wrapping method does it's best to B<only> do as much work as it
1638 absolutely needs to. In order to do this we have moved some of the
1639 performance costs to set-up time, where they are easier to amortize.
1640
1641 All this said, our benchmarks have indicated the following:
1642
1643   simple wrapper with no modifiers             100% slower
1644   simple wrapper with simple before modifier   400% slower
1645   simple wrapper with simple after modifier    450% slower
1646   simple wrapper with simple around modifier   500-550% slower
1647   simple wrapper with all 3 modifiers          1100% slower
1648
1649 These numbers may seem daunting, but you must remember, every feature
1650 comes with some cost. To put things in perspective, just doing a
1651 simple C<AUTOLOAD> which does nothing but extract the name of the
1652 method called and return it costs about 400% over a normal method
1653 call.
1654
1655 =over 4
1656
1657 =item B<< $metaclass->add_before_method_modifier($method_name, $code) >>
1658
1659 This wraps the specified method with the supplied subroutine
1660 reference. The modifier will be called as a method itself, and will
1661 receive the same arguments as are passed to the method.
1662
1663 When the modifier exits, the wrapped method will be called.
1664
1665 The return value of the modifier will be ignored.
1666
1667 =item B<< $metaclass->add_after_method_modifier($method_name, $code) >>
1668
1669 This wraps the specified method with the supplied subroutine
1670 reference. The modifier will be called as a method itself, and will
1671 receive the same arguments as are passed to the method.
1672
1673 When the wrapped methods exits, the modifier will be called.
1674
1675 The return value of the modifier will be ignored.
1676
1677 =item B<< $metaclass->add_around_method_modifier($method_name, $code) >>
1678
1679 This wraps the specified method with the supplied subroutine
1680 reference.
1681
1682 The first argument passed to the modifier will be a subroutine
1683 reference to the wrapped method. The second argument is the object,
1684 and after that come any arguments passed when the method is called.
1685
1686 The around modifier can choose to call the original method, as well as
1687 what arguments to pass if it does so.
1688
1689 The return value of the modifier is what will be seen by the caller.
1690
1691 =back
1692
1693 =head1 AUTHORS
1694
1695 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1696
1697 =head1 COPYRIGHT AND LICENSE
1698
1699 Copyright 2006-2009 by Infinity Interactive, Inc.
1700
1701 L<http://www.iinteractive.com>
1702
1703 This library is free software; you can redistribute it and/or modify
1704 it under the same terms as Perl itself.
1705
1706 =cut