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
72 my $get_methods_for_class = sub {
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}} if $self;
83 wantarray ? @functions : \@functions;
88 $get_methods_for_class->($self, $self->name);
91 sub get_all_method_names {
94 return grep { $uniq{$_}++ == 0 }
95 map { $get_methods_for_class->(undef, $_) }
96 $self->linearized_isa;
103 $self->{'attributes'}{$attr->name} = $attr;
106 sub compute_all_applicable_attributes {
110 for my $class ($self->linearized_isa) {
111 my $meta = $self->_metaclass_cache($class)
114 for my $name (keys %{ $meta->get_attribute_map }) {
115 next if $seen{$name}++;
116 push @attr, $meta->get_attribute($name);
123 sub get_attribute_map { $_[0]->{attributes} }
124 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
125 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
127 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
131 my $instance = shift;
133 (blessed($instance) && $instance->isa($class->name))
134 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
136 $class->clone_instance($instance, @_);
140 my ($class, $instance, %params) = @_;
143 || confess "You can only clone instances, ($instance) is not a blessed instance";
145 my $clone = bless { %$instance }, ref $instance;
147 foreach my $attr ($class->compute_all_applicable_attributes()) {
148 if ( defined( my $init_arg = $attr->init_arg ) ) {
149 if (exists $params{$init_arg}) {
150 $clone->{ $attr->name } = $params{$init_arg};
162 inline_constructor => 1,
166 my $name = $self->name;
167 $self->{is_immutable}++;
169 if ($args{inline_constructor}) {
170 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
173 if ($args{inline_destructor}) {
174 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
177 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
178 # at the end of a source file.
182 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
184 sub is_immutable { $_[0]->{is_immutable} }
186 sub attribute_metaclass { "Mouse::Meta::Class" }
188 sub _install_modifier {
189 my ( $self, $into, $type, $name, $code ) = @_;
190 if (eval "require Class::Method::Modifiers::Fast; 1") {
191 Class::Method::Modifiers::Fast::_install_modifier(
198 elsif (eval "require Class::Method::Modifiers; 1") {
199 Class::Method::Modifiers::_install_modifier(
207 Carp::croak("Method modifiers require the use of Class::Method::Modifiers. Please install it from CPAN and file a bug report with this application.");
211 sub add_before_method_modifier {
212 my ( $self, $name, $code ) = @_;
213 $self->_install_modifier( $self->name, 'before', $name, $code );
216 sub add_around_method_modifier {
217 my ( $self, $name, $code ) = @_;
218 $self->_install_modifier( $self->name, 'around', $name, $code );
221 sub add_after_method_modifier {
222 my ( $self, $name, $code ) = @_;
223 $self->_install_modifier( $self->name, 'after', $name, $code );
226 sub roles { $_[0]->{roles} }
229 my ($self, $role_name) = @_;
232 || confess "You must supply a role name to look for";
234 for my $role (@{ $self->{roles} }) {
235 return 1 if $role->name eq $role_name;
242 my ($self, $package_name, %options) = @_;
244 (ref $options{superclasses} eq 'ARRAY')
245 || confess "You must pass an ARRAY ref of superclasses"
246 if exists $options{superclasses};
248 (ref $options{attributes} eq 'ARRAY')
249 || confess "You must pass an ARRAY ref of attributes"
250 if exists $options{attributes};
252 (ref $options{methods} eq 'HASH')
253 || confess "You must pass a HASH ref of methods"
254 if exists $options{methods};
257 ( defined $package_name && $package_name )
258 || confess "You must pass a package name";
260 my $code = "package $package_name;";
261 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
262 if exists $options{version};
263 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
264 if exists $options{authority};
267 confess "creation of $package_name failed : $@" if $@;
270 my %initialize_options = %options;
271 delete @initialize_options{qw(
279 my $meta = $self->initialize( $package_name => %initialize_options );
282 $meta->add_method('meta' => sub {
283 $self->initialize(ref($_[0]) || $_[0]);
286 $meta->superclasses(@{$options{superclasses}})
287 if exists $options{superclasses};
289 # process attributes first, so that they can
290 # install accessors, but locally defined methods
291 # can then overwrite them. It is maybe a little odd, but
292 # I think this should be the order of things.
293 if (exists $options{attributes}) {
294 foreach my $attr (@{$options{attributes}}) {
295 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
298 if (exists $options{methods}) {
299 foreach my $method_name (keys %{$options{methods}}) {
300 $meta->add_method($method_name, $options{methods}->{$method_name});
307 my $ANON_CLASS_SERIAL = 0;
308 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
309 sub create_anon_class {
310 my ( $class, %options ) = @_;
311 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
312 return $class->create( $package_name, %options );
322 Mouse::Meta::Class - hook into the Mouse MOP
326 =head2 initialize ClassName -> Mouse::Meta::Class
328 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
329 one instance should exist for a given class.
331 =head2 new %args -> Mouse::Meta::Class
333 Creates a new Mouse::Meta::Class. Don't call this directly.
335 =head2 name -> ClassName
337 Returns the name of the owner class.
339 =head2 superclasses -> [ClassName]
341 Gets (or sets) the list of superclasses of the owner class.
343 =head2 add_attribute Mouse::Meta::Attribute
345 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
348 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
350 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
351 this class and its superclasses.
353 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
355 Returns a mapping of attribute names to their corresponding
356 L<Mouse::Meta::Attribute> objects.
358 =head2 has_attribute Name -> Bool
360 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
362 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
364 Returns the L<Mouse::Meta::Attribute> with the given name.
366 =head2 linearized_isa -> [ClassNames]
368 Returns the list of classes in method dispatch order, with duplicates removed.
370 =head2 clone_object Instance -> Instance
372 Clones the given C<Instance> which must be an instance governed by this
375 =head2 clone_instance Instance, Parameters -> Instance
377 Clones the given C<Instance> and sets any additional parameters.