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|override|super)$/,
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 inline_constructor => 1,
153 my $name = $self->name;
154 $self->{is_immutable}++;
156 if ($args{inline_constructor}) {
157 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
160 if ($args{inline_destructor}) {
161 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
165 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
167 sub is_immutable { $_[0]->{is_immutable} }
169 sub attribute_metaclass { "Mouse::Meta::Class" }
171 sub _install_modifier {
172 my ( $self, $into, $type, $name, $code ) = @_;
173 if (eval "require Class::Method::Modifiers::Fast; 1") {
174 Class::Method::Modifiers::Fast::_install_modifier(
182 require Class::Method::Modifiers;
183 Class::Method::Modifiers::_install_modifier(
192 sub add_before_method_modifier {
193 my ( $self, $name, $code ) = @_;
194 $self->_install_modifier( $self->name, 'before', $name, $code );
197 sub add_around_method_modifier {
198 my ( $self, $name, $code ) = @_;
199 $self->_install_modifier( $self->name, 'around', $name, $code );
202 sub add_after_method_modifier {
203 my ( $self, $name, $code ) = @_;
204 $self->_install_modifier( $self->name, 'after', $name, $code );
207 sub roles { $_[0]->{roles} }
210 my ($self, $role_name) = @_;
213 || confess "You must supply a role name to look for";
215 for my $role (@{ $self->{roles} }) {
216 return 1 if $role->name eq $role_name;
223 my ($self, $package_name, %options) = @_;
225 (ref $options{superclasses} eq 'ARRAY')
226 || confess "You must pass an ARRAY ref of superclasses"
227 if exists $options{superclasses};
229 (ref $options{attributes} eq 'ARRAY')
230 || confess "You must pass an ARRAY ref of attributes"
231 if exists $options{attributes};
233 (ref $options{methods} eq 'HASH')
234 || confess "You must pass a HASH ref of methods"
235 if exists $options{methods};
238 ( defined $package_name && $package_name )
239 || confess "You must pass a package name";
241 my $code = "package $package_name;";
242 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
243 if exists $options{version};
244 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
245 if exists $options{authority};
248 confess "creation of $package_name failed : $@" if $@;
251 my %initialize_options = %options;
252 delete @initialize_options{qw(
260 my $meta = $self->initialize( $package_name => %initialize_options );
263 $meta->add_method('meta' => sub {
264 $self->initialize(ref($_[0]) || $_[0]);
267 $meta->superclasses(@{$options{superclasses}})
268 if exists $options{superclasses};
270 # process attributes first, so that they can
271 # install accessors, but locally defined methods
272 # can then overwrite them. It is maybe a little odd, but
273 # I think this should be the order of things.
274 if (exists $options{attributes}) {
275 foreach my $attr (@{$options{attributes}}) {
276 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
279 if (exists $options{methods}) {
280 foreach my $method_name (keys %{$options{methods}}) {
281 $meta->add_method($method_name, $options{methods}->{$method_name});
288 my $ANON_CLASS_SERIAL = 0;
289 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
290 sub create_anon_class {
291 my ( $class, %options ) = @_;
292 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
293 return $class->create( $package_name, %options );
303 Mouse::Meta::Class - hook into the Mouse MOP
307 =head2 initialize ClassName -> Mouse::Meta::Class
309 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
310 one instance should exist for a given class.
312 =head2 new %args -> Mouse::Meta::Class
314 Creates a new Mouse::Meta::Class. Don't call this directly.
316 =head2 name -> ClassName
318 Returns the name of the owner class.
320 =head2 superclasses -> [ClassName]
322 Gets (or sets) the list of superclasses of the owner class.
324 =head2 add_attribute Mouse::Meta::Attribute
326 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
329 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
331 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
332 this class and its superclasses.
334 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
336 Returns a mapping of attribute names to their corresponding
337 L<Mouse::Meta::Attribute> objects.
339 =head2 has_attribute Name -> Bool
341 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
343 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
345 Returns the L<Mouse::Meta::Attribute> with the given name.
347 =head2 linearized_isa -> [ClassNames]
349 Returns the list of classes in method dispatch order, with duplicates removed.
351 =head2 clone_object Instance -> Instance
353 Clones the given C<Instance> which must be an instance governed by this
356 =head2 clone_instance Instance, Parameters -> Instance
358 Clones the given C<Instance> and sets any additional parameters.