2 package Moose::Meta::Method::Accessor;
10 our $AUTHORITY = 'cpan:STEVAN';
12 use base 'Moose::Meta::Method',
13 'Class::MOP::Method::Accessor';
15 ## Inline method generators
18 my ( $self, $code ) = @_;
21 # set up the environment
22 my $attr = $self->associated_attribute;
23 my $attr_name = $attr->name;
25 my $type_constraint_obj = $attr->type_constraint;
26 my $type_constraint_name = $type_constraint_obj && $type_constraint_obj->name;
27 my $type_constraint = $type_constraint_obj
28 ? $type_constraint_obj->_compiled_type_constraint
32 confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@;
37 sub generate_accessor_method_inline {
39 my $attr = $self->associated_attribute;
40 my $attr_name = $attr->name;
42 my $slot_access = $self->_inline_access($inv, $attr_name);
43 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
45 $self->_eval_code('sub { ' . "\n"
46 . $self->_inline_pre_body(@_) . "\n"
47 . 'if (scalar(@_) >= 2) {' . "\n"
48 . $self->_inline_copy_value . "\n"
49 . $self->_inline_check_required . "\n"
50 . $self->_inline_check_coercion . "\n"
51 . $self->_inline_check_constraint($value_name) . "\n"
52 . $self->_inline_store($inv, $value_name) . "\n"
53 . $self->_inline_trigger($inv, $value_name) . "\n"
55 . $self->_inline_check_lazy . "\n"
56 . $self->_inline_post_body(@_) . "\n"
57 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
61 sub generate_writer_method_inline {
63 my $attr = $self->associated_attribute;
64 my $attr_name = $attr->name;
66 my $slot_access = $self->_inline_get($inv, $attr_name);
67 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
69 $self->_eval_code('sub { '
70 . $self->_inline_pre_body(@_)
71 . $self->_inline_copy_value
72 . $self->_inline_check_required
73 . $self->_inline_check_coercion
74 . $self->_inline_check_constraint($value_name)
75 . $self->_inline_store($inv, $value_name)
76 . $self->_inline_post_body(@_)
77 . $self->_inline_trigger($inv, $value_name)
81 sub generate_reader_method_inline {
83 my $attr = $self->associated_attribute;
84 my $attr_name = $attr->name;
86 my $slot_access = $self->_inline_get($inv, $attr_name);
88 $self->_eval_code('sub {'
89 . $self->_inline_pre_body(@_)
90 . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;'
91 . $self->_inline_check_lazy
92 . $self->_inline_post_body(@_)
93 . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
97 sub _inline_copy_value {
98 return '' unless shift->_value_needs_copy;
99 return 'my $val = $_[1];'
102 sub _value_needs_copy {
103 my $attr = (shift)->associated_attribute;
104 return $attr->should_coerce;
107 sub generate_reader_method { shift->generate_reader_method_inline(@_) }
108 sub generate_writer_method { shift->generate_writer_method_inline(@_) }
109 sub generate_accessor_method { shift->generate_accessor_method_inline(@_) }
111 sub _inline_pre_body { '' }
112 sub _inline_post_body { '' }
114 sub _inline_check_constraint {
115 my ($self, $value) = @_;
117 my $attr = $self->associated_attribute;
118 my $attr_name = $attr->name;
120 return '' unless $attr->has_type_constraint;
122 my $type_constraint_name = $attr->type_constraint->name;
125 # This sprintf is insanely annoying, we should
126 # fix it someday - SL
127 return sprintf <<'EOF', $value, $attr_name, $value, $value,
128 $type_constraint->(%s)
129 || confess "Attribute (%s) does not pass the type constraint because: "
130 . $type_constraint_obj->get_message(%s);
134 sub _inline_check_coercion {
135 my $attr = (shift)->associated_attribute;
137 return '' unless $attr->should_coerce;
138 return '$val = $attr->type_constraint->coerce($_[1]);'
141 sub _inline_check_required {
142 my $attr = (shift)->associated_attribute;
144 my $attr_name = $attr->name;
146 return '' unless $attr->is_required;
147 return qq{defined(\$_[1]) || confess "Attribute ($attr_name) is required, so cannot be set to undef";}
150 sub _inline_check_lazy {
152 my $attr = $self->associated_attribute;
154 return '' unless $attr->is_lazy;
157 my $slot_access = $self->_inline_access($inv, $attr->name);
159 my $slot_exists = $self->_inline_has($inv, $attr->name);
161 my $code = 'unless (' . $slot_exists . ') {' . "\n";
162 if ($attr->has_type_constraint) {
163 if ($attr->has_default || $attr->has_builder) {
164 if ($attr->has_default) {
165 $code .= ' my $default = $attr->default(' . $inv . ');'."\n";
167 elsif ($attr->has_builder) {
168 $code .= ' my $default;'."\n".
169 ' if(my $builder = '.$inv.'->can($attr->builder)){ '."\n".
170 ' $default = '.$inv.'->$builder; '. "\n } else {\n" .
171 ' confess(Scalar::Util::blessed('.$inv.')." does not support builder method '.
172 '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }";
174 $code .= ' $default = $type_constraint_obj->coerce($default);'."\n" if $attr->should_coerce;
175 $code .= ' ($type_constraint->($default))' .
176 ' || confess "Attribute (" . $attr_name . ") does not pass the type constraint ("' .
177 ' . $type_constraint_name . ") with " . (defined($default) ? overload::StrVal($default) : "undef");'
179 $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, '$default') . "\n";
182 $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, 'undef') . "\n";
186 if ($attr->has_default) {
187 $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, ('$attr->default(' . $inv . ')')) . "\n";
189 elsif ($attr->has_builder) {
190 $code .= ' if (my $builder = '.$inv.'->can($attr->builder)) { ' . "\n"
191 . ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, ($inv . '->$builder'))
193 ' confess(Scalar::Util::blessed('.$inv.')." does not support builder method '.
194 '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }";
197 $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, 'undef') . "\n";
204 sub _inline_init_slot {
205 my ($self, $attr, $inv, $slot_access, $value) = @_;
206 if ($attr->has_initializer) {
207 return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
210 return ($slot_access . ' = ' . $value . ';');
215 my ($self, $instance, $value) = @_;
216 my $attr = $self->associated_attribute;
218 my $mi = $attr->associated_class->get_meta_instance;
219 my $slot_name = sprintf "'%s'", $attr->slots;
221 my $code = $mi->inline_set_slot_value($instance, $slot_name, $value) . ";";
222 $code .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";"
223 if $attr->is_weak_ref;
227 sub _inline_trigger {
228 my ($self, $instance, $value) = @_;
229 my $attr = $self->associated_attribute;
230 return '' unless $attr->has_trigger;
231 return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value);
235 my ($self, $instance) = @_;
236 my $attr = $self->associated_attribute;
238 my $mi = $attr->associated_class->get_meta_instance;
239 my $slot_name = sprintf "'%s'", $attr->slots;
241 return $mi->inline_get_slot_value($instance, $slot_name);
245 my ($self, $instance) = @_;
246 my $attr = $self->associated_attribute;
248 my $mi = $attr->associated_class->get_meta_instance;
249 my $slot_name = sprintf "'%s'", $attr->slots;
251 return $mi->inline_slot_access($instance, $slot_name);
255 my ($self, $instance) = @_;
256 my $attr = $self->associated_attribute;
258 my $mi = $attr->associated_class->get_meta_instance;
259 my $slot_name = sprintf "'%s'", $attr->slots;
261 return $mi->inline_is_slot_initialized($instance, $slot_name);
264 sub _inline_auto_deref {
265 my ( $self, $ref_value ) = @_;
266 my $attr = $self->associated_attribute;
268 return $ref_value unless $attr->should_auto_deref;
270 my $type_constraint = $attr->type_constraint;
273 if ($type_constraint->is_a_type_of('ArrayRef')) {
276 elsif ($type_constraint->is_a_type_of('HashRef')) {
280 confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'";
283 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
294 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
298 This is a subclass of L<Class::MOP::Method::Accessor> and it's primary
299 responsibility is to generate the accessor methods for attributes. It
300 can handle both closure based accessors, as well as inlined source based
303 This is a fairly new addition to the MOP, but this will play an important
304 role in the optimization strategy we are currently following.
310 =item B<generate_accessor_method>
312 =item B<generate_reader_method>
314 =item B<generate_writer_method>
316 =item B<generate_accessor_method_inline>
318 =item B<generate_reader_method_inline>
320 =item B<generate_writer_method_inline>
326 All complex software has bugs lurking in it, and this module is no
327 exception. If you find a bug please either email me, or add the bug
332 Stevan Little E<lt>stevan@iinteractive.comE<gt>
334 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
336 =head1 COPYRIGHT AND LICENSE
338 Copyright 2006-2008 by Infinity Interactive, Inc.
340 L<http://www.iinteractive.com>
342 This library is free software; you can redistribute it and/or modify
343 it under the same terms as Perl itself.