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
|
package Moose::Meta::Method::Delegation;
our $VERSION = '2.4000';
use strict;
use warnings;
use Scalar::Util 'blessed', 'weaken';
use Try::Tiny;
use parent 'Moose::Meta::Method',
'Class::MOP::Method::Generated';
use Moose::Util 'throw_exception';
sub new {
my $class = shift;
my %options = @_;
( exists $options{attribute} )
|| throw_exception( MustSupplyAnAttributeToConstructWith => params => \%options,
class => $class
);
( blessed( $options{attribute} )
&& $options{attribute}->isa('Moose::Meta::Attribute') )
|| throw_exception( MustSupplyAMooseMetaAttributeInstance => params => \%options,
class => $class
);
( $options{package_name} && $options{name} )
|| throw_exception( MustSupplyPackageNameAndName => params => \%options,
class => $class
);
( $options{delegate_to_method} && ( !ref $options{delegate_to_method} )
|| ( 'CODE' eq ref $options{delegate_to_method} ) )
|| throw_exception( MustSupplyADelegateToMethod => params => \%options,
class => $class
);
exists $options{curried_arguments}
|| ( $options{curried_arguments} = [] );
( $options{curried_arguments} &&
( 'ARRAY' eq ref $options{curried_arguments} ) )
|| throw_exception( MustSupplyArrayRefAsCurriedArguments => params => \%options,
class_name => $class
);
my $self = $class->_new( \%options );
weaken( $self->{'attribute'} );
$self->_initialize_body;
return $self;
}
sub _new {
my $class = shift;
my $options = @_ == 1 ? $_[0] : {@_};
return bless $options, $class;
}
sub curried_arguments { (shift)->{'curried_arguments'} }
sub associated_attribute { (shift)->{'attribute'} }
sub delegate_to_method { (shift)->{'delegate_to_method'} }
sub _initialize_body {
my $self = shift;
my $method_to_call = $self->delegate_to_method;
return $self->{body} = $method_to_call
if ref $method_to_call;
# We don't inline because it's faster, we do it because when the method is
# inlined, any errors thrown because of the delegated method have a _much_
# nicer stack trace, as the trace doesn't include any Moose internals.
$self->{body} = $self->_generate_inline_method;
return;
}
sub _generate_inline_method {
my $self = shift;
my $attr = $self->associated_attribute;
my $delegate = $self->delegate_to_method;
my $method_name = B::perlstring( $self->name );
my $attr_name = B::perlstring( $self->associated_attribute->name );
my $undefined_attr_throw = $self->_inline_throw_exception(
'AttributeValueIsNotDefined',
sprintf( <<'EOF', $method_name, $attr_name ) );
method => $self->meta->find_method_by_name(%s),
instance => $self,
attribute => $self->meta->find_attribute_by_name(%s),
EOF
my $not_an_object_throw = $self->_inline_throw_exception(
'AttributeValueIsNotAnObject',
sprintf( <<'EOF', $method_name, $attr_name ) );
method => $self->meta->find_method_by_name(%s),
instance => $self,
attribute => $self->meta->find_attribute_by_name(%s),
given_value => $proxy,
EOF
my $get_proxy
= $attr->has_read_method ? $attr->get_read_method : '$reader';
my $args = @{ $self->curried_arguments } ? '@curried, @_' : '@_';
my $source = sprintf(
<<'EOF', $get_proxy, $undefined_attr_throw, $not_an_object_throw, $delegate, $args );
sub {
my $self = shift;
my $proxy = $self->%s;
if ( !defined $proxy ) {
%s;
}
elsif ( ref $proxy && !Scalar::Util::blessed($proxy) ) {
%s;
}
return $proxy->%s( %s );
}
EOF
my $description
= 'inline delegation in '
. $self->package_name . ' for '
. $attr->name . '->'
. $delegate;
my $definition = $attr->definition_context;
# While all attributes created in the usual way (via Moose's has()) will
# define this, there's no guarantee that this must be defined. For
# example, when Moo inflates a class to Moose it does not define these (as
# of Moo 2.003).
$description .= " (attribute declared in $definition->{file} at line $definition->{line})"
if defined $definition->{file} && defined $definition->{line};
return try {
$self->_compile_code(
source => $source,
description => $description,
);
}
catch {
$self->_throw_exception(
'CouldNotGenerateInlineAttributeMethod',
instance => $self,
error => $_,
option => 'handles for ' . $attr->name . '->' . $delegate,
);
};
}
sub _eval_environment {
my $self = shift;
my %env;
if ( @{ $self->curried_arguments } ) {
$env{'@curried'} = $self->curried_arguments;
}
unless ( $self->associated_attribute->has_read_method ) {
$env{'$reader'} = \( $self->_get_delegate_accessor );
}
return \%env;
}
sub _get_delegate_accessor {
my $self = shift;
my $accessor = $self->associated_attribute->get_read_method_ref;
# If it's blessed it's a Moose::Meta::Method
return blessed $accessor
? ( $accessor->body )
: $accessor;
}
1;
# ABSTRACT: A Moose Method metaclass for delegation methods
__END__
=pod
=encoding UTF-8
=head1 NAME
Moose::Meta::Method::Delegation - A Moose Method metaclass for delegation methods
=head1 VERSION
version 2.4000
=head1 DESCRIPTION
This is a subclass of L<Moose::Meta::Method> for delegation
methods.
=head1 METHODS
=head2 Moose::Meta::Method::Delegation->new(%options)
This creates the delegation methods based on the provided C<%options>.
=over 4
=item I<attribute>
This must be an instance of C<Moose::Meta::Attribute> which this
accessor is being generated for. This options is B<required>.
=item I<delegate_to_method>
The method in the associated attribute's value to which we
delegate. This can be either a method name or a code reference.
=item I<curried_arguments>
An array reference of arguments that will be prepended to the argument list for
any call to the delegating method.
=back
=head2 $metamethod->associated_attribute
Returns the attribute associated with this method.
=head2 $metamethod->curried_arguments
Return any curried arguments that will be passed to the delegated method.
=head2 $metamethod->delegate_to_method
Returns the method to which this method delegates, as passed to the
constructor.
=head1 BUGS
See L<Moose/BUGS> for details on reporting bugs.
=head1 AUTHORS
=over 4
=item *
Stevan Little <stevan@cpan.org>
=item *
Dave Rolsky <autarch@urth.org>
=item *
Jesse Luehrs <doy@cpan.org>
=item *
Shawn M Moore <sartak@cpan.org>
=item *
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
=item *
Karen Etheridge <ether@cpan.org>
=item *
Florian Ragwitz <rafl@debian.org>
=item *
Hans Dieter Pearcey <hdp@cpan.org>
=item *
Chris Prather <chris@prather.org>
=item *
Matt S Trout <mstrout@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2006 by Infinity Interactive, Inc.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|