2 package Moose::Meta::Method::Constructor;
7 use Scalar::Util 'blessed', 'weaken', 'looks_like_number', 'refaddr';
10 our $AUTHORITY = 'cpan:STEVAN';
12 use base 'Moose::Meta::Method',
13 'Class::MOP::Method::Constructor';
19 my $meta = $options{metaclass};
21 (ref $options{options} eq 'HASH')
22 || $class->throw_error("You must pass a hash of options", data => $options{options});
24 ($options{package_name} && $options{name})
25 || $class->throw_error("You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT");
29 'package_name' => $options{package_name},
30 'name' => $options{name},
31 'options' => $options{options},
32 'associated_metaclass' => $meta,
33 '_expected_method_class' => $options{_expected_method_class} || 'Moose::Object',
36 # we don't want this creating
37 # a cycle in the code, if not
39 weaken($self->{'associated_metaclass'});
41 $self->_initialize_body;
46 # This is here so can_be_inlined can be inherited by MooseX modules.
47 sub _expected_constructor_class {
48 return 'Moose::Object';
53 sub _initialize_body {
56 # the %options should also include a both
57 # a call 'initializer' and call 'SUPER::'
58 # options, which should cover approx 90%
59 # of the possible use cases (even if it
60 # requires some adaption on the part of
61 # the author, after all, nothing is free)
63 $source .= "\n" . 'my $class = shift;';
65 $source .= "\n" . 'return $class->Moose::Object::new(@_)';
66 $source .= "\n if \$class ne '" . $self->associated_metaclass->name
69 $source .= $self->_generate_params('$params', '$class');
70 $source .= $self->_generate_instance('$instance', '$class');
71 $source .= $self->_generate_slot_initializers;
73 $source .= $self->_generate_triggers();
74 $source .= ";\n" . $self->_generate_BUILDALL();
76 $source .= ";\nreturn \$instance";
77 $source .= ";\n" . '}';
78 warn $source if $self->options->{debug};
80 # We need to check if the attribute ->can('type_constraint')
81 # since we may be trying to immutabilize a Moose meta class,
82 # which in turn has attributes which are Class::MOP::Attribute
83 # objects, rather than Moose::Meta::Attribute. And
84 # Class::MOP::Attribute attributes have no type constraints.
85 # However we need to make sure we leave an undef value there
86 # because the inlined code is using the index of the attributes
87 # to determine where to find the type constraint
89 my $attrs = $self->_attributes;
91 my @type_constraints = map {
92 $_->can('type_constraint') ? $_->type_constraint : undef
95 my @type_constraint_bodies = map {
96 defined $_ ? $_->_compiled_type_constraint : undef;
99 my ( $code, $e ) = $self->_compile_code(
104 '@type_constraints' => \@type_constraints,
105 '@type_constraint_bodies' => \@type_constraint_bodies,
110 "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$e",
111 error => $e, data => $source )
114 $self->{'body'} = $code;
117 sub _generate_params {
118 my ( $self, $var, $class_var ) = @_;
119 "my $var = " . $self->_generate_BUILDARGS( $class_var, '@_' ) . ";\n";
122 sub _generate_instance {
123 my ( $self, $var, $class_var ) = @_;
125 . $self->_meta_instance->inline_create_instance($class_var) . ";\n";
128 sub _generate_slot_initializers {
130 return (join ";\n" => map {
131 $self->_generate_slot_initializer($_)
132 } 0 .. (@{$self->_attributes} - 1)) . ";\n";
135 sub _generate_BUILDARGS {
136 my ( $self, $class, $args ) = @_;
138 my $buildargs = $self->associated_metaclass->find_method_by_name("BUILDARGS");
140 if ( $args eq '@_' and ( !$buildargs or $buildargs->body == \&Moose::Object::BUILDARGS ) ) {
143 $self->_inline_throw_error('"Single parameters to new() must be a HASH ref"', 'data => $_[0]'),
144 ' if scalar @_ == 1 && !( defined $_[0] && ref $_[0] eq q{HASH} );',
145 '(scalar @_ == 1) ? {%{$_[0]}} : {@_};',
149 return $class . "->BUILDARGS($args)";
153 sub _generate_BUILDALL {
156 foreach my $method (reverse $self->associated_metaclass->find_all_methods_by_name('BUILD')) {
157 push @BUILD_calls => '$instance->' . $method->{class} . '::BUILD($params)';
159 return join ";\n" => @BUILD_calls;
162 sub _generate_triggers {
165 foreach my $i ( 0 .. $#{ $self->_attributes } ) {
166 my $attr = $self->_attributes->[$i];
168 next unless $attr->can('has_trigger') && $attr->has_trigger;
170 my $init_arg = $attr->init_arg;
172 next unless defined $init_arg;
174 push @trigger_calls => '(exists $params->{\''
182 . $self->_meta_instance->inline_get_slot_value(
190 return join ";\n" => @trigger_calls;
193 sub _generate_slot_initializer {
197 my $attr = $self->_attributes->[$index];
199 my @source = ('## ' . $attr->name);
201 my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
203 if ($is_moose && defined($attr->init_arg) && $attr->is_required && !$attr->has_default && !$attr->has_builder) {
204 push @source => ('(exists $params->{\'' . $attr->init_arg . '\'}) ' .
205 '|| ' . $self->_inline_throw_error('"Attribute (' . $attr->name . ') is required"') .';');
208 if (($attr->has_default || $attr->has_builder) && !($is_moose && $attr->is_lazy)) {
210 if ( defined( my $init_arg = $attr->init_arg ) ) {
211 push @source => 'if (exists $params->{\'' . $init_arg . '\'}) {';
212 push @source => ('my $val = $params->{\'' . $init_arg . '\'};');
213 push @source => $self->_generate_type_constraint_and_coercion($attr, $index)
215 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
216 push @source => "} else {";
219 if ( $attr->has_default ) {
220 $default = $self->_generate_default_value($attr, $index);
223 my $builder = $attr->builder;
224 $default = '$instance->' . $builder;
227 push @source => '{'; # wrap this to avoid my $val overwrite warnings
228 push @source => ('my $val = ' . $default . ';');
229 push @source => $self->_generate_type_constraint_and_coercion($attr, $index)
231 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
232 push @source => '}'; # close - wrap this to avoid my $val overrite warnings
234 push @source => "}" if defined $attr->init_arg;
236 elsif ( defined( my $init_arg = $attr->init_arg ) ) {
237 push @source => '(exists $params->{\'' . $init_arg . '\'}) && do {';
239 push @source => ('my $val = $params->{\'' . $init_arg . '\'};');
240 if ($is_moose && $attr->has_type_constraint) {
241 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
242 push @source => $self->_generate_type_coercion(
244 '$type_constraints[' . $index . ']',
249 push @source => $self->_generate_type_constraint_check(
251 '$type_constraint_bodies[' . $index . ']',
252 '$type_constraints[' . $index . ']',
256 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
261 return join "\n" => @source;
264 sub _generate_slot_assignment {
265 my ($self, $attr, $value, $index) = @_;
269 if ($attr->has_initializer) {
271 '$attrs->[' . $index . ']->set_initial_value($instance, ' . $value . ');'
276 $self->_meta_instance->inline_set_slot_value(
284 my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
286 if ($is_moose && $attr->is_weak_ref) {
289 $self->_meta_instance->inline_weaken_slot_value(
293 ' if ref ' . $value . ';'
300 sub _generate_type_constraint_and_coercion {
301 my ($self, $attr, $index) = @_;
303 return unless $attr->has_type_constraint;
306 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
307 push @source => $self->_generate_type_coercion(
309 '$type_constraints[' . $index . ']',
314 push @source => $self->_generate_type_constraint_check(
316 ('$type_constraint_bodies[' . $index . ']'),
317 ('$type_constraints[' . $index . ']'),
323 sub _generate_type_coercion {
324 my ($self, $attr, $type_constraint_name, $value_name, $return_value_name) = @_;
325 return ($return_value_name . ' = ' . $type_constraint_name . '->coerce(' . $value_name . ');');
328 sub _generate_type_constraint_check {
329 my ($self, $attr, $type_constraint_cv, $type_constraint_obj, $value_name) = @_;
331 $self->_inline_throw_error('"Attribute (' # FIXME add 'dad'
333 . ') does not pass the type constraint because: " . '
334 . $type_constraint_obj . '->get_message(' . $value_name . ')')
335 . "\n\t unless " . $type_constraint_cv . '->(' . $value_name . ');'
339 sub _generate_default_value {
340 my ($self, $attr, $index) = @_;
342 # default values can either be CODE refs
343 # in which case we need to call them. Or
344 # they can be scalars (strings/numbers)
345 # in which case we can just deal with them
346 # in the code we eval.
347 if ($attr->is_default_a_coderef) {
348 return '$attrs->[' . $index . ']->default($instance)';
351 return q{"} . quotemeta( $attr->default ) . q{"};
363 Moose::Meta::Method::Constructor - Method Meta Object for constructors
367 This class is a subclass of L<Class::MOP::Class::Constructor> that
368 provides additional Moose-specific functionality
370 To understand this class, you should read the the
371 L<Class::MOP::Class::Constructor> documentation as well.
375 C<Moose::Meta::Method::Constructor> is a subclass of
376 L<Moose::Meta::Method> I<and> L<Class::MOP::Method::Constructor>.
380 Stevan Little E<lt>stevan@iinteractive.comE<gt>
382 =head1 COPYRIGHT AND LICENSE
384 Copyright 2006-2009 by Infinity Interactive, Inc.
386 L<http://www.iinteractive.com>
388 This library is free software; you can redistribute it and/or modify
389 it under the same terms as Perl itself.