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') })
23 our ($CurrentArgument, $CurrentAttribute, $CurrentStep, $OrigSigDie);
24 $OrigSigDie ||= sub { die $_[0] };
25 my $attr_desc = _attr_desc($CurrentAttribute, $CurrentArgument);
26 $OrigSigDie->("$CurrentStep for $attr_desc failed: $_[0]");
31 my ($pkg, $method, $type) = @_;
32 die "You cannot overwrite a locally defined method ($method) with @{[ $type || 'an accessor' ]}";
36 my ($self, $into, $name, $spec, $quote_opts) = @_;
37 $spec->{allow_overwrite}++ if $name =~ s/^\+//;
38 die "Must have an is" unless my $is = $spec->{is};
40 $spec->{reader} = $name unless exists $spec->{reader};
41 } elsif ($is eq 'rw') {
42 $spec->{accessor} = $name unless exists $spec->{accessor}
43 or ( $spec->{reader} and $spec->{writer} );
44 } elsif ($is eq 'lazy') {
45 $spec->{reader} = $name unless exists $spec->{reader};
47 $spec->{builder} ||= '_build_'.$name unless $spec->{default};
48 } elsif ($is eq 'rwp') {
49 $spec->{reader} = $name unless exists $spec->{reader};
50 $spec->{writer} = "_set_${name}" unless exists $spec->{writer};
51 } elsif ($is ne 'bare') {
52 die "Unknown is ${is}";
54 if (exists $spec->{builder}) {
55 if(ref $spec->{builder}) {
56 die "Invalid builder for $into->$name - not a method name, coderef or"
57 . " code-convertible object"
58 unless ref $spec->{builder} eq 'CODE'
59 or (blessed($spec->{builder}) and eval { \&{$spec->{builder}} });
60 $spec->{builder_sub} = $spec->{builder};
63 $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1;
64 die "Invalid builder for $into->$name - not a valid method name"
65 if $spec->{builder} !~ /\A[A-Za-z_][A-Za-z0-9_]*(?:::[A-Za-z_][A-Za-z0-9_]*)*\z/;
67 if (($spec->{predicate}||0) eq 1) {
68 $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}";
70 if (($spec->{clearer}||0) eq 1) {
71 $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}";
73 if (($spec->{trigger}||0) eq 1) {
74 $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)');
77 for my $setting (qw( isa coerce )) {
78 next if !exists $spec->{$setting};
79 $self->_validate_codulatable($setting, $spec->{$setting}, "$into->$name");
82 if (exists $spec->{default}) {
83 if (!defined $spec->{default} || ref $spec->{default}) {
84 $self->_validate_codulatable('default', $spec->{default}, "$into->$name", 'or a non-ref');
88 if (exists $spec->{moosify}) {
89 if (ref $spec->{moosify} ne 'ARRAY') {
90 $spec->{moosify} = [$spec->{moosify}];
93 for my $spec (@{$spec->{moosify}}) {
94 $self->_validate_codulatable('moosify', $spec, "$into->$name");
99 if (my $reader = $spec->{reader}) {
100 _die_overwrite($into, $reader, 'a reader')
101 if !$spec->{allow_overwrite} && *{_getglob("${into}::${reader}")}{CODE};
102 if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) {
103 $methods{$reader} = $self->_generate_xs(
104 getters => $into, $reader, $name, $spec
107 $self->{captures} = {};
109 quote_sub "${into}::${reader}"
110 => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n"
111 .$self->_generate_get($name, $spec)
112 => delete $self->{captures}
116 if (my $accessor = $spec->{accessor}) {
117 _die_overwrite($into, $accessor, 'an accessor')
118 if !$spec->{allow_overwrite} && *{_getglob("${into}::${accessor}")}{CODE};
121 && $self->is_simple_get($name, $spec)
122 && $self->is_simple_set($name, $spec)
124 $methods{$accessor} = $self->_generate_xs(
125 accessors => $into, $accessor, $name, $spec
128 $self->{captures} = {};
129 $methods{$accessor} =
130 quote_sub "${into}::${accessor}"
131 => $self->_generate_getset($name, $spec)
132 => delete $self->{captures}
136 if (my $writer = $spec->{writer}) {
137 _die_overwrite($into, $writer, 'a writer')
138 if !$spec->{allow_overwrite} && *{_getglob("${into}::${writer}")}{CODE};
141 && $self->is_simple_set($name, $spec)
143 $methods{$writer} = $self->_generate_xs(
144 setters => $into, $writer, $name, $spec
147 $self->{captures} = {};
149 quote_sub "${into}::${writer}"
150 => $self->_generate_set($name, $spec)
151 => delete $self->{captures}
155 if (my $pred = $spec->{predicate}) {
156 _die_overwrite($into, $pred, 'a predicate')
157 if !$spec->{allow_overwrite} && *{_getglob("${into}::${pred}")}{CODE};
159 quote_sub "${into}::${pred}" =>
160 ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n"
163 if (my $pred = $spec->{builder_sub}) {
164 _install_coderef( "${into}::$spec->{builder}" => $spec->{builder_sub} );
166 if (my $cl = $spec->{clearer}) {
167 _die_overwrite($into, $cl, 'a clearer')
168 if !$spec->{allow_overwrite} && *{_getglob("${into}::${cl}")}{CODE};
170 quote_sub "${into}::${cl}" =>
171 $self->_generate_simple_clear('$_[0]', $name, $spec)."\n"
174 if (my $hspec = $spec->{handles}) {
175 my $asserter = $spec->{asserter} ||= '_assert_'.$name;
177 if (ref($hspec) eq 'ARRAY') {
178 map [ $_ => $_ ], @$hspec;
179 } elsif (ref($hspec) eq 'HASH') {
180 map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ],
182 } elsif (!ref($hspec)) {
183 map [ $_ => $_ ], use_module('Role::Tiny')->methods_provided_by(use_module($hspec))
185 die "You gave me a handles of ${hspec} and I have no idea why";
188 foreach my $delegation_spec (@specs) {
189 my ($proxy, $target, @args) = @$delegation_spec;
190 _die_overwrite($into, $proxy, 'a delegation')
191 if !$spec->{allow_overwrite} && *{_getglob("${into}::${proxy}")}{CODE};
192 $self->{captures} = {};
194 quote_sub "${into}::${proxy}" =>
195 $self->_generate_delegation($asserter, $target, \@args),
196 delete $self->{captures}
200 if (my $asserter = $spec->{asserter}) {
201 $self->{captures} = {};
204 $methods{$asserter} =
205 quote_sub "${into}::${asserter}" => $self->_generate_asserter($name, $spec),
206 delete $self->{captures}
212 sub is_simple_attribute {
213 my ($self, $name, $spec) = @_;
214 # clearer doesn't have to be listed because it doesn't
215 # affect whether defined/exists makes a difference
217 qw(lazy default builder coerce isa trigger predicate weak_ref);
221 my ($self, $name, $spec) = @_;
222 !($spec->{lazy} and ($spec->{default} or $spec->{builder}));
226 my ($self, $name, $spec) = @_;
227 !grep $spec->{$_}, qw(coerce isa trigger weak_ref);
230 sub has_eager_default {
231 my ($self, $name, $spec) = @_;
232 (!$spec->{lazy} and (exists $spec->{default} or $spec->{builder}));
236 my ($self, $name, $spec) = @_;
237 my $simple = $self->_generate_simple_get('$_[0]', $name, $spec);
238 if ($self->is_simple_get($name, $spec)) {
241 $self->_generate_use_default(
242 '$_[0]', $name, $spec,
243 $self->_generate_simple_has('$_[0]', $name, $spec),
248 sub _generate_simple_has {
249 my ($self, $me, $name) = @_;
250 "exists ${me}->{${\perlstring $name}}";
253 sub _generate_simple_clear {
254 my ($self, $me, $name) = @_;
255 " delete ${me}->{${\perlstring $name}}\n"
258 sub generate_get_default {
260 $self->{captures} = {};
261 my $code = $self->_generate_get_default(@_);
262 ($code, delete $self->{captures});
265 sub _generate_use_default {
266 my ($self, $me, $name, $spec, $test) = @_;
267 my $get_value = $self->_generate_get_default($me, $name, $spec);
268 if ($spec->{coerce}) {
269 $get_value = $self->_generate_coerce(
275 .$self->_generate_simple_get($me, $name, $spec)."\n:"
277 ? " do {\n my \$value = ".$get_value.";\n"
278 ." ".$self->_generate_isa_check($name, '$value', $spec->{isa}).";\n"
279 ." ".$self->_generate_simple_set($me, $name, $spec, '$value')."\n"
281 : ' ('.$self->_generate_simple_set($me, $name, $spec, $get_value).")\n");
284 sub _generate_get_default {
285 my ($self, $me, $name, $spec) = @_;
286 if (exists $spec->{default}) {
288 ? $self->_generate_call_code($name, 'default', $me, $spec->{default})
289 : perlstring $spec->{default};
292 "${me}->${\$spec->{builder}}"
296 sub generate_simple_get {
297 my ($self, @args) = @_;
298 $self->_generate_simple_get(@args);
301 sub _generate_simple_get {
302 my ($self, $me, $name) = @_;
303 my $name_str = perlstring $name;
304 "${me}->{${name_str}}";
308 my ($self, $name, $spec) = @_;
309 if ($self->is_simple_set($name, $spec)) {
310 $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]');
312 my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)};
313 my $value_store = '$_[0]';
316 $value_store = '$value';
317 $code = "do { my (\$self, \$value) = \@_;\n"
319 .$self->_generate_coerce($name, $value_store, $coerce).";\n";
322 $code = "do { my \$self = shift;\n";
326 " ".$self->_generate_isa_check($name, $value_store, $isa_check).";\n";
328 my $simple = $self->_generate_simple_set('$self', $name, $spec, $value_store);
330 my $fire = $self->_generate_trigger($name, '$self', $value_store, $trigger);
332 " ".$simple.";\n ".$fire.";\n"
335 $code .= " ".$simple.";\n";
342 sub generate_coerce {
344 $self->{captures} = {};
345 my $code = $self->_generate_coerce(@_);
346 ($code, delete $self->{captures});
350 my ($name, $init_arg) = @_;
351 return perlstring($name) if !defined($init_arg) or $init_arg eq $name;
352 return perlstring($name).' (constructor argument: '.perlstring($init_arg).')';
355 sub _generate_coerce {
356 my ($self, $name, $value, $coerce, $init_arg) = @_;
357 $self->_generate_die_prefix(
361 $self->_generate_call_code($name, 'coerce', "${value}", $coerce)
365 sub generate_trigger {
367 $self->{captures} = {};
368 my $code = $self->_generate_trigger(@_);
369 ($code, delete $self->{captures});
372 sub _generate_trigger {
373 my ($self, $name, $obj, $value, $trigger) = @_;
374 $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger);
377 sub generate_isa_check {
378 my ($self, @args) = @_;
379 $self->{captures} = {};
380 my $code = $self->_generate_isa_check(@args);
381 ($code, delete $self->{captures});
384 sub _generate_die_prefix {
385 my ($self, $name, $prefix, $init_arg, $inside) = @_;
388 .' local $Method::Generate::Accessor::CurrentArgument = '
389 . (defined $init_arg ? B::perlstring($init_arg) : 'undef') . ";\n"
390 .' local $Method::Generate::Accessor::CurrentAttribute = '
391 . B::perlstring($name) . ";\n"
392 .' local $Method::Generate::Accessor::CurrentStep = '
393 . B::perlstring($prefix) . ";\n"
394 .' local $Method::Generate::Accessor::OrigSigDie = $SIG{__DIE__};'."\n"
395 .' local $SIG{__DIE__} = \&Method::Generate::Accessor::_SIGDIE;'."\n"
400 sub _generate_isa_check {
401 my ($self, $name, $value, $check, $init_arg) = @_;
402 $self->_generate_die_prefix(
406 $self->_generate_call_code($name, 'isa_check', $value, $check)
410 sub _generate_call_code {
411 my ($self, $name, $type, $values, $sub) = @_;
412 $sub = \&{$sub} if blessed($sub); # coderef if blessed
413 if (my $quoted = quoted_from_sub($sub)) {
415 if ($values eq '@_' || $values eq '$_[0]') {
419 my $code = $quoted->[1];
420 if (my $captures = $quoted->[2]) {
421 my $cap_name = qq{\$${type}_captures_for_${name}};
422 $self->{captures}->{$cap_name} = \$captures;
423 Sub::Quote::inlinify(
424 $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6), $local
427 Sub::Quote::inlinify($code, $values, undef, $local);
430 my $cap_name = qq{\$${type}_for_${name}};
431 $self->{captures}->{$cap_name} = \$sub;
432 "${cap_name}->(${values})";
436 sub generate_populate_set {
438 $self->{captures} = {};
439 my $code = $self->_generate_populate_set(@_);
440 ($code, delete $self->{captures});
443 sub _generate_populate_set {
444 my ($self, $me, $name, $spec, $source, $test, $init_arg) = @_;
445 if ($self->has_eager_default($name, $spec)) {
446 my $get_indent = ' ' x ($spec->{isa} ? 6 : 4);
447 my $get_default = $self->_generate_get_default(
451 defined($spec->{init_arg})
452 ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : "
456 if ($spec->{coerce}) {
457 $get_value = $self->_generate_coerce(
459 $spec->{coerce}, $init_arg
463 ? " {\n my \$value = ".$get_value.";\n "
464 .$self->_generate_isa_check(
465 $name, '$value', $spec->{isa}, $init_arg
467 .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n"
469 : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n"
473 .$self->_generate_trigger(
474 $name, $me, $self->_generate_simple_get($me, $name, $spec),
483 .$self->_generate_coerce(
485 $spec->{coerce}, $init_arg
491 .$self->_generate_isa_check(
492 $name, $source, $spec->{isa}, $init_arg
496 ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n"
499 .$self->_generate_trigger(
500 $name, $me, $self->_generate_simple_get($me, $name, $spec),
509 sub _generate_core_set {
510 my ($self, $me, $name, $spec, $value) = @_;
511 my $name_str = perlstring $name;
512 "${me}->{${name_str}} = ${value}";
515 sub _generate_simple_set {
516 my ($self, $me, $name, $spec, $value) = @_;
517 my $name_str = perlstring $name;
518 my $simple = $self->_generate_core_set($me, $name, $spec, $value);
520 if ($spec->{weak_ref}) {
521 require Scalar::Util;
522 my $get = $self->_generate_simple_get($me, $name, $spec);
524 # Perl < 5.8.3 can't weaken refs to readonly vars
525 # (e.g. string constants). This *can* be solved by:
527 #Internals::SetReadWrite($foo);
528 #Scalar::Util::weaken ($foo);
529 #Internals::SetReadOnly($foo);
531 # but requires XS and is just too damn crazy
532 # so simply throw a better exception
533 my $weak_simple = "do { Scalar::Util::weaken(${simple}); no warnings 'void'; $get }";
534 Moo::_Utils::lt_5_8_3() ? <<"EOC" : $weak_simple;
535 eval { Scalar::Util::weaken($simple); 1 }
536 ? do { no warnings 'void'; $get }
538 if( \$@ =~ /Modification of a read-only value attempted/) {
540 Carp::croak( sprintf (
541 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3',
554 sub _generate_getset {
555 my ($self, $name, $spec) = @_;
556 q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec)
557 ."\n : ".$self->_generate_get($name, $spec)."\n )";
560 sub _generate_asserter {
561 my ($self, $name, $spec) = @_;
564 ." my \$val = ".$self->_generate_get($name, $spec).";\n"
565 ." unless (".$self->_generate_simple_has('$_[0]', $name, $spec).") {\n"
566 .qq! die "Attempted to access '${name}' but it is not set";\n!
571 sub _generate_delegation {
572 my ($self, $asserter, $target, $args) = @_;
573 my $arg_string = do {
575 # I could, I reckon, linearise out non-refs here using perlstring
576 # plus something to check for numbers but I'm unsure if it's worth it
577 $self->{captures}{'@curries'} = $args;
583 "shift->${asserter}->${target}(${arg_string});";
587 my ($self, $type, $into, $name, $slot) = @_;
588 Class::XSAccessor->import(
590 $type => { $name => $slot },
596 sub default_construction_string { '{}' }
598 sub _validate_codulatable {
599 my ($self, $setting, $value, $into, $appended) = @_;
600 my $invalid = "Invalid $setting '" . overload::StrVal($value)
601 . "' for $into not a coderef";
602 $invalid .= " $appended" if $appended;
604 unless (ref $value and (ref $value eq 'CODE' or blessed($value))) {
605 die "$invalid or code-convertible object";
608 unless (eval { \&$value }) {
609 die "$invalid and could not be converted to a coderef: $@";