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 ($CurrentAttribute, $OrigSigDie);
24 $OrigSigDie ||= sub { die $_[0] };
26 return $OrigSigDie->(@_) if ref($_[0]);
28 my $attr_desc = _attr_desc(@$CurrentAttribute{qw(name init_arg)});
29 $OrigSigDie->("$CurrentAttribute->{step} for $attr_desc failed: $_[0]");
34 my ($pkg, $method, $type) = @_;
35 die "You cannot overwrite a locally defined method ($method) with @{[ $type || 'an accessor' ]}";
39 my ($self, $into, $name, $spec, $quote_opts) = @_;
40 $spec->{allow_overwrite}++ if $name =~ s/^\+//;
41 die "Must have an is" unless my $is = $spec->{is};
43 $spec->{reader} = $name unless exists $spec->{reader};
44 } elsif ($is eq 'rw') {
45 $spec->{accessor} = $name unless exists $spec->{accessor}
46 or ( $spec->{reader} and $spec->{writer} );
47 } elsif ($is eq 'lazy') {
48 $spec->{reader} = $name unless exists $spec->{reader};
50 $spec->{builder} ||= '_build_'.$name unless $spec->{default};
51 } elsif ($is eq 'rwp') {
52 $spec->{reader} = $name unless exists $spec->{reader};
53 $spec->{writer} = "_set_${name}" unless exists $spec->{writer};
54 } elsif ($is ne 'bare') {
55 die "Unknown is ${is}";
57 if (exists $spec->{builder}) {
58 if(ref $spec->{builder}) {
59 $self->_validate_codulatable('builder', $spec->{builder},
60 "$into->$name", 'or a method name');
61 $spec->{builder_sub} = $spec->{builder};
64 $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1;
65 die "Invalid builder for $into->$name - not a valid method name"
66 if $spec->{builder} !~ /\A[A-Za-z_][A-Za-z0-9_]*(?:::[A-Za-z_][A-Za-z0-9_]*)*\z/;
68 if (($spec->{predicate}||0) eq 1) {
69 $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}";
71 if (($spec->{clearer}||0) eq 1) {
72 $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}";
74 if (($spec->{trigger}||0) eq 1) {
75 $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)');
78 for my $setting (qw( isa coerce )) {
79 next if !exists $spec->{$setting};
80 $self->_validate_codulatable($setting, $spec->{$setting}, "$into->$name");
83 if (exists $spec->{default}) {
84 if (!defined $spec->{default} || ref $spec->{default}) {
85 $self->_validate_codulatable('default', $spec->{default}, "$into->$name", 'or a non-ref');
89 if (exists $spec->{moosify}) {
90 if (ref $spec->{moosify} ne 'ARRAY') {
91 $spec->{moosify} = [$spec->{moosify}];
94 for my $spec (@{$spec->{moosify}}) {
95 $self->_validate_codulatable('moosify', $spec, "$into->$name");
100 if (my $reader = $spec->{reader}) {
101 _die_overwrite($into, $reader, 'a reader')
102 if !$spec->{allow_overwrite} && *{_getglob("${into}::${reader}")}{CODE};
103 if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) {
104 $methods{$reader} = $self->_generate_xs(
105 getters => $into, $reader, $name, $spec
108 $self->{captures} = {};
110 quote_sub "${into}::${reader}"
111 => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n"
112 .$self->_generate_get($name, $spec)
113 => delete $self->{captures}
117 if (my $accessor = $spec->{accessor}) {
118 _die_overwrite($into, $accessor, 'an accessor')
119 if !$spec->{allow_overwrite} && *{_getglob("${into}::${accessor}")}{CODE};
122 && $self->is_simple_get($name, $spec)
123 && $self->is_simple_set($name, $spec)
125 $methods{$accessor} = $self->_generate_xs(
126 accessors => $into, $accessor, $name, $spec
129 $self->{captures} = {};
130 $methods{$accessor} =
131 quote_sub "${into}::${accessor}"
132 => $self->_generate_getset($name, $spec)
133 => delete $self->{captures}
137 if (my $writer = $spec->{writer}) {
138 _die_overwrite($into, $writer, 'a writer')
139 if !$spec->{allow_overwrite} && *{_getglob("${into}::${writer}")}{CODE};
142 && $self->is_simple_set($name, $spec)
144 $methods{$writer} = $self->_generate_xs(
145 setters => $into, $writer, $name, $spec
148 $self->{captures} = {};
150 quote_sub "${into}::${writer}"
151 => $self->_generate_set($name, $spec)
152 => delete $self->{captures}
156 if (my $pred = $spec->{predicate}) {
157 _die_overwrite($into, $pred, 'a predicate')
158 if !$spec->{allow_overwrite} && *{_getglob("${into}::${pred}")}{CODE};
160 quote_sub "${into}::${pred}" =>
161 ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n"
164 if (my $pred = $spec->{builder_sub}) {
165 _install_coderef( "${into}::$spec->{builder}" => $spec->{builder_sub} );
167 if (my $cl = $spec->{clearer}) {
168 _die_overwrite($into, $cl, 'a clearer')
169 if !$spec->{allow_overwrite} && *{_getglob("${into}::${cl}")}{CODE};
171 quote_sub "${into}::${cl}" =>
172 $self->_generate_simple_clear('$_[0]', $name, $spec)."\n"
175 if (my $hspec = $spec->{handles}) {
176 my $asserter = $spec->{asserter} ||= '_assert_'.$name;
178 if (ref($hspec) eq 'ARRAY') {
179 map [ $_ => $_ ], @$hspec;
180 } elsif (ref($hspec) eq 'HASH') {
181 map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ],
183 } elsif (!ref($hspec)) {
184 map [ $_ => $_ ], use_module('Role::Tiny')->methods_provided_by(use_module($hspec))
186 die "You gave me a handles of ${hspec} and I have no idea why";
189 foreach my $delegation_spec (@specs) {
190 my ($proxy, $target, @args) = @$delegation_spec;
191 _die_overwrite($into, $proxy, 'a delegation')
192 if !$spec->{allow_overwrite} && *{_getglob("${into}::${proxy}")}{CODE};
193 $self->{captures} = {};
195 quote_sub "${into}::${proxy}" =>
196 $self->_generate_delegation($asserter, $target, \@args),
197 delete $self->{captures}
201 if (my $asserter = $spec->{asserter}) {
202 $self->{captures} = {};
205 $methods{$asserter} =
206 quote_sub "${into}::${asserter}" => $self->_generate_asserter($name, $spec),
207 delete $self->{captures}
213 sub is_simple_attribute {
214 my ($self, $name, $spec) = @_;
215 # clearer doesn't have to be listed because it doesn't
216 # affect whether defined/exists makes a difference
218 qw(lazy default builder coerce isa trigger predicate weak_ref);
222 my ($self, $name, $spec) = @_;
223 !($spec->{lazy} and ($spec->{default} or $spec->{builder}));
227 my ($self, $name, $spec) = @_;
228 !grep $spec->{$_}, qw(coerce isa trigger weak_ref);
231 sub has_eager_default {
232 my ($self, $name, $spec) = @_;
233 (!$spec->{lazy} and (exists $spec->{default} or $spec->{builder}));
237 my ($self, $name, $spec) = @_;
238 my $simple = $self->_generate_simple_get('$_[0]', $name, $spec);
239 if ($self->is_simple_get($name, $spec)) {
242 $self->_generate_use_default(
243 '$_[0]', $name, $spec,
244 $self->_generate_simple_has('$_[0]', $name, $spec),
249 sub generate_simple_has {
251 $self->{captures} = {};
252 my $code = $self->_generate_simple_has(@_);
253 ($code, delete $self->{captures});
256 sub _generate_simple_has {
257 my ($self, $me, $name) = @_;
258 "exists ${me}->{${\perlstring $name}}";
261 sub _generate_simple_clear {
262 my ($self, $me, $name) = @_;
263 " delete ${me}->{${\perlstring $name}}\n"
266 sub generate_get_default {
268 $self->{captures} = {};
269 my $code = $self->_generate_get_default(@_);
270 ($code, delete $self->{captures});
273 sub generate_use_default {
275 $self->{captures} = {};
276 my $code = $self->_generate_use_default(@_);
277 ($code, delete $self->{captures});
280 sub _generate_use_default {
281 my ($self, $me, $name, $spec, $test) = @_;
282 my $get_value = $self->_generate_get_default($me, $name, $spec);
283 if ($spec->{coerce}) {
284 $get_value = $self->_generate_coerce(
290 .$self->_generate_simple_get($me, $name, $spec)."\n:"
292 ? " do {\n my \$value = ".$get_value.";\n"
293 ." ".$self->_generate_isa_check($name, '$value', $spec->{isa}).";\n"
294 ." ".$self->_generate_simple_set($me, $name, $spec, '$value')."\n"
296 : ' ('.$self->_generate_simple_set($me, $name, $spec, $get_value).")\n");
299 sub _generate_get_default {
300 my ($self, $me, $name, $spec) = @_;
301 if (exists $spec->{default}) {
303 ? $self->_generate_call_code($name, 'default', $me, $spec->{default})
304 : perlstring $spec->{default};
307 "${me}->${\$spec->{builder}}"
311 sub generate_simple_get {
312 my ($self, @args) = @_;
313 $self->_generate_simple_get(@args);
316 sub _generate_simple_get {
317 my ($self, $me, $name) = @_;
318 my $name_str = perlstring $name;
319 "${me}->{${name_str}}";
323 my ($self, $name, $spec) = @_;
324 if ($self->is_simple_set($name, $spec)) {
325 $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]');
327 my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)};
328 my $value_store = '$_[0]';
331 $value_store = '$value';
332 $code = "do { my (\$self, \$value) = \@_;\n"
334 .$self->_generate_coerce($name, $value_store, $coerce).";\n";
337 $code = "do { my \$self = shift;\n";
341 " ".$self->_generate_isa_check($name, $value_store, $isa_check).";\n";
343 my $simple = $self->_generate_simple_set('$self', $name, $spec, $value_store);
345 my $fire = $self->_generate_trigger($name, '$self', $value_store, $trigger);
347 " ".$simple.";\n ".$fire.";\n"
350 $code .= " ".$simple.";\n";
357 sub generate_coerce {
359 $self->{captures} = {};
360 my $code = $self->_generate_coerce(@_);
361 ($code, delete $self->{captures});
365 my ($name, $init_arg) = @_;
366 return perlstring($name) if !defined($init_arg) or $init_arg eq $name;
367 return perlstring($name).' (constructor argument: '.perlstring($init_arg).')';
370 sub _generate_coerce {
371 my ($self, $name, $value, $coerce, $init_arg) = @_;
372 $self->_generate_die_prefix(
376 $self->_generate_call_code($name, 'coerce', "${value}", $coerce)
380 sub generate_trigger {
382 $self->{captures} = {};
383 my $code = $self->_generate_trigger(@_);
384 ($code, delete $self->{captures});
387 sub _generate_trigger {
388 my ($self, $name, $obj, $value, $trigger) = @_;
389 $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger);
392 sub generate_isa_check {
393 my ($self, @args) = @_;
394 $self->{captures} = {};
395 my $code = $self->_generate_isa_check(@args);
396 ($code, delete $self->{captures});
399 sub _generate_die_prefix {
400 my ($self, $name, $prefix, $arg, $inside) = @_;
402 .' local $Method::Generate::Accessor::CurrentAttribute = {'
403 .' init_arg => '.(defined $arg ? B::perlstring($arg) : 'undef') . ",\n"
404 .' name => '.B::perlstring($name).",\n"
405 .' step => '.B::perlstring($prefix).",\n"
407 .' local $Method::Generate::Accessor::OrigSigDie = $SIG{__DIE__};'."\n"
408 .' local $SIG{__DIE__} = \&Method::Generate::Accessor::_SIGDIE;'."\n"
413 sub _generate_isa_check {
414 my ($self, $name, $value, $check, $init_arg) = @_;
415 $self->_generate_die_prefix(
419 $self->_generate_call_code($name, 'isa_check', $value, $check)
423 sub _generate_call_code {
424 my ($self, $name, $type, $values, $sub) = @_;
425 $sub = \&{$sub} if blessed($sub); # coderef if blessed
426 if (my $quoted = quoted_from_sub($sub)) {
428 if ($values eq '@_' || $values eq '$_[0]') {
432 my $code = $quoted->[1];
433 if (my $captures = $quoted->[2]) {
434 my $cap_name = qq{\$${type}_captures_for_${name}};
435 $self->{captures}->{$cap_name} = \$captures;
436 Sub::Quote::inlinify(
437 $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6), $local
440 Sub::Quote::inlinify($code, $values, undef, $local);
443 my $cap_name = qq{\$${type}_for_${name}};
444 $self->{captures}->{$cap_name} = \$sub;
445 "${cap_name}->(${values})";
449 sub generate_populate_set {
451 $self->{captures} = {};
452 my $code = $self->_generate_populate_set(@_);
453 ($code, delete $self->{captures});
456 sub _generate_populate_set {
457 my ($self, $me, $name, $spec, $source, $test, $init_arg) = @_;
458 if ($self->has_eager_default($name, $spec)) {
459 my $get_indent = ' ' x ($spec->{isa} ? 6 : 4);
460 my $get_default = $self->_generate_get_default(
464 defined($spec->{init_arg})
465 ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : "
469 if ($spec->{coerce}) {
470 $get_value = $self->_generate_coerce(
472 $spec->{coerce}, $init_arg
476 ? " {\n my \$value = ".$get_value.";\n "
477 .$self->_generate_isa_check(
478 $name, '$value', $spec->{isa}, $init_arg
480 .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n"
482 : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n"
486 .$self->_generate_trigger(
487 $name, $me, $self->_generate_simple_get($me, $name, $spec),
496 .$self->_generate_coerce(
498 $spec->{coerce}, $init_arg
504 .$self->_generate_isa_check(
505 $name, $source, $spec->{isa}, $init_arg
509 ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n"
512 .$self->_generate_trigger(
513 $name, $me, $self->_generate_simple_get($me, $name, $spec),
522 sub _generate_core_set {
523 my ($self, $me, $name, $spec, $value) = @_;
524 my $name_str = perlstring $name;
525 "${me}->{${name_str}} = ${value}";
528 sub _generate_simple_set {
529 my ($self, $me, $name, $spec, $value) = @_;
530 my $name_str = perlstring $name;
531 my $simple = $self->_generate_core_set($me, $name, $spec, $value);
533 if ($spec->{weak_ref}) {
534 require Scalar::Util;
535 my $get = $self->_generate_simple_get($me, $name, $spec);
537 # Perl < 5.8.3 can't weaken refs to readonly vars
538 # (e.g. string constants). This *can* be solved by:
540 #Internals::SetReadWrite($foo);
541 #Scalar::Util::weaken ($foo);
542 #Internals::SetReadOnly($foo);
544 # but requires XS and is just too damn crazy
545 # so simply throw a better exception
546 my $weak_simple = "do { Scalar::Util::weaken(${simple}); no warnings 'void'; $get }";
547 Moo::_Utils::lt_5_8_3() ? <<"EOC" : $weak_simple;
548 eval { Scalar::Util::weaken($simple); 1 }
549 ? do { no warnings 'void'; $get }
551 if( \$@ =~ /Modification of a read-only value attempted/) {
553 Carp::croak( sprintf (
554 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3',
567 sub _generate_getset {
568 my ($self, $name, $spec) = @_;
569 q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec)
570 ."\n : ".$self->_generate_get($name, $spec)."\n )";
573 sub _generate_asserter {
574 my ($self, $name, $spec) = @_;
577 ." my \$val = ".$self->_generate_get($name, $spec).";\n"
578 ." unless (".$self->_generate_simple_has('$_[0]', $name, $spec).") {\n"
579 .qq! die "Attempted to access '${name}' but it is not set";\n!
584 sub _generate_delegation {
585 my ($self, $asserter, $target, $args) = @_;
586 my $arg_string = do {
588 # I could, I reckon, linearise out non-refs here using perlstring
589 # plus something to check for numbers but I'm unsure if it's worth it
590 $self->{captures}{'@curries'} = $args;
596 "shift->${asserter}->${target}(${arg_string});";
600 my ($self, $type, $into, $name, $slot) = @_;
601 Class::XSAccessor->import(
603 $type => { $name => $slot },
609 sub default_construction_string { '{}' }
611 sub _validate_codulatable {
612 my ($self, $setting, $value, $into, $appended) = @_;
613 my $invalid = "Invalid $setting '" . overload::StrVal($value)
614 . "' for $into not a coderef";
615 $invalid .= " $appended" if $appended;
617 unless (ref $value and (ref $value eq 'CODE' or blessed($value))) {
618 die "$invalid or code-convertible object";
621 unless (eval { \&$value }) {
622 die "$invalid and could not be converted to a coderef: $@";