Commit | Line | Data |
c3398f5b |
1 | #!/usr/bin/env perl |
306290e8 |
2 | package Mouse::Meta::Attribute; |
c3398f5b |
3 | use strict; |
4 | use warnings; |
5 | |
6 | use Carp 'confess'; |
626cd940 |
7 | use Mouse::Util qw/blessed weaken/; |
c3398f5b |
8 | |
9 | sub new { |
10 | my $class = shift; |
11 | my %args = @_; |
12 | |
2e7e86c6 |
13 | my $name = $args{name}; |
14 | |
15 | $args{init_arg} = $name |
7ee01d77 |
16 | unless exists $args{init_arg}; |
45959ffa |
17 | |
c3398f5b |
18 | $args{is} ||= ''; |
19 | |
20 | bless \%args, $class; |
21 | } |
22 | |
181502b9 |
23 | sub name { $_[0]->{name} } |
24 | sub associated_class { $_[0]->{associated_class} } |
25 | sub _is_metadata { $_[0]->{is} } |
26 | sub is_required { $_[0]->{required} } |
27 | sub default { $_[0]->{default} } |
28 | sub is_lazy { $_[0]->{lazy} } |
29 | sub is_lazy_build { $_[0]->{lazy_build} } |
30 | sub predicate { $_[0]->{predicate} } |
31 | sub clearer { $_[0]->{clearer} } |
32 | sub handles { $_[0]->{handles} } |
33 | sub is_weak_ref { $_[0]->{weak_ref} } |
34 | sub init_arg { $_[0]->{init_arg} } |
35 | sub type_constraint { $_[0]->{type_constraint} } |
36 | sub trigger { $_[0]->{trigger} } |
37 | sub builder { $_[0]->{builder} } |
38 | sub should_auto_deref { $_[0]->{auto_deref} } |
32af3489 |
39 | sub should_coerce { $_[0]->{should_coerce} } |
c3398f5b |
40 | |
ccea8101 |
41 | sub has_default { exists $_[0]->{default} } |
42 | sub has_predicate { exists $_[0]->{predicate} } |
43 | sub has_clearer { exists $_[0]->{clearer} } |
44 | sub has_handles { exists $_[0]->{handles} } |
ccea8101 |
45 | sub has_type_constraint { exists $_[0]->{type_constraint} } |
de9a434a |
46 | sub has_trigger { exists $_[0]->{trigger} } |
47 | sub has_builder { exists $_[0]->{builder} } |
ccea8101 |
48 | |
1bfebf5f |
49 | sub _create_args { |
50 | $_[0]->{_create_args} = $_[1] if @_ > 1; |
51 | $_[0]->{_create_args} |
52 | } |
53 | |
7f7406a5 |
54 | sub inlined_name { |
55 | my $self = shift; |
56 | my $name = $self->name; |
57 | my $key = "'" . $name . "'"; |
58 | return $key; |
59 | } |
60 | |
c3398f5b |
61 | sub generate_accessor { |
62 | my $attribute = shift; |
63 | |
32af3489 |
64 | my $name = $attribute->name; |
65 | my $default = $attribute->default; |
66 | my $type = $attribute->type_constraint; |
67 | my $constraint = $attribute->find_type_constraint; |
68 | my $builder = $attribute->builder; |
69 | my $trigger = $attribute->trigger; |
70 | my $is_weak = $attribute->is_weak_ref; |
71 | my $should_deref = $attribute->should_auto_deref; |
72 | my $should_coerce = $attribute->should_coerce; |
4e757c98 |
73 | |
85ccd3e9 |
74 | my $self = '$_[0]'; |
85ccd3e9 |
75 | my $key = $attribute->inlined_name; |
c3398f5b |
76 | |
85ccd3e9 |
77 | my $accessor = "sub {\n"; |
2434d21b |
78 | if ($attribute->_is_metadata eq 'rw') { |
7de13475 |
79 | $accessor .= 'if (scalar(@_) >= 2) {' . "\n"; |
80 | |
81 | my $value = '$_[1]'; |
a707f587 |
82 | |
a08e715f |
83 | if ($constraint) { |
32af3489 |
84 | if ($should_coerce) { |
4188b837 |
85 | $accessor .= $value.' = $attribute->coerce_constraint('.$value.');'; |
86 | } |
87 | $accessor .= 'local $_ = '.$value.';'; |
88 | $accessor .= ' |
ed1eec39 |
89 | unless ($constraint->()) { |
a08e715f |
90 | my $display = defined($_) ? overload::StrVal($_) : "undef"; |
91 | Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display"); |
85ccd3e9 |
92 | }' . "\n" |
a707f587 |
93 | } |
94 | |
ccd73de7 |
95 | # if there's nothing left to do for the attribute we can return during |
96 | # this setter |
97 | $accessor .= 'return ' if !$is_weak && !$trigger && !$should_deref; |
c3398f5b |
98 | |
7de13475 |
99 | $accessor .= $self.'->{'.$key.'} = '.$value.';' . "\n"; |
100 | |
ccd73de7 |
101 | if ($is_weak) { |
85ccd3e9 |
102 | $accessor .= 'weaken('.$self.'->{'.$key.'}) if ref('.$self.'->{'.$key.'});' . "\n"; |
c3398f5b |
103 | } |
104 | |
a08e715f |
105 | if ($trigger) { |
85ccd3e9 |
106 | $accessor .= '$trigger->('.$self.', '.$value.', $attribute);' . "\n"; |
c3398f5b |
107 | } |
108 | |
85ccd3e9 |
109 | $accessor .= "}\n"; |
c3398f5b |
110 | } |
111 | else { |
85ccd3e9 |
112 | $accessor .= 'confess "Cannot assign a value to a read-only accessor" if scalar(@_) >= 2;' . "\n"; |
c3398f5b |
113 | } |
114 | |
2434d21b |
115 | if ($attribute->is_lazy) { |
85ccd3e9 |
116 | $accessor .= $self.'->{'.$key.'} = '; |
9367e029 |
117 | |
118 | $accessor .= $attribute->has_builder |
85ccd3e9 |
119 | ? $self.'->$builder' |
120 | : ref($default) eq 'CODE' |
121 | ? '$default->('.$self.')' |
122 | : '$default'; |
123 | $accessor .= ' if !exists '.$self.'->{'.$key.'};' . "\n"; |
c3398f5b |
124 | } |
125 | |
ccd73de7 |
126 | if ($should_deref) { |
3cf68001 |
127 | if ($attribute->type_constraint eq 'ArrayRef') { |
128 | $accessor .= 'if (wantarray) { |
85ccd3e9 |
129 | return @{ '.$self.'->{'.$key.'} || [] }; |
7de13475 |
130 | }'; |
3cf68001 |
131 | } |
132 | else { |
133 | $accessor .= 'if (wantarray) { |
85ccd3e9 |
134 | return %{ '.$self.'->{'.$key.'} || {} }; |
7de13475 |
135 | }'; |
3cf68001 |
136 | } |
137 | } |
138 | |
85ccd3e9 |
139 | $accessor .= 'return '.$self.'->{'.$key.'}; |
c3398f5b |
140 | }'; |
141 | |
71b948d1 |
142 | my $sub = eval $accessor; |
143 | confess $@ if $@; |
144 | return $sub; |
c3398f5b |
145 | } |
146 | |
147 | sub generate_predicate { |
148 | my $attribute = shift; |
d10fd510 |
149 | my $key = $attribute->inlined_name; |
c3398f5b |
150 | |
d10fd510 |
151 | my $predicate = 'sub { exists($_[0]->{'.$key.'}) }'; |
c3398f5b |
152 | |
71b948d1 |
153 | my $sub = eval $predicate; |
154 | confess $@ if $@; |
155 | return $sub; |
c3398f5b |
156 | } |
157 | |
158 | sub generate_clearer { |
159 | my $attribute = shift; |
d10fd510 |
160 | my $key = $attribute->inlined_name; |
c3398f5b |
161 | |
d10fd510 |
162 | my $clearer = 'sub { delete($_[0]->{'.$key.'}) }'; |
c3398f5b |
163 | |
71b948d1 |
164 | my $sub = eval $clearer; |
165 | confess $@ if $@; |
166 | return $sub; |
c3398f5b |
167 | } |
168 | |
169 | sub generate_handles { |
170 | my $attribute = shift; |
2434d21b |
171 | my $reader = $attribute->name; |
c3cc3642 |
172 | my %handles = $attribute->_canonicalize_handles($attribute->handles); |
c3398f5b |
173 | |
174 | my %method_map; |
175 | |
c3cc3642 |
176 | for my $local_method (keys %handles) { |
177 | my $remote_method = $handles{$local_method}; |
c3398f5b |
178 | |
179 | my $method = 'sub { |
180 | my $self = shift; |
181 | $self->$reader->$remote_method(@_) |
182 | }'; |
183 | |
184 | $method_map{$local_method} = eval $method; |
71b948d1 |
185 | confess $@ if $@; |
c3398f5b |
186 | } |
187 | |
188 | return \%method_map; |
189 | } |
190 | |
191 | sub create { |
192 | my ($self, $class, $name, %args) = @_; |
193 | |
1bfebf5f |
194 | $args{name} = $name; |
181502b9 |
195 | $args{associated_class} = $class; |
1bfebf5f |
196 | |
93d190e0 |
197 | %args = $self->canonicalize_args($name, %args); |
1bbaa8ed |
198 | $self->validate_args($name, \%args); |
45ea8620 |
199 | |
32af3489 |
200 | $args{should_coerce} = delete $args{coerce} |
4188b837 |
201 | if exists $args{coerce}; |
202 | |
c021207d |
203 | $args{type_constraint} = delete $args{isa} |
204 | if exists $args{isa}; |
186657a9 |
205 | |
1bfebf5f |
206 | my $attribute = $self->new(%args); |
1bfebf5f |
207 | |
724c77c0 |
208 | $attribute->_create_args(\%args); |
c3398f5b |
209 | |
724c77c0 |
210 | $class->add_attribute($attribute); |
b2500191 |
211 | |
c3398f5b |
212 | # install an accessor |
2434d21b |
213 | if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') { |
c3398f5b |
214 | my $accessor = $attribute->generate_accessor; |
724c77c0 |
215 | $class->add_method($name => $accessor); |
c3398f5b |
216 | } |
217 | |
c3398f5b |
218 | for my $method (qw/predicate clearer/) { |
2434d21b |
219 | my $predicate = "has_$method"; |
220 | if ($attribute->$predicate) { |
c3398f5b |
221 | my $generator = "generate_$method"; |
222 | my $coderef = $attribute->$generator; |
724c77c0 |
223 | $class->add_method($attribute->$method => $coderef); |
c3398f5b |
224 | } |
225 | } |
226 | |
2434d21b |
227 | if ($attribute->has_handles) { |
c3398f5b |
228 | my $method_map = $attribute->generate_handles; |
229 | for my $method_name (keys %$method_map) { |
724c77c0 |
230 | $class->add_method($method_name => $method_map->{$method_name}); |
c3398f5b |
231 | } |
232 | } |
233 | |
234 | return $attribute; |
235 | } |
236 | |
93d190e0 |
237 | sub canonicalize_args { |
238 | my $self = shift; |
239 | my $name = shift; |
240 | my %args = @_; |
241 | |
242 | if ($args{lazy_build}) { |
243 | $args{lazy} = 1; |
244 | $args{required} = 1; |
245 | $args{builder} = "_build_${name}" |
246 | if !exists($args{builder}); |
247 | if ($name =~ /^_/) { |
248 | $args{clearer} = "_clear${name}" if !exists($args{clearer}); |
249 | $args{predicate} = "_has${name}" if !exists($args{predicate}); |
250 | } |
251 | else { |
252 | $args{clearer} = "clear_${name}" if !exists($args{clearer}); |
253 | $args{predicate} = "has_${name}" if !exists($args{predicate}); |
254 | } |
255 | } |
256 | |
257 | return %args; |
258 | } |
259 | |
8fd9e611 |
260 | sub validate_args { |
261 | my $self = shift; |
262 | my $name = shift; |
1bbaa8ed |
263 | my $args = shift; |
8fd9e611 |
264 | |
93d190e0 |
265 | confess "You can not use lazy_build and default for the same attribute ($name)" |
1bbaa8ed |
266 | if $args->{lazy_build} && exists $args->{default}; |
93d190e0 |
267 | |
8fd9e611 |
268 | confess "You cannot have lazy attribute ($name) without specifying a default value for it" |
1bbaa8ed |
269 | if $args->{lazy} |
270 | && !exists($args->{default}) |
271 | && !exists($args->{builder}); |
8fd9e611 |
272 | |
273 | confess "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])" |
1bbaa8ed |
274 | if ref($args->{default}) |
275 | && ref($args->{default}) ne 'CODE'; |
8fd9e611 |
276 | |
97661b77 |
277 | confess "You cannot auto-dereference without specifying a type constraint on attribute ($name)" |
1bbaa8ed |
278 | if $args->{auto_deref} && !exists($args->{isa}); |
8fd9e611 |
279 | |
97661b77 |
280 | confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)" |
1bbaa8ed |
281 | if $args->{auto_deref} |
282 | && $args->{isa} ne 'ArrayRef' |
283 | && $args->{isa} ne 'HashRef'; |
8fd9e611 |
284 | |
506db557 |
285 | if ($args->{trigger}) { |
a08e715f |
286 | if (ref($args->{trigger}) eq 'HASH') { |
287 | Carp::carp "HASH-based form of trigger has been removed. Only the coderef form of triggers are now supported."; |
844fa049 |
288 | } |
506db557 |
289 | |
844fa049 |
290 | confess "Trigger must be a CODE ref on attribute ($name)" |
a08e715f |
291 | if ref($args->{trigger}) ne 'CODE'; |
506db557 |
292 | } |
6c5498d0 |
293 | |
8fd9e611 |
294 | return 1; |
295 | } |
296 | |
5aa30ced |
297 | sub find_type_constraint { |
298 | my $self = shift; |
299 | my $type = $self->type_constraint; |
300 | |
301 | return unless $type; |
302 | |
4188b837 |
303 | my $checker = Mouse::TypeRegistry->optimized_constraints($self->associated_class->name)->{$type}; |
5aa30ced |
304 | return $checker if $checker; |
305 | |
3301fa54 |
306 | return sub { blessed($_) && blessed($_) eq $type }; |
5aa30ced |
307 | } |
308 | |
309 | sub verify_type_constraint { |
310 | my $self = shift; |
311 | local $_ = shift; |
312 | |
313 | my $type = $self->type_constraint |
314 | or return 1; |
af745d5a |
315 | my $constraint = $self->find_type_constraint; |
5aa30ced |
316 | |
317 | return 1 if $constraint->($_); |
318 | |
319 | my $name = $self->name; |
f3e05dfd |
320 | my $display = defined($_) ? overload::StrVal($_) : 'undef'; |
321 | Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display"); |
5aa30ced |
322 | } |
323 | |
4188b837 |
324 | sub coerce_constraint { |
325 | my($self, $value) = @_; |
326 | my $type = $self->type_constraint |
327 | or return $value; |
328 | return Mouse::TypeRegistry->typecast_constraints($self->associated_class->name, $type, $value); |
329 | } |
330 | |
af745d5a |
331 | sub _canonicalize_handles { |
332 | my $self = shift; |
333 | my $handles = shift; |
334 | |
335 | if (ref($handles) eq 'HASH') { |
336 | return %$handles; |
337 | } |
338 | elsif (ref($handles) eq 'ARRAY') { |
339 | return map { $_ => $_ } @$handles; |
340 | } |
341 | else { |
342 | confess "Unable to canonicalize the 'handles' option with $handles"; |
343 | } |
344 | } |
345 | |
1bfebf5f |
346 | sub clone_parent { |
347 | my $self = shift; |
348 | my $class = shift; |
349 | my $name = shift; |
350 | my %args = ($self->get_parent_args($class, $name), @_); |
351 | |
352 | $self->create($class, $name, %args); |
353 | } |
354 | |
355 | sub get_parent_args { |
356 | my $self = shift; |
357 | my $class = shift; |
358 | my $name = shift; |
359 | |
724c77c0 |
360 | for my $super ($class->linearized_isa) { |
bb733405 |
361 | my $super_attr = $super->can("meta") && $super->meta->get_attribute($name) |
1bfebf5f |
362 | or next; |
363 | return %{ $super_attr->_create_args }; |
364 | } |
365 | |
366 | confess "Could not find an attribute by the name of '$name' to inherit from"; |
367 | } |
368 | |
c3398f5b |
369 | 1; |
370 | |
371 | __END__ |
372 | |
373 | =head1 NAME |
374 | |
306290e8 |
375 | Mouse::Meta::Attribute - attribute metaclass |
c3398f5b |
376 | |
377 | =head1 METHODS |
378 | |
306290e8 |
379 | =head2 new %args -> Mouse::Meta::Attribute |
c3398f5b |
380 | |
306290e8 |
381 | Instantiates a new Mouse::Meta::Attribute. Does nothing else. |
c3398f5b |
382 | |
306290e8 |
383 | =head2 create OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute |
c3398f5b |
384 | |
385 | Creates a new attribute in OwnerClass. Accessors and helper methods are |
386 | installed. Some error checking is done. |
387 | |
388 | =head2 name -> AttributeName |
389 | |
181502b9 |
390 | =head2 associated_class -> OwnerClass |
c3398f5b |
391 | |
ab27a55e |
392 | =head2 is_required -> Bool |
c3398f5b |
393 | |
ab27a55e |
394 | =head2 default -> Item |
c3398f5b |
395 | |
ab27a55e |
396 | =head2 has_default -> Bool |
397 | |
398 | =head2 is_lazy -> Bool |
399 | |
400 | =head2 predicate -> MethodName | Undef |
401 | |
402 | =head2 has_predicate -> Bool |
403 | |
404 | =head2 clearer -> MethodName | Undef |
405 | |
406 | =head2 has_clearer -> Bool |
c3398f5b |
407 | |
408 | =head2 handles -> { LocalName => RemoteName } |
409 | |
ab27a55e |
410 | =head2 has_handles -> Bool |
411 | |
3645b316 |
412 | =head2 is_weak_ref -> Bool |
c3398f5b |
413 | |
414 | =head2 init_arg -> Str |
415 | |
ab27a55e |
416 | =head2 type_constraint -> Str |
417 | |
418 | =head2 has_type_constraint -> Bool |
419 | |
420 | =head2 trigger => CODE | Undef |
421 | |
422 | =head2 has_trigger -> Bool |
423 | |
424 | =head2 builder => MethodName | Undef |
425 | |
426 | =head2 has_builder -> Bool |
427 | |
93f08899 |
428 | =head2 is_lazy_build => Bool |
429 | |
0fff36e6 |
430 | =head2 should_auto_deref -> Bool |
431 | |
c3398f5b |
432 | Informational methods. |
433 | |
434 | =head2 generate_accessor -> CODE |
435 | |
436 | Creates a new code reference for the attribute's accessor. |
437 | |
438 | =head2 generate_predicate -> CODE |
439 | |
440 | Creates a new code reference for the attribute's predicate. |
441 | |
442 | =head2 generate_clearer -> CODE |
443 | |
444 | Creates a new code reference for the attribute's clearer. |
445 | |
446 | =head2 generate_handles -> { MethodName => CODE } |
447 | |
448 | Creates a new code reference for each of the attribute's handles methods. |
449 | |
fb706f5c |
450 | =head2 find_type_constraint -> CODE |
451 | |
452 | Returns a code reference which can be used to check that a given value passes |
453 | this attribute's type constraint; |
454 | |
455 | =head2 verify_type_constraint Item -> 1 | ERROR |
456 | |
457 | Checks that the given value passes this attribute's type constraint. Returns 1 |
458 | on success, otherwise C<confess>es. |
459 | |
93d190e0 |
460 | =head2 canonicalize_args Name, %args -> %args |
461 | |
462 | Canonicalizes some arguments to create. In particular, C<lazy_build> is |
463 | canonicalized into C<lazy>, C<builder>, etc. |
464 | |
1bbaa8ed |
465 | =head2 validate_args Name, \%args -> 1 | ERROR |
93d190e0 |
466 | |
467 | Checks that the arguments to create the attribute (ie those specified by |
468 | C<has>) are valid. |
469 | |
f7b11a21 |
470 | =head2 clone_parent OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute |
471 | |
472 | Creates a new attribute in OwnerClass, inheriting options from parent classes. |
473 | Accessors and helper methods are installed. Some error checking is done. |
474 | |
475 | =head2 get_parent_args OwnerClass, AttributeName -> Hash |
476 | |
477 | Returns the options that the parent class of C<OwnerClass> used for attribute |
478 | C<AttributeName>. |
479 | |
c3398f5b |
480 | =cut |
481 | |