bump version to 0.79
[gitmo/Moose.git] / lib / Moose / Meta / Method / Accessor.pm
index d5e67e3..aa92e31 100644 (file)
@@ -4,218 +4,257 @@ package Moose::Meta::Method::Accessor;
 use strict;
 use warnings;
 
-use Carp 'confess';
-
-our $VERSION   = '0.06';
+our $VERSION   = '0.79';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Moose::Meta::Method',
          'Class::MOP::Method::Accessor';
 
-## Inline method generators
-
-sub generate_accessor_method_inline {
-    my $self        = $_[0];
-    my $attr        = $self->associated_attribute;
-    my $attr_name   = $attr->name;
-    my $inv         = '$_[0]';
-    my $slot_access = $self->_inline_get($inv, $attr_name);
-    my $value_name  = $attr->should_coerce ? '$val' : '$_[1]';
+sub _error_thrower {
+    my $self = shift;
+    ( ref $self && $self->associated_attribute ) || $self->SUPER::_error_thrower();
+}
 
-    my $code = 'sub { '
-    . $self->_inline_pre_body(@_)
-    . 'if (scalar(@_) == 2) {'
-        . $self->_inline_check_required
-        . $self->_inline_check_coercion
-        . $self->_inline_check_constraint($value_name)
-                . $self->_inline_store($inv, $value_name)
-                . $self->_inline_trigger($inv, $value_name)
-    . ' }'
-    . $self->_inline_check_lazy
-    . $self->_inline_post_body(@_)
-    . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv))
-    . ' }';
+sub _eval_code {
+    my ( $self, $code ) = @_;
 
     # NOTE:
     # set up the environment
-    my $type_constraint = $attr->type_constraint
-                                ? $attr->type_constraint->_compiled_type_constraint
-                                : undef;
+    my $attr = $self->associated_attribute;
+    my $type_constraint_obj = $attr->type_constraint;
+    my $environment = {
+        '$attr' => \$attr,
+        '$attr_name' => \$attr->name,
+        '$meta' => \$self,
+        '$type_constraint_obj' => \$type_constraint_obj,
+        '$type_constraint_name' => \($type_constraint_obj && $type_constraint_obj->name),
+        '$type_constraint' => \($type_constraint_obj
+                                   ? $type_constraint_obj->_compiled_type_constraint
+                                   : undef),
+    };
+
+    #warn "code for $attr_name =>\n" . $code . "\n";
+    $self->_compile_code( environment => $environment, code => $code )
+        or $self->throw_error("Could not create writer for '${\$self->associated_attribute->name}' because $@ \n code: $code", error => $@, data => $code );
+}
 
-    my $sub = eval $code;
-    confess "Could not create accessor for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;
+sub _generate_accessor_method_inline {
+    my $self        = $_[0];
+    my $attr        = $self->associated_attribute;
+    my $attr_name   = $attr->name;
+    my $inv         = '$_[0]';
+    my $slot_access = $self->_inline_access($inv, $attr_name);
+    my $value_name  = $self->_value_needs_copy ? '$val' : '$_[1]';
+
+    $self->_eval_code('sub { ' . "\n"
+    . $self->_inline_pre_body(@_) . "\n"
+    . 'if (scalar(@_) >= 2) {' . "\n"
+        . $self->_inline_copy_value . "\n"
+        . $self->_inline_check_required . "\n"
+        . $self->_inline_check_coercion($value_name) . "\n"
+        . $self->_inline_check_constraint($value_name) . "\n"
+        . $self->_inline_store($inv, $value_name) . "\n"
+        . $self->_inline_trigger($inv, $value_name) . "\n"
+    . ' }' . "\n"
+    . $self->_inline_check_lazy($inv) . "\n"
+    . $self->_inline_post_body(@_) . "\n"
+    . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
+    . ' }');
 }
 
