1 package Class::Accessor::Grouped;
6 use Module::Runtime ();
9 # use M::R to work around the 5.8 require bugs
11 Module::Runtime::require_module('MRO::Compat');
18 our $VERSION = '0.10006';
19 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
21 # when changing minimum version don't forget to adjust Makefile.PL as well
22 our $__minimum_xsa_version;
23 BEGIN { $__minimum_xsa_version = '1.13' }
26 # the unless defined is here so that we can override the value
27 # before require/use, *regardless* of the state of $ENV{CAG_USE_XS}
28 $USE_XS = $ENV{CAG_USE_XS}
29 unless defined $USE_XS;
34 die "Huh?! No minimum C::XSA version?!\n"
35 unless $__minimum_xsa_version;
40 # individual (one const at a time) imports so we are 5.6.2 compatible
41 # if we can - why not ;)
42 constant->import( NO_SUBNAME => eval {
43 Module::Runtime::require_module('Sub::Name')
46 constant->import( NO_CXSA => ( !NO_SUBNAME() and eval {
47 Module::Runtime::use_module('Class::XSAccessor' => $__minimum_xsa_version)
50 constant->import( BROKEN_GOTO => ($] < '5.008009') ? 1 : 0 );
52 constant->import( UNSTABLE_DOLLARAT => ($] < '5.013002') ? 1 : 0 );
54 constant->import( TRACK_UNDEFER_FAIL => (
55 $INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'}
57 $0 =~ m|^ x?t / .+ \.t $|x
61 # Yes this method is undocumented
62 # Yes it should be a private coderef like all the rest at the end of this file
63 # No we can't do that (yet) because the DBIC-CDBI compat layer overrides it
65 sub _mk_group_accessors {
66 my($self, $maker, $group, @fields) = @_;
67 my $class = Scalar::Util::blessed $self || $self;
70 no warnings 'redefine';
72 # So we don't have to do lots of lookups inside the loop.
73 $maker = $self->can($maker) unless ref $maker;
77 my ($name, $field) = (ref $_) ? (@$_) : ($_, $_);
79 for (qw/DESTROY AUTOLOAD CLONE/) {
80 Carp::carp("Having a data accessor named '$name' in '$class' is unwise.")
84 my $alias = "_${name}_accessor";
86 for my $meth ($name, $alias) {
88 # the maker may elect to not return anything, meaning it already
89 # installed the coderef for us (e.g. lack of Sub::Name)
90 my $cref = $self->$maker($group, $field, $meth)
93 my $fq_meth = "${class}::${meth}";
95 *$fq_meth = Sub::Name::subname($fq_meth, $cref);
96 #unless defined &{$class."\:\:$field"}
101 # coderef is setup at the end for clarity
106 Class::Accessor::Grouped - Lets you build groups of accessors
110 use base 'Class::Accessor::Grouped';
112 # make basic accessors for objects
113 __PACKAGE__->mk_group_accessors(simple => qw(id name email));
115 # make accessor that works for objects and classes
116 __PACKAGE__->mk_group_accessors(inherited => 'awesome_level');
120 This class lets you build groups of accessors that will call different
125 =head2 mk_group_accessors
127 __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]);
131 =item Arguments: $group, @fieldspec
137 Creates a set of accessors in a given group.
139 $group is the name of the accessor group for the generated accessors; they
140 will call get_$group($field) on get and set_$group($field, $value) on set.
142 If you want to mimic Class::Accessor's mk_accessors $group has to be 'simple'
143 to tell Class::Accessor::Grouped to use its own get_simple and set_simple
146 @fieldspec is a list of field/accessor names; if a fieldspec is a scalar
147 this is used as both field and accessor name, if a listref it is expected to
148 be of the form [ $accessor, $field ].
152 sub mk_group_accessors {
153 my ($self, $group, @fields) = @_;
155 $self->_mk_group_accessors('make_group_accessor', $group, @fields);
159 =head2 mk_group_ro_accessors
161 __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]);
165 =item Arguments: $group, @fieldspec
171 Creates a set of read only accessors in a given group. Identical to
172 L</mk_group_accessors> but accessors will throw an error if passed a value
173 rather than setting the value.
177 sub mk_group_ro_accessors {
178 my($self, $group, @fields) = @_;
180 $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields);
184 =head2 mk_group_wo_accessors
186 __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]);
190 =item Arguments: $group, @fieldspec
196 Creates a set of write only accessors in a given group. Identical to
197 L</mk_group_accessors> but accessors will throw an error if not passed a
198 value rather than getting the value.
202 sub mk_group_wo_accessors {
203 my($self, $group, @fields) = @_;
205 $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields);
213 =item Arguments: $field
219 Simple getter for hash-based objects which returns the value for the field
220 name passed as an argument.
232 =item Arguments: $field, $new_value
238 Simple setter for hash-based objects which sets and then returns the value
239 for the field name passed as an argument.
244 $_[0]->{$_[1]} = $_[2];
252 =item Arguments: $field
258 Simple getter for Classes and hash-based objects which returns the value for
259 the field name passed as an argument. This behaves much like
260 L<Class::Data::Accessor> where the field can be set in a base class,
261 inherited and changed in subclasses, and inherited and changed for object
269 if ( defined( $class = Scalar::Util::blessed $_[0] ) ) {
270 if (Scalar::Util::reftype $_[0] eq 'HASH') {
271 return $_[0]->{$_[1]} if exists $_[0]->{$_[1]};
274 Carp::croak('Cannot get inherited value on an object instance that is not hash-based');
282 no warnings 'uninitialized';
284 my $cag_slot = '::__cag_'. $_[1];
285 return ${$class.$cag_slot} if defined(${$class.$cag_slot});
287 do { return ${$_.$cag_slot} if defined(${$_.$cag_slot}) }
288 for $_[0]->get_super_paths;
297 =item Arguments: $field, $new_value
303 Simple setter for Classes and hash-based objects which sets and then returns
304 the value for the field name passed as an argument. When called on a hash-based
305 object it will set the appropriate hash key value. When called on a class, it
306 will set a class level variable.
308 B<Note:>: This method will die if you try to set an object variable on a non
314 if (defined Scalar::Util::blessed $_[0]) {
315 if (Scalar::Util::reftype $_[0] eq 'HASH') {
316 return $_[0]->{$_[1]} = $_[2];
318 Carp::croak('Cannot set inherited value on an object instance that is not hash-based');
323 ${$_[0].'::__cag_'.$_[1]} = $_[2];
326 =head2 get_component_class
330 =item Arguments: $field
336 Gets the value of the specified component class.
338 __PACKAGE__->mk_group_accessors('component_class' => 'result_class');
340 $self->result_class->method();
343 $self->get_component_class('result_class')->method();
347 sub get_component_class {
348 $_[0]->get_inherited($_[1]);
351 =head2 set_component_class
355 =item Arguments: $field, $class
361 Inherited accessor that automatically loads the specified class before setting
362 it. This method will die if the specified class could not be loaded.
364 __PACKAGE__->mk_group_accessors('component_class' => 'result_class');
365 __PACKAGE__->result_class('MyClass');
367 $self->result_class->method();
371 sub set_component_class {
372 if (defined $_[2] and length $_[2]) {
373 # disable warnings, and prevent $_ being eaten away by a behind-the-scenes
377 if (__CAG_ENV__::UNSTABLE_DOLLARAT) {
381 eval { Module::Runtime::use_package_optimistically($_[2]) }
384 Carp::croak("Could not load $_[1] '$_[2]': $err") if defined $err;
388 eval { Module::Runtime::use_package_optimistically($_[2]) }
389 or Carp::croak("Could not load $_[1] '$_[2]': $@");
393 $_[0]->set_inherited($_[1], $_[2]);
396 =head1 INTERNAL METHODS
398 These methods are documented for clarity, but are never meant to be called
399 directly, and are not really meant for overriding either.
401 =head2 get_super_paths
403 Returns a list of 'parent' or 'super' class names that the current class
404 inherited from. This is what drives the traversal done by L</get_inherited>.
408 sub get_super_paths {
409 # get_linear_isa returns the class itself as the 1st element
410 # use @_ as a pre-allocated scratch array
411 (undef, @_) = @{mro::get_linear_isa( length( ref($_[0]) ) ? ref($_[0]) : $_[0] )};
415 =head2 make_group_accessor
417 __PACKAGE__->make_group_accessor('simple', 'hair_length', 'hair_length');
418 __PACKAGE__->make_group_accessor('simple', 'hc', 'hair_color');
422 =item Arguments: $group, $field, $accessor
424 Returns: \&accessor_coderef ?
428 Called by mk_group_accessors for each entry in @fieldspec. Either returns
429 a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
430 C<undef> if it elects to install the coderef on its own.
434 sub make_group_accessor { $gen_accessor->('rw', @_) }
436 =head2 make_group_ro_accessor
438 __PACKAGE__->make_group_ro_accessor('simple', 'birthdate', 'birthdate');
439 __PACKAGE__->make_group_ro_accessor('simple', 'ssn', 'social_security_number');
443 =item Arguments: $group, $field, $accessor
445 Returns: \&accessor_coderef ?
449 Called by mk_group_ro_accessors for each entry in @fieldspec. Either returns
450 a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
451 C<undef> if it elects to install the coderef on its own.
455 sub make_group_ro_accessor { $gen_accessor->('ro', @_) }
457 =head2 make_group_wo_accessor
459 __PACKAGE__->make_group_wo_accessor('simple', 'lie', 'lie');
460 __PACKAGE__->make_group_wo_accessor('simple', 'subj', 'subject');
464 =item Arguments: $group, $field, $accessor
466 Returns: \&accessor_coderef ?
470 Called by mk_group_wo_accessors for each entry in @fieldspec. Either returns
471 a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns
472 C<undef> if it elects to install the coderef on its own.
476 sub make_group_wo_accessor { $gen_accessor->('wo', @_) }
481 To provide total flexibility L<Class::Accessor::Grouped> calls methods
482 internally while performing get/set actions, which makes it noticeably
483 slower than similar modules. To compensate, this module will automatically
484 use the insanely fast L<Class::XSAccessor> to generate the C<simple>-group
485 accessors if this module is available on your system.
489 This is the result of a set/get/set loop benchmark on perl 5.12.1 with
490 thread support, showcasing most popular accessor builders: L<Moose>, L<Mouse>,
491 L<Moo>, L<CAF|Class::Accessor::Fast>, L<CAF_XS|Class::Accessor::Fast::XS>,
492 L<XSA|Class::XSAccessor>, and L<CAF_XSA|Class::XSAccessor::Compat>:
494 Rate CAG moOse CAF moUse moo HANDMADE CAF_XS moUse_XS moo_XS CAF_XSA XSA CAG_XS
495 CAG 169/s -- -21% -24% -32% -32% -34% -59% -63% -67% -67% -67% -67%
496 moOse 215/s 27% -- -3% -13% -13% -15% -48% -53% -58% -58% -58% -58%
497 CAF 222/s 31% 3% -- -10% -10% -13% -46% -52% -57% -57% -57% -57%
498 moUse 248/s 46% 15% 11% -- -0% -3% -40% -46% -52% -52% -52% -52%
499 moo 248/s 46% 15% 11% 0% -- -3% -40% -46% -52% -52% -52% -52%
500 HANDMADE 255/s 50% 18% 14% 3% 3% -- -38% -45% -50% -51% -51% -51%
501 CAF_XS 411/s 143% 91% 85% 66% 66% 61% -- -11% -20% -20% -21% -21%
502 moUse_XS 461/s 172% 114% 107% 86% 86% 81% 12% -- -10% -11% -11% -11%
503 moo_XS 514/s 204% 139% 131% 107% 107% 102% 25% 12% -- -0% -1% -1%
504 CAF_XSA 516/s 205% 140% 132% 108% 108% 103% 26% 12% 0% -- -0% -0%
505 XSA 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% -- -0%
506 CAG_XS 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% 0% --
508 Benchmark program is available in the root of the
509 L<repository|http://search.cpan.org/dist/Class-Accessor-Grouped/>:
511 =head2 Notes on Class::XSAccessor
513 You can force (or disable) the use of L<Class::XSAccessor> before creating a
514 particular C<simple> accessor by either manipulating the global variable
515 C<$Class::Accessor::Grouped::USE_XS> to true or false (preferably with
516 L<localization|perlfunc/local>, or you can do so before runtime via the
517 C<CAG_USE_XS> environment variable.
519 Since L<Class::XSAccessor> has no knowledge of L</get_simple> and
520 L</set_simple> this module does its best to detect if you are overriding
521 one of these methods and will fall back to using the perl version of the
522 accessor in order to maintain consistency. However be aware that if you
523 enable use of C<Class::XSAccessor> (automatically or explicitly), create
524 an object, invoke a simple accessor on that object, and B<then> manipulate
525 the symbol table to install a C<get/set_simple> override - you get to keep
530 Matt S. Trout <mst@shadowcatsystems.co.uk>
532 Christopher H. Laco <claco@chrislaco.com>
536 Caelum: Rafael Kitover <rkitover@cpan.org>
538 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
540 groditi: Guillermo Roditi <groditi@cpan.org>
542 Jason Plum <jason.plum@bmmsi.com>
544 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
547 =head1 COPYRIGHT & LICENSE
549 Copyright (c) 2006-2010 Matt S. Trout <mst@shadowcatsystems.co.uk>
551 This program is free software; you can redistribute it and/or modify
552 it under the same terms as perl itself.
556 ########################################################################
557 ########################################################################
558 ########################################################################
560 # Here be many angry dragons
561 # (all code is in private coderefs since everything inherits CAG)
563 ########################################################################
564 ########################################################################
566 # Autodetect unless flag supplied
567 my $xsa_autodetected;
568 if (! defined $USE_XS) {
569 $USE_XS = __CAG_ENV__::NO_CXSA ? 0 : 1;
573 my $maker_templates = {
575 xs_call => 'accessors',
577 my $set = "set_$_[0]";
578 my $get = "get_$_[0]";
584 ? shift->$set('$field', \@_)
585 : shift->$get('$field')
590 xs_call => 'getters',
592 my $get = "get_$_[0]";
598 ? shift->$get('$field')
600 my \$caller = caller;
601 my \$class = ref \$_[0] || \$_[0];
602 Carp::croak(\"'\$caller' cannot alter the value of '$field' \".
603 \"(read-only attributes of class '\$class')\");
609 xs_call => 'setters',
611 my $set = "set_$_[0]";
617 ? shift->$set('$field', \@_)
619 my \$caller = caller;
620 my \$class = ref \$_[0] || \$_[0];
621 Carp::croak(\"'\$caller' cannot access the value of '$field' \".
622 \"(write-only attributes of class '\$class')\");
630 my ($accessor_maker_cache, $no_xsa_warned_classes);
632 # can't use pkg_gen to track this stuff, as it doesn't
633 # detect superclass mucking
634 my $original_simple_getter = __PACKAGE__->can ('get_simple');
635 my $original_simple_setter = __PACKAGE__->can ('set_simple');
637 # Note!!! Unusual signature
638 $gen_accessor = sub {
639 my ($type, $class, $group, $field, $methname) = @_;
640 if (my $c = Scalar::Util::blessed( $class )) {
644 # When installing an XSA simple accessor, we need to make sure we are not
645 # short-circuiting a (compile or runtime) get_simple/set_simple override.
646 # What we do here is install a lazy first-access check, which will decide
647 # the ultimate coderef being placed in the accessor slot
649 # Also note that the *original* class will always retain this shim, as
650 # different branches inheriting from it may have different overrides.
651 # Thus the final method (properly labeled and all) is installed in the
652 # calling-package's namespace
653 if ($USE_XS and $group eq 'simple') {
654 die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_ENV__::NO_CXSA )
655 if __CAG_ENV__::NO_CXSA;
657 my ($expected_cref, $cached_implementation);
658 my $ret = $expected_cref = sub {
659 my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0];
661 # $cached_implementation will be set only if the shim got
662 # 'around'ed, in which case it is handy to avoid re-running
663 # this block over and over again
664 my $resolved_implementation = $cached_implementation->{$current_class} || do {
666 ($current_class->can('get_simple')||0) == $original_simple_getter
668 ($current_class->can('set_simple')||0) == $original_simple_setter
670 # nothing has changed, might as well use the XS crefs
672 # note that by the time this code executes, we already have
673 # *objects* (since XSA works on 'simple' only by definition).
674 # If someone is mucking with the symbol table *after* there
675 # are some objects already - look! many, shiny pieces! :)
677 # The weird breeder thingy is because XSA does not have an
678 # interface returning *just* a coderef, without installing it
680 Class::XSAccessor->import(
682 class => '__CAG__XSA__BREEDER__',
683 $maker_templates->{$type}{xs_call} => {
687 __CAG__XSA__BREEDER__->can($methname);
690 if (! $xsa_autodetected and ! $no_xsa_warned_classes->{$current_class}++) {
691 # not using Carp since the line where this happens doesn't mean much
692 warn 'Explicitly requested use of Class::XSAccessor disabled for objects of class '
693 . "'$current_class' inheriting from '$class' due to an overriden get_simple and/or "
698 # that's faster than local
700 my $c = $gen_accessor->($type, $class, 'simple', $field, $methname);
707 # if after this shim was created someone wrapped it with an 'around',
708 # we can not blindly reinstall the method slot - we will destroy the
709 # wrapper. Silently chain execution further...
710 if ( !$expected_cref or $expected_cref != ($current_class->can($methname)||0) ) {
712 # there is no point in re-determining it on every subsequent call,
713 # just store for future reference
714 $cached_implementation->{$current_class} ||= $resolved_implementation;
716 # older perls segfault if the cref behind the goto throws
717 # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
718 return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
720 goto $resolved_implementation;
723 if (__CAG_ENV__::TRACK_UNDEFER_FAIL) {
724 my $deferred_calls_seen = do {
726 \%{"${current_class}::__cag_deferred_xs_shim_invocations"}
728 my @cframe = caller(0);
729 if (my $already_seen = $deferred_calls_seen->{$cframe[3]}) {
731 "Deferred version of method $cframe[3] invoked more than once (originally "
732 . "invoked at $already_seen). This is a strong indication your code has "
733 . 'cached the original ->can derived method coderef, and is using it instead '
734 . 'of the proper method re-lookup, causing performance regressions'
738 $deferred_calls_seen->{$cframe[3]} = "$cframe[1] line $cframe[2]";
742 # install the resolved implementation into the code slot so we do not
743 # come here anymore (hopefully)
744 # since XSAccessor was available - so is Sub::Name
747 no warnings 'redefine';
749 my $fq_name = "${current_class}::${methname}";
750 *$fq_name = Sub::Name::subname($fq_name, $resolved_implementation);
752 # need to update what the shim expects too *in case* its
753 # ->can was cached for some moronic reason
754 $expected_cref = $resolved_implementation;
755 Scalar::Util::weaken($expected_cref);
758 # older perls segfault if the cref behind the goto throws
759 # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
760 return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
762 goto $resolved_implementation;
765 Scalar::Util::weaken($expected_cref); # to break the self-reference
769 # no Sub::Name - just install the coderefs directly (compiling every time)
770 elsif (__CAG_ENV__::NO_SUBNAME) {
771 my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
772 $maker_templates->{$type}{pp_code}->($group, $field);
774 no warnings 'redefine';
775 local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
776 eval "sub ${class}::${methname} { $src }";
778 undef; # so that no further attempt will be made to install anything
781 # a coderef generator with a variable pad (returns a fresh cref on every invocation)
783 ($accessor_maker_cache->{pp}{$type}{$group}{$field} ||= do {
784 my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
785 $maker_templates->{$type}{pp_code}->($group, $field);
787 local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
788 eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@;