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 ) = @_;
23 # set up the environment
24 my $attr = $self->associated_attribute;
25 my $type_constraint_obj = $attr->type_constraint;
29 '$type_constraint_obj' => \$type_constraint_obj,
30 '$type_constraint' => \($type_constraint_obj
31 ? $type_constraint_obj->_compiled_type_constraint
35 #warn "code for " . $attr->name . " =>\n" . $source . "\n";
36 my ( $code, $e ) = $self->_compile_code( environment => $environment, code => $source );
39 "Could not create writer for '${\$self->associated_attribute->name}' because $e \n code: $source",
40 error => $e, data => $source )
46 sub _generate_accessor_method_inline {
48 my $attr = $self->associated_attribute;
50 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
52 $self->_eval_code('sub { ' . "\n"
53 . $self->_inline_pre_body(@_) . "\n"
54 . 'if (scalar(@_) >= 2) {' . "\n"
55 . $self->_inline_copy_value . "\n"
56 . $self->_inline_check_required . "\n"
57 . $self->_inline_check_coercion($value_name) . "\n"
58 . $self->_inline_check_constraint($value_name) . "\n"
59 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
60 . $self->_inline_store($inv, $value_name) . "\n"
61 . $self->_inline_trigger($inv, $value_name, '@old') . "\n"
63 . $self->_inline_check_lazy($inv) . "\n"
64 . $self->_inline_post_body(@_) . "\n"
65 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
69 sub _generate_writer_method_inline {
71 my $attr = $self->associated_attribute;
73 my $slot_access = $self->_inline_get($inv);
74 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
76 $self->_eval_code('sub { '
77 . $self->_inline_pre_body(@_)
78 . $self->_inline_copy_value
79 . $self->_inline_check_required
80 . $self->_inline_check_coercion($value_name)
81 . $self->_inline_check_constraint($value_name)
82 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
83 . $self->_inline_store($inv, $value_name)
84 . $self->_inline_post_body(@_)
85 . $self->_inline_trigger($inv, $value_name, '@old')
89 sub _generate_reader_method_inline {
91 my $attr = $self->associated_attribute;
93 my $slot_access = $self->_inline_get($inv);
95 $self->_eval_code('sub {'
96 . $self->_inline_pre_body(@_)
97 . $self->_inline_throw_error('"Cannot assign a value to a read-only accessor"', 'data => \@_') . ' if @_ > 1;'
98 . $self->_inline_check_lazy($inv)
99 . $self->_inline_post_body(@_)
100 . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
104 sub _inline_copy_value {
105 return '' unless shift->_value_needs_copy;
106 return 'my $val = $_[1];'
109 sub _value_needs_copy {
110 my $attr = (shift)->associated_attribute;
111 return $attr->should_coerce;
114 sub _instance_is_inlinable {
116 return $self->associated_attribute->associated_class->instance_metaclass->is_inlinable;
119 sub _generate_reader_method {
121 $self->_instance_is_inlinable ? $self->_generate_reader_method_inline(@_)
122 : $self->SUPER::_generate_reader_method(@_);
125 sub _generate_writer_method {
127 $self->_instance_is_inlinable ? $self->_generate_writer_method_inline(@_)
128 : $self->SUPER::_generate_writer_method(@_);
131 sub _generate_accessor_method {
133 $self->_instance_is_inlinable ? $self->_generate_accessor_method_inline(@_)
134 : $self->SUPER::_generate_accessor_method(@_);
137 sub _generate_predicate_method {
139 $self->_instance_is_inlinable ? $self->_generate_predicate_method_inline(@_)
140 : $self->SUPER::_generate_predicate_method(@_);
143 sub _generate_clearer_method {
145 $self->_instance_is_inlinable ? $self->_generate_clearer_method_inline(@_)
146 : $self->SUPER::_generate_clearer_method(@_);
149 sub _inline_pre_body { '' }
150 sub _inline_post_body { '' }
152 sub _inline_check_constraint {
153 my ($self, $value) = @_;
155 my $attr = $self->associated_attribute;
157 return '' unless $attr->has_type_constraint;
159 my $attr_name = quotemeta( $attr->name );
161 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") . ";";
164 sub _inline_check_coercion {
165 my ($self, $value) = @_;
167 my $attr = $self->associated_attribute;
169 return '' unless $attr->should_coerce && $attr->type_constraint->has_coercion;
170 return "$value = \$attr->type_constraint->coerce($value);";
173 sub _inline_check_required {
175 my $attr = $self->associated_attribute;
177 return '' unless $attr->is_required;
179 my $attr_name = quotemeta( $attr->name );
181 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
184 sub _inline_check_lazy {
185 my ($self, $instance) = @_;
187 my $attr = $self->associated_attribute;
189 return '' unless $attr->is_lazy;
191 my $slot_exists = $self->_inline_has($instance);
193 my $code = 'unless (' . $slot_exists . ') {' . "\n";
194 if ($attr->has_type_constraint) {
195 if ($attr->has_default || $attr->has_builder) {
196 if ($attr->has_default) {
197 $code .= ' my $default = $attr->default(' . $instance . ');'."\n";
199 elsif ($attr->has_builder) {
200 $code .= ' my $default;'."\n".
201 ' if(my $builder = '.$instance.'->can($attr->builder)){ '."\n".
202 ' $default = '.$instance.'->$builder; '. "\n } else {\n" .
203 ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name') .
206 $code .= $self->_inline_check_coercion('$default') . "\n";
207 $code .= $self->_inline_check_constraint('$default') . "\n";
208 $code .= ' ' . $self->_inline_init_slot($attr, $instance, '$default') . "\n";
211 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
215 if ($attr->has_default) {
216 $code .= ' ' . $self->_inline_init_slot($attr, $instance, ('$attr->default(' . $instance . ')')) . "\n";
218 elsif ($attr->has_builder) {
219 $code .= ' if (my $builder = '.$instance.'->can($attr->builder)) { ' . "\n"
220 . ' ' . $self->_inline_init_slot($attr, $instance, ($instance . '->$builder'))
222 . ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name')
226 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
233 sub _inline_init_slot {
234 my ($self, $attr, $inv, $value) = @_;
235 if ($attr->has_initializer) {
236 return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
239 return $self->_inline_store($inv, $value);
244 my ($self, $instance, $value) = @_;
245 my $attr = $self->associated_attribute;
247 my $mi = $attr->associated_class->get_meta_instance;
249 my $code = $mi->inline_set_slot_value($instance, $attr->slots, $value) . ";";
250 $code .= $mi->inline_weaken_slot_value($instance, $attr->slots, $value) . ";"
251 if $attr->is_weak_ref;
255 sub _inline_get_old_value_for_trigger {
256 my ( $self, $instance ) = @_;
258 my $attr = $self->associated_attribute;
259 return '' unless $attr->has_trigger;
261 my $mi = $attr->associated_class->get_meta_instance;
262 my $pred = $mi->inline_is_slot_initialized($instance, $attr->name);
267 . $self->_inline_get($instance) . q{ : ()} . ";\n";
270 sub _inline_trigger {
271 my ($self, $instance, $value, $old_value) = @_;
272 my $attr = $self->associated_attribute;
273 return '' unless $attr->has_trigger;
274 return sprintf('$attr->trigger->(%s, %s, %s);', $instance, $value, $old_value);
278 my ($self, $instance) = @_;
279 my $attr = $self->associated_attribute;
281 my $mi = $attr->associated_class->get_meta_instance;
283 return $mi->inline_get_slot_value($instance, $attr->slots);
287 my ($self, $instance) = @_;
288 my $attr = $self->associated_attribute;
290 my $mi = $attr->associated_class->get_meta_instance;
292 return $mi->inline_slot_access($instance, $attr->slots);
296 my ($self, $instance) = @_;
297 my $attr = $self->associated_attribute;
299 my $mi = $attr->associated_class->get_meta_instance;
301 return $mi->inline_is_slot_initialized($instance, $attr->slots);
304 sub _inline_auto_deref {
305 my ( $self, $ref_value ) = @_;
306 my $attr = $self->associated_attribute;
308 return $ref_value unless $attr->should_auto_deref;
310 my $type_constraint = $attr->type_constraint;
313 if ($type_constraint->is_a_type_of('ArrayRef')) {
316 elsif ($type_constraint->is_a_type_of('HashRef')) {
320 $self->throw_error( "Can not auto de-reference the type constraint '"
321 . quotemeta( $type_constraint->name )
322 . "'", type_constraint => $type_constraint );
325 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
336 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
340 This class is a subclass of L<Class::MOP::Method::Accessor> that
341 provides additional Moose-specific functionality, all of which is
344 To understand this class, you should read the the
345 L<Class::MOP::Method::Accessor> documentation.
349 See L<Moose/BUGS> for details on reporting bugs.
353 Stevan Little E<lt>stevan@iinteractive.comE<gt>
355 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
357 =head1 COPYRIGHT AND LICENSE
359 Copyright 2006-2010 by Infinity Interactive, Inc.
361 L<http://www.iinteractive.com>
363 This library is free software; you can redistribute it and/or modify
364 it under the same terms as Perl itself.