-sub generate_writer_method_inline {
+sub _generate_writer_method_inline {
     my $self        = $_[0];
     my $attr        = $self->associated_attribute;
     my $attr_name   = $attr->name;
     my $inv         = '$_[0]';
     my $slot_access = $self->_inline_get($inv, $attr_name);
-    my $value_name  = $attr->should_coerce ? '$val' : '$_[1]';
+    my $value_name  = $self->_value_needs_copy ? '$val' : '$_[1]';
 
-    my $code = 'sub { '
+    $self->_eval_code('sub { '
     . $self->_inline_pre_body(@_)
+    . $self->_inline_copy_value
     . $self->_inline_check_required
-    . $self->_inline_check_coercion
-        . $self->_inline_check_constraint($value_name)
-        . $self->_inline_store($inv, $value_name)
-        . $self->_inline_post_body(@_)
-        . $self->_inline_trigger($inv, $value_name)
-    . ' }';
-
-    # NOTE:
-    # set up the environment
-    my $type_constraint = $attr->type_constraint
-                                ? $attr->type_constraint->_compiled_type_constraint
-                                : undef;
-
-    my $sub = eval $code;
-    confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;
+    . $self->_inline_check_coercion($value_name)
+    . $self->_inline_check_constraint($value_name)
+    . $self->_inline_store($inv, $value_name)
+    . $self->_inline_post_body(@_)
+    . $self->_inline_trigger($inv, $value_name)
+    . ' }');
 }
 
-sub generate_reader_method_inline {
+sub _generate_reader_method_inline {
     my $self        = $_[0];
     my $attr        = $self->associated_attribute;
     my $attr_name   = $attr->name;
     my $inv         = '$_[0]';
     my $slot_access = $self->_inline_get($inv, $attr_name);
 
-    my $code = 'sub {'
+    $self->_eval_code('sub {'
     . $self->_inline_pre_body(@_)
-    . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;'
-    . $self->_inline_check_lazy
+    . $self->_inline_throw_error('"Cannot assign a value to a read-only accessor"', 'data => \@_') . ' if @_ > 1;'
+    . $self->_inline_check_lazy($inv)
     . $self->_inline_post_body(@_)
     . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
-    . '}';
+    . '}');
+}
 
-    # NOTE:
-    # set up the environment
-    my $type_constraint = $attr->type_constraint
-                                ? $attr->type_constraint->_compiled_type_constraint
-                                : undef;
+sub _inline_copy_value {
+    return '' unless shift->_value_needs_copy;
+    return 'my $val = $_[1];'
+}
 
-    my $sub = eval $code;
-    confess "Could not create reader for '$attr_name' because $@ \n code: $code" if $@;
-    return $sub;
+sub _value_needs_copy {
+    my $attr = (shift)->associated_attribute;
+    return $attr->should_coerce;
 }
 
-sub generate_reader_method { shift->generate_reader_method_inline(@_) }
-sub generate_writer_method { shift->generate_writer_method_inline(@_) }
-sub generate_accessor_method { shift->generate_accessor_method_inline(@_) }
+sub _generate_reader_method { shift->_generate_reader_method_inline(@_) }
+sub _generate_writer_method { shift->_generate_writer_method_inline(@_) }
+sub _generate_accessor_method { shift->_generate_accessor_method_inline(@_) }
+sub _generate_predicate_method { shift->_generate_predicate_method_inline(@_) }
+sub _generate_clearer_method { shift->_generate_clearer_method_inline(@_) }
 
 sub _inline_pre_body  { '' }
 sub _inline_post_body { '' }
 
 sub _inline_check_constraint {
-        my ($self, $value) = @_;
+    my ($self, $value) = @_;
 
-        my $attr = $self->associated_attribute;
+    my $attr = $self->associated_attribute;
+    my $attr_name = $attr->name;
 
-        return '' unless $attr->has_type_constraint;
-
-        # FIXME
-        # This sprintf is insanely annoying, we should
-        # fix it someday - SL
-        return sprintf <<'EOF', $value, $value, $value, $value, $value, $value, $value
-defined($type_constraint->(%s))
-        || confess "Attribute (" . $attr->name . ") does not pass the type constraint ("
-       . $attr->type_constraint->name . ") with "
-       . (defined(%s) ? (Scalar::Util::blessed(%s) && overload::Overloaded(%s) ? overload::StrVal(%s) : %s) : "undef")
-  if defined(%s);
-EOF
+    return '' unless $attr->has_type_constraint;
+
+    my $type_constraint_name = $attr->type_constraint->name;
+
+    qq{\$type_constraint->($value) || } . $self->_inline_throw_error(qq{"Attribute ($attr_name) does not pass the type constraint because: " . \$type_constraint_obj->get_message($value)}, "data => $value") . ";";
 }
 
 sub _inline_check_coercion {
-        my $attr = (shift)->associated_attribute;
+    my ($self, $value) = @_;
 
-        return '' unless $attr->should_coerce;
-    return 'my $val = $attr->type_constraint->coerce($_[1]);'
+    my $attr = $self->associated_attribute;
+
+    return '' unless $attr->should_coerce;
+    return "$value = \$attr->type_constraint->coerce($value);";
 }
 
 sub _inline_check_required {
-        my $attr = (shift)->associated_attribute;
+    my $self = shift;
+    my $attr = $self->associated_attribute;
 
-        return '' unless $attr->is_required;
-    return 'defined($_[1]) || confess "Attribute ($attr_name) is required, so cannot be set to undef";'
+    my $attr_name = $attr->name;
+
+    return '' unless $attr->is_required;
+    return qq{(\@_ >= 2) || } . $self->_inline_throw_error(qq{"Attribute ($attr_name) is required, so cannot be set to undef"}) . ';' # defined $_[1] is not good enough
 }
 
 sub _inline_check_lazy {
-    my $self = $_[0];
-    my $attr = $self->associated_attribute;
+    my ($self, $instance) = @_;
 
-        return '' unless $attr->is_lazy;
+    my $attr = $self->associated_attribute;
 
-    my $inv         = '$_[0]';
-    my $slot_access = $self->_inline_get($inv, $attr->name);
-
-        if ($attr->has_type_constraint) {
-            # NOTE:
-            # this could probably be cleaned
-            # up and streamlined a little more
-            return 'unless (exists ' . $slot_access . ') {' .
-                   '    if ($attr->has_default || $attr->has_builder ) {' .
-                   '        my $default; '.
-                   '        $default = $attr->default(' . $inv . ')  if $attr->has_default;' .
-                   '        if ( $attr->has_builder ) { '.
-                   '            my $builder = $self->builder;'.
-                   '            confess(blessed('.$inv.')." does not support builder method \'$builder\' for attribute \'" . $attr->name . "\'")'.
-                   '                unless '.$inv.'->can($builder); '.
-                   '            $default = '.$inv.'->$builder;'.
-                   '        }'.
-                   ($attr->should_coerce
-                       ? '$default = $attr->type_constraint->coerce($default);'
-                       : '') .
-               '        (defined($type_constraint->($default)))' .
-               '                || confess "Attribute (" . $attr->name . ") does not pass the type constraint ("' .
-               '               . $attr->type_constraint->name . ") with " . (defined($default) ? (Scalar::Util::blessed($default) && overload::Overloaded($default) ? overload::StrVal($default) : $default) : "undef")' .
-               '          if defined($default);' .
-                   '        ' . $slot_access . ' = $default; ' .
-                   '    }' .
-                   '    else {' .
-               '        ' . $slot_access . ' = undef;' .
-                   '    }' .
-                   '}';
+    return '' unless $attr->is_lazy;
+
+    my $slot_access = $self->_inline_access($instance, $attr->name);
+
+    my $slot_exists = $self->_inline_has($instance, $attr->name);
+
+    my $code = 'unless (' . $slot_exists . ') {' . "\n";
+    if ($attr->has_type_constraint) {
+        if ($attr->has_default || $attr->has_builder) {
+            if ($attr->has_default) {
+                $code .= '    my $default = $attr->default(' . $instance . ');'."\n";
+            }
+            elsif ($attr->has_builder) {
+                $code .= '    my $default;'."\n".
+                         '    if(my $builder = '.$instance.'->can($attr->builder)){ '."\n".
+                         '        $default = '.$instance.'->$builder; '. "\n    } else {\n" .
+                         '        ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name') .
+                         ';'. "\n    }";
+            }
+            $code .= $self->_inline_check_coercion('$default') . "\n";
+            $code .= $self->_inline_check_constraint('$default') . "\n";
+            $code .= '    ' . $self->_inline_init_slot($attr, $instance, $slot_access, '$default') . "\n";
+        }
+        else {
+            $code .= '    ' . $self->_inline_init_slot($attr, $instance, $slot_access, 'undef') . "\n";
         }
 
-    return  'unless (exists ' . $slot_access . ') {' .
-            '    if ($attr->has_default) { ' . $slot_access . ' = $attr->default(' . $inv . '); }' .
-            '    elsif ($attr->has_builder) { my $builder = $attr->builder; ' . $slot_access . ' = ' . $inv . '->$builder; }' .
-            '    else { ' .$slot_access . ' = undef; } '.
-            '}';
+    } else {
+        if ($attr->has_default) {
+            $code .= '    ' . $self->_inline_init_slot($attr, $instance, $slot_access, ('$attr->default(' . $instance . ')')) . "\n";
+        }
+        elsif ($attr->has_builder) {
+            $code .= '    if (my $builder = '.$instance.'->can($attr->builder)) { ' . "\n"
+                  .  '       ' . $self->_inline_init_slot($attr, $instance, $slot_access, ($instance . '->$builder'))
+                  .  "\n    } else {\n"
+                  .  '        ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name')
+                  .  ';'. "\n    }";
+        }
+        else {
+            $code .= '    ' . $self->_inline_init_slot($attr, $instance, $slot_access, 'undef') . "\n";
+        }
+    }
+    $code .= "}\n";
+    return $code;
 }
 
+sub _inline_init_slot {
+    my ($self, $attr, $inv, $slot_access, $value) = @_;
+    if ($attr->has_initializer) {
+        return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
+    }
+    else {
+        return ($slot_access . ' = ' . $value . ';');
+    }
+}
 
 sub _inline_store {
-        my ($self, $instance, $value) = @_;
-        my $attr = $self->associated_attribute;
+    my ($self, $instance, $value) = @_;
+    my $attr = $self->associated_attribute;
 
-        my $mi = $attr->associated_class->get_meta_instance;
-        my $slot_name = sprintf "'%s'", $attr->slots;
+    my $mi = $attr->associated_class->get_meta_instance;
 
-    my $code = $mi->inline_set_slot_value($instance, $slot_name, $value)    . ";";
-        $code   .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";"
-            if $attr->is_weak_ref;
+    my $code = $mi->inline_set_slot_value($instance, $attr->slots, $value)    . ";";
+    $code   .= $mi->inline_weaken_slot_value($instance, $attr->slots, $value) . ";"
+        if $attr->is_weak_ref;
     return $code;
 }
 
 sub _inline_trigger {
-        my ($self, $instance, $value) = @_;
-        my $attr = $self->associated_attribute;
-        return '' unless $attr->has_trigger;
-        return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value);
+    my ($self, $instance, $value) = @_;
+    my $attr = $self->associated_attribute;
+    return '' unless $attr->has_trigger;
+    return sprintf('$attr->trigger->(%s, %s);', $instance, $value);
 }
 
 sub _inline_get {
-        my ($self, $instance) = @_;
-        my $attr = $self->associated_attribute;
+    my ($self, $instance) = @_;
+    my $attr = $self->associated_attribute;
 
-        my $mi = $attr->associated_class->get_meta_instance;
-        my $slot_name = sprintf "'%s'", $attr->slots;
+    my $mi = $attr->associated_class->get_meta_instance;
 
-    return $mi->inline_get_slot_value($instance, $slot_name);
+    return $mi->inline_get_slot_value($instance, $attr->slots);
+}
+
+sub _inline_access {
+    my ($self, $instance) = @_;
+    my $attr = $self->associated_attribute;
+
+    my $mi = $attr->associated_class->get_meta_instance;
+
+    return $mi->inline_slot_access($instance, $attr->slots);
+}
+
+sub _inline_has {
+    my ($self, $instance) = @_;
+    my $attr = $self->associated_attribute;
+
+    my $mi = $attr->associated_class->get_meta_instance;
+
+    return $mi->inline_is_slot_initialized($instance, $attr->slots);
 }
 
 sub _inline_auto_deref {
@@ -234,7 +273,7 @@ sub _inline_auto_deref {
         $sigil = '%';
     }
     else {
-        confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'";
+        $self->throw_error("Can not auto de-reference the type constraint '" . $type_constraint->name . "'", type_constraint => $type_constraint );
     }
 
     "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
@@ -252,31 +291,12 @@ Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Method::Accessor> and it's primary
-responsibility is to generate the accessor methods for attributes. It
-can handle both closure based accessors, as well as inlined source based
-accessors.
-
-This is a fairly new addition to the MOP, but this will play an important
-role in the optimization strategy we are currently following.
-
-=head1 METHODS
-
-=over 4
-
-=item B<generate_accessor_method>
-
-=item B<generate_reader_method>
-
-=item B<generate_writer_method>
-
-=item B<generate_accessor_method_inline>
-
-=item B<generate_reader_method_inline>
-
-=item B<generate_writer_method_inline>
+This class is a subclass of L<Class::MOP::Class::Accessor> that
+provides additional Moose-specific functionality, all of which is
+private.
 
-=back
+To understand this class, you should read the the
+L<Class::MOP::Class::Accessor> documentation.
 
 =head1 BUGS
 
@@ -292,7 +312,7 @@ Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006, 2007 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>