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