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