lib/Mouse/Meta/Class.pm

   1 package Mouse::Meta::Class;
   2 use Mouse::Util qw/:meta get_linear_isa not_supported/; # enables strict and warnings
   3
   4 use Scalar::Util qw/blessed weaken/;
   5
   6 use Mouse::Meta::Module;
   7 our @ISA = qw(Mouse::Meta::Module);
   8
   9 sub attribute_metaclass;
  10 sub method_metaclass;
  11
  12 sub constructor_class;
  13 sub destructor_class;
  14
  15 my @MetaClassTypes = qw(
  16     attribute_metaclass
  17     method_metaclass
  18     constructor_class
  19     destructor_class
  20 );
  21
  22 sub _construct_meta {
  23     my($class, %args) = @_;
  24
  25     $args{attributes} = {};
  26     $args{methods}    = {};
  27     $args{roles}      = [];
  28
  29     $args{superclasses} = do {
  30         no strict 'refs';
  31         \@{ $args{package} . '::ISA' };
  32     };
  33
  34     my $self = bless \%args, ref($class) || $class;
  35     if(ref($self) ne __PACKAGE__){
  36         $self->meta->_initialize_object($self, \%args);
  37     }
  38     return $self;
  39 }
  40
  41 sub create_anon_class{
  42     my $self = shift;
  43     return $self->create(undef, @_);
  44 }
  45
  46 sub is_anon_class;
  47
  48 sub roles;
  49
  50 sub calculate_all_roles {
  51     my $self = shift;
  52     my %seen;
  53     return grep { !$seen{ $_->name }++ }
  54            map  { $_->calculate_all_roles } @{ $self->roles };
  55 }
  56
  57 sub superclasses {
  58     my $self = shift;
  59
  60     if (@_) {
  61         foreach my $super(@_){
  62             Mouse::Util::load_class($super);
  63             my $meta = Mouse::Util::get_metaclass_by_name($super);
  64
  65             next if not defined $meta;
  66
  67             if(Mouse::Util::is_a_metarole($meta)){
  68                 $self->throw_error("You cannot inherit from a Mouse Role ($super)");
  69             }
  70
  71             next if $self->isa(ref $meta); # _superclass_meta_is_compatible
  72
  73             $self->_reconcile_with_superclass_meta($meta);
  74         }
  75         @{ $self->{superclasses} } = @_;
  76     }
  77
  78     return @{ $self->{superclasses} };
  79 }
  80
  81 sub _reconcile_with_superclass_meta {
  82     my($self, $super_meta) = @_;
  83
  84     my @incompatibles;
  85
  86     foreach my $metaclass_type(@MetaClassTypes){
  87         my $super_c = $super_meta->$metaclass_type();
  88         my $self_c  = $self->$metaclass_type();
  89
  90         if(!$super_c->isa($self_c)){
  91             push @incompatibles, ($metaclass_type => $super_c);
  92         }
  93     }
  94
  95     my @roles;
  96
  97     foreach my $role($self->meta->calculate_all_roles){
  98         if(!$super_meta->meta->does_role($role->name)){
  99             push @roles, $role->name;
 100         }
 101     }
 102
 103     #print "reconcile($self vs. $super_meta; @roles; @incompatibles)\n";
 104
 105     require Mouse::Util::MetaRole;
 106     Mouse::Util::MetaRole::apply_metaclass_roles(
 107         for_class       => $self,
 108         metaclass       => ref $super_meta,
 109         metaclass_roles => \@roles,
 110         @incompatibles,
 111     );
 112     return;
 113 }
 114
 115 sub find_method_by_name{
 116     my($self, $method_name) = @_;
 117     defined($method_name)
 118         or $self->throw_error('You must define a method name to find');
 119
 120     foreach my $class( $self->linearized_isa ){
 121         my $method = $self->initialize($class)->get_method($method_name);
 122         return $method if defined $method;
 123     }
 124     return undef;
 125 }
 126
 127 sub get_all_methods {
 128     my($self) = @_;
 129     return map{ $self->find_method_by_name($_) } $self->get_all_method_names;
 130 }
 131
 132 sub get_all_method_names {
 133     my $self = shift;
 134     my %uniq;
 135     return grep { $uniq{$_}++ == 0 }
 136             map { Mouse::Meta::Class->initialize($_)->get_method_list() }
 137             $self->linearized_isa;
 138 }
 139
 140 sub find_attribute_by_name{
 141     my($self, $name) = @_;
 142     my $attr;
 143     foreach my $class($self->linearized_isa){
 144         my $meta = Mouse::Util::get_metaclass_by_name($class) or next;
 145         $attr = $meta->get_attribute($name) and last;
 146     }
 147     return $attr;
 148 }
 149
 150 sub add_attribute {
 151     my $self = shift;
 152
 153     my($attr, $name);
 154
 155     if(blessed $_[0]){
 156         $attr = $_[0];
 157
 158         $attr->isa('Mouse::Meta::Attribute')
 159             || $self->throw_error("Your attribute must be an instance of Mouse::Meta::Attribute (or a subclass)");
 160
 161         $name = $attr->name;
 162     }
 163     else{
 164         # _process_attribute
 165         $name = shift;
 166
 167         my %args = (@_ == 1) ? %{$_[0]} : @_;
 168
 169         defined($name)
 170             or $self->throw_error('You must provide a name for the attribute');
 171
 172         if ($name =~ s/^\+//) { # inherited attributes
 173             my $inherited_attr = $self->find_attribute_by_name($name)
 174                 or $self->throw_error("Could not find an attribute by the name of '$name' to inherit from in ".$self->name);
 175
 176             $attr = $inherited_attr->clone_and_inherit_options(%args);
 177         }
 178         else{
 179             my($attribute_class, @traits) = $self->attribute_metaclass->interpolate_class(\%args);
 180             $args{traits} = \@traits if @traits;
 181
 182             $attr = $attribute_class->new($name, %args);
 183         }
 184     }
 185
 186     weaken( $attr->{associated_class} = $self );
 187
 188     $self->{attributes}{$attr->name} = $attr;
 189     $attr->install_accessors();
 190
 191     if(Mouse::Util::_MOUSE_VERBOSE && !$attr->{associated_methods} && ($attr->{is} || '') ne 'bare'){
 192         Carp::cluck(qq{Attribute (}.$attr->name.qq{) of class }.$self->name.qq{ has no associated methods (did you mean to provide an "is" argument?)});
 193     }
 194     return $attr;
 195 }
 196
 197 sub compute_all_applicable_attributes { # DEPRECATED
 198     Carp::cluck('compute_all_applicable_attributes() has been deprecated. Use get_all_attributes() instead');
 199
 200     return shift->get_all_attributes(@_)
 201 }
 202
 203 sub linearized_isa;
 204
 205 sub new_object;
 206
 207 sub clone_object {
 208     my $class  = shift;
 209     my $object = shift;
 210     my $args   = $object->Mouse::Object::BUILDARGS(@_);
 211
 212     (blessed($object) && $object->isa($class->name))
 213         || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
 214
 215     my $cloned = bless { %$object }, ref $object;
 216     $class->_initialize_object($cloned, $args);
 217
 218     return $cloned;
 219 }
 220
 221 sub clone_instance { # DEPRECATED
 222     my ($class, $instance, %params) = @_;
 223
 224     Carp::cluck('clone_instance() has been deprecated. Use clone_object() instead');
 225
 226     return $class->clone_object($instance, %params);
 227 }
 228
 229
 230 sub immutable_options {
 231     my ( $self, @args ) = @_;
 232
 233     return (
 234         inline_constructor => 1,
 235         inline_destructor  => 1,
 236         constructor_name   => 'new',
 237         @args,
 238     );
 239 }
 240
 241
 242 sub make_immutable {
 243     my $self = shift;
 244     my %args = $self->immutable_options(@_);
 245
 246     $self->{is_immutable}++;
 247
 248     if ($args{inline_constructor}) {
 249         my $c = $self->constructor_class;
 250         Mouse::Util::load_class($c);
 251         $self->add_method($args{constructor_name} =>
 252             $c->_generate_constructor($self, \%args));
 253     }
 254
 255     if ($args{inline_destructor}) {
 256         my $c = $self->destructor_class;
 257         Mouse::Util::load_class($c);
 258         $self->add_method(DESTROY =>
 259             $c->_generate_destructor($self, \%args));
 260     }
 261
 262     # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
 263     # at the end of a source file.
 264     return 1;
 265 }
 266
 267 sub make_mutable {
 268     my($self) = @_;
 269     $self->{is_immutable} = 0;
 270     return;
 271 }
 272
 273 sub is_immutable;
 274 sub is_mutable   { !$_[0]->is_immutable }
 275
 276 sub _install_modifier_pp{
 277     my( $self, $type, $name, $code ) = @_;
 278     my $into = $self->name;
 279
 280     my $original = $into->can($name)
 281         or $self->throw_error("The method '$name' is not found in the inheritance hierarchy for class $into");
 282
 283     my $modifier_table = $self->{modifiers}{$name};
 284
 285     if(!$modifier_table){
 286         my(@before, @after, @around, $cache, $modified);
 287
 288         $cache = $original;
 289
 290         $modified = sub {
 291             for my $c (@before) { $c->(@_) }
 292
 293             if(wantarray){ # list context
 294                 my @rval = $cache->(@_);
 295
 296                 for my $c(@after){ $c->(@_) }
 297                 return @rval;
 298             }
 299             elsif(defined wantarray){ # scalar context
 300                 my $rval = $cache->(@_);
 301
 302                 for my $c(@after){ $c->(@_) }
 303                 return $rval;
 304             }
 305             else{ # void context
 306                 $cache->(@_);
 307
 308                 for my $c(@after){ $c->(@_) }
 309                 return;
 310             }
 311         };
 312
 313         $self->{modifiers}{$name} = $modifier_table = {
 314             original => $original,
 315
 316             before   => \@before,
 317             after    => \@after,
 318             around   => \@around,
 319
 320             cache    => \$cache, # cache for around modifiers
 321         };
 322
 323         $self->add_method($name => $modified);
 324     }
 325
 326     if($type eq 'before'){
 327         unshift @{$modifier_table->{before}}, $code;
 328     }
 329     elsif($type eq 'after'){
 330         push @{$modifier_table->{after}}, $code;
 331     }
 332     else{ # around
 333         push @{$modifier_table->{around}}, $code;
 334
 335         my $next = ${ $modifier_table->{cache} };
 336         ${ $modifier_table->{cache} } = sub{ $code->($next, @_) };
 337     }
 338
 339     return;
 340 }
 341
 342 sub _install_modifier {
 343     my ( $self, $type, $name, $code ) = @_;
 344
 345     # load Class::Method::Modifiers first
 346     my $no_cmm_fast = do{
 347         local $@;
 348         eval q{ use Class::Method::Modifiers::Fast 0.041 () };
 349         $@;
 350     };
 351
 352     my $impl;
 353     if($no_cmm_fast){
 354         $impl = \&_install_modifier_pp;
 355     }
 356     else{
 357         my $install_modifier = Class::Method::Modifiers::Fast->can('install_modifier');
 358         $impl = sub {
 359             my ( $self, $type, $name, $code ) = @_;
 360             my $into = $self->name;
 361             $install_modifier->($into, $type, $name, $code);
 362
 363             $self->add_method($name => do{
 364                 no strict 'refs';
 365                 \&{ $into . '::' . $name };
 366             });
 367             return;
 368         };
 369     }
 370
 371     # replace this method itself :)
 372     {
 373         no warnings 'redefine';
 374         *_install_modifier = $impl;
 375     }
 376
 377     $self->$impl( $type, $name, $code );
 378 }
 379
 380 sub add_before_method_modifier {
 381     my ( $self, $name, $code ) = @_;
 382     $self->_install_modifier( 'before', $name, $code );
 383 }
 384
 385 sub add_around_method_modifier {
 386     my ( $self, $name, $code ) = @_;
 387     $self->_install_modifier( 'around', $name, $code );
 388 }
 389
 390 sub add_after_method_modifier {
 391     my ( $self, $name, $code ) = @_;
 392     $self->_install_modifier( 'after', $name, $code );
 393 }
 394
 395 sub add_override_method_modifier {
 396     my ($self, $name, $code) = @_;
 397
 398     if($self->has_method($name)){
 399         $self->throw_error("Cannot add an override method if a local method is already present");
 400     }
 401
 402     my $package = $self->name;
 403
 404     my $super_body = $package->can($name)
 405         or $self->throw_error("You cannot override '$name' because it has no super method");
 406
 407     $self->add_method($name => sub {
 408         local $Mouse::SUPER_PACKAGE = $package;
 409         local $Mouse::SUPER_BODY    = $super_body;
 410         local @Mouse::SUPER_ARGS    = @_;
 411
 412         $code->(@_);
 413     });
 414     return;
 415 }
 416
 417 sub add_augment_method_modifier {
 418     my ($self, $name, $code) = @_;
 419     if($self->has_method($name)){
 420         $self->throw_error("Cannot add an augment method if a local method is already present");
 421     }
 422
 423     my $super = $self->find_method_by_name($name)
 424         or $self->throw_error("You cannot augment '$name' because it has no super method");
 425
 426     my $super_package = $super->package_name;
 427     my $super_body    = $super->body;
 428
 429     $self->add_method($name => sub{
 430         local $Mouse::INNER_BODY{$super_package} = $code;
 431         local $Mouse::INNER_ARGS{$super_package} = [@_];
 432         $super_body->(@_);
 433     });
 434     return;
 435 }
 436
 437 sub does_role {
 438     my ($self, $role_name) = @_;
 439
 440     (defined $role_name)
 441         || $self->throw_error("You must supply a role name to look for");
 442
 443     for my $class ($self->linearized_isa) {
 444         my $meta = Mouse::Util::get_metaclass_by_name($class)
 445             or next;
 446
 447         for my $role (@{ $meta->roles }) {
 448
 449             return 1 if $role->does_role($role_name);
 450         }
 451     }
 452
 453     return 0;
 454 }
 455
 456 1;
 457 __END__
 458
 459 =head1 NAME
 460
 461 Mouse::Meta::Class - The Mouse class metaclass
 462
 463 =head1 VERSION
 464
 465 This document describes Mouse version 0.48
 466
 467 =head1 METHODS
 468
 469 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
 470
 471 Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
 472 one instance should exist for a given class.
 473
 474 =head2 C<< name -> ClassName >>
 475
 476 Returns the name of the owner class.
 477
 478 =head2 C<< superclasses -> ClassNames >> C<< superclass(ClassNames) >>
 479
 480 Gets (or sets) the list of superclasses of the owner class.
 481
 482 =head2 C<< add_method(name => CodeRef) >>
 483
 484 Adds a method to the owner class.
 485
 486 =head2 C<< has_method(name) -> Bool >>
 487
 488 Returns whether we have a method with the given name.
 489
 490 =head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
 491
 492 Returns a L<Mouse::Meta::Method> with the given name.
 493
 494 Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
 495
 496 =head2 C<< get_method_list -> Names >>
 497
 498 Returns a list of method names which are defined in the local class.
 499 If you want a list of all applicable methods for a class, use the
 500 C<get_all_methods> method.
 501
 502 =head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
 503
 504 Return the list of all L<Mouse::Meta::Method> instances associated with
 505 the class and its superclasses.
 506
 507 =head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
 508
 509 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
 510 class.
 511
 512 =head2 C<< has_attribute(Name) -> Bool >>
 513
 514 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
 515
 516 =head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
 517
 518 Returns the L<Mouse::Meta::Attribute> with the given name.
 519
 520 =head2 C<< get_attribute_list -> Names >>
 521
 522 Returns a list of attribute names which are defined in the local
 523 class. If you want a list of all applicable attributes for a class,
 524 use the C<get_all_attributes> method.
 525
 526 =head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
 527
 528 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
 529 this class and its superclasses.
 530
 531 =head2 C<< linearized_isa -> [ClassNames] >>
 532
 533 Returns the list of classes in method dispatch order, with duplicates removed.
 534
 535 =head2 C<< new_object(Parameters) -> Instance >>
 536
 537 Creates a new instance.
 538
 539 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
 540
 541 Clones the given instance which must be an instance governed by this
 542 metaclass.
 543
 544 =head2 C<< throw_error(Message, Parameters) >>
 545
 546 Throws an error with the given message.
 547
 548 =head1 SEE ALSO
 549
 550 L<Mouse::Meta::Module>
 551
 552 L<Moose::Meta::Class>
 553
 554 L<Class::MOP::Class>
 555
 556 =cut
 557