X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FAccessor%2FGrouped.pm;h=f2c0ea8e7a1bbed6d7333b8b995e861658a6faaa;hb=2f4e57f4a8cd4f5bc4c4e16bb6c81b711722e697;hp=69be59ab962e8537cc33b29aae6aacdbded3e13b;hpb=bd9750940ac55f86ffa87313bda265f51990fa4d;p=p5sagit%2FClass-Accessor-Grouped.git diff --git a/lib/Class/Accessor/Grouped.pm b/lib/Class/Accessor/Grouped.pm index 69be59a..f2c0ea8 100644 --- a/lib/Class/Accessor/Grouped.pm +++ b/lib/Class/Accessor/Grouped.pm @@ -3,67 +3,164 @@ use strict; use warnings; use Carp (); use Scalar::Util (); -use MRO::Compat; +use Module::Runtime (); -our $VERSION = '0.09009'; -$VERSION = eval $VERSION; - -# when changing minimum version don't forget to adjust L and -# the Makefile.PL as well -our $__minimum_xsa_version; BEGIN { - $__minimum_xsa_version = '1.06'; + # use M::R to work around the 5.8 require bugs + if ($] < 5.009_005) { + Module::Runtime::require_module('MRO::Compat'); + } + else { + require mro; + } } +our $VERSION = '0.10010'; +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases + +# when changing minimum version don't forget to adjust Makefile.PL as well +our $__minimum_xsa_version; +BEGIN { $__minimum_xsa_version = '1.15' } + 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; + unless defined $USE_XS; + +BEGIN { + package # hide from PAUSE + __CAG_ENV__; + + die "Huh?! No minimum C::XSA version?!\n" + unless $__minimum_xsa_version; + + local $@; + require constant; + + # individual (one const at a time) imports so we are 5.6.2 compatible + # if we can - why not ;) + constant->import( NO_SUBNAME => eval { + Module::Runtime::require_module('Sub::Name') + } ? 0 : "$@" ); + + my $found_cxsa; + constant->import( NO_CXSA => ( NO_SUBNAME() || ( eval { + Module::Runtime::require_module('Class::XSAccessor'); + $found_cxsa = Class::XSAccessor->VERSION; + Class::XSAccessor->VERSION($__minimum_xsa_version); + } ? 0 : "$@" ) ) ); + + if (NO_CXSA() and $found_cxsa and !$ENV{CAG_OLD_XS_NOWARN}) { + warn( + 'The installed version of Class::XSAccessor is too old ' + . "(v$found_cxsa < v$__minimum_xsa_version). Please upgrade " + . "to instantly quadruple the performance of 'simple' accessors. " + . 'Set $ENV{CAG_OLD_XS_NOWARN} if you wish to disable this ' + . "warning.\n" + ); + } + + constant->import( BROKEN_GOTO => ($] < '5.008009') ? 1 : 0 ); + + constant->import( UNSTABLE_DOLLARAT => ($] < '5.013002') ? 1 : 0 ); + + constant->import( TRACK_UNDEFER_FAIL => ( + $INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'} + and + $0 =~ m{ ^ (?: \. \/ )? x?t / .+ \.t $}x + ) ? 1 : 0 ); + + require B; + # a perl 5.6 kludge + unless (B->can('perlstring')) { + require Data::Dumper; + my $d = Data::Dumper->new([])->Indent(0)->Purity(0)->Pad('')->Useqq(1)->Terse(1)->Freezer('')->Toaster(''); + *B::perlstring = sub { $d->Values([shift])->Dump }; + } +} # Yes this method is undocumented # Yes it should be a private coderef like all the rest at the end of this file # No we can't do that (yet) because the DBIC-CDBI compat layer overrides it # %$*@!?&!&#*$!!! + +my $illegal_accessors_warned; sub _mk_group_accessors { - my($self, $maker, $group, @fields) = @_; - my $class = Scalar::Util::blessed $self || $self; + my($self, $maker, $group, @fields) = @_; + my $class = length (ref ($self) ) ? ref ($self) : $self; - no strict 'refs'; - no warnings 'redefine'; + 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; + # So we don't have to do lots of lookups inside the loop. + $maker = $self->can($maker) unless ref $maker; - foreach (@fields) { - if( $_ eq 'DESTROY' ) { - Carp::carp("Having a data accessor named DESTROY in ". - "'$class' is unwise."); - } + for (@fields) { - my ($name, $field) = (ref $_) - ? (@$_) - : ($_, $_) - ; + my ($name, $field) = (ref $_) ? (@$_) : ($_, $_); - my $alias = "_${name}_accessor"; + if ($name !~ /\A[A-Z_a-z][0-9A-Z_a-z]*\z/) { - for my $meth ($name, $alias) { + if ($name =~ /\0/) { + Carp::croak(sprintf + "Illegal accessor name %s - nulls should never appear in stash keys", + B::perlstring($name), + ); + } + elsif (! $ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK} ) { + Carp::croak( + "Illegal accessor name '$name'. If you want CAG to attempt creating " + . 'it anyway (possible if Sub::Name is available) set ' + . '$ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK}' + ); + } + elsif (__CAG_ENV__::NO_SUBNAME) { + Carp::croak( + "Unable to install accessor with illegal name '$name': " + . 'Sub::Name not available' + ); + } + elsif ( + # Because one of the former maintainers of DBIC::SL is a raging + # idiot, there is now a ton of DBIC code out there that attempts + # to create column accessors with illegal names. In the interest + # of not cluttering the logs of unsuspecting victims (unsuspecting + # because these accessors are unusuable anyway) we provide an + # explicit "do not warn at all" escape, until all such code is + # fixed (this will be a loooooong time >:( + $ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK} ne 'DO_NOT_WARN' + and + ! $illegal_accessors_warned->{$class}++ + ) { + Carp::carp( + "Installing illegal accessor '$name' into $class, see " + . 'documentation for more details' + ); + } + } - # the maker may elect to not return anything, meaning it already - # installed the coderef for us (e.g. lack of Sub::Name) - my $cref = $self->$maker($group, $field, $meth) - or next; + Carp::carp("Having a data accessor named '$name' in '$class' is unwise.") + if $name =~ /\A(?: DESTROY | AUTOLOAD | CLONE )\z/x; - my $fq_meth = "${class}::${meth}"; + my $alias = "_${name}_accessor"; - *$fq_meth = Sub::Name::subname($fq_meth, $cref); - #unless defined &{$class."\:\:$field"} - } + for ($name, $alias) { + + # the maker may elect to not return anything, meaning it already + # installed the coderef for us (e.g. lack of Sub::Name) + my $cref = $self->$maker($group, $field, $_) + or next; + + my $fq_meth = "${class}::$_"; + + *$fq_meth = Sub::Name::subname($fq_meth, $cref); + #unless defined &{$class."\:\:$field"} } + } }; -# coderef is setup at the end for clarity +# $gen_accessor coderef is setup at the end for clarity my $gen_accessor; =head1 NAME @@ -72,15 +169,65 @@ Class::Accessor::Grouped - Lets you build groups of accessors =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'); + + # make an accessor which calls a custom pair of getters/setters + sub get_column { ... this will be called when you do $obj->name() ... } + sub set_column { ... this will be called when you do $obj->name('foo') ... } + __PACKAGE__->mk_group_accessors(column => 'name'); + =head1 DESCRIPTION This class lets you build groups of accessors that will call different -getters and setters. +getters and setters. The documentation of this module still requires a lot +of work (B<< volunteers welcome >.> >>), but in the meantime you can refer to +L +for more information. + +=head2 Notes on accessor names + +In general method names in Perl are considered identifiers, and as such need to +conform to the identifier specification of C. +While it is rather easy to invoke methods with non-standard names +(C<< $obj->${\"anything goes"} >>), it is not possible to properly declare such +methods without the use of L. Since this module must be able to +function identically with and without its optional dependencies, starting with +version C<0.10008> attempting to declare an accessor with a non-standard name +is a fatal error (such operations would silently succeed since version +C<0.08004>, as long as L is present, or otherwise would result in a +syntax error during a string eval). + +Unfortunately in the years since C<0.08004> a rather large body of code +accumulated in the wild that does attempt to declare accessors with funny +names. One notable perpetrator is L, which under +certain conditions could create accessors of the C group which start +with numbers and/or some other punctuation (the proper way would be to declare +columns with the C attribute set to C). + +Therefore an escape mechanism is provided via the environment variable +C. When set to a true value, one warning is +issued B on attempts to declare an accessor with a non-conforming +name, and as long as L is available all accessors will be properly +created. Regardless of this setting, accessor names containing nulls C<"\0"> +are disallowed, due to various deficiencies in perl itself. + +If your code base has too many instances of illegal accessor declarations, and +a fix is not feasible due to time constraints, it is possible to disable the +warnings altogether by setting C<$ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK}> to +C (observe capitalization). =head1 METHODS =head2 mk_group_accessors + __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -105,14 +252,16 @@ be of the form [ $accessor, $field ]. =cut sub mk_group_accessors { - my ($self, $group, @fields) = @_; + my ($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_accessor', $group, @fields); - return; + $self->_mk_group_accessors('make_group_accessor', $group, @fields); + return; } =head2 mk_group_ro_accessors + __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -128,13 +277,16 @@ rather than setting the value. =cut sub mk_group_ro_accessors { - my($self, $group, @fields) = @_; + my($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); + return; } =head2 mk_group_wo_accessors + __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -150,65 +302,12 @@ value rather than getting the value. =cut sub mk_group_wo_accessors { - my($self, $group, @fields) = @_; + my($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); + return; } -=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 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 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 if it elects to install the coderef on its own. - -=cut - -sub make_group_wo_accessor { $gen_accessor->('wo', @_) } - =head2 get_simple =over 4 @@ -225,7 +324,7 @@ name passed as an argument. =cut sub get_simple { - return $_[0]->{$_[1]}; + $_[0]->{$_[1]}; } =head2 set_simple @@ -244,7 +343,7 @@ for the field name passed as an argument. =cut sub set_simple { - return $_[0]->{$_[1]} = $_[2]; + $_[0]->{$_[1]} = $_[2]; } @@ -267,38 +366,30 @@ instances. =cut sub get_inherited { - my $class; - - if ( defined( $class = Scalar::Util::blessed $_[0] ) ) { - if (Scalar::Util::reftype $_[0] eq 'HASH') { - return $_[0]->{$_[1]} if exists $_[0]->{$_[1]}; - } - else { - Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); - } + if ( length (ref ($_[0]) ) ) { + if (Scalar::Util::reftype $_[0] eq 'HASH') { + return $_[0]->{$_[1]} if exists $_[0]->{$_[1]}; + # everything in @_ is aliased, an assignment won't work + splice @_, 0, 1, ref($_[0]); } else { - $class = $_[0]; + Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); } + } - no strict 'refs'; - no warnings 'uninitialized'; - - my $cag_slot = '::__cag_'. $_[1]; - return ${$class.$cag_slot} if defined(${$class.$cag_slot}); + # if we got this far there is nothing in the instance + # OR this is a class call + # in any case $_[0] contains the class name (see splice above) + no strict 'refs'; + no warnings 'uninitialized'; - # we need to be smarter about recalculation, as @ISA (thus supers) can very well change in-flight - my $cur_gen = mro::get_pkg_gen ($class); - if ( $cur_gen != ${$class.'::__cag_pkg_gen__'} ) { - @{$class.'::__cag_supers__'} = $_[0]->get_super_paths; - ${$class.'::__cag_pkg_gen__'} = $cur_gen; - } + my $cag_slot = '::__cag_'. $_[1]; + return ${$_[0].$cag_slot} if defined(${$_[0].$cag_slot}); - for (@{$class.'::__cag_supers__'}) { - return ${$_.$cag_slot} if defined(${$_.$cag_slot}); - }; + do { return ${$_.$cag_slot} if defined(${$_.$cag_slot}) } + for $_[0]->get_super_paths; - return undef; + return undef; } =head2 set_inherited @@ -322,17 +413,16 @@ hash-based object. =cut sub set_inherited { - if (defined Scalar::Util::blessed $_[0]) { - if (Scalar::Util::reftype $_[0] eq 'HASH') { - return $_[0]->{$_[1]} = $_[2]; - } else { - Carp::croak('Cannot set inherited value on an object instance that is not hash-based'); - }; + if (length (ref ($_[0]) ) ) { + if (Scalar::Util::reftype $_[0] eq 'HASH') { + return $_[0]->{$_[1]} = $_[2]; } else { - no strict 'refs'; - - return ${$_[0].'::__cag_'.$_[1]} = $_[2]; + Carp::croak('Cannot set inherited value on an object instance that is not hash-based'); }; + } + + no strict 'refs'; + ${$_[0].'::__cag_'.$_[1]} = $_[2]; } =head2 get_component_class @@ -347,17 +437,17 @@ Returns: $value Gets the value of the specified component class. - __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); + __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); - $self->result_class->method(); + $self->result_class->method(); - ## same as - $self->get_component_class('result_class')->method(); + ## same as + $self->get_component_class('result_class')->method(); =cut sub get_component_class { - return $_[0]->get_inherited($_[1]); + $_[0]->get_inherited($_[1]); }; =head2 set_component_class @@ -373,64 +463,176 @@ Returns: $new_value Inherited accessor that automatically loads the specified class before setting it. This method will die if the specified class could not be loaded. - __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); - __PACKAGE__->result_class('MyClass'); + __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); + __PACKAGE__->result_class('MyClass'); - $self->result_class->method(); + $self->result_class->method(); =cut sub set_component_class { - if ($_[2]) { - local $^W = 0; - require Class::Inspector; - if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) { - eval "require $_[2]"; + if (defined $_[2] and length $_[2]) { + # disable warnings, and prevent $_ being eaten away by a behind-the-scenes + # module loading + local ($^W, $_); + + if (__CAG_ENV__::UNSTABLE_DOLLARAT) { + my $err; + { + local $@; + eval { Module::Runtime::use_package_optimistically($_[2]) } + or $err = $@; + } + Carp::croak("Could not load $_[1] '$_[2]': $err") if defined $err; - Carp::croak("Could not load $_[1] '$_[2]': ", $@) if $@; - }; - }; + } + else { + eval { Module::Runtime::use_package_optimistically($_[2]) } + or Carp::croak("Could not load $_[1] '$_[2]': $@"); + } + }; - return $_[0]->set_inherited($_[1], $_[2]); + $_[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. =cut sub get_super_paths { - return @{mro::get_linear_isa( ref($_[0]) || $_[0] )}; + # get_linear_isa returns the class itself as the 1st element + # use @_ as a pre-allocated scratch array + (undef, @_) = @{mro::get_linear_isa( length( ref($_[0]) ) ? 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 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 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 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 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 to generate the C-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, L, -L, L -and L: - - 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 +This is the benchmark of 200 get/get/set/get/set cycles on perl 5.16.2 with +thread support, showcasing how this modules L, +L and L accessors stack up against most popular accessor +builders: L, L, L, L (both pure-perl and XS variant), +L, +L, +L, +L, +L +and L + + Rate CAG_INHP CAG_INH CA CAG_S CAF moOse OTRW CAL mo moUse HANDMADE moo CAF_XS moUse_XS XSA + + CAG_INHP 287.021+-0.02/s -- -0.3% -10.0% -37.1% -53.1% -53.6% -53.7% -54.1% -56.9% -59.0% -59.6% -59.8% -78.7% -81.9% -83.5% + + CAG_INH 288.025+-0.031/s 0.3% -- -9.7% -36.9% -52.9% -53.5% -53.5% -53.9% -56.7% -58.8% -59.5% -59.7% -78.6% -81.9% -83.5% + + CA 318.967+-0.047/s 11.1% 10.7% -- -30.1% -47.9% -48.5% -48.5% -49.0% -52.1% -54.4% -55.1% -55.3% -76.3% -79.9% -81.7% + + CAG_S 456.107+-0.054/s 58.9% 58.4% 43.0% -- -25.4% -26.3% -26.4% -27.0% -31.5% -34.8% -35.8% -36.1% -66.1% -71.3% -73.9% + + CAF 611.745+-0.099/s 113.1% 112.4% 91.8% 34.1% -- -1.2% -1.2% -2.1% -8.1% -12.6% -14.0% -14.3% -54.5% -61.5% -64.9% + + moOse 619.051+-0.059/s 115.7% 114.9% 94.1% 35.7% 1.2% -- -0.1% -1.0% -7.0% -11.6% -12.9% -13.3% -54.0% -61.0% -64.5% + + OTRW 619.475+-0.1/s 115.8% 115.1% 94.2% 35.8% 1.3% 0.1% -- -0.9% -6.9% -11.5% -12.9% -13.2% -54.0% -61.0% -64.5% + + CAL 625.106+-0.085/s 117.8% 117.0% 96.0% 37.1% 2.2% 1.0% 0.9% -- -6.1% -10.7% -12.1% -12.5% -53.5% -60.6% -64.2% + + mo 665.44+-0.12/s 131.8% 131.0% 108.6% 45.9% 8.8% 7.5% 7.4% 6.5% -- -4.9% -6.4% -6.8% -50.5% -58.1% -61.9% + + moUse 699.9+-0.15/s 143.9% 143.0% 119.4% 53.5% 14.4% 13.1% 13.0% 12.0% 5.2% -- -1.6% -2.0% -48.0% -55.9% -59.9% + + HANDMADE 710.98+-0.16/s 147.7% 146.8% 122.9% 55.9% 16.2% 14.9% 14.8% 13.7% 6.8% 1.6% -- -0.4% -47.2% -55.2% -59.2% + + moo 714.04+-0.13/s 148.8% 147.9% 123.9% 56.6% 16.7% 15.3% 15.3% 14.2% 7.3% 2.0% 0.4% -- -46.9% -55.0% -59.1% + + CAF_XS 1345.55+-0.051/s 368.8% 367.2% 321.8% 195.0% 120.0% 117.4% 117.2% 115.3% 102.2% 92.2% 89.3% 88.4% -- -15.3% -22.9% + + moUse_XS 1588+-0.036/s 453.3% 451.3% 397.9% 248.2% 159.6% 156.5% 156.3% 154.0% 138.6% 126.9% 123.4% 122.4% 18.0% -- -9.0% + + XSA 1744.67+-0.052/s 507.9% 505.7% 447.0% 282.5% 185.2% 181.8% 181.6% 179.1% 162.2% 149.3% 145.4% 144.3% 29.7% 9.9% -- + +Benchmarking program is available in the root of the L: =head2 Notes on Class::XSAccessor @@ -450,12 +652,6 @@ an object, invoke a simple accessor on that object, and B manipulate the symbol table to install a C override - you get to keep all the pieces. -While L 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 -will not be used automatically if you are running under C. - =head1 AUTHORS Matt S. Trout @@ -466,6 +662,8 @@ Christopher H. Laco Caelum: Rafael Kitover +frew: Arthur Axel "fREW" Schmidt + groditi: Guillermo Roditi Jason Plum @@ -492,128 +690,94 @@ it under the same terms as perl itself. ######################################################################## ######################################################################## -BEGIN { - - die "Huh?! No minimum C::XSA version?!\n" - unless $__minimum_xsa_version; - - local $@; - my $err; - - - $err = eval { require Sub::Name; 1; } ? undef : do { - delete $INC{'Sub/Name.pm'}; # because older perls suck - $@; - }; - *__CAG_NO_SUBNAME = $err - ? sub () { $err } - : sub () { 0 } - ; - - - $err = eval { - require Class::XSAccessor; - Class::XSAccessor->VERSION($__minimum_xsa_version); - require Sub::Name; - 1; - } ? undef : do { - delete $INC{'Sub/Name.pm'}; # because older perls suck - delete $INC{'Class/XSAccessor.pm'}; - $@; - }; - *__CAG_NO_CXSA = $err - ? sub () { $err } - : sub () { 0 } - ; - - - *__CAG_BROKEN_GOTO = ($] < '5.008009') - ? sub () { 1 } - : sub () { 0 } - ; - - - *__CAG_UNSTABLE_DOLLARAT = ($] < '5.013002') - ? sub () { 1 } - : sub () { 0 } - ; - - - *__CAG_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++; } + my $maker_templates = { rw => { - xs_call => 'accessors', - pp_code => sub { - my $set = "set_$_[0]"; - my $get = "get_$_[0]"; - my $field = $_[1]; - $field =~ s/'/\\'/g; - - " - \@_ > 1 - ? shift->$set('$field', \@_) - : shift->$get('$field') - " + cxsa_call => 'accessors', + pp_generator => sub { + # my ($group, $fieldname) = @_; + my $quoted_fieldname = B::perlstring($_[1]); + sprintf <<'EOS', ($_[0], $quoted_fieldname) x 2; + +@_ > 1 + ? shift->set_%s(%s, @_) + : shift->get_%s(%s) +EOS + }, }, ro => { - xs_call => 'getters', - pp_code => sub { - my $get = "get_$_[0]"; - my $field = $_[1]; - $field =~ s/'/\\'/g; - - " - \@_ == 1 - ? shift->$get('$field') - : do { - my \$caller = caller; - my \$class = ref \$_[0] || \$_[0]; - Carp::croak(\"'\$caller' cannot alter the value of '$field' \". - \"(read-only attributes of class '\$class')\"); - } - " + cxsa_call => 'getters', + pp_generator => sub { + # my ($group, $fieldname) = @_; + my $quoted_fieldname = B::perlstring($_[1]); + sprintf <<'EOS', $_[0], $quoted_fieldname; + +@_ > 1 + ? do { + my ($meth) = (caller(0))[3] =~ /([^\:]+)$/; + my $class = length( ref($_[0]) ) ? ref($_[0]) : $_[0]; + Carp::croak( + "'$meth' cannot alter its value (read-only attribute of class $class)" + ); + } + : shift->get_%s(%s) +EOS + }, }, wo => { - xs_call => 'setters', - pp_code => sub { - my $set = "set_$_[0]"; - my $field = $_[1]; - $field =~ s/'/\\'/g; - - " - \@_ > 1 - ? shift->$set('$field', \@_) - : do { - my \$caller = caller; - my \$class = ref \$_[0] || \$_[0]; - Carp::croak(\"'\$caller' cannot access the value of '$field' \". - \"(write-only attributes of class '\$class')\"); - } - " + cxsa_call => 'setters', + pp_generator => sub { + # my ($group, $fieldname) = @_; + my $quoted_fieldname = B::perlstring($_[1]); + sprintf <<'EOS', $_[0], $quoted_fieldname; + +@_ > 1 + ? shift->set_%s(%s, @_) + : do { + my ($meth) = (caller(0))[3] =~ /([^\:]+)$/; + my $class = length( ref($_[0]) ) ? ref($_[0]) : $_[0]; + Carp::croak( + "'$meth' cannot access its value (write-only attribute of class $class)" + ); + } +EOS + }, }, }; +my $cag_eval = sub { + #my ($src, $no_warnings, $err_msg) = @_; + + my $src = sprintf "{ %s warnings; use strict; no strict 'refs'; %s }", + $_[1] ? 'no' : 'use', + $_[0], + ; + + my (@rv, $err); + { + local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT; + wantarray + ? @rv = eval $src + : $rv[0] = eval $src + ; + $err = $@ if $@ ne ''; + } + + Carp::croak(join ': ', ($_[2] || 'String-eval failed'), "$err\n$src\n" ) + if defined $err; + + wantarray ? @rv : $rv[0]; +}; my ($accessor_maker_cache, $no_xsa_warned_classes); @@ -622,12 +786,20 @@ my ($accessor_maker_cache, $no_xsa_warned_classes); my $original_simple_getter = __PACKAGE__->can ('get_simple'); my $original_simple_setter = __PACKAGE__->can ('set_simple'); +my ($resolved_methods, $cag_produced_crefs); + +sub CLONE { + my @crefs = grep { defined $_ } values %{$cag_produced_crefs||{}}; + $cag_produced_crefs = @crefs + ? { map { $_ => $_ } @crefs } + : undef + ; +} + # Note!!! Unusual signature $gen_accessor = sub { my ($type, $class, $group, $field, $methname) = @_; - if (my $c = ref $class) { - $class = $c; - } + $class = ref $class if length ref $class; # 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. @@ -639,86 +811,127 @@ $gen_accessor = sub { # Thus the final method (properly labeled and all) is installed in the # calling-package's namespace if ($USE_XS and $group eq 'simple') { - 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; + + my $ret = sub { + my $current_class = length (ref ($_[0] ) ) ? ref ($_[0]) : $_[0]; + + my $resolved_implementation = $resolved_methods->{$current_class}{$methname} ||= do { + if ( + ($current_class->can('get_simple')||0) == $original_simple_getter + && + ($current_class->can('set_simple')||0) == $original_simple_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! :) + # + # 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 => '__CAG__XSA__BREEDER__', + $maker_templates->{$type}{cxsa_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' inheriting from '$class' due to an overriden get_simple and/or " + . "set_simple\n"; + } + + 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 ( ! $cag_produced_crefs->{ $current_class->can($methname) || 0 } ) { - my %deferred_calls_seen; + # 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; + } - return sub { - my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0]; - if (__CAG_TRACK_UNDEFER_FAIL) { + 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 ($deferred_calls_seen{$cframe[3]}) { + + if (my $already_seen = $deferred_calls_seen->{$cframe[3]}) { Carp::carp ( "Deferred version of method $cframe[3] invoked more than once (originally " - . "invoked at $deferred_calls_seen{$cframe[3]}). 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' + . "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 minor performance regressions' ); } else { - $deferred_calls_seen{$cframe[3]} = "$cframe[1] line $cframe[2]"; + $deferred_calls_seen->{$cframe[3]} = "$cframe[1] line $cframe[2]"; } } - if ( - $current_class->can('get_simple') == $original_simple_getter - && - $current_class->can('set_simple') == $original_simple_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! :) - Class::XSAccessor->import( - replace => 1, - class => $current_class, - $maker_templates->{$type}{xs_call} => { - $methname => $field, - }, - ); - } - 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' inheriting from '$class' due to an overriden get_simple and/or " - . "set_simple\n"; - } - + # 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, do { - # that's faster than local - $USE_XS = 0; - my $c = $gen_accessor->($type, $class, 'simple', $field, $methname); - $USE_XS = 1; - $c; - }); + *$fq_name = Sub::Name::subname($fq_name, $resolved_implementation); } + # now things are installed - one ref less to carry + delete $resolved_methods->{$current_class}{$methname}; + + # but need to record it in the expectation registry *in case* it + # was cached via ->can for some moronic reason + Scalar::Util::weaken( $cag_produced_crefs->{$resolved_implementation} = $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; }; + + Scalar::Util::weaken($cag_produced_crefs->{$ret} = $ret); + + $ret; # returning shim } # no Sub::Name - just install the coderefs directly (compiling every time) - elsif (__CAG_NO_SUBNAME) { + elsif (__CAG_ENV__::NO_SUBNAME) { my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= - $maker_templates->{$type}{pp_code}->($group, $field); + $maker_templates->{$type}{pp_generator}->($group, $field); - no warnings 'redefine'; - local $@ if __CAG_UNSTABLE_DOLLARAT; - eval "sub ${class}::${methname} { $src }"; + $cag_eval->( + "no warnings 'redefine'; sub ${class}::${methname} { $src }; 1", + ); undef; # so that no further attempt will be made to install anything } @@ -727,10 +940,9 @@ $gen_accessor = sub { else { ($accessor_maker_cache->{pp}{$type}{$group}{$field} ||= do { my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= - $maker_templates->{$type}{pp_code}->($group, $field); + $maker_templates->{$type}{pp_generator}->($group, $field); - local $@ if __CAG_UNSTABLE_DOLLARAT; - eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@; + $cag_eval->( "sub { my \$dummy; sub { \$dummy if 0; $src } }" ); })->() } };