lib/Mouse/Meta/Attribute.pm

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