lib/Moose/Meta/Method/Constructor.pm

   1
   2 package Moose::Meta::Method::Constructor;
   3
   4 use strict;
   5 use warnings;
   6
   7 use Carp         'confess';
   8 use Scalar::Util 'blessed', 'weaken', 'looks_like_number';
   9
  10 our $VERSION   = '0.10';
  11 our $AUTHORITY = 'cpan:STEVAN';
  12
  13 use base 'Moose::Meta::Method',
  14          'Class::MOP::Method::Generated';
  15
  16 sub new {
  17     my $class   = shift;
  18     my %options = @_;
  19
  20     (exists $options{options} && ref $options{options} eq 'HASH')
  21         || confess "You must pass a hash of options";
  22
  23     ($options{package_name} && $options{name})
  24         || confess "You must supply the package_name and name parameters";
  25
  26     my $self = bless {
  27         # from our superclass
  28         '&!body'          => undef,
  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 ],
  35         # ...
  36         '$!associated_metaclass' => $options{metaclass},
  37     } => $class;
  38
  39     # we don't want this creating
  40     # a cycle in the code, if not
  41     # needed
  42     weaken($self->{'$!associated_metaclass'});
  43
  44     $self->initialize_body;
  45
  46     return $self;
  47 }
  48
  49 ## accessors
  50
  51 sub options       { (shift)->{'%!options'}       }
  52 sub meta_instance { (shift)->{'$!meta_instance'} }
  53 sub attributes    { (shift)->{'@!attributes'}    }
  54
  55 sub associated_metaclass { (shift)->{'$!associated_metaclass'} }
  56
  57 ## method
  58
  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'" }
  62
  63 sub initialize_body {
  64     my $self = shift;
  65     # TODO:
  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)
  72     my $source = 'sub {';
  73     $source .= "\n" . 'my $class = shift;';
  74
  75     $source .= "\n" . 'return $class->Moose::Object::new(@_)';
  76     $source .= "\n" . '    if $class ne \'' . $self->associated_metaclass->name . '\';';
  77
  78     $source .= "\n" . 'my %params = (scalar @_ == 1) ? %{$_[0]} : @_;';
  79
  80     $source .= "\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class');
  81
  82     $source .= ";\n" . (join ";\n" => map {
  83         $self->_generate_slot_initializer($_)
  84     } 0 .. (@{$self->attributes} - 1));
  85
  86     $source .= ";\n" . $self->_generate_triggers();
  87     $source .= ";\n" . $self->_generate_BUILDALL();
  88
  89     $source .= ";\n" . 'return $instance';
  90     $source .= ";\n" . '}';
  91     warn $source if $self->options->{debug};
  92
  93     my $code;
  94     {
  95         # NOTE:
  96         # create the nessecary lexicals
  97         # to be picked up in the eval
  98         my $attrs = $self->attributes;
  99
 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
 108
 109         my @type_constraints = map {
 110             $_->can('type_constraint') ? $_->type_constraint : undef
 111         } @$attrs;
 112
 113         my @type_constraint_bodies = map {
 114             defined $_ ? $_->_compiled_type_constraint : undef;
 115         } @type_constraints;
 116
 117         $code = eval $source;
 118         confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@" if $@;
 119     }
 120     $self->{'&!body'} = $code;
 121 }
 122
 123 sub _generate_BUILDALL {
 124     my $self = shift;
 125     my @BUILD_calls;
 126     foreach my $method (reverse $self->associated_metaclass->find_all_methods_by_name('BUILD')) {
 127         push @BUILD_calls => '$instance->' . $method->{class} . '::BUILD(\%params)';
 128     }
 129     return join ";\n" => @BUILD_calls;
 130 }
 131
 132 sub _generate_triggers {
 133     my $self = shift;
 134     my @trigger_calls;
 135     foreach my $i (0 .. $#{ $self->attributes }) {
 136         my $attr = $self->attributes->[$i];
 137         if ($attr->can('has_trigger') && $attr->has_trigger) {
 138             if (defined(my $init_arg = $attr->init_arg)) {
 139                 push @trigger_calls => (
 140                     '(exists $params{\'' . $init_arg . '\'}) && do {' . "\n    "
 141                     .   '$attrs->[' . $i . ']->trigger->('
 142                     .       '$instance, '
 143                     .        $self->meta_instance->inline_get_slot_value(
 144                                  '$instance',
 145                                  ("'" . $attr->name . "'")
 146                              )
 147                              . ', '
 148                     .        '$attrs->[' . $i . ']'
 149                     .   ');'
 150                     ."\n}"
 151                 );
 152             }
 153         }
 154     }
 155     return join ";\n" => @trigger_calls;
 156 }
 157
 158 sub _generate_slot_initializer {
 159     my $self  = shift;
 160     my $index = shift;
 161
 162     my $attr = $self->attributes->[$index];
 163
 164     my @source = ('## ' . $attr->name);
 165
 166     my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
 167
 168     if ($is_moose && defined($attr->init_arg) && $attr->is_required && !$attr->has_default && !$attr->has_builder) {
 169         push @source => ('(exists $params{\'' . $attr->init_arg . '\'}) ' .
 170                         '|| confess "Attribute (' . $attr->name . ') is required";');
 171     }
 172
 173     if (($attr->has_default || $attr->has_builder) && !($is_moose && $attr->is_lazy)) {
 174
 175         if ( defined( my $init_arg = $attr->init_arg ) ) {
 176             push @source => 'if (exists $params{\'' . $init_arg . '\'}) {';
 177
 178                 push @source => ('my $val = $params{\'' . $init_arg . '\'};');
 179
 180                 if ($is_moose && $attr->has_type_constraint) {
 181                     if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
 182                         push @source => $self->_generate_type_coercion(
 183                             $attr,
 184                             '$type_constraints[' . $index . ']',
 185                             '$val',
 186                             '$val'
 187                         );
 188                     }
 189                     push @source => $self->_generate_type_constraint_check(
 190                         $attr,
 191                         '$type_constraint_bodies[' . $index . ']',
 192                         '$type_constraints[' . $index . ']',
 193                         '$val'
 194                     );
 195                 }
 196                 push @source => $self->_generate_slot_assignment($attr, '$val', $index);
 197
 198             push @source => "} else {";
 199         }
 200             my $default;
 201             if ( $attr->has_default ) {
 202                 $default = $self->_generate_default_value($attr, $index);
 203             }
 204             else {
 205                my $builder = $attr->builder;
 206                $default = '$instance->' . $builder;
 207             }
 208
 209             push @source => '{'; # wrap this to avoid my $val overwrite warnings
 210             push @source => ('my $val = ' . $default . ';');
 211             push @source => $self->_generate_type_constraint_check(
 212                 $attr,
 213                 ('$type_constraint_bodies[' . $index . ']'),
 214                 ('$type_constraints[' . $index . ']'),
 215                 '$val'
 216             ) if ($is_moose && $attr->has_type_constraint);
 217
 218             push @source => $self->_generate_slot_assignment($attr, '$val', $index);
 219             push @source => '}'; # close - wrap this to avoid my $val overrite warnings
 220
 221         push @source => "}" if defined $attr->init_arg;
 222     }
 223     elsif ( defined( my $init_arg = $attr->init_arg ) ) {
 224         push @source => '(exists $params{\'' . $init_arg . '\'}) && do {';
 225
 226             push @source => ('my $val = $params{\'' . $init_arg . '\'};');
 227             if ($is_moose && $attr->has_type_constraint) {
 228                 if ($attr->should_coerce && $attr->type_constraint->has_coercion) {
 229                     push @source => $self->_generate_type_coercion(
 230                         $attr,
 231                         '$type_constraints[' . $index . ']',
 232                         '$val',
 233                         '$val'
 234                     );
 235                 }
 236                 push @source => $self->_generate_type_constraint_check(
 237                     $attr,
 238                     '$type_constraint_bodies[' . $index . ']',
 239                     '$type_constraints[' . $index . ']',
 240                     '$val'
 241                 );
 242             }
 243             push @source => $self->_generate_slot_assignment($attr, '$val', $index);
 244
 245         push @source => "}";
 246     }
 247
 248     return join "\n" => @source;
 249 }
 250
 251 sub _generate_slot_assignment {
 252     my ($self, $attr, $value, $index) = @_;
 253
 254     my $source;
 255
 256     if ($attr->has_initializer) {
 257         $source = (
 258             '$attrs->[' . $index . ']->set_initial_value($instance, ' . $value . ');'
 259         );
 260     }
 261     else {
 262         $source = (
 263             $self->meta_instance->inline_set_slot_value(
 264                 '$instance',
 265                 ("'" . $attr->name . "'"),
 266                 $value
 267             ) . ';'
 268         );
 269     }
 270
 271     my $is_moose = $attr->isa('Moose::Meta::Attribute'); # XXX FIXME
 272
 273     if ($is_moose && $attr->is_weak_ref) {
 274         $source .= (
 275             "\n" .
 276             $self->meta_instance->inline_weaken_slot_value(
 277                 '$instance',
 278                 ("'" . $attr->name . "'")
 279             ) .
 280             ' if ref ' . $value . ';'
 281         );
 282     }
 283
 284     return $source;
 285 }
 286
 287 sub _generate_type_coercion {
 288     my ($self, $attr, $type_constraint_name, $value_name, $return_value_name) = @_;
 289     return ($return_value_name . ' = ' . $type_constraint_name .  '->coerce(' . $value_name . ');');
 290 }
 291
 292 sub _generate_type_constraint_check {
 293     my ($self, $attr, $type_constraint_cv, $type_constraint_obj, $value_name) = @_;
 294     return (
 295         $type_constraint_cv . '->(' . $value_name . ')'
 296         . "\n\t" . '|| confess "Attribute ('
 297         . $attr->name
 298         . ') does not pass the type constraint because: " . '
 299         . $type_constraint_obj . '->get_message(' . $value_name . ');'
 300     );
 301 }
 302
 303 sub _generate_default_value {
 304     my ($self, $attr, $index) = @_;
 305     # NOTE:
 306     # default values can either be CODE refs
 307     # in which case we need to call them. Or
 308     # they can be scalars (strings/numbers)
 309     # in which case we can just deal with them
 310     # in the code we eval.
 311     if ($attr->is_default_a_coderef) {
 312         return '$attrs->[' . $index . ']->default($instance)';
 313     }
 314     else {
 315         my $default = $attr->default;
 316         # make sure to quote strings ...
 317         unless (looks_like_number($default)) {
 318             $default = "'$default'";
 319         }
 320
 321         return $default;
 322     }
 323 }
 324
 325 1;
 326
 327 __END__
 328
 329 =pod
 330
 331 =head1 NAME
 332
 333 Moose::Meta::Method::Constructor - Method Meta Object for constructors
 334
 335 =head1 DESCRIPTION
 336
 337 This is a subclass of L<Class::MOP::Method> which handles
 338 constructing an approprate Constructor methods. This is primarily
 339 used in the making of immutable metaclasses, otherwise it is
 340 not particularly useful.
 341
 342 =head1 METHODS
 343
 344 =over 4
 345
 346 =item B<new>
 347
 348 =item B<attributes>
 349
 350 =item B<meta_instance>
 351
 352 =item B<options>
 353
 354 =item B<initialize_body>
 355
 356 =item B<associated_metaclass>
 357
 358 =back
 359
 360 =head1 AUTHORS
 361
 362 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 363
 364 =head1 COPYRIGHT AND LICENSE
 365
 366 Copyright 2006-2008 by Infinity Interactive, Inc.
 367
 368 L<http://www.iinteractive.com>
 369
 370 This library is free software; you can redistribute it and/or modify
 371 it under the same terms as Perl itself.
 372
 373 =cut
 374