2 package Mouse::Meta::Attribute;
7 use Mouse::Util qw/blessed weaken/;
13 my $name = $args{name};
15 $args{init_arg} = $name
16 unless exists $args{init_arg};
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} }
40 sub has_default { exists $_[0]->{default} }
41 sub has_predicate { exists $_[0]->{predicate} }
42 sub has_clearer { exists $_[0]->{clearer} }
43 sub has_handles { exists $_[0]->{handles} }
44 sub has_type_constraint { exists $_[0]->{type_constraint} }
45 sub has_trigger { exists $_[0]->{trigger} }
46 sub has_builder { exists $_[0]->{builder} }
49 $_[0]->{_create_args} = $_[1] if @_ > 1;
53 sub generate_accessor {
54 my $attribute = shift;
56 my $name = $attribute->name;
58 my $default = $attribute->default;
59 my $type = $attribute->type_constraint;
60 my $constraint = $attribute->find_type_constraint;
61 my $builder = $attribute->builder;
62 my $trigger = $attribute->trigger;
67 if ($attribute->_is_metadata eq 'rw') {
68 $accessor .= 'if (@_) {
72 $accessor .= 'unless ($constraint->()) {
73 my $display = defined($_) ? overload::StrVal($_) : "undef";
74 Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display");
78 $accessor .= '$self->{$key} = $_;';
80 if ($attribute->is_weak_ref) {
81 $accessor .= 'weaken($self->{$key}) if ref($self->{$key});';
85 $accessor .= '$trigger->($self, $_, $attribute);';
91 $accessor .= 'confess "Cannot assign a value to a read-only accessor" if @_;';
94 if ($attribute->is_lazy) {
95 $accessor .= '$self->{$key} = ';
97 $accessor .= $attribute->has_builder
99 : ref($default) eq 'CODE'
100 ? '$default->($self)'
103 $accessor .= ' if !exists($self->{$key});';
106 if ($attribute->should_auto_deref) {
107 if ($attribute->type_constraint eq 'ArrayRef') {
108 $accessor .= 'if (wantarray) {
109 return @{ $self->{$key} || [] };
113 $accessor .= 'if (wantarray) {
114 return %{ $self->{$key} || {} };
119 $accessor .= 'return $self->{$key};
122 return eval $accessor;
125 sub generate_predicate {
126 my $attribute = shift;
127 my $key = $attribute->name;
129 my $predicate = 'sub { exists($_[0]->{$key}) }';
131 return eval $predicate;
134 sub generate_clearer {
135 my $attribute = shift;
136 my $key = $attribute->name;
138 my $predicate = 'sub { delete($_[0]->{$key}) }';
140 return eval $predicate;
143 sub generate_handles {
144 my $attribute = shift;
145 my $reader = $attribute->name;
146 my %handles = $attribute->_canonicalize_handles($attribute->handles);
150 for my $local_method (keys %handles) {
151 my $remote_method = $handles{$local_method};
155 $self->$reader->$remote_method(@_)
158 $method_map{$local_method} = eval $method;
165 my ($self, $class, $name, %args) = @_;
168 $args{associated_class} = $class;
170 %args = $self->canonicalize_args($name, %args);
171 $self->validate_args($name, \%args);
173 $args{type_constraint} = delete $args{isa}
174 if exists $args{isa};
176 my $attribute = $self->new(%args);
178 $attribute->_create_args(\%args);
180 $class->add_attribute($attribute);
182 # install an accessor
183 if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') {
184 my $accessor = $attribute->generate_accessor;
185 $class->add_method($name => $accessor);
188 for my $method (qw/predicate clearer/) {
189 my $predicate = "has_$method";
190 if ($attribute->$predicate) {
191 my $generator = "generate_$method";
192 my $coderef = $attribute->$generator;
193 $class->add_method($attribute->$method => $coderef);
197 if ($attribute->has_handles) {
198 my $method_map = $attribute->generate_handles;
199 for my $method_name (keys %$method_map) {
200 $class->add_method($method_name => $method_map->{$method_name});
207 sub canonicalize_args {
212 if ($args{lazy_build}) {
215 $args{builder} = "_build_${name}"
216 if !exists($args{builder});
218 $args{clearer} = "_clear${name}" if !exists($args{clearer});
219 $args{predicate} = "_has${name}" if !exists($args{predicate});
222 $args{clearer} = "clear_${name}" if !exists($args{clearer});
223 $args{predicate} = "has_${name}" if !exists($args{predicate});
235 confess "You can not use lazy_build and default for the same attribute ($name)"
236 if $args->{lazy_build} && exists $args->{default};
238 confess "You cannot have lazy attribute ($name) without specifying a default value for it"
240 && !exists($args->{default})
241 && !exists($args->{builder});
243 confess "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"
244 if ref($args->{default})
245 && ref($args->{default}) ne 'CODE';
247 confess "You cannot auto-dereference without specifying a type constraint on attribute ($name)"
248 if $args->{auto_deref} && !exists($args->{isa});
250 confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)"
251 if $args->{auto_deref}
252 && $args->{isa} ne 'ArrayRef'
253 && $args->{isa} ne 'HashRef';
255 if ($args->{trigger}) {
256 if (ref($args->{trigger}) eq 'HASH') {
257 Carp::carp "HASH-based form of trigger has been removed. Only the coderef form of triggers are now supported.";
260 confess "Trigger must be a CODE ref on attribute ($name)"
261 if ref($args->{trigger}) ne 'CODE';
267 sub find_type_constraint {
269 my $type = $self->type_constraint;
273 my $checker = Mouse::TypeRegistry->optimized_constraints->{$type};
274 return $checker if $checker;
276 return sub { blessed($_) && blessed($_) eq $type };
279 sub verify_type_constraint {
283 my $type = $self->type_constraint
285 my $constraint = $self->find_type_constraint;
287 return 1 if $constraint->($_);
289 my $name = $self->name;
290 my $display = defined($_) ? overload::StrVal($_) : 'undef';
291 Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display");
294 sub _canonicalize_handles {
298 if (ref($handles) eq 'HASH') {
301 elsif (ref($handles) eq 'ARRAY') {
302 return map { $_ => $_ } @$handles;
305 confess "Unable to canonicalize the 'handles' option with $handles";
313 my %args = ($self->get_parent_args($class, $name), @_);
315 $self->create($class, $name, %args);
318 sub get_parent_args {
323 for my $super ($class->linearized_isa) {
324 my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
326 return %{ $super_attr->_create_args };
329 confess "Could not find an attribute by the name of '$name' to inherit from";
338 Mouse::Meta::Attribute - attribute metaclass
342 =head2 new %args -> Mouse::Meta::Attribute
344 Instantiates a new Mouse::Meta::Attribute. Does nothing else.
346 =head2 create OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute
348 Creates a new attribute in OwnerClass. Accessors and helper methods are
349 installed. Some error checking is done.
351 =head2 name -> AttributeName
353 =head2 associated_class -> OwnerClass
355 =head2 is_required -> Bool
357 =head2 default -> Item
359 =head2 has_default -> Bool
361 =head2 is_lazy -> Bool
363 =head2 predicate -> MethodName | Undef
365 =head2 has_predicate -> Bool
367 =head2 clearer -> MethodName | Undef
369 =head2 has_clearer -> Bool
371 =head2 handles -> { LocalName => RemoteName }
373 =head2 has_handles -> Bool
375 =head2 is_weak_ref -> Bool
377 =head2 init_arg -> Str
379 =head2 type_constraint -> Str
381 =head2 has_type_constraint -> Bool
383 =head2 trigger => CODE | Undef
385 =head2 has_trigger -> Bool
387 =head2 builder => MethodName | Undef
389 =head2 has_builder -> Bool
391 =head2 is_lazy_build => Bool
393 =head2 should_auto_deref -> Bool
395 Informational methods.
397 =head2 generate_accessor -> CODE
399 Creates a new code reference for the attribute's accessor.
401 =head2 generate_predicate -> CODE
403 Creates a new code reference for the attribute's predicate.
405 =head2 generate_clearer -> CODE
407 Creates a new code reference for the attribute's clearer.
409 =head2 generate_handles -> { MethodName => CODE }
411 Creates a new code reference for each of the attribute's handles methods.
413 =head2 find_type_constraint -> CODE
415 Returns a code reference which can be used to check that a given value passes
416 this attribute's type constraint;
418 =head2 verify_type_constraint Item -> 1 | ERROR
420 Checks that the given value passes this attribute's type constraint. Returns 1
421 on success, otherwise C<confess>es.
423 =head2 canonicalize_args Name, %args -> %args
425 Canonicalizes some arguments to create. In particular, C<lazy_build> is
426 canonicalized into C<lazy>, C<builder>, etc.
428 =head2 validate_args Name, \%args -> 1 | ERROR
430 Checks that the arguments to create the attribute (ie those specified by
433 =head2 clone_parent OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute
435 Creates a new attribute in OwnerClass, inheriting options from parent classes.
436 Accessors and helper methods are installed. Some error checking is done.
438 =head2 get_parent_args OwnerClass, AttributeName -> Hash
440 Returns the options that the parent class of C<OwnerClass> used for attribute