1 package Method::Generate::Accessor;
5 use base qw(Moo::Object);
8 use Scalar::Util 'blessed';
10 use Module::Runtime qw(use_module);
15 _maybe_load_module('Class::XSAccessor')
17 (eval { Class::XSAccessor->VERSION('1.07') })
22 my ($self, $into, $name, $spec, $quote_opts) = @_;
24 die "Must have an is" unless my $is = $spec->{is};
26 $spec->{reader} = $name unless exists $spec->{reader};
27 } elsif ($is eq 'rw') {
28 $spec->{accessor} = $name unless exists $spec->{accessor}
29 or ( $spec->{reader} and $spec->{writer} );
30 } elsif ($is eq 'lazy') {
31 $spec->{reader} = $name unless exists $spec->{reader};
33 $spec->{builder} ||= '_build_'.$name unless $spec->{default};
34 } elsif ($is eq 'rwp') {
35 $spec->{reader} = $name unless exists $spec->{reader};
36 $spec->{writer} = "_set_${name}" unless exists $spec->{writer};
37 } elsif ($is ne 'bare') {
38 die "Unknown is ${is}";
40 if (exists $spec->{builder}) {
41 if(ref $spec->{builder}) {
42 die "Invalid builder for $into->$name - not a method name, coderef or"
43 . " code-convertible object"
44 unless ref $spec->{builder} eq 'CODE'
45 or (blessed($spec->{builder}) and eval { \&{$spec->{builder}} });
46 $spec->{builder_sub} = $spec->{builder};
49 $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1;
50 die "Invalid builder for $into->$name - not a valid method name"
51 if $spec->{builder} !~ /\A[A-Za-z_][A-Za-z0-9_]*(?:::[A-Za-z_][A-Za-z0-9_]*)*\z/;
53 if (($spec->{predicate}||0) eq 1) {
54 $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}";
56 if (($spec->{clearer}||0) eq 1) {
57 $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}";
59 if (($spec->{trigger}||0) eq 1) {
60 $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)');
63 for my $setting (qw( default coerce )) {
64 next if !exists $spec->{$setting};
65 my $value = $spec->{$setting};
66 my $invalid = "Invalid $setting '" . overload::StrVal($value)
67 . "' for $into->$name - not a coderef";
68 die "$invalid or code-convertible object"
69 unless ref $value and (ref $value eq 'CODE' or blessed($value));
70 die "$invalid and could not be converted to a coderef: $@"
71 if !eval { \&$value };
75 if (my $reader = $spec->{reader}) {
76 if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) {
77 $methods{$reader} = $self->_generate_xs(
78 getters => $into, $reader, $name, $spec
81 $self->{captures} = {};
83 quote_sub "${into}::${reader}"
84 => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n"
85 .$self->_generate_get($name, $spec)
86 => delete $self->{captures}
90 if (my $accessor = $spec->{accessor}) {
93 && $self->is_simple_get($name, $spec)
94 && $self->is_simple_set($name, $spec)
96 $methods{$accessor} = $self->_generate_xs(
97 accessors => $into, $accessor, $name, $spec
100 $self->{captures} = {};
101 $methods{$accessor} =
102 quote_sub "${into}::${accessor}"
103 => $self->_generate_getset($name, $spec)
104 => delete $self->{captures}
108 if (my $writer = $spec->{writer}) {
111 && $self->is_simple_set($name, $spec)
113 $methods{$writer} = $self->_generate_xs(
114 setters => $into, $writer, $name, $spec
117 $self->{captures} = {};
119 quote_sub "${into}::${writer}"
120 => $self->_generate_set($name, $spec)
121 => delete $self->{captures}
125 if (my $pred = $spec->{predicate}) {
127 quote_sub "${into}::${pred}" =>
128 ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n"
131 if (my $pred = $spec->{builder_sub}) {
132 _install_coderef( "${into}::$spec->{builder}" => $spec->{builder_sub} );
134 if (my $cl = $spec->{clearer}) {
136 quote_sub "${into}::${cl}" =>
137 $self->_generate_simple_clear('$_[0]', $name, $spec)."\n"
140 if (my $hspec = $spec->{handles}) {
141 my $asserter = $spec->{asserter} ||= '_assert_'.$name;
143 if (ref($hspec) eq 'ARRAY') {
144 map [ $_ => $_ ], @$hspec;
145 } elsif (ref($hspec) eq 'HASH') {
146 map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ],
148 } elsif (!ref($hspec)) {
149 map [ $_ => $_ ], use_module('Role::Tiny')->methods_provided_by(use_module($hspec))
151 die "You gave me a handles of ${hspec} and I have no idea why";
154 foreach my $spec (@specs) {
155 my ($proxy, $target, @args) = @$spec;
156 $self->{captures} = {};
158 quote_sub "${into}::${proxy}" =>
159 $self->_generate_delegation($asserter, $target, \@args),
160 delete $self->{captures}
164 if (my $asserter = $spec->{asserter}) {
165 $self->{captures} = {};
166 $methods{$asserter} =
167 quote_sub "${into}::${asserter}" =>
168 'do { '.$self->_generate_get($name, $spec).qq! }||die "Attempted to access '${name}' but it is not set"!,
169 delete $self->{captures}
175 sub is_simple_attribute {
176 my ($self, $name, $spec) = @_;
177 # clearer doesn't have to be listed because it doesn't
178 # affect whether defined/exists makes a difference
180 qw(lazy default builder coerce isa trigger predicate weak_ref);
184 my ($self, $name, $spec) = @_;
185 !($spec->{lazy} and ($spec->{default} or $spec->{builder}));
189 my ($self, $name, $spec) = @_;
190 !grep $spec->{$_}, qw(coerce isa trigger weak_ref);
193 sub has_eager_default {
194 my ($self, $name, $spec) = @_;
195 (!$spec->{lazy} and ($spec->{default} or $spec->{builder}));
199 my ($self, $name, $spec) = @_;
200 my $simple = $self->_generate_simple_get('$_[0]', $name, $spec);
201 if ($self->is_simple_get($name, $spec)) {
204 'do { '.$self->_generate_use_default(
205 '$_[0]', $name, $spec,
206 $self->_generate_simple_has('$_[0]', $name, $spec),
209 ?($self->_generate_isa_check($name, $simple, $spec->{isa}).'; ')
216 sub _generate_simple_has {
217 my ($self, $me, $name) = @_;
218 "exists ${me}->{${\perlstring $name}}";
221 sub _generate_simple_clear {
222 my ($self, $me, $name) = @_;
223 " delete ${me}->{${\perlstring $name}}\n"
226 sub generate_get_default {
228 $self->{captures} = {};
229 my $code = $self->_generate_get_default(@_);
230 ($code, delete $self->{captures});
233 sub _generate_use_default {
234 my ($self, $me, $name, $spec, $test) = @_;
235 my $get_value = $self->_generate_get_default($me, $name, $spec);
236 if ($spec->{coerce}) {
237 $get_value = $self->_generate_coerce(
242 $self->_generate_simple_set(
243 $me, $name, $spec, $get_value
247 sub _generate_get_default {
248 my ($self, $me, $name, $spec) = @_;
250 ? $self->_generate_call_code($name, 'default', $me, $spec->{default})
251 : "${me}->${\$spec->{builder}}"
254 sub generate_simple_get {
255 my ($self, @args) = @_;
256 $self->_generate_simple_get(@args);
259 sub _generate_simple_get {
260 my ($self, $me, $name) = @_;
261 my $name_str = perlstring $name;
262 "${me}->{${name_str}}";
266 my ($self, $name, $spec) = @_;
267 if ($self->is_simple_set($name, $spec)) {
268 $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]');
270 my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)};
271 my $simple = $self->_generate_simple_set('$self', $name, $spec, '$value');
272 my $code = "do { my (\$self, \$value) = \@_;\n";
276 .$self->_generate_coerce($name, '$value', $coerce).";\n";
280 " ".$self->_generate_isa_check($name, '$value', $isa_check).";\n";
283 my $fire = $self->_generate_trigger($name, '$self', '$value', $trigger);
285 " ".$simple.";\n ".$fire.";\n"
288 $code .= " ".$simple.";\n";
295 sub generate_coerce {
297 $self->{captures} = {};
298 my $code = $self->_generate_coerce(@_);
299 ($code, delete $self->{captures});
303 my ($name, $init_arg) = @_;
304 return perlstring($name) if !defined($init_arg) or $init_arg eq $name;
305 return perlstring($name).' (constructor argument: '.perlstring($init_arg).')';
308 sub _generate_coerce {
309 my ($self, $name, $value, $coerce, $init_arg) = @_;
310 $self->_generate_die_prefix(
311 "coercion for ${\_attr_desc($name, $init_arg)} failed: ",
312 $self->_generate_call_code($name, 'coerce', "${value}", $coerce)
316 sub generate_trigger {
318 $self->{captures} = {};
319 my $code = $self->_generate_trigger(@_);
320 ($code, delete $self->{captures});
323 sub _generate_trigger {
324 my ($self, $name, $obj, $value, $trigger) = @_;
325 $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger);
328 sub generate_isa_check {
329 my ($self, @args) = @_;
330 $self->{captures} = {};
331 my $code = $self->_generate_isa_check(@args);
332 ($code, delete $self->{captures});
335 sub _generate_die_prefix {
336 my ($self, $prefix, $inside) = @_;
338 .' my $sig_die = $SIG{__DIE__} || sub { die $_[0] };'."\n"
339 .' local $SIG{__DIE__} = sub {'."\n"
340 .' $sig_die->(ref($_[0]) ? $_[0] : '.perlstring($prefix).'.$_[0]);'."\n"
346 sub _generate_isa_check {
347 my ($self, $name, $value, $check, $init_arg) = @_;
348 $self->_generate_die_prefix(
349 "isa check for ${\_attr_desc($name, $init_arg)} failed: ",
350 $self->_generate_call_code($name, 'isa_check', $value, $check)
354 sub _generate_call_code {
355 my ($self, $name, $type, $values, $sub) = @_;
356 if (my $quoted = quoted_from_sub($sub)) {
357 my $code = $quoted->[1];
358 if (my $captures = $quoted->[2]) {
359 my $cap_name = qq{\$${type}_captures_for_${name}};
360 $self->{captures}->{$cap_name} = \$captures;
361 Sub::Quote::inlinify(
362 $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6), 1
365 Sub::Quote::inlinify($code, $values, undef, 1);
368 my $cap_name = qq{\$${type}_for_${name}};
369 $self->{captures}->{$cap_name} = \$sub;
370 "${cap_name}->(${values})";
374 sub generate_populate_set {
376 $self->{captures} = {};
377 my $code = $self->_generate_populate_set(@_);
378 ($code, delete $self->{captures});
381 sub _generate_populate_set {
382 my ($self, $me, $name, $spec, $source, $test, $init_arg) = @_;
383 if ($self->has_eager_default($name, $spec)) {
384 my $get_indent = ' ' x ($spec->{isa} ? 6 : 4);
385 my $get_default = $self->_generate_get_default(
389 defined($spec->{init_arg})
390 ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : "
394 if ($spec->{coerce}) {
395 $get_value = $self->_generate_coerce(
397 $spec->{coerce}, $init_arg
401 ? " {\n my \$value = ".$get_value.";\n "
402 .$self->_generate_isa_check(
403 $name, '$value', $spec->{isa}, $init_arg
405 .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n"
407 : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n"
411 .$self->_generate_trigger(
412 $name, $me, $self->_generate_simple_get($me, $name, $spec),
421 .$self->_generate_coerce(
423 $spec->{coerce}, $init_arg
429 .$self->_generate_isa_check(
430 $name, $source, $spec->{isa}, $init_arg
434 ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n"
437 .$self->_generate_trigger(
438 $name, $me, $self->_generate_simple_get($me, $name, $spec),
447 sub _generate_core_set {
448 my ($self, $me, $name, $spec, $value) = @_;
449 my $name_str = perlstring $name;
450 "${me}->{${name_str}} = ${value}";
453 sub _generate_simple_set {
454 my ($self, $me, $name, $spec, $value) = @_;
455 my $name_str = perlstring $name;
457 if ($spec->{weak_ref}) {
458 $value = '$preserve = '.$value;
459 my $simple = $self->_generate_core_set($me, $name, $spec, $value);
460 require Scalar::Util;
462 # Perl < 5.8.3 can't weaken refs to readonly vars
463 # (e.g. string constants). This *can* be solved by:
465 #Internals::SetReadWrite($foo);
466 #Scalar::Util::weaken ($foo);
467 #Internals::SetReadOnly($foo);
469 # but requires XS and is just too damn crazy
470 # so simply throw a better exception
471 my $weak_simple = "my \$preserve; Scalar::Util::weaken(${simple}); no warnings 'void'; \$preserve";
472 Moo::_Utils::lt_5_8_3() ? <<"EOC" : $weak_simple;
475 eval { Scalar::Util::weaken($simple); 1 }
476 ? do { no warnings 'void'; \$preserve; }
478 if( \$@ =~ /Modification of a read-only value attempted/) {
480 Carp::croak( sprintf (
481 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3',
490 $self->_generate_core_set($me, $name, $spec, $value);
494 sub _generate_getset {
495 my ($self, $name, $spec) = @_;
496 q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec)
497 ."\n : ".$self->_generate_get($name, $spec)."\n )";
500 sub _generate_delegation {
501 my ($self, $asserter, $target, $args) = @_;
502 my $arg_string = do {
504 # I could, I reckon, linearise out non-refs here using perlstring
505 # plus something to check for numbers but I'm unsure if it's worth it
506 $self->{captures}{'@curries'} = $args;
512 "shift->${asserter}->${target}(${arg_string});";
516 my ($self, $type, $into, $name, $slot) = @_;
517 Class::XSAccessor->import(
519 $type => { $name => $slot },
525 sub default_construction_string { '{}' }