Commit | Line | Data |
ba38bf08 |
1 | |
2 | package Class::MOP::Method::Accessor; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
7 | use Carp 'confess'; |
8 | use Scalar::Util 'blessed', 'weaken'; |
15961c86 |
9 | use Try::Tiny; |
ba38bf08 |
10 | |
a9f48b4b |
11 | our $VERSION = '1.11'; |
d519662a |
12 | $VERSION = eval $VERSION; |
ba38bf08 |
13 | our $AUTHORITY = 'cpan:STEVAN'; |
14 | |
565f0cbb |
15 | use base 'Class::MOP::Method::Generated'; |
ba38bf08 |
16 | |
ba38bf08 |
17 | sub new { |
18 | my $class = shift; |
19 | my %options = @_; |
8d2d4c67 |
20 | |
ba38bf08 |
21 | (exists $options{attribute}) |
22 | || confess "You must supply an attribute to construct with"; |
8d2d4c67 |
23 | |
ba38bf08 |
24 | (exists $options{accessor_type}) |
8d2d4c67 |
25 | || confess "You must supply an accessor_type to construct with"; |
26 | |
ba38bf08 |
27 | (blessed($options{attribute}) && $options{attribute}->isa('Class::MOP::Attribute')) |
8d2d4c67 |
28 | || confess "You must supply an attribute which is a 'Class::MOP::Attribute' instance"; |
29 | |
b38f3848 |
30 | ($options{package_name} && $options{name}) |
32202ce2 |
31 | || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT"; |
b38f3848 |
32 | |
0bfc85b8 |
33 | my $self = $class->_new(\%options); |
8d2d4c67 |
34 | |
35 | # we don't want this creating |
36 | # a cycle in the code, if not |
ba38bf08 |
37 | # needed |
8683db0e |
38 | weaken($self->{'attribute'}); |
8d2d4c67 |
39 | |
e9497117 |
40 | $self->_initialize_body; |
8d2d4c67 |
41 | |
ba38bf08 |
42 | return $self; |
43 | } |
44 | |
a9e38dc7 |
45 | sub _new { |
0bfc85b8 |
46 | my $class = shift; |
a9e38dc7 |
47 | |
ec9e38e5 |
48 | return Class::MOP::Class->initialize($class)->new_object(@_) |
812d58f9 |
49 | if $class ne __PACKAGE__; |
a9e38dc7 |
50 | |
ec9e38e5 |
51 | my $params = @_ == 1 ? $_[0] : {@_}; |
52 | |
53 | return bless { |
54 | # inherited from Class::MOP::Method |
55 | body => $params->{body}, |
56 | associated_metaclass => $params->{associated_metaclass}, |
57 | package_name => $params->{package_name}, |
58 | name => $params->{name}, |
59 | original_method => $params->{original_method}, |
60 | |
61 | # inherit from Class::MOP::Generated |
62 | is_inline => $params->{is_inline} || 0, |
63 | definition_context => $params->{definition_context}, |
64 | |
65 | # defined in this class |
66 | attribute => $params->{attribute}, |
67 | accessor_type => $params->{accessor_type}, |
68 | } => $class; |
a9e38dc7 |
69 | } |
70 | |
ba38bf08 |
71 | ## accessors |
72 | |
8683db0e |
73 | sub associated_attribute { (shift)->{'attribute'} } |
74 | sub accessor_type { (shift)->{'accessor_type'} } |
ba38bf08 |
75 | |
8d2d4c67 |
76 | ## factory |
ba38bf08 |
77 | |
e9497117 |
78 | sub _initialize_body { |
ba38bf08 |
79 | my $self = shift; |
8d2d4c67 |
80 | |
ba38bf08 |
81 | my $method_name = join "_" => ( |
afc92ac6 |
82 | '_generate', |
8d2d4c67 |
83 | $self->accessor_type, |
ba38bf08 |
84 | 'method', |
d90b42a6 |
85 | ($self->is_inline ? 'inline' : ()) |
ba38bf08 |
86 | ); |
8d2d4c67 |
87 | |
1be5f78f |
88 | $self->{'body'} = $self->$method_name(); |
ba38bf08 |
89 | } |
90 | |
91 | ## generators |
92 | |
afc92ac6 |
93 | sub _generate_accessor_method { |
8d2d4c67 |
94 | my $attr = (shift)->associated_attribute; |
ba38bf08 |
95 | return sub { |
96 | $attr->set_value($_[0], $_[1]) if scalar(@_) == 2; |
97 | $attr->get_value($_[0]); |
98 | }; |
99 | } |
100 | |
afc92ac6 |
101 | sub _generate_reader_method { |
8d2d4c67 |
102 | my $attr = (shift)->associated_attribute; |
103 | return sub { |
ba38bf08 |
104 | confess "Cannot assign a value to a read-only accessor" if @_ > 1; |
105 | $attr->get_value($_[0]); |
8d2d4c67 |
106 | }; |
ba38bf08 |
107 | } |
108 | |
afc92ac6 |
109 | |
110 | sub _generate_writer_method { |
8d2d4c67 |
111 | my $attr = (shift)->associated_attribute; |
ba38bf08 |
112 | return sub { |
113 | $attr->set_value($_[0], $_[1]); |
114 | }; |
115 | } |
116 | |
afc92ac6 |
117 | sub _generate_predicate_method { |
8d2d4c67 |
118 | my $attr = (shift)->associated_attribute; |
119 | return sub { |
3545c727 |
120 | $attr->has_value($_[0]) |
ba38bf08 |
121 | }; |
122 | } |
123 | |
afc92ac6 |
124 | sub _generate_clearer_method { |
8d2d4c67 |
125 | my $attr = (shift)->associated_attribute; |
126 | return sub { |
3545c727 |
127 | $attr->clear_value($_[0]) |
ba38bf08 |
128 | }; |
129 | } |
130 | |
131 | ## Inline methods |
132 | |
afc92ac6 |
133 | sub _generate_accessor_method_inline { |
03a3092d |
134 | my $self = shift; |
135 | my $attr = $self->associated_attribute; |
ba38bf08 |
136 | |
15961c86 |
137 | my $code = try { |
138 | $self->_compile_code( |
139 | source => [ |
140 | 'sub {', |
141 | $attr->inline_set( '$_[0]', '$_[1]' ) |
142 | . ' if scalar(@_) == 2;', |
143 | $attr->inline_get('$_[0]') . ';', |
144 | '}', |
145 | ] |
146 | ); |
147 | } |
148 | catch { |
149 | confess "Could not generate inline accessor because : $_"; |
150 | }; |
a6eef5a3 |
151 | |
152 | return $code; |
ba38bf08 |
153 | } |
154 | |
afc92ac6 |
155 | sub _generate_reader_method_inline { |
03a3092d |
156 | my $self = shift; |
157 | my $attr = $self->associated_attribute; |
ba38bf08 |
158 | |
15961c86 |
159 | my $code = try { |
160 | $self->_compile_code( |
161 | source => [ |
162 | 'sub {', |
163 | 'confess "Cannot assign a value to a read-only accessor" ' |
164 | . 'if @_ > 1;', |
165 | $attr->inline_get('$_[0]') . ';', |
166 | '}', |
167 | ], |
168 | ); |
169 | } |
170 | catch { |
171 | confess "Could not generate inline reader because : $_"; |
172 | }; |
a6eef5a3 |
173 | |
174 | return $code; |
ba38bf08 |
175 | } |
176 | |
afc92ac6 |
177 | sub _generate_writer_method_inline { |
03a3092d |
178 | my $self = shift; |
179 | my $attr = $self->associated_attribute; |
ba38bf08 |
180 | |
15961c86 |
181 | my $code = try { |
182 | $self->_compile_code( |
183 | source => [ |
184 | 'sub {', |
185 | $attr->inline_set( '$_[0]', '$_[1]' ) . ';', |
186 | '}', |
187 | ], |
188 | ); |
189 | } |
190 | catch { |
191 | confess "Could not generate inline writer because : $_"; |
192 | }; |
a6eef5a3 |
193 | |
194 | return $code; |
ba38bf08 |
195 | } |
196 | |
afc92ac6 |
197 | sub _generate_predicate_method_inline { |
03a3092d |
198 | my $self = shift; |
199 | my $attr = $self->associated_attribute; |
ba38bf08 |
200 | |
15961c86 |
201 | my $code = try { |
202 | $self->_compile_code( |
203 | source => [ |
204 | 'sub {', |
205 | $attr->inline_has('$_[0]') . ';', |
206 | '}', |
207 | ], |
208 | ); |
209 | } |
210 | catch { |
211 | confess "Could not generate inline predicate because : $_"; |
212 | }; |
a6eef5a3 |
213 | |
214 | return $code; |
ba38bf08 |
215 | } |
216 | |
afc92ac6 |
217 | sub _generate_clearer_method_inline { |
03a3092d |
218 | my $self = shift; |
219 | my $attr = $self->associated_attribute; |
ba38bf08 |
220 | |
15961c86 |
221 | my $code = try { |
222 | $self->_compile_code( |
223 | source => [ |
224 | 'sub {', |
225 | $attr->inline_clear('$_[0]') . ';', |
226 | '}', |
227 | ], |
228 | ); |
229 | } |
230 | catch { |
231 | confess "Could not generate inline clearer because : $_"; |
232 | }; |
a6eef5a3 |
233 | |
234 | return $code; |
ba38bf08 |
235 | } |
236 | |
237 | 1; |
238 | |
239 | __END__ |
240 | |
241 | =pod |
242 | |
8d2d4c67 |
243 | =head1 NAME |
ba38bf08 |
244 | |
245 | Class::MOP::Method::Accessor - Method Meta Object for accessors |
246 | |
247 | =head1 SYNOPSIS |
248 | |
96e38ba6 |
249 | use Class::MOP::Method::Accessor; |
250 | |
251 | my $reader = Class::MOP::Method::Accessor->new( |
252 | attribute => $attribute, |
253 | is_inline => 1, |
254 | accessor_type => 'reader', |
255 | ); |
8d2d4c67 |
256 | |
b7045e66 |
257 | $reader->body->execute($instance); # call the reader method |
ba38bf08 |
258 | |
259 | =head1 DESCRIPTION |
260 | |
6f241a63 |
261 | This is a subclass of C<Class::MOP::Method> which is used by |
1385ad9d |
262 | C<Class::MOP::Attribute> to generate accessor code. It handles |
263 | generation of readers, writers, predicates and clearers. For each type |
264 | of method, it can either create a subroutine reference, or actually |
265 | inline code by generating a string and C<eval>'ing it. |
96e38ba6 |
266 | |
ba38bf08 |
267 | =head1 METHODS |
268 | |
269 | =over 4 |
270 | |
1385ad9d |
271 | =item B<< Class::MOP::Method::Accessor->new(%options) >> |
ba38bf08 |
272 | |
1385ad9d |
273 | This returns a new C<Class::MOP::Method::Accessor> based on the |
274 | C<%options> provided. |
96e38ba6 |
275 | |
276 | =over 4 |
277 | |
9258c369 |
278 | =item * attribute |
96e38ba6 |
279 | |
1385ad9d |
280 | This is the C<Class::MOP::Attribute> for which accessors are being |
281 | generated. This option is required. |
96e38ba6 |
282 | |
9258c369 |
283 | =item * accessor_type |
96e38ba6 |
284 | |
1385ad9d |
285 | This is a string which should be one of "reader", "writer", |
286 | "accessor", "predicate", or "clearer". This is the type of method |
287 | being generated. This option is required. |
96e38ba6 |
288 | |
9258c369 |
289 | =item * is_inline |
96e38ba6 |
290 | |
1385ad9d |
291 | This indicates whether or not the accessor should be inlined. This |
cb8d08c6 |
292 | defaults to false. |
96e38ba6 |
293 | |
9258c369 |
294 | =item * name |
295 | |
296 | The method name (without a package name). This is required. |
297 | |
298 | =item * package_name |
299 | |
300 | The package name for the method. This is required. |
301 | |
96e38ba6 |
302 | =back |
ba38bf08 |
303 | |
1385ad9d |
304 | =item B<< $metamethod->accessor_type >> |
ba38bf08 |
305 | |
1385ad9d |
306 | Returns the accessor type which was passed to C<new>. |
96e38ba6 |
307 | |
1385ad9d |
308 | =item B<< $metamethod->is_inline >> |
ba38bf08 |
309 | |
1385ad9d |
310 | Returns a boolean indicating whether or not the accessor is inlined. |
96e38ba6 |
311 | |
1385ad9d |
312 | =item B<< $metamethod->associated_attribute >> |
ba38bf08 |
313 | |
1385ad9d |
314 | This returns the L<Class::MOP::Attribute> object which was passed to |
315 | C<new>. |
96e38ba6 |
316 | |
1385ad9d |
317 | =item B<< $metamethod->body >> |
96e38ba6 |
318 | |
1385ad9d |
319 | The method itself is I<generated> when the accessor object is |
320 | constructed. |
ba38bf08 |
321 | |
322 | =back |
323 | |
324 | =head1 AUTHORS |
325 | |
326 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
327 | |
ba38bf08 |
328 | =head1 COPYRIGHT AND LICENSE |
329 | |
3e2c8600 |
330 | Copyright 2006-2010 by Infinity Interactive, Inc. |
ba38bf08 |
331 | |
332 | L<http://www.iinteractive.com> |
333 | |
334 | This library is free software; you can redistribute it and/or modify |
8d2d4c67 |
335 | it under the same terms as Perl itself. |
ba38bf08 |
336 | |
337 | =cut |
338 | |