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 ) = @_;
191 # which is modifer class available?
192 my $modifier_class = do {
193 if (eval "require Class::Method::Modifiers::Fast; 1") {
194 'Class::Method::Modifiers::Fast';
195 } elsif (eval "require Class::Method::Modifiers; 1") {
196 'Class::Method::Modifiers';
198 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.");
201 my $modifier = $modifier_class->can('_install_modifier');
203 # replace this method itself :)
206 no warnings 'redefine';
207 *{__PACKAGE__ . '::_install_modifier'} = sub {
208 my ( $self, $into, $type, $name, $code ) = @_;
218 # call me. for first time.
219 $self->_install_modifier( $into, $type, $name, $code );
222 sub add_before_method_modifier {
223 my ( $self, $name, $code ) = @_;
224 $self->_install_modifier( $self->name, 'before', $name, $code );
227 sub add_around_method_modifier {
228 my ( $self, $name, $code ) = @_;
229 $self->_install_modifier( $self->name, 'around', $name, $code );
232 sub add_after_method_modifier {
233 my ( $self, $name, $code ) = @_;
234 $self->_install_modifier( $self->name, 'after', $name, $code );
237 sub roles { $_[0]->{roles} }
240 my ($self, $role_name) = @_;
243 || confess "You must supply a role name to look for";
245 for my $role (@{ $self->{roles} }) {
246 return 1 if $role->name eq $role_name;
253 my ($self, $package_name, %options) = @_;
255 (ref $options{superclasses} eq 'ARRAY')
256 || confess "You must pass an ARRAY ref of superclasses"
257 if exists $options{superclasses};
259 (ref $options{attributes} eq 'ARRAY')
260 || confess "You must pass an ARRAY ref of attributes"
261 if exists $options{attributes};
263 (ref $options{methods} eq 'HASH')
264 || confess "You must pass a HASH ref of methods"
265 if exists $options{methods};
268 ( defined $package_name && $package_name )
269 || confess "You must pass a package name";
271 my $code = "package $package_name;";
272 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
273 if exists $options{version};
274 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
275 if exists $options{authority};
278 confess "creation of $package_name failed : $@" if $@;
281 my %initialize_options = %options;
282 delete @initialize_options{qw(
290 my $meta = $self->initialize( $package_name => %initialize_options );
293 $meta->add_method('meta' => sub {
294 $self->initialize(ref($_[0]) || $_[0]);
297 $meta->superclasses(@{$options{superclasses}})
298 if exists $options{superclasses};
300 # process attributes first, so that they can
301 # install accessors, but locally defined methods
302 # can then overwrite them. It is maybe a little odd, but
303 # I think this should be the order of things.
304 if (exists $options{attributes}) {
305 foreach my $attr (@{$options{attributes}}) {
306 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
309 if (exists $options{methods}) {
310 foreach my $method_name (keys %{$options{methods}}) {
311 $meta->add_method($method_name, $options{methods}->{$method_name});
318 my $ANON_CLASS_SERIAL = 0;
319 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
320 sub create_anon_class {
321 my ( $class, %options ) = @_;
322 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
323 return $class->create( $package_name, %options );
333 Mouse::Meta::Class - hook into the Mouse MOP
337 =head2 initialize ClassName -> Mouse::Meta::Class
339 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
340 one instance should exist for a given class.
342 =head2 new %args -> Mouse::Meta::Class
344 Creates a new Mouse::Meta::Class. Don't call this directly.
346 =head2 name -> ClassName
348 Returns the name of the owner class.
350 =head2 superclasses -> [ClassName]
352 Gets (or sets) the list of superclasses of the owner class.
354 =head2 add_attribute Mouse::Meta::Attribute
356 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
359 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
361 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
362 this class and its superclasses.
364 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
366 Returns a mapping of attribute names to their corresponding
367 L<Mouse::Meta::Attribute> objects.
369 =head2 has_attribute Name -> Bool
371 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
373 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
375 Returns the L<Mouse::Meta::Attribute> with the given name.
377 =head2 linearized_isa -> [ClassNames]
379 Returns the list of classes in method dispatch order, with duplicates removed.
381 =head2 clone_object Instance -> Instance
383 Clones the given C<Instance> which must be an instance governed by this
386 =head2 clone_instance Instance, Parameters -> Instance
388 Clones the given C<Instance> and sets any additional parameters.