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