2 package Moose::Meta::Method::Accessor;
8 $VERSION = eval $VERSION;
9 our $AUTHORITY = 'cpan:STEVAN';
11 use base 'Moose::Meta::Method',
12 'Class::MOP::Method::Accessor';
16 ( ref $self && $self->associated_attribute ) || $self->SUPER::_error_thrower();
20 my ( $self, $source ) = @_;
22 my $environment = $self->_eval_environment;
24 my ( $code, $e ) = $self->_compile_code( environment => $environment, code => $source );
27 "Could not create writer for '${\$self->associated_attribute->name}' because $e \n code: $source",
28 error => $e, data => $source )
34 sub _eval_environment {
37 my $attr = $self->associated_attribute;
38 my $type_constraint_obj = $attr->type_constraint;
43 '$type_constraint_obj' => \$type_constraint_obj,
44 '$type_constraint' => \(
46 ? $type_constraint_obj->_compiled_type_constraint
52 sub _generate_accessor_method_inline {
54 my $attr = $self->associated_attribute;
56 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
58 $self->_eval_code('sub { ' . "\n"
59 . $self->_inline_pre_body(@_) . "\n"
60 . 'if (scalar(@_) >= 2) {' . "\n"
61 . $self->_inline_copy_value . "\n"
62 . $self->_inline_check_required . "\n"
63 . $self->_inline_check_coercion($value_name) . "\n"
64 . $self->_inline_check_constraint($value_name) . "\n"
65 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
66 . $self->_inline_store($inv, $value_name) . "\n"
67 . $self->_inline_trigger($inv, $value_name, '@old') . "\n"
69 . $self->_inline_check_lazy($inv) . "\n"
70 . $self->_inline_post_body(@_) . "\n"
71 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
75 sub _generate_writer_method_inline {
77 my $attr = $self->associated_attribute;
79 my $slot_access = $self->_inline_get($inv);
80 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
82 $self->_eval_code('sub { '
83 . $self->_inline_pre_body(@_)
84 . $self->_inline_copy_value
85 . $self->_inline_check_required
86 . $self->_inline_check_coercion($value_name)
87 . $self->_inline_check_constraint($value_name)
88 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
89 . $self->_inline_store($inv, $value_name)
90 . $self->_inline_post_body(@_)
91 . $self->_inline_trigger($inv, $value_name, '@old')
95 sub _generate_reader_method_inline {
97 my $attr = $self->associated_attribute;
99 my $slot_access = $self->_inline_get($inv);
101 $self->_eval_code('sub {'
102 . $self->_inline_pre_body(@_)
103 . $self->_inline_throw_error('"Cannot assign a value to a read-only accessor"', 'data => \@_') . ' if @_ > 1;'
104 . $self->_inline_check_lazy($inv)
105 . $self->_inline_post_body(@_)
106 . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
110 sub _inline_copy_value {
111 return '' unless shift->_value_needs_copy;
112 return 'my $val = $_[1];'
115 sub _value_needs_copy {
116 my $attr = (shift)->associated_attribute;
117 return $attr->should_coerce;
120 sub _instance_is_inlinable {
122 return $self->associated_attribute->associated_class->instance_metaclass->is_inlinable;
125 sub _generate_reader_method {
127 $self->_instance_is_inlinable ? $self->_generate_reader_method_inline(@_)
128 : $self->SUPER::_generate_reader_method(@_);
131 sub _generate_writer_method {
133 $self->_instance_is_inlinable ? $self->_generate_writer_method_inline(@_)
134 : $self->SUPER::_generate_writer_method(@_);
137 sub _generate_accessor_method {
139 $self->_instance_is_inlinable ? $self->_generate_accessor_method_inline(@_)
140 : $self->SUPER::_generate_accessor_method(@_);
143 sub _generate_predicate_method {
145 $self->_instance_is_inlinable ? $self->_generate_predicate_method_inline(@_)
146 : $self->SUPER::_generate_predicate_method(@_);
149 sub _generate_clearer_method {
151 $self->_instance_is_inlinable ? $self->_generate_clearer_method_inline(@_)
152 : $self->SUPER::_generate_clearer_method(@_);
155 sub _inline_pre_body { '' }
156 sub _inline_post_body { '' }
158 sub _inline_check_constraint {
159 my ($self, $value) = @_;
161 my $attr = $self->associated_attribute;
163 return '' unless $attr->has_type_constraint;
165 my $attr_name = quotemeta( $attr->name );
167 qq{\$type_constraint->($value) || } . $self->_inline_throw_error(qq{"Attribute ($attr_name) does not pass the type constraint because: " . \$type_constraint_obj->get_message($value)}, "data => $value") . ";";
170 sub _inline_check_coercion {
171 my ($self, $value) = @_;
173 my $attr = $self->associated_attribute;
175 return '' unless $attr->should_coerce && $attr->type_constraint->has_coercion;
176 return "$value = \$attr->type_constraint->coerce($value);";
179 sub _inline_check_required {
181 my $attr = $self->associated_attribute;
183 return '' unless $attr->is_required;
185 my $attr_name = quotemeta( $attr->name );
187 return qq{(\@_ >= 2) || } . $self->_inline_throw_error(qq{"Attribute ($attr_name) is required, so cannot be set to undef"}) . ';' # defined $_[1] is not good enough
190 sub _inline_check_lazy {
191 my ($self, $instance) = @_;
193 my $attr = $self->associated_attribute;
195 return '' unless $attr->is_lazy;
197 my $slot_exists = $self->_inline_has($instance);
199 my $code = 'unless (' . $slot_exists . ') {' . "\n";
200 if ($attr->has_type_constraint) {
201 if ($attr->has_default || $attr->has_builder) {
202 if ($attr->has_default) {
203 $code .= ' my $default = $attr->default(' . $instance . ');'."\n";
205 elsif ($attr->has_builder) {
206 $code .= ' my $default;'."\n".
207 ' if(my $builder = '.$instance.'->can($attr->builder)){ '."\n".
208 ' $default = '.$instance.'->$builder; '. "\n } else {\n" .
209 ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name') .
212 $code .= $self->_inline_check_coercion('$default') . "\n";
213 $code .= $self->_inline_check_constraint('$default') . "\n";
214 $code .= ' ' . $self->_inline_init_slot($attr, $instance, '$default') . "\n";
217 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
221 if ($attr->has_default) {
222 $code .= ' ' . $self->_inline_init_slot($attr, $instance, ('$attr->default(' . $instance . ')')) . "\n";
224 elsif ($attr->has_builder) {
225 $code .= ' if (my $builder = '.$instance.'->can($attr->builder)) { ' . "\n"
226 . ' ' . $self->_inline_init_slot($attr, $instance, ($instance . '->$builder'))
228 . ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name')
232 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
239 sub _inline_init_slot {
240 my ($self, $attr, $inv, $value) = @_;
241 if ($attr->has_initializer) {
242 return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
245 return $self->_inline_store($inv, $value);
250 my ($self, $instance, $value) = @_;
251 my $attr = $self->associated_attribute;
253 my $mi = $attr->associated_class->get_meta_instance;
255 my $code = $mi->inline_set_slot_value($instance, $attr->slots, $value) . ";";
256 $code .= $mi->inline_weaken_slot_value($instance, $attr->slots, $value) . ";"
257 if $attr->is_weak_ref;
261 sub _inline_get_old_value_for_trigger {
262 my ( $self, $instance ) = @_;
264 my $attr = $self->associated_attribute;
265 return '' unless $attr->has_trigger;
267 my $mi = $attr->associated_class->get_meta_instance;
268 my $pred = $mi->inline_is_slot_initialized($instance, $attr->name);
273 . $self->_inline_get($instance) . q{ : ()} . ";\n";
276 sub _inline_trigger {
277 my ($self, $instance, $value, $old_value) = @_;
278 my $attr = $self->associated_attribute;
279 return '' unless $attr->has_trigger;
280 return sprintf('$attr->trigger->(%s, %s, %s);', $instance, $value, $old_value);
284 my ($self, $instance) = @_;
285 my $attr = $self->associated_attribute;
287 my $mi = $attr->associated_class->get_meta_instance;
289 return $mi->inline_get_slot_value($instance, $attr->slots);
293 my ($self, $instance) = @_;
294 my $attr = $self->associated_attribute;
296 my $mi = $attr->associated_class->get_meta_instance;
298 return $mi->inline_slot_access($instance, $attr->slots);
302 my ($self, $instance) = @_;
303 my $attr = $self->associated_attribute;
305 my $mi = $attr->associated_class->get_meta_instance;
307 return $mi->inline_is_slot_initialized($instance, $attr->slots);
310 sub _inline_auto_deref {
311 my ( $self, $ref_value ) = @_;
312 my $attr = $self->associated_attribute;
314 return $ref_value unless $attr->should_auto_deref;
316 my $type_constraint = $attr->type_constraint;
319 if ($type_constraint->is_a_type_of('ArrayRef')) {
322 elsif ($type_constraint->is_a_type_of('HashRef')) {
326 $self->throw_error( "Can not auto de-reference the type constraint '"
327 . quotemeta( $type_constraint->name )
328 . "'", type_constraint => $type_constraint );
331 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
342 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
346 This class is a subclass of L<Class::MOP::Method::Accessor> that
347 provides additional Moose-specific functionality, all of which is
350 To understand this class, you should read the the
351 L<Class::MOP::Method::Accessor> documentation.
355 See L<Moose/BUGS> for details on reporting bugs.
359 Stevan Little E<lt>stevan@iinteractive.comE<gt>
361 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
363 =head1 COPYRIGHT AND LICENSE
365 Copyright 2006-2010 by Infinity Interactive, Inc.
367 L<http://www.iinteractive.com>
369 This library is free software; you can redistribute it and/or modify
370 it under the same terms as Perl itself.