package Mouse::Meta::Class;
-use strict;
-use warnings;
+use Mouse::Util qw/:meta/; # enables strict and warnings
-use Scalar::Util qw/blessed weaken/;
+use Scalar::Util ();
-use Mouse::Util qw/get_linear_isa not_supported/;
-
-use Mouse::Meta::Method::Constructor;
-use Mouse::Meta::Method::Destructor;
use Mouse::Meta::Module;
+our @ISA = qw(Mouse::Meta::Module);
+
+our @CARP_NOT = qw(Mouse); # trust Mouse
+
+sub attribute_metaclass;
+sub method_metaclass;
-use base qw(Mouse::Meta::Module);
+sub constructor_class;
+sub destructor_class;
-sub method_metaclass(){ 'Mouse::Meta::Method' } # required for get_method()
sub _construct_meta {
my($class, %args) = @_;
- $args{attributes} ||= {};
- $args{methods} ||= {};
- $args{roles} ||= [];
+ $args{attributes} = {};
+ $args{methods} = {};
+ $args{roles} = [];
$args{superclasses} = do {
no strict 'refs';
\@{ $args{package} . '::ISA' };
};
- #return Mouse::Meta::Class->initialize($class)->new_object(%args)
- # if $class ne __PACKAGE__;
-
- return bless \%args, ref($class) || $class;
+ my $self = bless \%args, ref($class) || $class;
+ if(ref($self) ne __PACKAGE__){
+ $self->meta->_initialize_object($self, \%args);
+ }
+ return $self;
}
sub create_anon_class{
return $self->create(undef, @_);
}
-sub is_anon_class{
- return exists $_[0]->{anon_serial_id};
-}
+sub is_anon_class;
-sub roles { $_[0]->{roles} }
+sub roles;
+
+sub calculate_all_roles {
+ my $self = shift;
+ my %seen;
+ return grep { !$seen{ $_->name }++ }
+ map { $_->calculate_all_roles } @{ $self->roles };
+}
sub superclasses {
my $self = shift;
if (@_) {
- Mouse::load_class($_) for @_;
- @{ $self->{superclasses} } = @_;
+ foreach my $super(@_){
+ Mouse::Util::load_class($super);
+ my $meta = Mouse::Util::get_metaclass_by_name($super);
+ next if $self->verify_superclass($super, $meta);
+ $self->_reconcile_with_superclass_meta($meta);
+ }
+ return @{ $self->{superclasses} } = @_;
}
return @{ $self->{superclasses} };
}
-sub find_method_by_name{
+sub verify_superclass {
+ my($self, $super, $super_meta) = @_;
+
+ if(defined $super_meta) {
+ if(Mouse::Util::is_a_metarole($super_meta)){
+ $self->throw_error("You cannot inherit from a Mouse Role ($super)");
+ }
+ }
+ else {
+ # The metaclass of $super is not initialized.
+ # i.e. it might be Mouse::Object, a mixin package (e.g. Exporter),
+ # or a foreign class including Moose classes.
+ # See also Mouse::Foreign::Meta::Role::Class.
+ my $mm = $super->can('meta');
+ if(!($mm && $mm == \&Mouse::Util::meta)) {
+ if($super->can('new') or $super->can('DESTROY')) {
+ $self->inherit_from_foreign_class($super);
+ }
+ }
+ return 1; # always ok
+ }
+
+ return $self->isa(ref $super_meta); # checks metaclass compatibility
+}
+
+sub inherit_from_foreign_class {
+ my($class, $super) = @_;
+ Carp::carp("You inherit from non-Mouse class ($super),"
+ . " but it is unlikely to work correctly."
+ . " Please consider using MouseX::Foreign");
+ return;
+}
+
+my @MetaClassTypes = (
+ 'attribute', # Mouse::Meta::Attribute
+ 'method', # Mouse::Meta::Method
+ 'constructor', # Mouse::Meta::Method::Constructor
+ 'destructor', # Mouse::Meta::Method::Destructor
+);
+
+sub _reconcile_with_superclass_meta {
+ my($self, $other) = @_;
+
+ # find incompatible traits
+ my %metaroles;
+ foreach my $metaclass_type(@MetaClassTypes){
+ my $accessor = $self->can($metaclass_type . '_metaclass')
+ || $self->can($metaclass_type . '_class');
+
+ my $other_c = $other->$accessor();
+ my $self_c = $self->$accessor();
+
+ if(!$self_c->isa($other_c)){
+ $metaroles{$metaclass_type}
+ = [ $self_c->meta->_collect_roles($other_c->meta) ];
+ }
+ }
+
+ $metaroles{class} = [$self->meta->_collect_roles($other->meta)];
+
+ #use Data::Dumper; print Data::Dumper->new([\%metaroles], ['*metaroles'])->Indent(1)->Dump;
+
+ require Mouse::Util::MetaRole;
+ $_[0] = Mouse::Util::MetaRole::apply_metaroles(
+ for => $self,
+ class_metaroles => \%metaroles,
+ );
+ return;
+}
+
+sub _collect_roles {
+ my ($self, $other) = @_;
+
+ # find common ancestor
+ my @self_lin_isa = $self->linearized_isa;
+ my @other_lin_isa = $other->linearized_isa;
+
+ my(@self_anon_supers, @other_anon_supers);
+ push @self_anon_supers, shift @self_lin_isa while $self_lin_isa[0]->meta->is_anon_class;
+ push @other_anon_supers, shift @other_lin_isa while $other_lin_isa[0]->meta->is_anon_class;
+
+ my $common_ancestor = $self_lin_isa[0] eq $other_lin_isa[0] && $self_lin_isa[0];
+
+ if(!$common_ancestor){
+ $self->throw_error(sprintf '%s cannot have %s as a super class because of their metaclass incompatibility',
+ $self->name, $other->name);
+ }
+
+ my %seen;
+ return sort grep { !$seen{$_}++ } ## no critic
+ (map{ $_->name } map{ $_->meta->calculate_all_roles } @self_anon_supers),
+ (map{ $_->name } map{ $_->meta->calculate_all_roles } @other_anon_supers),
+ ;
+}
+
+
+sub find_method_by_name {
my($self, $method_name) = @_;
defined($method_name)
or $self->throw_error('You must define a method name to find');
+
foreach my $class( $self->linearized_isa ){
my $method = $self->initialize($class)->get_method($method_name);
return $method if defined $method;
sub get_all_methods {
my($self) = @_;
- return map{ $self->find_method_by_name($self) } $self->get_all_method_names;
+ return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
}
sub get_all_method_names {
$self->linearized_isa;
}
-sub add_attribute {
- my $self = shift;
-
- if (@_ == 1 && blessed($_[0])) {
- my $attr = shift @_;
- $self->{'attributes'}{$attr->name} = $attr;
- }
- else {
- my $names = shift @_;
- $names = [$names] if !ref($names);
- my $metaclass = 'Mouse::Meta::Attribute';
- my %options = (@_ == 1 ? %{$_[0]} : @_);
-
- if ( my $metaclass_name = delete $options{metaclass} ) {
- my $new_class = Mouse::Util::resolve_metaclass_alias(
- 'Attribute',
- $metaclass_name
- );
- if ( $metaclass ne $new_class ) {
- $metaclass = $new_class;
- }
- }
-
- for my $name (@$names) {
- if ($name =~ s/^\+//) {
- $metaclass->clone_parent($self, $name, %options);
- }
- else {
- $metaclass->create($self, $name, %options);
- }
- }
+sub find_attribute_by_name {
+ my($self, $name) = @_;
+ defined($name)
+ or $self->throw_error('You must define an attribute name to find');
+ foreach my $attr($self->get_all_attributes) {
+ return $attr if $attr->name eq $name;
}
+ return undef;
}
-sub compute_all_applicable_attributes { shift->get_all_attributes(@_) }
-sub get_all_attributes {
+sub add_attribute {
my $self = shift;
- my (@attr, %seen);
-
- for my $class ($self->linearized_isa) {
- my $meta = $self->_metaclass_cache($class)
- or next;
- for my $name (keys %{ $meta->get_attribute_map }) {
- next if $seen{$name}++;
- push @attr, $meta->get_attribute($name);
- }
- }
-
- return @attr;
-}
-
-sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
+ my($attr, $name);
-sub new_object {
- my $self = shift;
- my %args = (@_ == 1 ? %{$_[0]} : @_);
-
- my $instance = bless {}, $self->name;
+ if(Scalar::Util::blessed($_[0])){
+ $attr = $_[0];
- my @triggers_queue;
+ $attr->isa('Mouse::Meta::Attribute')
+ || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
- foreach my $attribute ($self->get_all_attributes) {
- my $from = $attribute->init_arg;
- my $key = $attribute->name;
+ $name = $attr->name;
+ }
+ else{
+ # _process_attribute
+ $name = shift;
- if (defined($from) && exists($args{$from})) {
- $args{$from} = $attribute->coerce_constraint($args{$from})
- if $attribute->should_coerce;
- $attribute->verify_against_type_constraint($args{$from});
+ my %args = (@_ == 1) ? %{$_[0]} : @_;
- $instance->{$key} = $args{$from};
+ defined($name)
+ or $self->throw_error('You must provide a name for the attribute');
- weaken($instance->{$key})
- if ref($instance->{$key}) && $attribute->is_weak_ref;
+ if ($name =~ s/^\+//) { # inherited attributes
+ my $inherited_attr = $self->find_attribute_by_name($name)
+ or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
- if ($attribute->has_trigger) {
- push @triggers_queue, [ $attribute->trigger, $args{$from} ];
- }
- }
- else {
- if ($attribute->has_default || $attribute->has_builder) {
- unless ($attribute->is_lazy) {
- my $default = $attribute->default;
- my $builder = $attribute->builder;
- my $value = $attribute->has_builder
- ? $instance->$builder
- : ref($default) eq 'CODE'
- ? $default->($instance)
- : $default;
-
- $value = $attribute->coerce_constraint($value)
- if $attribute->should_coerce;
- $attribute->verify_against_type_constraint($value);
-
- $instance->{$key} = $value;
-
- weaken($instance->{$key})
- if ref($instance->{$key}) && $attribute->is_weak_ref;
- }
- }
- else {
- if ($attribute->is_required) {
- $self->throw_error("Attribute (".$attribute->name.") is required");
- }
- }
+ $attr = $inherited_attr->clone_and_inherit_options(%args);
}
- }
-
- foreach my $trigger_and_value(@triggers_queue){
- my($trigger, $value) = @{$trigger_and_value};
- $trigger->($instance, $value);
- }
+ else{
+ my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
+ $args{traits} = \@traits if @traits;
- if($self->is_anon_class){
- $instance->{__METACLASS__} = $self;
+ $attr = $attribute_class->new($name, %args);
+ }
}
- return $instance;
-}
+ Scalar::Util::weaken( $attr->{associated_class} = $self );
-sub clone_object {
- my $class = shift;
- my $instance = shift;
+ # install accessors first
+ $attr->install_accessors();
- (blessed($instance) && $instance->isa($class->name))
- || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($instance)");
+ # then register the attribute to the metaclass
+ $attr->{insertion_order} = keys %{ $self->{attributes} };
+ $self->{attributes}{$name} = $attr;
+ delete $self->{_mouse_cache}; # clears internal cache
- $class->clone_instance($instance, @_);
+ if(!$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
+ Carp::carp(qq{Attribute ($name) of class }.$self->name
+ .qq{ has no associated methods (did you mean to provide an "is" argument?)});
+ }
+ return $attr;
}
-sub clone_instance {
- my ($class, $instance, %params) = @_;
-
- (blessed($instance))
- || $class->throw_error("You can only clone instances, ($instance) is not a blessed instance");
+sub _calculate_all_attributes {
+ my($self) = @_;
+ my %seen;
+ my @all_attrs;
+ foreach my $class($self->linearized_isa) {
+ my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
+ my @attrs = grep { !$seen{$_->name}++ } values %{$meta->{attributes}};
+ @attrs = sort {
+ $b->{insertion_order} <=> $a->{insertion_order}
+ } @attrs;
+ push @all_attrs, @attrs;
+ }
+ return [reverse @all_attrs];
+}
- my $clone = bless { %$instance }, ref $instance;
+sub linearized_isa;
- foreach my $attr ($class->get_all_attributes()) {
- if ( defined( my $init_arg = $attr->init_arg ) ) {
- if (exists $params{$init_arg}) {
- $clone->{ $attr->name } = $params{$init_arg};
- }
- }
- }
+sub new_object;
+sub clone_object;
- return $clone;
+sub immutable_options {
+ my ( $self, @args ) = @_;
+ return (
+ inline_constructor => 1,
+ inline_destructor => 1,
+ constructor_name => 'new',
+ @args,
+ );
}
sub make_immutable {
my $self = shift;
- my %args = (
- inline_constructor => 1,
- inline_destructor => 1,
- @_,
- );
+ my %args = $self->immutable_options(@_);
$self->{is_immutable}++;
if ($args{inline_constructor}) {
- $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
+ $self->add_method($args{constructor_name} =>
+ Mouse::Util::load_class($self->constructor_class)
+ ->_generate_constructor($self, \%args));
}
if ($args{inline_destructor}) {
- $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
+ $self->add_method(DESTROY =>
+ Mouse::Util::load_class($self->destructor_class)
+ ->_generate_destructor($self, \%args));
}
- # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
- # at the end of a source file.
+ # Moose's make_immutable returns true allowing calling code to skip
+ # setting an explicit true value at the end of a source file.
return 1;
}
-sub make_mutable { not_supported }
+sub make_mutable {
+ my($self) = @_;
+ $self->{is_immutable} = 0;
+ return;
+}
-sub is_immutable { $_[0]->{is_immutable} }
-sub is_mutable { !$_[0]->{is_immutable} }
+sub is_immutable;
+sub is_mutable { !$_[0]->is_immutable }
sub _install_modifier {
- my ( $self, $into, $type, $name, $code ) = @_;
-
- # which is modifer class available?
- my $modifier_class = do {
- if (eval "require Class::Method::Modifiers::Fast; 1") {
- 'Class::Method::Modifiers::Fast';
- } elsif (eval "require Class::Method::Modifiers; 1") {
- 'Class::Method::Modifiers';
- } else {
- Carp::croak("Method modifiers require the use of Class::Method::Modifiers or Class::Method::Modifiers::Fast. Please install it from CPAN and file a bug report with this application.");
- }
- };
- my $modifier = $modifier_class->can('_install_modifier');
-
- # replace this method itself :)
- {
- no warnings 'redefine';
- *_install_modifier = sub {
- my ( $self, $into, $type, $name, $code ) = @_;
- $modifier->(
- $into,
- $type,
- $name,
- $code
- );
- $self->{methods}{$name}++; # register it to the method map
- return;
+ my( $self, $type, $name, $code ) = @_;
+ my $into = $self->name;
+
+ my $original = $into->can($name)
+ or $self->throw_error("The method '$name' was not found in the inheritance hierarchy for $into");
+
+ my $modifier_table = $self->{modifiers}{$name};
+
+ if(!$modifier_table){
+ my(@before, @after, @around);
+ my $cache = $original;
+ my $modified = sub {
+ if(@before) {
+ for my $c (@before) { $c->(@_) }
+ }
+ unless(@after) {
+ return $cache->(@_);
+ }
+
+ if(wantarray){ # list context
+ my @rval = $cache->(@_);
+
+ for my $c(@after){ $c->(@_) }
+ return @rval;
+ }
+ elsif(defined wantarray){ # scalar context
+ my $rval = $cache->(@_);
+
+ for my $c(@after){ $c->(@_) }
+ return $rval;
+ }
+ else{ # void context
+ $cache->(@_);
+
+ for my $c(@after){ $c->(@_) }
+ return;
+ }
+ };
+
+ $self->{modifiers}{$name} = $modifier_table = {
+ original => $original,
+
+ before => \@before,
+ after => \@after,
+ around => \@around,
+
+ cache => \$cache, # cache for around modifiers
};
+
+ $self->add_method($name => $modified);
+ }
+
+ if($type eq 'before'){
+ unshift @{$modifier_table->{before}}, $code;
+ }
+ elsif($type eq 'after'){
+ push @{$modifier_table->{after}}, $code;
}
+ else{ # around
+ push @{$modifier_table->{around}}, $code;
- # call me. for first time.
- $self->_install_modifier( $into, $type, $name, $code );
+ my $next = ${ $modifier_table->{cache} };
+ ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
+ }
+
+ return;
}
sub add_before_method_modifier {
my ( $self, $name, $code ) = @_;
- $self->_install_modifier( $self->name, 'before', $name, $code );
+ $self->_install_modifier( 'before', $name, $code );
}
sub add_around_method_modifier {
my ( $self, $name, $code ) = @_;
- $self->_install_modifier( $self->name, 'around', $name, $code );
+ $self->_install_modifier( 'around', $name, $code );
}
sub add_after_method_modifier {
my ( $self, $name, $code ) = @_;
- $self->_install_modifier( $self->name, 'after', $name, $code );
+ $self->_install_modifier( 'after', $name, $code );
}
sub add_override_method_modifier {
my ($self, $name, $code) = @_;
+ if($self->has_method($name)){
+ $self->throw_error("Cannot add an override method if a local method is already present");
+ }
+
my $package = $self->name;
- my $body = $package->can($name)
+ my $super_body = $package->can($name)
or $self->throw_error("You cannot override '$name' because it has no super method");
- $self->add_method($name => sub { $code->($package, $body, @_) });
+ $self->add_method($name => sub {
+ local $Mouse::SUPER_PACKAGE = $package;
+ local $Mouse::SUPER_BODY = $super_body;
+ local @Mouse::SUPER_ARGS = @_;
+ &{$code};
+ });
+ return;
+}
+
+sub add_augment_method_modifier {
+ my ($self, $name, $code) = @_;
+ if($self->has_method($name)){
+ $self->throw_error("Cannot add an augment method if a local method is already present");
+ }
+
+ my $super = $self->find_method_by_name($name)
+ or $self->throw_error("You cannot augment '$name' because it has no super method");
+
+ my $super_package = $super->package_name;
+ my $super_body = $super->body;
+
+ $self->add_method($name => sub {
+ local $Mouse::INNER_BODY{$super_package} = $code;
+ local $Mouse::INNER_ARGS{$super_package} = [@_];
+ &{$super_body};
+ });
+ return;
}
sub does_role {
(defined $role_name)
|| $self->throw_error("You must supply a role name to look for");
+ $role_name = $role_name->name if ref $role_name;
+
for my $class ($self->linearized_isa) {
- my $meta = Mouse::Meta::Module::class_of($class);
- next unless $meta && $meta->can('roles');
+ my $meta = Mouse::Util::get_metaclass_by_name($class)
+ or next;
for my $role (@{ $meta->roles }) {
}
1;
-
__END__
=head1 NAME
-Mouse::Meta::Class - hook into the Mouse MOP
+Mouse::Meta::Class - The Mouse class metaclass
-=head1 METHODS
+=head1 VERSION
-=head2 initialize ClassName -> Mouse::Meta::Class
+This document describes Mouse version 0.76
-Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
-one instance should exist for a given class.
+=head1 DESCRIPTION
+
+This class is a meta object protocol for Mouse classes,
+which is a subset of Moose::Meta:::Class.
-=head2 new %args -> Mouse::Meta::Class
+=head1 METHODS
-Creates a new Mouse::Meta::Class. Don't call this directly.
+=head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
+
+Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
+one instance should exist for a given class.
-=head2 name -> ClassName
+=head2 C<< name -> ClassName >>
Returns the name of the owner class.
-=head2 superclasses -> [ClassName]
+=head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
Gets (or sets) the list of superclasses of the owner class.
-=head2 add_attribute (Mouse::Meta::Attribute| name => spec)
+=head2 C<< add_method(name => CodeRef) >>
+
+Adds a method to the owner class.
+
+=head2 C<< has_method(name) -> Bool >>
+
+Returns whether we have a method with the given name.
+
+=head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
+
+Returns a L<Mouse::Meta::Method> with the given name.
+
+Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
+
+=head2 C<< get_method_list -> Names >>
+
+Returns a list of method names which are defined in the local class.
+If you want a list of all applicable methods for a class, use the
+C<get_all_methods> method.
+
+=head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
+
+Return the list of all L<Mouse::Meta::Method> instances associated with
+the class and its superclasses.
+
+=head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
class.
-=head2 get_all_attributes -> (Mouse::Meta::Attribute)
+=head2 C<< has_attribute(Name) -> Bool >>
-Returns the list of all L<Mouse::Meta::Attribute> instances associated with
-this class and its superclasses.
+Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
-=head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
+=head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
-Returns a mapping of attribute names to their corresponding
-L<Mouse::Meta::Attribute> objects.
+Returns the L<Mouse::Meta::Attribute> with the given name.
-=head2 get_attribute_list -> { name => Mouse::Meta::Attribute }
+=head2 C<< get_attribute_list -> Names >>
-This returns a list of attribute names which are defined in the local
+Returns a list of attribute names which are defined in the local
class. If you want a list of all applicable attributes for a class,
use the C<get_all_attributes> method.
-=head2 has_attribute Name -> Bool
+=head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
-Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
+Returns the list of all L<Mouse::Meta::Attribute> instances associated with
+this class and its superclasses.
-=head2 get_attribute Name -> Mouse::Meta::Attribute | undef
+=head2 C<< linearized_isa -> [ClassNames] >>
-Returns the L<Mouse::Meta::Attribute> with the given name.
+Returns the list of classes in method dispatch order, with duplicates removed.
-=head2 linearized_isa -> [ClassNames]
+=head2 C<< new_object(Parameters) -> Instance >>
-Returns the list of classes in method dispatch order, with duplicates removed.
+Creates a new instance.
-=head2 clone_object Instance -> Instance
+=head2 C<< clone_object(Instance, Parameters) -> Instance >>
-Clones the given C<Instance> which must be an instance governed by this
+Clones the given instance which must be an instance governed by this
metaclass.
-=head2 clone_instance Instance, Parameters -> Instance
+=head2 C<< throw_error(Message, Parameters) >>
+
+Throws an error with the given message.
+
+=head1 SEE ALSO
+
+L<Mouse::Meta::Module>
+
+L<Moose::Meta::Class>
-The clone_instance method has been made private.
-The public version is deprecated.
+L<Class::MOP::Class>
=cut