2 package Moose::Meta::Method::Accessor;
10 our $AUTHORITY = 'cpan:STEVAN';
12 use base 'Moose::Meta::Method',
13 'Class::MOP::Method::Accessor';
15 ## Inline method generators
17 sub generate_accessor_method_inline {
19 my $attr = $self->associated_attribute;
20 my $attr_name = $attr->name;
22 my $value_name = $attr->should_coerce ? '$val' : '$_[1]';
23 my $mi = $attr->associated_class->get_meta_instance;
24 my $slot_name = sprintf "'%s'", $attr->slots;
27 . 'if (scalar(@_) == 2) {'
28 . $self->_inline_check_required
29 . $self->_inline_check_coercion
30 . $self->_inline_check_constraint($value_name)
31 . $self->_inline_store($inv, $value_name)
32 . $self->_inline_trigger($inv, $value_name)
34 . $self->_inline_check_lazy
35 . 'return ' . $self->_inline_auto_deref($self->_inline_get($inv))
39 # set up the environment
40 my $type_constraint = $attr->type_constraint
41 ? $attr->type_constraint->_compiled_type_constraint
45 confess "Could not create accessor for '$attr_name' because $@ \n code: $code" if $@;
49 sub generate_writer_method_inline {
51 my $attr = $self->associated_attribute;
52 my $attr_name = $attr->name;
54 my $value_name = $attr->should_coerce ? '$val' : '$_[1]';
57 . $self->_inline_check_required
58 . $self->_inline_check_coercion
59 . $self->_inline_check_constraint($value_name)
60 . $self->_inline_store($inv, $value_name)
61 . $self->_inline_trigger($inv, $value_name)
65 # set up the environment
66 my $type_constraint = $attr->type_constraint
67 ? $attr->type_constraint->_compiled_type_constraint
71 confess "Could not create writer for '$attr_name' because $@ \n code: $code" if $@;
75 sub generate_reader_method_inline {
77 my $attr = $self->associated_attribute;
78 my $attr_name = $attr->name;
81 . 'confess "Cannot assign a value to a read-only accessor" if @_ > 1;'
82 . $self->_inline_check_lazy
83 . 'return ' . $self->_inline_auto_deref( '$_[0]->{$attr_name}' ) . ';'
87 # set up the environment
88 my $type_constraint = $attr->type_constraint
89 ? $attr->type_constraint->_compiled_type_constraint
93 confess "Could not create reader for '$attr_name' because $@ \n code: $code" if $@;
97 *generate_reader_method = \&generate_reader_method_inline;
98 *generate_writer_method = \&generate_writer_method_inline;
99 *generate_accessor_method = \&generate_accessor_method_inline;
101 sub _inline_check_constraint {
102 my ($self, $value) = @_;
104 my $attr = $self->associated_attribute;
106 return '' unless $attr->has_type_constraint;
108 return sprintf <<'EOF', $value, $value, $value, $value
109 defined($type_constraint->(%s))
110 || confess "Attribute (" . $attr->name . ") does not pass the type constraint ("
111 . $attr->type_constraint->name . ") with " . (defined(%s) ? "'%s'" : "undef")
116 sub _inline_check_coercion {
117 my $attr = (shift)->associated_attribute;
119 return '' unless $attr->should_coerce;
120 return 'my $val = $attr->type_constraint->coerce($_[1]);'
123 sub _inline_check_required {
124 my $attr = (shift)->associated_attribute;
126 return '' unless $attr->is_required;
127 return 'defined($_[1]) || confess "Attribute ($attr_name) is required, so cannot be set to undef";'
130 sub _inline_check_lazy {
131 my $attr = (shift)->associated_attribute;
133 return '' unless $attr->is_lazy;
135 if ($attr->has_type_constraint) {
137 # this could probably be cleaned
138 # up and streamlined a little more
139 return 'unless (exists $_[0]->{$attr_name}) {' .
140 ' if ($attr->has_default) {' .
141 ' my $default = $attr->default($_[0]);' .
142 ' (defined($type_constraint->($default)))' .
143 ' || confess "Attribute (" . $attr->name . ") does not pass the type constraint ("' .
144 ' . $attr->type_constraint->name . ") with " . (defined($default) ? "\'$default\'" : "undef")' .
145 ' if defined($default);' .
146 ' $_[0]->{$attr_name} = $default; ' .
149 ' $_[0]->{$attr_name} = undef;' .
153 return '$_[0]->{$attr_name} = ($attr->has_default ? $attr->default($_[0]) : undef)'
154 . 'unless exists $_[0]->{$attr_name};';
159 my ($self, $instance, $value) = @_;
160 my $attr = $self->associated_attribute;
162 my $mi = $attr->associated_class->get_meta_instance;
163 my $slot_name = sprintf "'%s'", $attr->slots;
165 my $code = $mi->inline_set_slot_value($instance, $slot_name, $value) . ";";
166 $code .= $mi->inline_weaken_slot_value($instance, $slot_name, $value) . ";"
167 if $attr->is_weak_ref;
171 sub _inline_trigger {
172 my ($self, $instance, $value) = @_;
173 my $attr = $self->associated_attribute;
174 return '' unless $attr->has_trigger;
175 return sprintf('$attr->trigger->(%s, %s, $attr);', $instance, $value);
179 my ($self, $instance) = @_;
180 my $attr = $self->associated_attribute;
182 my $mi = $attr->associated_class->get_meta_instance;
183 my $slot_name = sprintf "'%s'", $attr->slots;
185 return $mi->inline_get_slot_value($instance, $slot_name);
188 sub _inline_auto_deref {
189 my ( $self, $ref_value ) = @_;
190 my $attr = $self->associated_attribute;
192 return $ref_value unless $attr->should_auto_deref;
194 my $type_constraint = $attr->type_constraint;
197 if ($type_constraint->is_a_type_of('ArrayRef')) {
200 elsif ($type_constraint->is_a_type_of('HashRef')) {
204 confess "Can not auto de-reference the type constraint '" . $type_constraint->name . "'";
207 "(wantarray() ? $sigil\{ ( $ref_value ) || return } : ( $ref_value ) )";
218 Moose::Meta::Method::Accessor - A Moose Method metaclass for accessors
222 This is a subclass of L<Class::MOP::Method::Accessor> and it's primary
223 responsibility is to generate the accessor methods for attributes. It
224 can handle both closure based accessors, as well as inlined source based
227 This is a fairly new addition to the MOP, but this will play an important
228 role in the optimization strategy we are currently following.
234 =item B<generate_accessor_method>
236 =item B<generate_reader_method>
238 =item B<generate_writer_method>
240 =item B<generate_accessor_method_inline>
242 =item B<generate_reader_method_inline>
244 =item B<generate_writer_method_inline>
250 All complex software has bugs lurking in it, and this module is no
251 exception. If you find a bug please either email me, or add the bug
256 Stevan Little E<lt>stevan@iinteractive.comE<gt>
258 Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
260 =head1 COPYRIGHT AND LICENSE
262 Copyright 2006, 2007 by Infinity Interactive, Inc.
264 L<http://www.iinteractive.com>
266 This library is free software; you can redistribute it and/or modify
267 it under the same terms as Perl itself.