package Class::Accessor::Grouped;
use strict;
use warnings;
-use Carp::Clan;
-use vars qw($VERSION);
+use Carp ();
+use Scalar::Util ();
+use MRO::Compat;
+
+our $VERSION = '0.09008';
+$VERSION = eval $VERSION;
+
+# when changing minimum version don't forget to adjust L</PERFORMANCE> and
+# the Makefile.PL as well
+our $__minimum_xsa_version;
+BEGIN {
+ $__minimum_xsa_version = '1.06';
+}
+
+our $USE_XS;
+# the unless defined is here so that we can override the value
+# before require/use, *regardless* of the state of $ENV{CAG_USE_XS}
+$USE_XS = $ENV{CAG_USE_XS}
+ unless defined $USE_XS;
+
+# 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 $_)
+ ? (@$_)
+ : ($_, $_)
+ ;
-$VERSION = '0.01';
+ 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
+Class::Accessor::Grouped - Lets you build groups of accessors
=head1 SYNOPSIS
$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;
-}
+ my ($self, $group, @fields) = @_;
-
-{
- no strict 'refs';
- no warnings 'redefine';
-
- sub _mk_group_accessors {
- my($self, $maker, $group, @fields) = @_;
- my $class = ref $self || $self;
-
- # So we don't have to do lots of lookups inside the loop.
- $maker = $self->can($maker) unless ref $maker;
-
- foreach my $field (@fields) {
- if( $field eq 'DESTROY' ) {
- carp("Having a data accessor named DESTROY in ".
- "'$class' is unwise.");
- }
-
- my $name = $field;
-
- ($name, $field) = @$field if ref $field;
-
- my $accessor = $self->$maker($group, $field);
- my $alias = "_${name}_accessor";
-
- #warn "$class $group $field $alias";
-
- *{$class."\:\:$name"} = $accessor;
- #unless defined &{$class."\:\:$field"}
-
- *{$class."\:\:$alias"} = $accessor;
- #unless defined &{$class."\:\:$alias"}
- }
- }
+ $self->_mk_group_accessors('make_group_accessor', $group, @fields);
+ return;
}
=head2 mk_group_ro_accessors
=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
+L</mk_group_accessors> but accessors will throw an error if passed a value
rather than setting the value.
=cut
=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
+L</mk_group_accessors> but accessors will throw an error if not passed a
value rather than getting the value.
=cut
=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<undef> if it elects to install the coderef on its own.
=cut
-sub make_group_accessor {
- my ($class, $group, $field) = @_;
+sub make_group_accessor { $gen_accessor->('rw', @_) }
- my $set = "set_$group";
- my $get = "get_$group";
+=head2 make_group_ro_accessor
- # Build a closure around $field.
- return sub {
- my $self = shift;
+=over 4
- if(@_) {
- return $self->$set($field, @_);
- }
- else {
- return $self->$get($field);
- }
- };
-}
+=item Arguments: $group, $field, $method
-=head2 make_group_ro_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__::$method>, 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
=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_wo_accessors for each entry in @fieldspec. Either returns
+a coderef which will be installed at C<&__PACKAGE__::$method>, or returns
+C<undef> if it elects to install the coderef on its own.
=cut
-sub make_group_ro_accessor {
- my($class, $group, $field) = @_;
+sub make_group_wo_accessor { $gen_accessor->('wo', @_) }
- my $get = "get_$group";
+=head2 get_simple
- return sub {
- my $self = shift;
+=over 4
- if(@_) {
- my $caller = caller;
- croak("'$caller' cannot alter the value of '$field' on ".
- "objects of class '$class'");
- }
- else {
- return $self->$get($field);
- }
- };
+=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 {
+ return $_[0]->{$_[1]};
}
-=head2 make_group_wo_accessor
+=head2 set_simple
=over 4
-=item Arguments: $group, $field
+=item Arguments: $field, $new_value
-Returns: $sub (\CODE)
+Returns: $new_value
=back
-Returns a single write-only accessor in a given group; called by
-mk_group_wo_accessors for each entry in @fieldspec.
+Simple setter for hash-based objects which sets and then returns the value
+for the field name passed as an argument.
=cut
-sub make_group_wo_accessor {
- my($class, $group, $field) = @_;
+sub set_simple {
+ return $_[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.
- my $set = "set_$group";
+=cut
- return sub {
- my $self = shift;
+sub get_inherited {
+ my $class;
- unless (@_) {
- my $caller = caller;
- croak("'$caller' cannot access the value of '$field' on ".
- "objects of class '$class'");
+ if ( defined( $class = Scalar::Util::blessed $_[0] ) ) {
+ if (Scalar::Util::reftype $_[0] eq 'HASH') {
+ return $_[0]->{$_[1]} if exists $_[0]->{$_[1]};
}
else {
- return $self->$set($field, @_);
+ Carp::croak('Cannot get inherited value on an object instance that is not hash-based');
}
+ }
+ else {
+ $class = $_[0];
+ }
+
+ no strict 'refs';
+ 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 $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;
+ }
+
+ for (@{$class.'::__cag_supers__'}) {
+ return ${$_.$cag_slot} if defined(${$_.$cag_slot});
};
+
+ return undef;
}
-=head2 get_simple
+=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 (defined Scalar::Util::blessed $_[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');
+ };
+ } else {
+ no strict 'refs';
+
+ return ${$_[0].'::__cag_'.$_[1]} = $_[2];
+ };
+}
+
+=head2 get_component_class
=over 4
=back
-Simple getter for hash-based objects which returns the value for the field
-name passed as an argument.
+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_simple {
- my ($self, $get) = @_;
- return $self->{$get};
-}
+sub get_component_class {
+ return $_[0]->get_inherited($_[1]);
+};
-=head2 set_simple
+=head2 set_component_class
=over 4
-=item Arguments: $field, $new_value
+=item Arguments: $field, $class
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.
+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_simple {
- my ($self, $set, $val) = @_;
- return $self->{$set} = $val;
-}
+sub set_component_class {
+ if ($_[2]) {
+ local $^W = 0;
+ require Class::Inspector;
+ if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) {
+ eval "require $_[2]";
-1;
+ Carp::croak("Could not load $_[1] '$_[2]': ", $@) if $@;
+ };
+ };
+
+ return $_[0]->set_inherited($_[1], $_[2]);
+};
+
+=head2 get_super_paths
+
+Returns a list of 'parent' or 'super' class names that the current class inherited from.
+
+=cut
+
+sub get_super_paths {
+ return @{mro::get_linear_isa( ref($_[0]) || $_[0] )};
+};
+
+=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 L<< Class::XSAccessor >= 1.06|Class::XSAccessor >> is
+available on your system.
+
+=head2 Benchmark
+
+This is the result of a set/get/set loop benchmark on perl 5.12.1 with
+thread support, showcasing most popular accessor builders: L<Moose>, L<Mouse>,
+L<CAF|Class::Accessor::Fast>, L<CAF_XS|Class::Accessor::Fast::XS>
+and L<XSA|Class::XSAccessor>:
+
+ Rate CAG moOse CAF HANDMADE CAF_XS moUse_XS CAG_XS XSA
+ CAG 1777/s -- -27% -29% -36% -62% -67% -72% -73%
+ moOse 2421/s 36% -- -4% -13% -48% -55% -61% -63%
+ CAF 2511/s 41% 4% -- -10% -47% -53% -60% -61%
+ HANDMADE 2791/s 57% 15% 11% -- -41% -48% -56% -57%
+ CAF_XS 4699/s 164% 94% 87% 68% -- -13% -25% -28%
+ moUse_XS 5375/s 203% 122% 114% 93% 14% -- -14% -18%
+ CAG_XS 6279/s 253% 159% 150% 125% 34% 17% -- -4%
+ XSA 6515/s 267% 169% 159% 133% 39% 21% 4% --
+
+Benchmark program is available in the root of the
+L<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.
+
+While L<Class::XSAccessor> 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<Class::XSAccessor>
+will not be used automatically if you are running under C<MSWin32>.
=head1 AUTHORS
Matt S. Trout <mst@shadowcatsystems.co.uk>
-=head1 LICENSE
+Christopher H. Laco <claco@chrislaco.com>
+
+=head1 CONTRIBUTORS
+
+Caelum: Rafael Kitover <rkitover@cpan.org>
+
+groditi: Guillermo Roditi <groditi@cpan.org>
-You may distribute this code under the same terms as Perl itself.
+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)
+#
+########################################################################
+########################################################################
+
+BEGIN {
+
+ die "Huh?! No minimum C::XSA version?!\n"
+ unless $__minimum_xsa_version;
+
+ local $@;
+ my $err;
+
+
+ $err = eval { require Sub::Name; 1; } ? undef : do {
+ delete $INC{'Sub/Name.pm'}; # because older perls suck
+ $@;
+ };
+ *__CAG_NO_SUBNAME = $err
+ ? sub () { $err }
+ : sub () { 0 }
+ ;
+
+
+ $err = eval {
+ require Class::XSAccessor;
+ Class::XSAccessor->VERSION($__minimum_xsa_version);
+ require Sub::Name;
+ 1;
+ } ? undef : do {
+ delete $INC{'Sub/Name.pm'}; # because older perls suck
+ delete $INC{'Class/XSAccessor.pm'};
+ $@;
+ };
+ *__CAG_NO_CXSA = $err
+ ? sub () { $err }
+ : sub () { 0 }
+ ;
+
+
+ *__CAG_BROKEN_GOTO = ($] < '5.008009')
+ ? sub () { 1 }
+ : sub () { 0 }
+ ;
+
+
+ *__CAG_UNSTABLE_DOLLARAT = ($] < '5.013002')
+ ? sub () { 1 }
+ : sub () { 0 }
+ ;
+
+};
+
+# Autodetect unless flag supplied
+# Class::XSAccessor is segfaulting on win32, in some
+# esoteric heavily-threaded scenarios
+# Win32 users can set $USE_XS/CAG_USE_XS to try to use it anyway
+my $xsa_autodetected;
+if (! defined $USE_XS) {
+ $USE_XS = (!__CAG_NO_CXSA and $^O ne 'MSWin32') ? 1 : 0;
+ $xsa_autodetected++;
+}
+
+my $maker_templates = {
+ rw => {
+ xs_call => 'accessors',
+ pp_code => sub {
+ my $set = "set_$_[0]";
+ my $get = "get_$_[0]";
+ my $field = $_[1];
+ $field =~ s/'/\\'/g;
+
+ "
+ \@_ > 1
+ ? shift->$set('$field', \@_)
+ : shift->$get('$field')
+ "
+ },
+ },
+ ro => {
+ xs_call => 'getters',
+ pp_code => sub {
+ my $get = "get_$_[0]";
+ my $field = $_[1];
+ $field =~ s/'/\\'/g;
+
+ "
+ \@_ == 1
+ ? shift->$get('$field')
+ : do {
+ my \$caller = caller;
+ my \$class = ref \$_[0] || \$_[0];
+ Carp::croak(\"'\$caller' cannot alter the value of '$field' \".
+ \"(read-only attributes of class '\$class')\");
+ }
+ "
+ },
+ },
+ wo => {
+ xs_call => 'setters',
+ pp_code => sub {
+ my $set = "set_$_[0]";
+ my $field = $_[1];
+ $field =~ s/'/\\'/g;
+
+ "
+ \@_ > 1
+ ? shift->$set('$field', \@_)
+ : do {
+ my \$caller = caller;
+ my \$class = ref \$_[0] || \$_[0];
+ Carp::croak(\"'\$caller' cannot access the value of '$field' \".
+ \"(write-only attributes of class '\$class')\");
+ }
+ "
+ },
+ },
+};
+
+
+my ($accessor_maker_cache, $no_xsa_warned_classes);
+
+# can't use pkg_gen to track this stuff, as it doesn't
+# detect superclass mucking
+my $original_simple_getter = __PACKAGE__->can ('get_simple');
+my $original_simple_setter = __PACKAGE__->can ('set_simple');
+
+# Note!!! Unusual signature
+$gen_accessor = sub {
+ my ($type, $class, $group, $field, $methname) = @_;
+ if (my $c = ref $class) {
+ $class = $c;
+ }
+
+
+ # When installing an XSA simple accessor, we need to make sure we are not
+ # short-circuiting a (compile or runtime) get_simple/set_simple override.
+ # What we do here is install a lazy first-access check, which will decide
+ # the ultimate coderef being placed in the accessor slot
+ if ($USE_XS and $group eq 'simple') {
+ my $fq_name = "${class}::${methname}";
+ ($accessor_maker_cache->{xs}{$field}{$type}{$fq_name} ||= do {
+ die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_NO_CXSA )
+ if __CAG_NO_CXSA;
+
+
+ sub { sub {
+ my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0];
+
+ if (
+ $current_class->can('get_simple') == $original_simple_getter
+ &&
+ $current_class->can('set_simple') == $original_simple_setter
+ ) {
+ # nothing has changed, might as well use the XS crefs
+ #
+ # note that by the time this code executes, we already have
+ # *objects* (since XSA works on 'simple' only by definition).
+ # If someone is mucking with the symbol table *after* there
+ # are some objects already - look! many, shiny pieces! :)
+ Class::XSAccessor->import(
+ replace => 1,
+ class => $class,
+ $maker_templates->{$type}{xs_call} => {
+ $methname => $field,
+ },
+ );
+ }
+ else {
+ if (! $xsa_autodetected and ! $no_xsa_warned_classes->{$current_class}++) {
+ # not using Carp since the line where this happens doesn't mean much
+ warn 'Explicitly requested use of Class::XSAccessor disabled for objects of class '
+ . "'$current_class' due to an overriden get_simple and/or set_simple\n";
+ }
+
+ no strict qw/refs/;
+
+ *$fq_name = Sub::Name::subname($fq_name, do {
+ # that's faster than local
+ $USE_XS = 0;
+ my $c = $gen_accessor->($type, $class, 'simple', $field, $methname);
+ $USE_XS = 1;
+ $c;
+ });
+ }
+
+ # older perls segfault if the cref behind the goto throws
+ # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
+ return $current_class->can($methname)->(@_) if __CAG_BROKEN_GOTO;
+
+ goto $current_class->can($methname);
+ }}
+ })->();
+ }
+
+ # no Sub::Name - just install the coderefs directly (compiling every time)
+ elsif (__CAG_NO_SUBNAME) {
+ my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
+ $maker_templates->{$type}{pp_code}->($group, $field);
+
+ no warnings 'redefine';
+ local $@ if __CAG_UNSTABLE_DOLLARAT;
+ eval "sub ${class}::${methname}{$src}";
+
+ undef; # so that no attempt will be made to install anything
+ }
+
+ # a coderef generator with a variable pad (returns a fresh cref on every invocation)
+ else {
+ ($accessor_maker_cache->{pp}{$group}{$field}{$type} ||= do {
+ my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
+ $maker_templates->{$type}{pp_code}->($group, $field);
+
+ local $@ if __CAG_UNSTABLE_DOLLARAT;
+ eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@;
+ })->()
+ }
+};
+
+1;
projects / p5sagit/Class-Accessor-Grouped.git / blobdiff