X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FAccessor%2FGrouped.pm;h=77c55750f8b52af306d267b843cf43a83a227233;hb=18922520eb03bc7fb5e1cdfd7304748365b7210e;hp=265ec531ad7fe1d10910a73d2c2d7bce8ddad918;hpb=eece2562b6286c22c2e0f3fad9551ab38b559681;p=p5sagit%2FClass-Accessor-Grouped.git diff --git a/lib/Class/Accessor/Grouped.pm b/lib/Class/Accessor/Grouped.pm index 265ec53..77c5575 100644 --- a/lib/Class/Accessor/Grouped.pm +++ b/lib/Class/Accessor/Grouped.pm @@ -3,14 +3,25 @@ use strict; use warnings; use Carp (); use Scalar::Util (); -use MRO::Compat; -use Sub::Name (); -our $VERSION = '0.09006'; -$VERSION = eval $VERSION; +BEGIN { + if ($] < 5.009_005) { + require MRO::Compat; + } + else { + require mro; + } +} + +our $VERSION = '0.10002'; +$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases -# when changing minimum version don't forget to adjust L as well -our $__minimum_xsa_version = '1.06'; +# 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.11'; +} our $USE_XS; # the unless defined is here so that we can override the value @@ -18,122 +29,11 @@ our $USE_XS; $USE_XS = $ENV{CAG_USE_XS} unless defined $USE_XS; -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); - }; - - # 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); - - goto $final_cref; - }; -}; - -my $install_group_accessors = sub { +# 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; @@ -141,7 +41,7 @@ my $install_group_accessors = sub { 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'; + $maker = $self->can($maker) unless ref $maker; foreach (@fields) { if( $_ eq 'DESTROY' ) { @@ -159,11 +59,11 @@ my $install_group_accessors = sub { for my $meth ($name, $alias) { # the maker may elect to not return anything, meaning it already - # installed the coderef for us + # installed the coderef for us (e.g. lack of Sub::Name) my $cref = $self->$maker($group, $field, $meth) or next; - my $fq_meth = join('::', $class, $meth); + my $fq_meth = "${class}::${meth}"; *$fq_meth = Sub::Name::subname($fq_meth, $cref); #unless defined &{$class."\:\:$field"} @@ -171,6 +71,8 @@ my $install_group_accessors = sub { } }; +# coderef is setup at the end for clarity +my $gen_accessor; =head1 NAME @@ -178,6 +80,14 @@ 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'); + =head1 DESCRIPTION This class lets you build groups of accessors that will call different @@ -187,6 +97,8 @@ getters and setters. =head2 mk_group_accessors + __PACKAGE__->mk_group_accessors(simple => 'hair_length'); + =over 4 =item Arguments: $group, @fieldspec @@ -211,14 +123,16 @@ be of the form [ $accessor, $field ]. =cut sub mk_group_accessors { - my ($self, $group, @fields) = @_; + my ($self, $group, @fields) = @_; - $self->$install_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'); + =over 4 =item Arguments: $group, @fieldspec @@ -236,11 +150,13 @@ rather than setting the value. sub mk_group_ro_accessors { my($self, $group, @fields) = @_; - $self->$install_group_accessors('make_group_ro_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); } =head2 mk_group_wo_accessors + __PACKAGE__->mk_group_wo_accessors(simple => 'lie'); + =over 4 =item Arguments: $group, @fieldspec @@ -258,11 +174,13 @@ value rather than getting the value. sub mk_group_wo_accessors { my($self, $group, @fields) = @_; - $self->$install_group_accessors('make_group_wo_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); } =head2 make_group_accessor + __PACKAGE__->make_group_accessor(simple => 'hair_length', 'hair_length'); + =over 4 =item Arguments: $group, $field, $method @@ -277,34 +195,12 @@ C if it elects to install the coderef on its own. =cut -sub make_group_accessor { - 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) { - return shift->$set('$field', \@_); - } - else { - return shift->$get('$field'); - } - };"; - Carp::croak $@ if $@; - - return $code; -} +sub make_group_accessor { $gen_accessor->('rw', @_) } =head2 make_group_ro_accessor + __PACKAGE__->make_group_ro_accessor(simple => 'birthdate', 'birthdate'); + =over 4 =item Arguments: $group, $field, $method @@ -319,34 +215,12 @@ C if it elects to install the coderef on its own. =cut -sub make_group_ro_accessor { - 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; - Carp::croak(\"'\$caller' cannot alter the value of '$field' on \". - \"objects of class '$class'\"); - } - else { - return shift->$get('$field'); - } - };"; - Carp::croak $@ if $@; - - return $code; -} +sub make_group_ro_accessor { $gen_accessor->('ro', @_) } =head2 make_group_wo_accessor + __PACKAGE__->make_group_wo_accessor(simple => 'lie', 'lie'); + =over 4 =item Arguments: $group, $field, $method @@ -361,31 +235,7 @@ C if it elects to install the coderef on its own. =cut -sub make_group_wo_accessor { - 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; - Carp::croak(\"'\$caller' cannot access the value of '$field' on \". - \"objects of class '$class'\"); - } - else { - return shift->$set('$field', \@_); - } - };"; - Carp::croak $@ if $@; - - return $code; -} +sub make_group_wo_accessor { $gen_accessor->('wo', @_) } =head2 get_simple @@ -403,7 +253,7 @@ name passed as an argument. =cut sub get_simple { - return $_[0]->{$_[1]}; + return $_[0]->{$_[1]}; } =head2 set_simple @@ -422,7 +272,7 @@ for the field name passed as an argument. =cut sub set_simple { - return $_[0]->{$_[1]} = $_[2]; + return $_[0]->{$_[1]} = $_[2]; } @@ -563,7 +413,7 @@ sub set_component_class { 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 $@; }; @@ -582,33 +432,34 @@ sub get_super_paths { 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 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% -- +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: @@ -630,12 +481,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 @@ -646,6 +491,8 @@ Christopher H. Laco Caelum: Rafael Kitover +frew: Arthur Axel "fREW" Schmidt + groditi: Guillermo Roditi Jason Plum @@ -661,3 +508,298 @@ 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 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 $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;