Commit | Line | Data |
51a3b106 |
1 | package Method::Generate::Accessor; |
2 | |
3 | use strictures 1; |
b1eebd55 |
4 | use Moo::_Utils; |
5 | use base qw(Moo::Object); |
51a3b106 |
6 | use Sub::Quote; |
7 | use B 'perlstring'; |
daa05b62 |
8 | BEGIN { |
6e294299 |
9 | our $CAN_HAZ_XS = |
33d35735 |
10 | !$ENV{MOO_XS_DISABLE} |
11 | && |
6e294299 |
12 | _maybe_load_module('Class::XSAccessor') |
13 | && |
edb9977c |
14 | (eval { Class::XSAccessor->VERSION('1.07') }) |
6e294299 |
15 | ; |
daa05b62 |
16 | } |
51a3b106 |
17 | |
316917c9 |
18 | sub generate_method { |
6f68f022 |
19 | my ($self, $into, $name, $spec, $quote_opts) = @_; |
51a3b106 |
20 | die "Must have an is" unless my $is = $spec->{is}; |
dcae37d3 |
21 | if ($is eq 'ro') { |
22 | $spec->{reader} = $name unless exists $spec->{reader}; |
23 | } elsif ($is eq 'rw') { |
24 | $spec->{accessor} = $name unless exists $spec->{accessor}; |
25 | } elsif ($is eq 'lazy') { |
dcae37d3 |
26 | $spec->{reader} = $name unless exists $spec->{reader}; |
27 | $spec->{lazy} = 1; |
28 | $spec->{builder} ||= '_build_'.$name unless $spec->{default}; |
2bb6aaa3 |
29 | } elsif ($is eq 'rwp') { |
30 | $spec->{reader} = $name unless exists $spec->{reader}; |
31 | $spec->{writer} = "_set_${name}" unless exists $spec->{writer}; |
dcae37d3 |
32 | } elsif ($is ne 'bare') { |
33 | die "Unknown is ${is}"; |
34 | } |
2bb6aaa3 |
35 | $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1; |
36 | if (($spec->{predicate}||0) eq 1) { |
37 | $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}"; |
38 | } |
39 | if (($spec->{clearer}||0) eq 1) { |
40 | $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}"; |
41 | } |
42 | if (($spec->{trigger}||0) eq 1) { |
43 | $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)'); |
44 | } |
dcae37d3 |
45 | my %methods; |
46 | if (my $reader = $spec->{reader}) { |
47 | if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) { |
48 | $methods{$reader} = $self->_generate_xs( |
873df570 |
49 | getters => $into, $reader, $name, $spec |
dcae37d3 |
50 | ); |
51 | } else { |
e57f338d |
52 | $self->{captures} = {}; |
dcae37d3 |
53 | $methods{$reader} = |
54 | quote_sub "${into}::${reader}" |
33d35735 |
55 | => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n" |
56 | .$self->_generate_get($name, $spec) |
e57f338d |
57 | => delete $self->{captures} |
dcae37d3 |
58 | ; |
59 | } |
60 | } |
61 | if (my $accessor = $spec->{accessor}) { |
62 | if ( |
63 | our $CAN_HAZ_XS |
64 | && $self->is_simple_get($name, $spec) |
65 | && $self->is_simple_set($name, $spec) |
66 | ) { |
67 | $methods{$accessor} = $self->_generate_xs( |
873df570 |
68 | accessors => $into, $accessor, $name, $spec |
dcae37d3 |
69 | ); |
70 | } else { |
e57f338d |
71 | $self->{captures} = {}; |
dcae37d3 |
72 | $methods{$accessor} = |
73 | quote_sub "${into}::${accessor}" |
74 | => $self->_generate_getset($name, $spec) |
e57f338d |
75 | => delete $self->{captures} |
dcae37d3 |
76 | ; |
77 | } |
78 | } |
79 | if (my $writer = $spec->{writer}) { |
80 | if ( |
81 | our $CAN_HAZ_XS |
82 | && $self->is_simple_set($name, $spec) |
83 | ) { |
84 | $methods{$writer} = $self->_generate_xs( |
873df570 |
85 | setters => $into, $writer, $name, $spec |
dcae37d3 |
86 | ); |
51a3b106 |
87 | } else { |
e57f338d |
88 | $self->{captures} = {}; |
dcae37d3 |
89 | $methods{$writer} = |
90 | quote_sub "${into}::${writer}" |
91 | => $self->_generate_set($name, $spec) |
e57f338d |
92 | => delete $self->{captures} |
dcae37d3 |
93 | ; |
51a3b106 |
94 | } |
dcae37d3 |
95 | } |
8f333548 |
96 | if (my $pred = $spec->{predicate}) { |
dcae37d3 |
97 | $methods{$pred} = |
98 | quote_sub "${into}::${pred}" => |
ceea0e38 |
99 | ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n" |
dcae37d3 |
100 | ; |
8f333548 |
101 | } |
102 | if (my $cl = $spec->{clearer}) { |
dcae37d3 |
103 | $methods{$cl} = |
104 | quote_sub "${into}::${cl}" => |
ceea0e38 |
105 | $self->_generate_simple_clear('$_[0]', $name, $spec)."\n" |
dcae37d3 |
106 | ; |
901efe1a |
107 | } |
4db3a740 |
108 | if (my $hspec = $spec->{handles}) { |
109 | my $asserter = $spec->{asserter} ||= '_assert_'.$name; |
110 | my @specs = do { |
111 | if (ref($hspec) eq 'ARRAY') { |
112 | map [ $_ => $_ ], @$hspec; |
113 | } elsif (ref($hspec) eq 'HASH') { |
114 | map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ], |
115 | keys %$hspec; |
116 | } elsif (!ref($hspec)) { |
117 | map [ $_ => $_ ], Role::Tiny->methods_provided_by($hspec); |
118 | } else { |
119 | die "You gave me a handles of ${hspec} and I have no idea why"; |
120 | } |
121 | }; |
122 | foreach my $spec (@specs) { |
123 | my ($proxy, $target, @args) = @$spec; |
e57f338d |
124 | $self->{captures} = {}; |
4db3a740 |
125 | $methods{$proxy} = |
126 | quote_sub "${into}::${proxy}" => |
127 | $self->_generate_delegation($asserter, $target, \@args), |
e57f338d |
128 | delete $self->{captures} |
4db3a740 |
129 | ; |
130 | } |
131 | } |
132 | if (my $asserter = $spec->{asserter}) { |
e57f338d |
133 | $self->{captures} = {}; |
4db3a740 |
134 | $methods{$asserter} = |
135 | quote_sub "${into}::${asserter}" => |
136 | 'do { '.$self->_generate_get($name, $spec).qq! }||die "Attempted to access '${name}' but it is not set"!, |
e57f338d |
137 | delete $self->{captures} |
4db3a740 |
138 | ; |
139 | } |
dcae37d3 |
140 | \%methods; |
51a3b106 |
141 | } |
142 | |
3a9a65a4 |
143 | sub is_simple_attribute { |
144 | my ($self, $name, $spec) = @_; |
8f333548 |
145 | # clearer doesn't have to be listed because it doesn't |
146 | # affect whether defined/exists makes a difference |
901efe1a |
147 | !grep $spec->{$_}, |
82a5b146 |
148 | qw(lazy default builder coerce isa trigger predicate weak_ref); |
3a9a65a4 |
149 | } |
150 | |
daa05b62 |
151 | sub is_simple_get { |
152 | my ($self, $name, $spec) = @_; |
901efe1a |
153 | !($spec->{lazy} and ($spec->{default} or $spec->{builder})); |
daa05b62 |
154 | } |
155 | |
156 | sub is_simple_set { |
157 | my ($self, $name, $spec) = @_; |
82a5b146 |
158 | !grep $spec->{$_}, qw(coerce isa trigger weak_ref); |
daa05b62 |
159 | } |
160 | |
4ced3a94 |
161 | sub has_eager_default { |
162 | my ($self, $name, $spec) = @_; |
163 | (!$spec->{lazy} and ($spec->{default} or $spec->{builder})); |
164 | } |
165 | |
51a3b106 |
166 | sub _generate_get { |
46389f86 |
167 | my ($self, $name, $spec) = @_; |
ceea0e38 |
168 | my $simple = $self->_generate_simple_get('$_[0]', $name, $spec); |
901efe1a |
169 | if ($self->is_simple_get($name, $spec)) { |
170 | $simple; |
171 | } else { |
172 | 'do { '.$self->_generate_use_default( |
173 | '$_[0]', $name, $spec, |
ceea0e38 |
174 | $self->_generate_simple_has('$_[0]', $name, $spec), |
901efe1a |
175 | ).'; '.$simple.' }'; |
176 | } |
46389f86 |
177 | } |
178 | |
179 | sub _generate_simple_has { |
180 | my ($self, $me, $name) = @_; |
181 | "exists ${me}->{${\perlstring $name}}"; |
182 | } |
183 | |
02e9ef74 |
184 | sub _generate_simple_clear { |
185 | my ($self, $me, $name) = @_; |
186 | " delete ${me}->{${\perlstring $name}}\n" |
187 | } |
188 | |
649ac264 |
189 | sub generate_get_default { |
190 | my $self = shift; |
e57f338d |
191 | $self->{captures} = {}; |
649ac264 |
192 | my $code = $self->_generate_get_default(@_); |
e57f338d |
193 | ($code, delete $self->{captures}); |
649ac264 |
194 | } |
195 | |
196 | sub _generate_use_default { |
197 | my ($self, $me, $name, $spec, $test) = @_; |
160c2c2c |
198 | my $get_value = $self->_generate_get_default($me, $name, $spec); |
199 | if ($spec->{coerce}) { |
200 | $get_value = $self->_generate_coerce( |
b1f04da5 |
201 | $name, $get_value, |
160c2c2c |
202 | $spec->{coerce} |
203 | ) |
204 | } |
46389f86 |
205 | $self->_generate_simple_set( |
160c2c2c |
206 | $me, $name, $spec, $get_value |
46389f86 |
207 | ).' unless '.$test; |
a16d301e |
208 | } |
209 | |
649ac264 |
210 | sub _generate_get_default { |
211 | my ($self, $me, $name, $spec) = @_; |
212 | $spec->{default} |
213 | ? $self->_generate_call_code($name, 'default', $me, $spec->{default}) |
214 | : "${me}->${\$spec->{builder}}" |
215 | } |
216 | |
a16d301e |
217 | sub generate_simple_get { |
901efe1a |
218 | my ($self, @args) = @_; |
219 | $self->_generate_simple_get(@args); |
a16d301e |
220 | } |
221 | |
222 | sub _generate_simple_get { |
223 | my ($self, $me, $name) = @_; |
224 | my $name_str = perlstring $name; |
225 | "${me}->{${name_str}}"; |
51a3b106 |
226 | } |
227 | |
228 | sub _generate_set { |
dcae37d3 |
229 | my ($self, $name, $spec) = @_; |
901efe1a |
230 | if ($self->is_simple_set($name, $spec)) { |
32381de9 |
231 | $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]'); |
6d377074 |
232 | } else { |
82a5b146 |
233 | my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)}; |
32381de9 |
234 | my $simple = $self->_generate_simple_set('$self', $name, $spec, '$value'); |
e57f338d |
235 | my $code = "do { my (\$self, \$value) = \@_;\n"; |
82a5b146 |
236 | if ($coerce) { |
237 | $code .= |
238 | " \$value = " |
b1f04da5 |
239 | .$self->_generate_coerce($name, '$value', $coerce).";\n"; |
82a5b146 |
240 | } |
901efe1a |
241 | if ($isa_check) { |
242 | $code .= |
e57f338d |
243 | " ".$self->_generate_isa_check($name, '$value', $isa_check).";\n"; |
901efe1a |
244 | } |
245 | if ($trigger) { |
e57f338d |
246 | my $fire = $self->_generate_trigger($name, '$self', '$value', $trigger); |
901efe1a |
247 | $code .= |
e57f338d |
248 | " ".$simple.";\n ".$fire.";\n" |
901efe1a |
249 | ." \$value;\n"; |
250 | } else { |
251 | $code .= " ".$simple.";\n"; |
252 | } |
253 | $code .= " }"; |
254 | $code; |
a16d301e |
255 | } |
a16d301e |
256 | } |
82a5b146 |
257 | |
258 | sub generate_coerce { |
259 | my $self = shift; |
260 | $self->{captures} = {}; |
261 | my $code = $self->_generate_coerce(@_); |
262 | ($code, delete $self->{captures}); |
263 | } |
264 | |
265 | sub _generate_coerce { |
b1f04da5 |
266 | my ($self, $name, $value, $coerce) = @_; |
82a5b146 |
267 | $self->_generate_call_code($name, 'coerce', "${value}", $coerce); |
268 | } |
269 | |
a16d301e |
270 | sub generate_trigger { |
271 | my $self = shift; |
e57f338d |
272 | $self->{captures} = {}; |
a16d301e |
273 | my $code = $self->_generate_trigger(@_); |
e57f338d |
274 | ($code, delete $self->{captures}); |
a16d301e |
275 | } |
276 | |
277 | sub _generate_trigger { |
278 | my ($self, $name, $obj, $value, $trigger) = @_; |
6d377074 |
279 | $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger); |
280 | } |
281 | |
282 | sub generate_isa_check { |
901efe1a |
283 | my ($self, @args) = @_; |
e57f338d |
284 | $self->{captures} = {}; |
901efe1a |
285 | my $code = $self->_generate_isa_check(@args); |
e57f338d |
286 | ($code, delete $self->{captures}); |
6d377074 |
287 | } |
288 | |
289 | sub _generate_isa_check { |
290 | my ($self, $name, $value, $check) = @_; |
291 | $self->_generate_call_code($name, 'isa_check', $value, $check); |
292 | } |
293 | |
294 | sub _generate_call_code { |
295 | my ($self, $name, $type, $values, $sub) = @_; |
296 | if (my $quoted = quoted_from_sub($sub)) { |
625d6219 |
297 | my $code = $quoted->[1]; |
e57f338d |
298 | my $at_ = '@_ = ('.$values.');'; |
8c6626cf |
299 | if (my $captures = $quoted->[2]) { |
6d377074 |
300 | my $cap_name = qq{\$${type}_captures_for_${name}}; |
8c6626cf |
301 | $self->{captures}->{$cap_name} = \$captures; |
e57f338d |
302 | Sub::Quote::inlinify( |
303 | $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6) |
304 | ); |
305 | } else { |
306 | Sub::Quote::inlinify($code, $values); |
8c6626cf |
307 | } |
901efe1a |
308 | } else { |
309 | my $cap_name = qq{\$${type}_for_${name}}; |
310 | $self->{captures}->{$cap_name} = \$sub; |
311 | "${cap_name}->(${values})"; |
625d6219 |
312 | } |
a16d301e |
313 | } |
314 | |
3a9a65a4 |
315 | sub generate_populate_set { |
316 | my $self = shift; |
e57f338d |
317 | $self->{captures} = {}; |
3a9a65a4 |
318 | my $code = $self->_generate_populate_set(@_); |
e57f338d |
319 | ($code, delete $self->{captures}); |
3a9a65a4 |
320 | } |
321 | |
322 | sub _generate_populate_set { |
323 | my ($self, $me, $name, $spec, $source, $test) = @_; |
4ced3a94 |
324 | if ($self->has_eager_default($name, $spec)) { |
3a9a65a4 |
325 | my $get_indent = ' ' x ($spec->{isa} ? 6 : 4); |
d02da2bc |
326 | my $get_default = $self->_generate_get_default( |
327 | '$new', $_, $spec |
328 | ); |
3a9a65a4 |
329 | my $get_value = |
d02da2bc |
330 | defined($spec->{init_arg}) |
331 | ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : " |
332 | .$get_default |
333 | ."\n${get_indent})" |
334 | : $get_default; |
b1f04da5 |
335 | if ($spec->{coerce}) { |
336 | $get_value = $self->_generate_coerce( |
337 | $name, $get_value, |
338 | $spec->{coerce} |
339 | ) |
7fe3b886 |
340 | } |
3a9a65a4 |
341 | ($spec->{isa} |
342 | ? " {\n my \$value = ".$get_value.";\n " |
5d349892 |
343 | .$self->_generate_isa_check( |
344 | $name, '$value', $spec->{isa} |
345 | ).";\n" |
32381de9 |
346 | .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n" |
5d349892 |
347 | ." }\n" |
32381de9 |
348 | : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n" |
3a9a65a4 |
349 | ) |
350 | .($spec->{trigger} |
351 | ? ' ' |
5d349892 |
352 | .$self->_generate_trigger( |
ceea0e38 |
353 | $name, $me, $self->_generate_simple_get($me, $name, $spec), |
5d349892 |
354 | $spec->{trigger} |
355 | )." if ${test};\n" |
3a9a65a4 |
356 | : '' |
357 | ); |
358 | } else { |
359 | " if (${test}) {\n" |
82a5b146 |
360 | .($spec->{coerce} |
361 | ? " $source = " |
362 | .$self->_generate_coerce( |
b1f04da5 |
363 | $name, $source, |
82a5b146 |
364 | $spec->{coerce} |
365 | ).";\n" |
366 | : "" |
367 | ) |
3a9a65a4 |
368 | .($spec->{isa} |
369 | ? " " |
5d349892 |
370 | .$self->_generate_isa_check( |
371 | $name, $source, $spec->{isa} |
372 | ).";\n" |
3a9a65a4 |
373 | : "" |
374 | ) |
32381de9 |
375 | ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n" |
3a9a65a4 |
376 | .($spec->{trigger} |
5d349892 |
377 | ? " " |
378 | .$self->_generate_trigger( |
ceea0e38 |
379 | $name, $me, $self->_generate_simple_get($me, $name, $spec), |
5d349892 |
380 | $spec->{trigger} |
381 | ).";\n" |
382 | : "" |
3a9a65a4 |
383 | ) |
384 | ." }\n"; |
385 | } |
386 | } |
387 | |
388 | sub generate_multi_set { |
389 | my ($self, $me, $to_set, $from) = @_; |
390 | "\@{${me}}{qw(${\join ' ', @$to_set})} = $from"; |
391 | } |
392 | |
873df570 |
393 | sub _generate_core_set { |
394 | my ($self, $me, $name, $spec, $value) = @_; |
395 | my $name_str = perlstring $name; |
396 | "${me}->{${name_str}} = ${value}"; |
397 | } |
398 | |
a16d301e |
399 | sub _generate_simple_set { |
32381de9 |
400 | my ($self, $me, $name, $spec, $value) = @_; |
a16d301e |
401 | my $name_str = perlstring $name; |
6b1913bc |
402 | my $simple = $self->_generate_core_set($me, $name, $spec, $value); |
2215d4b9 |
403 | |
32381de9 |
404 | if ($spec->{weak_ref}) { |
faa9ce11 |
405 | require Scalar::Util; |
2215d4b9 |
406 | |
407 | # Perl < 5.8.3 can't weaken refs to readonly vars |
408 | # (e.g. string constants). This *can* be solved by: |
409 | # |
410 | #Internals::SetReadWrite($foo); |
411 | #Scalar::Util::weaken ($foo); |
412 | #Internals::SetReadOnly($foo); |
413 | # |
414 | # but requires XS and is just too damn crazy |
415 | # so simply throw a better exception |
416 | Moo::_Utils::lt_5_8_3() ? <<"EOC" : "Scalar::Util::weaken(${simple})"; |
417 | |
418 | eval { Scalar::Util::weaken($simple); 1 } or do { |
419 | if( \$@ =~ /Modification of a read-only value attempted/) { |
faa9ce11 |
420 | require Carp; |
2215d4b9 |
421 | Carp::croak( sprintf ( |
422 | 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3', |
423 | $name_str, |
424 | ) ); |
425 | } else { |
426 | die \$@; |
427 | } |
428 | }; |
429 | EOC |
32381de9 |
430 | } else { |
431 | $simple; |
432 | } |
51a3b106 |
433 | } |
434 | |
435 | sub _generate_getset { |
a16d301e |
436 | my ($self, $name, $spec) = @_; |
dcae37d3 |
437 | q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec) |
f537c364 |
438 | ."\n : ".$self->_generate_get($name, $spec)."\n )"; |
51a3b106 |
439 | } |
440 | |
4db3a740 |
441 | sub _generate_delegation { |
442 | my ($self, $asserter, $target, $args) = @_; |
443 | my $arg_string = do { |
444 | if (@$args) { |
445 | # I could, I reckon, linearise out non-refs here using perlstring |
446 | # plus something to check for numbers but I'm unsure if it's worth it |
447 | $self->{captures}{'@curries'} = $args; |
448 | '@curries, @_'; |
449 | } else { |
450 | '@_'; |
451 | } |
452 | }; |
453 | "shift->${asserter}->${target}(${arg_string});"; |
454 | } |
455 | |
daa05b62 |
456 | sub _generate_xs { |
dcae37d3 |
457 | my ($self, $type, $into, $name, $slot) = @_; |
daa05b62 |
458 | Class::XSAccessor->import( |
e6f2e914 |
459 | class => $into, |
dcae37d3 |
460 | $type => { $name => $slot } |
daa05b62 |
461 | ); |
901efe1a |
462 | $into->can($name); |
daa05b62 |
463 | } |
464 | |
02e9ef74 |
465 | sub default_construction_string { '{}' } |
466 | |
51a3b106 |
467 | 1; |