use warnings;
use Carp ();
use Scalar::Util ();
-use MRO::Compat;
-our $VERSION = '0.10001';
+BEGIN {
+ if ($] < 5.009_005) {
+ require MRO::Compat;
+ }
+ else {
+ require mro;
+ }
+}
+
+our $VERSION = '0.10005';
$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
-# when changing minimum version don't forget to adjust L</PERFORMANCE> and
-# the Makefile.PL as well
+# when changing minimum version don't forget to adjust Makefile.PL as well
our $__minimum_xsa_version;
-BEGIN {
- $__minimum_xsa_version = '1.06';
-}
+BEGIN { $__minimum_xsa_version = '1.13' }
our $USE_XS;
# the unless defined is here so that we can override the value
=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
=head2 mk_group_accessors
+ __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]);
+
=over 4
=item Arguments: $group, @fieldspec
=head2 mk_group_ro_accessors
+ __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]);
+
=over 4
=item Arguments: $group, @fieldspec
=head2 mk_group_wo_accessors
+ __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]);
+
=over 4
=item Arguments: $group, @fieldspec
$self->_mk_group_accessors('make_group_wo_accessor', $group, @fields);
}
-=head2 make_group_accessor
-
-=over 4
-
-=item Arguments: $group, $field, $method
-
-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__::$method>, 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
-
-=over 4
-
-=item Arguments: $group, $field, $method
-
-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, $method
-
-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__::$method>, or returns
-C<undef> if it elects to install the coderef on its own.
-
-=cut
-
-sub make_group_wo_accessor { $gen_accessor->('wo', @_) }
-
=head2 get_simple
=over 4
return $_[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.
+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
return @{mro::get_linear_isa( 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 L<< Class::XSAccessor >= 1.06|Class::XSAccessor >> is
-available on your system.
+accessors if this module is available on your system.
=head2 Benchmark
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>
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>
delete $INC{'Sub/Name.pm'}; # because older perls suck
$@;
};
- *__CAG_NO_SUBNAME = $err
+ *__CAG_ENV__::NO_SUBNAME = $err
? sub () { $err }
: sub () { 0 }
;
delete $INC{'Class/XSAccessor.pm'};
$@;
};
- *__CAG_NO_CXSA = $err
+ *__CAG_ENV__::NO_CXSA = $err
? sub () { $err }
: sub () { 0 }
;
- *__CAG_BROKEN_GOTO = ($] < '5.008009')
+ *__CAG_ENV__::BROKEN_GOTO = ($] < '5.008009')
? sub () { 1 }
: sub () { 0 }
;
- *__CAG_UNSTABLE_DOLLARAT = ($] < '5.013002')
+ *__CAG_ENV__::UNSTABLE_DOLLARAT = ($] < '5.013002')
? sub () { 1 }
: sub () { 0 }
;
- *__CAG_TRACK_UNDEFER_FAIL = (
+ *__CAG_ENV__::TRACK_UNDEFER_FAIL = (
$INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'}
and
$0 =~ m|^ x?t / .+ \.t $|x
}
# 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;
+ $USE_XS = __CAG_ENV__::NO_CXSA ? 0 : 1;
$xsa_autodetected++;
}
# 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;
+ die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_ENV__::NO_CXSA )
+ if __CAG_ENV__::NO_CXSA;
- return sub {
+ my ($expected_cref, $cached_implementation);
+ my $ret = $expected_cref = sub {
my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0];
- if (__CAG_TRACK_UNDEFER_FAIL) {
+ # $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_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"}
}
}
- 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 => $current_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' inheriting from '$class' due to an overriden get_simple and/or "
- . "set_simple\n";
- }
-
+ # 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, do {
- # that's faster than local
- $USE_XS = 0;
- my $c = $gen_accessor->($type, $class, 'simple', $field, $methname);
- $USE_XS = 1;
- $c;
- });
+ *$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 $current_class->can($methname)->(@_) if __CAG_BROKEN_GOTO;
+ return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO;
- goto $current_class->can($methname);
+ 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) {
+ elsif (__CAG_ENV__::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;
+ local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
eval "sub ${class}::${methname} { $src }";
undef; # so that no further attempt will be made to install anything
my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||=
$maker_templates->{$type}{pp_code}->($group, $field);
- local $@ if __CAG_UNSTABLE_DOLLARAT;
+ local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT;
eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@;
})->()
}
projects / p5sagit/Class-Accessor-Grouped.git / blobdiff