1 package Mouse::Meta::Attribute;
7 use Mouse::Util qw(:meta);
9 use Mouse::Meta::TypeConstraint;
10 use Mouse::Meta::Method::Accessor;
13 my($class, $name, $args) = @_;
16 # XXX: for backward compatibility (with method modifiers)
17 if($class->can('canonicalize_args') != \&canonicalize_args){
18 %{$args} = $class->canonicalize_args($name, %{$args});
21 # taken from Class::MOP::Attribute::new
24 or $class->throw_error('You must provide a name for the attribute');
26 if(!exists $args->{init_arg}){
27 $args->{init_arg} = $name;
30 # 'required' requires eigher 'init_arg', 'builder', or 'default'
31 my $can_be_required = defined( $args->{init_arg} );
33 if(exists $args->{builder}){
34 $class->throw_error('builder must be a defined scalar value which is a method name')
35 if ref $args->{builder} || !(defined $args->{builder});
39 elsif(exists $args->{default}){
40 if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
41 $class->throw_error("References are not allowed as default values, you must "
42 . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
47 if( $args->{required} && !$can_be_required ) {
48 $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
51 # taken from Mouse::Meta::Attribute->new and _process_args->
53 if(exists $args->{is}){
57 $args->{reader} ||= $name;
60 if(exists $args->{writer}){
61 $args->{reader} ||= $name;
64 $args->{accessor} ||= $name;
68 # do nothing, but don't complain (later) about missing methods
71 $is = 'undef' if !defined $is;
72 $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
77 if(exists $args->{isa}){
78 $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
80 elsif(exists $args->{does}){
82 # $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
84 $tc = $args->{type_constraint};
88 || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
91 && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
94 if ($args->{lazy_build}) {
95 exists($args->{default})
96 && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
99 $args->{builder} ||= "_build_${name}";
101 $args->{clearer} ||= "_clear${name}";
102 $args->{predicate} ||= "_has${name}";
105 $args->{clearer} ||= "clear_${name}";
106 $args->{predicate} ||= "has_${name}";
110 if ($args->{auto_deref}) {
112 || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
114 ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') )
115 || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
118 if (exists $args->{trigger}) {
119 ('CODE' eq ref $args->{trigger})
120 || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
124 (exists $args->{default} || defined $args->{builder})
125 || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
135 my %args = (@_ == 1) ? %{ $_[0] } : @_;
137 $class->_process_options($name, \%args);
141 my $instance = bless \%args, $class;
144 if($class ne __PACKAGE__){
145 $class->meta->_initialize_instance($instance,\%args);
148 # XXX: there is no fast way to check attribute validity
152 # Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad");
160 sub name { $_[0]->{name} }
161 sub associated_class { $_[0]->{associated_class} }
163 sub accessor { $_[0]->{accessor} }
164 sub reader { $_[0]->{reader} }
165 sub writer { $_[0]->{writer} }
166 sub predicate { $_[0]->{predicate} }
167 sub clearer { $_[0]->{clearer} }
168 sub handles { $_[0]->{handles} }
170 sub _is_metadata { $_[0]->{is} }
171 sub is_required { $_[0]->{required} }
172 sub default { $_[0]->{default} }
173 sub is_lazy { $_[0]->{lazy} }
174 sub is_lazy_build { $_[0]->{lazy_build} }
175 sub is_weak_ref { $_[0]->{weak_ref} }
176 sub init_arg { $_[0]->{init_arg} }
177 sub type_constraint { $_[0]->{type_constraint} }
179 sub trigger { $_[0]->{trigger} }
180 sub builder { $_[0]->{builder} }
181 sub should_auto_deref { $_[0]->{auto_deref} }
182 sub should_coerce { $_[0]->{coerce} }
184 sub get_read_method { $_[0]->{reader} || $_[0]->{accessor} }
185 sub get_write_method { $_[0]->{writer} || $_[0]->{accessor} }
189 sub has_accessor { exists $_[0]->{accessor} }
190 sub has_reader { exists $_[0]->{reader} }
191 sub has_writer { exists $_[0]->{writer} }
192 sub has_predicate { exists $_[0]->{predicate} }
193 sub has_clearer { exists $_[0]->{clearer} }
194 sub has_handles { exists $_[0]->{handles} }
196 sub has_default { exists $_[0]->{default} }
197 sub has_type_constraint { exists $_[0]->{type_constraint} }
198 sub has_trigger { exists $_[0]->{trigger} }
199 sub has_builder { exists $_[0]->{builder} }
201 sub has_read_method { exists $_[0]->{reader} || exists $_[0]->{accessor} }
202 sub has_write_method { exists $_[0]->{writer} || exists $_[0]->{accessor} }
205 $_[0]->{_create_args} = $_[1] if @_ > 1;
206 $_[0]->{_create_args}
209 sub interpolate_class{
210 my($class, $name, $args) = @_;
212 if(my $metaclass = delete $args->{metaclass}){
213 $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass );
217 if(my $traits_ref = delete $args->{traits}){
219 for (my $i = 0; $i < @{$traits_ref}; $i++) {
220 my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1);
222 next if $class->does($trait);
224 push @traits, $trait;
227 push @traits, $traits_ref->[++$i]
228 if ref($traits_ref->[$i+1]);
232 $class = Mouse::Meta::Class->create_anon_class(
233 superclasses => [ $class ],
240 return( $class, @traits );
243 sub canonicalize_args{
244 my ($self, $name, %args) = @_;
246 Carp::cluck("$self->canonicalize_args has been deprecated."
247 . "Use \$self->_process_options instead.")
254 my ($self, $class, $name, %args) = @_;
256 Carp::cluck("$self->create has been deprecated."
257 . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
264 sub verify_against_type_constraint {
265 my ($self, $value) = @_;
266 my $tc = $self->type_constraint;
270 return 1 if $tc->check($value);
272 $self->verify_type_constraint_error($self->name, $value, $tc);
275 sub verify_type_constraint_error {
276 my($self, $name, $value, $type) = @_;
277 $self->throw_error("Attribute ($name) does not pass the type constraint because: " . $type->get_message($value));
280 sub coerce_constraint { ## my($self, $value) = @_;
281 my $type = $_[0]->{type_constraint}
283 return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]);
286 sub _canonicalize_handles {
290 if (ref($handles) eq 'HASH') {
293 elsif (ref($handles) eq 'ARRAY') {
294 return map { $_ => $_ } @$handles;
297 $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
301 sub clone_and_inherit_options{
305 return ref($self)->new($name, %{$self}, (@_ == 1) ? %{$_[0]} : @_);
312 my %args = ($self->get_parent_args($class, $name), @_);
314 Carp::cluck("$self->clone_parent has been deprecated."
315 . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
318 $self->clone_and_inherited_args($class, $name, %args);
321 sub get_parent_args {
326 for my $super ($class->linearized_isa) {
327 my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
329 return %{ $super_attr->_create_args };
332 $self->throw_error("Could not find an attribute by the name of '$name' to inherit from");
335 sub associate_method{
336 my ($attribute, $method) = @_;
337 $attribute->{associated_methods}++;
341 sub install_accessors{
344 my $metaclass = $attribute->{associated_class};
346 foreach my $type(qw(accessor reader writer predicate clearer handles)){
347 if(exists $attribute->{$type}){
348 my $installer = '_install_' . $type;
350 Mouse::Meta::Method::Accessor->$installer($attribute, $attribute->{$type}, $metaclass);
352 $attribute->{associated_methods}++;
356 if($attribute->can('create') != \&create){
357 # backword compatibility
358 $attribute->create($metaclass, $attribute->name, %{$attribute});
367 my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class';
368 $metaclass->throw_error(@_, depth => 1);
377 Mouse::Meta::Attribute - attribute metaclass
381 =head2 C<< new(%options) -> Mouse::Meta::Attribute >>
383 Instantiates a new Mouse::Meta::Attribute. Does nothing else.
385 It adds the following options to the constructor:
389 =item C<< is => 'ro', 'rw', 'bare' >>
391 This provides a shorthand for specifying the C<reader>, C<writer>, or
392 C<accessor> names. If the attribute is read-only ('ro') then it will
393 have a C<reader> method with the same attribute as the name.
395 If it is read-write ('rw') then it will have an C<accessor> method
396 with the same name. If you provide an explicit C<writer> for a
397 read-write attribute, then you will have a C<reader> with the same
398 name as the attribute, and a C<writer> with the name you provided.
400 Use 'bare' when you are deliberately not installing any methods
401 (accessor, reader, etc.) associated with this attribute; otherwise,
402 Moose will issue a deprecation warning when this attribute is added to a
405 =item C<< isa => Type >>
407 This option accepts a type. The type can be a string, which should be
408 a type name. If the type name is unknown, it is assumed to be a class
411 This option can also accept a L<Moose::Meta::TypeConstraint> object.
413 If you I<also> provide a C<does> option, then your C<isa> option must
414 be a class name, and that class must do the role specified with
417 =item C<< does => Role >>
419 This is short-hand for saying that the attribute's type must be an
420 object which does the named role.
422 B<This option is not yet supported.>
424 =item C<< coerce => Bool >>
426 This option is only valid for objects with a type constraint
427 (C<isa>). If this is true, then coercions will be applied whenever
428 this attribute is set.
430 You can make both this and the C<weak_ref> option true.
432 =item C<< trigger => CodeRef >>
434 This option accepts a subroutine reference, which will be called after
435 the attribute is set.
437 =item C<< required => Bool >>
439 An attribute which is required must be provided to the constructor. An
440 attribute which is required can also have a C<default> or C<builder>,
441 which will satisfy its required-ness.
443 A required attribute must have a C<default>, C<builder> or a
444 non-C<undef> C<init_arg>
446 =item C<< lazy => Bool >>
448 A lazy attribute must have a C<default> or C<builder>. When an
449 attribute is lazy, the default value will not be calculated until the
452 =item C<< weak_ref => Bool >>
454 If this is true, the attribute's value will be stored as a weak
457 =item C<< auto_deref => Bool >>
459 If this is true, then the reader will dereference the value when it is
460 called. The attribute must have a type constraint which defines the
461 attribute as an array or hash reference.
463 =item C<< lazy_build => Bool >>
465 Setting this to true makes the attribute lazy and provides a number of
473 is equivalent to this:
478 builder => '_build_size',
479 clearer => 'clear_size',
480 predicate => 'has_size',
485 =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >>
487 Checks that the given value passes this attribute's type constraint. Returns C<true>
488 on success, otherwise C<confess>es.
490 =head2 C<< clone_and_inherit_options(options) -> Mouse::Meta::Attribute >>
492 Creates a new attribute in the owner class, inheriting options from parent classes.
493 Accessors and helper methods are installed. Some error checking is done.
497 L<Moose::Meta::Attribute>