2 package Class::MOP::Class;
7 use Class::MOP::Immutable;
8 use Class::MOP::Instance;
9 use Class::MOP::Method::Wrapped;
12 use Scalar::Util 'blessed', 'weaken';
14 our $VERSION = '0.79';
15 $VERSION = eval $VERSION;
16 our $AUTHORITY = 'cpan:STEVAN';
18 use base 'Class::MOP::Module';
28 $package_name = shift;
31 $package_name = $options{package};
34 (defined $package_name && $package_name && !ref($package_name))
35 || confess "You must pass a package name and it cannot be blessed";
37 return Class::MOP::get_metaclass_by_name($package_name)
38 || $class->construct_class_instance(package => $package_name, @_);
41 # NOTE: (meta-circularity)
42 # this is a special form of &construct_instance
43 # (see below), which is used to construct class
44 # meta-object instances for any Class::MOP::*
45 # class. All other classes will use the more
46 # normal &construct_instance.
47 sub construct_class_instance {
49 my $options = @_ == 1 ? $_[0] : {@_};
50 my $package_name = $options->{package};
51 (defined $package_name && $package_name)
52 || confess "You must pass a package name";
54 # return the metaclass if we have it cached,
55 # and it is still defined (it has not been
56 # reaped by DESTROY yet, which can happen
57 # annoyingly enough during global destruction)
59 if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) {
64 # we need to deal with the possibility
65 # of class immutability here, and then
66 # get the name of the class appropriately
68 ? ($class->is_immutable
69 ? $class->get_mutable_metaclass_name()
73 # now create the metaclass
75 if ($class eq 'Class::MOP::Class') {
76 $meta = $class->_new($options);
80 # it is safe to use meta here because
81 # class will always be a subclass of
82 # Class::MOP::Class, which defines meta
83 $meta = $class->meta->construct_instance($options)
86 # and check the metaclass compatibility
87 $meta->check_metaclass_compatibility();
89 Class::MOP::store_metaclass_by_name($package_name, $meta);
92 # we need to weaken any anon classes
93 # so that they can call DESTROY properly
94 Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class;
101 my $options = @_ == 1 ? $_[0] : {@_};
104 # inherited from Class::MOP::Package
105 'package' => $options->{package},
108 # since the following attributes will
109 # actually be loaded from the symbol
110 # table, and actually bypass the instance
111 # entirely, we can just leave these things
112 # listed here for reference, because they
113 # should not actually have a value associated
115 'namespace' => \undef,
117 # inherited from Class::MOP::Module
119 'authority' => \undef,
121 # defined in Class::MOP::Class
122 'superclasses' => \undef,
126 'attribute_metaclass' => $options->{'attribute_metaclass'}
127 || 'Class::MOP::Attribute',
128 'method_metaclass' => $options->{'method_metaclass'}
129 || 'Class::MOP::Method',
130 'wrapped_method_metaclass' => $options->{'wrapped_method_metaclass'}
131 || 'Class::MOP::Method::Wrapped',
132 'instance_metaclass' => $options->{'instance_metaclass'}
133 || 'Class::MOP::Instance',
137 sub reset_package_cache_flag { (shift)->{'_package_cache_flag'} = undef }
138 sub update_package_cache_flag {
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.
146 $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name);
149 sub check_metaclass_compatibility {
152 # this is always okay ...
153 return if ref($self) eq 'Class::MOP::Class' &&
154 $self->instance_metaclass eq 'Class::MOP::Instance';
156 my @class_list = $self->linearized_isa;
157 shift @class_list; # shift off $self->name
159 foreach my $superclass_name (@class_list) {
160 my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name) || next;
163 # we need to deal with the possibility
164 # of class immutability here, and then
165 # get the name of the class appropriately
167 = $super_meta->is_immutable
168 ? $super_meta->get_mutable_metaclass_name()
171 ($self->isa($super_meta_type))
172 || confess "Class::MOP::class_of(" . $self->name . ") => ("
173 . (ref($self)) . ")" . " is not compatible with the " .
174 "Class::MOP::class_of(".$superclass_name . ") => ("
175 . ($super_meta_type) . ")";
177 # we also need to check that instance metaclasses
178 # are compatibile in the same the class.
179 ($self->instance_metaclass->isa($super_meta->instance_metaclass))
180 || confess "Class::MOP::class_of(" . $self->name . ")->instance_metaclass => (" . ($self->instance_metaclass) . ")" .
181 " is not compatible with the " .
182 "Class::MOP::class_of(" . $superclass_name . ")->instance_metaclass => (" . ($super_meta->instance_metaclass) . ")";
190 # this should be sufficient, if you have a
191 # use case where it is not, write a test and
193 my $ANON_CLASS_SERIAL = 0;
196 # we need a sufficiently annoying prefix
197 # this should suffice for now, this is
198 # used in a couple of places below, so
199 # need to put it up here for now.
200 my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';
204 no warnings 'uninitialized';
205 $self->name =~ /^$ANON_CLASS_PREFIX/;
208 sub create_anon_class {
209 my ($class, %options) = @_;
210 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
211 return $class->create($package_name, %options);
215 # this will only get called for
216 # anon-classes, all other calls
217 # are assumed to occur during
218 # global destruction and so don't
219 # really need to be handled explicitly
223 return if Class::MOP::in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated
225 no warnings 'uninitialized';
226 return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
227 # Moose does a weird thing where it replaces the metaclass for
228 # class when fixing metaclass incompatibility. In that case,
229 # we don't want to clean out the namespace now. We can detect
230 # that because Moose will explicitly update the singleton
231 # cache in Class::MOP.
232 my $current_meta = Class::MOP::get_metaclass_by_name($self->name);
233 return if $current_meta ne $self;
235 my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
237 foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
238 delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
240 delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};
245 # creating classes with MOP ...
248 my ( $class, @args ) = @_;
250 unshift @args, 'package' if @args % 2 == 1;
252 my (%options) = @args;
253 my $package_name = $options{package};
255 (ref $options{superclasses} eq 'ARRAY')
256 || confess "You must pass an ARRAY ref of superclasses"
257 if exists $options{superclasses};
259 (ref $options{attributes} eq 'ARRAY')
260 || confess "You must pass an ARRAY ref of attributes"
261 if exists $options{attributes};
263 (ref $options{methods} eq 'HASH')
264 || confess "You must pass a HASH ref of methods"
265 if exists $options{methods};
267 $class->SUPER::create(%options);
269 my (%initialize_options) = @args;
270 delete @initialize_options{qw(
278 my $meta = $class->initialize( $package_name => %initialize_options );
281 $meta->add_method('meta' => sub {
282 $class->initialize(ref($_[0]) || $_[0]);
285 $meta->superclasses(@{$options{superclasses}})
286 if exists $options{superclasses};
288 # process attributes first, so that they can
289 # install accessors, but locally defined methods
290 # can then overwrite them. It is maybe a little odd, but
291 # I think this should be the order of things.
292 if (exists $options{attributes}) {
293 foreach my $attr (@{$options{attributes}}) {
294 $meta->add_attribute($attr);
297 if (exists $options{methods}) {
298 foreach my $method_name (keys %{$options{methods}}) {
299 $meta->add_method($method_name, $options{methods}->{$method_name});
308 # all these attribute readers will be bootstrapped
309 # away in the Class::MOP bootstrap section
311 sub get_attribute_map { $_[0]->{'attributes'} }
312 sub attribute_metaclass { $_[0]->{'attribute_metaclass'} }
313 sub method_metaclass { $_[0]->{'method_metaclass'} }
314 sub wrapped_method_metaclass { $_[0]->{'wrapped_method_metaclass'} }
315 sub instance_metaclass { $_[0]->{'instance_metaclass'} }
317 # Instance Construction & Cloning
323 # we need to protect the integrity of the
324 # Class::MOP::Class singletons here, so we
325 # delegate this to &construct_class_instance
326 # which will deal with the singletons
327 return $class->construct_class_instance(@_)
328 if $class->name->isa('Class::MOP::Class');
329 return $class->construct_instance(@_);
332 sub construct_instance {
334 my $params = @_ == 1 ? $_[0] : {@_};
335 my $meta_instance = $class->get_meta_instance();
336 my $instance = $meta_instance->create_instance();
337 foreach my $attr ($class->compute_all_applicable_attributes()) {
338 $attr->initialize_instance_slot($meta_instance, $instance, $params);
341 # this will only work for a HASH instance type
342 if ($class->is_anon_class) {
343 (Scalar::Util::reftype($instance) eq 'HASH')
344 || confess "Currently only HASH based instances are supported with instance of anon-classes";
346 # At some point we should make this official
347 # as a reserved slot name, but right now I am
348 # going to keep it here.
349 # my $RESERVED_MOP_SLOT = '__MOP__';
350 $instance->{'__MOP__'} = $class;
356 sub get_meta_instance {
358 $self->{'_meta_instance'} ||= $self->create_meta_instance();
361 sub create_meta_instance {
364 my $instance = $self->instance_metaclass->new(
365 associated_metaclass => $self,
366 attributes => [ $self->compute_all_applicable_attributes() ],
369 $self->add_meta_instance_dependencies()
370 if $instance->is_dependent_on_superclasses();
377 my $instance = shift;
378 (blessed($instance) && $instance->isa($class->name))
379 || confess "You must pass an instance of the metaclass (" . (ref $class ? $class->name : $class) . "), not ($instance)";
382 # we need to protect the integrity of the
383 # Class::MOP::Class singletons here, they
384 # should not be cloned.
385 return $instance if $instance->isa('Class::MOP::Class');
386 $class->clone_instance($instance, @_);
390 my ($class, $instance, %params) = @_;
392 || confess "You can only clone instances, ($instance) is not a blessed instance";
393 my $meta_instance = $class->get_meta_instance();
394 my $clone = $meta_instance->clone_instance($instance);
395 foreach my $attr ($class->compute_all_applicable_attributes()) {
396 if ( defined( my $init_arg = $attr->init_arg ) ) {
397 if (exists $params{$init_arg}) {
398 $attr->set_value($clone, $params{$init_arg});
405 sub rebless_instance {
406 my ($self, $instance, %params) = @_;
408 my $old_metaclass = Class::MOP::class_of($instance);
410 my $old_class = $old_metaclass ? $old_metaclass->name : blessed($instance);
411 $self->name->isa($old_class)
412 || confess "You may rebless only into a subclass of ($old_class), of which (". $self->name .") isn't.";
414 $old_metaclass->rebless_instance_away($instance, $self, %params)
417 my $meta_instance = $self->get_meta_instance();
420 # we use $_[1] here because of t/306_rebless_overload.t regressions on 5.8.8
421 $meta_instance->rebless_instance_structure($_[1], $self);
423 foreach my $attr ( $self->compute_all_applicable_attributes ) {
424 if ( $attr->has_value($instance) ) {
425 if ( defined( my $init_arg = $attr->init_arg ) ) {
426 $params{$init_arg} = $attr->get_value($instance)
427 unless exists $params{$init_arg};
430 $attr->set_value($instance, $attr->get_value($instance));
435 foreach my $attr ($self->compute_all_applicable_attributes) {
436 $attr->initialize_instance_slot($meta_instance, $instance, \%params);
442 sub rebless_instance_away {
443 # this intentionally does nothing, it is just a hook
450 my $var_spec = { sigil => '@', type => 'ARRAY', name => 'ISA' };
453 @{$self->get_package_symbol($var_spec)} = @supers;
456 # on 5.8 and below, we need to call
457 # a method to get Perl to detect
458 # a cycle in the class hierarchy
459 my $class = $self->name;
463 # we need to check the metaclass
464 # compatibility here so that we can
465 # be sure that the superclass is
466 # not potentially creating an issues
467 # we don't know about
469 $self->check_metaclass_compatibility();
470 $self->update_meta_instance_dependencies();
472 @{$self->get_package_symbol($var_spec)};
478 my $super_class = $self->name;
480 if ( Class::MOP::HAVE_ISAREV() ) {
481 return @{ $super_class->mro::get_isarev() };
485 my $find_derived_classes;
486 $find_derived_classes = sub {
487 my ($outer_class) = @_;
489 my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} };
492 for my $symbol ( keys %$symbol_table_hashref ) {
493 next SYMBOL if $symbol !~ /\A (\w+):: \z/x;
494 my $inner_class = $1;
496 next SYMBOL if $inner_class eq 'SUPER'; # skip '*::SUPER'
500 ? "${outer_class}::$inner_class"
503 if ( $class->isa($super_class) and $class ne $super_class ) {
504 push @derived_classes, $class;
507 next SYMBOL if $class eq 'main'; # skip 'main::*'
509 $find_derived_classes->($class);
513 my $root_class = q{};
514 $find_derived_classes->($root_class);
516 undef $find_derived_classes;
518 @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes;
520 return @derived_classes;
526 return @{ mro::get_linear_isa( (shift)->name ) };
529 sub class_precedence_list {
531 my $name = $self->name;
533 unless (Class::MOP::IS_RUNNING_ON_5_10()) {
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.
541 ($name || return)->isa('This is a test for circular inheritance')
544 # if our mro is c3, we can
545 # just grab the linear_isa
546 if (mro::get_mro($name) eq 'c3') {
547 return @{ mro::get_linear_isa($name) }
551 # we can't grab the linear_isa for dfs
552 # since it has all the duplicates
557 $self->initialize($_)->class_precedence_list()
558 } $self->superclasses()
565 sub wrap_method_body {
566 my ( $self, %args ) = @_;
568 ('CODE' eq ref $args{body})
569 || confess "Your code block must be a CODE reference";
571 $self->method_metaclass->wrap(
572 package_name => $self->name,
578 my ($self, $method_name, $method) = @_;
579 (defined $method_name && $method_name)
580 || confess "You must define a method name";
583 if (blessed($method)) {
584 $body = $method->body;
585 if ($method->package_name ne $self->name) {
586 $method = $method->clone(
587 package_name => $self->name,
589 ) if $method->can('clone');
594 $method = $self->wrap_method_body( body => $body, name => $method_name );
597 $method->attach_to_class($self);
599 # This used to call get_method_map, which meant we would build all
600 # the method objects for the class just because we added one
601 # method. This is hackier, but quicker too.
602 $self->{methods}{$method_name} = $method;
604 my $full_method_name = ($self->name . '::' . $method_name);
605 $self->add_package_symbol(
606 { sigil => '&', type => 'CODE', name => $method_name },
607 Class::MOP::subname($full_method_name => $body)
612 my $fetch_and_prepare_method = sub {
613 my ($self, $method_name) = @_;
614 my $wrapped_metaclass = $self->wrapped_method_metaclass;
616 my $method = $self->get_method($method_name);
617 # if we dont have local ...
619 # try to find the next method
620 $method = $self->find_next_method_by_name($method_name);
621 # die if it does not exist
623 || confess "The method '$method_name' was not found in the inheritance hierarchy for " . $self->name;
624 # and now make sure to wrap it
625 # even if it is already wrapped
626 # because we need a new sub ref
627 $method = $wrapped_metaclass->wrap($method);
630 # now make sure we wrap it properly
631 $method = $wrapped_metaclass->wrap($method)
632 unless $method->isa($wrapped_metaclass);
634 $self->add_method($method_name => $method);
638 sub add_before_method_modifier {
639 my ($self, $method_name, $method_modifier) = @_;
640 (defined $method_name && $method_name)
641 || confess "You must pass in a method name";
642 my $method = $fetch_and_prepare_method->($self, $method_name);
643 $method->add_before_modifier(
644 Class::MOP::subname(':before' => $method_modifier)
648 sub add_after_method_modifier {
649 my ($self, $method_name, $method_modifier) = @_;
650 (defined $method_name && $method_name)
651 || confess "You must pass in a method name";
652 my $method = $fetch_and_prepare_method->($self, $method_name);
653 $method->add_after_modifier(
654 Class::MOP::subname(':after' => $method_modifier)
658 sub add_around_method_modifier {
659 my ($self, $method_name, $method_modifier) = @_;
660 (defined $method_name && $method_name)
661 || confess "You must pass in a method name";
662 my $method = $fetch_and_prepare_method->($self, $method_name);
663 $method->add_around_modifier(
664 Class::MOP::subname(':around' => $method_modifier)
669 # the methods above used to be named like this:
670 # ${pkg}::${method}:(before|after|around)
671 # but this proved problematic when using one modifier
672 # to wrap multiple methods (something which is likely
673 # to happen pretty regularly IMO). So instead of naming
674 # it like this, I have chosen to just name them purely
675 # with their modifier names, like so:
676 # :(before|after|around)
677 # The fact is that in a stack trace, it will be fairly
678 # evident from the context what method they are attached
679 # to, and so don't need the fully qualified name.
685 $self->add_method(@_);
689 my ($self, $method_name) = @_;
690 (defined $method_name && $method_name)
691 || confess "You must define a method name";
693 exists $self->{methods}{$method_name} || exists $self->get_method_map->{$method_name};
697 my ($self, $method_name) = @_;
698 (defined $method_name && $method_name)
699 || confess "You must define a method name";
701 return $self->{methods}{$method_name} || $self->get_method_map->{$method_name};
705 my ($self, $method_name) = @_;
706 (defined $method_name && $method_name)
707 || confess "You must define a method name";
709 my $removed_method = delete $self->get_method_map->{$method_name};
711 $self->remove_package_symbol(
712 { sigil => '&', type => 'CODE', name => $method_name }
715 $removed_method->detach_from_class if $removed_method;
717 $self->update_package_cache_flag; # still valid, since we just removed the method from the map
719 return $removed_method;
722 sub get_method_list {
724 keys %{$self->get_method_map};
727 sub find_method_by_name {
728 my ($self, $method_name) = @_;
729 (defined $method_name && $method_name)
730 || confess "You must define a method name to find";
731 foreach my $class ($self->linearized_isa) {
732 # fetch the meta-class ...
733 my $meta = $self->initialize($class);
734 return $meta->get_method($method_name)
735 if $meta->has_method($method_name);
740 sub get_all_methods {
742 my %methods = map { %{ $self->initialize($_)->get_method_map } } reverse $self->linearized_isa;
743 return values %methods;
747 sub compute_all_applicable_methods {
751 class => $_->package_name,
752 code => $_, # sigh, overloading
754 } shift->get_all_methods(@_);
757 sub get_all_method_names {
760 grep { $uniq{$_}++ == 0 } map { $_->name } $self->get_all_methods;
763 sub find_all_methods_by_name {
764 my ($self, $method_name) = @_;
765 (defined $method_name && $method_name)
766 || confess "You must define a method name to find";
768 foreach my $class ($self->linearized_isa) {
769 # fetch the meta-class ...
770 my $meta = $self->initialize($class);
772 name => $method_name,
774 code => $meta->get_method($method_name)
775 } if $meta->has_method($method_name);
780 sub find_next_method_by_name {
781 my ($self, $method_name) = @_;
782 (defined $method_name && $method_name)
783 || confess "You must define a method name to find";
784 my @cpl = $self->linearized_isa;
785 shift @cpl; # discard ourselves
786 foreach my $class (@cpl) {
787 # fetch the meta-class ...
788 my $meta = $self->initialize($class);
789 return $meta->get_method($method_name)
790 if $meta->has_method($method_name);
799 # either we have an attribute object already
800 # or we need to create one from the args provided
801 my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_);
802 # make sure it is derived from the correct type though
803 ($attribute->isa('Class::MOP::Attribute'))
804 || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";
806 # first we attach our new attribute
807 # because it might need certain information
808 # about the class which it is attached to
809 $attribute->attach_to_class($self);
811 # then we remove attributes of a conflicting
812 # name here so that we can properly detach
813 # the old attr object, and remove any
814 # accessors it would have generated
815 if ( $self->has_attribute($attribute->name) ) {
816 $self->remove_attribute($attribute->name);
818 $self->invalidate_meta_instances();
821 # then onto installing the new accessors
822 $self->get_attribute_map->{$attribute->name} = $attribute;
824 # invalidate package flag here
825 my $e = do { local $@; eval { $attribute->install_accessors() }; $@ };
827 $self->remove_attribute($attribute->name);
834 sub update_meta_instance_dependencies {
837 if ( $self->{meta_instance_dependencies} ) {
838 return $self->add_meta_instance_dependencies;
842 sub add_meta_instance_dependencies {
845 $self->remove_meta_instance_dependencies;
847 my @attrs = $self->compute_all_applicable_attributes();
850 my @classes = grep { not $seen{$_->name}++ } map { $_->associated_class } @attrs;
852 foreach my $class ( @classes ) {
853 $class->add_dependent_meta_instance($self);
856 $self->{meta_instance_dependencies} = \@classes;
859 sub remove_meta_instance_dependencies {
862 if ( my $classes = delete $self->{meta_instance_dependencies} ) {
863 foreach my $class ( @$classes ) {
864 $class->remove_dependent_meta_instance($self);
874 sub add_dependent_meta_instance {
875 my ( $self, $metaclass ) = @_;
876 push @{ $self->{dependent_meta_instances} }, $metaclass;
879 sub remove_dependent_meta_instance {
880 my ( $self, $metaclass ) = @_;
881 my $name = $metaclass->name;
882 @$_ = grep { $_->name ne $name } @$_ for $self->{dependent_meta_instances};
885 sub invalidate_meta_instances {
887 $_->invalidate_meta_instance() for $self, @{ $self->{dependent_meta_instances} };
890 sub invalidate_meta_instance {
892 undef $self->{_meta_instance};
896 my ($self, $attribute_name) = @_;
897 (defined $attribute_name && $attribute_name)
898 || confess "You must define an attribute name";
899 exists $self->get_attribute_map->{$attribute_name};
903 my ($self, $attribute_name) = @_;
904 (defined $attribute_name && $attribute_name)
905 || confess "You must define an attribute name";
906 return $self->get_attribute_map->{$attribute_name}
908 # this will return undef anyway, so no need ...
909 # if $self->has_attribute($attribute_name);
913 sub remove_attribute {
914 my ($self, $attribute_name) = @_;
915 (defined $attribute_name && $attribute_name)
916 || confess "You must define an attribute name";
917 my $removed_attribute = $self->get_attribute_map->{$attribute_name};
918 return unless defined $removed_attribute;
919 delete $self->get_attribute_map->{$attribute_name};
920 $self->invalidate_meta_instances();
921 $removed_attribute->remove_accessors();
922 $removed_attribute->detach_from_class();
923 return $removed_attribute;
926 sub get_attribute_list {
928 keys %{$self->get_attribute_map};
931 sub get_all_attributes {
932 shift->compute_all_applicable_attributes(@_);
935 sub compute_all_applicable_attributes {
937 my %attrs = map { %{ $self->initialize($_)->get_attribute_map } } reverse $self->linearized_isa;
938 return values %attrs;
941 sub find_attribute_by_name {
942 my ($self, $attr_name) = @_;
943 foreach my $class ($self->linearized_isa) {
944 # fetch the meta-class ...
945 my $meta = $self->initialize($class);
946 return $meta->get_attribute($attr_name)
947 if $meta->has_attribute($attr_name);
952 # check if we can reinitialize
956 # if any local attr is defined
957 return if $self->get_attribute_list;
959 # or any non-declared methods
960 if ( my @methods = values %{ $self->get_method_map } ) {
961 my $metaclass = $self->method_metaclass;
962 foreach my $method ( @methods ) {
963 return if $method->isa("Class::MOP::Method::Generated");
964 # FIXME do we need to enforce this too? return unless $method->isa($metaclass);
974 sub is_immutable { 0 }
976 sub immutable_transformer { $_[0]->{immutable_transformer} }
977 sub _set_immutable_transformer { $_[0]->{immutable_transformer} = $_[1] }
982 return if $self->is_immutable;
984 my $transformer = $self->immutable_transformer
985 || $self->_make_immutable_transformer(@_);
987 $self->_set_immutable_transformer($transformer);
989 $transformer->make_metaclass_immutable;
993 my %Default_Immutable_Options = (
994 read_only => [qw/superclasses/],
1002 remove_package_symbol
1006 class_precedence_list => 'ARRAY',
1007 # FIXME perl 5.10 memoizes this on its own, no need?
1008 linearized_isa => 'ARRAY',
1009 get_all_methods => 'ARRAY',
1010 get_all_method_names => 'ARRAY',
1011 compute_all_applicable_attributes => 'ARRAY',
1012 get_meta_instance => 'SCALAR',
1013 get_method_map => 'SCALAR',
1017 # this is ugly, but so are typeglobs,
1018 # so whattayahgonnadoboutit
1021 add_package_symbol => sub {
1022 my $original = shift;
1023 confess "Cannot add package symbols to an immutable metaclass"
1024 unless ( caller(2) )[3] eq
1025 'Class::MOP::Package::get_package_symbol';
1027 # This is a workaround for a bug in 5.8.1 which thinks that
1028 # goto $original->body
1029 # is trying to go to a label
1030 my $body = $original->body;
1036 sub _default_immutable_transformer_options {
1037 return %Default_Immutable_Options;
1041 sub _make_immutable_transformer {
1044 Class::MOP::Immutable->new(
1046 $self->_default_immutable_transformer_options,
1054 return if $self->is_mutable;
1056 $self->immutable_transformer->make_metaclass_mutable;
1067 Class::MOP::Class - Class Meta Object
1071 # assuming that class Foo
1072 # has been defined, you can
1074 # use this for introspection ...
1076 # add a method to Foo ...
1077 Foo->meta->add_method( 'bar' => sub {...} )
1079 # get a list of all the classes searched
1080 # the method dispatcher in the correct order
1081 Foo->meta->class_precedence_list()
1083 # remove a method from Foo
1084 Foo->meta->remove_method('bar');
1086 # or use this to actually create classes ...
1088 Class::MOP::Class->create(
1091 superclasses => ['Foo'],
1093 Class::MOP:: : Attribute->new('$bar'),
1094 Class::MOP:: : Attribute->new('$baz'),
1097 calculate_bar => sub {...},
1098 construct_baz => sub {...}
1105 The Class Protocol is the largest and most complex part of the
1106 Class::MOP meta-object protocol. It controls the introspection and
1107 manipulation of Perl 5 classes, and it can create them as well. The
1108 best way to understand what this module can do, is to read the
1109 documentation for each of its methods.
1113 C<Class::MOP::Class> is a subclass of L<Class::MOP::Module>.
1117 =head2 Class construction
1119 These methods all create new C<Class::MOP::Class> objects. These
1120 objects can represent existing classes, or they can be used to create
1121 new classes from scratch.
1123 The metaclass object for a given class is a singleton. If you attempt
1124 to create a metaclass for the same class twice, you will just get the
1129 =item B<< Class::MOP::Class->create($package_name, %options) >>
1131 This method creates a new C<Class::MOP::Class> object with the given
1132 package name. It accepts a number of options.
1138 An optional version number for the newly created package.
1142 An optional authority for the newly created package.
1144 =item * superclasses
1146 An optional array reference of superclass names.
1150 An optional hash reference of methods for the class. The keys of the
1151 hash reference are method names, and values are subroutine references.
1155 An optional array reference of attributes.
1157 An attribute can be passed as an existing L<Class::MOP::Attribute>
1158 object, I<or> or as a hash reference of options which will be passed
1159 to the attribute metaclass's constructor.
1163 =item B<< Class::MOP::Class->create_anon_class(%options) >>
1165 This method works just like C<< Class::MOP::Class->create >> but it
1166 creates an "anonymous" class. In fact, the class does have a name, but
1167 that name is a unique name generated internally by this module.
1169 It accepts the same C<superclasses>, C<methods>, and C<attributes>
1170 parameters that C<create> accepts.
1172 Anonymous classes are destroyed once the metaclass they are attached
1173 to goes out of scope, and will be removed from Perl's internal symbol
1176 All instances of an anonymous class keep a special reference to the
1177 metaclass object, which prevents the metaclass from going out of scope
1178 while any instances exist.
1180 This only works if the instance if based on a hash reference, however.
1182 =item B<< Class::MOP::Class->initialize($package_name, %options) >>
1184 This method will initialize a C<Class::MOP::Class> object for the
1185 named package. Unlike C<create>, this method I<will not> create a new
1188 The purpose of this method is to retrieve a C<Class::MOP::Class>
1189 object for introspecting an existing class.
1191 If an existing C<Class::MOP::Class> object exists for the named
1192 package, it will be returned, and any options provided will be
1195 If the object does not yet exist, it will be created.
1197 The valid options that can be passed to this method are
1198 C<attribute_metaclass>, C<method_metaclass>,
1199 C<wrapped_method_metaclass>, and C<instance_metaclass>. These are all
1200 optional, and default to the appropriate class in the C<Class::MOP>
1205 =head2 Object instance construction and cloning
1207 These methods are all related to creating and/or cloning object
1212 =item B<< $metaclass->clone_object($instance, %params) >>
1214 This method clones an existing object instance. Any parameters you
1215 provide are will override existing attribute values in the object.
1217 This is a convenience method for cloning an object instance, then
1218 blessing it into the appropriate package.
1220 You could implement a clone method in your class, using this method:
1223 my ($self, %params) = @_;
1224 $self->meta->clone_object($self, %params);
1227 =item B<< $metaclass->rebless_instance($instance, %params) >>
1229 This method changes the class of C<$instance> to the metaclass's class.
1231 You can only rebless an instance into a subclass of its current
1232 class. If you pass any additional parameters, these will be treated
1233 like constructor parameters and used to initialize the object's
1234 attributes. Any existing attributes that are already set will be
1237 Before reblessing the instance, this method will call
1238 C<rebless_instance_away> on the instance's current metaclass. This method
1239 will be passed the instance, the new metaclass, and any parameters
1240 specified to C<rebless_instance>. By default, C<rebless_instance_away>
1241 does nothing; it is merely a hook.
1243 =item B<< $metaclass->new_object(%params) >>
1245 This method is used to create a new object of the metaclass's
1246 class. Any parameters you provide are used to initialize the
1247 instance's attributes.
1249 =item B<< $metaclass->instance_metaclass >>
1251 Returns the class name of the instance metaclass, see
1252 L<Class::MOP::Instance> for more information on the instance
1255 =item B<< $metaclass->get_meta_instance >>
1257 Returns an instance of the C<instance_metaclass> to be used in the
1258 construction of a new instance of the class.
1262 =head2 Informational predicates
1264 These are a few predicate methods for asking information about the
1269 =item B<< $metaclass->is_anon_class >>
1271 This returns true if the class was created by calling C<<
1272 Class::MOP::Class->create_anon_class >>.
1274 =item B<< $metaclass->is_mutable >>
1276 This returns true if the class is still mutable.
1278 =item B<< $metaclass->is_immutable >>
1280 This returns true if the class has been made immutable.
1282 =item B<< $metaclass->is_pristine >>
1284 A class is I<not> pristine if it has non-inherited attributes or if it
1285 has any generated methods.
1289 =head2 Inheritance Relationships
1293 =item B<< $metaclass->superclasses(@superclasses) >>
1295 This is a read-write accessor which represents the superclass
1296 relationships of the metaclass's class.
1298 This is basically sugar around getting and setting C<@ISA>.
1300 =item B<< $metaclass->class_precedence_list >>
1302 This returns a list of all of the class's ancestor classes. The
1303 classes are returned in method dispatch order.
1305 =item B<< $metaclass->linearized_isa >>
1307 This returns a list based on C<class_precedence_list> but with all
1310 =item B<< $metaclass->subclasses >>
1312 This returns a list of subclasses for this class.
1316 =head2 Method introspection and creation
1318 These methods allow you to introspect a class's methods, as well as
1319 add, remove, or change methods.
1321 Determining what is truly a method in a Perl 5 class requires some
1322 heuristics (aka guessing).
1324 Methods defined outside the package with a fully qualified name (C<sub
1325 Package::name { ... }>) will be included. Similarly, methods named
1326 with a fully qualified name using L<Sub::Name> are also included.
1328 However, we attempt to ignore imported functions.
1330 Ultimately, we are using heuristics to determine what truly is a
1331 method in a class, and these heuristics may get the wrong answer in
1332 some edge cases. However, for most "normal" cases the heuristics work
1337 =item B<< $metaclass->get_method($method_name) >>
1339 This will return a L<Class::MOP::Method> for the specified
1340 C<$method_name>. If the class does not have the specified method, it
1343 =item B<< $metaclass->has_method($method_name) >>
1345 Returns a boolean indicating whether or not the class defines the
1346 named method. It does not include methods inherited from parent
1349 =item B<< $metaclass->get_method_map >>
1351 Returns a hash reference representing the methods defined in this
1352 class. The keys are method names and the values are
1353 L<Class::MOP::Method> objects.
1355 =item B<< $metaclass->get_method_list >>
1357 This will return a list of method I<names> for all methods defined in
1360 =item B<< $metaclass->get_all_methods >>
1362 This will traverse the inheritance hierarchy and return a list of all
1363 the L<Class::MOP::Method> objects for this class and its parents.
1365 =item B<< $metaclass->find_method_by_name($method_name) >>
1367 This will return a L<Class::MOP::Method> for the specified
1368 C<$method_name>. If the class does not have the specified method, it
1371 Unlike C<get_method>, this method I<will> look for the named method in
1374 =item B<< $metaclass->get_all_method_names >>
1376 This will return a list of method I<names> for all of this class's
1377 methods, including inherited methods.
1379 =item B<< $metaclass->find_all_methods_by_name($method_name) >>
1381 This method looks for the named method in the class and all of its
1382 parents. It returns every matching method it finds in the inheritance
1383 tree, so it returns a list of methods.
1385 Each method is returned as a hash reference with three keys. The keys
1386 are C<name>, C<class>, and C<code>. The C<code> key has a
1387 L<Class::MOP::Method> object as its value.
1389 The list of methods is distinct.
1391 =item B<< $metaclass->find_next_method_by_name($method_name) >>
1393 This method returns the first method in any superclass matching the
1394 given name. It is effectively the method that C<SUPER::$method_name>
1397 =item B<< $metaclass->add_method($method_name, $method) >>
1399 This method takes a method name and a subroutine reference, and adds
1400 the method to the class.
1402 The subroutine reference can be a L<Class::MOP::Method>, and you are
1403 strongly encouraged to pass a meta method object instead of a code
1404 reference. If you do so, that object gets stored as part of the
1405 class's method map directly. If not, the meta information will have to
1406 be recreated later, and may be incorrect.
1408 If you provide a method object, this method will clone that object if
1409 the object's package name does not match the class name. This lets us
1410 track the original source of any methods added from other classes
1411 (notably Moose roles).
1413 =item B<< $metaclass->remove_method($method_name) >>
1415 Remove the named method from the class. This method returns the
1416 L<Class::MOP::Method> object for the method.
1418 =item B<< $metaclass->method_metaclass >>
1420 Returns the class name of the method metaclass, see
1421 L<Class::MOP::Method> for more information on the method metaclass.
1423 =item B<< $metaclass->wrapped_method_metaclass >>
1425 Returns the class name of the wrapped method metaclass, see
1426 L<Class::MOP::Method::Wrapped> for more information on the wrapped
1431 =head2 Attribute introspection and creation
1433 Because Perl 5 does not have a core concept of attributes in classes,
1434 we can only return information about attributes which have been added
1435 via this class's methods. We cannot discover information about
1436 attributes which are defined in terms of "regular" Perl 5 methods.
1440 =item B<< $metaclass->get_attribute($attribute_name) >>
1442 This will return a L<Class::MOP::Attribute> for the specified
1443 C<$attribute_name>. If the class does not have the specified
1444 attribute, it returns C<undef>
1446 =item B<< $metaclass->has_attribute($attribute_name) >>
1448 Returns a boolean indicating whether or not the class defines the
1449 named attribute. It does not include attributes inherited from parent
1452 =item B<< $metaclass->get_attribute_map >>
1454 Returns a hash reference representing the attributes defined in this
1455 class. The keys are attribute names and the values are
1456 L<Class::MOP::Attribute> objects.
1458 =item B<< $metaclass->get_attribute_list >>
1460 This will return a list of attributes I<names> for all attributes
1461 defined in this class.
1463 =item B<< $metaclass->get_all_attributes >>
1465 This will traverse the inheritance hierarchy and return a list of all
1466 the L<Class::MOP::Attribute> objects for this class and its parents.
1468 This method can also be called as C<compute_all_applicable_attributes>.
1470 =item B<< $metaclass->find_attribute_by_name($attribute_name) >>
1472 This will return a L<Class::MOP::Attribute> for the specified
1473 C<$attribute_name>. If the class does not have the specified
1474 attribute, it returns C<undef>
1476 Unlike C<get_attribute>, this attribute I<will> look for the named
1477 attribute in superclasses.
1479 =item B<< $metaclass->add_attribute(...) >>
1481 This method accepts either an existing L<Class::MOP::Attribute>
1482 object, or parameters suitable for passing to that class's C<new>
1485 The attribute provided will be added to the class.
1487 Any accessor methods defined by the attribute will be added to the
1488 class when the attribute is added.
1490 If an attribute of the same name already exists, the old attribute
1491 will be removed first.
1493 =item B<< $metaclass->remove_attribute($attribute_name) >>
1495 This will remove the named attribute from the class, and
1496 L<Class::MOP::Attribute> object.
1498 Removing an attribute also removes any accessor methods defined by the
1501 However, note that removing an attribute will only affect I<future>
1502 object instances created for this class, not existing instances.
1504 =item B<< $metaclass->attribute_metaclass >>
1506 Returns the class name of the attribute metaclass for this class. By
1507 default, this is L<Class::MOP::Attribute>. for more information on
1511 =head2 Class Immutability
1513 Making a class immutable "freezes" the class definition. You can no
1514 longer call methods which alter the class, such as adding or removing
1515 methods or attributes.
1517 Making a class immutable lets us optimize the class by inlining some
1518 methods, and also allows us to optimize some methods on the metaclass
1521 The immutabilization system in L<Moose> takes much greater advantage
1522 of the inlining features than Class::MOP itself does.
1526 =item B<< $metaclass->make_immutable(%options) >>
1528 This method will create an immutable transformer and uses it to make
1529 the class and its metaclass object immutable.
1531 Details of how immutabilization works are in L<Class::MOP::Immutable>
1534 =item B<< $metaclass->make_mutable >>
1536 Calling this method reverse the immutabilization transformation.
1538 =item B<< $metaclass->immutable_transformer >>
1540 If the class has been made immutable previously, this returns the
1541 L<Class::MOP::Immutable> object that was created to do the
1544 If the class was never made immutable, this method will die.
1548 =head2 Method Modifiers
1550 Method modifiers are hooks which allow a method to be wrapped with
1551 I<before>, I<after> and I<around> method modifiers. Every time a
1552 method is called, it's modifiers are also called.
1554 A class can modify its own methods, as well as methods defined in
1557 =head3 How method modifiers work?
1559 Method modifiers work by wrapping the original method and then
1560 replacing it in the class's symbol table. The wrappers will handle
1561 calling all the modifiers in the appropriate order and preserving the
1562 calling context for the original method.
1564 The return values of C<before> and C<after> modifiers are
1565 ignored. This is because their purpose is B<not> to filter the input
1566 and output of the primary method (this is done with an I<around>
1569 This may seem like an odd restriction to some, but doing this allows
1570 for simple code to be added at the beginning or end of a method call
1571 without altering the function of the wrapped method or placing any
1572 extra responsibility on the code of the modifier.
1574 Of course if you have more complex needs, you can use the C<around>
1575 modifier which allows you to change both the parameters passed to the
1576 wrapped method, as well as its return value.
1578 Before and around modifiers are called in last-defined-first-called
1579 order, while after modifiers are called in first-defined-first-called
1580 order. So the call tree might looks something like this:
1592 =head3 What is the performance impact?
1594 Of course there is a performance cost associated with method
1595 modifiers, but we have made every effort to make that cost directly
1596 proportional to the number of modifier features you utilize.
1598 The wrapping method does it's best to B<only> do as much work as it
1599 absolutely needs to. In order to do this we have moved some of the
1600 performance costs to set-up time, where they are easier to amortize.
1602 All this said, our benchmarks have indicated the following:
1604 simple wrapper with no modifiers 100% slower
1605 simple wrapper with simple before modifier 400% slower
1606 simple wrapper with simple after modifier 450% slower
1607 simple wrapper with simple around modifier 500-550% slower
1608 simple wrapper with all 3 modifiers 1100% slower
1610 These numbers may seem daunting, but you must remember, every feature
1611 comes with some cost. To put things in perspective, just doing a
1612 simple C<AUTOLOAD> which does nothing but extract the name of the
1613 method called and return it costs about 400% over a normal method
1618 =item B<< $metaclass->add_before_method_modifier($method_name, $code) >>
1620 This wraps the specified method with the supplied subroutine
1621 reference. The modifier will be called as a method itself, and will
1622 receive the same arguments as are passed to the method.
1624 When the modifier exits, the wrapped method will be called.
1626 The return value of the modifier will be ignored.
1628 =item B<< $metaclass->add_after_method_modifier($method_name, $code) >>
1630 This wraps the specified method with the supplied subroutine
1631 reference. The modifier will be called as a method itself, and will
1632 receive the same arguments as are passed to the method.
1634 When the wrapped methods exits, the modifier will be called.
1636 The return value of the modifier will be ignored.
1638 =item B<< $metaclass->add_around_method_modifier($method_name, $code) >>
1640 This wraps the specified method with the supplied subroutine
1643 The first argument passed to the modifier will be a subroutine
1644 reference to the wrapped method. The second argument is the object,
1645 and after that come any arguments passed when the method is called.
1647 The around modifier can choose to call the original method, as well as
1648 what arguments to pass if it does so.
1650 The return value of the modifier is what will be seen by the caller.
1654 =head2 Introspection
1658 =item B<< Class::MOP::Class->meta >>
1660 This will return a L<Class::MOP::Class> instance for this class.
1662 It should also be noted that L<Class::MOP> will actually bootstrap
1663 this module by installing a number of attribute meta-objects into its
1670 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1672 =head1 COPYRIGHT AND LICENSE
1674 Copyright 2006-2009 by Infinity Interactive, Inc.
1676 L<http://www.iinteractive.com>
1678 This library is free software; you can redistribute it and/or modify
1679 it under the same terms as Perl itself.