X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FClass.pm;h=7a6f0399067d23e846853c36a1d492e7474e5b0f;hb=1550e0820d345fd483382e2b912ba683da3bdc1d;hp=cc57b6c5be7c95e26de5d3c3149f8cd4f67c2731;hpb=42c0f0e16769c77535cec6ef4c4e66c3a16fce65;p=gitmo%2FClass-MOP.git
diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm
index cc57b6c..7a6f039 100644
--- a/lib/Class/MOP/Class.pm
+++ b/lib/Class/MOP/Class.pm
@@ -11,7 +11,7 @@ use Class::MOP::Method::Wrapped;
use Carp 'confess';
use Scalar::Util 'blessed', 'weaken';
-our $VERSION = '0.65';
+our $VERSION = '0.78_02';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
@@ -73,8 +73,7 @@ sub construct_class_instance {
# now create the metaclass
my $meta;
if ($class eq 'Class::MOP::Class') {
- no strict 'refs';
- $meta = $class->_new($options)
+ $meta = $class->_new($options);
}
else {
# NOTE:
@@ -103,7 +102,7 @@ sub _new {
bless {
# inherited from Class::MOP::Package
- 'package' => $options->{package},
+ 'package' => $options->{package},
# NOTE:
# since the following attributes will
@@ -113,18 +112,25 @@ sub _new {
# listed here for reference, because they
# should not actually have a value associated
# with the slot.
- 'namespace' => \undef,
+ 'namespace' => \undef,
+
# inherited from Class::MOP::Module
- 'version' => \undef,
- 'authority' => \undef,
+ 'version' => \undef,
+ 'authority' => \undef,
+
# defined in Class::MOP::Class
- 'superclasses' => \undef,
+ 'superclasses' => \undef,
'methods' => {},
'attributes' => {},
- 'attribute_metaclass' => $options->{'attribute_metaclass'} || 'Class::MOP::Attribute',
- 'method_metaclass' => $options->{'method_metaclass'} || 'Class::MOP::Method',
- 'instance_metaclass' => $options->{'instance_metaclass'} || 'Class::MOP::Instance',
+ 'attribute_metaclass' => $options->{'attribute_metaclass'}
+ || 'Class::MOP::Attribute',
+ 'method_metaclass' => $options->{'method_metaclass'}
+ || 'Class::MOP::Method',
+ 'wrapped_method_metaclass' => $options->{'wrapped_method_metaclass'}
+ || 'Class::MOP::Method::Wrapped',
+ 'instance_metaclass' => $options->{'instance_metaclass'}
+ || 'Class::MOP::Instance',
}, $class;
}
@@ -150,37 +156,32 @@ sub check_metaclass_compatibility {
my @class_list = $self->linearized_isa;
shift @class_list; # shift off $self->name
- foreach my $class_name (@class_list) {
- my $meta = Class::MOP::get_metaclass_by_name($class_name) || next;
+ foreach my $superclass_name (@class_list) {
+ my $super_meta = Class::MOP::get_metaclass_by_name($superclass_name) || next;
# NOTE:
# we need to deal with the possibility
# of class immutability here, and then
# get the name of the class appropriately
- my $meta_type = ($meta->is_immutable
- ? $meta->get_mutable_metaclass_name()
- : ref($meta));
+ my $super_meta_type
+ = $super_meta->is_immutable
+ ? $super_meta->get_mutable_metaclass_name()
+ : ref($super_meta);
- ($self->isa($meta_type))
+ ($self->isa($super_meta_type))
|| confess $self->name . "->meta => (" . (ref($self)) . ")" .
" is not compatible with the " .
- $class_name . "->meta => (" . ($meta_type) . ")";
+ $superclass_name . "->meta => (" . ($super_meta_type) . ")";
# NOTE:
# we also need to check that instance metaclasses
# are compatibile in the same the class.
- ($self->instance_metaclass->isa($meta->instance_metaclass))
+ ($self->instance_metaclass->isa($super_meta->instance_metaclass))
|| confess $self->name . "->meta->instance_metaclass => (" . ($self->instance_metaclass) . ")" .
" is not compatible with the " .
- $class_name . "->meta->instance_metaclass => (" . ($meta->instance_metaclass) . ")";
+ $superclass_name . "->meta->instance_metaclass => (" . ($super_meta->instance_metaclass) . ")";
}
}
-# backwards compat for stevan's inability to spell ;)
-sub check_metaclass_compatability {
- my $self = shift;
- $self->check_metaclass_compatibility(@_);
-}
-
## ANON classes
{
@@ -250,9 +251,6 @@ sub create {
my (%options) = @args;
my $package_name = $options{package};
- (defined $package_name && $package_name)
- || confess "You must pass a package name";
-
(ref $options{superclasses} eq 'ARRAY')
|| confess "You must pass an ARRAY ref of superclasses"
if exists $options{superclasses};
@@ -262,19 +260,21 @@ sub create {
if exists $options{attributes};
(ref $options{methods} eq 'HASH')
- || confess "You must pass an HASH ref of methods"
+ || confess "You must pass a HASH ref of methods"
if exists $options{methods};
- my $code = "package $package_name;";
- $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
- if exists $options{version};
- $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
- if exists $options{authority};
+ $class->SUPER::create(%options);
- eval $code;
- confess "creation of $package_name failed : $@" if $@;
-
- my $meta = $class->initialize($package_name);
+ my (%initialize_options) = @args;
+ delete @initialize_options{qw(
+ package
+ superclasses
+ attributes
+ methods
+ version
+ authority
+ )};
+ my $meta = $class->initialize( $package_name => %initialize_options );
# FIXME totally lame
$meta->add_method('meta' => sub {
@@ -307,62 +307,11 @@ sub create {
# all these attribute readers will be bootstrapped
# away in the Class::MOP bootstrap section
-sub get_attribute_map { $_[0]->{'attributes'} }
-sub attribute_metaclass { $_[0]->{'attribute_metaclass'} }
-sub method_metaclass { $_[0]->{'method_metaclass'} }
-sub instance_metaclass { $_[0]->{'instance_metaclass'} }
-
-# FIXME:
-# this is a prime canidate for conversion to XS
-sub get_method_map {
- my $self = shift;
-
- my $current = Class::MOP::check_package_cache_flag($self->name);
-
- if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
- return $self->{'methods'} ||= {};
- }
-
- $self->{_package_cache_flag} = $current;
-
- my $map = $self->{'methods'} ||= {};
-
- my $class_name = $self->name;
- my $method_metaclass = $self->method_metaclass;
-
- my %all_code = $self->get_all_package_symbols('CODE');
-
- foreach my $symbol (keys %all_code) {
- my $code = $all_code{$symbol};
-
- next if exists $map->{$symbol} &&
- defined $map->{$symbol} &&
- $map->{$symbol}->body == $code;
-
- my ($pkg, $name) = Class::MOP::get_code_info($code);
-
- # NOTE:
- # in 5.10 constant.pm the constants show up
- # as being in the right package, but in pre-5.10
- # they show up as constant::__ANON__ so we
- # make an exception here to be sure that things
- # work as expected in both.
- # - SL
- unless ($pkg eq 'constant' && $name eq '__ANON__') {
- next if ($pkg || '') ne $class_name ||
- (($name || '') ne '__ANON__' && ($pkg || '') ne $class_name);
- }
-
- $map->{$symbol} = $method_metaclass->wrap(
- $code,
- associated_metaclass => $self,
- package_name => $class_name,
- name => $symbol,
- );
- }
-
- return $map;
-}
+sub get_attribute_map { $_[0]->{'attributes'} }
+sub attribute_metaclass { $_[0]->{'attribute_metaclass'} }
+sub method_metaclass { $_[0]->{'method_metaclass'} }
+sub wrapped_method_metaclass { $_[0]->{'wrapped_method_metaclass'} }
+sub instance_metaclass { $_[0]->{'instance_metaclass'} }
# Instance Construction & Cloning
@@ -471,7 +420,8 @@ sub rebless_instance {
|| confess "You may rebless only into a subclass of (". $old_metaclass->name ."), of which (". $self->name .") isn't.";
# rebless!
- $meta_instance->rebless_instance_structure($instance, $self);
+ # we use $_[1] here because of t/306_rebless_overload.t regressions on 5.8.8
+ $meta_instance->rebless_instance_structure($_[1], $self);
foreach my $attr ( $self->compute_all_applicable_attributes ) {
if ( $attr->has_value($instance) ) {
@@ -500,6 +450,14 @@ sub superclasses {
if (@_) {
my @supers = @_;
@{$self->get_package_symbol($var_spec)} = @supers;
+
+ # NOTE:
+ # on 5.8 and below, we need to call
+ # a method to get Perl to detect
+ # a cycle in the class hierarchy
+ my $class = $self->name;
+ $class->isa($class);
+
# NOTE:
# we need to check the metaclass
# compatibility here so that we can
@@ -637,20 +595,22 @@ sub add_method {
$method->attach_to_class($self);
- $self->get_method_map->{$method_name} = $method;
+ # This used to call get_method_map, which meant we would build all
+ # the method objects for the class just because we added one
+ # method. This is hackier, but quicker too.
+ $self->{methods}{$method_name} = $method;
my $full_method_name = ($self->name . '::' . $method_name);
$self->add_package_symbol(
{ sigil => '&', type => 'CODE', name => $method_name },
Class::MOP::subname($full_method_name => $body)
);
-
- $self->update_package_cache_flag; # still valid, since we just added the method to the map, and if it was invalid before that then get_method_map updated it
}
{
my $fetch_and_prepare_method = sub {
my ($self, $method_name) = @_;
+ my $wrapped_metaclass = $self->wrapped_method_metaclass;
# fetch it locally
my $method = $self->get_method($method_name);
# if we dont have local ...
@@ -659,16 +619,16 @@ sub add_method {
$method = $self->find_next_method_by_name($method_name);
# die if it does not exist
(defined $method)
- || confess "The method '$method_name' is not found in the inheritance hierarchy for class " . $self->name;
+ || confess "The method '$method_name' was not found in the inheritance hierarchy for " . $self->name;
# and now make sure to wrap it
# even if it is already wrapped
# because we need a new sub ref
- $method = Class::MOP::Method::Wrapped->wrap($method);
+ $method = $wrapped_metaclass->wrap($method);
}
else {
# now make sure we wrap it properly
- $method = Class::MOP::Method::Wrapped->wrap($method)
- unless $method->isa('Class::MOP::Method::Wrapped');
+ $method = $wrapped_metaclass->wrap($method)
+ unless $method->isa($wrapped_metaclass);
}
$self->add_method($method_name => $method);
return $method;
@@ -729,7 +689,7 @@ sub has_method {
(defined $method_name && $method_name)
|| confess "You must define a method name";
- exists $self->get_method_map->{$method_name};
+ exists $self->{methods}{$method_name} || exists $self->get_method_map->{$method_name};
}
sub get_method {
@@ -737,13 +697,7 @@ sub get_method {
(defined $method_name && $method_name)
|| confess "You must define a method name";
- # NOTE:
- # I don't really need this here, because
- # if the method_map is missing a key it
- # will just return undef for me now
- # return unless $self->has_method($method_name);
-
- return $self->get_method_map->{$method_name};
+ return $self->{methods}{$method_name} || $self->get_method_map->{$method_name};
}
sub remove_method {
@@ -799,6 +753,12 @@ sub compute_all_applicable_methods {
} shift->get_all_methods(@_);
}
+sub get_all_method_names {
+ my $self = shift;
+ my %uniq;
+ grep { $uniq{$_}++ == 0 } map { $_->name } $self->get_all_methods;
+}
+
sub find_all_methods_by_name {
my ($self, $method_name) = @_;
(defined $method_name && $method_name)
@@ -881,7 +841,7 @@ sub update_meta_instance_dependencies {
sub add_meta_instance_dependencies {
my $self = shift;
- $self->remove_meta_instance_depdendencies;
+ $self->remove_meta_instance_dependencies;
my @attrs = $self->compute_all_applicable_attributes();
@@ -895,7 +855,7 @@ sub add_meta_instance_dependencies {
$self->{meta_instance_dependencies} = \@classes;
}
-sub remove_meta_instance_depdendencies {
+sub remove_meta_instance_dependencies {
my $self = shift;
if ( my $classes = delete $self->{meta_instance_dependencies} ) {
@@ -1012,108 +972,56 @@ sub is_pristine {
sub is_mutable { 1 }
sub is_immutable { 0 }
-# NOTE:
-# Why I changed this (groditi)
-# - One Metaclass may have many Classes through many Metaclass instances
-# - One Metaclass should only have one Immutable Transformer instance
-# - Each Class may have different Immutabilizing options
-# - Therefore each Metaclass instance may have different Immutabilizing options
-# - We need to store one Immutable Transformer instance per Metaclass
-# - We need to store one set of Immutable Transformer options per Class
-# - Upon make_mutable we may delete the Immutabilizing options
-# - We could clean the immutable Transformer instance when there is no more
-# immutable Classes of that type, but we can also keep it in case
-# another class with this same Metaclass becomes immutable. It is a case
-# of trading of storing an instance to avoid unnecessary instantiations of
-# Immutable Transformers. You may view this as a memory leak, however
-# Because we have few Metaclasses, in practice it seems acceptable
-# - To allow Immutable Transformers instances to be cleaned up we could weaken
-# the reference stored in $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM
-
-{
+sub immutable_transformer { $_[0]->{immutable_transformer} }
+sub _set_immutable_transformer { $_[0]->{immutable_transformer} = $_[1] }
- my %IMMUTABLE_TRANSFORMERS;
- my %IMMUTABLE_OPTIONS;
-
- sub get_immutable_options {
- my $self = shift;
- return if $self->is_mutable;
- confess "unable to find immutabilizing options"
- unless exists $IMMUTABLE_OPTIONS{$self->name};
- my %options = %{$IMMUTABLE_OPTIONS{$self->name}};
- delete $options{IMMUTABLE_TRANSFORMER};
- return \%options;
- }
-
- sub get_immutable_transformer {
- my $self = shift;
- if( $self->is_mutable ){
- my $class = ref $self || $self;
- return $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer;
- }
- confess "unable to find transformer for immutable class"
- unless exists $IMMUTABLE_OPTIONS{$self->name};
- return $IMMUTABLE_OPTIONS{$self->name}->{IMMUTABLE_TRANSFORMER};
- }
+sub make_immutable {
+ my $self = shift;
- sub make_immutable {
- my $self = shift;
- my %options = @_;
+ return if $self->is_immutable;
- my $transformer = $self->get_immutable_transformer;
- $transformer->make_metaclass_immutable($self, \%options);
- $IMMUTABLE_OPTIONS{$self->name} =
- { %options, IMMUTABLE_TRANSFORMER => $transformer };
+ my $transformer = $self->immutable_transformer
+ || $self->_make_immutable_transformer(@_);
- if( exists $options{debug} && $options{debug} ){
- print STDERR "# of Metaclass options: ", keys %IMMUTABLE_OPTIONS;
- print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS;
- }
+ $self->_set_immutable_transformer($transformer);
- 1;
- }
-
- sub make_mutable{
- my $self = shift;
- return if $self->is_mutable;
- my $options = delete $IMMUTABLE_OPTIONS{$self->name};
- confess "unable to find immutabilizing options" unless ref $options;
- my $transformer = delete $options->{IMMUTABLE_TRANSFORMER};
- $transformer->make_metaclass_mutable($self, $options);
- 1;
- }
+ $transformer->make_metaclass_immutable;
}
-sub create_immutable_transformer {
- my $self = shift;
- my $class = Class::MOP::Immutable->new($self, {
+{
+ my %Default_Immutable_Options = (
read_only => [qw/superclasses/],
- cannot_call => [qw/
- add_method
- alias_method
- remove_method
- add_attribute
- remove_attribute
- remove_package_symbol
- /],
- memoize => {
- class_precedence_list => 'ARRAY',
- linearized_isa => 'ARRAY', # FIXME perl 5.10 memoizes this on its own, no need?
- get_all_methods => 'ARRAY',
- #get_all_attributes => 'ARRAY', # it's an alias, no need, but maybe in the future
- compute_all_applicable_attributes => 'ARRAY',
- get_meta_instance => 'SCALAR',
- get_method_map => 'SCALAR',
+ cannot_call => [
+ qw(
+ add_method
+ alias_method
+ remove_method
+ add_attribute
+ remove_attribute
+ remove_package_symbol
+ )
+ ],
+ memoize => {
+ class_precedence_list => 'ARRAY',
+ # FIXME perl 5.10 memoizes this on its own, no need?
+ linearized_isa => 'ARRAY',
+ get_all_methods => 'ARRAY',
+ get_all_method_names => 'ARRAY',
+ compute_all_applicable_attributes => 'ARRAY',
+ get_meta_instance => 'SCALAR',
+ get_method_map => 'SCALAR',
},
+
# NOTE:
- # this is ugly, but so are typeglobs,
+ # this is ugly, but so are typeglobs,
# so whattayahgonnadoboutit
# - SL
- wrapped => {
+ wrapped => {
add_package_symbol => sub {
my $original = shift;
- confess "Cannot add package symbols to an immutable metaclass"
- unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol';
+ confess "Cannot add package symbols to an immutable metaclass"
+ unless ( caller(2) )[3] eq
+ 'Class::MOP::Package::get_package_symbol';
# This is a workaround for a bug in 5.8.1 which thinks that
# goto $original->body
@@ -1122,8 +1030,29 @@ sub create_immutable_transformer {
goto $body;
},
},
- });
- return $class;
+ );
+
+ sub _default_immutable_transformer_options {
+ return %Default_Immutable_Options;
+ }
+}
+
+sub _make_immutable_transformer {
+ my $self = shift;
+
+ Class::MOP::Immutable->new(
+ $self,
+ $self->_default_immutable_transformer_options,
+ @_
+ );
+}
+
+sub make_mutable {
+ my $self = shift;
+
+ return if $self->is_mutable;
+
+ $self->immutable_transformer->make_metaclass_mutable;
}
1;
@@ -1144,275 +1073,209 @@ Class::MOP::Class - Class Meta Object
# use this for introspection ...
# add a method to Foo ...
- Foo->meta->add_method('bar' => sub { ... })
+ Foo->meta->add_method( 'bar' => sub {...} )
- # get a list of all the classes searched
- # the method dispatcher in the correct order
- Foo->meta->class_precedence_list()
+ # get a list of all the classes searched
+ # the method dispatcher in the correct order
+ Foo->meta->class_precedence_list()
- # remove a method from Foo
- Foo->meta->remove_method('bar');
+ # remove a method from Foo
+ Foo->meta->remove_method('bar');
# or use this to actually create classes ...
- Class::MOP::Class->create('Bar' => (
- version => '0.01',
- superclasses => [ 'Foo' ],
- attributes => [
- Class::MOP:::Attribute->new('$bar'),
- Class::MOP:::Attribute->new('$baz'),
- ],
- methods => {
- calculate_bar => sub { ... },
- construct_baz => sub { ... }
- }
- ));
+ Class::MOP::Class->create(
+ 'Bar' => (
+ version => '0.01',
+ superclasses => ['Foo'],
+ attributes => [
+ Class::MOP:: : Attribute->new('$bar'),
+ Class::MOP:: : Attribute->new('$baz'),
+ ],
+ methods => {
+ calculate_bar => sub {...},
+ construct_baz => sub {...}
+ }
+ )
+ );
=head1 DESCRIPTION
-This is the largest and currently most complex part of the Perl 5
-meta-object protocol. It controls the introspection and
-manipulation of Perl 5 classes (and it can create them too). The
+The Class Protocol is the largest and most complex part of the
+Class::MOP meta-object protocol. It controls the introspection and
+manipulation of Perl 5 classes, and it can create them as well. The
best way to understand what this module can do, is to read the
-documentation for each of it's methods.
-
-=head1 METHODS
-
-=head2 Self Introspection
-
-=over 4
-
-=item B
+documentation for each of its methods.
-This will return a B instance which is related
-to this class. Thereby allowing B to actually
-introspect itself.
+=head1 INHERITANCE
-As with B, B will actually
-bootstrap this module by installing a number of attribute meta-objects
-into it's metaclass. This will allow this class to reap all the benifits
-of the MOP when subclassing it.
+C is a subclass of L.
-=back
+=head1 METHODS
=head2 Class construction
-These methods will handle creating B objects,
-which can be used to both create new classes, and analyze
-pre-existing classes.
+These methods all create new C objects. These
+objects can represent existing classes, or they can be used to create
+new classes from scratch.
-This module will internally store references to all the instances
-you create with these methods, so that they do not need to be
-created any more than nessecary. Basically, they are singletons.
+The metaclass object for a given class is a singleton. If you attempt
+to create a metaclass for the same class twice, you will just get the
+existing object.
=over 4
-=item B ?$version,
- authority =E ?$authority,
- superclasses =E ?@superclasses,
- methods =E ?%methods,
- attributes =E ?%attributes)>
-
-This returns a B object, bringing the specified
-C<$package_name> into existence and adding any of the C<$version>,
-C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to
-it.
+=item B<< Class::MOP::Class->create($package_name, %options) >>
-=item B ?@superclasses,
- methods =E ?%methods,
- attributes =E ?%attributes)>
+This method creates a new C object with the given
+package name. It accepts a number of options.
-This will create an anonymous class, it works much like C but
-it does not need a C<$package_name>. Instead it will create a suitably
-unique package name for you to stash things into.
+=over 8
-On very important distinction is that anon classes are destroyed once
-the metaclass they are attached to goes out of scope. In the DESTROY
-method, the created package will be removed from the symbol table.
+=item * version
-It is also worth noting that any instances created with an anon-class
-will keep a special reference to the anon-meta which will prevent the
-anon-class from going out of scope until all instances of it have also
-been destroyed. This however only works for HASH based instance types,
-as we use a special reserved slot (C<__MOP__>) to store this.
+An optional version number for the newly created package.
-=item B
+=item * authority
-This initializes and returns returns a B object
-for a given a C<$package_name>.
+An optional authority for the newly created package.
-=item B
+=item * superclasses
-This will construct an instance of B, it is
-here so that we can actually "tie the knot" for B
-to use C once all the bootstrapping is done. This
-method is used internally by C and should never be called
-from outside of that method really.
+An optional array reference of superclass names.
-=item B
+=item * methods
-This method is called as the very last thing in the
-C method. This will check that the
-metaclass you are creating is compatible with the metaclasses of all
-your ancestors. For more inforamtion about metaclass compatibility
-see the C section in L.
+An optional hash reference of methods for the class. The keys of the
+hash reference are method names, and values are subroutine references.
-=item B
+=item * attributes
-This will reset the package cache flag for this particular metaclass
-it is basically the value of the C
-function. This is very rarely needed from outside of C
-but in some cases you might want to use it, so it is here.
+An optional array reference of attributes.
-=item B
+An attribute can be passed as an existing L
+object, I or as a hash reference of options which will be passed
+to the attribute metaclass's constructor.
-Clears the package cache flag to announce to the internals that we need
-to rebuild the method map.
-
-=item B
-
-Registers this class as dependent on its superclasses.
-
-Only superclasses from which this class inherits attributes will be added.
-
-=item B
+=back
-Unregisters this class from its superclasses.
+=item B<< Class::MOP::Class->create_anon_class(%options) >>
-=item B
+This method works just like C<< Class::MOP::Class->create >> but it
+creates an "anonymous" class. In fact, the class does have a name, but
+that name is a unique name generated internally by this module.
-Reregisters if necessary.
+It accepts the same C, C, and C
+parameters that C accepts.
-=item B $metaclass
+Anonymous classes are destroyed once the metaclass they are attached
+to goes out of scope, and will be removed from Perl's internal symbol
+table.
-Registers the class as having a meta instance dependent on this class.
+All instances of an anonymous class keep a special reference to the
+metaclass object, which prevents the metaclass from going out of scope
+while any instances exist.
-=item B $metaclass
+This only works if the instance if based on a hash reference, however.
-Remove the class from the list of dependent classes.
+=item B<< Class::MOP::Class->initialize($package_name, %options) >>
-=item B
+This method will initialize a C object for the
+named package. Unlike C, this method I create a new
+class.
-Clears the cached meta instance for this metaclass and all of the registered
-classes with dependent meta instances.
+The purpose of this method is to retrieve a C
+object for introspecting an existing class.
-Called by C and C to recalculate the attribute
-slots.
+If an existing C object exists for the named
+package, it will be returned, and any options provided will be
+ignored!
-=item B
+If the object does not yet exist, it will be created.
-Used by C.
+The valid options that can be passed to this method are
+C, C,
+C, and C. These are all
+optional, and default to the appropriate class in the C
+distribution.
=back
=head2 Object instance construction and cloning
-These methods are B, it is up to you whether you want
-to use them or not.
+These methods are all related to creating and/or cloning object
+instances.
=over 4
-=item B
+=item B<< $metaclass->clone_object($instance, %params) >>
-Returns the class name of the instance metaclass, see L
-for more information on the instance metaclasses.
+This method clones an existing object instance. Any parameters you
+provide are will override existing attribute values in the object.
-=item B
+This is a convenience method for cloning an object instance, then
+blessing it into the appropriate package.
-Returns an instance of L to be used in the construction
-of a new instance of the class.
+You could implement a clone method in your class, using this method:
-=item B
-
-Called by C if necessary.
-
-=item B
-
-This is a convience method for creating a new object of the class, and
-blessing it into the appropriate package as well. Ideally your class
-would call a C this method like so:
-
- sub MyClass::new {
- my ($class, %param) = @_;
- $class->meta->new_object(%params);
+ sub clone {
+ my ($self, %params) = @_;
+ $self->meta->clone_object($self, %params);
}
-=item B
+=item B<< $metaclass->rebless_instance($instance, %params) >>
-This method is used to construct an instance structure suitable for
-C-ing into your package of choice. It works in conjunction
-with the Attribute protocol to collect all applicable attributes.
+This method changes the class of C<$instance> to the metaclass's class.
-This will construct and instance using a HASH ref as storage
-(currently only HASH references are supported). This will collect all
-the applicable attributes and layout out the fields in the HASH ref,
-it will then initialize them using either use the corresponding key
-in C<%params> or any default value or initializer found in the
-attribute meta-object.
+You can only rebless an instance into a subclass of its current
+class. If you pass any additional parameters, these will be treated
+like constructor parameters and used to initialize the object's
+attributes. Any existing attributes that are already set will be
+overwritten.
-=item B
+=item B<< $metaclass->new_object(%params) >>
-This is a convience method for cloning an object instance, then
-blessing it into the appropriate package. This method will call
-C, which performs a shallow copy of the object,
-see that methods documentation for more details. Ideally your
-class would call a C this method like so:
+This method is used to create a new object of the metaclass's
+class. Any parameters you provide are used to initialize the
+instance's attributes.
- sub MyClass::clone {
- my ($self, %param) = @_;
- $self->meta->clone_object($self, %params);
- }
-
-=item B
-
-This method is a compliment of C (which means if
-you override C, you need to override this one too),
-and clones the instance shallowly.
-
-The cloned structure returned is (like with C) an
-unCed HASH reference, it is your responsibility to then bless
-this cloned structure into the right class (which C will
-do for you).
+=item B<< $metaclass->instance_metaclass >>
-As of 0.11, this method will clone the C<$instance> structure shallowly,
-as opposed to the deep cloning implemented in prior versions. After much
-thought, research and discussion, I have decided that anything but basic
-shallow cloning is outside the scope of the meta-object protocol. I
-think Yuval "nothingmuch" Kogman put it best when he said that cloning
-is too I to be part of the MOP.
+Returns the class name of the instance metaclass, see
+L for more information on the instance
+metaclass.
-=item B
+=item B<< $metaclass->get_meta_instance >>
-This will change the class of C<$instance> to the class of the invoking
-C. You may only rebless the instance to a subclass of
-itself. You may pass in optional C<%params> which are like constructor
-params and will override anything already defined in the instance.
+Returns an instance of the C to be used in the
+construction of a new instance of the class.
=back
-=head2 Informational
+=head2 Informational predicates
-These are a few predicate methods for asking information about the class.
+These are a few predicate methods for asking information about the
+class itself.
=over 4
-=item B
+=item B<< $metaclass->is_anon_class >>
-This returns true if the class is a C created anon class.
+This returns true if the class was created by calling C<<
+Class::MOP::Class->create_anon_class >>.
-=item B
+=item B<< $metaclass->is_mutable >>
This returns true if the class is still mutable.
-=item B
+=item B<< $metaclass->is_immutable >>
This returns true if the class has been made immutable.
-=item B
+=item B<< $metaclass->is_pristine >>
-Checks whether the class has any data that will be lost if C is
-called.
+A class is I pristine if it has non-inherited attributes or if it
+has any generated methods.
=back
@@ -1420,374 +1283,378 @@ called.
=over 4
-=item B
+=item B<< $metaclass->superclasses(@superclasses) >>
-This is a read-write attribute which represents the superclass
-relationships of the class the B instance is
-associated with. Basically, it can get and set the C<@ISA> for you.
+This is a read-write accessor which represents the superclass
+relationships of the metaclass's class.
-=item B
+This is basically sugar around getting and setting C<@ISA>.
-This computes the a list of all the class's ancestors in the same order
-in which method dispatch will be done. This is similair to what
-B does, but we don't remove duplicate names.
+=item B<< $metaclass->class_precedence_list >>
-=item B
+This returns a list of all of the class's ancestor classes. The
+classes are returned in method dispatch order.
-This returns a list based on C but with all
+=item B<< $metaclass->linearized_isa >>
+
+This returns a list based on C but with all
duplicates removed.
-=item B
+=item B<< $metaclass->subclasses >>
-This returns a list of subclasses for this class.
+This returns a list of subclasses for this class.
=back
-=head2 Methods
+=head2 Method introspection and creation
+
+These methods allow you to introspect a class's methods, as well as
+add, remove, or change methods.
+
+Determining what is truly a method in a Perl 5 class requires some
+heuristics (aka guessing).
+
+Methods defined outside the package with a fully qualified name (C) will be included. Similarly, methods named
+with a fully qualified name using L are also included.
+
+However, we attempt to ignore imported functions.
+
+Ultimately, we are using heuristics to determine what truly is a
+method in a class, and these heuristics may get the wrong answer in
+some edge cases. However, for most "normal" cases the heuristics work
+correctly.
=over 4
-=item B
+=item B<< $metaclass->get_method($method_name) >>
-Returns a HASH ref of name to CODE reference mapping for this class.
+This will return a L for the specified
+C<$method_name>. If the class does not have the specified method, it
+returns C
-=item B
+=item B<< $metaclass->has_method($method_name) >>
-Returns the class name of the method metaclass, see L
-for more information on the method metaclasses.
+Returns a boolean indicating whether or not the class defines the
+named method. It does not include methods inherited from parent
+classes.
-=item B
+=item B<< $metaclass->get_method_map >>
-Wrap a code ref (C<$attrs{body>) with C.
+Returns a hash reference representing the methods defined in this
+class. The keys are method names and the values are
+L objects.
-=item B
+=item B<< $metaclass->get_method_list >>
-This will take a C<$method_name> and CODE reference or meta method
-objectand install it into the class's package.
+This will return a list of method I for all methods defined in
+this class.
-You are strongly encouraged to pass a meta method object instead of a
-code reference. If you do so, that object gets stored as part of the
-class's method map, providing more useful information about the method
-for introspection.
+=item B<< $metaclass->get_all_methods >>
-When you provide a method object, this method will clone that object
-if the object's package name does not match the class name. This lets
-us track the original source of any methods added from other classes
-(notably Moose roles).
+This will traverse the inheritance hierarchy and return a list of all
+the L objects for this class and its parents.
-B:
-This does absolutely nothing special to C<$method>
-other than use B to make sure it is tagged with the
-correct name, and therefore show up correctly in stack traces and
-such.
+=item B<< $metaclass->find_method_by_name($method_name) >>
-=item B
+This will return a L for the specified
+C<$method_name>. If the class does not have the specified method, it
+returns C
-This just provides a simple way to check if the class implements
-a specific C<$method_name>. It will I however, attempt to check
-if the class inherits the method (use C for that).
+Unlike C, this method I look for the named method in
+superclasses.
-This will correctly handle functions defined outside of the package
-that use a fully qualified name (C).
+=item B<< $metaclass->get_all_method_names >>
-This will correctly handle functions renamed with B and
-installed using the symbol tables. However, if you are naming the
-subroutine outside of the package scope, you must use the fully
-qualified name, including the package name, for C to
-correctly identify it.
+This will return a list of method I for all of this class's
+methods, including inherited methods.
-This will attempt to correctly ignore functions imported from other
-packages using B. It breaks down if the function imported
-is an C<__ANON__> sub (such as with C