1 package Method::Generate::Accessor;
5 use base qw(Moo::Object);
8 use Scalar::Util 'blessed';
14 _maybe_load_module('Class::XSAccessor')
16 (eval { Class::XSAccessor->VERSION('1.07') })
21 my ($self, $into, $name, $spec, $quote_opts) = @_;
23 die "Must have an is" unless my $is = $spec->{is};
25 $spec->{reader} = $name unless exists $spec->{reader};
26 } elsif ($is eq 'rw') {
27 $spec->{accessor} = $name unless exists $spec->{accessor};
28 } elsif ($is eq 'lazy') {
29 $spec->{reader} = $name unless exists $spec->{reader};
31 $spec->{builder} ||= '_build_'.$name unless $spec->{default};
32 } elsif ($is eq 'rwp') {
33 $spec->{reader} = $name unless exists $spec->{reader};
34 $spec->{writer} = "_set_${name}" unless exists $spec->{writer};
35 } elsif ($is ne 'bare') {
36 die "Unknown is ${is}";
38 $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1;
39 if (($spec->{predicate}||0) eq 1) {
40 $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}";
42 if (($spec->{clearer}||0) eq 1) {
43 $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}";
45 if (($spec->{trigger}||0) eq 1) {
46 $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)');
49 for my $setting (qw( default coerce )) {
50 next if !exists $spec->{$setting};
51 my $value = $spec->{$setting};
52 my $invalid = "Invalid $setting '" . overload::StrVal($value)
53 . "' for $into->$name - not a coderef";
54 die "$invalid or code-convertible object"
55 unless ref $value and (ref $value eq 'CODE' or blessed($value));
56 die "$invalid and could not be converted to a coderef: $@"
57 if !eval { \&$value };
61 if (my $reader = $spec->{reader}) {
62 if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) {
63 $methods{$reader} = $self->_generate_xs(
64 getters => $into, $reader, $name, $spec
67 $self->{captures} = {};
69 quote_sub "${into}::${reader}"
70 => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n"
71 .$self->_generate_get($name, $spec)
72 => delete $self->{captures}
76 if (my $accessor = $spec->{accessor}) {
79 && $self->is_simple_get($name, $spec)
80 && $self->is_simple_set($name, $spec)
82 $methods{$accessor} = $self->_generate_xs(
83 accessors => $into, $accessor, $name, $spec
86 $self->{captures} = {};
88 quote_sub "${into}::${accessor}"
89 => $self->_generate_getset($name, $spec)
90 => delete $self->{captures}
94 if (my $writer = $spec->{writer}) {
97 && $self->is_simple_set($name, $spec)
99 $methods{$writer} = $self->_generate_xs(
100 setters => $into, $writer, $name, $spec
103 $self->{captures} = {};
105 quote_sub "${into}::${writer}"
106 => $self->_generate_set($name, $spec)
107 => delete $self->{captures}
111 if (my $pred = $spec->{predicate}) {
113 quote_sub "${into}::${pred}" =>
114 ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n"
117 if (my $cl = $spec->{clearer}) {
119 quote_sub "${into}::${cl}" =>
120 $self->_generate_simple_clear('$_[0]', $name, $spec)."\n"
123 if (my $hspec = $spec->{handles}) {
124 my $asserter = $spec->{asserter} ||= '_assert_'.$name;
126 if (ref($hspec) eq 'ARRAY') {
127 map [ $_ => $_ ], @$hspec;
128 } elsif (ref($hspec) eq 'HASH') {
129 map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ],
131 } elsif (!ref($hspec)) {
132 map [ $_ => $_ ], Role::Tiny->methods_provided_by($hspec);
134 die "You gave me a handles of ${hspec} and I have no idea why";
137 foreach my $spec (@specs) {
138 my ($proxy, $target, @args) = @$spec;
139 $self->{captures} = {};
141 quote_sub "${into}::${proxy}" =>
142 $self->_generate_delegation($asserter, $target, \@args),
143 delete $self->{captures}
147 if (my $asserter = $spec->{asserter}) {
148 $self->{captures} = {};
149 $methods{$asserter} =
150 quote_sub "${into}::${asserter}" =>
151 'do { '.$self->_generate_get($name, $spec).qq! }||die "Attempted to access '${name}' but it is not set"!,
152 delete $self->{captures}
158 sub is_simple_attribute {
159 my ($self, $name, $spec) = @_;
160 # clearer doesn't have to be listed because it doesn't
161 # affect whether defined/exists makes a difference
163 qw(lazy default builder coerce isa trigger predicate weak_ref);
167 my ($self, $name, $spec) = @_;
168 !($spec->{lazy} and ($spec->{default} or $spec->{builder}));
172 my ($self, $name, $spec) = @_;
173 !grep $spec->{$_}, qw(coerce isa trigger weak_ref);
176 sub has_eager_default {
177 my ($self, $name, $spec) = @_;
178 (!$spec->{lazy} and ($spec->{default} or $spec->{builder}));
182 my ($self, $name, $spec) = @_;
183 my $simple = $self->_generate_simple_get('$_[0]', $name, $spec);
184 if ($self->is_simple_get($name, $spec)) {
187 'do { '.$self->_generate_use_default(
188 '$_[0]', $name, $spec,
189 $self->_generate_simple_has('$_[0]', $name, $spec),
192 ?($self->_generate_isa_check($name, $simple, $spec->{isa}).'; ')
199 sub _generate_simple_has {
200 my ($self, $me, $name) = @_;
201 "exists ${me}->{${\perlstring $name}}";
204 sub _generate_simple_clear {
205 my ($self, $me, $name) = @_;
206 " delete ${me}->{${\perlstring $name}}\n"
209 sub generate_get_default {
211 $self->{captures} = {};
212 my $code = $self->_generate_get_default(@_);
213 ($code, delete $self->{captures});
216 sub _generate_use_default {
217 my ($self, $me, $name, $spec, $test) = @_;
218 my $get_value = $self->_generate_get_default($me, $name, $spec);
219 if ($spec->{coerce}) {
220 $get_value = $self->_generate_coerce(
225 $self->_generate_simple_set(
226 $me, $name, $spec, $get_value
230 sub _generate_get_default {
231 my ($self, $me, $name, $spec) = @_;
233 ? $self->_generate_call_code($name, 'default', $me, $spec->{default})
234 : "${me}->${\$spec->{builder}}"
237 sub generate_simple_get {
238 my ($self, @args) = @_;
239 $self->_generate_simple_get(@args);
242 sub _generate_simple_get {
243 my ($self, $me, $name) = @_;
244 my $name_str = perlstring $name;
245 "${me}->{${name_str}}";
249 my ($self, $name, $spec) = @_;
250 if ($self->is_simple_set($name, $spec)) {
251 $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]');
253 my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)};
254 my $simple = $self->_generate_simple_set('$self', $name, $spec, '$value');
255 my $code = "do { my (\$self, \$value) = \@_;\n";
259 .$self->_generate_coerce($name, '$value', $coerce).";\n";
263 " ".$self->_generate_isa_check($name, '$value', $isa_check).";\n";
266 my $fire = $self->_generate_trigger($name, '$self', '$value', $trigger);
268 " ".$simple.";\n ".$fire.";\n"
271 $code .= " ".$simple.";\n";
278 sub generate_coerce {
280 $self->{captures} = {};
281 my $code = $self->_generate_coerce(@_);
282 ($code, delete $self->{captures});
285 sub _generate_coerce {
286 my ($self, $name, $value, $coerce) = @_;
287 $self->_generate_die_prefix(
288 "coercion for ${\perlstring($name)} failed: ",
289 $self->_generate_call_code($name, 'coerce', "${value}", $coerce)
293 sub generate_trigger {
295 $self->{captures} = {};
296 my $code = $self->_generate_trigger(@_);
297 ($code, delete $self->{captures});
300 sub _generate_trigger {
301 my ($self, $name, $obj, $value, $trigger) = @_;
302 $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger);
305 sub generate_isa_check {
306 my ($self, @args) = @_;
307 $self->{captures} = {};
308 my $code = $self->_generate_isa_check(@args);
309 ($code, delete $self->{captures});
312 sub _generate_die_prefix {
313 my ($self, $prefix, $inside) = @_;
315 .' my $sig_die = $SIG{__DIE__} || sub { die $_[0] };'."\n"
316 .' local $SIG{__DIE__} = sub {'."\n"
317 .' $sig_die->(ref($_[0]) ? $_[0] : '.perlstring($prefix).'.$_[0]);'."\n"
323 sub _generate_isa_check {
324 my ($self, $name, $value, $check) = @_;
325 $self->_generate_die_prefix(
326 "isa check for ${\perlstring($name)} failed: ",
327 $self->_generate_call_code($name, 'isa_check', $value, $check)
331 sub _generate_call_code {
332 my ($self, $name, $type, $values, $sub) = @_;
333 if (my $quoted = quoted_from_sub($sub)) {
334 my $code = $quoted->[1];
335 my $at_ = '@_ = ('.$values.');';
336 if (my $captures = $quoted->[2]) {
337 my $cap_name = qq{\$${type}_captures_for_${name}};
338 $self->{captures}->{$cap_name} = \$captures;
339 Sub::Quote::inlinify(
340 $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6)
343 Sub::Quote::inlinify($code, $values);
346 my $cap_name = qq{\$${type}_for_${name}};
347 $self->{captures}->{$cap_name} = \$sub;
348 "${cap_name}->(${values})";
352 sub generate_populate_set {
354 $self->{captures} = {};
355 my $code = $self->_generate_populate_set(@_);
356 ($code, delete $self->{captures});
359 sub _generate_populate_set {
360 my ($self, $me, $name, $spec, $source, $test) = @_;
361 if ($self->has_eager_default($name, $spec)) {
362 my $get_indent = ' ' x ($spec->{isa} ? 6 : 4);
363 my $get_default = $self->_generate_get_default(
367 defined($spec->{init_arg})
368 ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : "
372 if ($spec->{coerce}) {
373 $get_value = $self->_generate_coerce(
379 ? " {\n my \$value = ".$get_value.";\n "
380 .$self->_generate_isa_check(
381 $name, '$value', $spec->{isa}
383 .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n"
385 : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n"
389 .$self->_generate_trigger(
390 $name, $me, $self->_generate_simple_get($me, $name, $spec),
399 .$self->_generate_coerce(
407 .$self->_generate_isa_check(
408 $name, $source, $spec->{isa}
412 ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n"
415 .$self->_generate_trigger(
416 $name, $me, $self->_generate_simple_get($me, $name, $spec),
425 sub _generate_core_set {
426 my ($self, $me, $name, $spec, $value) = @_;
427 my $name_str = perlstring $name;
428 "${me}->{${name_str}} = ${value}";
431 sub _generate_simple_set {
432 my ($self, $me, $name, $spec, $value) = @_;
433 my $name_str = perlstring $name;
435 if ($spec->{weak_ref}) {
436 $value = '$preserve = '.$value;
437 my $simple = $self->_generate_core_set($me, $name, $spec, $value);
438 require Scalar::Util;
440 # Perl < 5.8.3 can't weaken refs to readonly vars
441 # (e.g. string constants). This *can* be solved by:
443 #Internals::SetReadWrite($foo);
444 #Scalar::Util::weaken ($foo);
445 #Internals::SetReadOnly($foo);
447 # but requires XS and is just too damn crazy
448 # so simply throw a better exception
449 my $weak_simple = "my \$preserve; Scalar::Util::weaken(${simple})";
450 Moo::_Utils::lt_5_8_3() ? <<"EOC" : $weak_simple;
453 eval { Scalar::Util::weaken($simple); 1 } or do {
454 if( \$@ =~ /Modification of a read-only value attempted/) {
456 Carp::croak( sprintf (
457 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3',
466 $self->_generate_core_set($me, $name, $spec, $value);
470 sub _generate_getset {
471 my ($self, $name, $spec) = @_;
472 q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec)
473 ."\n : ".$self->_generate_get($name, $spec)."\n )";
476 sub _generate_delegation {
477 my ($self, $asserter, $target, $args) = @_;
478 my $arg_string = do {
480 # I could, I reckon, linearise out non-refs here using perlstring
481 # plus something to check for numbers but I'm unsure if it's worth it
482 $self->{captures}{'@curries'} = $args;
488 "shift->${asserter}->${target}(${arg_string});";
492 my ($self, $type, $into, $name, $slot) = @_;
493 Class::XSAccessor->import(
495 $type => { $name => $slot },
501 sub default_construction_string { '{}' }