/usr/share/perl5/Class/Accessor/Grouped.pm is in libclass-accessor-grouped-perl 0.10012-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 | package Class::Accessor::Grouped;
use strict;
use warnings;
use Carp ();
use Scalar::Util ();
use Module::Runtime ();
BEGIN {
# 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.10012';
$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.19' }
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;
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 );
sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
}
# 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 = length (ref ($self) ) ? ref ($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;
for (@fields) {
my ($name, $field) = (ref $_) ? (@$_) : ($_, $_);
if ($name !~ /\A[A-Z_a-z][0-9A-Z_a-z]*\z/) {
if ($name =~ /\0/) {
Carp::croak(sprintf
"Illegal accessor name %s - nulls should never appear in stash keys",
__CAG_ENV__::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 unusable 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'
);
}
}
Carp::carp("Having a data accessor named '$name' in '$class' is unwise.")
if $name =~ /\A(?: DESTROY | AUTOLOAD | CLONE )\z/x;
my $alias = "_${name}_accessor";
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"}
}
}
};
# $gen_accessor coderef is setup at the end for clarity
my $gen_accessor;
=head1 NAME
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. The documentation of this module still requires a lot
of work (B<< volunteers welcome >.> >>), but in the meantime you can refer to
L<this post|http://lo-f.at/glahn/2009/08/WritingPowerfulAccessorsForPerlClasses.html>
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<qr/\A[A-Z_a-z][0-9A-Z_a-z]*\z/>.
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<Sub::Name>. 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<Sub::Name> 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<DBIx::Class::Schema::Loader>, which under
certain conditions could create accessors of the C<column> group which start
with numbers and/or some other punctuation (the proper way would be to declare
columns with the C<accessor> attribute set to C<undef>).
Therefore an escape mechanism is provided via the environment variable
C<CAG_ILLEGAL_ACCESSOR_NAME_OK>. When set to a true value, one warning is
issued B<per class> on attempts to declare an accessor with a non-conforming
name, and as long as L<Sub::Name> 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<DO_NOT_WARN> (observe capitalization).
=head1 METHODS
=head2 mk_group_accessors
__PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]);
=over 4
=item Arguments: $group, @fieldspec
Returns: none
=back
Creates a set of accessors in a given group.
$group is the name of the accessor group for the generated accessors; they
will call get_$group($field) on get and set_$group($field, $value) on set.
If you want to mimic Class::Accessor's mk_accessors $group has to be 'simple'
to tell Class::Accessor::Grouped to use its own get_simple and set_simple
methods.
@fieldspec is a list of field/accessor names; if a fieldspec is a scalar
this is used as both field and accessor name, if a listref it is expected to
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;
}
=head2 mk_group_ro_accessors
__PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]);
=over 4
=item Arguments: $group, @fieldspec
Returns: none
=back
Creates a set of read only accessors in a given group. Identical to
L</mk_group_accessors> but accessors will throw an error if passed a value
rather than setting the value.
=cut
sub mk_group_ro_accessors {
my($self, $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
Returns: none
=back
Creates a set of write only accessors in a given group. Identical to
L</mk_group_accessors> but accessors will throw an error if not passed a
value rather than getting the value.
=cut
sub mk_group_wo_accessors {
my($self, $group, @fields) = @_;
$self->_mk_group_accessors('make_group_wo_accessor', $group, @fields);
return;
}
=head2 get_simple
=over 4
=item Arguments: $field
Returns: $value
=back
Simple getter for hash-based objects which returns the value for the field
name passed as an argument.
=cut
sub get_simple {
$_[0]->{$_[1]};
}
=head2 set_simple
=over 4
=item Arguments: $field, $new_value
Returns: $new_value
=back
Simple setter for hash-based objects which sets and then returns the value
for the field name passed as an argument.
=cut
sub set_simple {
$_[0]->{$_[1]} = $_[2];
}
=head2 get_inherited
=over 4
=item Arguments: $field
Returns: $value
=back
Simple getter for Classes and hash-based objects which returns the value for
the field name passed as an argument. This behaves much like
L<Class::Data::Accessor> where the field can be set in a base class,
inherited and changed in subclasses, and inherited and changed for object
instances.
=cut
sub get_inherited {
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 {
Carp::croak('Cannot get inherited value on an object instance that is not hash-based');
}
}
# 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';
my $cag_slot = '::__cag_'. $_[1];
return ${$_[0].$cag_slot} if defined(${$_[0].$cag_slot});
do { return ${$_.$cag_slot} if defined(${$_.$cag_slot}) }
for $_[0]->get_super_paths;
return undef;
}
=head2 set_inherited
=over 4
=item Arguments: $field, $new_value
Returns: $new_value
=back
Simple setter for Classes and hash-based objects which sets and then returns
the value for the field name passed as an argument. When called on a hash-based
object it will set the appropriate hash key value. When called on a class, it
will set a class level variable.
B<Note:>: This method will die if you try to set an object variable on a non
hash-based object.
=cut
sub set_inherited {
if (length (ref ($_[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');
};
}
no strict 'refs';
${$_[0].'::__cag_'.$_[1]} = $_[2];
}
=head2 get_component_class
=over 4
=item Arguments: $field
Returns: $value
=back
Gets the value of the specified component class.
__PACKAGE__->mk_group_accessors('component_class' => 'result_class');
$self->result_class->method();
## same as
$self->get_component_class('result_class')->method();
=cut
sub get_component_class {
$_[0]->get_inherited($_[1]);
};
=head2 set_component_class
=over 4
=item Arguments: $field, $class
Returns: $new_value
=back
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');
$self->result_class->method();
=cut
sub set_component_class {
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;
}
else {
eval { Module::Runtime::use_package_optimistically($_[2]) }
or Carp::croak("Could not load $_[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. This is what drives the traversal done by L</get_inherited>.
=cut
sub get_super_paths {
# 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<undef> 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<undef> 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<undef> 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<Class::Accessor::Grouped> calls methods
internally while performing get/set actions, which makes it noticeably
slower than similar modules. To compensate, this module will automatically
use the insanely fast L<Class::XSAccessor> to generate the C<simple>-group
accessors if this module is available on your system.
=head2 Benchmark
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<simple (CAG_S)|/get_simple>,
L<inherited (CAG_INH)|/get_inherited> and L<inherited with parent-class data
(CAG_INHP)|/get_inherited> accessors stack up against most popular accessor
builders: L<Moose>, L<Moo>, L<Mo>, L<Mouse> (both pure-perl and XS variant),
L<Object::Tiny::RW (OTRW)|Object::Tiny::RW>,
L<Class::Accessor (CA)|Class::Accessor>,
L<Class::Accessor::Lite (CAL)|Class::Accessor::Lite>,
L<Class::Accessor::Fast (CAF)|Class::Accessor::Fast>,
L<Class::Accessor::Fast::XS (CAF_XS)|Class::Accessor::Fast::XS>
and L<Class::XSAccessor (XSA)|Class::XSAccessor>
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<repository|http://search.cpan.org/dist/Class-Accessor-Grouped/>:
=head2 Notes on Class::XSAccessor
You can force (or disable) the use of L<Class::XSAccessor> before creating a
particular C<simple> accessor by either manipulating the global variable
C<$Class::Accessor::Grouped::USE_XS> to true or false (preferably with
L<localization|perlfunc/local>, or you can do so before runtime via the
C<CAG_USE_XS> environment variable.
Since L<Class::XSAccessor> has no knowledge of L</get_simple> and
L</set_simple> this module does its best to detect if you are overriding
one of these methods and will fall back to using the perl version of the
accessor in order to maintain consistency. However be aware that if you
enable use of C<Class::XSAccessor> (automatically or explicitly), create
an object, invoke a simple accessor on that object, and B<then> manipulate
the symbol table to install a C<get/set_simple> override - you get to keep
all the pieces.
=head1 AUTHORS
Matt S. Trout <mst@shadowcatsystems.co.uk>
Christopher H. Laco <claco@chrislaco.com>
=head1 CONTRIBUTORS
Caelum: Rafael Kitover <rkitover@cpan.org>
frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
groditi: Guillermo Roditi <groditi@cpan.org>
Jason Plum <jason.plum@bmmsi.com>
ribasushi: Peter Rabbitson <ribasushi@cpan.org>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2006-2010 Matt S. Trout <mst@shadowcatsystems.co.uk>
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)
#
########################################################################
########################################################################
# Autodetect unless flag supplied
my $xsa_autodetected;
if (! defined $USE_XS) {
$USE_XS = __CAG_ENV__::NO_CXSA ? 0 : 1;
$xsa_autodetected++;
}
my $maker_templates = {
rw => {
cxsa_call => 'accessors',
pp_generator => sub {
# my ($group, $fieldname) = @_;
my $quoted_fieldname = __CAG_ENV__::perlstring($_[1]);
sprintf <<'EOS', ($_[0], $quoted_fieldname) x 2;
@_ > 1
? shift->set_%s(%s, @_)
: shift->get_%s(%s)
EOS
},
},
ro => {
cxsa_call => 'getters',
pp_generator => sub {
# my ($group, $fieldname) = @_;
my $quoted_fieldname = __CAG_ENV__::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 => {
cxsa_call => 'setters',
pp_generator => sub {
# my ($group, $fieldname) = @_;
my $quoted_fieldname = __CAG_ENV__::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);
# 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');
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) = @_;
$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.
# 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_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 } ) {
# 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;
}
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 (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 minor 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);
}
# 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 $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
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_ENV__::NO_SUBNAME) {
my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
$maker_templates->{$type}{pp_generator}->($group, $field);
$cag_eval->(
"no warnings 'redefine'; sub ${class}::${methname} { $src }; 1",
);
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_generator}->($group, $field);
$cag_eval->( "sub { my \$dummy; sub { \$dummy if 0; $src } }" );
})->()
}
};
1;
|