use Scalar::Util 'blessed', 'reftype';
use Sub::Name 'subname';
use B 'svref_2object';
+use Clone ();
our $VERSION = '0.03';
-# Self-introspection
+# Self-introspection
-sub meta { Class::MOP::Class->initialize($_[0]) }
+sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) }
# Creation
# there is no need to worry about destruction though
# because they should die only when the program dies.
# After all, do package definitions even get reaped?
- my %METAS;
+ my %METAS;
+
sub initialize {
my $class = shift;
my $package_name = shift;
|| confess "You must pass a package name";
# make sure the package name is not blessed
$package_name = blessed($package_name) || $package_name;
- return $METAS{$package_name} if exists $METAS{$package_name};
- $METAS{$package_name} = $class->construct_class_instance($package_name, @_);
+ $class->construct_class_instance(':package' => $package_name, @_);
}
# NOTE: (meta-circularity)
# normal &construct_instance.
sub construct_class_instance {
my $class = shift;
- my $package_name = shift;
+ my %options = @_;
+ my $package_name = $options{':package'};
(defined $package_name && $package_name)
- || confess "You must pass a package name";
+ || confess "You must pass a package name";
+ return $METAS{$package_name} if exists $METAS{$package_name};
$class = blessed($class) || $class;
+ # now create the metaclass
+ my $meta;
if ($class =~ /^Class::MOP::/) {
- bless {
+ $meta = bless {
'$:package' => $package_name,
'%:attributes' => {},
- '$:attribute_metaclass' => 'Class::MOP::Attribute',
- '$:method_metaclass' => 'Class::MOP::Method',
+ '$:attribute_metaclass' => $options{':attribute_metaclass'} || 'Class::MOP::Attribute',
+ '$:method_metaclass' => $options{':method_metaclass'} || 'Class::MOP::Method',
} => $class;
}
else {
# it is safe to use meta here because
# class will always be a subclass of
# Class::MOP::Class, which defines meta
- bless $class->meta->construct_instance(':package' => $package_name, @_) => $class
+ $meta = bless $class->meta->construct_instance(%options) => $class
}
+ # and check the metaclass compatibility
+ $meta->check_metaclass_compatability();
+ $METAS{$package_name} = $meta;
+ }
+
+ sub check_metaclass_compatability {
+ my $self = shift;
+
+ # this is always okay ...
+ return if blessed($self) eq 'Class::MOP::Class';
+
+ my @class_list = $self->class_precedence_list;
+ shift @class_list; # shift off $self->name
+
+ foreach my $class_name (@class_list) {
+ next unless $METAS{$class_name};
+ my $meta = $METAS{$class_name};
+ ($self->isa(blessed($meta)))
+ || confess $self->name . "->meta => (" . (blessed($self)) . ")" .
+ " is not compatible with the " .
+ $class_name . "->meta => (" . (blessed($meta)) . ")";
+ }
}
}
eval $code;
confess "creation of $package_name failed : $@" if $@;
my $meta = $class->initialize($package_name);
+
+ $meta->add_method('meta' => sub {
+ Class::MOP::Class->initialize(blessed($_[0]) || $_[0]);
+ });
+
$meta->superclasses(@{$options{superclasses}})
if exists $options{superclasses};
# NOTE:
return $meta;
}
+## Attribute readers
+
+# NOTE:
+# all these attribute readers will be bootstrapped
+# away in the Class::MOP bootstrap section
+
+sub name { $_[0]->{'$:package'} }
+sub get_attribute_map { $_[0]->{'%:attributes'} }
+sub attribute_metaclass { $_[0]->{'$:attribute_metaclass'} }
+sub method_metaclass { $_[0]->{'$:method_metaclass'} }
+
# Instance Construction & Cloning
sub new_object {
my $class = shift;
+ # NOTE:
+ # we need to protect the integrity of the
+ # Class::MOP::Class singletons here, so we
+ # delegate this to &construct_class_instance
+ # which will deal with the singletons
+ return $class->construct_class_instance(@_)
+ if $class->name->isa('Class::MOP::Class');
bless $class->construct_instance(@_) => $class->name;
}
my ($class, %params) = @_;
my $instance = {};
foreach my $attr ($class->compute_all_applicable_attributes()) {
- my $init_arg = $attr->has_init_arg() ? $attr->init_arg() : $attr->name;
+ my $init_arg = $attr->init_arg();
# try to fetch the init arg from the %params ...
my $val;
$val = $params{$init_arg} if exists $params{$init_arg};
sub clone_object {
my $class = shift;
- my $instance = shift;
- bless $class->clone_instance($instance, @_) => $class->name;
+ my $instance = shift;
+ (blessed($instance) && $instance->isa($class->name))
+ || confess "You must pass an instance ($instance) of the metaclass (" . $class->name . ")";
+ # NOTE:
+ # we need to protect the integrity of the
+ # Class::MOP::Class singletons here, they
+ # should not be cloned.
+ return $instance if $instance->isa('Class::MOP::Class');
+ bless $class->clone_instance($instance, @_) => blessed($instance);
}
sub clone_instance {
- my ($class, $self, %params) = @_;
- (blessed($self))
+ my ($class, $instance, %params) = @_;
+ (blessed($instance))
|| confess "You can only clone instances, \$self is not a blessed instance";
# NOTE:
- # this should actually do a deep clone
- # instead of this cheap hack. I will
- # add that in later.
- # (use the Class::Cloneable::Util code)
- my $clone = { %{$self} };
+ # This will deep clone, which might
+ # not be what you always want. So
+ # the best thing is to write a more
+ # controled &clone method locally
+ # in the class (see Class::MOP)
+ my $clone = Clone::clone($instance);
foreach my $attr ($class->compute_all_applicable_attributes()) {
- my $init_arg = $attr->has_init_arg() ? $attr->init_arg() : $attr->name;
+ my $init_arg = $attr->init_arg();
# try to fetch the init arg from the %params ...
$clone->{$attr->name} = $params{$init_arg}
if exists $params{$init_arg};
# Informational
-sub name { $_[0]->{'$:package'} }
+# &name should be here too, but it is above
+# because it gets bootstrapped away
sub version {
my $self = shift;
## Methods
-# un-used right now ...
-sub method_metaclass { $_[0]->{'$:method_metaclass'} }
-
sub add_method {
my ($self, $method_name, $method) = @_;
(defined $method_name && $method_name)
*{$full_method_name} = subname $full_method_name => $method;
}
+sub alias_method {
+ my ($self, $method_name, $method) = @_;
+ (defined $method_name && $method_name)
+ || confess "You must define a method name";
+ # use reftype here to allow for blessed subs ...
+ (reftype($method) && reftype($method) eq 'CODE')
+ || confess "Your code block must be a CODE reference";
+ my $full_method_name = ($self->name . '::' . $method_name);
+
+ no strict 'refs';
+ no warnings 'redefine';
+ *{$full_method_name} = $method;
+}
+
{
## private utility functions for has_method
next if $seen_class{$class};
$seen_class{$class}++;
# fetch the meta-class ...
- my $meta = $self->initialize($class);
+ my $meta = $self->initialize($class);;
push @methods => {
name => $method_name,
class => $class,
## Attributes
-sub attribute_metaclass { $_[0]->{'$:attribute_metaclass'} }
-
sub add_attribute {
my $self = shift;
# either we have an attribute object already
|| confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";
$attribute->attach_to_class($self);
$attribute->install_accessors();
- $self->{'%:attrs'}->{$attribute->name} = $attribute;
+ $self->get_attribute_map->{$attribute->name} = $attribute;
}
sub has_attribute {
my ($self, $attribute_name) = @_;
(defined $attribute_name && $attribute_name)
|| confess "You must define an attribute name";
- exists $self->{'%:attrs'}->{$attribute_name} ? 1 : 0;
+ exists $self->get_attribute_map->{$attribute_name} ? 1 : 0;
}
sub get_attribute {
my ($self, $attribute_name) = @_;
(defined $attribute_name && $attribute_name)
|| confess "You must define an attribute name";
- return $self->{'%:attrs'}->{$attribute_name}
+ return $self->get_attribute_map->{$attribute_name}
if $self->has_attribute($attribute_name);
}
my ($self, $attribute_name) = @_;
(defined $attribute_name && $attribute_name)
|| confess "You must define an attribute name";
- my $removed_attribute = $self->{'%:attrs'}->{$attribute_name};
- delete $self->{'%:attrs'}->{$attribute_name}
+ my $removed_attribute = $self->get_attribute_map->{$attribute_name};
+ delete $self->get_attribute_map->{$attribute_name}
if defined $removed_attribute;
$removed_attribute->remove_accessors();
$removed_attribute->detach_from_class();
sub get_attribute_list {
my $self = shift;
- keys %{$self->{'%:attrs'}};
+ keys %{$self->get_attribute_map};
}
sub compute_all_applicable_attributes {
delete ${$self->name . '::'}{$name};
}
+# class mixins
+
+sub mixin {
+ my ($self, $mixin) = @_;
+ $mixin = $self->initialize($mixin)
+ unless blessed($mixin);
+
+ my @attributes = map {
+ $mixin->get_attribute($_)->clone()
+ } $mixin->get_attribute_list;
+
+ my %methods = map {
+ my $method = $mixin->get_method($_);
+ (blessed($method) && $method->isa('Class::MOP::Attribute::Accessor'))
+ ? () : ($_ => $method)
+ } $mixin->get_method_list;
+
+ foreach my $attr (@attributes) {
+ $self->add_attribute($attr)
+ unless $self->has_attribute($attr->name);
+ }
+
+ foreach my $method_name (keys %methods) {
+ $self->alias_method($method_name => $methods{$method_name})
+ unless $self->has_method($method_name);
+ }
+}
+
1;
__END__
# use this for introspection ...
- package Foo;
- sub meta { Class::MOP::Class->initialize(__PACKAGE__) }
-
- # elsewhere in the code ...
-
# add a method to Foo ...
Foo->meta->add_method('bar' => sub { ... })
This initializes and returns returns a B<Class::MOP::Class> object
for a given a C<$package_name>.
-=item B<construct_class_instance ($package_name)>
+=item B<construct_class_instance (%options)>
This will construct an instance of B<Class::MOP::Class>, it is
here so that we can actually "tie the knot" for B<Class::MOP::Class>
method is used internally by C<initialize> and should never be called
from outside of that method really.
+=item B<check_metaclass_compatability>
+
+This method is called as the very last thing in the
+C<construct_class_instance> 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<About Metaclass compatibility> section in L<Class::MOP>.
+
=back
=head2 Object instance construction and cloning
correct name, and therefore show up correctly in stack traces and
such.
+=item B<alias_method ($method_name, $method)>
+
+This will take a C<$method_name> and CODE reference to that
+C<$method> and alias the method into the class's package.
+
+B<NOTE>:
+Unlike C<add_method>, this will B<not> try to name the
+C<$method> using B<Sub::Name>, it only aliases the method in
+the class's package.
+
=item B<has_method ($method_name)>
This just provides a simple way to check if the class implements
=item B<attribute_metaclass>
+=item B<get_attribute_map>
+
=item B<add_attribute ($attribute_name, $attribute_meta_object)>
This stores a C<$attribute_meta_object> in the B<Class::MOP::Class>
projects / gitmo/Class-MOP.git / blobdiff