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