X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FMethod%2FConstructor.pm;h=0a6dd36fe40af110148d674bed0d2f8da2b8d524;hb=baf46b9edc7dc3665c7eaf9d1684b157efb09e1a;hp=82d39cdc6351c20ae193222906c643a9068f022a;hpb=07b0f1a5599bf1a0ed99933200ca27290e9a468a;p=gitmo%2FMoose.git diff --git a/lib/Moose/Meta/Method/Constructor.pm b/lib/Moose/Meta/Method/Constructor.pm index 82d39cd..0a6dd36 100644 --- a/lib/Moose/Meta/Method/Constructor.pm +++ b/lib/Moose/Meta/Method/Constructor.pm @@ -4,61 +4,134 @@ package Moose::Meta::Method::Constructor; use strict; use warnings; -use Carp 'confess'; use Scalar::Util 'blessed', 'weaken', 'looks_like_number'; -our $VERSION = '0.51'; +our $VERSION = '0.72_01'; our $AUTHORITY = 'cpan:STEVAN'; use base 'Moose::Meta::Method', - 'Class::MOP::Method::Generated'; + 'Class::MOP::Method::Constructor'; sub new { my $class = shift; my %options = @_; - (exists $options{options} && ref $options{options} eq 'HASH') - || confess "You must pass a hash of options"; + my $meta = $options{metaclass}; + + (ref $options{options} eq 'HASH') + || $class->throw_error("You must pass a hash of options", data => $options{options}); ($options{package_name} && $options{name}) - || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT"; + || $class->throw_error("You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT"); my $self = bless { # from our superclass - '&!body' => undef, - '$!package_name' => $options{package_name}, - '$!name' => $options{name}, + 'body' => undef, + 'package_name' => $options{package_name}, + 'name' => $options{name}, # specific to this subclass - '%!options' => $options{options}, - '$!meta_instance' => $options{metaclass}->get_meta_instance, - '@!attributes' => [ $options{metaclass}->compute_all_applicable_attributes ], + 'options' => $options{options}, + 'meta_instance' => $meta->get_meta_instance, + 'attributes' => [ $meta->compute_all_applicable_attributes ], # ... - '$!associated_metaclass' => $options{metaclass}, + 'associated_metaclass' => $meta, } => $class; # we don't want this creating # a cycle in the code, if not # needed - weaken($self->{'$!associated_metaclass'}); + weaken($self->{'associated_metaclass'}); $self->initialize_body; return $self; } -## accessors +sub can_be_inlined { + my $self = shift; + my $metaclass = $self->associated_metaclass; + + my $expected_class = $self->_expected_constructor_class; + + # If any of our parents have been made immutable, we are okay to + # inline our own new method. The assumption is that an inlined new + # method provided by a parent does not actually get used by + # children anyway. + for my $meta ( + grep { $_->is_immutable } + map { ( ref $metaclass )->initialize($_) } + grep { $_ ne $expected_class } + $metaclass->linearized_isa + ) { + my $transformer = $meta->immutable_transformer; + + # This is actually a false positive if we're in a subclass of + # this class, _and_ the expected class is not overridden (but + # should be), and the real expected class is actually + # immutable itself (see Fey::Object::Table for an example of + # how this can happen). I'm not sure how to actually handle + # that case, since it's effectively a bug in the subclass (for + # not overriding _expected_constructor_class). + return 1 if $transformer->inlined_constructor; + } + + if ( my $constructor = $metaclass->find_method_by_name( $self->name ) ) { + my $class = $self->associated_metaclass->name; + + if ( $constructor->body != $expected_class->can('new') ) { + my $warning + = "Not inlining a constructor for $class since it is not" + . " inheriting the default $expected_class constructor\n" + . "If you are certain you don't need to inline your" + . " constructor, specify inline_constructor => 0 in your" + . " call to $class->meta->make_immutable\n"; + + $warning .= " (constructor has method modifiers which would be lost if it were inlined)\n" + if $constructor->isa('Class::MOP::Method::Wrapped'); + + warn $warning; -sub options { (shift)->{'%!options'} } -sub meta_instance { (shift)->{'$!meta_instance'} } -sub attributes { (shift)->{'@!attributes'} } + return 0; + } + else { + return 1; + } + } -sub associated_metaclass { (shift)->{'$!associated_metaclass'} } + # This would be a rather weird case where we have no constructor + # in the inheritance chain. + return 1; +} + +# This is here so can_be_inlined can be inherited by MooseX modules. +sub _expected_constructor_class { + return 'Moose::Object'; +} + +## accessors + +sub meta_instance { (shift)->{'meta_instance'} } +sub attributes { (shift)->{'attributes'} } ## method -# this was changed in 0.41, but broke MooseX::Singleton, so try to catch -# any other code using the original broken spelling -sub intialize_body { confess "Please correct the spelling of 'intialize_body' to 'initialize_body'" } +sub _generate_params { + my ($self, $var, $class_var) = @_; + "my $var = " . $self->_generate_BUILDARGS($class_var, '@_') . ";\n"; +} + +sub _generate_instance { + my ($self, $var, $class_var) = @_; + "my $var = " . $self->meta_instance->inline_create_instance($class_var) + . ";\n"; +} + +sub _generate_slot_initializers { + my ($self) = @_; + return (join ";\n" => map { + $self->_generate_slot_initializer($_) + } 0 .. (@{$self->attributes} - 1)) . ";\n"; +} sub initialize_body { my $self = shift; @@ -73,51 +146,50 @@ sub initialize_body { $source .= "\n" . 'my $class = shift;'; $source .= "\n" . 'return $class->Moose::Object::new(@_)'; - $source .= "\n" . ' if $class ne \'' . $self->associated_metaclass->name . '\';'; - - $source .= "\n" . 'my $params = ' . $self->_generate_BUILDARGS('$class', '@_'); - - $source .= ";\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class'); + $source .= "\n if \$class ne '" . $self->associated_metaclass->name + . "';\n"; - $source .= ";\n" . (join ";\n" => map { - $self->_generate_slot_initializer($_) - } 0 .. (@{$self->attributes} - 1)); + $source .= $self->_generate_params('$params', '$class'); + $source .= $self->_generate_instance('$instance', '$class'); + $source .= $self->_generate_slot_initializers; - $source .= ";\n" . $self->_generate_triggers(); + $source .= $self->_generate_triggers(); $source .= ";\n" . $self->_generate_BUILDALL(); - $source .= ";\n" . 'return $instance'; + $source .= ";\nreturn \$instance"; $source .= ";\n" . '}'; warn $source if $self->options->{debug}; - my $code; - { - # NOTE: - # create the nessecary lexicals - # to be picked up in the eval - my $attrs = $self->attributes; - - # We need to check if the attribute ->can('type_constraint') - # since we may be trying to immutabilize a Moose meta class, - # which in turn has attributes which are Class::MOP::Attribute - # objects, rather than Moose::Meta::Attribute. And - # Class::MOP::Attribute attributes have no type constraints. - # However we need to make sure we leave an undef value there - # because the inlined code is using the index of the attributes - # to determine where to find the type constraint - - my @type_constraints = map { - $_->can('type_constraint') ? $_->type_constraint : undef - } @$attrs; - - my @type_constraint_bodies = map { - defined $_ ? $_->_compiled_type_constraint : undef; - } @type_constraints; - - $code = eval $source; - confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@" if $@; - } - $self->{'&!body'} = $code; + # We need to check if the attribute ->can('type_constraint') + # since we may be trying to immutabilize a Moose meta class, + # which in turn has attributes which are Class::MOP::Attribute + # objects, rather than Moose::Meta::Attribute. And + # Class::MOP::Attribute attributes have no type constraints. + # However we need to make sure we leave an undef value there + # because the inlined code is using the index of the attributes + # to determine where to find the type constraint + + my $attrs = $self->attributes; + + my @type_constraints = map { + $_->can('type_constraint') ? $_->type_constraint : undef + } @$attrs; + + my @type_constraint_bodies = map { + defined $_ ? $_->_compiled_type_constraint : undef; + } @type_constraints; + + my $code = $self->_compile_code( + code => $source, + environment => { + '$meta' => \$self, + '$attrs' => \$attrs, + '@type_constraints' => \@type_constraints, + '@type_constraint_bodies' => \@type_constraint_bodies, + }, + ) or $self->throw_error("Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@", error => $@, data => $source ); + + $self->{'body'} = $code; } sub _generate_BUILDARGS { @@ -128,9 +200,8 @@ sub _generate_BUILDARGS { if ( $args eq '@_' and ( !$buildargs or $buildargs->body == \&Moose::Object::BUILDARGS ) ) { return join("\n", 'do {', - 'no warnings "uninitialized";', - 'confess "Single parameters to new() must be a HASH ref"', - ' if scalar @_ == 1 && defined $_[0] && ref($_[0]) ne q{HASH};', + $self->_inline_throw_error('"Single parameters to new() must be a HASH ref"', 'data => $_[0]'), + ' if scalar @_ == 1 && !( defined $_[0] && ref $_[0] eq q{HASH} );', '(scalar @_ == 1) ? {%{$_[0]}} : {@_};', '}', ); @@ -151,27 +222,33 @@ sub _generate_BUILDALL { sub _generate_triggers { my $self = shift; my @trigger_calls; - foreach my $i (0 .. $#{ $self->attributes }) { + foreach my $i ( 0 .. $#{ $self->attributes } ) { my $attr = $self->attributes->[$i]; - if ($attr->can('has_trigger') && $attr->has_trigger) { - if (defined(my $init_arg = $attr->init_arg)) { - push @trigger_calls => ( - '(exists $params->{\'' . $init_arg . '\'}) && do {' . "\n " - . '$attrs->[' . $i . ']->trigger->(' - . '$instance, ' - . $self->meta_instance->inline_get_slot_value( - '$instance', - ("'" . $attr->name . "'") - ) - . ', ' - . '$attrs->[' . $i . ']' - . ');' - ."\n}" - ); - } - } + + next unless $attr->can('has_trigger') && $attr->has_trigger; + + my $init_arg = $attr->init_arg; + + next unless defined $init_arg; + + push @trigger_calls => '(exists $params->{\'' + . $init_arg + . '\'}) && do {' + . "\n " + . '$attrs->[' + . $i + . ']->trigger->(' + . '$instance, ' + . $self->meta_instance->inline_get_slot_value( + '$instance', + $attr->name, + ) + . ', ' + . '$attrs->[' + . $i . ']' . ');' . "\n}"; } - return join ";\n" => @trigger_calls; + + return join ";\n" => @trigger_calls; } sub _generate_slot_initializer { @@ -186,34 +263,17 @@ sub _generate_slot_initializer { if ($is_moose && defined($attr->init_arg) && $attr->is_required && !$attr->has_default && !$attr->has_builder) { push @source => ('(exists $params->{\'' . $attr->init_arg . '\'}) ' . - '|| confess "Attribute (' . $attr->name . ') is required";'); + '|| ' . $self->_inline_throw_error('"Attribute (' . $attr->name . ') is required"') .';'); } if (($attr->has_default || $attr->has_builder) && !($is_moose && $attr->is_lazy)) { if ( defined( my $init_arg = $attr->init_arg ) ) { push @source => 'if (exists $params->{\'' . $init_arg . '\'}) {'; - - push @source => ('my $val = $params->{\'' . $init_arg . '\'};'); - - if ($is_moose && $attr->has_type_constraint) { - if ($attr->should_coerce && $attr->type_constraint->has_coercion) { - push @source => $self->_generate_type_coercion( - $attr, - '$type_constraints[' . $index . ']', - '$val', - '$val' - ); - } - push @source => $self->_generate_type_constraint_check( - $attr, - '$type_constraint_bodies[' . $index . ']', - '$type_constraints[' . $index . ']', - '$val' - ); - } - push @source => $self->_generate_slot_assignment($attr, '$val', $index); - + push @source => ('my $val = $params->{\'' . $init_arg . '\'};'); + push @source => $self->_generate_type_constraint_and_coercion($attr, $index) + if $is_moose; + push @source => $self->_generate_slot_assignment($attr, '$val', $index); push @source => "} else {"; } my $default; @@ -227,13 +287,8 @@ sub _generate_slot_initializer { push @source => '{'; # wrap this to avoid my $val overwrite warnings push @source => ('my $val = ' . $default . ';'); - push @source => $self->_generate_type_constraint_check( - $attr, - ('$type_constraint_bodies[' . $index . ']'), - ('$type_constraints[' . $index . ']'), - '$val' - ) if ($is_moose && $attr->has_type_constraint); - + push @source => $self->_generate_type_constraint_and_coercion($attr, $index) + if $is_moose; push @source => $self->_generate_slot_assignment($attr, '$val', $index); push @source => '}'; # close - wrap this to avoid my $val overrite warnings @@ -281,7 +336,7 @@ sub _generate_slot_assignment { $source = ( $self->meta_instance->inline_set_slot_value( '$instance', - ("'" . $attr->name . "'"), + $attr->name, $value ) . ';' ); @@ -294,7 +349,7 @@ sub _generate_slot_assignment { "\n" . $self->meta_instance->inline_weaken_slot_value( '$instance', - ("'" . $attr->name . "'") + $attr->name ) . ' if ref ' . $value . ';' ); @@ -303,6 +358,29 @@ sub _generate_slot_assignment { return $source; } +sub _generate_type_constraint_and_coercion { + my ($self, $attr, $index) = @_; + + return unless $attr->has_type_constraint; + + my @source; + if ($attr->should_coerce && $attr->type_constraint->has_coercion) { + push @source => $self->_generate_type_coercion( + $attr, + '$type_constraints[' . $index . ']', + '$val', + '$val' + ); + } + push @source => $self->_generate_type_constraint_check( + $attr, + ('$type_constraint_bodies[' . $index . ']'), + ('$type_constraints[' . $index . ']'), + '$val' + ); + return @source; +} + sub _generate_type_coercion { my ($self, $attr, $type_constraint_name, $value_name, $return_value_name) = @_; return ($return_value_name . ' = ' . $type_constraint_name . '->coerce(' . $value_name . ');'); @@ -311,11 +389,11 @@ sub _generate_type_coercion { sub _generate_type_constraint_check { my ($self, $attr, $type_constraint_cv, $type_constraint_obj, $value_name) = @_; return ( - $type_constraint_cv . '->(' . $value_name . ')' - . "\n\t" . '|| confess "Attribute (' + $self->_inline_throw_error('"Attribute (' # FIXME add 'dad' . $attr->name . ') does not pass the type constraint because: " . ' - . $type_constraint_obj . '->get_message(' . $value_name . ');' + . $type_constraint_obj . '->get_message(' . $value_name . ')') + . "\n\t unless " . $type_constraint_cv . '->(' . $value_name . ');' ); } @@ -331,13 +409,7 @@ sub _generate_default_value { return '$attrs->[' . $index . ']->default($instance)'; } else { - my $default = $attr->default; - # make sure to quote strings ... - unless (looks_like_number($default)) { - $default = "'$default'"; - } - - return $default; + return q{"} . quotemeta( $attr->default ) . q{"}; } } @@ -353,26 +425,37 @@ Moose::Meta::Method::Constructor - Method Meta Object for constructors =head1 DESCRIPTION -This is a subclass of L which handles -constructing an approprate Constructor methods. This is primarily -used in the making of immutable metaclasses, otherwise it is -not particularly useful. +This class is a subclass of L that +provides additional Moose-specific functionality + +To understand this class, you should read the the +L documentation as well. + +=head1 INHERITANCE + +C is a subclass of +L I L. =head1 METHODS =over 4 -=item B +=item B<< $metamethod->can_be_inlined >> -=item B +This returns true if the method can inlined. -=item B +First, it looks at all of the parents of the associated class. If any +of them have an inlined constructor, then the constructor can be +inlined. -=item B +If none of them have been inlined, it checks to make sure that the +pre-inlining constructor for the class matches the constructor from +the expected class. -=item B +By default, it expects this constructor come from L, +but subclasses can change this expectation. -=item B +If the constructor cannot be inlined it warns that this is the case. =back @@ -382,7 +465,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L