X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FAccessor%2FGrouped.pm;h=3608fd5f3ddc4f21c742ac99dd7adf4da40e77c0;hb=ad2211b606582c67edb4e8f60c8777a8825e2a24;hp=6cb0ddf29eda51c636216d4746a84bdc1422de6b;hpb=af169484b92883c80359dc9befa32b56f1430bbe;p=p5sagit%2FClass-Accessor-Grouped.git diff --git a/lib/Class/Accessor/Grouped.pm b/lib/Class/Accessor/Grouped.pm index 6cb0ddf..3608fd5 100644 --- a/lib/Class/Accessor/Grouped.pm +++ b/lib/Class/Accessor/Grouped.pm @@ -2,34 +2,69 @@ package Class::Accessor::Grouped; 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.09009'; $VERSION = eval $VERSION; -# Class::XSAccessor is segfaulting on win32, so be careful -# Win32 users can set $hasXS to try to use it anyway +# 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'; +} + +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; -our $hasXS; +# 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 +# %$*@!?&!&#*$!!! +sub _mk_group_accessors { + my($self, $maker, $group, @fields) = @_; + my $class = Scalar::Util::blessed $self || $self; -sub _hasXS { + 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; + + foreach (@fields) { + if( $_ eq 'DESTROY' ) { + Carp::carp("Having a data accessor named DESTROY in ". + "'$class' is unwise."); + } - if (not defined $hasXS) { - $hasXS = 0; + my ($name, $field) = (ref $_) + ? (@$_) + : ($_, $_) + ; - if ($^O ne 'MSWin32') { - eval { - require Class::XSAccessor; - $hasXS = 1; - }; + 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 (e.g. lack of Sub::Name) + my $cref = $self->$maker($group, $field, $meth) + or next; + + my $fq_meth = "${class}::${meth}"; + + *$fq_meth = Sub::Name::subname($fq_meth, $cref); + #unless defined &{$class."\:\:$field"} + } } - } +}; - return $hasXS; -} +# coderef is setup at the end for clarity +my $gen_accessor; =head1 NAME @@ -70,59 +105,10 @@ be of the form [ $accessor, $field ]. =cut sub mk_group_accessors { - my ($self, $group, @fields) = @_; - - $self->_mk_group_accessors('make_group_accessor', $group, @fields); - return; -} - - -{ - no strict 'refs'; - no warnings 'redefine'; + my ($self, $group, @fields) = @_; - 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::newxs_accessor("${class}::${name}", $field, 0); - Class::XSAccessor::newxs_accessor("${class}::${alias}", $field, 0); - - # XXX: is the alias accessor really necessary? - } - 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"} - } - } - } + $self->_mk_group_accessors('make_group_accessor', $group, @fields); + return; } =head2 mk_group_ro_accessors @@ -173,97 +159,55 @@ sub mk_group_wo_accessors { =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 if it elects to install the coderef on its own. =cut -sub make_group_accessor { - my ($class, $group, $field) = @_; - - my $set = "set_$group"; - my $get = "get_$group"; - - # eval for faster fastiness - return eval "sub { - if(\@_ > 1) { - return shift->$set('$field', \@_); - } - else { - return shift->$get('$field'); - } - };" -} +sub make_group_accessor { $gen_accessor->('rw', @_) } =head2 make_group_ro_accessor =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 if it elects to install the coderef on its own. =cut -sub make_group_ro_accessor { - my($class, $group, $field) = @_; - - my $get = "get_$group"; - - return eval "sub { - if(\@_ > 1) { - my \$caller = caller; - Carp::croak(\"'\$caller' cannot alter the value of '$field' on \". - \"objects of class '$class'\"); - } - else { - return shift->$get('$field'); - } - };" -} +sub make_group_ro_accessor { $gen_accessor->('ro', @_) } =head2 make_group_wo_accessor =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 if it elects to install the coderef on its own. =cut -sub make_group_wo_accessor { - my($class, $group, $field) = @_; - - my $set = "set_$group"; - - return eval "sub { - unless (\@_ > 1) { - my \$caller = caller; - Carp::croak(\"'\$caller' cannot access the value of '$field' on \". - \"objects of class '$class'\"); - } - else { - return shift->$set('$field', \@_); - } - };" -} +sub make_group_wo_accessor { $gen_accessor->('wo', @_) } =head2 get_simple @@ -281,7 +225,7 @@ name passed as an argument. =cut sub get_simple { - return $_[0]->{$_[1]}; + return $_[0]->{$_[1]}; } =head2 set_simple @@ -300,7 +244,7 @@ for the field name passed as an argument. =cut sub set_simple { - return $_[0]->{$_[1]} = $_[2]; + return $_[0]->{$_[1]} = $_[2]; } @@ -325,32 +269,33 @@ instances. sub get_inherited { my $class; - if (Scalar::Util::blessed $_[0]) { - my $reftype = Scalar::Util::reftype $_[0]; - $class = ref $_[0]; - - if ($reftype eq 'HASH' && exists $_[0]->{$_[1]}) { - return $_[0]->{$_[1]}; - } elsif ($reftype ne 'HASH') { - Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); - }; - } else { + 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'); + } + } + else { $class = $_[0]; - }; + } no strict 'refs'; - no warnings qw/uninitialized/; - return ${$class.'::__cag_'.$_[1]} if defined(${$class.'::__cag_'.$_[1]}); + no warnings 'uninitialized'; + + my $cag_slot = '::__cag_'. $_[1]; + return ${$class.$cag_slot} if defined(${$class.$cag_slot}); # we need to be smarter about recalculation, as @ISA (thus supers) can very well change in-flight - my $pkg_gen = mro::get_pkg_gen ($class); - if ( ${$class.'::__cag_pkg_gen'} != $pkg_gen ) { - @{$class.'::__cag_supers'} = $_[0]->get_super_paths; - ${$class.'::__cag_pkg_gen'} = $pkg_gen; - }; + 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; + } - foreach (@{$class.'::__cag_supers'}) { - return ${$_.'::__cag_'.$_[1]} if defined(${$_.'::__cag_'.$_[1]}); + for (@{$class.'::__cag_supers__'}) { + return ${$_.$cag_slot} if defined(${$_.$cag_slot}); }; return undef; @@ -377,7 +322,7 @@ hash-based object. =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 { @@ -438,8 +383,9 @@ it. This method will die if the specified class could not be loaded. sub set_component_class { if ($_[2]) { local $^W = 0; + require Class::Inspector; if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) { - eval "use $_[2]"; + eval "require $_[2]"; Carp::croak("Could not load $_[1] '$_[2]': ", $@) if $@; }; @@ -455,30 +401,77 @@ Returns a list of 'parent' or 'super' class names that the current class inherit =cut sub get_super_paths { - my $class = Scalar::Util::blessed $_[0] || $_[0]; - - return @{mro::get_linear_isa($class)}; + return @{mro::get_linear_isa( ref($_[0]) || $_[0] )}; }; -1; - -=head1 Performance - -You can speed up accessors of type 'simple' by installing L. -Note however that the use of this module is disabled by default on Win32 -systems, as it causes yet unresolved segfaults. If you are a Win32 user, and -want to try this module with L, set -C<$Class::Accessor::Grouped::hasXS> to a true value B registering -your accessors (e.g. in a C block) +=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. + +=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 +L: + +=head2 Notes on Class::XSAccessor + +You can force (or disable) the use of L before creating a +particular C accessor by either manipulating the global variable +C<$Class::Accessor::Grouped::USE_XS> to true or false (preferably with +L, or you can do so before runtime via the +C environment variable. + +Since L has no knowledge of L and +L 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 (automatically or explicitly), create +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 + Christopher H. Laco -With contributions from: +=head1 CONTRIBUTORS + +Caelum: Rafael Kitover + +groditi: Guillermo Roditi + +Jason Plum + +ribasushi: Peter Rabbitson -Guillermo Roditi =head1 COPYRIGHT & LICENSE @@ -488,3 +481,230 @@ This program is free software; you can redistribute it and/or modify it under the same terms as perl itself. =cut + +######################################################################## +######################################################################## +######################################################################## +# +# Here be many angry dragons +# (all code is in private coderefs since everything inherits CAG) +# +######################################################################## +######################################################################## + +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 } + ; +} + +# 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; + $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') + " + }, + }, + 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')\"); + } + " + }, + }, + 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')\"); + } + " + }, + }, +}; + + +my ($accessor_maker_cache, $no_xsa_warned_classes); + +# can't use pkg_gen to track this stuff, as it doesn't +# detect superclass mucking +my $original_simple_getter = __PACKAGE__->can ('get_simple'); +my $original_simple_setter = __PACKAGE__->can ('set_simple'); + +# Note!!! Unusual signature +$gen_accessor = sub { + my ($type, $class, $group, $field, $methname) = @_; + if (my $c = ref $class) { + $class = $c; + } + + # 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 + # + # 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') { + die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_NO_CXSA ) + if __CAG_NO_CXSA; + + return sub { + my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0]; + + 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"; + } + + no strict qw/refs/; + + 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; + }); + } + + # 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; + + goto $current_class->can($methname); + }; + } + + # no Sub::Name - just install the coderefs directly (compiling every time) + elsif (__CAG_NO_SUBNAME) { + my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= + $maker_templates->{$type}{pp_code}->($group, $field); + + no warnings 'redefine'; + local $@ if __CAG_UNSTABLE_DOLLARAT; + eval "sub ${class}::${methname}{$src}"; + + undef; # so that no 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 $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= + $maker_templates->{$type}{pp_code}->($group, $field); + + local $@ if __CAG_UNSTABLE_DOLLARAT; + eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@; + })->() + } +}; + +1;