use Sub::Name 'subname';
use B 'svref_2object';
-our $VERSION = '0.15';
+our $VERSION = '0.19';
+our $AUTHORITY = 'cpan:STEVAN';
use base 'Class::MOP::Module';
sub meta { Class::MOP::Class->initialize(blessed($_[0]) || $_[0]) }
-# Class globals ...
-
-# NOTE:
-# we need a sufficiently annoying prefix
-# this should suffice for now, this is
-# used in a couple of places below, so
-# need to put it up here for now.
-my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';
-
# Creation
-
-{
- # Metaclasses are singletons, so we cache them here.
- # 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;
- # means of accessing all the metaclasses that have
- # been initialized thus far (for mugwumps obj browser)
- sub get_all_metaclasses { %METAS }
- sub get_all_metaclass_instances { values %METAS }
- sub get_all_metaclass_names { keys %METAS }
+sub initialize {
+ my $class = shift;
+ my $package_name = shift;
+ (defined $package_name && $package_name && !blessed($package_name))
+ || confess "You must pass a package name and it cannot be blessed";
+ $class->construct_class_instance(':package' => $package_name, @_);
+}
+
+sub reinitialize {
+ my $class = shift;
+ my $package_name = shift;
+ (defined $package_name && $package_name && !blessed($package_name))
+ || confess "You must pass a package name and it cannot be blessed";
+ Class::MOP::remove_metaclass_by_name($package_name);
+ $class->construct_class_instance(':package' => $package_name, @_);
+}
- sub initialize {
- my $class = shift;
- my $package_name = shift;
- (defined $package_name && $package_name && !blessed($package_name))
- || confess "You must pass a package name and it cannot be blessed";
- $class->construct_class_instance(':package' => $package_name, @_);
+# NOTE: (meta-circularity)
+# this is a special form of &construct_instance
+# (see below), which is used to construct class
+# meta-object instances for any Class::MOP::*
+# class. All other classes will use the more
+# normal &construct_instance.
+sub construct_class_instance {
+ my $class = shift;
+ my %options = @_;
+ my $package_name = $options{':package'};
+ (defined $package_name && $package_name)
+ || confess "You must pass a package name";
+ # NOTE:
+ # return the metaclass if we have it cached,
+ # and it is still defined (it has not been
+ # reaped by DESTROY yet, which can happen
+ # annoyingly enough during global destruction)
+ return Class::MOP::get_metaclass_by_name($package_name)
+ if Class::MOP::does_metaclass_exist($package_name);
+
+ # NOTE:
+ # we need to deal with the possibility
+ # of class immutability here, and then
+ # get the name of the class appropriately
+ $class = (blessed($class)
+ ? ($class->is_immutable
+ ? $class->get_mutable_metaclass_name()
+ : blessed($class))
+ : $class);
+
+ $class = blessed($class) || $class;
+ # now create the metaclass
+ my $meta;
+ if ($class =~ /^Class::MOP::Class$/) {
+ no strict 'refs';
+ $meta = bless {
+ # inherited from Class::MOP::Package
+ '$:package' => $package_name,
+
+ # NOTE:
+ # since the following attributes will
+ # actually be loaded from the symbol
+ # table, and actually bypass the instance
+ # entirely, we can just leave these things
+ # listed here for reference, because they
+ # should not actually have a value associated
+ # with the slot.
+ '%:namespace' => \undef,
+ # inherited from Class::MOP::Module
+ '$:version' => \undef,
+ '$:authority' => \undef,
+ # defined in Class::MOP::Class
+
+ '%: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',
+ } => $class;
+ }
+ else {
+ # NOTE:
+ # it is safe to use meta here because
+ # class will always be a subclass of
+ # Class::MOP::Class, which defines meta
+ $meta = $class->meta->construct_instance(%options)
}
- sub reinitialize {
- my $class = shift;
- my $package_name = shift;
- (defined $package_name && $package_name && !blessed($package_name))
- || confess "You must pass a package name and it cannot be blessed";
- $METAS{$package_name} = undef;
- $class->construct_class_instance(':package' => $package_name, @_);
- }
+ # and check the metaclass compatibility
+ $meta->check_metaclass_compatability();
- # NOTE: (meta-circularity)
- # this is a special form of &construct_instance
- # (see below), which is used to construct class
- # meta-object instances for any Class::MOP::*
- # class. All other classes will use the more
- # normal &construct_instance.
- sub construct_class_instance {
- my $class = shift;
- my %options = @_;
- my $package_name = $options{':package'};
- (defined $package_name && $package_name)
- || confess "You must pass a package name";
- # NOTE:
- # return the metaclass if we have it cached,
- # and it is still defined (it has not been
- # reaped by DESTROY yet, which can happen
- # annoyingly enough during global destruction)
- return $METAS{$package_name}
- if exists $METAS{$package_name} && defined $METAS{$package_name};
+ Class::MOP::store_metaclass_by_name($package_name, $meta);
+
+ # NOTE:
+ # we need to weaken any anon classes
+ # so that they can call DESTROY properly
+ Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class;
+
+ $meta;
+}
+
+sub check_metaclass_compatability {
+ my $self = shift;
+
+ # this is always okay ...
+ return if blessed($self) eq 'Class::MOP::Class' &&
+ $self->instance_metaclass eq 'Class::MOP::Instance';
+ my @class_list = $self->class_precedence_list;
+ shift @class_list; # shift off $self->name
+
+ foreach my $class_name (@class_list) {
+ my $meta = Class::MOP::get_metaclass_by_name($class_name) || next;
+
# NOTE:
# we need to deal with the possibility
# of class immutability here, and then
- # get the name of the class appropriately
- $class = (blessed($class)
- ? ($class->is_immutable
- ? $class->get_mutable_metaclass_name()
- : blessed($class))
- : $class);
-
- $class = blessed($class) || $class;
- # now create the metaclass
- my $meta;
- if ($class =~ /^Class::MOP::/) {
- $meta = bless {
- '$:package' => $package_name,
- '%: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',
- } => $class;
- }
- else {
- # NOTE:
- # it is safe to use meta here because
- # class will always be a subclass of
- # Class::MOP::Class, which defines meta
- $meta = $class->meta->construct_instance(%options)
- }
- # and check the metaclass compatibility
- $meta->check_metaclass_compatability();
- $METAS{$package_name} = $meta;
+ # get the name of the class appropriately
+ my $meta_type = ($meta->is_immutable
+ ? $meta->get_mutable_metaclass_name()
+ : blessed($meta));
+
+ ($self->isa($meta_type))
+ || confess $self->name . "->meta => (" . (blessed($self)) . ")" .
+ " is not compatible with the " .
+ $class_name . "->meta => (" . ($meta_type) . ")";
# NOTE:
- # we need to weaken any anon classes
- # so that they can call DESTROY properly
- weaken($METAS{$package_name})
- if $package_name =~ /^$ANON_CLASS_PREFIX/;
- $meta;
- }
-
- sub check_metaclass_compatability {
- my $self = shift;
-
- # this is always okay ...
- return if blessed($self) eq 'Class::MOP::Class' &&
- $self->instance_metaclass eq 'Class::MOP::Instance';
-
- my @class_list = $self->class_precedence_list;
- shift @class_list; # shift off $self->name
-
- foreach my $class_name (@class_list) {
- my $meta = $METAS{$class_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()
- : blessed($meta));
-
- ($self->isa($meta_type))
- || confess $self->name . "->meta => (" . (blessed($self)) . ")" .
- " is not compatible with the " .
- $class_name . "->meta => (" . ($meta_type) . ")";
- # NOTE:
- # we also need to check that instance metaclasses
- # are compatabile in the same the class.
- ($self->instance_metaclass->isa($meta->instance_metaclass))
- || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" .
- " is not compatible with the " .
- $class_name . "->meta => (" . ($meta->instance_metaclass) . ")";
- }
- }
-}
+ # we also need to check that instance metaclasses
+ # are compatabile in the same the class.
+ ($self->instance_metaclass->isa($meta->instance_metaclass))
+ || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" .
+ " is not compatible with the " .
+ $class_name . "->meta => (" . ($meta->instance_metaclass) . ")";
+ }
+}
## ANON classes
# use case where it is not, write a test and
# I will change it.
my $ANON_CLASS_SERIAL = 0;
+
+ # NOTE:
+ # we need a sufficiently annoying prefix
+ # this should suffice for now, this is
+ # used in a couple of places below, so
+ # need to put it up here for now.
+ my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';
+
+ sub is_anon_class {
+ my $self = shift;
+ $self->name =~ /^$ANON_CLASS_PREFIX/ ? 1 : 0;
+ }
sub create_anon_class {
my ($class, %options) = @_;
my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
- return $class->create($package_name, '0.00', %options);
- }
-}
+ return $class->create($package_name, %options);
+ }
-# NOTE:
-# this will only get called for
-# anon-classes, all other calls
-# are assumed to occur during
-# global destruction and so don't
-# really need to be handled explicitly
-sub DESTROY {
- my $self = shift;
- return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
- my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
- no strict 'refs';
- foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
- delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
+ # NOTE:
+ # this will only get called for
+ # anon-classes, all other calls
+ # are assumed to occur during
+ # global destruction and so don't
+ # really need to be handled explicitly
+ sub DESTROY {
+ my $self = shift;
+ return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
+ my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
+ no strict 'refs';
+ foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
+ delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
+ }
+ delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};
}
- delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};
+
}
# creating classes with MOP ...
sub create {
- my ($class, $package_name, $package_version, %options) = @_;
+ my $class = shift;
+ my $package_name = shift;
+
(defined $package_name && $package_name)
|| confess "You must pass a package name";
+
+ (scalar @_ % 2 == 0)
+ || confess "You much pass all parameters as name => value pairs " .
+ "(I found an uneven number of params in \@_)";
+
+ my (%options) = @_;
+
my $code = "package $package_name;";
- $code .= "\$$package_name\:\:VERSION = '$package_version';"
- if defined $package_version;
+ $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
+ if exists $options{version};
+ $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
+ if exists $options{authority};
+
eval $code;
confess "creation of $package_name failed : $@" if $@;
+
my $meta = $class->initialize($package_name);
$meta->add_method('meta' => sub {
sub method_metaclass { $_[0]->{'$:method_metaclass'} }
sub instance_metaclass { $_[0]->{'$:instance_metaclass'} }
+sub get_method_map {
+ my $self = shift;
+ my $map = $self->{'%:methods'};
+
+ foreach my $symbol (grep { $self->has_package_symbol('&' . $_) } $self->list_all_package_symbols) {
+ next if exists $map->{$symbol} &&
+ $map->{$symbol}->body == $self->get_package_symbol('&' . $symbol);
+
+ $map->{$symbol} = $self->method_metaclass->wrap(
+ $self->get_package_symbol('&' . $symbol)
+ );
+ }
+
+ return $map;
+}
+
# Instance Construction & Cloning
sub new_object {
sub superclasses {
my $self = shift;
- no strict 'refs';
if (@_) {
my @supers = @_;
- @{$self->name . '::ISA'} = @supers;
+ @{$self->get_package_symbol('@ISA')} = @supers;
# NOTE:
# we need to check the metaclass
# compatability here so that we can
# we don't know about
$self->check_metaclass_compatability();
}
- @{$self->name . '::ISA'};
+ @{$self->get_package_symbol('@ISA')};
}
sub class_precedence_list {
(defined $method_name && $method_name)
|| confess "You must define a method name";
# use reftype here to allow for blessed subs ...
- ('CODE' eq (reftype($method) || ''))
- || confess "Your code block must be a CODE reference";
- my $full_method_name = ($self->name . '::' . $method_name);
-
- $method = $self->method_metaclass->wrap($method) unless blessed($method);
- no strict 'refs';
- no warnings 'redefine';
- *{$full_method_name} = subname $full_method_name => $method;
+ my $body;
+
+ if (blessed($method)) {
+
+ $body = $method->body;
+
+ ('CODE' eq (reftype($body) || ''))
+ || confess "Your code block must be a CODE reference";
+
+ $self->get_method_map->{$method_name} = $method;
+ }
+ else {
+
+ $body = $method;
+
+ ('CODE' eq (reftype($body) || ''))
+ || confess "Your code block must be a CODE reference";
+
+ $self->get_method_map->{$method_name} = $self->method_metaclass->wrap($body);
+
+ }
+
+ my $full_method_name = ($self->name . '::' . $method_name);
+ $self->add_package_symbol("&${method_name}" => subname $full_method_name => $body);
}
{
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 ...
- ('CODE' eq (reftype($method) || ''))
- || confess "Your code block must be a CODE reference";
- my $full_method_name = ($self->name . '::' . $method_name);
- $method = $self->method_metaclass->wrap($method) unless blessed($method);
+ my $body;
+
+ if (blessed($method)) {
+
+ $body = $method->body;
+
+ ('CODE' eq (reftype($body) || ''))
+ || confess "Your code block must be a CODE reference";
+
+ $self->get_method_map->{$method_name} = $method;
+ }
+ else {
+
+ $body = $method;
+
+ ('CODE' eq (reftype($body) || ''))
+ || confess "Your code block must be a CODE reference";
+
+ $self->get_method_map->{$method_name} = $self->method_metaclass->wrap($body);
+
+ }
- no strict 'refs';
- no warnings 'redefine';
- *{$full_method_name} = $method;
+ $self->add_package_symbol("&${method_name}" => $body);
}
sub has_method {
my ($self, $method_name) = @_;
(defined $method_name && $method_name)
|| confess "You must define a method name";
-
- my $sub_name = ($self->name . '::' . $method_name);
- no strict 'refs';
- return 0 if !defined(&{$sub_name});
- my $method = \&{$sub_name};
- return 0 if (svref_2object($method)->GV->STASH->NAME || '') ne $self->name &&
- (svref_2object($method)->GV->NAME || '') ne '__ANON__';
+ my $method_map = $self->get_method_map;
+
+ return 0 unless exists $self->get_method_map->{$method_name};
+
+ my $method = $method_map->{$method_name};
+ return 0 if ($method->package_name || '') ne $self->name &&
+ ($method->name || '') ne '__ANON__';
- # at this point we are relatively sure
- # it is our method, so we bless/wrap it
- $self->method_metaclass->wrap($method) unless blessed($method);
return 1;
}
my ($self, $method_name) = @_;
(defined $method_name && $method_name)
|| confess "You must define a method name";
-
+
return unless $self->has_method($method_name);
-
- no strict 'refs';
- return \&{$self->name . '::' . $method_name};
+
+ return $self->get_method_map->{$method_name};
}
sub remove_method {
my $removed_method = $self->get_method($method_name);
- no strict 'refs';
- delete ${$self->name . '::'}{$method_name}
+ $self->remove_package_symbol("&${method_name}")
if defined $removed_method;
+ delete $self->get_method_map->{$method_name}
+ if exists $self->get_method_map->{$method_name};
+
return $removed_method;
}
sub get_method_list {
my $self = shift;
- no strict 'refs';
- grep { $self->has_method($_) } keys %{$self->name . '::'};
+ return grep { $self->has_method($_) } keys %{$self->get_method_map};
+}
+
+sub find_method_by_name {
+ my ($self, $method_name) = @_;
+ # FIXME
+ return $self->name->can($method_name);
}
sub compute_all_applicable_methods {
$attribute->attach_to_class($self);
$attribute->install_accessors();
$self->get_attribute_map->{$attribute->name} = $attribute;
-
- # FIXME
- # in theory we have to tell everyone the slot structure may have changed
}
sub has_attribute {
# or use this to actually create classes ...
- Class::MOP::Class->create('Bar' => '0.01' => (
+ Class::MOP::Class->create('Bar' => (
+ version => '0.01',
superclasses => [ 'Foo' ],
attributes => [
Class::MOP:::Attribute->new('$bar'),
into it's metaclass. This will allow this class to reap all the benifits
of the MOP when subclassing it.
-=item B<get_all_metaclasses>
-
-This will return an hash of all the metaclass instances that have
-been cached by B<Class::MOP::Class> keyed by the package name.
-
-=item B<get_all_metaclass_instances>
-
-This will return an array of all the metaclass instances that have
-been cached by B<Class::MOP::Class>.
-
-=item B<get_all_metaclass_names>
-
-This will return an array of all the metaclass names that have
-been cached by B<Class::MOP::Class>.
-
=back
=head2 Class construction
=over 4
-=item B<create ($package_name, ?$package_version,
+=item B<create ($package_name,
+ version =E<gt> ?$version,
+ authority =E<gt> ?$authority,
superclasses =E<gt> ?@superclasses,
methods =E<gt> ?%methods,
attributes =E<gt> ?%attributes)>
This returns a B<Class::MOP::Class> object, bringing the specified
-C<$package_name> into existence and adding any of the
-C<$package_version>, C<@superclasses>, C<%methods> and C<%attributes>
-to it.
+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<create_anon_class (superclasses =E<gt> ?@superclasses,
methods =E<gt> ?%methods,
=head2 Informational
-=over 4
+These are a few predicate methods for asking information about the class.
-=item B<name>
+=over 4
-This is a read-only attribute which returns the package name for the
-given B<Class::MOP::Class> instance.
+=item B<is_anon_class>
-=item B<version>
+=item B<is_mutable>
-This is a read-only attribute which returns the C<$VERSION> of the
-package for the given B<Class::MOP::Class> instance.
+=item B<is_immutable>
=back
=over 4
+=item B<get_method_map>
+
=item B<method_metaclass>
=item B<add_method ($method_name, $method)>
This will return a CODE reference of the specified C<$method_name>,
or return undef if that method does not exist.
+=item B<find_method_by_name ($method_name>
+
+This will return a CODE reference of the specified C<$method_name>,
+or return undef if that method does not exist.
+
+Unlike C<get_method> this will also look in the superclasses.
+
=item B<remove_method ($method_name)>
This will attempt to remove a given C<$method_name> from the class.
=back
-=head2 Package Variables
-
-Since Perl's classes are built atop the Perl package system, it is
-fairly common to use package scoped variables for things like static
-class variables. The following methods are convience methods for
-the creation and inspection of package scoped variables.
-
-=over 4
-
-=item B<add_package_symbol ($variable_name, ?$initial_value)>
-
-Given a C<$variable_name>, which must contain a leading sigil, this
-method will create that variable within the package which houses the
-class. It also takes an optional C<$initial_value>, which must be a
-reference of the same type as the sigil of the C<$variable_name>
-implies.
-
-=item B<get_package_symbol ($variable_name)>
-
-This will return a reference to the package variable in
-C<$variable_name>.
-
-=item B<has_package_symbol ($variable_name)>
-
-Returns true (C<1>) if there is a package variable defined for
-C<$variable_name>, and false (C<0>) otherwise.
-
-=item B<remove_package_symbol ($variable_name)>
-
-This will attempt to remove the package variable at C<$variable_name>.
-
-=back
-
=head2 Class closing
=over 4
-=item B<is_mutable>
-
-=item B<is_immutable>
-
=item B<make_immutable>
=back
-=head1 AUTHOR
+=head1 AUTHORS
Stevan Little E<lt>stevan@iinteractive.comE<gt>
+Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
+
=head1 COPYRIGHT AND LICENSE
Copyright 2006 by Infinity Interactive, Inc.
projects / gitmo/Class-MOP.git / blobdiff