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;
102 if (@_ == 1 && blessed($_[0])) {
104 $self->{'attributes'}{$attr->name} = $attr;
106 my $names = shift @_;
107 $names = [$names] if !ref($names);
108 my $metaclass = 'Mouse::Meta::Attribute';
111 if ( my $metaclass_name = delete $options{metaclass} ) {
112 my $new_class = Mouse::Util::resolve_metaclass_alias(
116 if ( $metaclass ne $new_class ) {
117 $metaclass = $new_class;
121 for my $name (@$names) {
122 if ($name =~ s/^\+//) {
123 $metaclass->clone_parent($self, $name, @_);
126 $metaclass->create($self, $name, @_);
132 sub compute_all_applicable_attributes {
136 for my $class ($self->linearized_isa) {
137 my $meta = $self->_metaclass_cache($class)
140 for my $name (keys %{ $meta->get_attribute_map }) {
141 next if $seen{$name}++;
142 push @attr, $meta->get_attribute($name);
149 sub get_attribute_map { $_[0]->{attributes} }
150 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
151 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
153 sub linearized_isa { @{ get_linear_isa($_[0]->name) } }
157 my $instance = shift;
159 (blessed($instance) && $instance->isa($class->name))
160 || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)";
162 $class->clone_instance($instance, @_);
166 my ($class, $instance, %params) = @_;
169 || confess "You can only clone instances, ($instance) is not a blessed instance";
171 my $clone = bless { %$instance }, ref $instance;
173 foreach my $attr ($class->compute_all_applicable_attributes()) {
174 if ( defined( my $init_arg = $attr->init_arg ) ) {
175 if (exists $params{$init_arg}) {
176 $clone->{ $attr->name } = $params{$init_arg};
188 inline_constructor => 1,
192 my $name = $self->name;
193 $self->{is_immutable}++;
195 if ($args{inline_constructor}) {
196 $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self ));
199 if ($args{inline_destructor}) {
200 $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self ));
203 # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value
204 # at the end of a source file.
208 sub make_mutable { confess "Mouse does not currently support 'make_mutable'" }
210 sub is_immutable { $_[0]->{is_immutable} }
212 sub attribute_metaclass { "Mouse::Meta::Class" }
214 sub _install_modifier {
215 my ( $self, $into, $type, $name, $code ) = @_;
217 # which is modifer class available?
218 my $modifier_class = do {
219 if (eval "require Class::Method::Modifiers::Fast; 1") {
220 'Class::Method::Modifiers::Fast';
221 } elsif (eval "require Class::Method::Modifiers; 1") {
222 'Class::Method::Modifiers';
224 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.");
227 my $modifier = $modifier_class->can('_install_modifier');
229 # replace this method itself :)
232 no warnings 'redefine';
233 *{__PACKAGE__ . '::_install_modifier'} = sub {
234 my ( $self, $into, $type, $name, $code ) = @_;
244 # call me. for first time.
245 $self->_install_modifier( $into, $type, $name, $code );
248 sub add_before_method_modifier {
249 my ( $self, $name, $code ) = @_;
250 $self->_install_modifier( $self->name, 'before', $name, $code );
253 sub add_around_method_modifier {
254 my ( $self, $name, $code ) = @_;
255 $self->_install_modifier( $self->name, 'around', $name, $code );
258 sub add_after_method_modifier {
259 my ( $self, $name, $code ) = @_;
260 $self->_install_modifier( $self->name, 'after', $name, $code );
263 sub roles { $_[0]->{roles} }
266 my ($self, $role_name) = @_;
269 || confess "You must supply a role name to look for";
271 for my $role (@{ $self->{roles} }) {
272 return 1 if $role->name eq $role_name;
279 my ($self, $package_name, %options) = @_;
281 (ref $options{superclasses} eq 'ARRAY')
282 || confess "You must pass an ARRAY ref of superclasses"
283 if exists $options{superclasses};
285 (ref $options{attributes} eq 'ARRAY')
286 || confess "You must pass an ARRAY ref of attributes"
287 if exists $options{attributes};
289 (ref $options{methods} eq 'HASH')
290 || confess "You must pass a HASH ref of methods"
291 if exists $options{methods};
294 ( defined $package_name && $package_name )
295 || confess "You must pass a package name";
297 my $code = "package $package_name;";
298 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
299 if exists $options{version};
300 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
301 if exists $options{authority};
304 confess "creation of $package_name failed : $@" if $@;
307 my %initialize_options = %options;
308 delete @initialize_options{qw(
316 my $meta = $self->initialize( $package_name => %initialize_options );
319 $meta->add_method('meta' => sub {
320 $self->initialize(ref($_[0]) || $_[0]);
323 $meta->superclasses(@{$options{superclasses}})
324 if exists $options{superclasses};
326 # process attributes first, so that they can
327 # install accessors, but locally defined methods
328 # can then overwrite them. It is maybe a little odd, but
329 # I think this should be the order of things.
330 if (exists $options{attributes}) {
331 foreach my $attr (@{$options{attributes}}) {
332 Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr);
335 if (exists $options{methods}) {
336 foreach my $method_name (keys %{$options{methods}}) {
337 $meta->add_method($method_name, $options{methods}->{$method_name});
344 my $ANON_CLASS_SERIAL = 0;
345 my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::';
346 sub create_anon_class {
347 my ( $class, %options ) = @_;
348 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
349 return $class->create( $package_name, %options );
359 Mouse::Meta::Class - hook into the Mouse MOP
363 =head2 initialize ClassName -> Mouse::Meta::Class
365 Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
366 one instance should exist for a given class.
368 =head2 new %args -> Mouse::Meta::Class
370 Creates a new Mouse::Meta::Class. Don't call this directly.
372 =head2 name -> ClassName
374 Returns the name of the owner class.
376 =head2 superclasses -> [ClassName]
378 Gets (or sets) the list of superclasses of the owner class.
380 =head2 add_attribute (Mouse::Meta::Attribute| name => spec)
382 Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
385 =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute)
387 Returns the list of all L<Mouse::Meta::Attribute> instances associated with
388 this class and its superclasses.
390 =head2 get_attribute_map -> { name => Mouse::Meta::Attribute }
392 Returns a mapping of attribute names to their corresponding
393 L<Mouse::Meta::Attribute> objects.
395 =head2 has_attribute Name -> Bool
397 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
399 =head2 get_attribute Name -> Mouse::Meta::Attribute | undef
401 Returns the L<Mouse::Meta::Attribute> with the given name.
403 =head2 linearized_isa -> [ClassNames]
405 Returns the list of classes in method dispatch order, with duplicates removed.
407 =head2 clone_object Instance -> Instance
409 Clones the given C<Instance> which must be an instance governed by this
412 =head2 clone_instance Instance, Parameters -> Instance
414 Clones the given C<Instance> and sets any additional parameters.