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;
72 # copied from Class::Inspector
73 my $get_methods_for_class = sub {
78 # Get all the CODE symbol table entries
80 grep !/^(?:has|with|around|before|after|augment|inner|blessed|extends|confess|override|super)$/,
81 grep { defined &{"${name}::$_"} }
83 push @functions, keys %{$self->{'methods'}->{$name}} if $self;
84 wantarray ? @functions : \@functions;
89 $get_methods_for_class->($self, $self->name);
92 sub get_all_method_names {
95 return grep { $uniq{$_}++ == 0 }
96 map { $get_methods_for_class->(undef, $_) }
97 $self->linearized_isa;
103 if (@_ == 1 && blessed($_[0])) {
105 $self->{'attributes'}{$attr->name} = $attr;
107 my $names = shift @_;
108 $names = [$names] if !ref($names);
109 my $metaclass = 'Mouse::Meta::Attribute';
112 if ( my $metaclass_name = delete $options{metaclass} ) {
113 my $new_class = Mouse::Util::resolve_metaclass_alias(
117 if ( $metaclass ne $new_class ) {
118 $metaclass = $new_class;
122 for my $name (@$names) {
123 if ($name =~ s/^\+//) {
124 $metaclass->clone_parent($self, $name, @_);
127 $metaclass->create($self, $name, @_);
133 sub compute_all_applicable_attributes {
137 for my $class ($self->linearized_isa) {
138 my $meta = $self->_metaclass_cache($class)
141 for my $name (keys %{ $meta->get_attribute_map }) {
142 next if $seen{$name}++;
143 push @attr, $meta->get_attribute($name);
150 sub get_attribute_map { $_[0]->{attributes} }
151 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
152 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
154 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
158 my $instance = shift;
160 (blessed($instance) && $instance->isa($class->name))
161 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
163 $class->clone_instance($instance, @_);
167 my ($class, $instance, %params) = @_;
170 || confess "You can only clone instances, ($instance) is not a blessed instance";
172 my $clone = bless { %$instance }, ref $instance;
174 foreach my $attr ($class->compute_all_applicable_attributes()) {
175 if ( defined( my $init_arg = $attr->init_arg ) ) {
176 if (exists $params{$init_arg}) {
177 $clone->{ $attr->name } = $params{$init_arg};
189 inline_constructor => 1,
193 my $name = $self->name;
194 $self->{is_immutable}++;
196 if ($args{inline_constructor}) {
197 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
200 if ($args{inline_destructor}) {
201 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
204 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
205 # at the end of a source file.
209 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
211 sub is_immutable { $_[0]->{is_immutable} }
213 sub attribute_metaclass { "Mouse::Meta::Class" }
215 sub _install_modifier {
216 my ( $self, $into, $type, $name, $code ) = @_;
218 # which is modifer class available?
219 my $modifier_class = do {
220 if (eval "require Class::Method::Modifiers::Fast; 1") {
221 'Class::Method::Modifiers::Fast';
222 } elsif (eval "require Class::Method::Modifiers; 1") {
223 'Class::Method::Modifiers';
225 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.");
228 my $modifier = $modifier_class->can('_install_modifier');
230 # replace this method itself :)
233 no warnings 'redefine';
234 *{__PACKAGE__ . '::_install_modifier'} = sub {
235 my ( $self, $into, $type, $name, $code ) = @_;
245 # call me. for first time.
246 $self->_install_modifier( $into, $type, $name, $code );
249 sub add_before_method_modifier {
250 my ( $self, $name, $code ) = @_;
251 $self->_install_modifier( $self->name, 'before', $name, $code );
254 sub add_around_method_modifier {
255 my ( $self, $name, $code ) = @_;
256 $self->_install_modifier( $self->name, 'around', $name, $code );
259 sub add_after_method_modifier {
260 my ( $self, $name, $code ) = @_;
261 $self->_install_modifier( $self->name, 'after', $name, $code );
264 sub add_override_method_modifier {
265 my ($self, $name, $code) = @_;
267 my $pkg = $self->name;
268 my $method = "${pkg}::${name}";
270 # Class::Method::Modifiers won't do this for us, so do it ourselves
272 my $body = $pkg->can($name)
273 or confess "You cannot override '$method' because it has no super method";
276 *$method = sub { $code->($pkg, $body, @_) };
280 sub roles { $_[0]->{roles} }
283 my ($self, $role_name) = @_;
286 || confess "You must supply a role name to look for";
288 for my $role (@{ $self->{roles} }) {
289 return 1 if $role->name eq $role_name;
296 my ($self, $package_name, %options) = @_;
298 (ref $options{superclasses} eq 'ARRAY')
299 || confess "You must pass an ARRAY ref of superclasses"
300 if exists $options{superclasses};
302 (ref $options{attributes} eq 'ARRAY')
303 || confess "You must pass an ARRAY ref of attributes"
304 if exists $options{attributes};
306 (ref $options{methods} eq 'HASH')
307 || confess "You must pass a HASH ref of methods"
308 if exists $options{methods};
311 ( defined $package_name && $package_name )
312 || confess "You must pass a package name";
314 my $code = "package $package_name;";
315 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
316 if exists $options{version};
317 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
318 if exists $options{authority};
321 confess "creation of $package_name failed : $@" if $@;
324 my %initialize_options = %options;
325 delete @initialize_options{qw(
333 my $meta = $self->initialize( $package_name => %initialize_options );
336 $meta->add_method('meta' => sub {
337 $self->initialize(ref($_[0]) || $_[0]);
340 $meta->superclasses(@{$options{superclasses}})
341 if exists $options{superclasses};
343 # process attributes first, so that they can
344 # install accessors, but locally defined methods
345 # can then overwrite them. It is maybe a little odd, but
346 # I think this should be the order of things.
347 if (exists $options{attributes}) {
348 foreach my $attr (@{$options{attributes}}) {
349 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
352 if (exists $options{methods}) {
353 foreach my $method_name (keys %{$options{methods}}) {
354 $meta->add_method($method_name, $options{methods}->{$method_name});
361 my $ANON_CLASS_SERIAL = 0;
362 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
363 sub create_anon_class {
364 my ( $class, %options ) = @_;
365 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
366 return $class->create( $package_name, %options );
376 Mouse::Meta::Class - hook into the Mouse MOP
380 =head2 initialize ClassName -> Mouse::Meta::Class
382 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
383 one instance should exist for a given class.
385 =head2 new %args -> Mouse::Meta::Class
387 Creates a new Mouse::Meta::Class. Don't call this directly.
389 =head2 name -> ClassName
391 Returns the name of the owner class.
393 =head2 superclasses -> [ClassName]
395 Gets (or sets) the list of superclasses of the owner class.
397 =head2 add_attribute (Mouse::Meta::Attribute| name => spec)
399 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
402 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
404 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
405 this class and its superclasses.
407 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
409 Returns a mapping of attribute names to their corresponding
410 L<Mouse::Meta::Attribute> objects.
412 =head2 has_attribute Name -> Bool
414 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
416 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
418 Returns the L<Mouse::Meta::Attribute> with the given name.
420 =head2 linearized_isa -> [ClassNames]
422 Returns the list of classes in method dispatch order, with duplicates removed.
424 =head2 clone_object Instance -> Instance
426 Clones the given C<Instance> which must be an instance governed by this
429 =head2 clone_instance Instance, Parameters -> Instance
431 Clones the given C<Instance> and sets any additional parameters.