Make sure we always local-ize $@ and $SIG{__DIE__} for code evals.
[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.86';
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 ( !defined $current_name || $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 {
859         local $@;
860         local $SIG{__DIE__};
861         eval { $attribute->install_accessors() };
862         $@;
863     };
864     if ( $e ) {
865         $self->remove_attribute($attribute->name);
866         die $e;
867     }
868
869     return $attribute;
870 }
871
872 sub update_meta_instance_dependencies {
873     my $self = shift;
874
875     if ( $self->{meta_instance_dependencies} ) {
876         return $self->add_meta_instance_dependencies;
877     }
878 }
879
880 sub add_meta_instance_dependencies {
881     my $self = shift;
882
883     $self->remove_meta_instance_dependencies;
884
885     my @attrs = $self->get_all_attributes();
886
887     my %seen;
888     my @classes = grep { not $seen{$_->name}++ } map { $_->associated_class } @attrs;
889
890     foreach my $class ( @classes ) { 
891         $class->add_dependent_meta_instance($self);
892     }
893
894     $self->{meta_instance_dependencies} = \@classes;
895 }
896
897 sub remove_meta_instance_dependencies {
898     my $self = shift;
899
900     if ( my $classes = delete $self->{meta_instance_dependencies} ) {
901         foreach my $class ( @$classes ) {
902             $class->remove_dependent_meta_instance($self);
903         }
904
905         return $classes;
906     }
907
908     return;
909
910 }
911
912 sub add_dependent_meta_instance {
913     my ( $self, $metaclass ) = @_;
914     push @{ $self->{dependent_meta_instances} }, $metaclass;
915 }
916
917 sub remove_dependent_meta_instance {
918     my ( $self, $metaclass ) = @_;
919     my $name = $metaclass->name;
920     @$_ = grep { $_->name ne $name } @$_ for $self->{dependent_meta_instances};
921 }
922
923 sub invalidate_meta_instances {
924     my $self = shift;
925     $_->invalidate_meta_instance() for $self, @{ $self->{dependent_meta_instances} };
926 }
927
928 sub invalidate_meta_instance {
929     my $self = shift;
930     undef $self->{_meta_instance};
931 }
932
933 sub has_attribute {
934     my ($self, $attribute_name) = @_;
935     (defined $attribute_name && $attribute_name)
936         || confess "You must define an attribute name";
937     exists $self->get_attribute_map->{$attribute_name};
938 }
939
940 sub get_attribute {
941     my ($self, $attribute_name) = @_;
942     (defined $attribute_name && $attribute_name)
943         || confess "You must define an attribute name";
944     return $self->get_attribute_map->{$attribute_name}
945     # NOTE:
946     # this will return undef anyway, so no need ...
947     #    if $self->has_attribute($attribute_name);
948     #return;
949 }
950
951 sub remove_attribute {
952     my ($self, $attribute_name) = @_;
953     (defined $attribute_name && $attribute_name)
954         || confess "You must define an attribute name";
955     my $removed_attribute = $self->get_attribute_map->{$attribute_name};
956     return unless defined $removed_attribute;
957     delete $self->get_attribute_map->{$attribute_name};
958     $self->invalidate_meta_instances();
959     $removed_attribute->remove_accessors();
960     $removed_attribute->detach_from_class();
961     return $removed_attribute;
962 }
963
964 sub get_attribute_list {
965     my $self = shift;
966     keys %{$self->get_attribute_map};
967 }
968
969 sub get_all_attributes {
970     my $self = shift;
971     my %attrs = map { %{ $self->initialize($_)->get_attribute_map } } reverse $self->linearized_isa;
972     return values %attrs;
973 }
974
975 sub compute_all_applicable_attributes {
976     Carp::cluck('The compute_all_applicable_attributes method has been deprecated.'
977         . " Use get_all_attributes instead.\n");
978
979     shift->get_all_attributes(@_);
980 }
981
982 sub find_attribute_by_name {
983     my ($self, $attr_name) = @_;
984     foreach my $class ($self->linearized_isa) {
985         # fetch the meta-class ...
986         my $meta = $self->initialize($class);
987         return $meta->get_attribute($attr_name)
988             if $meta->has_attribute($attr_name);
989     }
990     return;
991 }
992
993 # check if we can reinitialize
994 sub is_pristine {
995     my $self = shift;
996
997     # if any local attr is defined
998     return if $self->get_attribute_list;
999
1000     # or any non-declared methods
1001     if ( my @methods = values %{ $self->get_method_map } ) {
1002         my $metaclass = $self->method_metaclass;
1003         foreach my $method ( @methods ) {
1004             return if $method->isa("Class::MOP::Method::Generated");
1005             # FIXME do we need to enforce this too? return unless $method->isa($metaclass);
1006         }
1007     }
1008
1009     return 1;
1010 }
1011
1012 ## Class closing
1013
1014 sub is_mutable   { 1 }
1015 sub is_immutable { 0 }
1016
1017 sub _immutable_options {
1018     my ( $self, @args ) = @_;
1019
1020     return (
1021         inline_accessors   => 1,
1022         inline_constructor => 1,
1023         inline_destructor  => 0,
1024         debug              => 0,
1025         immutable_trait    => $self->immutable_trait,
1026         constructor_name   => $self->constructor_name,
1027         constructor_class  => $self->constructor_class,
1028         destructor_class   => $self->destructor_class,
1029         @args,
1030     );
1031 }
1032
1033 sub make_immutable {
1034     my ( $self, @args ) = @_;
1035
1036     if ( $self->is_mutable ) {
1037         $self->_initialize_immutable( $self->_immutable_options(@args) );
1038         $self->_rebless_as_immutable(@args);
1039         return $self;
1040     }
1041     else {
1042         return;
1043     }
1044 }
1045
1046 sub make_mutable {
1047     my $self = shift;
1048
1049     if ( $self->is_immutable ) {
1050         my @args = $self->immutable_options;
1051         $self->_rebless_as_mutable();
1052         $self->_remove_inlined_code(@args);
1053         delete $self->{__immutable};
1054         return $self;
1055     }
1056     else {
1057         return;
1058     }
1059 }
1060
1061 sub _rebless_as_immutable {
1062     my ( $self, @args ) = @_;
1063
1064     $self->{__immutable}{original_class} = ref $self;
1065
1066     bless $self => $self->_immutable_metaclass(@args);
1067 }
1068
1069 sub _immutable_metaclass {
1070     my ( $self, %args ) = @_;
1071
1072     if ( my $class = $args{immutable_metaclass} ) {
1073         return $class;
1074     }
1075
1076     my $trait = $args{immutable_trait} = $self->immutable_trait
1077         || confess "no immutable trait specified for $self";
1078
1079     my $meta_attr = $self->meta->find_attribute_by_name("immutable_trait");
1080
1081     my $class_name;
1082
1083     if ( $meta_attr and $trait eq $meta_attr->default ) {
1084         # if the trait is the same as the default we try and pick a
1085         # predictable name for the immutable metaclass
1086         $class_name = 'Class::MOP::Class::Immutable::' . ref($self);
1087     }
1088     else {
1089         $class_name = join '::', 'Class::MOP::Class::Immutable::CustomTrait',
1090             $trait, 'ForMetaClass', ref($self);
1091     }
1092
1093     if ( Class::MOP::is_class_loaded($class_name) ) {
1094         if ( $class_name->isa($trait) ) {
1095             return $class_name;
1096         }
1097         else {
1098             confess
1099                 "$class_name is already defined but does not inherit $trait";
1100         }
1101     }
1102     else {
1103         my @super = ( $trait, ref($self) );
1104
1105         my $meta = Class::MOP::Class->initialize($class_name);
1106         $meta->superclasses(@super);
1107
1108         $meta->make_immutable;
1109
1110         return $class_name;
1111     }
1112 }
1113
1114 sub _remove_inlined_code {
1115     my $self = shift;
1116
1117     $self->remove_method( $_->name ) for $self->_inlined_methods;
1118
1119     delete $self->{__immutable}{inlined_methods};
1120 }
1121
1122 sub _inlined_methods { @{ $_[0]{__immutable}{inlined_methods} || [] } }
1123
1124 sub _add_inlined_method {
1125     my ( $self, $method ) = @_;
1126
1127     push @{ $self->{__immutable}{inlined_methods} ||= [] }, $method;
1128 }
1129
1130 sub _initialize_immutable {
1131     my ( $self, %args ) = @_;
1132
1133     $self->{__immutable}{options} = \%args;
1134     $self->_install_inlined_code(%args);
1135 }
1136
1137 sub _install_inlined_code {
1138     my ( $self, %args ) = @_;
1139
1140     # FIXME
1141     $self->_inline_accessors(%args)   if $args{inline_accessors};
1142     $self->_inline_constructor(%args) if $args{inline_constructor};
1143     $self->_inline_destructor(%args)  if $args{inline_destructor};
1144 }
1145
1146 sub _rebless_as_mutable {
1147     my $self = shift;
1148
1149     bless $self, $self->get_mutable_metaclass_name;
1150
1151     return $self;
1152 }
1153
1154 sub _inline_accessors {
1155     my $self = shift;
1156
1157     foreach my $attr_name ( $self->get_attribute_list ) {
1158         $self->get_attribute($attr_name)->install_accessors(1);
1159     }
1160 }
1161
1162 sub _inline_constructor {
1163     my ( $self, %args ) = @_;
1164
1165     my $name = $args{constructor_name};
1166
1167     if ( $self->has_method($name) && !$args{replace_constructor} ) {
1168         my $class = $self->name;
1169         warn "Not inlining a constructor for $class since it defines"
1170             . " its own constructor.\n"
1171             . "If you are certain you don't need to inline your"
1172             . " constructor, specify inline_constructor => 0 in your"
1173             . " call to $class->meta->make_immutable\n";
1174         return;
1175     }
1176
1177     my $constructor_class = $args{constructor_class};
1178
1179     Class::MOP::load_class($constructor_class);
1180
1181     my $constructor = $constructor_class->new(
1182         options      => \%args,
1183         metaclass    => $self,
1184         is_inline    => 1,
1185         package_name => $self->name,
1186         name         => $name,
1187     );
1188
1189     if ( $args{replace_constructor} or $constructor->can_be_inlined ) {
1190         $self->add_method( $name => $constructor );
1191         $self->_add_inlined_method($constructor);
1192     }
1193 }
1194
1195 sub _inline_destructor {
1196     my ( $self, %args ) = @_;
1197
1198     ( exists $args{destructor_class} && defined $args{destructor_class} )
1199         || confess "The 'inline_destructor' option is present, but "
1200         . "no destructor class was specified";
1201
1202     if ( $self->has_method('DESTROY') && ! $args{replace_destructor} ) {
1203         my $class = $self->name;
1204         warn "Not inlining a destructor for $class since it defines"
1205             . " its own destructor.\n";
1206         return;
1207     }
1208
1209     my $destructor_class = $args{destructor_class};
1210
1211     Class::MOP::load_class($destructor_class);
1212
1213     return unless $destructor_class->is_needed($self);
1214
1215     my $destructor = $destructor_class->new(
1216         options      => \%args,
1217         metaclass    => $self,
1218         package_name => $self->name,
1219         name         => 'DESTROY'
1220     );
1221
1222     if ( $args{replace_destructor} or $destructor->can_be_inlined ) {
1223         $self->add_method( 'DESTROY' => $destructor );
1224         $self->_add_inlined_method($destructor);
1225     }
1226 }
1227
1228 1;
1229
1230 __END__
1231
1232 =pod
1233
1234 =head1 NAME
1235
1236 Class::MOP::Class - Class Meta Object
1237
1238 =head1 SYNOPSIS
1239
1240   # assuming that class Foo
1241   # has been defined, you can
1242
1243   # use this for introspection ...
1244
1245   # add a method to Foo ...
1246   Foo->meta->add_method( 'bar' => sub {...} )
1247
1248   # get a list of all the classes searched
1249   # the method dispatcher in the correct order
1250   Foo->meta->class_precedence_list()
1251
1252   # remove a method from Foo
1253   Foo->meta->remove_method('bar');
1254
1255   # or use this to actually create classes ...
1256
1257   Class::MOP::Class->create(
1258       'Bar' => (
1259           version      => '0.01',
1260           superclasses => ['Foo'],
1261           attributes   => [
1262               Class::MOP::Attribute->new('$bar'),
1263               Class::MOP::Attribute->new('$baz'),
1264           ],
1265           methods => {
1266               calculate_bar => sub {...},
1267               construct_baz => sub {...}
1268           }
1269       )
1270   );
1271
1272 =head1 DESCRIPTION
1273
1274 The Class Protocol is the largest and most complex part of the
1275 Class::MOP meta-object protocol. It controls the introspection and
1276 manipulation of Perl 5 classes, and it can create them as well. The
1277 best way to understand what this module can do, is to read the
1278 documentation for each of its methods.
1279
1280 =head1 INHERITANCE
1281
1282 C<Class::MOP::Class> is a subclass of L<Class::MOP::Module>.
1283
1284 =head1 METHODS
1285
1286 =head2 Class construction
1287
1288 These methods all create new C<Class::MOP::Class> objects. These
1289 objects can represent existing classes, or they can be used to create
1290 new classes from scratch.
1291
1292 The metaclass object for a given class is a singleton. If you attempt
1293 to create a metaclass for the same class twice, you will just get the
1294 existing object.
1295
1296 =over 4
1297
1298 =item B<< Class::MOP::Class->create($package_name, %options) >>
1299
1300 This method creates a new C<Class::MOP::Class> object with the given
1301 package name. It accepts a number of options.
1302
1303 =over 8
1304
1305 =item * version
1306
1307 An optional version number for the newly created package.
1308
1309 =item * authority
1310
1311 An optional authority for the newly created package.
1312
1313 =item * superclasses
1314
1315 An optional array reference of superclass names.
1316
1317 =item * methods
1318
1319 An optional hash reference of methods for the class. The keys of the
1320 hash reference are method names, and values are subroutine references.
1321
1322 =item * attributes
1323
1324 An optional array reference of attributes.
1325
1326 An attribute can be passed as an existing L<Class::MOP::Attribute>
1327 object, I<or> or as a hash reference of options which will be passed
1328 to the attribute metaclass's constructor.
1329
1330 =back
1331
1332 =item B<< Class::MOP::Class->create_anon_class(%options) >>
1333
1334 This method works just like C<< Class::MOP::Class->create >> but it
1335 creates an "anonymous" class. In fact, the class does have a name, but
1336 that name is a unique name generated internally by this module.
1337
1338 It accepts the same C<superclasses>, C<methods>, and C<attributes>
1339 parameters that C<create> accepts.
1340
1341 Anonymous classes are destroyed once the metaclass they are attached
1342 to goes out of scope, and will be removed from Perl's internal symbol
1343 table.
1344
1345 All instances of an anonymous class keep a special reference to the
1346 metaclass object, which prevents the metaclass from going out of scope
1347 while any instances exist.
1348
1349 This only works if the instance if based on a hash reference, however.
1350
1351 =item B<< Class::MOP::Class->initialize($package_name, %options) >>
1352
1353 This method will initialize a C<Class::MOP::Class> object for the
1354 named package. Unlike C<create>, this method I<will not> create a new
1355 class.
1356
1357 The purpose of this method is to retrieve a C<Class::MOP::Class>
1358 object for introspecting an existing class.
1359
1360 If an existing C<Class::MOP::Class> object exists for the named
1361 package, it will be returned, and any options provided will be
1362 ignored!
1363
1364 If the object does not yet exist, it will be created.
1365
1366 The valid options that can be passed to this method are
1367 C<attribute_metaclass>, C<method_metaclass>,
1368 C<wrapped_method_metaclass>, and C<instance_metaclass>. These are all
1369 optional, and default to the appropriate class in the C<Class::MOP>
1370 distribution.
1371
1372 =back
1373
1374 =head2 Object instance construction and cloning
1375
1376 These methods are all related to creating and/or cloning object
1377 instances.
1378
1379 =over 4
1380
1381 =item B<< $metaclass->clone_object($instance, %params) >>
1382
1383 This method clones an existing object instance. Any parameters you
1384 provide are will override existing attribute values in the object.
1385
1386 This is a convenience method for cloning an object instance, then
1387 blessing it into the appropriate package.
1388
1389 You could implement a clone method in your class, using this method:
1390
1391   sub clone {
1392       my ($self, %params) = @_;
1393       $self->meta->clone_object($self, %params);
1394   }
1395
1396 =item B<< $metaclass->rebless_instance($instance, %params) >>
1397
1398 This method changes the class of C<$instance> to the metaclass's class.
1399
1400 You can only rebless an instance into a subclass of its current
1401 class. If you pass any additional parameters, these will be treated
1402 like constructor parameters and used to initialize the object's
1403 attributes. Any existing attributes that are already set will be
1404 overwritten.
1405
1406 Before reblessing the instance, this method will call
1407 C<rebless_instance_away> on the instance's current metaclass. This method
1408 will be passed the instance, the new metaclass, and any parameters
1409 specified to C<rebless_instance>. By default, C<rebless_instance_away>
1410 does nothing; it is merely a hook.
1411
1412 =item B<< $metaclass->new_object(%params) >>
1413
1414 This method is used to create a new object of the metaclass's
1415 class. Any parameters you provide are used to initialize the
1416 instance's attributes.
1417
1418 =item B<< $metaclass->instance_metaclass >>
1419
1420 Returns the class name of the instance metaclass, see
1421 L<Class::MOP::Instance> for more information on the instance
1422 metaclass.
1423
1424 =item B<< $metaclass->get_meta_instance >>
1425
1426 Returns an instance of the C<instance_metaclass> to be used in the
1427 construction of a new instance of the class.
1428
1429 =back
1430
1431 =head2 Informational predicates
1432
1433 These are a few predicate methods for asking information about the
1434 class itself.
1435
1436 =over 4
1437
1438 =item B<< $metaclass->is_anon_class >>
1439
1440 This returns true if the class was created by calling C<<
1441 Class::MOP::Class->create_anon_class >>.
1442
1443 =item B<< $metaclass->is_mutable >>
1444
1445 This returns true if the class is still mutable.
1446
1447 =item B<< $metaclass->is_immutable >>
1448
1449 This returns true if the class has been made immutable.
1450
1451 =item B<< $metaclass->is_pristine >>
1452
1453 A class is I<not> pristine if it has non-inherited attributes or if it
1454 has any generated methods.
1455
1456 =back
1457
1458 =head2 Inheritance Relationships
1459
1460 =over 4
1461
1462 =item B<< $metaclass->superclasses(@superclasses) >>
1463
1464 This is a read-write accessor which represents the superclass
1465 relationships of the metaclass's class.
1466
1467 This is basically sugar around getting and setting C<@ISA>.
1468
1469 =item B<< $metaclass->class_precedence_list >>
1470
1471 This returns a list of all of the class's ancestor classes. The
1472 classes are returned in method dispatch order.
1473
1474 =item B<< $metaclass->linearized_isa >>
1475
1476 This returns a list based on C<class_precedence_list> but with all
1477 duplicates removed.
1478
1479 =item B<< $metaclass->subclasses >>
1480
1481 This returns a list of all subclasses for this class, even indirect
1482 subclasses.
1483
1484 =item B<< $metaclass->direct_subclasses >>
1485
1486 This returns a list of immediate subclasses for this class, which does not
1487 include indirect subclasses.
1488
1489 =back
1490
1491 =head2 Method introspection and creation
1492
1493 These methods allow you to introspect a class's methods, as well as
1494 add, remove, or change methods.
1495
1496 Determining what is truly a method in a Perl 5 class requires some
1497 heuristics (aka guessing).
1498
1499 Methods defined outside the package with a fully qualified name (C<sub
1500 Package::name { ... }>) will be included. Similarly, methods named
1501 with a fully qualified name using L<Sub::Name> are also included.
1502
1503 However, we attempt to ignore imported functions.
1504
1505 Ultimately, we are using heuristics to determine what truly is a
1506 method in a class, and these heuristics may get the wrong answer in
1507 some edge cases. However, for most "normal" cases the heuristics work
1508 correctly.
1509
1510 =over 4
1511
1512 =item B<< $metaclass->get_method($method_name) >>
1513
1514 This will return a L<Class::MOP::Method> for the specified
1515 C<$method_name>. If the class does not have the specified method, it
1516 returns C<undef>
1517
1518 =item B<< $metaclass->has_method($method_name) >>
1519
1520 Returns a boolean indicating whether or not the class defines the
1521 named method. It does not include methods inherited from parent
1522 classes.
1523
1524 =item B<< $metaclass->get_method_map >>
1525
1526 Returns a hash reference representing the methods defined in this
1527 class. The keys are method names and the values are
1528 L<Class::MOP::Method> objects.
1529
1530 =item B<< $metaclass->get_method_list >>
1531
1532 This will return a list of method I<names> for all methods defined in
1533 this class.
1534
1535 =item B<< $metaclass->get_all_methods >>
1536
1537 This will traverse the inheritance hierarchy and return a list of all
1538 the L<Class::MOP::Method> objects for this class and its parents.
1539
1540 =item B<< $metaclass->find_method_by_name($method_name) >>
1541
1542 This will return a L<Class::MOP::Method> for the specified
1543 C<$method_name>. If the class does not have the specified method, it
1544 returns C<undef>
1545
1546 Unlike C<get_method>, this method I<will> look for the named method in
1547 superclasses.
1548
1549 =item B<< $metaclass->get_all_method_names >>
1550
1551 This will return a list of method I<names> for all of this class's
1552 methods, including inherited methods.
1553
1554 =item B<< $metaclass->find_all_methods_by_name($method_name) >>
1555
1556 This method looks for the named method in the class and all of its
1557 parents. It returns every matching method it finds in the inheritance
1558 tree, so it returns a list of methods.
1559
1560 Each method is returned as a hash reference with three keys. The keys
1561 are C<name>, C<class>, and C<code>. The C<code> key has a
1562 L<Class::MOP::Method> object as its value.
1563
1564 The list of methods is distinct.
1565
1566 =item B<< $metaclass->find_next_method_by_name($method_name) >>
1567
1568 This method returns the first method in any superclass matching the
1569 given name. It is effectively the method that C<SUPER::$method_name>
1570 would dispatch to.
1571
1572 =item B<< $metaclass->add_method($method_name, $method) >>
1573
1574 This method takes a method name and a subroutine reference, and adds
1575 the method to the class.
1576
1577 The subroutine reference can be a L<Class::MOP::Method>, and you are
1578 strongly encouraged to pass a meta method object instead of a code
1579 reference. If you do so, that object gets stored as part of the
1580 class's method map directly. If not, the meta information will have to
1581 be recreated later, and may be incorrect.
1582
1583 If you provide a method object, this method will clone that object if
1584 the object's package name does not match the class name. This lets us
1585 track the original source of any methods added from other classes
1586 (notably Moose roles).
1587
1588 =item B<< $metaclass->remove_method($method_name) >>
1589
1590 Remove the named method from the class. This method returns the
1591 L<Class::MOP::Method> object for the method.
1592
1593 =item B<< $metaclass->method_metaclass >>
1594
1595 Returns the class name of the method metaclass, see
1596 L<Class::MOP::Method> for more information on the method metaclass.
1597
1598 =item B<< $metaclass->wrapped_method_metaclass >>
1599
1600 Returns the class name of the wrapped method metaclass, see
1601 L<Class::MOP::Method::Wrapped> for more information on the wrapped
1602 method metaclass.
1603
1604 =back
1605
1606 =head2 Attribute introspection and creation
1607
1608 Because Perl 5 does not have a core concept of attributes in classes,
1609 we can only return information about attributes which have been added
1610 via this class's methods. We cannot discover information about
1611 attributes which are defined in terms of "regular" Perl 5 methods.
1612
1613 =over 4
1614
1615 =item B<< $metaclass->get_attribute($attribute_name) >>
1616
1617 This will return a L<Class::MOP::Attribute> for the specified
1618 C<$attribute_name>. If the class does not have the specified
1619 attribute, it returns C<undef>.
1620
1621 NOTE that get_attribute does not search superclasses, for that you
1622 need to use C<find_attribute_by_name>.
1623
1624 =item B<< $metaclass->has_attribute($attribute_name) >>
1625
1626 Returns a boolean indicating whether or not the class defines the
1627 named attribute. It does not include attributes inherited from parent
1628 classes.
1629
1630 =item B<< $metaclass->get_attribute_map >>
1631
1632 Returns a hash reference representing the attributes defined in this
1633 class. The keys are attribute names and the values are
1634 L<Class::MOP::Attribute> objects.
1635
1636 =item B<< $metaclass->get_attribute_list >>
1637
1638 This will return a list of attributes I<names> for all attributes
1639 defined in this class.
1640
1641 =item B<< $metaclass->get_all_attributes >>
1642
1643 This will traverse the inheritance hierarchy and return a list of all
1644 the L<Class::MOP::Attribute> objects for this class and its parents.
1645
1646 =item B<< $metaclass->find_attribute_by_name($attribute_name) >>
1647
1648 This will return a L<Class::MOP::Attribute> for the specified
1649 C<$attribute_name>. If the class does not have the specified
1650 attribute, it returns C<undef>
1651
1652 Unlike C<get_attribute>, this attribute I<will> look for the named
1653 attribute in superclasses.
1654
1655 =item B<< $metaclass->add_attribute(...) >>
1656
1657 This method accepts either an existing L<Class::MOP::Attribute>
1658 object, or parameters suitable for passing to that class's C<new>
1659 method.
1660
1661 The attribute provided will be added to the class.
1662
1663 Any accessor methods defined by the attribute will be added to the
1664 class when the attribute is added.
1665
1666 If an attribute of the same name already exists, the old attribute
1667 will be removed first.
1668
1669 =item B<< $metaclass->remove_attribute($attribute_name) >>
1670
1671 This will remove the named attribute from the class, and
1672 L<Class::MOP::Attribute> object.
1673
1674 Removing an attribute also removes any accessor methods defined by the
1675 attribute.
1676
1677 However, note that removing an attribute will only affect I<future>
1678 object instances created for this class, not existing instances.
1679
1680 =item B<< $metaclass->attribute_metaclass >>
1681
1682 Returns the class name of the attribute metaclass for this class. By
1683 default, this is L<Class::MOP::Attribute>.  for more information on
1684
1685 =back
1686
1687 =head2 Class Immutability
1688
1689 Making a class immutable "freezes" the class definition. You can no
1690 longer call methods which alter the class, such as adding or removing
1691 methods or attributes.
1692
1693 Making a class immutable lets us optimize the class by inlining some
1694 methods, and also allows us to optimize some methods on the metaclass
1695 object itself.
1696
1697 After immutabilization, the metaclass object will cache most
1698 informational methods such as C<get_method_map> and
1699 C<get_all_attributes>. Methods which would alter the class, such as
1700 C<add_attribute>, C<add_method>, and so on will throw an error on an
1701 immutable metaclass object.
1702
1703 The immutabilization system in L<Moose> takes much greater advantage
1704 of the inlining features than Class::MOP itself does.
1705
1706 =over 4
1707
1708 =item B<< $metaclass->make_immutable(%options) >>
1709
1710 This method will create an immutable transformer and uses it to make
1711 the class and its metaclass object immutable.
1712
1713 This method accepts the following options:
1714
1715 =over 8
1716
1717 =item * inline_accessors
1718
1719 =item * inline_constructor
1720
1721 =item * inline_destructor
1722
1723 These are all booleans indicating whether the specified method(s)
1724 should be inlined.
1725
1726 By default, accessors and the constructor are inlined, but not the
1727 destructor.
1728
1729 =item * immutable_trait
1730
1731 The name of a class which will be used as a parent class for the
1732 metaclass object being made immutable. This "trait" implements the
1733 post-immutability functionlity of the metaclass (but not the
1734 transformation itself).
1735
1736 This defaults to L<Class::MOP::Class::Immutable::Trait>.
1737
1738 =item * constructor_name
1739
1740 This is the constructor method name. This defaults to "new".
1741
1742 =item * constructor_class
1743
1744 The name of the method metaclass for constructors. It will be used to
1745 generate the inlined constructor. This defaults to
1746 "Class::MOP::Method::Constructor".
1747
1748 =item * replace_constructor
1749
1750 This is a boolean indicating whether an existing constructor should be
1751 replaced when inlining a constructor. This defaults to false.
1752
1753 =item * destructor_class
1754
1755 The name of the method metaclass for destructors. It will be used to
1756 generate the inlined destructor. This defaults to
1757 "Class::MOP::Method::Denstructor".
1758
1759 =item * replace_destructor
1760
1761 This is a boolean indicating whether an existing destructor should be
1762 replaced when inlining a destructor. This defaults to false.
1763
1764 =back
1765
1766 =item B<< $metaclass->make_mutable >>
1767
1768 Calling this method reverse the immutabilization transformation.
1769
1770 =back
1771
1772 =head2 Method Modifiers
1773
1774 Method modifiers are hooks which allow a method to be wrapped with
1775 I<before>, I<after> and I<around> method modifiers. Every time a
1776 method is called, it's modifiers are also called.
1777
1778 A class can modify its own methods, as well as methods defined in
1779 parent classes.
1780
1781 =head3 How method modifiers work?
1782
1783 Method modifiers work by wrapping the original method and then
1784 replacing it in the class's symbol table. The wrappers will handle
1785 calling all the modifiers in the appropriate order and preserving the
1786 calling context for the original method.
1787
1788 The return values of C<before> and C<after> modifiers are
1789 ignored. This is because their purpose is B<not> to filter the input
1790 and output of the primary method (this is done with an I<around>
1791 modifier).
1792
1793 This may seem like an odd restriction to some, but doing this allows
1794 for simple code to be added at the beginning or end of a method call
1795 without altering the function of the wrapped method or placing any
1796 extra responsibility on the code of the modifier.
1797
1798 Of course if you have more complex needs, you can use the C<around>
1799 modifier which allows you to change both the parameters passed to the
1800 wrapped method, as well as its return value.
1801
1802 Before and around modifiers are called in last-defined-first-called
1803 order, while after modifiers are called in first-defined-first-called
1804 order. So the call tree might looks something like this:
1805
1806   before 2
1807    before 1
1808     around 2
1809      around 1
1810       primary
1811      around 1
1812     around 2
1813    after 1
1814   after 2
1815
1816 =head3 What is the performance impact?
1817
1818 Of course there is a performance cost associated with method
1819 modifiers, but we have made every effort to make that cost directly
1820 proportional to the number of modifier features you utilize.
1821
1822 The wrapping method does it's best to B<only> do as much work as it
1823 absolutely needs to. In order to do this we have moved some of the
1824 performance costs to set-up time, where they are easier to amortize.
1825
1826 All this said, our benchmarks have indicated the following:
1827
1828   simple wrapper with no modifiers             100% slower
1829   simple wrapper with simple before modifier   400% slower
1830   simple wrapper with simple after modifier    450% slower
1831   simple wrapper with simple around modifier   500-550% slower
1832   simple wrapper with all 3 modifiers          1100% slower
1833
1834 These numbers may seem daunting, but you must remember, every feature
1835 comes with some cost. To put things in perspective, just doing a
1836 simple C<AUTOLOAD> which does nothing but extract the name of the
1837 method called and return it costs about 400% over a normal method
1838 call.
1839
1840 =over 4
1841
1842 =item B<< $metaclass->add_before_method_modifier($method_name, $code) >>
1843
1844 This wraps the specified method with the supplied subroutine
1845 reference. The modifier will be called as a method itself, and will
1846 receive the same arguments as are passed to the method.
1847
1848 When the modifier exits, the wrapped method will be called.
1849
1850 The return value of the modifier will be ignored.
1851
1852 =item B<< $metaclass->add_after_method_modifier($method_name, $code) >>
1853
1854 This wraps the specified method with the supplied subroutine
1855 reference. The modifier will be called as a method itself, and will
1856 receive the same arguments as are passed to the method.
1857
1858 When the wrapped methods exits, the modifier will be called.
1859
1860 The return value of the modifier will be ignored.
1861
1862 =item B<< $metaclass->add_around_method_modifier($method_name, $code) >>
1863
1864 This wraps the specified method with the supplied subroutine
1865 reference.
1866
1867 The first argument passed to the modifier will be a subroutine
1868 reference to the wrapped method. The second argument is the object,
1869 and after that come any arguments passed when the method is called.
1870
1871 The around modifier can choose to call the original method, as well as
1872 what arguments to pass if it does so.
1873
1874 The return value of the modifier is what will be seen by the caller.
1875
1876 =back
1877
1878 =head2 Introspection
1879
1880 =over 4
1881
1882 =item B<< Class::MOP::Class->meta >>
1883
1884 This will return a L<Class::MOP::Class> instance for this class.
1885
1886 It should also be noted that L<Class::MOP> will actually bootstrap
1887 this module by installing a number of attribute meta-objects into its
1888 metaclass.
1889
1890 =back
1891
1892 =head1 AUTHORS
1893
1894 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1895
1896 =head1 COPYRIGHT AND LICENSE
1897
1898 Copyright 2006-2009 by Infinity Interactive, Inc.
1899
1900 L<http://www.iinteractive.com>
1901
1902 This library is free software; you can redistribute it and/or modify
1903 it under the same terms as Perl itself.
1904
1905 =cut