X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FAccessor%2FGrouped.pm;h=aea38c20774f28c7ab28ccff7cf2d3e52792b9fe;hb=b36cd2595cc422d4e5bb0d5e905acfd7d4c1fd70;hp=0c4b502c02519ddae77c6a3bdb554620e74c1994;hpb=a557f8adc8357410d04217c0f4c2e07a42a4da23;p=p5sagit%2FClass-Accessor-Grouped.git diff --git a/lib/Class/Accessor/Grouped.pm b/lib/Class/Accessor/Grouped.pm index 0c4b502..aea38c2 100644 --- a/lib/Class/Accessor/Grouped.pm +++ b/lib/Class/Accessor/Grouped.pm @@ -2,29 +2,70 @@ 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.09000'; +our $VERSION = '0.10001'; +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases +# when changing minimum version don't forget to adjust L and +# the Makefile.PL as well +our $__minimum_xsa_version; BEGIN { - our $hasXS; - - sub _hasXS { - return $hasXS if defined $hasXS; - - $hasXS = 0; - eval { - require Class::XSAccessor; - $hasXS = 1; - }; - - return $hasXS; - } + $__minimum_xsa_version = '1.11'; } +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; + +# 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; + + 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."); + } + + 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 (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"} + } + } +}; + +# coderef is setup at the end for clarity +my $gen_accessor; + =head1 NAME Class::Accessor::Grouped - Lets you build groups of accessors @@ -64,58 +105,10 @@ 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; -} - - -{ - 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' ) { - 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 @@ -166,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 @@ -274,7 +225,7 @@ name passed as an argument. =cut sub get_simple { - return $_[0]->{$_[1]}; + return $_[0]->{$_[1]}; } =head2 set_simple @@ -293,7 +244,7 @@ for the field name passed as an argument. =cut sub set_simple { - return $_[0]->{$_[1]} = $_[2]; + return $_[0]->{$_[1]} = $_[2]; } @@ -318,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; @@ -370,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 { @@ -431,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 $@; }; @@ -448,27 +401,375 @@ 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 + +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 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, L, +L, and L: + + 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: + +=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. =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 -Copyright (c) 2006-2009 Matt S. Trout +Copyright (c) 2006-2010 Matt S. Trout 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 } + ; + + + *__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 +my $xsa_autodetected; +if (! defined $USE_XS) { + $USE_XS = __CAG_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') + " + }, + }, + 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 = Scalar::Util::blessed( $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; + + 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 + && + $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! :) + # + # 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}{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' 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 ($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 $resolved_implementation->(@_) if __CAG_BROKEN_GOTO; + + goto $resolved_implementation; + } + + if (__CAG_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_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 $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 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}{$type}{$group}{$field} ||= 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;