attr initializer
[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.28';
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 sub get_attribute_values {
437     my ($self, $instance) = @_;
438
439     return +{
440         map { $_->name => $_->get_value($instance) }
441             grep { $_->has_value($instance) }
442                 $self->compute_all_applicable_attributes
443     };
444 }
445
446 sub get_init_args {
447     my ($self, $instance) = @_;
448
449     return +{
450         map { $_->init_arg => $_->get_value($instance) }
451             grep { $_->has_value($instance) }
452                 grep { defined($_->init_arg) } 
453                     $self->compute_all_applicable_attributes
454     };
455 }
456
457 # Inheritance
458
459 sub superclasses {
460     my $self = shift;
461     if (@_) {
462         my @supers = @_;
463         @{$self->get_package_symbol('@ISA')} = @supers;
464         # NOTE:
465         # we need to check the metaclass
466         # compatibility here so that we can
467         # be sure that the superclass is
468         # not potentially creating an issues
469         # we don't know about
470         $self->check_metaclass_compatability();
471     }
472     @{$self->get_package_symbol('@ISA')};
473 }
474
475 sub subclasses {
476     my $self = shift;
477
478     my $super_class = $self->name;
479     my @derived_classes;
480     
481     my $find_derived_classes;
482     $find_derived_classes = sub {
483         my ($outer_class) = @_;
484
485         my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} };
486
487         SYMBOL:
488         for my $symbol ( keys %$symbol_table_hashref ) {
489             next SYMBOL if $symbol !~ /\A (\w+):: \z/x;
490             my $inner_class = $1;
491
492             next SYMBOL if $inner_class eq 'SUPER';    # skip '*::SUPER'
493
494             my $class =
495               $outer_class
496               ? "${outer_class}::$inner_class"
497               : $inner_class;
498
499             if ( $class->isa($super_class) and $class ne $super_class ) {
500                 push @derived_classes, $class;
501             }
502
503             next SYMBOL if $class eq 'main';           # skip 'main::*'
504
505             $find_derived_classes->($class);
506         }
507     };
508
509     my $root_class = q{};
510     $find_derived_classes->($root_class);
511
512     undef $find_derived_classes;
513
514     @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes;
515
516     return @derived_classes;
517 }
518
519
520 sub linearized_isa {
521     if (Class::MOP::IS_RUNNING_ON_5_10()) {
522         return @{ mro::get_linear_isa( (shift)->name ) };
523     }
524     else {
525         my %seen;
526         return grep { !($seen{$_}++) } (shift)->class_precedence_list;
527     }
528 }
529
530 sub class_precedence_list {
531     my $self = shift;
532
533     unless (Class::MOP::IS_RUNNING_ON_5_10()) { 
534         # NOTE:
535         # We need to check for circular inheritance here
536         # if we are are not on 5.10, cause 5.8 detects it 
537         # late. This will do nothing if all is well, and 
538         # blow up otherwise. Yes, it's an ugly hack, better
539         # suggestions are welcome.        
540         # - SL
541         ($self->name || return)->isa('This is a test for circular inheritance') 
542     }
543
544     (
545         $self->name,
546         map {
547             $self->initialize($_)->class_precedence_list()
548         } $self->superclasses()
549     );
550 }
551
552 ## Methods
553
554 sub add_method {
555     my ($self, $method_name, $method) = @_;
556     (defined $method_name && $method_name)
557         || confess "You must define a method name";
558
559     my $body;
560     if (blessed($method)) {
561         $body = $method->body;
562     }
563     else {
564         $body = $method;
565         ('CODE' eq (reftype($body) || ''))
566             || confess "Your code block must be a CODE reference";
567         $method = $self->method_metaclass->wrap($body);
568     }
569     $self->get_method_map->{$method_name} = $method;
570
571     my $full_method_name = ($self->name . '::' . $method_name);
572     $self->add_package_symbol("&${method_name}" => subname $full_method_name => $body);
573     $self->update_package_cache_flag;    
574 }
575
576 {
577     my $fetch_and_prepare_method = sub {
578         my ($self, $method_name) = @_;
579         # fetch it locally
580         my $method = $self->get_method($method_name);
581         # if we dont have local ...
582         unless ($method) {
583             # try to find the next method
584             $method = $self->find_next_method_by_name($method_name);
585             # die if it does not exist
586             (defined $method)
587                 || confess "The method '$method_name' is not found in the inheritance hierarchy for class " . $self->name;
588             # and now make sure to wrap it
589             # even if it is already wrapped
590             # because we need a new sub ref
591             $method = Class::MOP::Method::Wrapped->wrap($method);
592         }
593         else {
594             # now make sure we wrap it properly
595             $method = Class::MOP::Method::Wrapped->wrap($method)
596                 unless $method->isa('Class::MOP::Method::Wrapped');
597         }
598         $self->add_method($method_name => $method);
599         return $method;
600     };
601
602     sub add_before_method_modifier {
603         my ($self, $method_name, $method_modifier) = @_;
604         (defined $method_name && $method_name)
605             || confess "You must pass in a method name";
606         my $method = $fetch_and_prepare_method->($self, $method_name);
607         $method->add_before_modifier(subname ':before' => $method_modifier);
608     }
609
610     sub add_after_method_modifier {
611         my ($self, $method_name, $method_modifier) = @_;
612         (defined $method_name && $method_name)
613             || confess "You must pass in a method name";
614         my $method = $fetch_and_prepare_method->($self, $method_name);
615         $method->add_after_modifier(subname ':after' => $method_modifier);
616     }
617
618     sub add_around_method_modifier {
619         my ($self, $method_name, $method_modifier) = @_;
620         (defined $method_name && $method_name)
621             || confess "You must pass in a method name";
622         my $method = $fetch_and_prepare_method->($self, $method_name);
623         $method->add_around_modifier(subname ':around' => $method_modifier);
624     }
625
626     # NOTE:
627     # the methods above used to be named like this:
628     #    ${pkg}::${method}:(before|after|around)
629     # but this proved problematic when using one modifier
630     # to wrap multiple methods (something which is likely
631     # to happen pretty regularly IMO). So instead of naming
632     # it like this, I have chosen to just name them purely
633     # with their modifier names, like so:
634     #    :(before|after|around)
635     # The fact is that in a stack trace, it will be fairly
636     # evident from the context what method they are attached
637     # to, and so don't need the fully qualified name.
638 }
639
640 sub alias_method {
641     my ($self, $method_name, $method) = @_;
642     (defined $method_name && $method_name)
643         || confess "You must define a method name";
644
645     my $body = (blessed($method) ? $method->body : $method);
646     ('CODE' eq (reftype($body) || ''))
647         || confess "Your code block must be a CODE reference";
648
649     $self->add_package_symbol("&${method_name}" => $body);
650     $self->update_package_cache_flag;     
651 }
652
653 sub has_method {
654     my ($self, $method_name) = @_;
655     (defined $method_name && $method_name)
656         || confess "You must define a method name";
657
658     return 0 unless exists $self->get_method_map->{$method_name};
659     return 1;
660 }
661
662 sub get_method {
663     my ($self, $method_name) = @_;
664     (defined $method_name && $method_name)
665         || confess "You must define a method name";
666
667     # NOTE:
668     # I don't really need this here, because
669     # if the method_map is missing a key it
670     # will just return undef for me now
671     # return unless $self->has_method($method_name);
672
673     return $self->get_method_map->{$method_name};
674 }
675
676 sub remove_method {
677     my ($self, $method_name) = @_;
678     (defined $method_name && $method_name)
679         || confess "You must define a method name";
680
681     my $removed_method = delete $self->get_method_map->{$method_name};
682     
683     $self->remove_package_symbol("&${method_name}");
684     
685     $self->update_package_cache_flag;        
686
687     return $removed_method;
688 }
689
690 sub get_method_list {
691     my $self = shift;
692     keys %{$self->get_method_map};
693 }
694
695 sub find_method_by_name {
696     my ($self, $method_name) = @_;
697     (defined $method_name && $method_name)
698         || confess "You must define a method name to find";
699     foreach my $class ($self->linearized_isa) {
700         # fetch the meta-class ...
701         my $meta = $self->initialize($class);
702         return $meta->get_method($method_name)
703             if $meta->has_method($method_name);
704     }
705     return;
706 }
707
708 sub compute_all_applicable_methods {
709     my $self = shift;
710     my (@methods, %seen_method);
711     foreach my $class ($self->linearized_isa) {
712         # fetch the meta-class ...
713         my $meta = $self->initialize($class);
714         foreach my $method_name ($meta->get_method_list()) {
715             next if exists $seen_method{$method_name};
716             $seen_method{$method_name}++;
717             push @methods => {
718                 name  => $method_name,
719                 class => $class,
720                 code  => $meta->get_method($method_name)
721             };
722         }
723     }
724     return @methods;
725 }
726
727 sub find_all_methods_by_name {
728     my ($self, $method_name) = @_;
729     (defined $method_name && $method_name)
730         || confess "You must define a method name to find";
731     my @methods;
732     foreach my $class ($self->linearized_isa) {
733         # fetch the meta-class ...
734         my $meta = $self->initialize($class);
735         push @methods => {
736             name  => $method_name,
737             class => $class,
738             code  => $meta->get_method($method_name)
739         } if $meta->has_method($method_name);
740     }
741     return @methods;
742 }
743
744 sub find_next_method_by_name {
745     my ($self, $method_name) = @_;
746     (defined $method_name && $method_name)
747         || confess "You must define a method name to find";
748     my @cpl = $self->linearized_isa;
749     shift @cpl; # discard ourselves
750     foreach my $class (@cpl) {
751         # fetch the meta-class ...
752         my $meta = $self->initialize($class);
753         return $meta->get_method($method_name)
754             if $meta->has_method($method_name);
755     }
756     return;
757 }
758
759 ## Attributes
760
761 sub add_attribute {
762     my $self      = shift;
763     # either we have an attribute object already
764     # or we need to create one from the args provided
765     my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_);
766     # make sure it is derived from the correct type though
767     ($attribute->isa('Class::MOP::Attribute'))
768         || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";
769
770     # first we attach our new attribute
771     # because it might need certain information
772     # about the class which it is attached to
773     $attribute->attach_to_class($self);
774
775     # then we remove attributes of a conflicting
776     # name here so that we can properly detach
777     # the old attr object, and remove any
778     # accessors it would have generated
779     $self->remove_attribute($attribute->name)
780         if $self->has_attribute($attribute->name);
781
782     # then onto installing the new accessors
783     $attribute->install_accessors();
784     $self->get_attribute_map->{$attribute->name} = $attribute;
785 }
786
787 sub has_attribute {
788     my ($self, $attribute_name) = @_;
789     (defined $attribute_name && $attribute_name)
790         || confess "You must define an attribute name";
791     exists $self->get_attribute_map->{$attribute_name} ? 1 : 0;
792 }
793
794 sub get_attribute {
795     my ($self, $attribute_name) = @_;
796     (defined $attribute_name && $attribute_name)
797         || confess "You must define an attribute name";
798     return $self->get_attribute_map->{$attribute_name}
799     # NOTE:
800     # this will return undef anyway, so no need ...
801     #    if $self->has_attribute($attribute_name);
802     #return;
803 }
804
805 sub remove_attribute {
806     my ($self, $attribute_name) = @_;
807     (defined $attribute_name && $attribute_name)
808         || confess "You must define an attribute name";
809     my $removed_attribute = $self->get_attribute_map->{$attribute_name};
810     return unless defined $removed_attribute;
811     delete $self->get_attribute_map->{$attribute_name};
812     $removed_attribute->remove_accessors();
813     $removed_attribute->detach_from_class();
814     return $removed_attribute;
815 }
816
817 sub get_attribute_list {
818     my $self = shift;
819     keys %{$self->get_attribute_map};
820 }
821
822 sub compute_all_applicable_attributes {
823     my $self = shift;
824     my (@attrs, %seen_attr);
825     foreach my $class ($self->linearized_isa) {
826         # fetch the meta-class ...
827         my $meta = $self->initialize($class);
828         foreach my $attr_name ($meta->get_attribute_list()) {
829             next if exists $seen_attr{$attr_name};
830             $seen_attr{$attr_name}++;
831             push @attrs => $meta->get_attribute($attr_name);
832         }
833     }
834     return @attrs;
835 }
836
837 sub find_attribute_by_name {
838     my ($self, $attr_name) = @_;
839     foreach my $class ($self->linearized_isa) {
840         # fetch the meta-class ...
841         my $meta = $self->initialize($class);
842         return $meta->get_attribute($attr_name)
843             if $meta->has_attribute($attr_name);
844     }
845     return;
846 }
847
848 ## Class closing
849
850 sub is_mutable   { 1 }
851 sub is_immutable { 0 }
852
853 # NOTE:
854 # Why I changed this (groditi)
855 #  - One Metaclass may have many Classes through many Metaclass instances
856 #  - One Metaclass should only have one Immutable Transformer instance
857 #  - Each Class may have different Immutabilizing options
858 #  - Therefore each Metaclass instance may have different Immutabilizing options
859 #  - We need to store one Immutable Transformer instance per Metaclass
860 #  - We need to store one set of Immutable Transformer options per Class
861 #  - Upon make_mutable we may delete the Immutabilizing options
862 #  - We could clean the immutable Transformer instance when there is no more
863 #      immutable Classes of that type, but we can also keep it in case
864 #      another class with this same Metaclass becomes immutable. It is a case
865 #      of trading of storing an instance to avoid unnecessary instantiations of
866 #      Immutable Transformers. You may view this as a memory leak, however
867 #      Because we have few Metaclasses, in practice it seems acceptable
868 #  - To allow Immutable Transformers instances to be cleaned up we could weaken
869 #      the reference stored in  $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM
870
871 {
872     my %IMMUTABLE_TRANSFORMERS;
873     my %IMMUTABLE_OPTIONS;
874     sub make_immutable {
875         my $self = shift;
876         my %options = @_;
877         my $class = blessed $self || $self;
878
879         $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer;
880         my $transformer = $IMMUTABLE_TRANSFORMERS{$class};
881
882         $transformer->make_metaclass_immutable($self, \%options);
883         $IMMUTABLE_OPTIONS{$self->name} =
884             { %options,  IMMUTABLE_TRANSFORMER => $transformer };
885
886         if( exists $options{debug} && $options{debug} ){
887             print STDERR "# of Metaclass options:      ", keys %IMMUTABLE_OPTIONS;
888             print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS;
889         }
890     }
891
892     sub make_mutable{
893         my $self = shift;
894         return if $self->is_mutable;
895         my $options = delete $IMMUTABLE_OPTIONS{$self->name};
896         confess "unable to find immutabilizing options" unless ref $options;
897         my $transformer = delete $options->{IMMUTABLE_TRANSFORMER};
898         $transformer->make_metaclass_mutable($self, $options);
899     }
900 }
901
902 sub create_immutable_transformer {
903     my $self = shift;
904     my $class = Class::MOP::Immutable->new($self, {
905        read_only   => [qw/superclasses/],
906        cannot_call => [qw/
907            add_method
908            alias_method
909            remove_method
910            add_attribute
911            remove_attribute
912            add_package_symbol
913            remove_package_symbol
914        /],
915        memoize     => {
916            class_precedence_list             => 'ARRAY',
917            linearized_isa                    => 'ARRAY',
918            compute_all_applicable_attributes => 'ARRAY',
919            get_meta_instance                 => 'SCALAR',
920            get_method_map                    => 'SCALAR',
921        }
922     });
923     return $class;
924 }
925
926 1;
927
928 __END__
929
930 =pod
931
932 =head1 NAME
933
934 Class::MOP::Class - Class Meta Object
935
936 =head1 SYNOPSIS
937
938   # assuming that class Foo
939   # has been defined, you can
940
941   # use this for introspection ...
942
943   # add a method to Foo ...
944   Foo->meta->add_method('bar' => sub { ... })
945
946   # get a list of all the classes searched
947   # the method dispatcher in the correct order
948   Foo->meta->class_precedence_list()
949
950   # remove a method from Foo
951   Foo->meta->remove_method('bar');
952
953   # or use this to actually create classes ...
954
955   Class::MOP::Class->create('Bar' => (
956       version      => '0.01',
957       superclasses => [ 'Foo' ],
958       attributes => [
959           Class::MOP:::Attribute->new('$bar'),
960           Class::MOP:::Attribute->new('$baz'),
961       ],
962       methods => {
963           calculate_bar => sub { ... },
964           construct_baz => sub { ... }
965       }
966   ));
967
968 =head1 DESCRIPTION
969
970 This is the largest and currently most complex part of the Perl 5
971 meta-object protocol. It controls the introspection and
972 manipulation of Perl 5 classes (and it can create them too). The
973 best way to understand what this module can do, is to read the
974 documentation for each of it's methods.
975
976 =head1 METHODS
977
978 =head2 Self Introspection
979
980 =over 4
981
982 =item B<meta>
983
984 This will return a B<Class::MOP::Class> instance which is related
985 to this class. Thereby allowing B<Class::MOP::Class> to actually
986 introspect itself.
987
988 As with B<Class::MOP::Attribute>, B<Class::MOP> will actually
989 bootstrap this module by installing a number of attribute meta-objects
990 into it's metaclass. This will allow this class to reap all the benifits
991 of the MOP when subclassing it.
992
993 =back
994
995 =head2 Class construction
996
997 These methods will handle creating B<Class::MOP::Class> objects,
998 which can be used to both create new classes, and analyze
999 pre-existing classes.
1000
1001 This module will internally store references to all the instances
1002 you create with these methods, so that they do not need to be
1003 created any more than nessecary. Basically, they are singletons.
1004
1005 =over 4
1006
1007 =item B<create ($package_name,
1008                 version      =E<gt> ?$version,
1009                 authority    =E<gt> ?$authority,
1010                 superclasses =E<gt> ?@superclasses,
1011                 methods      =E<gt> ?%methods,
1012                 attributes   =E<gt> ?%attributes)>
1013
1014 This returns a B<Class::MOP::Class> object, bringing the specified
1015 C<$package_name> into existence and adding any of the C<$version>,
1016 C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to
1017 it.
1018
1019 =item B<create_anon_class (superclasses =E<gt> ?@superclasses,
1020                            methods      =E<gt> ?%methods,
1021                            attributes   =E<gt> ?%attributes)>
1022
1023 This will create an anonymous class, it works much like C<create> but
1024 it does not need a C<$package_name>. Instead it will create a suitably
1025 unique package name for you to stash things into.
1026
1027 On very important distinction is that anon classes are destroyed once
1028 the metaclass they are attached to goes out of scope. In the DESTROY
1029 method, the created package will be removed from the symbol table.
1030
1031 It is also worth noting that any instances created with an anon-class
1032 will keep a special reference to the anon-meta which will prevent the
1033 anon-class from going out of scope until all instances of it have also
1034 been destroyed. This however only works for HASH based instance types,
1035 as we use a special reserved slot (C<__MOP__>) to store this.
1036
1037 =item B<initialize ($package_name, %options)>
1038
1039 This initializes and returns returns a B<Class::MOP::Class> object
1040 for a given a C<$package_name>.
1041
1042 =item B<reinitialize ($package_name, %options)>
1043
1044 This removes the old metaclass, and creates a new one in it's place.
1045 Do B<not> use this unless you really know what you are doing, it could
1046 very easily make a very large mess of your program.
1047
1048 =item B<construct_class_instance (%options)>
1049
1050 This will construct an instance of B<Class::MOP::Class>, it is
1051 here so that we can actually "tie the knot" for B<Class::MOP::Class>
1052 to use C<construct_instance> once all the bootstrapping is done. This
1053 method is used internally by C<initialize> and should never be called
1054 from outside of that method really.
1055
1056 =item B<check_metaclass_compatability>
1057
1058 This method is called as the very last thing in the
1059 C<construct_class_instance> method. This will check that the
1060 metaclass you are creating is compatible with the metaclasses of all
1061 your ancestors. For more inforamtion about metaclass compatibility
1062 see the C<About Metaclass compatibility> section in L<Class::MOP>.
1063
1064 =item B<update_package_cache_flag>
1065
1066 This will reset the package cache flag for this particular metaclass
1067 it is basically the value of the C<Class::MOP::get_package_cache_flag> 
1068 function. This is very rarely needed from outside of C<Class::MOP::Class>
1069 but in some cases you might want to use it, so it is here.
1070
1071 =item B<reset_package_cache_flag>
1072
1073 Clear this flag, used in Moose.
1074
1075 =back
1076
1077 =head2 Object instance construction and cloning
1078
1079 These methods are B<entirely optional>, it is up to you whether you want
1080 to use them or not.
1081
1082 =over 4
1083
1084 =item B<instance_metaclass>
1085
1086 =item B<get_meta_instance>
1087
1088 =item B<new_object (%params)>
1089
1090 This is a convience method for creating a new object of the class, and
1091 blessing it into the appropriate package as well. Ideally your class
1092 would call a C<new> this method like so:
1093
1094   sub MyClass::new {
1095       my ($class, %param) = @_;
1096       $class->meta->new_object(%params);
1097   }
1098
1099 Of course the ideal place for this would actually be in C<UNIVERSAL::>
1100 but that is considered bad style, so we do not do that.
1101
1102 =item B<construct_instance (%params)>
1103
1104 This method is used to construct an instace structure suitable for
1105 C<bless>-ing into your package of choice. It works in conjunction
1106 with the Attribute protocol to collect all applicable attributes.
1107
1108 This will construct and instance using a HASH ref as storage
1109 (currently only HASH references are supported). This will collect all
1110 the applicable attributes and layout out the fields in the HASH ref,
1111 it will then initialize them using either use the corresponding key
1112 in C<%params> or any default value or initializer found in the
1113 attribute meta-object.
1114
1115 =item B<clone_object ($instance, %params)>
1116
1117 This is a convience method for cloning an object instance, then
1118 blessing it into the appropriate package. This method will call
1119 C<clone_instance>, which performs a shallow copy of the object,
1120 see that methods documentation for more details. Ideally your
1121 class would call a C<clone> this method like so:
1122
1123   sub MyClass::clone {
1124       my ($self, %param) = @_;
1125       $self->meta->clone_object($self, %params);
1126   }
1127
1128 Of course the ideal place for this would actually be in C<UNIVERSAL::>
1129 but that is considered bad style, so we do not do that.
1130
1131 =item B<clone_instance($instance, %params)>
1132
1133 This method is a compliment of C<construct_instance> (which means if
1134 you override C<construct_instance>, you need to override this one too),
1135 and clones the instance shallowly.
1136
1137 The cloned structure returned is (like with C<construct_instance>) an
1138 unC<bless>ed HASH reference, it is your responsibility to then bless
1139 this cloned structure into the right class (which C<clone_object> will
1140 do for you).
1141
1142 As of 0.11, this method will clone the C<$instance> structure shallowly,
1143 as opposed to the deep cloning implemented in prior versions. After much
1144 thought, research and discussion, I have decided that anything but basic
1145 shallow cloning is outside the scope of the meta-object protocol. I
1146 think Yuval "nothingmuch" Kogman put it best when he said that cloning
1147 is too I<context-specific> to be part of the MOP.
1148
1149 =item B<get_attribute_values($instance)>
1150
1151 Returns the values of the C<$instance>'s fields keyed by the attribute names.
1152
1153 =item B<get_init_args($instance)>
1154
1155 Returns a hash reference where the keys are all the attributes' C<init_arg>s
1156 and the values are the instance's fields. Attributes without an C<init_arg>
1157 will be skipped.
1158
1159 =item B<rebless_instance($instance)>
1160
1161 This will change the class of C<$instance> to the class of the invoking
1162 C<Class::MOP::Class>. You may only rebless the instance to a subclass of
1163 itself. This limitation may be relaxed in the future.
1164
1165 This can be useful in a number of situations, such as when you are writing
1166 a program that doesn't know everything at object construction time.
1167
1168 =back
1169
1170 =head2 Informational
1171
1172 These are a few predicate methods for asking information about the class.
1173
1174 =over 4
1175
1176 =item B<is_anon_class>
1177
1178 This returns true if the class is a C<Class::MOP::Class> created anon class.
1179
1180 =item B<is_mutable>
1181
1182 This returns true if the class is still mutable.
1183
1184 =item B<is_immutable>
1185
1186 This returns true if the class has been made immutable.
1187
1188 =back
1189
1190 =head2 Inheritance Relationships
1191
1192 =over 4
1193
1194 =item B<superclasses (?@superclasses)>
1195
1196 This is a read-write attribute which represents the superclass
1197 relationships of the class the B<Class::MOP::Class> instance is
1198 associated with. Basically, it can get and set the C<@ISA> for you.
1199
1200 B<NOTE:>
1201 Perl will occasionally perform some C<@ISA> and method caching, if
1202 you decide to change your superclass relationship at runtime (which
1203 is quite insane and very much not recommened), then you should be
1204 aware of this and the fact that this module does not make any
1205 attempt to address this issue.
1206
1207 =item B<class_precedence_list>
1208
1209 This computes the a list of all the class's ancestors in the same order
1210 in which method dispatch will be done. This is similair to
1211 what B<Class::ISA::super_path> does, but we don't remove duplicate names.
1212
1213 =item B<linearized_isa>
1214
1215 This returns a list based on C<class_precedence_list> but with all 
1216 duplicates removed.
1217
1218 =item B<subclasses>
1219
1220 This returns a list of subclasses for this class.
1221
1222 =back
1223
1224 =head2 Methods
1225
1226 =over 4
1227
1228 =item B<get_method_map>
1229
1230 =item B<method_metaclass>
1231
1232 =item B<add_method ($method_name, $method)>
1233
1234 This will take a C<$method_name> and CODE reference to that
1235 C<$method> and install it into the class's package.
1236
1237 B<NOTE>:
1238 This does absolutely nothing special to C<$method>
1239 other than use B<Sub::Name> to make sure it is tagged with the
1240 correct name, and therefore show up correctly in stack traces and
1241 such.
1242
1243 =item B<alias_method ($method_name, $method)>
1244
1245 This will take a C<$method_name> and CODE reference to that
1246 C<$method> and alias the method into the class's package.
1247
1248 B<NOTE>:
1249 Unlike C<add_method>, this will B<not> try to name the
1250 C<$method> using B<Sub::Name>, it only aliases the method in
1251 the class's package.
1252
1253 =item B<has_method ($method_name)>
1254
1255 This just provides a simple way to check if the class implements
1256 a specific C<$method_name>. It will I<not> however, attempt to check
1257 if the class inherits the method (use C<UNIVERSAL::can> for that).
1258
1259 This will correctly handle functions defined outside of the package
1260 that use a fully qualified name (C<sub Package::name { ... }>).
1261
1262 This will correctly handle functions renamed with B<Sub::Name> and
1263 installed using the symbol tables. However, if you are naming the
1264 subroutine outside of the package scope, you must use the fully
1265 qualified name, including the package name, for C<has_method> to
1266 correctly identify it.
1267
1268 This will attempt to correctly ignore functions imported from other
1269 packages using B<Exporter>. It breaks down if the function imported
1270 is an C<__ANON__> sub (such as with C<use constant>), which very well
1271 may be a valid method being applied to the class.
1272
1273 In short, this method cannot always be trusted to determine if the
1274 C<$method_name> is actually a method. However, it will DWIM about
1275 90% of the time, so it's a small trade off I think.
1276
1277 =item B<get_method ($method_name)>
1278
1279 This will return a Class::MOP::Method instance related to the specified
1280 C<$method_name>, or return undef if that method does not exist.
1281
1282 The Class::MOP::Method is codifiable, so you can use it like a normal
1283 CODE reference, see L<Class::MOP::Method> for more information.
1284
1285 =item B<find_method_by_name ($method_name>
1286
1287 This will return a CODE reference of the specified C<$method_name>,
1288 or return undef if that method does not exist.
1289
1290 Unlike C<get_method> this will also look in the superclasses.
1291
1292 =item B<remove_method ($method_name)>
1293
1294 This will attempt to remove a given C<$method_name> from the class.
1295 It will return the CODE reference that it has removed, and will
1296 attempt to use B<Sub::Name> to clear the methods associated name.
1297
1298 =item B<get_method_list>
1299
1300 This will return a list of method names for all I<locally> defined
1301 methods. It does B<not> provide a list of all applicable methods,
1302 including any inherited ones. If you want a list of all applicable
1303 methods, use the C<compute_all_applicable_methods> method.
1304
1305 =item B<compute_all_applicable_methods>
1306
1307 This will return a list of all the methods names this class will
1308 respond to, taking into account inheritance. The list will be a list of
1309 HASH references, each one containing the following information; method
1310 name, the name of the class in which the method lives and a CODE
1311 reference for the actual method.
1312
1313 =item B<find_all_methods_by_name ($method_name)>
1314
1315 This will traverse the inheritence hierarchy and locate all methods
1316 with a given C<$method_name>. Similar to
1317 C<compute_all_applicable_methods> it returns a list of HASH references
1318 with the following information; method name (which will always be the
1319 same as C<$method_name>), the name of the class in which the method
1320 lives and a CODE reference for the actual method.
1321
1322 The list of methods produced is a distinct list, meaning there are no
1323 duplicates in it. This is especially useful for things like object
1324 initialization and destruction where you only want the method called
1325 once, and in the correct order.
1326
1327 =item B<find_next_method_by_name ($method_name)>
1328
1329 This will return the first method to match a given C<$method_name> in
1330 the superclasses, this is basically equivalent to calling
1331 C<SUPER::$method_name>, but it can be dispatched at runtime.
1332
1333 =back
1334
1335 =head2 Method Modifiers
1336
1337 Method modifiers are a concept borrowed from CLOS, in which a method
1338 can be wrapped with I<before>, I<after> and I<around> method modifiers
1339 that will be called everytime the method is called.
1340
1341 =head3 How method modifiers work?
1342
1343 Method modifiers work by wrapping the original method and then replacing
1344 it in the classes symbol table. The wrappers will handle calling all the
1345 modifiers in the appropariate orders and preserving the calling context
1346 for the original method.
1347
1348 Each method modifier serves a particular purpose, which may not be
1349 obvious to users of other method wrapping modules. To start with, the
1350 return values of I<before> and I<after> modifiers are ignored. This is
1351 because thier purpose is B<not> to filter the input and output of the
1352 primary method (this is done with an I<around> modifier). This may seem
1353 like an odd restriction to some, but doing this allows for simple code
1354 to be added at the begining or end of a method call without jeapordizing
1355 the normal functioning of the primary method or placing any extra
1356 responsibility on the code of the modifier. Of course if you have more
1357 complex needs, then use the I<around> modifier, which uses a variation
1358 of continutation passing style to allow for a high degree of flexibility.
1359
1360 Before and around modifiers are called in last-defined-first-called order,
1361 while after modifiers are called in first-defined-first-called order. So
1362 the call tree might looks something like this:
1363
1364   before 2
1365    before 1
1366     around 2
1367      around 1
1368       primary
1369      after 1
1370     after 2
1371
1372 To see examples of using method modifiers, see the following examples
1373 included in the distribution; F<InstanceCountingClass>, F<Perl6Attribute>,
1374 F<AttributesWithHistory> and F<C3MethodDispatchOrder>. There is also a
1375 classic CLOS usage example in the test F<017_add_method_modifier.t>.
1376
1377 =head3 What is the performance impact?
1378
1379 Of course there is a performance cost associated with method modifiers,
1380 but we have made every effort to make that cost be directly proportional
1381 to the amount of modifier features you utilize.
1382
1383 The wrapping method does it's best to B<only> do as much work as it
1384 absolutely needs to. In order to do this we have moved some of the
1385 performance costs to set-up time, where they are easier to amortize.
1386
1387 All this said, my benchmarks have indicated the following:
1388
1389   simple wrapper with no modifiers             100% slower
1390   simple wrapper with simple before modifier   400% slower
1391   simple wrapper with simple after modifier    450% slower
1392   simple wrapper with simple around modifier   500-550% slower
1393   simple wrapper with all 3 modifiers          1100% slower
1394
1395 These numbers may seem daunting, but you must remember, every feature
1396 comes with some cost. To put things in perspective, just doing a simple
1397 C<AUTOLOAD> which does nothing but extract the name of the method called
1398 and return it costs about 400% over a normal method call.
1399
1400 =over 4
1401
1402 =item B<add_before_method_modifier ($method_name, $code)>
1403
1404 This will wrap the method at C<$method_name> and the supplied C<$code>
1405 will be passed the C<@_> arguments, and called before the original
1406 method is called. As specified above, the return value of the I<before>
1407 method modifiers is ignored, and it's ability to modify C<@_> is
1408 fairly limited. If you need to do either of these things, use an
1409 C<around> method modifier.
1410
1411 =item B<add_after_method_modifier ($method_name, $code)>
1412
1413 This will wrap the method at C<$method_name> so that the original
1414 method will be called, it's return values stashed, and then the
1415 supplied C<$code> will be passed the C<@_> arguments, and called.
1416 As specified above, the return value of the I<after> method
1417 modifiers is ignored, and it cannot modify the return values of
1418 the original method. If you need to do either of these things, use an
1419 C<around> method modifier.
1420
1421 =item B<add_around_method_modifier ($method_name, $code)>
1422
1423 This will wrap the method at C<$method_name> so that C<$code>
1424 will be called and passed the original method as an extra argument
1425 at the begining of the C<@_> argument list. This is a variation of
1426 continuation passing style, where the function prepended to C<@_>
1427 can be considered a continuation. It is up to C<$code> if it calls
1428 the original method or not, there is no restriction on what the
1429 C<$code> can or cannot do.
1430
1431 =back
1432
1433 =head2 Attributes
1434
1435 It should be noted that since there is no one consistent way to define
1436 the attributes of a class in Perl 5. These methods can only work with
1437 the information given, and can not easily discover information on
1438 their own. See L<Class::MOP::Attribute> for more details.
1439
1440 =over 4
1441
1442 =item B<attribute_metaclass>
1443
1444 =item B<get_attribute_map>
1445
1446 =item B<add_attribute ($attribute_meta_object | $attribute_name, %attribute_spec)>
1447
1448 This stores the C<$attribute_meta_object> (or creates one from the
1449 C<$attribute_name> and C<%attribute_spec>) in the B<Class::MOP::Class>
1450 instance associated with the given class. Unlike methods, attributes
1451 within the MOP are stored as meta-information only. They will be used
1452 later to construct instances from (see C<construct_instance> above).
1453 More details about the attribute meta-objects can be found in the
1454 L<Class::MOP::Attribute> or the L<Class::MOP/The Attribute protocol>
1455 section.
1456
1457 It should be noted that any accessor, reader/writer or predicate
1458 methods which the C<$attribute_meta_object> has will be installed
1459 into the class at this time.
1460
1461 B<NOTE>
1462 If an attribute already exists for C<$attribute_name>, the old one
1463 will be removed (as well as removing all it's accessors), and then
1464 the new one added.
1465
1466 =item B<has_attribute ($attribute_name)>
1467
1468 Checks to see if this class has an attribute by the name of
1469 C<$attribute_name> and returns a boolean.
1470
1471 =item B<get_attribute ($attribute_name)>
1472
1473 Returns the attribute meta-object associated with C<$attribute_name>,
1474 if none is found, it will return undef.
1475
1476 =item B<remove_attribute ($attribute_name)>
1477
1478 This will remove the attribute meta-object stored at
1479 C<$attribute_name>, then return the removed attribute meta-object.
1480
1481 B<NOTE:>
1482 Removing an attribute will only affect future instances of
1483 the class, it will not make any attempt to remove the attribute from
1484 any existing instances of the class.
1485
1486 It should be noted that any accessor, reader/writer or predicate
1487 methods which the attribute meta-object stored at C<$attribute_name>
1488 has will be removed from the class at this time. This B<will> make
1489 these attributes somewhat inaccessable in previously created
1490 instances. But if you are crazy enough to do this at runtime, then
1491 you are crazy enough to deal with something like this :).
1492
1493 =item B<get_attribute_list>
1494
1495 This returns a list of attribute names which are defined in the local
1496 class. If you want a list of all applicable attributes for a class,
1497 use the C<compute_all_applicable_attributes> method.
1498
1499 =item B<compute_all_applicable_attributes>
1500
1501 This will traverse the inheritance heirachy and return a list of all
1502 the applicable attributes for this class. It does not construct a
1503 HASH reference like C<compute_all_applicable_methods> because all
1504 that same information is discoverable through the attribute
1505 meta-object itself.
1506
1507 =item B<find_attribute_by_name ($attr_name)>
1508
1509 This method will traverse the inheritance heirachy and find the
1510 first attribute whose name matches C<$attr_name>, then return it.
1511 It will return undef if nothing is found.
1512
1513 =back
1514
1515 =head2 Class Immutability
1516
1517 =over 4
1518
1519 =item B<make_immutable (%options)>
1520
1521 This method will invoke a tranforamtion upon the class which will
1522 make it immutable. Details of this transformation can be found in
1523 the L<Class::MOP::Immutable> documentation.
1524
1525 =item B<make_mutable>
1526
1527 This method will reverse tranforamtion upon the class which
1528 made it immutable.
1529
1530 =item B<create_immutable_transformer>
1531
1532 Create a transformer suitable for making this class immutable
1533
1534 =back
1535
1536 =head1 AUTHORS
1537
1538 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1539
1540 =head1 COPYRIGHT AND LICENSE
1541
1542 Copyright 2006-2008 by Infinity Interactive, Inc.
1543
1544 L<http://www.iinteractive.com>
1545
1546 This library is free software; you can redistribute it and/or modify
1547 it under the same terms as Perl itself.
1548
1549 =cut