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 version authority identifier/;
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};
23 my $class = blessed($_[0]) || $_[0];
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 no warnings 'redefine';
68 $self->{'methods'}->{$name}++; # Moose stores meta object here.
69 *{ $pkg . '::' . $name } = $code;
75 $self->name->can($name);
78 # copied from Class::Inspector
79 my $get_methods_for_class = sub {
84 # Get all the CODE symbol table entries
86 grep !/^(?:has|with|around|before|after|augment|inner|blessed|extends|confess|override|super)$/,
87 grep { defined &{"${name}::$_"} }
89 push @functions, keys %{$self->{'methods'}->{$name}} if $self;
90 wantarray ? @functions : \@functions;
95 $get_methods_for_class->($self, $self->name);
98 sub get_all_method_names {
101 return grep { $uniq{$_}++ == 0 }
102 map { $get_methods_for_class->(undef, $_) }
103 $self->linearized_isa;
109 if (@_ == 1 && blessed($_[0])) {
111 $self->{'attributes'}{$attr->name} = $attr;
113 my $names = shift @_;
114 $names = [$names] if !ref($names);
115 my $metaclass = 'Mouse::Meta::Attribute';
118 if ( my $metaclass_name = delete $options{metaclass} ) {
119 my $new_class = Mouse::Util::resolve_metaclass_alias(
123 if ( $metaclass ne $new_class ) {
124 $metaclass = $new_class;
128 for my $name (@$names) {
129 if ($name =~ s/^\+//) {
130 $metaclass->clone_parent($self, $name, @_);
133 $metaclass->create($self, $name, @_);
139 sub compute_all_applicable_attributes {
143 for my $class ($self->linearized_isa) {
144 my $meta = $self->_metaclass_cache($class)
147 for my $name (keys %{ $meta->get_attribute_map }) {
148 next if $seen{$name}++;
149 push @attr, $meta->get_attribute($name);
156 sub get_attribute_map { $_[0]->{attributes} }
157 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
158 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
159 sub get_attribute_list {
161 keys %{$self->get_attribute_map};
164 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
168 my $instance = shift;
170 (blessed($instance) && $instance->isa($class->name))
171 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
173 $class->clone_instance($instance, @_);
177 my ($class, $instance, %params) = @_;
180 || confess "You can only clone instances, ($instance) is not a blessed instance";
182 my $clone = bless { %$instance }, ref $instance;
184 foreach my $attr ($class->compute_all_applicable_attributes()) {
185 if ( defined( my $init_arg = $attr->init_arg ) ) {
186 if (exists $params{$init_arg}) {
187 $clone->{ $attr->name } = $params{$init_arg};
199 inline_constructor => 1,
203 my $name = $self->name;
204 $self->{is_immutable}++;
206 if ($args{inline_constructor}) {
207 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
210 if ($args{inline_destructor}) {
211 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
214 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
215 # at the end of a source file.
219 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
221 sub is_immutable { $_[0]->{is_immutable} }
223 sub attribute_metaclass { "Mouse::Meta::Class" }
225 sub _install_modifier {
226 my ( $self, $into, $type, $name, $code ) = @_;
228 # which is modifer class available?
229 my $modifier_class = do {
230 if (eval "require Class::Method::Modifiers::Fast; 1") {
231 'Class::Method::Modifiers::Fast';
232 } elsif (eval "require Class::Method::Modifiers; 1") {
233 'Class::Method::Modifiers';
235 Carp::croak("Method modifiers require the use of Class::Method::Modifiers or Class::Method::Modifiers::Fast. Please install it from CPAN and file a bug report with this application.");
238 my $modifier = $modifier_class->can('_install_modifier');
240 # replace this method itself :)
243 no warnings 'redefine';
244 *{__PACKAGE__ . '::_install_modifier'} = sub {
245 my ( $self, $into, $type, $name, $code ) = @_;
255 # call me. for first time.
256 $self->_install_modifier( $into, $type, $name, $code );
259 sub add_before_method_modifier {
260 my ( $self, $name, $code ) = @_;
261 $self->_install_modifier( $self->name, 'before', $name, $code );
264 sub add_around_method_modifier {
265 my ( $self, $name, $code ) = @_;
266 $self->_install_modifier( $self->name, 'around', $name, $code );
269 sub add_after_method_modifier {
270 my ( $self, $name, $code ) = @_;
271 $self->_install_modifier( $self->name, 'after', $name, $code );
274 sub add_override_method_modifier {
275 my ($self, $name, $code) = @_;
277 my $pkg = $self->name;
278 my $method = "${pkg}::${name}";
280 # Class::Method::Modifiers won't do this for us, so do it ourselves
282 my $body = $pkg->can($name)
283 or confess "You cannot override '$method' because it has no super method";
286 *$method = sub { $code->($pkg, $body, @_) };
290 sub roles { $_[0]->{roles} }
293 my ($self, $role_name) = @_;
296 || confess "You must supply a role name to look for";
298 for my $role (@{ $self->{roles} }) {
299 return 1 if $role->name eq $role_name;
306 my ($self, $package_name, %options) = @_;
308 (ref $options{superclasses} eq 'ARRAY')
309 || confess "You must pass an ARRAY ref of superclasses"
310 if exists $options{superclasses};
312 (ref $options{attributes} eq 'ARRAY')
313 || confess "You must pass an ARRAY ref of attributes"
314 if exists $options{attributes};
316 (ref $options{methods} eq 'HASH')
317 || confess "You must pass a HASH ref of methods"
318 if exists $options{methods};
321 ( defined $package_name && $package_name )
322 || confess "You must pass a package name";
324 my $code = "package $package_name;";
325 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
326 if exists $options{version};
327 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
328 if exists $options{authority};
331 confess "creation of $package_name failed : $@" if $@;
334 my %initialize_options = %options;
335 delete @initialize_options{qw(
343 my $meta = $self->initialize( $package_name => %initialize_options );
346 $meta->add_method('meta' => sub {
347 $self->initialize(ref($_[0]) || $_[0]);
350 $meta->superclasses(@{$options{superclasses}})
351 if exists $options{superclasses};
353 # process attributes first, so that they can
354 # install accessors, but locally defined methods
355 # can then overwrite them. It is maybe a little odd, but
356 # I think this should be the order of things.
357 if (exists $options{attributes}) {
358 foreach my $attr (@{$options{attributes}}) {
359 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
362 if (exists $options{methods}) {
363 foreach my $method_name (keys %{$options{methods}}) {
364 $meta->add_method($method_name, $options{methods}->{$method_name});
371 my $ANON_CLASS_SERIAL = 0;
372 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
373 sub create_anon_class {
374 my ( $class, %options ) = @_;
375 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
376 return $class->create( $package_name, %options );
386 Mouse::Meta::Class - hook into the Mouse MOP
390 =head2 initialize ClassName -> Mouse::Meta::Class
392 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
393 one instance should exist for a given class.
395 =head2 new %args -> Mouse::Meta::Class
397 Creates a new Mouse::Meta::Class. Don't call this directly.
399 =head2 name -> ClassName
401 Returns the name of the owner class.
403 =head2 superclasses -> [ClassName]
405 Gets (or sets) the list of superclasses of the owner class.
407 =head2 add_attribute (Mouse::Meta::Attribute| name => spec)
409 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
412 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
414 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
415 this class and its superclasses.
417 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
419 Returns a mapping of attribute names to their corresponding
420 L<Mouse::Meta::Attribute> objects.
422 =head2 get_attribute_list -> { name => Mouse::Meta::Attribute }
424 This returns a list of attribute names which are defined in the local
425 class. If you want a list of all applicable attributes for a class,
426 use the C<compute_all_applicable_attributes> method.
428 =head2 has_attribute Name -> Bool
430 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
432 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
434 Returns the L<Mouse::Meta::Attribute> with the given name.
436 =head2 linearized_isa -> [ClassNames]
438 Returns the list of classes in method dispatch order, with duplicates removed.
440 =head2 clone_object Instance -> Instance
442 Clones the given C<Instance> which must be an instance governed by this
445 =head2 clone_instance Instance, Parameters -> Instance
447 Clones the given C<Instance> and sets any additional parameters.