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 $self->{'methods'}->{$name}++; # Moose stores meta object here.
67 *{ $pkg . '::' . $name } = $code;
70 # copied from Class::Inspector
73 my $name = $self->name;
76 # Get all the CODE symbol table entries
78 grep !/^(?:has|with|around|before|after|blessed|extends|confess)$/,
79 grep { defined &{"${name}::$_"} }
81 push @functions, keys %{$self->{'methods'}->{$name}};
82 wantarray ? @functions : \@functions;
89 $self->{'attributes'}{$attr->name} = $attr;
92 sub compute_all_applicable_attributes {
96 for my $class ($self->linearized_isa) {
97 my $meta = $self->_metaclass_cache($class)
100 for my $name (keys %{ $meta->get_attribute_map }) {
101 next if $seen{$name}++;
102 push @attr, $meta->get_attribute($name);
109 sub get_attribute_map { $_[0]->{attributes} }
110 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
111 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
113 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
117 my $instance = shift;
119 (blessed($instance) && $instance->isa($class->name))
120 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
122 $class->clone_instance($instance, @_);
126 my ($class, $instance, %params) = @_;
129 || confess "You can only clone instances, ($instance) is not a blessed instance";
131 my $clone = bless { %$instance }, ref $instance;
133 foreach my $attr ($class->compute_all_applicable_attributes()) {
134 if ( defined( my $init_arg = $attr->init_arg ) ) {
135 if (exists $params{$init_arg}) {
136 $clone->{ $attr->name } = $params{$init_arg};
148 my $name = $self->name;
149 $self->{is_immutable}++;
150 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
151 if ($args{inline_destructor}) {
152 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
156 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
158 sub is_immutable { $_[0]->{is_immutable} }
160 sub attribute_metaclass { "Mouse::Meta::Class" }
162 sub add_before_method_modifier {
163 my ($self, $name, $code) = @_;
164 require Class::Method::Modifiers;
165 Class::Method::Modifiers::_install_modifier(
173 sub add_around_method_modifier {
174 my ($self, $name, $code) = @_;
175 require Class::Method::Modifiers;
176 Class::Method::Modifiers::_install_modifier(
184 sub add_after_method_modifier {
185 my ($self, $name, $code) = @_;
186 require Class::Method::Modifiers;
187 Class::Method::Modifiers::_install_modifier(
195 sub roles { $_[0]->{roles} }
198 my ($self, $role_name) = @_;
201 || confess "You must supply a role name to look for";
203 for my $role (@{ $self->{roles} }) {
204 return 1 if $role->name eq $role_name;
211 my ( $class, @args ) = @_;
213 unshift @args, 'package' if @args % 2 == 1;
215 my (%options) = @args;
216 my $package_name = $options{package};
218 (ref $options{superclasses} eq 'ARRAY')
219 || confess "You must pass an ARRAY ref of superclasses"
220 if exists $options{superclasses};
222 (ref $options{attributes} eq 'ARRAY')
223 || confess "You must pass an ARRAY ref of attributes"
224 if exists $options{attributes};
226 (ref $options{methods} eq 'HASH')
227 || confess "You must pass a HASH ref of methods"
228 if exists $options{methods};
231 # XXX should I implement Mouse::Meta::Module?
232 my $package_name = $options{package};
234 ( defined $package_name && $package_name )
235 || confess "You must pass a package name";
237 my $code = "package $package_name;";
238 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
239 if exists $options{version};
240 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
241 if exists $options{authority};
244 confess "creation of $package_name failed : $@" if $@;
247 my (%initialize_options) = @args;
248 delete @initialize_options{qw(
256 my $meta = $class->initialize( $package_name => %initialize_options );
259 $meta->add_method('meta' => sub {
260 $class->initialize(ref($_[0]) || $_[0]);
263 $meta->superclasses(@{$options{superclasses}})
264 if exists $options{superclasses};
266 # process attributes first, so that they can
267 # install accessors, but locally defined methods
268 # can then overwrite them. It is maybe a little odd, but
269 # I think this should be the order of things.
270 if (exists $options{attributes}) {
271 foreach my $attr (@{$options{attributes}}) {
272 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
275 if (exists $options{methods}) {
276 foreach my $method_name (keys %{$options{methods}}) {
277 $meta->add_method($method_name, $options{methods}->{$method_name});
284 my $ANON_CLASS_SERIAL = 0;
285 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
286 sub create_anon_class {
287 my ( $class, %options ) = @_;
288 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
289 return $class->create( $package_name, %options );
299 Mouse::Meta::Class - hook into the Mouse MOP
303 =head2 initialize ClassName -> Mouse::Meta::Class
305 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
306 one instance should exist for a given class.
308 =head2 new %args -> Mouse::Meta::Class
310 Creates a new Mouse::Meta::Class. Don't call this directly.
312 =head2 name -> ClassName
314 Returns the name of the owner class.
316 =head2 superclasses -> [ClassName]
318 Gets (or sets) the list of superclasses of the owner class.
320 =head2 add_attribute Mouse::Meta::Attribute
322 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
325 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
327 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
328 this class and its superclasses.
330 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
332 Returns a mapping of attribute names to their corresponding
333 L<Mouse::Meta::Attribute> objects.
335 =head2 has_attribute Name -> Boool
337 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
339 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
341 Returns the L<Mouse::Meta::Attribute> with the given name.
343 =head2 linearized_isa -> [ClassNames]
345 Returns the list of classes in method dispatch order, with duplicates removed.
347 =head2 clone_object Instance -> Instance
349 Clones the given C<Instance> which must be an instance governed by this
352 =head2 clone_instance Instance, Parameters -> Instance
354 Clones the given C<Instance> and sets any additional parameters.