2 package Moose::Meta::Method::Constructor;
8 use Scalar::Util 'blessed', 'weaken', 'looks_like_number';
10 our $VERSION = '0.50';
11 our $AUTHORITY = 'cpan:STEVAN';
13 use base 'Moose::Meta::Method',
14 'Class::MOP::Method::Generated';
20 (exists $options{options} && ref $options{options} eq 'HASH')
21 || confess "You must pass a hash of options";
23 ($options{package_name} && $options{name})
24 || confess "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 # specific to this subclass
32 '%!options' => $options{options},
33 '$!meta_instance' => $options{metaclass}->get_meta_instance,
34 '@!attributes' => [ $options{metaclass}->compute_all_applicable_attributes ],
36 '$!associated_metaclass' => $options{metaclass},
39 # we don't want this creating
40 # a cycle in the code, if not
42 weaken($self->{'$!associated_metaclass'});
44 $self->initialize_body;
51 sub options { (shift)->{'%!options'} }
52 sub meta_instance { (shift)->{'$!meta_instance'} }
53 sub attributes { (shift)->{'@!attributes'} }
55 sub associated_metaclass { (shift)->{'$!associated_metaclass'} }
59 # this was changed in 0.41, but broke MooseX::Singleton, so try to catch
60 # any other code using the original broken spelling
61 sub intialize_body { confess "Please correct the spelling of 'intialize_body' to 'initialize_body'" }
66 # the %options should also include a both
67 # a call 'initializer' and call 'SUPER::'
68 # options, which should cover approx 90%
69 # of the possible use cases (even if it
70 # requires some adaption on the part of
71 # the author, after all, nothing is free)
73 $source .= "\n" . 'my $class = shift;';
75 $source .= "\n" . 'return $class->Moose::Object::new(@_)';
76 $source .= "\n" . ' if $class ne \'' . $self->associated_metaclass->name . '\';';
78 $source .= "\n" . 'my $params = ' . $self->_generate_BUILDARGS('$class', '@_');
80 $source .= ";\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class');
82 $source .= ";\n" . (join ";\n" => map {
83 $self->_generate_slot_initializer($_)
84 } 0 .. (@{$self->attributes} - 1));
86 $source .= ";\n" . $self->_generate_triggers();
87 $source .= ";\n" . $self->_generate_BUILDALL();
89 $source .= ";\n" . 'return $instance';
90 $source .= ";\n" . '}';
91 warn $source if $self->options->{debug};
96 # create the nessecary lexicals
97 # to be picked up in the eval
98 my $attrs = $self->attributes;
100 # We need to check if the attribute ->can('type_constraint')
101 # since we may be trying to immutabilize a Moose meta class,
102 # which in turn has attributes which are Class::MOP::Attribute
103 # objects, rather than Moose::Meta::Attribute. And
104 # Class::MOP::Attribute attributes have no type constraints.
105 # However we need to make sure we leave an undef value there
106 # because the inlined code is using the index of the attributes
107 # to determine where to find the type constraint
109 my @type_constraints = map {
110 $_->can('type_constraint') ? $_->type_constraint : undef
113 my @type_constraint_bodies = map {
114 defined $_ ? $_->_compiled_type_constraint : undef;
117 $code = eval $source;
118 confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@" if $@;
120 $self->{'&!body'} = $code;
123 sub _generate_BUILDARGS {
124 my ( $self, $class, $args ) = @_;
126 my $buildargs = $self->associated_metaclass->find_method_by_name("BUILDARGS");
128 if ( $args eq '@_' and ( !$buildargs or $buildargs->body == \&Moose::Object::BUILDARGS ) ) {
131 'confess "Single parameters to new() must be a HASH ref"',
132 ' if scalar @_ == 1 && defined $_[0] && ref($_[0]) ne q{HASH};',
133 '(scalar @_ == 1) ? {%{$_[0]}} : {@_};',
137 return $class . "->BUILDARGS($args)";
141 sub _generate_BUILDALL {
144 foreach my $method (reverse $self->associated_metaclass->find_all_methods_by_name('BUILD')) {
145 push @BUILD_calls => '$instance->' . $method->{class} . '::BUILD($params)';
147 return join ";\n" => @BUILD_calls;
150 sub _generate_triggers {
153 foreach my $i (0 .. $#{ $self->attributes }) {
154 my $attr = $self->attributes->[$i];
155 if ($attr->can('has_trigger') && $attr->has_trigger) {
156 if (defined(my $init_arg = $attr->init_arg)) {
157 push @trigger_calls => (
158 '(exists $params->{\'' . $init_arg . '\'}) && do {' . "\n "
159 . '$attrs->[' . $i . ']->trigger->('
161 . $self->meta_instance->inline_get_slot_value(
163 ("'" . $attr->name . "'")
166 . '$attrs->[' . $i . ']'
173 return join ";\n" => @trigger_calls;
176 sub _generate_slot_initializer {
180 my $attr = $self->attributes->[$index];
182 my @source = ('## ' . $attr->name);
184 my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
186 if ($is_moose && defined($attr->init_arg) && $attr->is_required && !$attr->has_default && !$attr->has_builder) {
187 push @source => ('(exists $params->{\'' . $attr->init_arg . '\'}) ' .
188 '|| confess "Attribute (' . $attr->name . ') is required";');
191 if (($attr->has_default || $attr->has_builder) && !($is_moose && $attr->is_lazy)) {
193 if ( defined( my $init_arg = $attr->init_arg ) ) {
194 push @source => 'if (exists $params->{\'' . $init_arg . '\'}) {';
196 push @source => ('my $val = $params->{\'' . $init_arg . '\'};');
198 if ($is_moose && $attr->has_type_constraint) {
199 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
200 push @source => $self->_generate_type_coercion(
202 '$type_constraints[' . $index . ']',
207 push @source => $self->_generate_type_constraint_check(
209 '$type_constraint_bodies[' . $index . ']',
210 '$type_constraints[' . $index . ']',
214 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_check(
231 ('$type_constraint_bodies[' . $index . ']'),
232 ('$type_constraints[' . $index . ']'),
234 ) if ($is_moose && $attr->has_type_constraint);
236 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
237 push @source => '}'; # close - wrap this to avoid my $val overrite warnings
239 push @source => "}" if defined $attr->init_arg;
241 elsif ( defined( my $init_arg = $attr->init_arg ) ) {
242 push @source => '(exists $params->{\'' . $init_arg . '\'}) && do {';
244 push @source => ('my $val = $params->{\'' . $init_arg . '\'};');
245 if ($is_moose && $attr->has_type_constraint) {
246 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
247 push @source => $self->_generate_type_coercion(
249 '$type_constraints[' . $index . ']',
254 push @source => $self->_generate_type_constraint_check(
256 '$type_constraint_bodies[' . $index . ']',
257 '$type_constraints[' . $index . ']',
261 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
266 return join "\n" => @source;
269 sub _generate_slot_assignment {
270 my ($self, $attr, $value, $index) = @_;
274 if ($attr->has_initializer) {
276 '$attrs->[' . $index . ']->set_initial_value($instance, ' . $value . ');'
281 $self->meta_instance->inline_set_slot_value(
283 ("'" . $attr->name . "'"),
289 my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
291 if ($is_moose && $attr->is_weak_ref) {
294 $self->meta_instance->inline_weaken_slot_value(
296 ("'" . $attr->name . "'")
298 ' if ref ' . $value . ';'
305 sub _generate_type_coercion {
306 my ($self, $attr, $type_constraint_name, $value_name, $return_value_name) = @_;
307 return ($return_value_name . ' = ' . $type_constraint_name . '->coerce(' . $value_name . ');');
310 sub _generate_type_constraint_check {
311 my ($self, $attr, $type_constraint_cv, $type_constraint_obj, $value_name) = @_;
313 $type_constraint_cv . '->(' . $value_name . ')'
314 . "\n\t" . '|| confess "Attribute ('
316 . ') does not pass the type constraint because: " . '
317 . $type_constraint_obj . '->get_message(' . $value_name . ');'
321 sub _generate_default_value {
322 my ($self, $attr, $index) = @_;
324 # default values can either be CODE refs
325 # in which case we need to call them. Or
326 # they can be scalars (strings/numbers)
327 # in which case we can just deal with them
328 # in the code we eval.
329 if ($attr->is_default_a_coderef) {
330 return '$attrs->[' . $index . ']->default($instance)';
333 my $default = $attr->default;
334 # make sure to quote strings ...
335 unless (looks_like_number($default)) {
336 $default = "'$default'";
351 Moose::Meta::Method::Constructor - Method Meta Object for constructors
355 This is a subclass of L<Class::MOP::Method> which handles
356 constructing an approprate Constructor methods. This is primarily
357 used in the making of immutable metaclasses, otherwise it is
358 not particularly useful.
368 =item B<meta_instance>
372 =item B<initialize_body>
374 =item B<associated_metaclass>
380 Stevan Little E<lt>stevan@iinteractive.comE<gt>
382 =head1 COPYRIGHT AND LICENSE
384 Copyright 2006-2008 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.