lib/Mouse/Meta/Class.pm

   1 #!/usr/bin/env perl
   2 package Mouse::Meta::Class;
   3 use strict;
   4 use warnings;
   5
   6 use Mouse::Util qw/get_linear_isa blessed/;
   7 use Carp 'confess';
   8
   9 do {
  10     my %METACLASS_CACHE;
  11
  12     # because Mouse doesn't introspect existing classes, we're forced to
  13     # only pay attention to other Mouse classes
  14     sub _metaclass_cache {
  15         my $class = shift;
  16         my $name  = shift;
  17         return $METACLASS_CACHE{$name};
  18     }
  19
  20     sub initialize {
  21         my $class = shift;
  22         my $name  = shift;
  23         $METACLASS_CACHE{$name} = $class->new(name => $name)
  24             if !exists($METACLASS_CACHE{$name});
  25         return $METACLASS_CACHE{$name};
  26     }
  27 };
  28
  29 sub new {
  30     my $class = shift;
  31     my %args  = @_;
  32
  33     $args{attributes} = {};
  34     $args{superclasses} = do {
  35         no strict 'refs';
  36         \@{ $args{name} . '::ISA' };
  37     };
  38
  39     bless \%args, $class;
  40 }
  41
  42 sub name { $_[0]->{name} }
  43
  44 sub superclasses {
  45     my $self = shift;
  46
  47     if (@_) {
  48         Mouse::load_class($_) for @_;
  49         @{ $self->{superclasses} } = @_;
  50     }
  51
  52     @{ $self->{superclasses} };
  53 }
  54
  55 sub add_method {
  56     my $self = shift;
  57     my $name = shift;
  58     my $code = shift;
  59
  60     my $pkg = $self->name;
  61
  62     no strict 'refs';
  63     *{ $pkg . '::' . $name } = $code;
  64 }
  65
  66 sub add_attribute {
  67     my $self = shift;
  68     my $attr = shift;
  69
  70     $self->{'attributes'}{$attr->name} = $attr;
  71 }
  72
  73 sub compute_all_applicable_attributes {
  74     my $self = shift;
  75     my (@attr, %seen);
  76
  77     for my $class ($self->linearized_isa) {
  78         my $meta = $self->_metaclass_cache($class)
  79             or next;
  80
  81         for my $name (keys %{ $meta->get_attribute_map }) {
  82             next if $seen{$name}++;
  83             push @attr, $meta->get_attribute($name);
  84         }
  85     }
  86
  87     return @attr;
  88 }
  89
  90 sub get_attribute_map { $_[0]->{attributes} }
  91 sub has_attribute     { exists $_[0]->{attributes}->{$_[1]} }
  92 sub get_attribute     { $_[0]->{attributes}->{$_[1]} }
  93
  94 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
  95
  96 sub clone_object {
  97     my $class    = shift;
  98     my $instance = shift;
  99
 100     (blessed($instance) && $instance->isa($class->name))
 101         || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
 102
 103     $class->clone_instance($instance, @_);
 104 }
 105
 106 sub clone_instance {
 107     my ($class, $instance, %params) = @_;
 108
 109     (blessed($instance))
 110         || confess "You can only clone instances, ($instance) is not a blessed instance";
 111
 112     my $clone = bless { %$instance }, ref $instance;
 113
 114     foreach my $attr ($class->compute_all_applicable_attributes()) {
 115         if ( defined( my $init_arg = $attr->init_arg ) ) {
 116             if (exists $params{$init_arg}) {
 117                 $clone->{ $attr->name } = $params{$init_arg};
 118             }
 119         }
 120     }
 121
 122     return $clone;
 123
 124 }
 125
 126 sub make_immutable {}
 127 sub is_immutable { 0 }
 128
 129 sub attribute_metaclass { "Mouse::Meta::Class" }
 130
 131 sub add_before_method_modifier {
 132     my ($self, $name, $code) = @_;
 133     require Class::Method::Modifiers;
 134     Class::Method::Modifiers::_install_modifier(
 135         $self->name,
 136         'before',
 137         $name,
 138         $code,
 139     );
 140 }
 141
 142 sub add_around_method_modifier {
 143     my ($self, $name, $code) = @_;
 144     require Class::Method::Modifiers;
 145     Class::Method::Modifiers::_install_modifier(
 146         $self->name,
 147         'around',
 148         $name,
 149         $code,
 150     );
 151 }
 152
 153 sub add_after_method_modifier {
 154     my ($self, $name, $code) = @_;
 155     require Class::Method::Modifiers;
 156     Class::Method::Modifiers::_install_modifier(
 157         $self->name,
 158         'after',
 159         $name,
 160         $code,
 161     );
 162 }
 163
 164 1;
 165
 166 __END__
 167
 168 =head1 NAME
 169
 170 Mouse::Meta::Class - hook into the Mouse MOP
 171
 172 =head1 METHODS
 173
 174 =head2 initialize ClassName -> Mouse::Meta::Class
 175
 176 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
 177 one instance should exist for a given class.
 178
 179 =head2 new %args -> Mouse::Meta::Class
 180
 181 Creates a new Mouse::Meta::Class. Don't call this directly.
 182
 183 =head2 name -> ClassName
 184
 185 Returns the name of the owner class.
 186
 187 =head2 superclasses -> [ClassName]
 188
 189 Gets (or sets) the list of superclasses of the owner class.
 190
 191 =head2 add_attribute Mouse::Meta::Attribute
 192
 193 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
 194 class.
 195
 196 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
 197
 198 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
 199 this class and its superclasses.
 200
 201 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
 202
 203 Returns a mapping of attribute names to their corresponding
 204 L<Mouse::Meta::Attribute> objects.
 205
 206 =head2 has_attribute Name -> Boool
 207
 208 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
 209
 210 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
 211
 212 Returns the L<Mouse::Meta::Attribute> with the given name.
 213
 214 =head2 linearized_isa -> [ClassNames]
 215
 216 Returns the list of classes in method dispatch order, with duplicates removed.
 217
 218 =head2 clone_object Instance -> Instance
 219
 220 Clones the given C<Instance> which must be an instance governed by this
 221 metaclass.
 222
 223 =head2 clone_instance Instance, Parameters -> Instance
 224
 225 Clones the given C<Instance> and sets any additional parameters.
 226
 227 =cut
 228