1 package Mouse::Meta::Class;
5 use Mouse::Meta::Method::Constructor;
6 use Mouse::Meta::Method::Destructor;
7 use Scalar::Util qw/blessed/;
8 use Mouse::Util qw/get_linear_isa/;
14 # because Mouse doesn't introspect existing classes, we're forced to
15 # only pay attention to other Mouse classes
16 sub _metaclass_cache {
19 return $METACLASS_CACHE{$name};
25 $METACLASS_CACHE{$name} = $class->new(name => $name)
26 if !exists($METACLASS_CACHE{$name});
27 return $METACLASS_CACHE{$name};
35 $args{attributes} = {};
36 $args{superclasses} = do {
38 \@{ $args{name} . '::ISA' };
45 sub name { $_[0]->{name} }
51 Mouse::load_class($_) for @_;
52 @{ $self->{superclasses} } = @_;
55 @{ $self->{superclasses} };
63 my $pkg = $self->name;
66 no warnings 'redefine';
67 $self->{'methods'}->{$name}++; # Moose stores meta object here.
68 *{ $pkg . '::' . $name } = $code;
71 # copied from Class::Inspector
74 my $name = $self->name;
77 # Get all the CODE symbol table entries
79 grep !/^(?:has|with|around|before|after|blessed|extends|confess)$/,
80 grep { defined &{"${name}::$_"} }
82 push @functions, keys %{$self->{'methods'}->{$name}};
83 wantarray ? @functions : \@functions;
90 $self->{'attributes'}{$attr->name} = $attr;
93 sub compute_all_applicable_attributes {
97 for my $class ($self->linearized_isa) {
98 my $meta = $self->_metaclass_cache($class)
101 for my $name (keys %{ $meta->get_attribute_map }) {
102 next if $seen{$name}++;
103 push @attr, $meta->get_attribute($name);
110 sub get_attribute_map { $_[0]->{attributes} }
111 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
112 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
114 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
118 my $instance = shift;
120 (blessed($instance) && $instance->isa($class->name))
121 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
123 $class->clone_instance($instance, @_);
127 my ($class, $instance, %params) = @_;
130 || confess "You can only clone instances, ($instance) is not a blessed instance";
132 my $clone = bless { %$instance }, ref $instance;
134 foreach my $attr ($class->compute_all_applicable_attributes()) {
135 if ( defined( my $init_arg = $attr->init_arg ) ) {
136 if (exists $params{$init_arg}) {
137 $clone->{ $attr->name } = $params{$init_arg};
149 my $name = $self->name;
150 $self->{is_immutable}++;
152 if ($self->name->can('new') != Mouse::Object->can('new')) {
153 warn "Not inlining a constructor for ".$self->name." since it is not inheriting the default Mouse::Object constructor\n";
156 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
159 if ($args{inline_destructor}) {
160 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
164 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
166 sub is_immutable { $_[0]->{is_immutable} }
168 sub attribute_metaclass { "Mouse::Meta::Class" }
170 sub _install_modifier {
171 my ( $self, $into, $type, $name, $code ) = @_;
172 if (eval "require Class::Method::Modifiers::Fast; 1") {
173 Class::Method::Modifiers::Fast::_install_modifier(
181 require Class::Method::Modifiers;
182 Class::Method::Modifiers::_install_modifier(
191 sub add_before_method_modifier {
192 my ( $self, $name, $code ) = @_;
193 $self->_install_modifier( $self->name, 'before', $name, $code );
196 sub add_around_method_modifier {
197 my ( $self, $name, $code ) = @_;
198 $self->_install_modifier( $self->name, 'around', $name, $code );
201 sub add_after_method_modifier {
202 my ( $self, $name, $code ) = @_;
203 $self->_install_modifier( $self->name, 'after', $name, $code );
206 sub roles { $_[0]->{roles} }
209 my ($self, $role_name) = @_;
212 || confess "You must supply a role name to look for";
214 for my $role (@{ $self->{roles} }) {
215 return 1 if $role->name eq $role_name;
222 my ($self, $package_name, %options) = @_;
224 (ref $options{superclasses} eq 'ARRAY')
225 || confess "You must pass an ARRAY ref of superclasses"
226 if exists $options{superclasses};
228 (ref $options{attributes} eq 'ARRAY')
229 || confess "You must pass an ARRAY ref of attributes"
230 if exists $options{attributes};
232 (ref $options{methods} eq 'HASH')
233 || confess "You must pass a HASH ref of methods"
234 if exists $options{methods};
237 ( defined $package_name && $package_name )
238 || confess "You must pass a package name";
240 my $code = "package $package_name;";
241 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
242 if exists $options{version};
243 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
244 if exists $options{authority};
247 confess "creation of $package_name failed : $@" if $@;
250 my %initialize_options = %options;
251 delete @initialize_options{qw(
259 my $meta = $self->initialize( $package_name => %initialize_options );
262 $meta->add_method('meta' => sub {
263 $self->initialize(ref($_[0]) || $_[0]);
266 $meta->superclasses(@{$options{superclasses}})
267 if exists $options{superclasses};
269 # process attributes first, so that they can
270 # install accessors, but locally defined methods
271 # can then overwrite them. It is maybe a little odd, but
272 # I think this should be the order of things.
273 if (exists $options{attributes}) {
274 foreach my $attr (@{$options{attributes}}) {
275 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
278 if (exists $options{methods}) {
279 foreach my $method_name (keys %{$options{methods}}) {
280 $meta->add_method($method_name, $options{methods}->{$method_name});
287 my $ANON_CLASS_SERIAL = 0;
288 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
289 sub create_anon_class {
290 my ( $class, %options ) = @_;
291 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
292 return $class->create( $package_name, %options );
302 Mouse::Meta::Class - hook into the Mouse MOP
306 =head2 initialize ClassName -> Mouse::Meta::Class
308 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
309 one instance should exist for a given class.
311 =head2 new %args -> Mouse::Meta::Class
313 Creates a new Mouse::Meta::Class. Don't call this directly.
315 =head2 name -> ClassName
317 Returns the name of the owner class.
319 =head2 superclasses -> [ClassName]
321 Gets (or sets) the list of superclasses of the owner class.
323 =head2 add_attribute Mouse::Meta::Attribute
325 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
328 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
330 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
331 this class and its superclasses.
333 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
335 Returns a mapping of attribute names to their corresponding
336 L<Mouse::Meta::Attribute> objects.
338 =head2 has_attribute Name -> Bool
340 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
342 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
344 Returns the L<Mouse::Meta::Attribute> with the given name.
346 =head2 linearized_isa -> [ClassNames]
348 Returns the list of classes in method dispatch order, with duplicates removed.
350 =head2 clone_object Instance -> Instance
352 Clones the given C<Instance> which must be an instance governed by this
355 =head2 clone_instance Instance, Parameters -> Instance
357 Clones the given C<Instance> and sets any additional parameters.