use strict;
use warnings;
-use Carp 'confess';
-use Scalar::Util 'blessed', 'weaken', 'looks_like_number';
+use Scalar::Util 'blessed', 'weaken', 'looks_like_number', 'refaddr';
-our $VERSION = '0.11';
+our $VERSION = '0.75_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->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},
- # specific to this subclass
- '%!options' => $options{options},
- '$!meta_instance' => $options{metaclass}->get_meta_instance,
- '@!attributes' => [ $options{metaclass}->compute_all_applicable_attributes ],
- # ...
- '$!associated_metaclass' => $options{metaclass},
+ 'body' => undef,
+ 'package_name' => $options{package_name},
+ 'name' => $options{name},
+ 'options' => $options{options},
+ 'associated_metaclass' => $meta,
+ '_expected_method_class' => $options{_expected_method_class} || 'Moose::Object',
} => $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;
+ $self->_initialize_body;
return $self;
}
-## accessors
-
-sub options { (shift)->{'%!options'} }
-sub meta_instance { (shift)->{'$!meta_instance'} }
-sub attributes { (shift)->{'@!attributes'} }
-
-sub associated_metaclass { (shift)->{'$!associated_metaclass'} }
+# This is here so can_be_inlined can be inherited by MooseX modules.
+sub _expected_constructor_class {
+ return 'Moose::Object';
+}
## 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 initialize_body {
+sub _initialize_body {
my $self = shift;
# TODO:
# the %options should also include a both
$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 = (scalar @_ == 1) ? %{$_[0]} : @_;';
+ $source .= "\n if \$class ne '" . $self->associated_metaclass->name
+ . "';\n";
- $source .= "\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class');
+ $source .= $self->_generate_params('$params', '$class');
+ $source .= $self->_generate_instance('$instance', '$class');
+ $source .= $self->_generate_slot_initializers;
- $source .= ";\n" . (join ";\n" => map {
- $self->_generate_slot_initializer($_)
- } 0 .. (@{$self->attributes} - 1));
-
- $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 $@;
+ # 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_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 _generate_BUILDARGS {
+ my ( $self, $class, $args ) = @_;
+
+ my $buildargs = $self->associated_metaclass->find_method_by_name("BUILDARGS");
+
+ if ( $args eq '@_' and ( !$buildargs or $buildargs->body == \&Moose::Object::BUILDARGS ) ) {
+ return join("\n",
+ 'do {',
+ $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]}} : {@_};',
+ '}',
+ );
+ } else {
+ return $class . "->BUILDARGS($args)";
}
- $self->{'&!body'} = $code;
}
sub _generate_BUILDALL {
my $self = shift;
my @BUILD_calls;
foreach my $method (reverse $self->associated_metaclass->find_all_methods_by_name('BUILD')) {
- push @BUILD_calls => '$instance->' . $method->{class} . '::BUILD(\%params)';
+ push @BUILD_calls => '$instance->' . $method->{class} . '::BUILD($params)';
}
return join ";\n" => @BUILD_calls;
}
sub _generate_triggers {
my $self = shift;
my @trigger_calls;
- 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}"
- );
- }
- }
+ foreach my $i ( 0 .. $#{ $self->_attributes } ) {
+ my $attr = $self->_attributes->[$i];
+
+ 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,
+ )
+ . ', '
+ . ');' . "\n}";
}
- return join ";\n" => @trigger_calls;
+
+ return join ";\n" => @trigger_calls;
}
sub _generate_slot_initializer {
my $self = shift;
my $index = shift;
- my $attr = $self->attributes->[$index];
+ my $attr = $self->_attributes->[$index];
my @source = ('## ' . $attr->name);
my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
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";');
+ push @source => ('(exists $params->{\'' . $attr->init_arg . '\'}) ' .
+ '|| ' . $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 => 'if (exists $params->{\'' . $init_arg . '\'}) {';
+ 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;
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
push @source => "}" if defined $attr->init_arg;
}
elsif ( defined( my $init_arg = $attr->init_arg ) ) {
- push @source => '(exists $params{\'' . $init_arg . '\'}) && do {';
+ push @source => '(exists $params->{\'' . $init_arg . '\'}) && do {';
- push @source => ('my $val = $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(
}
else {
$source = (
- $self->meta_instance->inline_set_slot_value(
+ $self->_meta_instance->inline_set_slot_value(
'$instance',
- ("'" . $attr->name . "'"),
+ $attr->name,
$value
) . ';'
);
if ($is_moose && $attr->is_weak_ref) {
$source .= (
"\n" .
- $self->meta_instance->inline_weaken_slot_value(
+ $self->_meta_instance->inline_weaken_slot_value(
'$instance',
- ("'" . $attr->name . "'")
+ $attr->name
) .
' if ref ' . $value . ';'
);
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 . ');');
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 . ');'
);
}
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{"};
}
}
=head1 DESCRIPTION
-This is a subclass of L<Class::MOP::Method> 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<Class::MOP::Class::Constructor> that
+provides additional Moose-specific functionality
+
+To understand this class, you should read the the
+L<Class::MOP::Class::Constructor> documentation as well.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::Method::Constructor> is a subclass of
+L<Moose::Meta::Method> I<and> L<Class::MOP::Method::Constructor>.
=head1 METHODS
=over 4
-=item B<new>
+=item B<< $metamethod->can_be_inlined >>
-=item B<attributes>
+This returns true if the method can inlined.
-=item B<meta_instance>
+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<options>
+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<initialize_body>
+By default, it expects this constructor come from L<Moose::Object>,
+but subclasses can change this expectation.
-=item B<associated_metaclass>
+If the constructor cannot be inlined it warns that this is the case.
=back
=head1 COPYRIGHT AND LICENSE
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Moose.git / blobdiff