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