2 package Mouse::Meta::Attribute;
7 use Scalar::Util 'blessed';
13 my $name = $args{name};
15 $args{init_arg} = $name
16 unless exists $args{init_arg};
23 sub name { $_[0]->{name} }
24 sub class { $_[0]->{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;
63 my $trigger = $attribute->trigger;
64 my $before = $trigger->{before};
65 my $after = $trigger->{after};
66 my $around = $trigger->{around};
71 if ($attribute->_is_metadata eq 'rw') {
72 $accessor .= 'if (@_) {
76 $accessor .= '$before->($self, $_, $attribute);';
81 my $display = defined($_) ? overload::StrVal($_) : "undef";
82 Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display") unless $constraint->();
86 $accessor .= '$self->{$key} = $_;';
88 if ($attribute->is_weak_ref) {
89 $accessor .= 'Scalar::Util::weaken($self->{$key}) if ref($self->{$key});';
93 $accessor .= '$after->($self, $_, $attribute);';
99 $accessor .= 'confess "Cannot assign a value to a read-only accessor" if @_;';
102 if ($attribute->is_lazy) {
103 $accessor .= '$self->{$key} = ';
105 $accessor .= $attribute->has_builder
107 : ref($default) eq 'CODE'
108 ? '$default->($self)'
111 $accessor .= ' if !exists($self->{$key});';
114 if ($attribute->should_auto_deref) {
115 if ($attribute->type_constraint eq 'ArrayRef') {
116 $accessor .= 'if (wantarray) {
117 return @{ $self->{$key} || [] };
121 $accessor .= 'if (wantarray) {
122 return %{ $self->{$key} || {} };
127 $accessor .= 'return $self->{$key};
130 return eval $accessor;
133 sub generate_predicate {
134 my $attribute = shift;
135 my $key = $attribute->name;
137 my $predicate = 'sub { exists($_[0]->{$key}) }';
139 return eval $predicate;
142 sub generate_clearer {
143 my $attribute = shift;
144 my $key = $attribute->name;
146 my $predicate = 'sub { delete($_[0]->{$key}) }';
148 return eval $predicate;
151 sub generate_handles {
152 my $attribute = shift;
153 my $reader = $attribute->name;
154 my %handles = $attribute->_canonicalize_handles($attribute->handles);
158 for my $local_method (keys %handles) {
159 my $remote_method = $handles{$local_method};
163 $self->$reader->$remote_method(@_)
166 $method_map{$local_method} = eval $method;
173 my ($self, $class, $name, %args) = @_;
176 $args{class} = $class;
178 %args = $self->canonicalize_args($name, %args);
179 $self->validate_args($name, \%args);
181 $args{type_constraint} = delete $args{isa}
182 if exists $args{isa};
184 my $attribute = $self->new(%args);
185 $attribute->_create_args(\%args);
187 my $meta = $class->meta;
189 $meta->add_attribute($attribute);
191 # install an accessor
192 if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') {
193 my $accessor = $attribute->generate_accessor;
195 *{ $class . '::' . $name } = $accessor;
198 for my $method (qw/predicate clearer/) {
199 my $predicate = "has_$method";
200 if ($attribute->$predicate) {
201 my $generator = "generate_$method";
202 my $coderef = $attribute->$generator;
204 *{ $class . '::' . $attribute->$method } = $coderef;
208 if ($attribute->has_handles) {
209 my $method_map = $attribute->generate_handles;
210 for my $method_name (keys %$method_map) {
212 *{ $class . '::' . $method_name } = $method_map->{$method_name};
219 sub canonicalize_args {
224 if ($args{lazy_build}) {
227 $args{builder} = "_build_${name}"
228 if !exists($args{builder});
230 $args{clearer} = "_clear${name}" if !exists($args{clearer});
231 $args{predicate} = "_has${name}" if !exists($args{predicate});
234 $args{clearer} = "clear_${name}" if !exists($args{clearer});
235 $args{predicate} = "has_${name}" if !exists($args{predicate});
247 confess "You can not use lazy_build and default for the same attribute ($name)"
248 if $args->{lazy_build} && exists $args->{default};
250 confess "You cannot have lazy attribute ($name) without specifying a default value for it"
252 && !exists($args->{default})
253 && !exists($args->{builder});
255 confess "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"
256 if ref($args->{default})
257 && ref($args->{default}) ne 'CODE';
259 confess "You cannot auto-dereference without specifying a type constraint on attribute $name"
260 if $args->{auto_deref} && !exists($args->{isa});
262 confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute $name"
263 if $args->{auto_deref}
264 && $args->{isa} ne 'ArrayRef'
265 && $args->{isa} ne 'HashRef';
267 if ($args->{trigger}) {
268 if (ref($args->{trigger}) eq 'CODE') {
270 after => $args->{trigger},
274 confess "Trigger must be a CODE or HASH ref on attribute ($name)"
276 && ref($args->{trigger}) ne 'HASH';
282 sub find_type_constraint {
284 my $type = $self->type_constraint;
288 my $checker = Mouse::TypeRegistry->optimized_constraints->{$type};
289 return $checker if $checker;
291 return sub { blessed($_) && blessed($_) eq $type };
294 sub verify_type_constraint {
298 my $type = $self->type_constraint
300 my $constraint = $self->find_type_constraint;
302 return 1 if $constraint->($_);
304 my $name = $self->name;
305 my $display = defined($_) ? overload::StrVal($_) : 'undef';
306 Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display");
309 sub _canonicalize_handles {
313 if (ref($handles) eq 'HASH') {
316 elsif (ref($handles) eq 'ARRAY') {
317 return map { $_ => $_ } @$handles;
320 confess "Unable to canonicalize the 'handles' option with $handles";
328 my %args = ($self->get_parent_args($class, $name), @_);
330 $self->create($class, $name, %args);
333 sub get_parent_args {
338 for my $super ($class->meta->linearized_isa) {
339 my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
341 return %{ $super_attr->_create_args };
344 confess "Could not find an attribute by the name of '$name' to inherit from";
353 Mouse::Meta::Attribute - attribute metaclass
357 =head2 new %args -> Mouse::Meta::Attribute
359 Instantiates a new Mouse::Meta::Attribute. Does nothing else.
361 =head2 create OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute
363 Creates a new attribute in OwnerClass. Accessors and helper methods are
364 installed. Some error checking is done.
366 =head2 name -> AttributeName
368 =head2 class -> OwnerClass
370 =head2 is_required -> Bool
372 =head2 default -> Item
374 =head2 has_default -> Bool
376 =head2 is_lazy -> Bool
378 =head2 predicate -> MethodName | Undef
380 =head2 has_predicate -> Bool
382 =head2 clearer -> MethodName | Undef
384 =head2 has_clearer -> Bool
386 =head2 handles -> { LocalName => RemoteName }
388 =head2 has_handles -> Bool
390 =head2 is_weak_ref -> Bool
392 =head2 init_arg -> Str
394 =head2 type_constraint -> Str
396 =head2 has_type_constraint -> Bool
398 =head2 trigger => CODE | Undef
400 =head2 has_trigger -> Bool
402 =head2 builder => MethodName | Undef
404 =head2 has_builder -> Bool
406 =head2 is_lazy_build => Bool
408 =head2 should_auto_deref -> Bool
410 Informational methods.
412 =head2 generate_accessor -> CODE
414 Creates a new code reference for the attribute's accessor.
416 =head2 generate_predicate -> CODE
418 Creates a new code reference for the attribute's predicate.
420 =head2 generate_clearer -> CODE
422 Creates a new code reference for the attribute's clearer.
424 =head2 generate_handles -> { MethodName => CODE }
426 Creates a new code reference for each of the attribute's handles methods.
428 =head2 find_type_constraint -> CODE
430 Returns a code reference which can be used to check that a given value passes
431 this attribute's type constraint;
433 =head2 verify_type_constraint Item -> 1 | ERROR
435 Checks that the given value passes this attribute's type constraint. Returns 1
436 on success, otherwise C<confess>es.
438 =head2 canonicalize_args Name, %args -> %args
440 Canonicalizes some arguments to create. In particular, C<lazy_build> is
441 canonicalized into C<lazy>, C<builder>, etc.
443 =head2 validate_args Name, \%args -> 1 | ERROR
445 Checks that the arguments to create the attribute (ie those specified by
448 =head2 clone_parent OwnerClass, AttributeName, %args -> Mouse::Meta::Attribute
450 Creates a new attribute in OwnerClass, inheriting options from parent classes.
451 Accessors and helper methods are installed. Some error checking is done.
453 =head2 get_parent_args OwnerClass, AttributeName -> Hash
455 Returns the options that the parent class of C<OwnerClass> used for attribute