use warnings;
use Carp ();
use Scalar::Util ();
-use MRO::Compat;
-our $VERSION = '0.09008';
-$VERSION = eval $VERSION;
+BEGIN {
+ if ($] < 5.009_005) {
+ require MRO::Compat;
+ }
+ else {
+ require mro;
+ }
+}
+
+our $VERSION = '0.10003';
+$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
# when changing minimum version don't forget to adjust L</PERFORMANCE> and
# the Makefile.PL as well
our $__minimum_xsa_version;
BEGIN {
- $__minimum_xsa_version = '1.06';
+ $__minimum_xsa_version = '1.11';
}
our $USE_XS;
=head1 SYNOPSIS
+ use base 'Class::Accessor::Grouped';
+
+ # make basic accessors for objects
+ __PACKAGE__->mk_group_accessors(simple => qw(id name email));
+
+ # make accessor that works for objects and classes
+ __PACKAGE__->mk_group_accessors(inherited => 'awesome_level');
+
=head1 DESCRIPTION
This class lets you build groups of accessors that will call different
=head2 mk_group_accessors
+ __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]);
+
=over 4
=item Arguments: $group, @fieldspec
=head2 mk_group_ro_accessors
+ __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]);
+
=over 4
=item Arguments: $group, @fieldspec
=head2 mk_group_wo_accessors
+ __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]);
+
=over 4
=item Arguments: $group, @fieldspec
$self->_mk_group_accessors('make_group_wo_accessor', $group, @fields);
}
-=head2 make_group_accessor
-
-=over 4
-
-=item Arguments: $group, $field, $method
-
-Returns: \&accessor_coderef ?
-
-=back
-
-Called by mk_group_accessors for each entry in @fieldspec. Either returns
-a coderef which will be installed at C<&__PACKAGE__::$method>, or returns
-C<undef> if it elects to install the coderef on its own.
-
-=cut
-
-sub make_group_accessor { $gen_accessor->('rw', @_) }
-
-=head2 make_group_ro_accessor
-
-=over 4
-
-=item Arguments: $group, $field, $method
-
-Returns: \&accessor_coderef ?
-
-=back
-
-Called by mk_group_ro_accessors for each entry in @fieldspec. Either returns
-a coderef which will be installed at C<&__PACKAGE__::$method>, or returns
-C<undef> if it elects to install the coderef on its own.
-
-=cut
-
-sub make_group_ro_accessor { $gen_accessor->('ro', @_) }
-
-=head2 make_group_wo_accessor
-
-=over 4
-
-=item Arguments: $group, $field, $method
-
-Returns: \&accessor_coderef ?
-
-=back
-
-Called by mk_group_wo_accessors for each entry in @fieldspec. Either returns
-a coderef which will be installed at C<&__PACKAGE__::$method>, or returns
-C<undef> if it elects to install the coderef on its own.
-
-=cut
-
-sub make_group_wo_accessor { $gen_accessor->('wo', @_) }
-
=head2 get_simple
=over 4
return $_[0]->set_inherited($_[1], $_[2]);
};
+=head1 INTERNAL METHODS
+
+These methods are documented for clarity, but are never meant to be called
+directly, and are not really meant for overriding either.
+
=head2 get_super_paths
-Returns a list of 'parent' or 'super' class names that the current class inherited from.
+Returns a list of 'parent' or 'super' class names that the current class
+inherited from. This is what drives the traversal done by L</get_inherited>.
=cut
return @{mro::get_linear_isa( ref($_[0]) || $_[0] )};
};
+=head2 make_group_accessor
+
+ __PACKAGE__->make_group_accessor('simple', 'hair_length', 'hair_length');
+ __PACKAGE__->make_group_accessor('simple', 'hc', 'hair_color');
+
+=over 4
+
+=item Arguments: $group, $field, $accessor
+
+Returns: \&accessor_coderef ?
+
+=back
+
+Called by mk_group_accessors for each entry in @fieldspec. Either returns
+a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
+C<undef> if it elects to install the coderef on its own.
+
+=cut
+
+sub make_group_accessor { $gen_accessor->('rw', @_) }
+
+=head2 make_group_ro_accessor
+
+ __PACKAGE__->make_group_ro_accessor('simple', 'birthdate', 'birthdate');
+ __PACKAGE__->make_group_ro_accessor('simple', 'ssn', 'social_security_number');
+
+=over 4
+
+=item Arguments: $group, $field, $accessor
+
+Returns: \&accessor_coderef ?
+
+=back
+
+Called by mk_group_ro_accessors for each entry in @fieldspec. Either returns
+a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
+C<undef> if it elects to install the coderef on its own.
+
+=cut
+
+sub make_group_ro_accessor { $gen_accessor->('ro', @_) }
+
+=head2 make_group_wo_accessor
+
+ __PACKAGE__->make_group_wo_accessor('simple', 'lie', 'lie');
+ __PACKAGE__->make_group_wo_accessor('simple', 'subj', 'subject');
+
+=over 4
+
+=item Arguments: $group, $field, $accessor
+
+Returns: \&accessor_coderef ?
+
+=back
+
+Called by mk_group_wo_accessors for each entry in @fieldspec. Either returns
+a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
+C<undef> if it elects to install the coderef on its own.
+
+=cut
+
+sub make_group_wo_accessor { $gen_accessor->('wo', @_) }
+
+
=head1 PERFORMANCE
To provide total flexibility L<Class::Accessor::Grouped> calls methods
internally while performing get/set actions, which makes it noticeably
slower than similar modules. To compensate, this module will automatically
use the insanely fast L<Class::XSAccessor> to generate the C<simple>-group
-accessors, if L<< Class::XSAccessor >= 1.06|Class::XSAccessor >> is
-available on your system.
+accessors if this module is available on your system.
=head2 Benchmark
This is the result of a set/get/set loop benchmark on perl 5.12.1 with
thread support, showcasing most popular accessor builders: L<Moose>, L<Mouse>,
-L<CAF|Class::Accessor::Fast>, L<CAF_XS|Class::Accessor::Fast::XS>
-and L<XSA|Class::XSAccessor>:
-
- Rate CAG moOse CAF HANDMADE CAF_XS moUse_XS CAG_XS XSA
- CAG 1777/s -- -27% -29% -36% -62% -67% -72% -73%
- moOse 2421/s 36% -- -4% -13% -48% -55% -61% -63%
- CAF 2511/s 41% 4% -- -10% -47% -53% -60% -61%
- HANDMADE 2791/s 57% 15% 11% -- -41% -48% -56% -57%
- CAF_XS 4699/s 164% 94% 87% 68% -- -13% -25% -28%
- moUse_XS 5375/s 203% 122% 114% 93% 14% -- -14% -18%
- CAG_XS 6279/s 253% 159% 150% 125% 34% 17% -- -4%
- XSA 6515/s 267% 169% 159% 133% 39% 21% 4% --
+L<Moo>, L<CAF|Class::Accessor::Fast>, L<CAF_XS|Class::Accessor::Fast::XS>,
+L<XSA|Class::XSAccessor>, and L<CAF_XSA|Class::XSAccessor::Compat>:
+
+ Rate CAG moOse CAF moUse moo HANDMADE CAF_XS moUse_XS moo_XS CAF_XSA XSA CAG_XS
+ CAG 169/s -- -21% -24% -32% -32% -34% -59% -63% -67% -67% -67% -67%
+ moOse 215/s 27% -- -3% -13% -13% -15% -48% -53% -58% -58% -58% -58%
+ CAF 222/s 31% 3% -- -10% -10% -13% -46% -52% -57% -57% -57% -57%
+ moUse 248/s 46% 15% 11% -- -0% -3% -40% -46% -52% -52% -52% -52%
+ moo 248/s 46% 15% 11% 0% -- -3% -40% -46% -52% -52% -52% -52%
+ HANDMADE 255/s 50% 18% 14% 3% 3% -- -38% -45% -50% -51% -51% -51%
+ CAF_XS 411/s 143% 91% 85% 66% 66% 61% -- -11% -20% -20% -21% -21%
+ moUse_XS 461/s 172% 114% 107% 86% 86% 81% 12% -- -10% -11% -11% -11%
+ moo_XS 514/s 204% 139% 131% 107% 107% 102% 25% 12% -- -0% -1% -1%
+ CAF_XSA 516/s 205% 140% 132% 108% 108% 103% 26% 12% 0% -- -0% -0%
+ XSA 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% -- -0%
+ CAG_XS 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% 0% --
Benchmark program is available in the root of the
L<repository|http://search.cpan.org/dist/Class-Accessor-Grouped/>:
the symbol table to install a C<get/set_simple> override - you get to keep
all the pieces.
-While L<Class::XSAccessor> works surprisingly well for the amount of black
-magic it tries to pull off, it's still black magic. At present (Sep 2010)
-the module is known to have problems on Windows under heavy thread-stress
-(e.g. Win32+Apache+mod_perl). Thus for the time being L<Class::XSAccessor>
-will not be used automatically if you are running under C<MSWin32>.
-
=head1 AUTHORS
Matt S. Trout <mst@shadowcatsystems.co.uk>
Caelum: Rafael Kitover <rkitover@cpan.org>
+frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+
groditi: Guillermo Roditi <groditi@cpan.org>
Jason Plum <jason.plum@bmmsi.com>
local $@;
my $err;
+
$err = eval { require Sub::Name; 1; } ? undef : do {
delete $INC{'Sub/Name.pm'}; # because older perls suck
$@;
};
- *__CAG_NO_SUBNAME = $err
+ *__CAG_ENV__::NO_SUBNAME = $err
? sub () { $err }
: sub () { 0 }
;
delete $INC{'Class/XSAccessor.pm'};
$@;
};
- *__CAG_NO_CXSA = $err
+ *__CAG_ENV__::NO_CXSA = $err
? sub () { $err }
: sub () { 0 }
;
- *__CAG_BROKEN_GOTO = ($] < '5.008009')
+ *__CAG_ENV__::BROKEN_GOTO = ($] < '5.008009')
? sub () { 1 }
: sub () { 0 }
;
-};
+
+ *__CAG_ENV__::UNSTABLE_DOLLARAT = ($] < '5.013002')
+ ? sub () { 1 }
+ : sub () { 0 }
+ ;
+
+
+ *__CAG_ENV__::TRACK_UNDEFER_FAIL = (
+ $INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'}
+ and
+ $0 =~ m|^ x?t / .+ \.t $|x
+ ) ? sub () { 1 }
+ : sub () { 0 }
+ ;
+}
# Autodetect unless flag supplied
-# Class::XSAccessor is segfaulting on win32, in some
-# esoteric heavily-threaded scenarios
-# Win32 users can set $USE_XS/CAG_USE_XS to try to use it anyway
my $xsa_autodetected;
if (! defined $USE_XS) {
- $USE_XS = (!__CAG_NO_CXSA and $^O ne 'MSWin32') ? 1 : 0;
+ $USE_XS = __CAG_ENV__::NO_CXSA ? 0 : 1;
$xsa_autodetected++;
}
$field =~ s/'/\\'/g;
"
- \@_ > 1
+ \@_ != 1
? shift->$set('$field', \@_)
: shift->$get('$field')
"
$field =~ s/'/\\'/g;
"
- \@_ > 1
+ \@_ != 1
? shift->$set('$field', \@_)
: do {
my \$caller = caller;
# Note!!! Unusual signature
$gen_accessor = sub {
my ($type, $class, $group, $field, $methname) = @_;
- if (my $c = ref $class) {
+ if (my $c = Scalar::Util::blessed( $class )) {
$class = $c;
}
# short-circuiting a (compile or runtime) get_simple/set_simple override.
# What we do here is install a lazy first-access check, which will decide
# the ultimate coderef being placed in the accessor slot
+ #
+ # Also note that the *original* class will always retain this shim, as
+ # different branches inheriting from it may have different overrides.
+ # Thus the final method (properly labeled and all) is installed in the
+ # calling-package's namespace
if ($USE_XS and $group eq 'simple') {
- my $fq_name = "${class}::${methname}";
- ($accessor_maker_cache->{xs}{$field}{$type}{$fq_name} ||= do {
- die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_NO_CXSA )
- if __CAG_NO_CXSA;
+ die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_ENV__::NO_CXSA )
+ if __CAG_ENV__::NO_CXSA;
- sub { sub {
- my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0];
+ my ($expected_cref, $cached_implementation);
+ my $ret = $expected_cref = sub {
+ my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0];
+ # $cached_implementation will be set only if the shim got
+ # 'around'ed, in which case it is handy to avoid re-running
+ # this block over and over again
+ my $resolved_implementation = $cached_implementation->{$current_class} || do {
if (
$current_class->can('get_simple') == $original_simple_getter
&&
# *objects* (since XSA works on 'simple' only by definition).
# If someone is mucking with the symbol table *after* there
# are some objects already - look! many, shiny pieces! :)
+ #
+ # The weird breeder thingy is because XSA does not have an
+ # interface returning *just* a coderef, without installing it
+ # anywhere :(
Class::XSAccessor->import(
replace => 1,
- class => $class,
+ class => '__CAG__XSA__BREEDER__',
$maker_templates->{$type}{xs_call} => {
$methname => $field,
},
);
+ __CAG__XSA__BREEDER__->can($methname);
}
else {
if (! $xsa_autodetected and ! $no_xsa_warned_classes->{$current_class}++) {
# not using Carp since the line where this happens doesn't mean much
warn 'Explicitly requested use of Class::XSAccessor disabled for objects of class '
- . "'$current_class' due to an overriden get_simple and/or set_simple\n";
+ . "'$current_class' inheriting from '$class' due to an overriden get_simple and/or "
+ . "set_simple\n";
}
- no strict qw/refs/;
-
- *$fq_name = Sub::Name::subname($fq_name, do {
+ do {
# that's faster than local
$USE_XS = 0;
my $c = $gen_accessor->($type, $class, 'simple', $field, $methname);
$USE_XS = 1;
$c;
- });
+ };
}
+ };
+
+ # if after this shim was created someone wrapped it with an 'around',
+ # we can not blindly reinstall the method slot - we will destroy the
+ # wrapper. Silently chain execution further...
+ if ( !$expected_cref or $expected_cref != $current_class->can($methname) ) {
+
+ # there is no point in re-determining it on every subsequent call,
+ # just store for future reference
+ $cached_implementation->{$current_class} ||= $resolved_implementation;
# older perls segfault if the cref behind the goto throws
# http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
- return $current_class->can($methname)->(@_) if __CAG_BROKEN_GOTO;
+ return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
- goto $current_class->can($methname);
- }}
- })->();
+ goto $resolved_implementation;
+ }
+
+ if (__CAG_ENV__::TRACK_UNDEFER_FAIL) {
+ my $deferred_calls_seen = do {
+ no strict 'refs';
+ \%{"${current_class}::__cag_deferred_xs_shim_invocations"}
+ };
+ my @cframe = caller(0);
+ if (my $already_seen = $deferred_calls_seen->{$cframe[3]}) {
+ Carp::carp (
+ "Deferred version of method $cframe[3] invoked more than once (originally "
+ . "invoked at $already_seen). This is a strong indication your code has "
+ . 'cached the original ->can derived method coderef, and is using it instead '
+ . 'of the proper method re-lookup, causing performance regressions'
+ );
+ }
+ else {
+ $deferred_calls_seen->{$cframe[3]} = "$cframe[1] line $cframe[2]";
+ }
+ }
+
+ # install the resolved implementation into the code slot so we do not
+ # come here anymore (hopefully)
+ # since XSAccessor was available - so is Sub::Name
+ {
+ no strict 'refs';
+ no warnings 'redefine';
+
+ my $fq_name = "${current_class}::${methname}";
+ *$fq_name = Sub::Name::subname($fq_name, $resolved_implementation);
+
+ # need to update what the shim expects too *in case* its
+ # ->can was cached for some moronic reason
+ $expected_cref = $resolved_implementation;
+ Scalar::Util::weaken($expected_cref);
+ }
+
+ # older perls segfault if the cref behind the goto throws
+ # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
+ return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
+
+ goto $resolved_implementation;
+ };
+
+ Scalar::Util::weaken($expected_cref); # to break the self-reference
+ $ret;
}
# no Sub::Name - just install the coderefs directly (compiling every time)
- elsif (__CAG_NO_SUBNAME) {
- my $pp_code = $maker_templates->{$type}{pp_code}->($group, $field);
- eval "sub ${class}::${methname} { $pp_code }; 1" or die $@;
- undef; # so that no attempt will be made to install anything
+ elsif (__CAG_ENV__::NO_SUBNAME) {
+ my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
+ $maker_templates->{$type}{pp_code}->($group, $field);
+
+ no warnings 'redefine';
+ local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
+ eval "sub ${class}::${methname} { $src }";
+
+ undef; # so that no further attempt will be made to install anything
}
# a coderef generator with a variable pad (returns a fresh cref on every invocation)
else {
- ($accessor_maker_cache->{pp}{$group}{$field}{$type} ||= do {
- my $pp_code = $maker_templates->{$type}{pp_code}->($group, $field);
- eval "sub { my \$dummy; sub { \$dummy if 0; $pp_code } }" or die $@;
+ ($accessor_maker_cache->{pp}{$type}{$group}{$field} ||= do {
+ my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
+ $maker_templates->{$type}{pp_code}->($group, $field);
+
+ local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
+ eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@;
})->()
}
};