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 my ($pkg, $method, $type) = @_;
24 *{_getglob("${pkg}::${method}")}{CODE} and
25 die "You cannot overwrite a locally defined method ($method) with a @{[ $type || 'accessor' ]}";
29 my ($self, $into, $name, $spec, $quote_opts) = @_;
31 die "Must have an is" unless my $is = $spec->{is};
33 $spec->{reader} = $name unless exists $spec->{reader};
34 } elsif ($is eq 'rw') {
35 $spec->{accessor} = $name unless exists $spec->{accessor}
36 or ( $spec->{reader} and $spec->{writer} );
37 } elsif ($is eq 'lazy') {
38 $spec->{reader} = $name unless exists $spec->{reader};
40 $spec->{builder} ||= '_build_'.$name unless $spec->{default};
41 } elsif ($is eq 'rwp') {
42 $spec->{reader} = $name unless exists $spec->{reader};
43 $spec->{writer} = "_set_${name}" unless exists $spec->{writer};
44 } elsif ($is ne 'bare') {
45 die "Unknown is ${is}";
47 if (exists $spec->{builder}) {
48 if(ref $spec->{builder}) {
49 die "Invalid builder for $into->$name - not a method name, coderef or"
50 . " code-convertible object"
51 unless ref $spec->{builder} eq 'CODE'
52 or (blessed($spec->{builder}) and eval { \&{$spec->{builder}} });
53 $spec->{builder_sub} = $spec->{builder};
56 $spec->{builder} = '_build_'.$name if ($spec->{builder}||0) eq 1;
57 die "Invalid builder for $into->$name - not a valid method name"
58 if $spec->{builder} !~ /\A[A-Za-z_][A-Za-z0-9_]*(?:::[A-Za-z_][A-Za-z0-9_]*)*\z/;
60 if (($spec->{predicate}||0) eq 1) {
61 $spec->{predicate} = $name =~ /^_/ ? "_has${name}" : "has_${name}";
63 if (($spec->{clearer}||0) eq 1) {
64 $spec->{clearer} = $name =~ /^_/ ? "_clear${name}" : "clear_${name}";
66 if (($spec->{trigger}||0) eq 1) {
67 $spec->{trigger} = quote_sub('shift->_trigger_'.$name.'(@_)');
70 if (exists $spec->{coerce}) {
71 my $value = $spec->{coerce};
72 my $invalid = "Invalid coerce '" . overload::StrVal($value)
73 . "' for $into->$name - not a coderef";
74 die "$invalid or code-convertible object"
75 unless ref $value and (ref $value eq 'CODE' or blessed($value));
76 die "$invalid and could not be converted to a coderef: $@"
77 if !eval { \&$value };
80 if (exists $spec->{default}) {
81 my $value = $spec->{default};
82 if (!defined $value || ref $value) {
83 my $invalid = "Invalid default '" . overload::StrVal($value)
84 . "' for $into->$name - not a coderef or non-ref";
85 die "$invalid or code-convertible object"
86 unless ref $value and (ref $value eq 'CODE' or blessed($value));
87 die "$invalid and could not be converted to a coderef: $@"
88 if !eval { \&$value };
94 if (my $reader = $spec->{reader}) {
95 _check_overwrite($into, $reader, 'reader');
96 if (our $CAN_HAZ_XS && $self->is_simple_get($name, $spec)) {
97 $methods{$reader} = $self->_generate_xs(
98 getters => $into, $reader, $name, $spec
101 $self->{captures} = {};
103 quote_sub "${into}::${reader}"
104 => ' die "'.$reader.' is a read-only accessor" if @_ > 1;'."\n"
105 .$self->_generate_get($name, $spec)
106 => delete $self->{captures}
110 if (my $accessor = $spec->{accessor}) {
111 _check_overwrite($into, $accessor, 'accessor');
114 && $self->is_simple_get($name, $spec)
115 && $self->is_simple_set($name, $spec)
117 $methods{$accessor} = $self->_generate_xs(
118 accessors => $into, $accessor, $name, $spec
121 $self->{captures} = {};
122 $methods{$accessor} =
123 quote_sub "${into}::${accessor}"
124 => $self->_generate_getset($name, $spec)
125 => delete $self->{captures}
129 if (my $writer = $spec->{writer}) {
130 _check_overwrite($into, $writer, 'writer');
133 && $self->is_simple_set($name, $spec)
135 $methods{$writer} = $self->_generate_xs(
136 setters => $into, $writer, $name, $spec
139 $self->{captures} = {};
141 quote_sub "${into}::${writer}"
142 => $self->_generate_set($name, $spec)
143 => delete $self->{captures}
147 if (my $pred = $spec->{predicate}) {
148 _check_overwrite($into, $pred, 'predicate');
150 quote_sub "${into}::${pred}" =>
151 ' '.$self->_generate_simple_has('$_[0]', $name, $spec)."\n"
154 if (my $pred = $spec->{builder_sub}) {
155 _install_coderef( "${into}::$spec->{builder}" => $spec->{builder_sub} );
157 if (my $cl = $spec->{clearer}) {
158 _check_overwrite($into, $cl, 'clearer');
160 quote_sub "${into}::${cl}" =>
161 $self->_generate_simple_clear('$_[0]', $name, $spec)."\n"
164 if (my $hspec = $spec->{handles}) {
165 my $asserter = $spec->{asserter} ||= '_assert_'.$name;
167 if (ref($hspec) eq 'ARRAY') {
168 map [ $_ => $_ ], @$hspec;
169 } elsif (ref($hspec) eq 'HASH') {
170 map [ $_ => ref($hspec->{$_}) ? @{$hspec->{$_}} : $hspec->{$_} ],
172 } elsif (!ref($hspec)) {
173 map [ $_ => $_ ], use_module('Role::Tiny')->methods_provided_by(use_module($hspec))
175 die "You gave me a handles of ${hspec} and I have no idea why";
178 foreach my $spec (@specs) {
179 my ($proxy, $target, @args) = @$spec;
180 _check_overwrite($into, $proxy, 'delegation');
181 $self->{captures} = {};
183 quote_sub "${into}::${proxy}" =>
184 $self->_generate_delegation($asserter, $target, \@args),
185 delete $self->{captures}
189 if (my $asserter = $spec->{asserter}) {
190 $self->{captures} = {};
193 ." my \$val = ".$self->_generate_get($name, $spec).";\n"
194 ." unless (".$self->_generate_simple_has('$_[0]', $name).") {\n"
195 .qq! die "Attempted to access '${name}' but it is not set";\n!
200 $methods{$asserter} =
201 quote_sub "${into}::${asserter}" => $code,
202 delete $self->{captures}
208 sub is_simple_attribute {
209 my ($self, $name, $spec) = @_;
210 # clearer doesn't have to be listed because it doesn't
211 # affect whether defined/exists makes a difference
213 qw(lazy default builder coerce isa trigger predicate weak_ref);
217 my ($self, $name, $spec) = @_;
218 !($spec->{lazy} and ($spec->{default} or $spec->{builder}));
222 my ($self, $name, $spec) = @_;
223 !grep $spec->{$_}, qw(coerce isa trigger weak_ref);
226 sub has_eager_default {
227 my ($self, $name, $spec) = @_;
228 (!$spec->{lazy} and ($spec->{default} or $spec->{builder}));
232 my ($self, $name, $spec) = @_;
233 my $simple = $self->_generate_simple_get('$_[0]', $name, $spec);
234 if ($self->is_simple_get($name, $spec)) {
237 'do { '.$self->_generate_use_default(
238 '$_[0]', $name, $spec,
239 $self->_generate_simple_has('$_[0]', $name, $spec),
242 ?($self->_generate_isa_check($name, $simple, $spec->{isa}).'; ')
249 sub _generate_simple_has {
250 my ($self, $me, $name) = @_;
251 "exists ${me}->{${\perlstring $name}}";
254 sub _generate_simple_clear {
255 my ($self, $me, $name) = @_;
256 " delete ${me}->{${\perlstring $name}}\n"
259 sub generate_get_default {
261 $self->{captures} = {};
262 my $code = $self->_generate_get_default(@_);
263 ($code, delete $self->{captures});
266 sub _generate_use_default {
267 my ($self, $me, $name, $spec, $test) = @_;
268 my $get_value = $self->_generate_get_default($me, $name, $spec);
269 if ($spec->{coerce}) {
270 $get_value = $self->_generate_coerce(
275 $self->_generate_simple_set(
276 $me, $name, $spec, $get_value
280 sub _generate_get_default {
281 my ($self, $me, $name, $spec) = @_;
282 if (exists $spec->{default}) {
284 ? $self->_generate_call_code($name, 'default', $me, $spec->{default})
285 : perlstring $spec->{default};
288 "${me}->${\$spec->{builder}}"
292 sub generate_simple_get {
293 my ($self, @args) = @_;
294 $self->_generate_simple_get(@args);
297 sub _generate_simple_get {
298 my ($self, $me, $name) = @_;
299 my $name_str = perlstring $name;
300 "${me}->{${name_str}}";
304 my ($self, $name, $spec) = @_;
305 if ($self->is_simple_set($name, $spec)) {
306 $self->_generate_simple_set('$_[0]', $name, $spec, '$_[1]');
308 my ($coerce, $trigger, $isa_check) = @{$spec}{qw(coerce trigger isa)};
309 my $simple = $self->_generate_simple_set('$self', $name, $spec, '$value');
310 my $code = "do { my (\$self, \$value) = \@_;\n";
314 .$self->_generate_coerce($name, '$value', $coerce).";\n";
318 " ".$self->_generate_isa_check($name, '$value', $isa_check).";\n";
321 my $fire = $self->_generate_trigger($name, '$self', '$value', $trigger);
323 " ".$simple.";\n ".$fire.";\n"
326 $code .= " ".$simple.";\n";
333 sub generate_coerce {
335 $self->{captures} = {};
336 my $code = $self->_generate_coerce(@_);
337 ($code, delete $self->{captures});
341 my ($name, $init_arg) = @_;
342 return perlstring($name) if !defined($init_arg) or $init_arg eq $name;
343 return perlstring($name).' (constructor argument: '.perlstring($init_arg).')';
346 sub _generate_coerce {
347 my ($self, $name, $value, $coerce, $init_arg) = @_;
348 $self->_generate_die_prefix(
349 "coercion for ${\_attr_desc($name, $init_arg)} failed: ",
350 $self->_generate_call_code($name, 'coerce', "${value}", $coerce)
354 sub generate_trigger {
356 $self->{captures} = {};
357 my $code = $self->_generate_trigger(@_);
358 ($code, delete $self->{captures});
361 sub _generate_trigger {
362 my ($self, $name, $obj, $value, $trigger) = @_;
363 $self->_generate_call_code($name, 'trigger', "${obj}, ${value}", $trigger);
366 sub generate_isa_check {
367 my ($self, @args) = @_;
368 $self->{captures} = {};
369 my $code = $self->_generate_isa_check(@args);
370 ($code, delete $self->{captures});
373 sub _generate_die_prefix {
374 my ($self, $prefix, $inside) = @_;
376 .' my $sig_die = $SIG{__DIE__} || sub { die $_[0] };'."\n"
377 .' local $SIG{__DIE__} = sub {'."\n"
378 .' $sig_die->(ref($_[0]) ? $_[0] : '.perlstring($prefix).'.$_[0]);'."\n"
384 sub _generate_isa_check {
385 my ($self, $name, $value, $check, $init_arg) = @_;
386 $self->_generate_die_prefix(
387 "isa check for ${\_attr_desc($name, $init_arg)} failed: ",
388 $self->_generate_call_code($name, 'isa_check', $value, $check)
392 sub _generate_call_code {
393 my ($self, $name, $type, $values, $sub) = @_;
394 if (my $quoted = quoted_from_sub($sub)) {
395 my $code = $quoted->[1];
396 if (my $captures = $quoted->[2]) {
397 my $cap_name = qq{\$${type}_captures_for_${name}};
398 $self->{captures}->{$cap_name} = \$captures;
399 Sub::Quote::inlinify(
400 $code, $values, Sub::Quote::capture_unroll($cap_name, $captures, 6), 1
403 Sub::Quote::inlinify($code, $values, undef, 1);
406 my $cap_name = qq{\$${type}_for_${name}};
407 $self->{captures}->{$cap_name} = \$sub;
408 "${cap_name}->(${values})";
412 sub generate_populate_set {
414 $self->{captures} = {};
415 my $code = $self->_generate_populate_set(@_);
416 ($code, delete $self->{captures});
419 sub _generate_populate_set {
420 my ($self, $me, $name, $spec, $source, $test, $init_arg) = @_;
421 if ($self->has_eager_default($name, $spec)) {
422 my $get_indent = ' ' x ($spec->{isa} ? 6 : 4);
423 my $get_default = $self->_generate_get_default(
427 defined($spec->{init_arg})
428 ? "(\n${get_indent} ${test}\n${get_indent} ? ${source}\n${get_indent} : "
432 if ($spec->{coerce}) {
433 $get_value = $self->_generate_coerce(
435 $spec->{coerce}, $init_arg
439 ? " {\n my \$value = ".$get_value.";\n "
440 .$self->_generate_isa_check(
441 $name, '$value', $spec->{isa}, $init_arg
443 .' '.$self->_generate_simple_set($me, $name, $spec, '$value').";\n"
445 : ' '.$self->_generate_simple_set($me, $name, $spec, $get_value).";\n"
449 .$self->_generate_trigger(
450 $name, $me, $self->_generate_simple_get($me, $name, $spec),
459 .$self->_generate_coerce(
461 $spec->{coerce}, $init_arg
467 .$self->_generate_isa_check(
468 $name, $source, $spec->{isa}, $init_arg
472 ." ".$self->_generate_simple_set($me, $name, $spec, $source).";\n"
475 .$self->_generate_trigger(
476 $name, $me, $self->_generate_simple_get($me, $name, $spec),
485 sub _generate_core_set {
486 my ($self, $me, $name, $spec, $value) = @_;
487 my $name_str = perlstring $name;
488 "${me}->{${name_str}} = ${value}";
491 sub _generate_simple_set {
492 my ($self, $me, $name, $spec, $value) = @_;
493 my $name_str = perlstring $name;
495 if ($spec->{weak_ref}) {
496 $value = '$preserve = '.$value;
497 my $simple = $self->_generate_core_set($me, $name, $spec, $value);
498 require Scalar::Util;
500 # Perl < 5.8.3 can't weaken refs to readonly vars
501 # (e.g. string constants). This *can* be solved by:
503 #Internals::SetReadWrite($foo);
504 #Scalar::Util::weaken ($foo);
505 #Internals::SetReadOnly($foo);
507 # but requires XS and is just too damn crazy
508 # so simply throw a better exception
509 my $weak_simple = "my \$preserve; Scalar::Util::weaken(${simple}); no warnings 'void'; \$preserve";
510 Moo::_Utils::lt_5_8_3() ? <<"EOC" : $weak_simple;
513 eval { Scalar::Util::weaken($simple); 1 }
514 ? do { no warnings 'void'; \$preserve; }
516 if( \$@ =~ /Modification of a read-only value attempted/) {
518 Carp::croak( sprintf (
519 'Reference to readonly value in "%s" can not be weakened on Perl < 5.8.3',
528 $self->_generate_core_set($me, $name, $spec, $value);
532 sub _generate_getset {
533 my ($self, $name, $spec) = @_;
534 q{(@_ > 1}."\n ? ".$self->_generate_set($name, $spec)
535 ."\n : ".$self->_generate_get($name, $spec)."\n )";
538 sub _generate_delegation {
539 my ($self, $asserter, $target, $args) = @_;
540 my $arg_string = do {
542 # I could, I reckon, linearise out non-refs here using perlstring
543 # plus something to check for numbers but I'm unsure if it's worth it
544 $self->{captures}{'@curries'} = $args;
550 "shift->${asserter}->${target}(${arg_string});";
554 my ($self, $type, $into, $name, $slot) = @_;
555 Class::XSAccessor->import(
557 $type => { $name => $slot },
563 sub default_construction_string { '{}' }