2 package Mouse::Meta::Class;
6 use Mouse::Meta::Method::Constructor;
7 use Mouse::Meta::Method::Destructor;
8 use Scalar::Util qw/blessed/;
9 use Mouse::Util qw/get_linear_isa/;
15 # because Mouse doesn't introspect existing classes, we're forced to
16 # only pay attention to other Mouse classes
17 sub _metaclass_cache {
20 return $METACLASS_CACHE{$name};
26 $METACLASS_CACHE{$name} = $class->new(name => $name)
27 if !exists($METACLASS_CACHE{$name});
28 return $METACLASS_CACHE{$name};
36 $args{attributes} = {};
37 $args{superclasses} = do {
39 \@{ $args{name} . '::ISA' };
46 sub name { $_[0]->{name} }
52 Mouse::load_class($_) for @_;
53 @{ $self->{superclasses} } = @_;
56 @{ $self->{superclasses} };
64 my $pkg = $self->name;
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}++;
151 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
152 if ($args{inline_destructor}) {
153 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
157 Carp::croak "Mouse::Meta::Class->make_mutable does not supported by Mouse";
159 sub is_immutable { $_[0]->{is_immutable} }
161 sub attribute_metaclass { "Mouse::Meta::Class" }
163 sub add_before_method_modifier {
164 my ($self, $name, $code) = @_;
165 require Class::Method::Modifiers;
166 Class::Method::Modifiers::_install_modifier(
174 sub add_around_method_modifier {
175 my ($self, $name, $code) = @_;
176 require Class::Method::Modifiers;
177 Class::Method::Modifiers::_install_modifier(
185 sub add_after_method_modifier {
186 my ($self, $name, $code) = @_;
187 require Class::Method::Modifiers;
188 Class::Method::Modifiers::_install_modifier(
196 sub roles { $_[0]->{roles} }
199 my ($self, $role_name) = @_;
201 || confess "You must supply a role name to look for";
202 for my $role (@{ $self->{roles} }) {
203 return 1 if $role->name eq $role_name;
209 my ( $class, @args ) = @_;
211 unshift @args, 'package' if @args % 2 == 1;
213 my (%options) = @args;
214 my $package_name = $options{package};
216 (ref $options{superclasses} eq 'ARRAY')
217 || confess "You must pass an ARRAY ref of superclasses"
218 if exists $options{superclasses};
220 (ref $options{attributes} eq 'ARRAY')
221 || confess "You must pass an ARRAY ref of attributes"
222 if exists $options{attributes};
224 (ref $options{methods} eq 'HASH')
225 || confess "You must pass a HASH ref of methods"
226 if exists $options{methods};
229 # XXX should I implement Mouse::Meta::Module?
230 my $package_name = $options{package};
232 ( defined $package_name && $package_name )
233 || confess "You must pass a package name";
235 my $code = "package $package_name;";
236 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
237 if exists $options{version};
238 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
239 if exists $options{authority};
242 confess "creation of $package_name failed : $@" if $@;
245 my (%initialize_options) = @args;
246 delete @initialize_options{qw(
254 my $meta = $class->initialize( $package_name => %initialize_options );
257 $meta->add_method('meta' => sub {
258 $class->initialize(ref($_[0]) || $_[0]);
261 $meta->superclasses(@{$options{superclasses}})
262 if exists $options{superclasses};
264 # process attributes first, so that they can
265 # install accessors, but locally defined methods
266 # can then overwrite them. It is maybe a little odd, but
267 # I think this should be the order of things.
268 if (exists $options{attributes}) {
269 foreach my $attr (@{$options{attributes}}) {
270 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
273 if (exists $options{methods}) {
274 foreach my $method_name (keys %{$options{methods}}) {
275 $meta->add_method($method_name, $options{methods}->{$method_name});
282 my $ANON_CLASS_SERIAL = 0;
283 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
284 sub create_anon_class {
285 my ( $class, %options ) = @_;
286 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
287 return $class->create( $package_name, %options );
297 Mouse::Meta::Class - hook into the Mouse MOP
301 =head2 initialize ClassName -> Mouse::Meta::Class
303 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
304 one instance should exist for a given class.
306 =head2 new %args -> Mouse::Meta::Class
308 Creates a new Mouse::Meta::Class. Don't call this directly.
310 =head2 name -> ClassName
312 Returns the name of the owner class.
314 =head2 superclasses -> [ClassName]
316 Gets (or sets) the list of superclasses of the owner class.
318 =head2 add_attribute Mouse::Meta::Attribute
320 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
323 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
325 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
326 this class and its superclasses.
328 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
330 Returns a mapping of attribute names to their corresponding
331 L<Mouse::Meta::Attribute> objects.
333 =head2 has_attribute Name -> Boool
335 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
337 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
339 Returns the L<Mouse::Meta::Attribute> with the given name.
341 =head2 linearized_isa -> [ClassNames]
343 Returns the list of classes in method dispatch order, with duplicates removed.
345 =head2 clone_object Instance -> Instance
347 Clones the given C<Instance> which must be an instance governed by this
350 =head2 clone_instance Instance, Parameters -> Instance
352 Clones the given C<Instance> and sets any additional parameters.