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 {
55 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
57 $self->_eval_code('sub { ' . "\n"
58 . $self->_inline_pre_body(@_) . "\n"
59 . 'if (scalar(@_) >= 2) {' . "\n"
60 . $self->_inline_copy_value . "\n"
61 . $self->_inline_check_required . "\n"
62 . $self->_inline_check_coercion($value_name) . "\n"
63 . $self->_inline_check_constraint($value_name) . "\n"
64 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
65 . $self->_inline_store($inv, $value_name) . "\n"
66 . $self->_inline_trigger($inv, $value_name, '@old') . "\n"
68 . $self->_inline_check_lazy($inv) . "\n"
69 . $self->_inline_post_body(@_) . "\n"
70 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv)) . "\n"
74 sub _generate_writer_method_inline {
77 my $value_name = $self->_value_needs_copy ? '$val' : '$_[1]';
79 $self->_eval_code('sub { '
80 . $self->_inline_pre_body(@_)
81 . $self->_inline_copy_value
82 . $self->_inline_check_required
83 . $self->_inline_check_coercion($value_name)
84 . $self->_inline_check_constraint($value_name)
85 . $self->_inline_get_old_value_for_trigger($inv, $value_name) . "\n"
86 . $self->_inline_store($inv, $value_name)
87 . $self->_inline_post_body(@_)
88 . $self->_inline_trigger($inv, $value_name, '@old')
92 sub _generate_reader_method_inline {
95 my $slot_access = $self->_inline_get($inv);
97 $self->_eval_code('sub {'
98 . $self->_inline_pre_body(@_)
99 . $self->_inline_throw_error('"Cannot assign a value to a read-only accessor"', 'data => \@_') . ' if @_ > 1;'
100 . $self->_inline_check_lazy($inv)
101 . $self->_inline_post_body(@_)
102 . 'return ' . $self->_inline_auto_deref( $slot_access ) . ';'
106 sub _inline_copy_value {
107 return '' unless shift->_value_needs_copy;
108 return 'my $val = $_[1];'
111 sub _value_needs_copy {
112 my $attr = (shift)->associated_attribute;
113 return $attr->should_coerce;
116 sub _instance_is_inlinable {
118 return $self->associated_attribute->associated_class->instance_metaclass->is_inlinable;
121 sub _generate_reader_method {
123 $self->_instance_is_inlinable ? $self->_generate_reader_method_inline(@_)
124 : $self->SUPER::_generate_reader_method(@_);
127 sub _generate_writer_method {
129 $self->_instance_is_inlinable ? $self->_generate_writer_method_inline(@_)
130 : $self->SUPER::_generate_writer_method(@_);
133 sub _generate_accessor_method {
135 $self->_instance_is_inlinable ? $self->_generate_accessor_method_inline(@_)
136 : $self->SUPER::_generate_accessor_method(@_);
139 sub _generate_predicate_method {
141 $self->_instance_is_inlinable ? $self->_generate_predicate_method_inline(@_)
142 : $self->SUPER::_generate_predicate_method(@_);
145 sub _generate_clearer_method {
147 $self->_instance_is_inlinable ? $self->_generate_clearer_method_inline(@_)
148 : $self->SUPER::_generate_clearer_method(@_);
151 sub _inline_pre_body { '' }
152 sub _inline_post_body { '' }
154 sub _inline_check_constraint {
155 my ($self, $value) = @_;
157 my $attr = $self->associated_attribute;
159 return '' unless $attr->has_type_constraint;
161 my $attr_name = quotemeta( $attr->name );
163 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") . ";";
166 sub _inline_check_coercion {
167 my ($self, $value) = @_;
169 my $attr = $self->associated_attribute;
171 return '' unless $attr->should_coerce && $attr->type_constraint->has_coercion;
172 return "$value = \$attr->type_constraint->coerce($value);";
175 sub _inline_check_required {
177 my $attr = $self->associated_attribute;
179 return '' unless $attr->is_required;
181 my $attr_name = quotemeta( $attr->name );
183 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
186 sub _inline_check_lazy {
187 my ($self, $instance) = @_;
189 my $attr = $self->associated_attribute;
191 return '' unless $attr->is_lazy;
193 my $slot_exists = $self->_inline_has($instance);
195 my $code = 'unless (' . $slot_exists . ') {' . "\n";
196 if ($attr->has_type_constraint) {
197 if ($attr->has_default || $attr->has_builder) {
198 if ($attr->has_default) {
199 $code .= ' my $default = $attr->default(' . $instance . ');'."\n";
201 elsif ($attr->has_builder) {
202 $code .= ' my $default;'."\n".
203 ' if(my $builder = '.$instance.'->can($attr->builder)){ '."\n".
204 ' $default = '.$instance.'->$builder; '. "\n } else {\n" .
205 ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name') .
208 $code .= $self->_inline_check_coercion('$default') . "\n";
209 $code .= $self->_inline_check_constraint('$default') . "\n";
210 $code .= ' ' . $self->_inline_init_slot($attr, $instance, '$default') . "\n";
213 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
217 if ($attr->has_default) {
218 $code .= ' ' . $self->_inline_init_slot($attr, $instance, ('$attr->default(' . $instance . ')')) . "\n";
220 elsif ($attr->has_builder) {
221 $code .= ' if (my $builder = '.$instance.'->can($attr->builder)) { ' . "\n"
222 . ' ' . $self->_inline_init_slot($attr, $instance, ($instance . '->$builder'))
224 . ' ' . $self->_inline_throw_error(q{sprintf "%s does not support builder method '%s' for attribute '%s'", ref(} . $instance . ') || '.$instance.', $attr->builder, $attr->name')
228 $code .= ' ' . $self->_inline_init_slot($attr, $instance, 'undef') . "\n";
235 sub _inline_init_slot {
236 my ($self, $attr, $inv, $value) = @_;
237 if ($attr->has_initializer) {
238 return ('$attr->set_initial_value(' . $inv . ', ' . $value . ');');
241 return $self->_inline_store($inv, $value);
246 my ( $self, $instance, $value ) = @_;
248 return $self->associated_attribute->inline_set( $instance, $value );
251 sub _inline_get_old_value_for_trigger {
252 my ( $self, $instance ) = @_;
254 my $attr = $self->associated_attribute;
255 return '' unless $attr->has_trigger;
259 . $self->_inline_has($instance) . q{ ? }
260 . $self->_inline_get($instance) . q{ : ()} . ";\n";
263 sub _inline_trigger {
264 my ($self, $instance, $value, $old_value) = @_;
265 my $attr = $self->associated_attribute;
266 return '' unless $attr->has_trigger;
267 return sprintf('$attr->trigger->(%s, %s, %s);', $instance, $value, $old_value);
271 my ($self, $instance) = @_;
273 return $self->associated_attribute->inline_get($instance);
277 my ($self, $instance) = @_;
279 return $self->associated_attribute->inline_has($instance);
282 sub _inline_auto_deref {
283 my ( $self, $ref_value ) = @_;
284 my $attr = $self->associated_attribute;
286 return $ref_value unless $attr->should_auto_deref;
288 my $type_constraint = $attr->type_constraint;
291 if ($type_constraint->is_a_type_of('ArrayRef')) {
294 elsif ($type_constraint->is_a_type_of('HashRef')) {
298 $self->throw_error( "Can not auto de-reference the type constraint '"
299 . quotemeta( $type_constraint->name )
300 . "'", type_constraint => $type_constraint );
303 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
314 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
318 This class is a subclass of L<Class::MOP::Method::Accessor> that
319 provides additional Moose-specific functionality, all of which is
322 To understand this class, you should read the the
323 L<Class::MOP::Method::Accessor> documentation.
327 See L<Moose/BUGS> for details on reporting bugs.
331 Stevan Little E<lt>stevan@iinteractive.comE<gt>
333 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
335 =head1 COPYRIGHT AND LICENSE
337 Copyright 2006-2010 by Infinity Interactive, Inc.
339 L<http://www.iinteractive.com>
341 This library is free software; you can redistribute it and/or modify
342 it under the same terms as Perl itself.