2 package Class::MOP::Class;
7 use Class::MOP::Instance;
8 use Class::MOP::Method::Wrapped;
9 use Class::MOP::Method::Accessor;
10 use Class::MOP::Method::Constructor;
11 use Class::MOP::MiniTrait;
14 use Class::Load 'is_class_loaded', 'load_class';
15 use Scalar::Util 'blessed', 'reftype', 'weaken';
16 use Sub::Name 'subname';
18 use List::MoreUtils 'all';
20 use base 'Class::MOP::Module',
21 'Class::MOP::Mixin::HasAttributes',
22 'Class::MOP::Mixin::HasMethods';
32 $package_name = shift;
35 $package_name = $options{package};
38 ($package_name && !ref($package_name))
39 || confess "You must pass a package name and it cannot be blessed";
41 return Class::MOP::get_metaclass_by_name($package_name)
42 || $class->_construct_class_instance(package => $package_name, @_);
46 my ( $class, @args ) = @_;
47 unshift @args, "package" if @args % 2;
49 my $old_metaclass = blessed($options{package})
51 : Class::MOP::get_metaclass_by_name($options{package});
52 $options{weaken} = Class::MOP::metaclass_is_weak($old_metaclass->name)
53 if !exists $options{weaken}
54 && blessed($old_metaclass)
55 && $old_metaclass->isa('Class::MOP::Class');
56 $old_metaclass->_remove_generated_metaobjects
57 if $old_metaclass && $old_metaclass->isa('Class::MOP::Class');
58 my $new_metaclass = $class->SUPER::reinitialize(%options);
59 $new_metaclass->_restore_metaobjects_from($old_metaclass)
60 if $old_metaclass && $old_metaclass->isa('Class::MOP::Class');
61 return $new_metaclass;
64 # NOTE: (meta-circularity)
65 # this is a special form of _construct_instance
66 # (see below), which is used to construct class
67 # meta-object instances for any Class::MOP::*
68 # class. All other classes will use the more
69 # normal &construct_instance.
70 sub _construct_class_instance {
72 my $options = @_ == 1 ? $_[0] : {@_};
73 my $package_name = $options->{package};
74 (defined $package_name && $package_name)
75 || confess "You must pass a package name";
77 # return the metaclass if we have it cached,
78 # and it is still defined (it has not been
79 # reaped by DESTROY yet, which can happen
80 # annoyingly enough during global destruction)
82 if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) {
88 ? $class->_real_ref_name
91 # now create the metaclass
93 if ($class eq 'Class::MOP::Class') {
94 $meta = $class->_new($options);
98 # it is safe to use meta here because
99 # class will always be a subclass of
100 # Class::MOP::Class, which defines meta
101 $meta = $class->meta->_construct_instance($options)
104 # and check the metaclass compatibility
105 $meta->_check_metaclass_compatibility();
107 Class::MOP::store_metaclass_by_name($package_name, $meta);
110 # we need to weaken any anon classes
111 # so that they can call DESTROY properly
112 Class::MOP::weaken_metaclass($package_name) if $options->{weaken};
120 # NOTE: we need to deal with the possibility of class immutability here,
121 # and then get the name of the class appropriately
122 return $self->is_immutable
123 ? $self->_get_mutable_metaclass_name()
130 return Class::MOP::Class->initialize($class)->new_object(@_)
131 if $class ne __PACKAGE__;
133 my $options = @_ == 1 ? $_[0] : {@_};
136 # inherited from Class::MOP::Package
137 'package' => $options->{package},
140 # since the following attributes will
141 # actually be loaded from the symbol
142 # table, and actually bypass the instance
143 # entirely, we can just leave these things
144 # listed here for reference, because they
145 # should not actually have a value associated
147 'namespace' => \undef,
150 # inherited from Class::MOP::Module
152 'authority' => \undef,
154 # defined in Class::MOP::Class
155 'superclasses' => \undef,
158 'attribute_metaclass' =>
159 ( $options->{'attribute_metaclass'} || 'Class::MOP::Attribute' ),
160 'method_metaclass' =>
161 ( $options->{'method_metaclass'} || 'Class::MOP::Method' ),
162 'wrapped_method_metaclass' => (
163 $options->{'wrapped_method_metaclass'}
164 || 'Class::MOP::Method::Wrapped'
166 'instance_metaclass' =>
167 ( $options->{'instance_metaclass'} || 'Class::MOP::Instance' ),
168 'immutable_trait' => (
169 $options->{'immutable_trait'}
170 || 'Class::MOP::Class::Immutable::Trait'
172 'constructor_name' => ( $options->{constructor_name} || 'new' ),
173 'constructor_class' => (
174 $options->{constructor_class} || 'Class::MOP::Method::Constructor'
176 'destructor_class' => $options->{destructor_class},
180 ## Metaclass compatibility
182 my %base_metaclass = (
183 attribute_metaclass => 'Class::MOP::Attribute',
184 method_metaclass => 'Class::MOP::Method',
185 wrapped_method_metaclass => 'Class::MOP::Method::Wrapped',
186 instance_metaclass => 'Class::MOP::Instance',
187 constructor_class => 'Class::MOP::Method::Constructor',
188 destructor_class => 'Class::MOP::Method::Destructor',
191 sub _base_metaclasses { %base_metaclass }
194 sub _check_metaclass_compatibility {
197 my @superclasses = $self->superclasses
200 $self->_fix_metaclass_incompatibility(@superclasses);
202 my %base_metaclass = $self->_base_metaclasses;
204 # this is always okay ...
206 if ref($self) eq 'Class::MOP::Class'
208 my $meta = $self->$_;
209 !defined($meta) || $meta eq $base_metaclass{$_};
211 keys %base_metaclass;
213 for my $superclass (@superclasses) {
214 $self->_check_class_metaclass_compatibility($superclass);
217 for my $metaclass_type ( keys %base_metaclass ) {
218 next unless defined $self->$metaclass_type;
219 for my $superclass (@superclasses) {
220 $self->_check_single_metaclass_compatibility( $metaclass_type,
226 sub _check_class_metaclass_compatibility {
228 my ( $superclass_name ) = @_;
230 if (!$self->_class_metaclass_is_compatible($superclass_name)) {
231 my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name);
233 my $super_meta_type = $super_meta->_real_ref_name;
235 confess "The metaclass of " . $self->name . " ("
236 . (ref($self)) . ")" . " is not compatible with "
237 . "the metaclass of its superclass, "
238 . $superclass_name . " (" . ($super_meta_type) . ")";
242 sub _class_metaclass_is_compatible {
244 my ( $superclass_name ) = @_;
246 my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name)
249 my $super_meta_name = $super_meta->_real_ref_name;
251 return $self->_is_compatible_with($super_meta_name);
254 sub _check_single_metaclass_compatibility {
256 my ( $metaclass_type, $superclass_name ) = @_;
258 if (!$self->_single_metaclass_is_compatible($metaclass_type, $superclass_name)) {
259 my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name);
260 my $metaclass_type_name = $metaclass_type;
261 $metaclass_type_name =~ s/_(?:meta)?class$//;
262 $metaclass_type_name =~ s/_/ /g;
263 confess "The $metaclass_type_name metaclass for "
264 . $self->name . " (" . ($self->$metaclass_type)
265 . ")" . " is not compatible with the "
266 . "$metaclass_type_name metaclass of its "
267 . "superclass, $superclass_name ("
268 . ($super_meta->$metaclass_type) . ")";
272 sub _single_metaclass_is_compatible {
274 my ( $metaclass_type, $superclass_name ) = @_;
276 my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name)
279 # for instance, Moose::Meta::Class has a error_class attribute, but
280 # Class::MOP::Class doesn't - this shouldn't be an error
281 return 1 unless $super_meta->can($metaclass_type);
282 # for instance, Moose::Meta::Class has a destructor_class, but
283 # Class::MOP::Class doesn't - this shouldn't be an error
284 return 1 unless defined $super_meta->$metaclass_type;
285 # if metaclass is defined in superclass but not here, it's not compatible
286 # this is a really odd case
287 return 0 unless defined $self->$metaclass_type;
289 return $self->$metaclass_type->_is_compatible_with($super_meta->$metaclass_type);
292 sub _fix_metaclass_incompatibility {
294 my @supers = map { Class::MOP::Class->initialize($_) } @_;
297 for my $super (@supers) {
299 if $self->_can_fix_metaclass_incompatibility($super);
301 return unless $necessary;
303 for my $super (@supers) {
304 if (!$self->_class_metaclass_is_compatible($super->name)) {
305 $self->_fix_class_metaclass_incompatibility($super);
309 my %base_metaclass = $self->_base_metaclasses;
310 for my $metaclass_type (keys %base_metaclass) {
311 for my $super (@supers) {
312 if (!$self->_single_metaclass_is_compatible($metaclass_type, $super->name)) {
313 $self->_fix_single_metaclass_incompatibility(
314 $metaclass_type, $super
321 sub _can_fix_metaclass_incompatibility {
323 my ($super_meta) = @_;
325 return 1 if $self->_class_metaclass_can_be_made_compatible($super_meta);
327 my %base_metaclass = $self->_base_metaclasses;
328 for my $metaclass_type (keys %base_metaclass) {
329 return 1 if $self->_single_metaclass_can_be_made_compatible($super_meta, $metaclass_type);
335 sub _class_metaclass_can_be_made_compatible {
337 my ($super_meta) = @_;
339 return $self->_can_be_made_compatible_with($super_meta->_real_ref_name);
342 sub _single_metaclass_can_be_made_compatible {
344 my ($super_meta, $metaclass_type) = @_;
346 my $specific_meta = $self->$metaclass_type;
348 return unless $super_meta->can($metaclass_type);
349 my $super_specific_meta = $super_meta->$metaclass_type;
351 # for instance, Moose::Meta::Class has a destructor_class, but
352 # Class::MOP::Class doesn't - this shouldn't be an error
353 return unless defined $super_specific_meta;
355 # if metaclass is defined in superclass but not here, it's fixable
356 # this is a really odd case
357 return 1 unless defined $specific_meta;
359 return 1 if $specific_meta->_can_be_made_compatible_with($super_specific_meta);
362 sub _fix_class_metaclass_incompatibility {
364 my ( $super_meta ) = @_;
366 if ($self->_class_metaclass_can_be_made_compatible($super_meta)) {
368 || confess "Can't fix metaclass incompatibility for "
370 . " because it is not pristine.";
372 my $super_meta_name = $super_meta->_real_ref_name;
374 $self->_make_compatible_with($super_meta_name);
378 sub _fix_single_metaclass_incompatibility {
380 my ( $metaclass_type, $super_meta ) = @_;
382 if ($self->_single_metaclass_can_be_made_compatible($super_meta, $metaclass_type)) {
384 || confess "Can't fix metaclass incompatibility for "
386 . " because it is not pristine.";
388 my $new_metaclass = $self->$metaclass_type
389 ? $self->$metaclass_type->_get_compatible_metaclass($super_meta->$metaclass_type)
390 : $super_meta->$metaclass_type;
391 $self->{$metaclass_type} = $new_metaclass;
395 sub _restore_metaobjects_from {
399 $self->_restore_metamethods_from($old_meta);
400 $self->_restore_metaattributes_from($old_meta);
403 sub _remove_generated_metaobjects {
406 for my $attr (map { $self->get_attribute($_) } $self->get_attribute_list) {
407 $attr->remove_accessors;
411 # creating classes with MOP ...
417 unshift @args, 'package' if @args % 2 == 1;
420 (ref $options{superclasses} eq 'ARRAY')
421 || confess "You must pass an ARRAY ref of superclasses"
422 if exists $options{superclasses};
424 (ref $options{attributes} eq 'ARRAY')
425 || confess "You must pass an ARRAY ref of attributes"
426 if exists $options{attributes};
428 (ref $options{methods} eq 'HASH')
429 || confess "You must pass a HASH ref of methods"
430 if exists $options{methods};
432 my $package = delete $options{package};
433 my $superclasses = delete $options{superclasses};
434 my $attributes = delete $options{attributes};
435 my $methods = delete $options{methods};
436 my $meta_name = exists $options{meta_name}
437 ? delete $options{meta_name}
440 my $meta = $class->SUPER::create($package => %options);
442 $meta->_add_meta_method($meta_name)
443 if defined $meta_name;
445 $meta->superclasses(@{$superclasses})
446 if defined $superclasses;
448 # process attributes first, so that they can
449 # install accessors, but locally defined methods
450 # can then overwrite them. It is maybe a little odd, but
451 # I think this should be the order of things.
452 if (defined $attributes) {
453 foreach my $attr (@{$attributes}) {
454 $meta->add_attribute($attr);
457 if (defined $methods) {
458 foreach my $method_name (keys %{$methods}) {
459 $meta->add_method($method_name, $methods->{$method_name});
465 # XXX: something more intelligent here?
466 sub _anon_package_prefix { 'Class::MOP::Class::__ANON__::SERIAL::' }
468 sub create_anon_class { shift->create_anon(@_) }
469 sub is_anon_class { shift->is_anon(@_) }
471 sub _anon_cache_key {
474 # Makes something like Super::Class|Super::Class::2
476 join( '|', sort @{ $options{superclasses} || [] } ),
480 # Instance Construction & Cloning
486 # we need to protect the integrity of the
487 # Class::MOP::Class singletons here, so we
488 # delegate this to &construct_class_instance
489 # which will deal with the singletons
490 return $class->_construct_class_instance(@_)
491 if $class->name->isa('Class::MOP::Class');
492 return $class->_construct_instance(@_);
495 sub _construct_instance {
497 my $params = @_ == 1 ? $_[0] : {@_};
498 my $meta_instance = $class->get_meta_instance();
500 # the code below is almost certainly incorrect
501 # but this is foreign inheritance, so we might
502 # have to kludge it in the end.
504 if (my $instance_class = blessed($params->{__INSTANCE__})) {
505 ($instance_class eq $class->name)
506 || confess "Objects passed as the __INSTANCE__ parameter must "
507 . "already be blessed into the correct class, but "
508 . "$params->{__INSTANCE__} is not a " . $class->name;
509 $instance = $params->{__INSTANCE__};
511 elsif (exists $params->{__INSTANCE__}) {
512 confess "The __INSTANCE__ parameter must be a blessed reference, not "
513 . $params->{__INSTANCE__};
516 $instance = $meta_instance->create_instance();
518 foreach my $attr ($class->get_all_attributes()) {
519 $attr->initialize_instance_slot($meta_instance, $instance, $params);
521 if (Class::MOP::metaclass_is_weak($class->name)) {
522 $meta_instance->_set_mop_slot($instance, $class);
527 sub _inline_new_object {
531 'my $class = shift;',
532 '$class = Scalar::Util::blessed($class) || $class;',
533 $self->_inline_fallback_constructor('$class'),
534 $self->_inline_params('$params', '$class'),
535 $self->_inline_generate_instance('$instance', '$class'),
536 $self->_inline_slot_initializers,
537 $self->_inline_preserve_weak_metaclasses,
538 $self->_inline_extra_init,
543 sub _inline_fallback_constructor {
547 'return ' . $self->_generate_fallback_constructor($class),
548 'if ' . $class . ' ne \'' . $self->name . '\';',
552 sub _generate_fallback_constructor {
555 return 'Class::MOP::Class->initialize(' . $class . ')->new_object(@_)',
560 my ($params, $class) = @_;
562 'my ' . $params . ' = @_ == 1 ? $_[0] : {@_};',
566 sub _inline_generate_instance {
568 my ($inst, $class) = @_;
570 'my ' . $inst . ' = ' . $self->_inline_create_instance($class) . ';',
574 sub _inline_create_instance {
577 return $self->get_meta_instance->inline_create_instance(@_);
580 sub _inline_slot_initializers {
585 return map { $self->_inline_slot_initializer($_, $idx++) }
586 sort { $a->name cmp $b->name } $self->get_all_attributes;
589 sub _inline_slot_initializer {
591 my ($attr, $idx) = @_;
593 if (defined(my $init_arg = $attr->init_arg)) {
595 'if (exists $params->{\'' . $init_arg . '\'}) {',
596 $self->_inline_init_attr_from_constructor($attr, $idx),
599 if (my @default = $self->_inline_init_attr_from_default($attr, $idx)) {
608 elsif (my @default = $self->_inline_init_attr_from_default($attr, $idx)) {
620 sub _inline_init_attr_from_constructor {
622 my ($attr, $idx) = @_;
624 my @initial_value = $attr->_inline_set_value(
625 '$instance', '$params->{\'' . $attr->init_arg . '\'}',
628 push @initial_value, (
629 '$attrs->[' . $idx . ']->set_initial_value(',
631 $attr->_inline_instance_get('$instance'),
633 ) if $attr->has_initializer;
635 return @initial_value;
638 sub _inline_init_attr_from_default {
640 my ($attr, $idx) = @_;
642 my $default = $self->_inline_default_value($attr, $idx);
643 return unless $default;
645 my @initial_value = $attr->_inline_set_value('$instance', $default);
647 push @initial_value, (
648 '$attrs->[' . $idx . ']->set_initial_value(',
650 $attr->_inline_instance_get('$instance'),
652 ) if $attr->has_initializer;
654 return @initial_value;
657 sub _inline_default_value {
659 my ($attr, $index) = @_;
661 if ($attr->has_default) {
663 # default values can either be CODE refs
664 # in which case we need to call them. Or
665 # they can be scalars (strings/numbers)
666 # in which case we can just deal with them
667 # in the code we eval.
668 if ($attr->is_default_a_coderef) {
669 return '$defaults->[' . $index . ']->($instance)';
672 return '$defaults->[' . $index . ']';
675 elsif ($attr->has_builder) {
676 return '$instance->' . $attr->builder;
683 sub _inline_preserve_weak_metaclasses {
685 if (Class::MOP::metaclass_is_weak($self->name)) {
687 $self->_inline_set_mop_slot(
688 '$instance', 'Class::MOP::class_of($class)'
697 sub _inline_extra_init { }
699 sub _eval_environment {
702 my @attrs = sort { $a->name cmp $b->name } $self->get_all_attributes;
704 my $defaults = [map { $_->default } @attrs];
707 '$defaults' => \$defaults,
712 sub get_meta_instance {
714 $self->{'_meta_instance'} ||= $self->_create_meta_instance();
717 sub _create_meta_instance {
720 my $instance = $self->instance_metaclass->new(
721 associated_metaclass => $self,
722 attributes => [ $self->get_all_attributes() ],
725 $self->add_meta_instance_dependencies()
726 if $instance->is_dependent_on_superclasses();
731 # TODO: this is actually not being used!
732 sub _inline_rebless_instance {
735 return $self->get_meta_instance->inline_rebless_instance_structure(@_);
738 sub _inline_get_mop_slot {
741 return $self->get_meta_instance->_inline_get_mop_slot(@_);
744 sub _inline_set_mop_slot {
747 return $self->get_meta_instance->_inline_set_mop_slot(@_);
750 sub _inline_clear_mop_slot {
753 return $self->get_meta_instance->_inline_clear_mop_slot(@_);
758 my $instance = shift;
759 (blessed($instance) && $instance->isa($class->name))
760 || confess "You must pass an instance of the metaclass (" . (ref $class ? $class->name : $class) . "), not ($instance)";
763 # we need to protect the integrity of the
764 # Class::MOP::Class singletons here, they
765 # should not be cloned.
766 return $instance if $instance->isa('Class::MOP::Class');
767 $class->_clone_instance($instance, @_);
770 sub _clone_instance {
771 my ($class, $instance, %params) = @_;
773 || confess "You can only clone instances, ($instance) is not a blessed instance";
774 my $meta_instance = $class->get_meta_instance();
775 my $clone = $meta_instance->clone_instance($instance);
776 foreach my $attr ($class->get_all_attributes()) {
777 if ( defined( my $init_arg = $attr->init_arg ) ) {
778 if (exists $params{$init_arg}) {
779 $attr->set_value($clone, $params{$init_arg});
786 sub _force_rebless_instance {
787 my ($self, $instance, %params) = @_;
788 my $old_metaclass = Class::MOP::class_of($instance);
790 $old_metaclass->rebless_instance_away($instance, $self, %params)
793 my $meta_instance = $self->get_meta_instance;
795 if (Class::MOP::metaclass_is_weak($old_metaclass->name)) {
796 $meta_instance->_clear_mop_slot($instance);
800 # we use $_[1] here because of t/cmop/rebless_overload.t regressions
802 $meta_instance->rebless_instance_structure($_[1], $self);
804 $self->_fixup_attributes_after_rebless($instance, $old_metaclass, %params);
806 if (Class::MOP::metaclass_is_weak($self->name)) {
807 $meta_instance->_set_mop_slot($instance, $self);
811 sub rebless_instance {
812 my ($self, $instance, %params) = @_;
813 my $old_metaclass = Class::MOP::class_of($instance);
815 my $old_class = $old_metaclass ? $old_metaclass->name : blessed($instance);
816 $self->name->isa($old_class)
817 || confess "You may rebless only into a subclass of ($old_class), of which (". $self->name .") isn't.";
819 $self->_force_rebless_instance($_[1], %params);
824 sub rebless_instance_back {
825 my ( $self, $instance ) = @_;
826 my $old_metaclass = Class::MOP::class_of($instance);
829 = $old_metaclass ? $old_metaclass->name : blessed($instance);
830 $old_class->isa( $self->name )
832 "You may rebless only into a superclass of ($old_class), of which ("
836 $self->_force_rebless_instance($_[1]);
841 sub rebless_instance_away {
842 # this intentionally does nothing, it is just a hook
845 sub _fixup_attributes_after_rebless {
847 my ($instance, $rebless_from, %params) = @_;
848 my $meta_instance = $self->get_meta_instance;
850 for my $attr ( $rebless_from->get_all_attributes ) {
851 next if $self->find_attribute_by_name( $attr->name );
852 $meta_instance->deinitialize_slot( $instance, $_ ) for $attr->slots;
855 foreach my $attr ( $self->get_all_attributes ) {
856 if ( $attr->has_value($instance) ) {
857 if ( defined( my $init_arg = $attr->init_arg ) ) {
858 $params{$init_arg} = $attr->get_value($instance)
859 unless exists $params{$init_arg};
862 $attr->set_value($instance, $attr->get_value($instance));
867 foreach my $attr ($self->get_all_attributes) {
868 $attr->initialize_instance_slot($meta_instance, $instance, \%params);
872 sub _attach_attribute {
873 my ($self, $attribute) = @_;
874 $attribute->attach_to_class($self);
877 sub _post_add_attribute {
878 my ( $self, $attribute ) = @_;
880 $self->invalidate_meta_instances;
882 # invalidate package flag here
885 $attribute->install_accessors;
888 $self->remove_attribute( $attribute->name );
893 sub remove_attribute {
896 my $removed_attribute = $self->SUPER::remove_attribute(@_)
899 $self->invalidate_meta_instances;
901 $removed_attribute->remove_accessors;
902 $removed_attribute->detach_from_class;
904 return$removed_attribute;
907 sub find_attribute_by_name {
908 my ( $self, $attr_name ) = @_;
910 foreach my $class ( $self->linearized_isa ) {
911 # fetch the meta-class ...
912 my $meta = Class::MOP::Class->initialize($class);
913 return $meta->get_attribute($attr_name)
914 if $meta->has_attribute($attr_name);
920 sub get_all_attributes {
922 my %attrs = map { %{ Class::MOP::Class->initialize($_)->_attribute_map } }
923 reverse $self->linearized_isa;
924 return values %attrs;
932 my $isa = $self->get_or_add_package_symbol('@ISA');
939 # on 5.8 and below, we need to call
940 # a method to get Perl to detect
941 # a cycle in the class hierarchy
942 my $class = $self->name;
946 # we need to check the metaclass
947 # compatibility here so that we can
948 # be sure that the superclass is
949 # not potentially creating an issues
950 # we don't know about
952 $self->_check_metaclass_compatibility();
953 $self->_superclasses_updated();
959 sub _superclasses_updated {
961 $self->update_meta_instance_dependencies();
962 # keep strong references to all our parents, so they don't disappear if
963 # they are anon classes and don't have any direct instances
964 $self->_superclass_metas(
965 map { Class::MOP::class_of($_) } $self->superclasses
969 sub _superclass_metas {
971 $self->{_superclass_metas} = [@_];
976 my $super_class = $self->name;
978 return @{ $super_class->mro::get_isarev() };
981 sub direct_subclasses {
983 my $super_class = $self->name;
988 } Class::MOP::Class->initialize($_)->superclasses
993 return @{ mro::get_linear_isa( (shift)->name ) };
996 sub class_precedence_list {
998 my $name = $self->name;
1000 unless (Class::MOP::IS_RUNNING_ON_5_10()) {
1002 # We need to check for circular inheritance here
1003 # if we are are not on 5.10, cause 5.8 detects it
1004 # late. This will do nothing if all is well, and
1005 # blow up otherwise. Yes, it's an ugly hack, better
1006 # suggestions are welcome.
1008 ($name || return)->isa('This is a test for circular inheritance')
1011 # if our mro is c3, we can
1012 # just grab the linear_isa
1013 if (mro::get_mro($name) eq 'c3') {
1014 return @{ mro::get_linear_isa($name) }
1018 # we can't grab the linear_isa for dfs
1019 # since it has all the duplicates
1024 Class::MOP::Class->initialize($_)->class_precedence_list()
1025 } $self->superclasses()
1033 my $fetch_and_prepare_method = sub {
1034 my ($self, $method_name) = @_;
1035 my $wrapped_metaclass = $self->wrapped_method_metaclass;
1037 my $method = $self->get_method($method_name);
1038 # if we dont have local ...
1040 # try to find the next method
1041 $method = $self->find_next_method_by_name($method_name);
1042 # die if it does not exist
1044 || confess "The method '$method_name' was not found in the inheritance hierarchy for " . $self->name;
1045 # and now make sure to wrap it
1046 # even if it is already wrapped
1047 # because we need a new sub ref
1048 $method = $wrapped_metaclass->wrap($method,
1049 package_name => $self->name,
1050 name => $method_name,
1054 # now make sure we wrap it properly
1055 $method = $wrapped_metaclass->wrap($method,
1056 package_name => $self->name,
1057 name => $method_name,
1058 ) unless $method->isa($wrapped_metaclass);
1060 $self->add_method($method_name => $method);
1064 sub add_before_method_modifier {
1065 my ($self, $method_name, $method_modifier) = @_;
1066 (defined $method_name && length $method_name)
1067 || confess "You must pass in a method name";
1068 my $method = $fetch_and_prepare_method->($self, $method_name);
1069 $method->add_before_modifier(
1070 subname(':before' => $method_modifier)
1074 sub add_after_method_modifier {
1075 my ($self, $method_name, $method_modifier) = @_;
1076 (defined $method_name && length $method_name)
1077 || confess "You must pass in a method name";
1078 my $method = $fetch_and_prepare_method->($self, $method_name);
1079 $method->add_after_modifier(
1080 subname(':after' => $method_modifier)
1084 sub add_around_method_modifier {
1085 my ($self, $method_name, $method_modifier) = @_;
1086 (defined $method_name && length $method_name)
1087 || confess "You must pass in a method name";
1088 my $method = $fetch_and_prepare_method->($self, $method_name);
1089 $method->add_around_modifier(
1090 subname(':around' => $method_modifier)
1095 # the methods above used to be named like this:
1096 # ${pkg}::${method}:(before|after|around)
1097 # but this proved problematic when using one modifier
1098 # to wrap multiple methods (something which is likely
1099 # to happen pretty regularly IMO). So instead of naming
1100 # it like this, I have chosen to just name them purely
1101 # with their modifier names, like so:
1102 # :(before|after|around)
1103 # The fact is that in a stack trace, it will be fairly
1104 # evident from the context what method they are attached
1105 # to, and so don't need the fully qualified name.
1108 sub find_method_by_name {
1109 my ($self, $method_name) = @_;
1110 (defined $method_name && length $method_name)
1111 || confess "You must define a method name to find";
1112 foreach my $class ($self->linearized_isa, 'UNIVERSAL') {
1113 my $method = Class::MOP::Class->initialize($class)->get_method($method_name);
1114 return $method if defined $method;
1119 sub get_all_methods {
1123 for my $class ( 'UNIVERSAL', reverse $self->linearized_isa ) {
1124 my $meta = Class::MOP::Class->initialize($class);
1126 $methods{ $_->name } = $_ for $meta->_get_local_methods;
1129 return values %methods;
1132 sub get_all_method_names {
1137 grep { !$uniq{$_}++ }
1138 map { Class::MOP::Class->initialize($_)->get_method_list }
1139 $self->linearized_isa, 'UNIVERSAL';
1142 sub find_all_methods_by_name {
1143 my ($self, $method_name) = @_;
1144 (defined $method_name && length $method_name)
1145 || confess "You must define a method name to find";
1147 foreach my $class ($self->linearized_isa, 'UNIVERSAL') {
1148 # fetch the meta-class ...
1149 my $meta = Class::MOP::Class->initialize($class);
1151 name => $method_name,
1153 code => $meta->get_method($method_name)
1154 } if $meta->has_method($method_name);
1159 sub find_next_method_by_name {
1160 my ($self, $method_name) = @_;
1161 (defined $method_name && length $method_name)
1162 || confess "You must define a method name to find";
1163 my @cpl = ($self->linearized_isa, 'UNIVERSAL');
1164 shift @cpl; # discard ourselves
1165 foreach my $class (@cpl) {
1166 my $method = Class::MOP::Class->initialize($class)->get_method($method_name);
1167 return $method if defined $method;
1172 sub update_meta_instance_dependencies {
1175 if ( $self->{meta_instance_dependencies} ) {
1176 return $self->add_meta_instance_dependencies;
1180 sub add_meta_instance_dependencies {
1183 $self->remove_meta_instance_dependencies;
1185 my @attrs = $self->get_all_attributes();
1188 my @classes = grep { not $seen{ $_->name }++ }
1189 map { $_->associated_class } @attrs;
1191 foreach my $class (@classes) {
1192 $class->add_dependent_meta_instance($self);
1195 $self->{meta_instance_dependencies} = \@classes;
1198 sub remove_meta_instance_dependencies {
1201 if ( my $classes = delete $self->{meta_instance_dependencies} ) {
1202 foreach my $class (@$classes) {
1203 $class->remove_dependent_meta_instance($self);
1213 sub add_dependent_meta_instance {
1214 my ( $self, $metaclass ) = @_;
1215 push @{ $self->{dependent_meta_instances} }, $metaclass;
1218 sub remove_dependent_meta_instance {
1219 my ( $self, $metaclass ) = @_;
1220 my $name = $metaclass->name;
1221 @$_ = grep { $_->name ne $name } @$_
1222 for $self->{dependent_meta_instances};
1225 sub invalidate_meta_instances {
1227 $_->invalidate_meta_instance()
1228 for $self, @{ $self->{dependent_meta_instances} };
1231 sub invalidate_meta_instance {
1233 undef $self->{_meta_instance};
1236 # check if we can reinitialize
1240 # if any local attr is defined
1241 return if $self->get_attribute_list;
1243 # or any non-declared methods
1244 for my $method ( map { $self->get_method($_) } $self->get_method_list ) {
1245 return if $method->isa("Class::MOP::Method::Generated");
1246 # FIXME do we need to enforce this too? return unless $method->isa( $self->method_metaclass );
1254 sub is_mutable { 1 }
1255 sub is_immutable { 0 }
1257 sub immutable_options { %{ $_[0]{__immutable}{options} || {} } }
1259 sub _immutable_options {
1260 my ( $self, @args ) = @_;
1263 inline_accessors => 1,
1264 inline_constructor => 1,
1265 inline_destructor => 0,
1267 immutable_trait => $self->immutable_trait,
1268 constructor_name => $self->constructor_name,
1269 constructor_class => $self->constructor_class,
1270 destructor_class => $self->destructor_class,
1275 sub make_immutable {
1276 my ( $self, @args ) = @_;
1278 return unless $self->is_mutable;
1280 my ($file, $line) = (caller)[1..2];
1282 $self->_initialize_immutable(
1285 $self->_immutable_options(@args),
1287 $self->_rebless_as_immutable(@args);
1295 if ( $self->is_immutable ) {
1296 my @args = $self->immutable_options;
1297 $self->_rebless_as_mutable();
1298 $self->_remove_inlined_code(@args);
1299 delete $self->{__immutable};
1307 sub _rebless_as_immutable {
1308 my ( $self, @args ) = @_;
1310 $self->{__immutable}{original_class} = ref $self;
1312 bless $self => $self->_immutable_metaclass(@args);
1315 sub _immutable_metaclass {
1316 my ( $self, %args ) = @_;
1318 if ( my $class = $args{immutable_metaclass} ) {
1322 my $trait = $args{immutable_trait} = $self->immutable_trait
1323 || confess "no immutable trait specified for $self";
1325 my $meta = $self->meta;
1326 my $meta_attr = $meta->find_attribute_by_name("immutable_trait");
1330 if ( $meta_attr and $trait eq $meta_attr->default ) {
1331 # if the trait is the same as the default we try and pick a
1332 # predictable name for the immutable metaclass
1333 $class_name = 'Class::MOP::Class::Immutable::' . ref($self);
1336 $class_name = join '::', 'Class::MOP::Class::Immutable::CustomTrait',
1337 $trait, 'ForMetaClass', ref($self);
1341 if is_class_loaded($class_name);
1343 # If the metaclass is a subclass of CMOP::Class which has had
1344 # metaclass roles applied (via Moose), then we want to make sure
1345 # that we preserve that anonymous class (see Fey::ORM for an
1346 # example of where this matters).
1347 my $meta_name = $meta->_real_ref_name;
1349 my $immutable_meta = $meta_name->create(
1351 superclasses => [ ref $self ],
1354 Class::MOP::MiniTrait::apply( $immutable_meta, $trait );
1356 $immutable_meta->make_immutable(
1357 inline_constructor => 0,
1358 inline_accessors => 0,
1364 sub _remove_inlined_code {
1367 $self->remove_method( $_->name ) for $self->_inlined_methods;
1369 delete $self->{__immutable}{inlined_methods};
1372 sub _inlined_methods { @{ $_[0]{__immutable}{inlined_methods} || [] } }
1374 sub _add_inlined_method {
1375 my ( $self, $method ) = @_;
1377 push @{ $self->{__immutable}{inlined_methods} ||= [] }, $method;
1380 sub _initialize_immutable {
1381 my ( $self, %args ) = @_;
1383 $self->{__immutable}{options} = \%args;
1384 $self->_install_inlined_code(%args);
1387 sub _install_inlined_code {
1388 my ( $self, %args ) = @_;
1391 $self->_inline_accessors(%args) if $args{inline_accessors};
1392 $self->_inline_constructor(%args) if $args{inline_constructor};
1393 $self->_inline_destructor(%args) if $args{inline_destructor};
1396 sub _rebless_as_mutable {
1399 bless $self, $self->_get_mutable_metaclass_name;
1404 sub _inline_accessors {
1407 foreach my $attr_name ( $self->get_attribute_list ) {
1408 $self->get_attribute($attr_name)->install_accessors(1);
1412 sub _inline_constructor {
1413 my ( $self, %args ) = @_;
1415 my $name = $args{constructor_name};
1416 # A class may not even have a constructor, and that's okay.
1417 return unless defined $name;
1419 if ( $self->has_method($name) && !$args{replace_constructor} ) {
1420 my $class = $self->name;
1421 warn "Not inlining a constructor for $class since it defines"
1422 . " its own constructor.\n"
1423 . "If you are certain you don't need to inline your"
1424 . " constructor, specify inline_constructor => 0 in your"
1425 . " call to $class->meta->make_immutable\n";
1429 my $constructor_class = $args{constructor_class};
1431 load_class($constructor_class);
1433 my $constructor = $constructor_class->new(
1437 package_name => $self->name,
1439 definition_context => {
1440 description => "constructor " . $self->name . "::" . $name,
1441 file => $args{file},
1442 line => $args{line},
1446 if ( $args{replace_constructor} or $constructor->can_be_inlined ) {
1447 $self->add_method( $name => $constructor );
1448 $self->_add_inlined_method($constructor);
1452 sub _inline_destructor {
1453 my ( $self, %args ) = @_;
1455 ( exists $args{destructor_class} && defined $args{destructor_class} )
1456 || confess "The 'inline_destructor' option is present, but "
1457 . "no destructor class was specified";
1459 if ( $self->has_method('DESTROY') && ! $args{replace_destructor} ) {
1460 my $class = $self->name;
1461 warn "Not inlining a destructor for $class since it defines"
1462 . " its own destructor.\n";
1466 my $destructor_class = $args{destructor_class};
1468 load_class($destructor_class);
1470 return unless $destructor_class->is_needed($self);
1472 my $destructor = $destructor_class->new(
1475 package_name => $self->name,
1477 definition_context => {
1478 description => "destructor " . $self->name . "::DESTROY",
1479 file => $args{file},
1480 line => $args{line},
1484 if ( $args{replace_destructor} or $destructor->can_be_inlined ) {
1485 $self->add_method( 'DESTROY' => $destructor );
1486 $self->_add_inlined_method($destructor);
1492 # ABSTRACT: Class Meta Object
1500 # assuming that class Foo
1501 # has been defined, you can
1503 # use this for introspection ...
1505 # add a method to Foo ...
1506 Foo->meta->add_method( 'bar' => sub {...} )
1508 # get a list of all the classes searched
1509 # the method dispatcher in the correct order
1510 Foo->meta->class_precedence_list()
1512 # remove a method from Foo
1513 Foo->meta->remove_method('bar');
1515 # or use this to actually create classes ...
1517 Class::MOP::Class->create(
1520 superclasses => ['Foo'],
1522 Class::MOP::Attribute->new('$bar'),
1523 Class::MOP::Attribute->new('$baz'),
1526 calculate_bar => sub {...},
1527 construct_baz => sub {...}
1534 The Class Protocol is the largest and most complex part of the
1535 Class::MOP meta-object protocol. It controls the introspection and
1536 manipulation of Perl 5 classes, and it can create them as well. The
1537 best way to understand what this module can do is to read the
1538 documentation for each of its methods.
1542 C<Class::MOP::Class> is a subclass of L<Class::MOP::Module>.
1546 =head2 Class construction
1548 These methods all create new C<Class::MOP::Class> objects. These
1549 objects can represent existing classes or they can be used to create
1550 new classes from scratch.
1552 The metaclass object for a given class is a singleton. If you attempt
1553 to create a metaclass for the same class twice, you will just get the
1558 =item B<< Class::MOP::Class->create($package_name, %options) >>
1560 This method creates a new C<Class::MOP::Class> object with the given
1561 package name. It accepts a number of options:
1567 An optional version number for the newly created package.
1571 An optional authority for the newly created package.
1573 =item * superclasses
1575 An optional array reference of superclass names.
1579 An optional hash reference of methods for the class. The keys of the
1580 hash reference are method names and values are subroutine references.
1584 An optional array reference of L<Class::MOP::Attribute> objects.
1588 Specifies the name to install the C<meta> method for this class under.
1589 If it is not passed, C<meta> is assumed, and if C<undef> is explicitly
1590 given, no meta method will be installed.
1594 If true, the metaclass that is stored in the global cache will be a
1597 Classes created in this way are destroyed once the metaclass they are
1598 attached to goes out of scope, and will be removed from Perl's internal
1601 All instances of a class with a weakened metaclass keep a special
1602 reference to the metaclass object, which prevents the metaclass from
1603 going out of scope while any instances exist.
1605 This only works if the instance is based on a hash reference, however.
1609 =item B<< Class::MOP::Class->create_anon_class(%options) >>
1611 This method works just like C<< Class::MOP::Class->create >> but it
1612 creates an "anonymous" class. In fact, the class does have a name, but
1613 that name is a unique name generated internally by this module.
1615 It accepts the same C<superclasses>, C<methods>, and C<attributes>
1616 parameters that C<create> accepts.
1618 Anonymous classes default to C<< weaken => 1 >>, although this can be
1621 =item B<< Class::MOP::Class->initialize($package_name, %options) >>
1623 This method will initialize a C<Class::MOP::Class> object for the
1624 named package. Unlike C<create>, this method I<will not> create a new
1627 The purpose of this method is to retrieve a C<Class::MOP::Class>
1628 object for introspecting an existing class.
1630 If an existing C<Class::MOP::Class> object exists for the named
1631 package, it will be returned, and any options provided will be
1634 If the object does not yet exist, it will be created.
1636 The valid options that can be passed to this method are
1637 C<attribute_metaclass>, C<method_metaclass>,
1638 C<wrapped_method_metaclass>, and C<instance_metaclass>. These are all
1639 optional, and default to the appropriate class in the C<Class::MOP>
1644 =head2 Object instance construction and cloning
1646 These methods are all related to creating and/or cloning object
1651 =item B<< $metaclass->clone_object($instance, %params) >>
1653 This method clones an existing object instance. Any parameters you
1654 provide are will override existing attribute values in the object.
1656 This is a convenience method for cloning an object instance, then
1657 blessing it into the appropriate package.
1659 You could implement a clone method in your class, using this method:
1662 my ($self, %params) = @_;
1663 $self->meta->clone_object($self, %params);
1666 =item B<< $metaclass->rebless_instance($instance, %params) >>
1668 This method changes the class of C<$instance> to the metaclass's class.
1670 You can only rebless an instance into a subclass of its current
1671 class. If you pass any additional parameters, these will be treated
1672 like constructor parameters and used to initialize the object's
1673 attributes. Any existing attributes that are already set will be
1676 Before reblessing the instance, this method will call
1677 C<rebless_instance_away> on the instance's current metaclass. This method
1678 will be passed the instance, the new metaclass, and any parameters
1679 specified to C<rebless_instance>. By default, C<rebless_instance_away>
1680 does nothing; it is merely a hook.
1682 =item B<< $metaclass->rebless_instance_back($instance) >>
1684 Does the same thing as C<rebless_instance>, except that you can only
1685 rebless an instance into one of its superclasses. Any attributes that
1686 do not exist in the superclass will be deinitialized.
1688 This is a much more dangerous operation than C<rebless_instance>,
1689 especially when multiple inheritance is involved, so use this carefully!
1691 =item B<< $metaclass->new_object(%params) >>
1693 This method is used to create a new object of the metaclass's
1694 class. Any parameters you provide are used to initialize the
1695 instance's attributes. A special C<__INSTANCE__> key can be passed to
1696 provide an already generated instance, rather than having Class::MOP
1697 generate it for you. This is mostly useful for using Class::MOP with
1698 foreign classes which generate instances using their own constructors.
1700 =item B<< $metaclass->instance_metaclass >>
1702 Returns the class name of the instance metaclass. See
1703 L<Class::MOP::Instance> for more information on the instance
1706 =item B<< $metaclass->get_meta_instance >>
1708 Returns an instance of the C<instance_metaclass> to be used in the
1709 construction of a new instance of the class.
1713 =head2 Informational predicates
1715 These are a few predicate methods for asking information about the
1720 =item B<< $metaclass->is_anon_class >>
1722 This returns true if the class was created by calling C<<
1723 Class::MOP::Class->create_anon_class >>.
1725 =item B<< $metaclass->is_mutable >>
1727 This returns true if the class is still mutable.
1729 =item B<< $metaclass->is_immutable >>
1731 This returns true if the class has been made immutable.
1733 =item B<< $metaclass->is_pristine >>
1735 A class is I<not> pristine if it has non-inherited attributes or if it
1736 has any generated methods.
1740 =head2 Inheritance Relationships
1744 =item B<< $metaclass->superclasses(@superclasses) >>
1746 This is a read-write accessor which represents the superclass
1747 relationships of the metaclass's class.
1749 This is basically sugar around getting and setting C<@ISA>.
1751 =item B<< $metaclass->class_precedence_list >>
1753 This returns a list of all of the class's ancestor classes. The
1754 classes are returned in method dispatch order.
1756 =item B<< $metaclass->linearized_isa >>
1758 This returns a list based on C<class_precedence_list> but with all
1761 =item B<< $metaclass->subclasses >>
1763 This returns a list of all subclasses for this class, even indirect
1766 =item B<< $metaclass->direct_subclasses >>
1768 This returns a list of immediate subclasses for this class, which does not
1769 include indirect subclasses.
1773 =head2 Method introspection and creation
1775 These methods allow you to introspect a class's methods, as well as
1776 add, remove, or change methods.
1778 Determining what is truly a method in a Perl 5 class requires some
1779 heuristics (aka guessing).
1781 Methods defined outside the package with a fully qualified name (C<sub
1782 Package::name { ... }>) will be included. Similarly, methods named
1783 with a fully qualified name using L<Sub::Name> are also included.
1785 However, we attempt to ignore imported functions.
1787 Ultimately, we are using heuristics to determine what truly is a
1788 method in a class, and these heuristics may get the wrong answer in
1789 some edge cases. However, for most "normal" cases the heuristics work
1794 =item B<< $metaclass->get_method($method_name) >>
1796 This will return a L<Class::MOP::Method> for the specified
1797 C<$method_name>. If the class does not have the specified method, it
1800 =item B<< $metaclass->has_method($method_name) >>
1802 Returns a boolean indicating whether or not the class defines the
1803 named method. It does not include methods inherited from parent
1806 =item B<< $metaclass->get_method_list >>
1808 This will return a list of method I<names> for all methods defined in
1811 =item B<< $metaclass->add_method($method_name, $method) >>
1813 This method takes a method name and a subroutine reference, and adds
1814 the method to the class.
1816 The subroutine reference can be a L<Class::MOP::Method>, and you are
1817 strongly encouraged to pass a meta method object instead of a code
1818 reference. If you do so, that object gets stored as part of the
1819 class's method map directly. If not, the meta information will have to
1820 be recreated later, and may be incorrect.
1822 If you provide a method object, this method will clone that object if
1823 the object's package name does not match the class name. This lets us
1824 track the original source of any methods added from other classes
1825 (notably Moose roles).
1827 =item B<< $metaclass->remove_method($method_name) >>
1829 Remove the named method from the class. This method returns the
1830 L<Class::MOP::Method> object for the method.
1832 =item B<< $metaclass->method_metaclass >>
1834 Returns the class name of the method metaclass, see
1835 L<Class::MOP::Method> for more information on the method metaclass.
1837 =item B<< $metaclass->wrapped_method_metaclass >>
1839 Returns the class name of the wrapped method metaclass, see
1840 L<Class::MOP::Method::Wrapped> for more information on the wrapped
1843 =item B<< $metaclass->get_all_methods >>
1845 This will traverse the inheritance hierarchy and return a list of all
1846 the L<Class::MOP::Method> objects for this class and its parents.
1848 =item B<< $metaclass->find_method_by_name($method_name) >>
1850 This will return a L<Class::MOP::Method> for the specified
1851 C<$method_name>. If the class does not have the specified method, it
1854 Unlike C<get_method>, this method I<will> look for the named method in
1857 =item B<< $metaclass->get_all_method_names >>
1859 This will return a list of method I<names> for all of this class's
1860 methods, including inherited methods.
1862 =item B<< $metaclass->find_all_methods_by_name($method_name) >>
1864 This method looks for the named method in the class and all of its
1865 parents. It returns every matching method it finds in the inheritance
1866 tree, so it returns a list of methods.
1868 Each method is returned as a hash reference with three keys. The keys
1869 are C<name>, C<class>, and C<code>. The C<code> key has a
1870 L<Class::MOP::Method> object as its value.
1872 The list of methods is distinct.
1874 =item B<< $metaclass->find_next_method_by_name($method_name) >>
1876 This method returns the first method in any superclass matching the
1877 given name. It is effectively the method that C<SUPER::$method_name>
1882 =head2 Attribute introspection and creation
1884 Because Perl 5 does not have a core concept of attributes in classes,
1885 we can only return information about attributes which have been added
1886 via this class's methods. We cannot discover information about
1887 attributes which are defined in terms of "regular" Perl 5 methods.
1891 =item B<< $metaclass->get_attribute($attribute_name) >>
1893 This will return a L<Class::MOP::Attribute> for the specified
1894 C<$attribute_name>. If the class does not have the specified
1895 attribute, it returns C<undef>.
1897 NOTE that get_attribute does not search superclasses, for that you
1898 need to use C<find_attribute_by_name>.
1900 =item B<< $metaclass->has_attribute($attribute_name) >>
1902 Returns a boolean indicating whether or not the class defines the
1903 named attribute. It does not include attributes inherited from parent
1906 =item B<< $metaclass->get_attribute_list >>
1908 This will return a list of attributes I<names> for all attributes
1909 defined in this class. Note that this operates on the current class
1910 only, it does not traverse the inheritance hierarchy.
1912 =item B<< $metaclass->get_all_attributes >>
1914 This will traverse the inheritance hierarchy and return a list of all
1915 the L<Class::MOP::Attribute> objects for this class and its parents.
1917 =item B<< $metaclass->find_attribute_by_name($attribute_name) >>
1919 This will return a L<Class::MOP::Attribute> for the specified
1920 C<$attribute_name>. If the class does not have the specified
1921 attribute, it returns C<undef>.
1923 Unlike C<get_attribute>, this attribute I<will> look for the named
1924 attribute in superclasses.
1926 =item B<< $metaclass->add_attribute(...) >>
1928 This method accepts either an existing L<Class::MOP::Attribute>
1929 object or parameters suitable for passing to that class's C<new>
1932 The attribute provided will be added to the class.
1934 Any accessor methods defined by the attribute will be added to the
1935 class when the attribute is added.
1937 If an attribute of the same name already exists, the old attribute
1938 will be removed first.
1940 =item B<< $metaclass->remove_attribute($attribute_name) >>
1942 This will remove the named attribute from the class, and
1943 L<Class::MOP::Attribute> object.
1945 Removing an attribute also removes any accessor methods defined by the
1948 However, note that removing an attribute will only affect I<future>
1949 object instances created for this class, not existing instances.
1951 =item B<< $metaclass->attribute_metaclass >>
1953 Returns the class name of the attribute metaclass for this class. By
1954 default, this is L<Class::MOP::Attribute>.
1958 =head2 Class Immutability
1960 Making a class immutable "freezes" the class definition. You can no
1961 longer call methods which alter the class, such as adding or removing
1962 methods or attributes.
1964 Making a class immutable lets us optimize the class by inlining some
1965 methods, and also allows us to optimize some methods on the metaclass
1968 After immutabilization, the metaclass object will cache most informational
1969 methods that returns information about methods or attributes. Methods which
1970 would alter the class, such as C<add_attribute> and C<add_method>, will
1971 throw an error on an immutable metaclass object.
1973 The immutabilization system in L<Moose> takes much greater advantage
1974 of the inlining features than Class::MOP itself does.
1978 =item B<< $metaclass->make_immutable(%options) >>
1980 This method will create an immutable transformer and use it to make
1981 the class and its metaclass object immutable.
1983 This method accepts the following options:
1987 =item * inline_accessors
1989 =item * inline_constructor
1991 =item * inline_destructor
1993 These are all booleans indicating whether the specified method(s)
1996 By default, accessors and the constructor are inlined, but not the
1999 =item * immutable_trait
2001 The name of a class which will be used as a parent class for the
2002 metaclass object being made immutable. This "trait" implements the
2003 post-immutability functionality of the metaclass (but not the
2004 transformation itself).
2006 This defaults to L<Class::MOP::Class::Immutable::Trait>.
2008 =item * constructor_name
2010 This is the constructor method name. This defaults to "new".
2012 =item * constructor_class
2014 The name of the method metaclass for constructors. It will be used to
2015 generate the inlined constructor. This defaults to
2016 "Class::MOP::Method::Constructor".
2018 =item * replace_constructor
2020 This is a boolean indicating whether an existing constructor should be
2021 replaced when inlining a constructor. This defaults to false.
2023 =item * destructor_class
2025 The name of the method metaclass for destructors. It will be used to
2026 generate the inlined destructor. This defaults to
2027 "Class::MOP::Method::Denstructor".
2029 =item * replace_destructor
2031 This is a boolean indicating whether an existing destructor should be
2032 replaced when inlining a destructor. This defaults to false.
2036 =item B<< $metaclass->immutable_options >>
2038 Returns a hash of the options used when making the class immutable, including
2039 both defaults and anything supplied by the user in the call to C<<
2040 $metaclass->make_immutable >>. This is useful if you need to temporarily make
2041 a class mutable and then restore immutability as it was before.
2043 =item B<< $metaclass->make_mutable >>
2045 Calling this method reverse the immutabilization transformation.
2049 =head2 Method Modifiers
2051 Method modifiers are hooks which allow a method to be wrapped with
2052 I<before>, I<after> and I<around> method modifiers. Every time a
2053 method is called, its modifiers are also called.
2055 A class can modify its own methods, as well as methods defined in
2058 =head3 How method modifiers work?
2060 Method modifiers work by wrapping the original method and then
2061 replacing it in the class's symbol table. The wrappers will handle
2062 calling all the modifiers in the appropriate order and preserving the
2063 calling context for the original method.
2065 The return values of C<before> and C<after> modifiers are
2066 ignored. This is because their purpose is B<not> to filter the input
2067 and output of the primary method (this is done with an I<around>
2070 This may seem like an odd restriction to some, but doing this allows
2071 for simple code to be added at the beginning or end of a method call
2072 without altering the function of the wrapped method or placing any
2073 extra responsibility on the code of the modifier.
2075 Of course if you have more complex needs, you can use the C<around>
2076 modifier which allows you to change both the parameters passed to the
2077 wrapped method, as well as its return value.
2079 Before and around modifiers are called in last-defined-first-called
2080 order, while after modifiers are called in first-defined-first-called
2081 order. So the call tree might looks something like this:
2093 =head3 What is the performance impact?
2095 Of course there is a performance cost associated with method
2096 modifiers, but we have made every effort to make that cost directly
2097 proportional to the number of modifier features you use.
2099 The wrapping method does its best to B<only> do as much work as it
2100 absolutely needs to. In order to do this we have moved some of the
2101 performance costs to set-up time, where they are easier to amortize.
2103 All this said, our benchmarks have indicated the following:
2105 simple wrapper with no modifiers 100% slower
2106 simple wrapper with simple before modifier 400% slower
2107 simple wrapper with simple after modifier 450% slower
2108 simple wrapper with simple around modifier 500-550% slower
2109 simple wrapper with all 3 modifiers 1100% slower
2111 These numbers may seem daunting, but you must remember, every feature
2112 comes with some cost. To put things in perspective, just doing a
2113 simple C<AUTOLOAD> which does nothing but extract the name of the
2114 method called and return it costs about 400% over a normal method
2119 =item B<< $metaclass->add_before_method_modifier($method_name, $code) >>
2121 This wraps the specified method with the supplied subroutine
2122 reference. The modifier will be called as a method itself, and will
2123 receive the same arguments as are passed to the method.
2125 When the modifier exits, the wrapped method will be called.
2127 The return value of the modifier will be ignored.
2129 =item B<< $metaclass->add_after_method_modifier($method_name, $code) >>
2131 This wraps the specified method with the supplied subroutine
2132 reference. The modifier will be called as a method itself, and will
2133 receive the same arguments as are passed to the method.
2135 When the wrapped methods exits, the modifier will be called.
2137 The return value of the modifier will be ignored.
2139 =item B<< $metaclass->add_around_method_modifier($method_name, $code) >>
2141 This wraps the specified method with the supplied subroutine
2144 The first argument passed to the modifier will be a subroutine
2145 reference to the wrapped method. The second argument is the object,
2146 and after that come any arguments passed when the method is called.
2148 The around modifier can choose to call the original method, as well as
2149 what arguments to pass if it does so.
2151 The return value of the modifier is what will be seen by the caller.
2155 =head2 Introspection
2159 =item B<< Class::MOP::Class->meta >>
2161 This will return a L<Class::MOP::Class> instance for this class.
2163 It should also be noted that L<Class::MOP> will actually bootstrap
2164 this module by installing a number of attribute meta-objects into its