2 package Moose::Meta::Method::Accessor;
10 $VERSION = eval $VERSION;
11 our $AUTHORITY = 'cpan:STEVAN';
13 use base 'Moose::Meta::Method',
14 'Class::MOP::Method::Accessor';
16 ## Inline method generators
19 my ( $self, $code ) = @_;
22 # set up the environment
23 my $attr = $self->associated_attribute;
24 my $attr_name = $attr->name;
26 my $type_constraint_obj = $attr->type_constraint;
27 my $type_constraint_name = $type_constraint_obj && $type_constraint_obj->name;
28 my $type_constraint = $type_constraint_obj
29 ? $type_constraint_obj->_compiled_type_constraint
32 #warn "code for $attr_name =>\n" . $code . "\n";
34 confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@;
39 sub generate_accessor_method_inline {
41 my $attr = $self->associated_attribute;
42 my $attr_name = $attr->name;
44 my $slot_access = $self->_inline_access($inv, $attr_name);
45 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
47 $self->_eval_code('sub { ' . "\n"
48 . $self->_inline_pre_body(@_) . "\n"
49 . 'if (scalar(@_) >= 2) {' . "\n"
50 . $self->_inline_copy_value . "\n"
51 . $self->_inline_check_required . "\n"
52 . $self->_inline_check_coercion . "\n"
53 . $self->_inline_check_constraint($value_name) . "\n"
54 . $self->_inline_store($inv, $value_name) . "\n"
55 . $self->_inline_trigger($inv, $value_name) . "\n"
57 . $self->_inline_check_lazy($inv) . "\n"
58 . $self->_inline_post_body(@_) . "\n"
59 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
63 sub generate_writer_method_inline {
65 my $attr = $self->associated_attribute;
66 my $attr_name = $attr->name;
68 my $slot_access = $self->_inline_get($inv, $attr_name);
69 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
71 $self->_eval_code('sub { '
72 . $self->_inline_pre_body(@_)
73 . $self->_inline_copy_value
74 . $self->_inline_check_required
75 . $self->_inline_check_coercion
76 . $self->_inline_check_constraint($value_name)
77 . $self->_inline_store($inv, $value_name)
78 . $self->_inline_post_body(@_)
79 . $self->_inline_trigger($inv, $value_name)
83 sub generate_reader_method_inline {
85 my $attr = $self->associated_attribute;
86 my $attr_name = $attr->name;
88 my $slot_access = $self->_inline_get($inv, $attr_name);
90 $self->_eval_code('sub {'
91 . $self->_inline_pre_body(@_)
92 . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;'
93 . $self->_inline_check_lazy($inv)
94 . $self->_inline_post_body(@_)
95 . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
99 sub _inline_copy_value {
100 return '' unless shift->_value_needs_copy;
101 return 'my $val = $_[1];'
104 sub _value_needs_copy {
105 my $attr = (shift)->associated_attribute;
106 return $attr->should_coerce;
109 sub generate_reader_method { shift->generate_reader_method_inline(@_) }
110 sub generate_writer_method { shift->generate_writer_method_inline(@_) }
111 sub generate_accessor_method { shift->generate_accessor_method_inline(@_) }
113 sub _inline_pre_body { '' }
114 sub _inline_post_body { '' }
116 sub _inline_check_constraint {
117 my ($self, $value) = @_;
119 my $attr = $self->associated_attribute;
120 my $attr_name = $attr->name;
122 return '' unless $attr->has_type_constraint;
124 my $type_constraint_name = $attr->type_constraint->name;
127 # This sprintf is insanely annoying, we should
128 # fix it someday - SL
129 return sprintf <<'EOF', $value, $attr_name, $value, $value,
130 $type_constraint->(%s)
131 || confess "Attribute (%s) does not pass the type constraint because: "
132 . $type_constraint_obj->get_message(%s);
136 sub _inline_check_coercion {
137 my $attr = (shift)->associated_attribute;
139 return '' unless $attr->should_coerce;
140 return '$val = $attr->type_constraint->coerce($_[1]);'
143 sub _inline_check_required {
144 my $attr = (shift)->associated_attribute;
146 my $attr_name = $attr->name;
148 return '' unless $attr->is_required;
149 return qq{(\@_ >= 2) || confess "Attribute ($attr_name) is required, so cannot be set to undef";} # defined $_[1] is not good enough
152 sub _inline_check_lazy {
153 my ($self, $instance) = @_;
155 my $attr = $self->associated_attribute;
157 return '' unless $attr->is_lazy;
159 my $slot_access = $self->_inline_access($instance, $attr->name);
161 my $slot_exists = $self->_inline_has($instance, $attr->name);
163 my $code = 'unless (' . $slot_exists . ') {' . "\n";
164 if ($attr->has_type_constraint) {
165 if ($attr->has_default || $attr->has_builder) {
166 if ($attr->has_default) {
167 $code .= ' my $default = $attr->default(' . $instance . ');'."\n";
169 elsif ($attr->has_builder) {
170 $code .= ' my $default;'."\n".
171 ' if(my $builder = '.$instance.'->can($attr->builder)){ '."\n".
172 ' $default = '.$instance.'->$builder; '. "\n } else {\n" .
173 ' confess((Scalar::Util::blessed('.$instance.') || '.$instance.')." does not support builder method '.
174 '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }";
176 $code .= ' $default = $type_constraint_obj->coerce($default);'."\n" if $attr->should_coerce;
177 $code .= ' ($type_constraint->($default))' .
178 ' || confess "Attribute (" . $attr_name . ") does not pass the type constraint ("' .
179 ' . $type_constraint_name . ") with " . (defined($default) ? overload::StrVal($default) : "undef");'
181 $code .= ' ' . $self->_inline_init_slot($attr, $instance, $slot_access, '$default') . "\n";
184 $code .= ' ' . $self->_inline_init_slot($attr, $instance, $slot_access, 'undef') . "\n";
188 if ($attr->has_default) {
189 $code .= ' ' . $self->_inline_init_slot($attr, $instance, $slot_access, ('$attr->default(' . $instance . ')')) . "\n";
191 elsif ($attr->has_builder) {
192 $code .= ' if (my $builder = '.$instance.'->can($attr->builder)) { ' . "\n"
193 . ' ' . $self->_inline_init_slot($attr, $instance, $slot_access, ($instance . '->$builder'))
195 ' confess((Scalar::Util::blessed('.$instance.') || '.$instance.')." does not support builder method '.
196 '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }";
199 $code .= ' ' . $self->_inline_init_slot($attr, $instance, $slot_access, 'undef') . "\n";
206 sub _inline_init_slot {
207 my ($self, $attr, $inv, $slot_access, $value) = @_;
208 if ($attr->has_initializer) {
209 return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
212 return ($slot_access . ' = ' . $value . ';');
217 my ($self, $instance, $value) = @_;
218 my $attr = $self->associated_attribute;
220 my $mi = $attr->associated_class->get_meta_instance;
221 my $slot_name = sprintf "'%s'", $attr->slots;
223 my $code = $mi->inline_set_slot_value($instance, $slot_name, $value) . ";";
224 $code .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";"
225 if $attr->is_weak_ref;
229 sub _inline_trigger {
230 my ($self, $instance, $value) = @_;
231 my $attr = $self->associated_attribute;
232 return '' unless $attr->has_trigger;
233 return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value);
237 my ($self, $instance) = @_;
238 my $attr = $self->associated_attribute;
240 my $mi = $attr->associated_class->get_meta_instance;
241 my $slot_name = sprintf "'%s'", $attr->slots;
243 return $mi->inline_get_slot_value($instance, $slot_name);
247 my ($self, $instance) = @_;
248 my $attr = $self->associated_attribute;
250 my $mi = $attr->associated_class->get_meta_instance;
251 my $slot_name = sprintf "'%s'", $attr->slots;
253 return $mi->inline_slot_access($instance, $slot_name);
257 my ($self, $instance) = @_;
258 my $attr = $self->associated_attribute;
260 my $mi = $attr->associated_class->get_meta_instance;
261 my $slot_name = sprintf "'%s'", $attr->slots;
263 return $mi->inline_is_slot_initialized($instance, $slot_name);
266 sub _inline_auto_deref {
267 my ( $self, $ref_value ) = @_;
268 my $attr = $self->associated_attribute;
270 return $ref_value unless $attr->should_auto_deref;
272 my $type_constraint = $attr->type_constraint;
275 if ($type_constraint->is_a_type_of('ArrayRef')) {
278 elsif ($type_constraint->is_a_type_of('HashRef')) {
282 confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'";
285 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
296 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
300 This is a subclass of L<Class::MOP::Method::Accessor> and it's primary
301 responsibility is to generate the accessor methods for attributes. It
302 can handle both closure based accessors, as well as inlined source based
305 This is a fairly new addition to the MOP, but this will play an important
306 role in the optimization strategy we are currently following.
312 =item B<generate_accessor_method>
314 =item B<generate_reader_method>
316 =item B<generate_writer_method>
318 =item B<generate_accessor_method_inline>
320 =item B<generate_reader_method_inline>
322 =item B<generate_writer_method_inline>
328 All complex software has bugs lurking in it, and this module is no
329 exception. If you find a bug please either email me, or add the bug
334 Stevan Little E<lt>stevan@iinteractive.comE<gt>
336 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
338 =head1 COPYRIGHT AND LICENSE
340 Copyright 2006-2008 by Infinity Interactive, Inc.
342 L<http://www.iinteractive.com>
344 This library is free software; you can redistribute it and/or modify
345 it under the same terms as Perl itself.