use strict;
use warnings;
use Carp ();
-use Class::Inspector ();
use Scalar::Util ();
use MRO::Compat;
use Sub::Name ();
-our $VERSION = '0.09003';
+our $VERSION = '0.09007';
$VERSION = eval $VERSION;
-our $hasXS;
+# when changing minimum version don't forget to adjust L</PERFROMANCE> as well
+our $__minimum_xsa_version = '1.06';
-sub _hasXS {
- if (not defined $hasXS) {
- $hasXS = 0;
+our $USE_XS;
+# the unless defined is here so that we can override the value
+# before require/use, *regardless* of the state of $ENV{CAG_USE_XS}
+$USE_XS = $ENV{CAG_USE_XS}
+ unless defined $USE_XS;
- eval {
- require Class::XSAccessor;
- $hasXS = 1;
+my ($xsa_loaded, $xsa_autodetected);
+
+my $load_xsa = sub {
+ return if $xsa_loaded++;
+ require Class::XSAccessor;
+ Class::XSAccessor->VERSION($__minimum_xsa_version);
+};
+
+my $use_xs = sub {
+ if (defined $USE_XS) {
+ $load_xsa->() if ($USE_XS && ! $xsa_loaded);
+ return $USE_XS;
+ }
+
+ $xsa_autodetected = 1;
+ $USE_XS = 0;
+
+ # 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
+ if ($^O ne 'MSWin32') {
+ local $@;
+ eval { $load_xsa->(); $USE_XS = 1 };
+ }
+
+ return $USE_XS;
+};
+
+my $maker_type_map = {
+ rw => {
+ xsa => 'accessors',
+ cag => 'make_group_accessor',
+ },
+ ro => {
+ xsa => 'getters',
+ cag => 'make_group_ro_accessor',
+ },
+ wo => {
+ xsa => 'setters',
+ cag => 'make_group_wo_accessor',
+ },
+};
+
+# When installing an XSA simple accessor, we need to make sure we are not
+# 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
+
+my $no_xsa_classes_warned;
+my $add_xs_accessor = sub {
+ my ($class, $group, $field, $name, $type) = @_;
+
+ Class::XSAccessor->import({
+ replace => 1,
+ class => $class,
+ $maker_type_map->{$type}{xsa} => {
+ $name => $field,
+ },
+ });
+
+ my $xs_cref = $class->can($name);
+
+ my $pp_cref = do {
+ my $cag_method = $maker_type_map->{$type}{cag};
+ local $USE_XS = 0;
+ $class->$cag_method ($group, $field, $name, $type);
};
- }
- return $hasXS;
-}
+ # can't use pkg_gen to track this stuff, as it doesn't
+ # detect superclass mucking
+ my $original_getter = __PACKAGE__->can ("get_$group");
+ my $original_setter = __PACKAGE__->can ("set_$group");
+
+ return sub {
+ my $self = $_[0];
+ my $current_class = Scalar::Util::blessed( $self ) || $self;
+
+ my $final_cref;
+ if (
+ $current_class->can("get_$group") == $original_getter
+ &&
+ $current_class->can("set_$group") == $original_setter
+ ) {
+ # nothing has changed, might as well use the XS crefs
+ #
+ # note that by the time this code executes, we already have
+ # *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! :)
+ $final_cref = $xs_cref;
+ }
+ else {
+ $final_cref = $pp_cref;
+ if ($USE_XS and ! $xsa_autodetected and ! $no_xsa_classes_warned->{$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_$group and/or set_$group\n";
+ }
+ }
+
+ # installing an XSA cref that was originally created on a class
+ # different than $current_class is perfectly safe as per
+ # C::XSA's author
+ my $fq_meth = "${current_class}::${name}";
+
+ no strict qw/refs/;
+ no warnings qw/redefine/;
+
+ *$fq_meth = Sub::Name::subname($fq_meth, $final_cref);
+
+ # older perls segfault if the cref behind the goto throws
+ # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
+ return $final_cref->(@_) if ($] < 5.008009);
+
+ goto $final_cref;
+ };
+};
+
+my $install_group_accessors = sub {
+ my($self, $maker, $group, @fields) = @_;
+ my $class = Scalar::Util::blessed $self || $self;
+
+ no strict 'refs';
+ no warnings 'redefine';
+
+ # So we don't have to do lots of lookups inside the loop.
+ $maker = $self->can($maker) unless ref $maker eq 'CODE';
+
+ foreach (@fields) {
+ if( $_ eq 'DESTROY' ) {
+ Carp::carp("Having a data accessor named DESTROY in ".
+ "'$class' is unwise.");
+ }
+
+ my ($name, $field) = (ref $_)
+ ? (@$_)
+ : ($_, $_)
+ ;
+
+ my $alias = "_${name}_accessor";
+
+ for my $meth ($name, $alias) {
+
+ # the maker may elect to not return anything, meaning it already
+ # installed the coderef for us
+ my $cref = $self->$maker($group, $field, $meth)
+ or next;
+
+ my $fq_meth = join('::', $class, $meth);
+
+ *$fq_meth = Sub::Name::subname($fq_meth, $cref);
+ #unless defined &{$class."\:\:$field"}
+ }
+ }
+};
+
=head1 NAME
sub mk_group_accessors {
my ($self, $group, @fields) = @_;
- $self->_mk_group_accessors('make_group_accessor', $group, @fields);
+ $self->$install_group_accessors('make_group_accessor', $group, @fields);
return;
}
-
-{
- no strict 'refs';
- no warnings 'redefine';
-
- sub _mk_group_accessors {
- my($self, $maker, $group, @fields) = @_;
- my $class = Scalar::Util::blessed $self || $self;
-
- # So we don't have to do lots of lookups inside the loop.
- $maker = $self->can($maker) unless ref $maker;
-
- my $hasXS = _hasXS();
-
- foreach my $field (@fields) {
- if( $field eq 'DESTROY' ) {
- Carp::carp("Having a data accessor named DESTROY in ".
- "'$class' is unwise.");
- }
-
- my $name = $field;
-
- ($name, $field) = @$field if ref $field;
-
- my $alias = "_${name}_accessor";
- my $full_name = join('::', $class, $name);
- my $full_alias = join('::', $class, $alias);
- if ( $hasXS && $group eq 'simple' ) {
- require Class::XSAccessor;
- Class::XSAccessor->import({
- replace => 1,
- class => $class,
- accessors => {
- $name => $field,
- $alias => $field,
- },
- });
- }
- else {
- my $accessor = $self->$maker($group, $field);
- my $alias_accessor = $self->$maker($group, $field);
-
- *$full_name = Sub::Name::subname($full_name, $accessor);
- #unless defined &{$class."\:\:$field"}
-
- *$full_alias = Sub::Name::subname($full_alias, $alias_accessor);
- #unless defined &{$class."\:\:$alias"}
- }
- }
- }
-}
-
=head2 mk_group_ro_accessors
=over 4
sub mk_group_ro_accessors {
my($self, $group, @fields) = @_;
- $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields);
+ $self->$install_group_accessors('make_group_ro_accessor', $group, @fields);
}
=head2 mk_group_wo_accessors
sub mk_group_wo_accessors {
my($self, $group, @fields) = @_;
- $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields);
+ $self->$install_group_accessors('make_group_wo_accessor', $group, @fields);
}
=head2 make_group_accessor
=over 4
-=item Arguments: $group, $field
+=item Arguments: $group, $field, $method
-Returns: $sub (\CODE)
+Returns: \&accessor_coderef ?
=back
-Returns a single accessor in a given group; called by mk_group_accessors
-for each entry in @fieldspec.
+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 {
- my ($class, $group, $field) = @_;
+ my ($class, $group, $field, $name) = @_;
+
+ if ( $group eq 'simple' && $use_xs->() ) {
+ return $add_xs_accessor->(@_, 'rw');
+ }
my $set = "set_$group";
my $get = "get_$group";
+ $field =~ s/'/\\'/g;
+
# eval for faster fastiness
my $code = eval "sub {
if(\@_ > 1) {
=over 4
-=item Arguments: $group, $field
+=item Arguments: $group, $field, $method
-Returns: $sub (\CODE)
+Returns: \&accessor_coderef ?
=back
-Returns a single read-only accessor in a given group; called by
-mk_group_ro_accessors for each entry in @fieldspec.
+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 {
- my($class, $group, $field) = @_;
+ my($class, $group, $field, $name) = @_;
+
+ if ( $group eq 'simple' && $use_xs->() ) {
+ return $add_xs_accessor->(@_, 'ro');
+ }
my $get = "get_$group";
+ $field =~ s/'/\\'/g;
+
my $code = eval "sub {
if(\@_ > 1) {
my \$caller = caller;
=over 4
-=item Arguments: $group, $field
+=item Arguments: $group, $field, $method
-Returns: $sub (\CODE)
+Returns: \&accessor_coderef ?
=back
-Returns a single write-only accessor in a given group; called by
-mk_group_wo_accessors for each entry in @fieldspec.
+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 {
- my($class, $group, $field) = @_;
+ my($class, $group, $field, $name) = @_;
+
+ if ( $group eq 'simple' && $use_xs->() ) {
+ return $add_xs_accessor->(@_, 'wo')
+ }
my $set = "set_$group";
+ $field =~ s/'/\\'/g;
+
my $code = eval "sub {
unless (\@_ > 1) {
my \$caller = caller;
sub get_inherited {
my $class;
- if ( ($class = ref $_[0]) && Scalar::Util::blessed $_[0]) {
+ if ( defined( $class = Scalar::Util::blessed $_[0] ) ) {
if (Scalar::Util::reftype $_[0] eq 'HASH') {
return $_[0]->{$_[1]} if exists $_[0]->{$_[1]};
}
}
no strict 'refs';
- no warnings qw/uninitialized/;
+ no warnings 'uninitialized';
my $cag_slot = '::__cag_'. $_[1];
return ${$class.$cag_slot} if defined(${$class.$cag_slot});
=cut
sub set_inherited {
- if (Scalar::Util::blessed $_[0]) {
+ if (defined Scalar::Util::blessed $_[0]) {
if (Scalar::Util::reftype $_[0] eq 'HASH') {
return $_[0]->{$_[1]} = $_[2];
} else {
sub set_component_class {
if ($_[2]) {
local $^W = 0;
+ require Class::Inspector;
if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) {
eval "use $_[2]";
=head1 PERFORMANCE
-You can speed up accessors of type 'simple' by installing L<Class::XSAccessor>.
+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.
+
+=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% --
+
+Benchmark program is available in the root of the
+L<repository|http://search.cpan.org/dist/Class-Accessor-Grouped/>:
+
+=head2 Notes on Class::XSAccessor
+
+You can force (or disable) the use of L<Class::XSAccessor> before creating a
+particular C<simple> accessor by either manipulating the global variable
+C<$Class::Accessor::Grouped::USE_XS> to true or false (preferably with
+L<localization|perlfunc/local>, or you can do so before runtime via the
+C<CAG_USE_XS> environment variable.
+
+Since L<Class::XSAccessor> has no knowledge of L</get_simple> and
+L</set_simple> this module does its best to detect if you are overriding
+one of these methods and will fall back to using the perl version of the
+accessor in order to maintain consistency. However be aware that if you
+enable use of C<Class::XSAccessor> (automatically or explicitly), create
+an object, invoke a simple accessor on that object, and B<then> manipulate
+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>
+
Christopher H. Laco <claco@chrislaco.com>
=head1 CONTRIBUTORS
+Caelum: Rafael Kitover <rkitover@cpan.org>
+
groditi: Guillermo Roditi <groditi@cpan.org>
+
+Jason Plum <jason.plum@bmmsi.com>
+
ribasushi: Peter Rabbitson <ribasushi@cpan.org>
+
=head1 COPYRIGHT & LICENSE
Copyright (c) 2006-2010 Matt S. Trout <mst@shadowcatsystems.co.uk>
projects / p5sagit/Class-Accessor-Grouped.git / blobdiff