Commit | Line | Data |
8ee73eeb |
1 | |
2 | package Moose::Meta::Method::Accessor; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
39b3bc94 |
7 | use Carp 'confess'; |
8 | |
330dbb07 |
9 | our $VERSION = '0.55'; |
d44714be |
10 | our $AUTHORITY = 'cpan:STEVAN'; |
8ee73eeb |
11 | |
39b3bc94 |
12 | use base 'Moose::Meta::Method', |
d617b644 |
13 | 'Class::MOP::Method::Accessor'; |
14 | |
946289d1 |
15 | ## Inline method generators |
d617b644 |
16 | |
c9183ffc |
17 | sub _eval_code { |
18 | my ( $self, $code ) = @_; |
19 | |
20 | # NOTE: |
21 | # set up the environment |
22 | my $attr = $self->associated_attribute; |
23 | my $attr_name = $attr->name; |
24 | |
25 | my $type_constraint_obj = $attr->type_constraint; |
26 | my $type_constraint_name = $type_constraint_obj && $type_constraint_obj->name; |
9df136d0 |
27 | my $type_constraint = $type_constraint_obj |
28 | ? $type_constraint_obj->_compiled_type_constraint |
29 | : undef; |
c9183ffc |
30 | |
ae8d63f2 |
31 | #warn "code for $attr_name =>\n" . $code . "\n"; |
c9183ffc |
32 | my $sub = eval $code; |
33 | confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@; |
34 | return $sub; |
35 | |
36 | } |
37 | |
946289d1 |
38 | sub generate_accessor_method_inline { |
3ccdc84a |
39 | my $self = $_[0]; |
26fbace8 |
40 | my $attr = $self->associated_attribute; |
3ccdc84a |
41 | my $attr_name = $attr->name; |
42 | my $inv = '$_[0]'; |
e27dfc11 |
43 | my $slot_access = $self->_inline_access($inv, $attr_name); |
ac211120 |
44 | my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]'; |
d617b644 |
45 | |
c9183ffc |
46 | $self->_eval_code('sub { ' . "\n" |
e27dfc11 |
47 | . $self->_inline_pre_body(@_) . "\n" |
e7c06c1e |
48 | . 'if (scalar(@_) >= 2) {' . "\n" |
ac211120 |
49 | . $self->_inline_copy_value . "\n" |
e27dfc11 |
50 | . $self->_inline_check_required . "\n" |
51 | . $self->_inline_check_coercion . "\n" |
52 | . $self->_inline_check_constraint($value_name) . "\n" |
32dd4a95 |
53 | . $self->_inline_store($inv, $value_name) . "\n" |
65e14c86 |
54 | . $self->_inline_trigger($inv, $value_name) . "\n" |
e27dfc11 |
55 | . ' }' . "\n" |
56 | . $self->_inline_check_lazy . "\n" |
57 | . $self->_inline_post_body(@_) . "\n" |
58 | . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n" |
c9183ffc |
59 | . ' }'); |
d617b644 |
60 | } |
61 | |
946289d1 |
62 | sub generate_writer_method_inline { |
3ccdc84a |
63 | my $self = $_[0]; |
26fbace8 |
64 | my $attr = $self->associated_attribute; |
3ccdc84a |
65 | my $attr_name = $attr->name; |
66 | my $inv = '$_[0]'; |
67 | my $slot_access = $self->_inline_get($inv, $attr_name); |
ac211120 |
68 | my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]'; |
3ccdc84a |
69 | |
c9183ffc |
70 | $self->_eval_code('sub { ' |
c350159f |
71 | . $self->_inline_pre_body(@_) |
ac211120 |
72 | . $self->_inline_copy_value |
d617b644 |
73 | . $self->_inline_check_required |
74 | . $self->_inline_check_coercion |
32dd4a95 |
75 | . $self->_inline_check_constraint($value_name) |
76 | . $self->_inline_store($inv, $value_name) |
77 | . $self->_inline_post_body(@_) |
65e14c86 |
78 | . $self->_inline_trigger($inv, $value_name) |
c9183ffc |
79 | . ' }'); |
d617b644 |
80 | } |
81 | |
946289d1 |
82 | sub generate_reader_method_inline { |
3ccdc84a |
83 | my $self = $_[0]; |
26fbace8 |
84 | my $attr = $self->associated_attribute; |
3ccdc84a |
85 | my $attr_name = $attr->name; |
86 | my $inv = '$_[0]'; |
87 | my $slot_access = $self->_inline_get($inv, $attr_name); |
26fbace8 |
88 | |
c9183ffc |
89 | $self->_eval_code('sub {' |
c350159f |
90 | . $self->_inline_pre_body(@_) |
d617b644 |
91 | . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;' |
92 | . $self->_inline_check_lazy |
c350159f |
93 | . $self->_inline_post_body(@_) |
3ccdc84a |
94 | . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';' |
c9183ffc |
95 | . '}'); |
d617b644 |
96 | } |
97 | |
ac211120 |
98 | sub _inline_copy_value { |
99 | return '' unless shift->_value_needs_copy; |
100 | return 'my $val = $_[1];' |
101 | } |
102 | |
103 | sub _value_needs_copy { |
104 | my $attr = (shift)->associated_attribute; |
105 | return $attr->should_coerce; |
106 | } |
107 | |
51308c23 |
108 | sub generate_reader_method { shift->generate_reader_method_inline(@_) } |
109 | sub generate_writer_method { shift->generate_writer_method_inline(@_) } |
110 | sub generate_accessor_method { shift->generate_accessor_method_inline(@_) } |
8ecb1fa0 |
111 | |
3ccdc84a |
112 | sub _inline_pre_body { '' } |
c350159f |
113 | sub _inline_post_body { '' } |
114 | |
d617b644 |
115 | sub _inline_check_constraint { |
97e11ef5 |
116 | my ($self, $value) = @_; |
117 | |
118 | my $attr = $self->associated_attribute; |
8bb7da15 |
119 | my $attr_name = $attr->name; |
97e11ef5 |
120 | |
121 | return '' unless $attr->has_type_constraint; |
122 | |
8bb7da15 |
123 | my $type_constraint_name = $attr->type_constraint->name; |
124 | |
97e11ef5 |
125 | # FIXME |
126 | # This sprintf is insanely annoying, we should |
127 | # fix it someday - SL |
688fcdda |
128 | return sprintf <<'EOF', $value, $attr_name, $value, $value, |
7c4f0d32 |
129 | $type_constraint->(%s) |
688fcdda |
130 | || confess "Attribute (%s) does not pass the type constraint because: " |
ab76842e |
131 | . $type_constraint_obj->get_message(%s); |
d617b644 |
132 | EOF |
133 | } |
134 | |
135 | sub _inline_check_coercion { |
97e11ef5 |
136 | my $attr = (shift)->associated_attribute; |
137 | |
138 | return '' unless $attr->should_coerce; |
ac211120 |
139 | return '$val = $attr->type_constraint->coerce($_[1]);' |
d617b644 |
140 | } |
141 | |
142 | sub _inline_check_required { |
97e11ef5 |
143 | my $attr = (shift)->associated_attribute; |
8bb7da15 |
144 | |
145 | my $attr_name = $attr->name; |
97e11ef5 |
146 | |
147 | return '' unless $attr->is_required; |
b6af66f8 |
148 | return qq{(\@_ >= 2) || confess "Attribute ($attr_name) is required, so cannot be set to undef";} # defined $_[1] is not good enough |
d617b644 |
149 | } |
150 | |
151 | sub _inline_check_lazy { |
3ccdc84a |
152 | my $self = $_[0]; |
26fbace8 |
153 | my $attr = $self->associated_attribute; |
154 | |
3822d5ee |
155 | return '' unless $attr->is_lazy; |
26fbace8 |
156 | |
3ccdc84a |
157 | my $inv = '$_[0]'; |
e27dfc11 |
158 | my $slot_access = $self->_inline_access($inv, $attr->name); |
3822d5ee |
159 | |
e27dfc11 |
160 | my $slot_exists = $self->_inline_has($inv, $attr->name); |
3822d5ee |
161 | |
162 | my $code = 'unless (' . $slot_exists . ') {' . "\n"; |
163 | if ($attr->has_type_constraint) { |
97e11ef5 |
164 | if ($attr->has_default || $attr->has_builder) { |
165 | if ($attr->has_default) { |
3822d5ee |
166 | $code .= ' my $default = $attr->default(' . $inv . ');'."\n"; |
97e11ef5 |
167 | } |
168 | elsif ($attr->has_builder) { |
3822d5ee |
169 | $code .= ' my $default;'."\n". |
170 | ' if(my $builder = '.$inv.'->can($attr->builder)){ '."\n". |
171 | ' $default = '.$inv.'->$builder; '. "\n } else {\n" . |
172 | ' confess(Scalar::Util::blessed('.$inv.')." does not support builder method '. |
173 | '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }"; |
174 | } |
7c4f0d32 |
175 | $code .= ' $default = $type_constraint_obj->coerce($default);'."\n" if $attr->should_coerce; |
176 | $code .= ' ($type_constraint->($default))' . |
177 | ' || confess "Attribute (" . $attr_name . ") does not pass the type constraint ("' . |
ab76842e |
178 | ' . $type_constraint_name . ") with " . (defined($default) ? overload::StrVal($default) : "undef");' |
179 | . "\n"; |
9df136d0 |
180 | $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, '$default') . "\n"; |
97e11ef5 |
181 | } |
182 | else { |
9df136d0 |
183 | $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, 'undef') . "\n"; |
26fbace8 |
184 | } |
185 | |
3822d5ee |
186 | } else { |
97e11ef5 |
187 | if ($attr->has_default) { |
9df136d0 |
188 | $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, ('$attr->default(' . $inv . ')')) . "\n"; |
97e11ef5 |
189 | } |
190 | elsif ($attr->has_builder) { |
9df136d0 |
191 | $code .= ' if (my $builder = '.$inv.'->can($attr->builder)) { ' . "\n" |
192 | . ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, ($inv . '->$builder')) |
193 | . "\n } else {\n" . |
3822d5ee |
194 | ' confess(Scalar::Util::blessed('.$inv.')." does not support builder method '. |
195 | '\'".$attr->builder."\' for attribute \'" . $attr->name . "\'");'. "\n }"; |
97e11ef5 |
196 | } |
197 | else { |
9df136d0 |
198 | $code .= ' ' . $self->_inline_init_slot($attr, $inv, $slot_access, 'undef') . "\n"; |
3822d5ee |
199 | } |
200 | } |
201 | $code .= "}\n"; |
202 | return $code; |
d617b644 |
203 | } |
204 | |
9df136d0 |
205 | sub _inline_init_slot { |
206 | my ($self, $attr, $inv, $slot_access, $value) = @_; |
207 | if ($attr->has_initializer) { |
208 | return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');'); |
209 | } |
210 | else { |
211 | return ($slot_access . ' = ' . $value . ';'); |
212 | } |
213 | } |
d617b644 |
214 | |
215 | sub _inline_store { |
97e11ef5 |
216 | my ($self, $instance, $value) = @_; |
217 | my $attr = $self->associated_attribute; |
65e14c86 |
218 | |
97e11ef5 |
219 | my $mi = $attr->associated_class->get_meta_instance; |
220 | my $slot_name = sprintf "'%s'", $attr->slots; |
65e14c86 |
221 | |
222 | my $code = $mi->inline_set_slot_value($instance, $slot_name, $value) . ";"; |
223 | $code .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";" |
224 | if $attr->is_weak_ref; |
225 | return $code; |
226 | } |
d617b644 |
227 | |
65e14c86 |
228 | sub _inline_trigger { |
229 | my ($self, $instance, $value) = @_; |
230 | my $attr = $self->associated_attribute; |
231 | return '' unless $attr->has_trigger; |
232 | return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value); |
d617b644 |
233 | } |
234 | |
235 | sub _inline_get { |
97e11ef5 |
236 | my ($self, $instance) = @_; |
237 | my $attr = $self->associated_attribute; |
238 | |
239 | my $mi = $attr->associated_class->get_meta_instance; |
240 | my $slot_name = sprintf "'%s'", $attr->slots; |
d617b644 |
241 | |
242 | return $mi->inline_get_slot_value($instance, $slot_name); |
243 | } |
244 | |
e27dfc11 |
245 | sub _inline_access { |
97e11ef5 |
246 | my ($self, $instance) = @_; |
247 | my $attr = $self->associated_attribute; |
248 | |
249 | my $mi = $attr->associated_class->get_meta_instance; |
250 | my $slot_name = sprintf "'%s'", $attr->slots; |
e27dfc11 |
251 | |
252 | return $mi->inline_slot_access($instance, $slot_name); |
253 | } |
254 | |
255 | sub _inline_has { |
97e11ef5 |
256 | my ($self, $instance) = @_; |
257 | my $attr = $self->associated_attribute; |
258 | |
259 | my $mi = $attr->associated_class->get_meta_instance; |
260 | my $slot_name = sprintf "'%s'", $attr->slots; |
e27dfc11 |
261 | |
262 | return $mi->inline_is_slot_initialized($instance, $slot_name); |
263 | } |
264 | |
d617b644 |
265 | sub _inline_auto_deref { |
266 | my ( $self, $ref_value ) = @_; |
26fbace8 |
267 | my $attr = $self->associated_attribute; |
d617b644 |
268 | |
39b3bc94 |
269 | return $ref_value unless $attr->should_auto_deref; |
d617b644 |
270 | |
39b3bc94 |
271 | my $type_constraint = $attr->type_constraint; |
d617b644 |
272 | |
273 | my $sigil; |
274 | if ($type_constraint->is_a_type_of('ArrayRef')) { |
275 | $sigil = '@'; |
26fbace8 |
276 | } |
d617b644 |
277 | elsif ($type_constraint->is_a_type_of('HashRef')) { |
278 | $sigil = '%'; |
26fbace8 |
279 | } |
d617b644 |
280 | else { |
281 | confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'"; |
282 | } |
283 | |
284 | "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )"; |
285 | } |
8ee73eeb |
286 | |
287 | 1; |
288 | |
289 | __END__ |
290 | |
291 | =pod |
292 | |
39b3bc94 |
293 | =head1 NAME |
294 | |
ecb59493 |
295 | Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors |
39b3bc94 |
296 | |
297 | =head1 DESCRIPTION |
298 | |
26fbace8 |
299 | This is a subclass of L<Class::MOP::Method::Accessor> and it's primary |
300 | responsibility is to generate the accessor methods for attributes. It |
ecb59493 |
301 | can handle both closure based accessors, as well as inlined source based |
26fbace8 |
302 | accessors. |
ecb59493 |
303 | |
304 | This is a fairly new addition to the MOP, but this will play an important |
305 | role in the optimization strategy we are currently following. |
306 | |
39b3bc94 |
307 | =head1 METHODS |
308 | |
309 | =over 4 |
310 | |
8ecb1fa0 |
311 | =item B<generate_accessor_method> |
312 | |
313 | =item B<generate_reader_method> |
314 | |
315 | =item B<generate_writer_method> |
316 | |
39b3bc94 |
317 | =item B<generate_accessor_method_inline> |
318 | |
39b3bc94 |
319 | =item B<generate_reader_method_inline> |
320 | |
39b3bc94 |
321 | =item B<generate_writer_method_inline> |
322 | |
323 | =back |
324 | |
325 | =head1 BUGS |
326 | |
26fbace8 |
327 | All complex software has bugs lurking in it, and this module is no |
39b3bc94 |
328 | exception. If you find a bug please either email me, or add the bug |
329 | to cpan-RT. |
330 | |
331 | =head1 AUTHOR |
332 | |
333 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
334 | |
335 | Yuval Kogman E<lt>nothingmuch@woobling.comE<gt> |
336 | |
337 | =head1 COPYRIGHT AND LICENSE |
338 | |
778db3ac |
339 | Copyright 2006-2008 by Infinity Interactive, Inc. |
39b3bc94 |
340 | |
341 | L<http://www.iinteractive.com> |
342 | |
343 | This library is free software; you can redistribute it and/or modify |
344 | it under the same terms as Perl itself. |
345 | |
51308c23 |
346 | =cut |