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