docs for CMOP::Method::Constructor

[gitmo/Class-MOP.git] / lib / Class / MOP / Method / Constructor.pm

diff --git a/lib/Class/MOP/Method/Constructor.pm b/lib/Class/MOP/Method/Constructor.pm
index 966731e..d027938 100644 (file)
--- a/lib/Class/MOP/Method/Constructor.pm
+++ b/lib/Class/MOP/Method/Constructor.pm
@@ -7,7 +7,8 @@ use warnings;
 use Carp         'confess';
 use Scalar::Util 'blessed', 'weaken', 'looks_like_number';
 
-our $VERSION   = '0.65';
+our $VERSION   = '0.78';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Class::MOP::Method::Generated';
@@ -51,6 +52,8 @@ sub _new {
     }, $class;
 }
 
+sub can_be_inlined { 1 }
+
 ## accessors
 
 sub options              { (shift)->{'options'}              }
@@ -86,6 +89,8 @@ sub generate_constructor_method {
 sub generate_constructor_method_inline {
     my $self = shift;
 
+    my $close_over = {};
+
     my $source = 'sub {';
     $source .= "\n" . 'my $class = shift;';
 
@@ -96,28 +101,25 @@ sub generate_constructor_method_inline {
 
     $source .= "\n" . 'my $instance = ' . $self->meta_instance->inline_create_instance('$class');
     $source .= ";\n" . (join ";\n" => map {
-        $self->_generate_slot_initializer($_)
+        $self->_generate_slot_initializer($_, $close_over)
     } 0 .. (@{$self->attributes} - 1));
     $source .= ";\n" . 'return $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;
+    my $code = $self->_eval_closure(
+        $close_over,
+        $source
+    );
+    confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@" if $@;
 
-        $code = eval $source;
-        confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$@" if $@;
-    }
     return $code;
 }
 
 sub _generate_slot_initializer {
     my $self  = shift;
     my $index = shift;
+    my $close = shift;
 
     my $attr = $self->attributes->[$index];
 
@@ -130,7 +132,9 @@ sub _generate_slot_initializer {
         # in which case we can just deal with them
         # in the code we eval.
         if ($attr->is_default_a_coderef) {
-            $default = '$attrs->[' . $index . ']->default($instance)';
+            my $idx = @{$close->{'@defaults'}||=[]};
+            push(@{$close->{'@defaults'}}, $attr->default);
+            $default = '$defaults[' . $idx . ']->($instance)';
         }
         else {
             $default = $attr->default;
@@ -148,12 +152,12 @@ sub _generate_slot_initializer {
           'if(exists $params->{\'' . $attr->init_arg . '\'}){' . "\n" .
                 $self->meta_instance->inline_set_slot_value(
                     '$instance',
-                    ("'" . $attr->name . "'"),
+                    $attr->name,
                     '$params->{\'' . $attr->init_arg . '\'}' ) . "\n" .
            '} ' . (!defined $default ? '' : 'else {' . "\n" .
                 $self->meta_instance->inline_set_slot_value(
                     '$instance',
-                    ("'" . $attr->name . "'"),
+                    $attr->name,
                      $default ) . "\n" .
            '}')
         );
@@ -161,7 +165,7 @@ sub _generate_slot_initializer {
         return (
             $self->meta_instance->inline_set_slot_value(
                 '$instance',
-                ("'" . $attr->name . "'"),
+                $attr->name,
                  $default ) . "\n"
         );
     } else { return '' }
@@ -189,56 +193,62 @@ Class::MOP::Method::Constructor - Method Meta Object for constructors
   );
 
   # calling the constructor ...
-  $constructor->body->($metaclass->name, %params);
+  $constructor->body->execute($metaclass->name, %params);
 
 =head1 DESCRIPTION
 
-This is a subclass of C<Class::MOP::Method> which deals with
-class constructors. This is used when making a class immutable
-to generate an optimized constructor.
+This is a subclass of C<Class::MOP::Method> which generates
+constructor methods.
 
 =head1 METHODS
 
 =over 4
 
-=item B<new (metaclass => $meta, options => \%options)>
+=item B<< Class::MOP::Method::Constructor->new(%options) >>
 
-=item B<options>
+This creates a new constructor object. It accepts a hash reference of
+options.
 
-This returns the options HASH which is passed into C<new>.
+=over 8
 
-=item B<associated_metaclass>
+=item * metaclass
 
-This returns the metaclass which is passed into C<new>.
+This should be a L<Class::MOP::Class> object. It is required.
 
-=item B<attributes>
+=item * name
 
-This returns the list of attributes which are associated with the
-metaclass which is passed into C<new>.
+The method name (without a package name). This is required.
 
-=item B<meta_instance>
+=item * package_name
 
-This returns the meta instance which is associated with the
-metaclass which is passed into C<new>.
+The package name for the method. This is required.
 
-=item B<is_inline>
+=item * is_inline
 
-This returns a boolean, but since constructors are very rarely
-not inlined, this always returns true for now.
+This indicates whether or not the constructor should be inlined. This
+defaults to false.
 
-=item B<initialize_body>
+=back
 
-This creates the code reference for the constructor itself.
+=item B<< $metamethod->is_inline >>
 
-=back
+Returns a boolean indicating whether or not the constructor is
+inlined.
 
-=head2 Method Generators 
+=item B<< $metamethod->associated_metaclass >>
 
-=over 4
+This returns the L<Class::MOP::Class> object for the method.
+
+=item B<< $metamethod->is_inline >>
+
+Returns a boolean indicating whether or not the constructor is
+inlined.
 
-=item B<generate_constructor_method>
+=item B<< $metamethod->can_be_inlined >>
 
-=item B<generate_constructor_method_inline>
+This method always returns true in this class. It exists so that
+subclasses (as in Moose) can do some sort of checking to determine
+whether or not inlining the constructor is safe.
 
 =back
 
@@ -248,7 +258,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>