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