1 package Mouse::Meta::Module;
6 use Scalar::Util qw/blessed weaken/;
8 use Mouse::Util qw/:meta get_code_package not_supported load_class/;
13 # because Mouse doesn't introspect existing classes, we're forced to
14 # only pay attention to other Mouse classes
15 sub _metaclass_cache {
16 my($class, $name) = @_;
17 return $METACLASS_CACHE{$name};
21 my($class, $package_name, @args) = @_;
23 ($package_name && !ref($package_name))
24 || $class->throw_error("You must pass a package name and it cannot be blessed");
26 return $METACLASS_CACHE{$package_name}
27 ||= $class->_construct_meta(package => $package_name, @args);
31 my($class_or_instance) = @_;
32 return undef unless defined $class_or_instance;
33 return $METACLASS_CACHE{ blessed($class_or_instance) || $class_or_instance };
36 # Means of accessing all the metaclasses that have
37 # been initialized thus far
38 sub get_all_metaclasses { %METACLASS_CACHE }
39 sub get_all_metaclass_instances { values %METACLASS_CACHE }
40 sub get_all_metaclass_names { keys %METACLASS_CACHE }
41 sub get_metaclass_by_name { $METACLASS_CACHE{$_[0]} }
42 sub store_metaclass_by_name { $METACLASS_CACHE{$_[0]} = $_[1] }
43 sub weaken_metaclass { weaken($METACLASS_CACHE{$_[0]}) }
44 sub does_metaclass_exist { defined $METACLASS_CACHE{$_[0]} }
45 sub remove_metaclass_by_name { delete $METACLASS_CACHE{$_[0]} }
49 sub _new{ Carp::croak("Mouse::Meta::Module is an abstract class") }
51 sub name { $_[0]->{package} }
53 sub version { no strict 'refs'; ${shift->name.'::VERSION'} }
54 sub authority { no strict 'refs'; ${shift->name.'::AUTHORITY'} }
59 ($self->version || ()),
60 ($self->authority || ()),
64 # add_attribute is an abstract method
66 sub get_attribute_map { $_[0]->{attributes} }
67 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
68 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
69 sub get_attribute_list{ keys %{$_[0]->{attributes}} }
70 sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} }
73 my $name = $_[0]->{package};
75 return \%{ $name . '::' };
79 my($self, $name, $code) = @_;
82 $self->throw_error('You must pass a defined name');
85 $self->throw_error('You must pass a defined code');
88 if(ref($code) ne 'CODE'){
89 not_supported 'add_method for a method object';
92 $self->{methods}->{$name}++; # Moose stores meta object here.
94 my $pkg = $self->name;
96 no warnings 'redefine';
97 *{ $pkg . '::' . $name } = $code;
100 # XXX: for backward compatibility
101 my %foreign = map{ $_ => undef } qw(
102 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
106 my($self, $code) = @_;
108 my $package = get_code_package($code);
110 return !exists $foreign{$package};
114 my($self, $method_name) = @_;
116 return 1 if $self->{methods}->{$method_name};
118 my $code = do{ no strict 'refs'; *{$self->{package} . '::' . $method_name}{CODE} };
120 return $code && $self->_code_is_mine($code);
124 my($self, $method_name) = @_;
126 if($self->has_method($method_name)){
127 my $method_metaclass = $self->method_metaclass;
128 load_class($method_metaclass);
130 my $package = $self->name;
131 return $method_metaclass->new(
132 body => $package->can($method_name),
133 name => $method_name,
141 sub get_method_list {
144 return grep { $self->has_method($_) } keys %{ $self->namespace };
149 my $ANON_PREFIX = 'Mouse::Meta::Module::__ANON__::';
154 my ($class, $package_name, %options) = @_;
156 $class->throw_error('You must pass a package name') if @_ == 1;
159 if(exists $options{superclasses}){
160 if($class->isa('Mouse::Meta::Class')){
161 (ref $options{superclasses} eq 'ARRAY')
162 || $class->throw_error("You must pass an ARRAY ref of superclasses");
165 delete $options{superclasses};
170 if(exists $options{attributes}){
171 $attributes = delete $options{attributes};
172 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
173 || $class->throw_error("You must pass an ARRAY ref of attributes")
176 (ref $options{methods} eq 'HASH')
177 || $class->throw_error("You must pass a HASH ref of methods")
178 if exists $options{methods};
180 (ref $options{roles} eq 'ARRAY')
181 || $class->throw_error("You must pass an ARRAY ref of roles")
182 if exists $options{roles};
189 if(!defined $package_name){ # anonymous
190 $mortal = !$options{cache};
192 # anonymous but immortal
194 # something like Super::Class|Super::Class::2=Role|Role::1
195 $cache_key = join '=' => (
196 join('|', @{$options{superclasses} || []}),
197 join('|', sort @{$options{roles} || []}),
199 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
201 $package_name = $ANON_PREFIX . ++$ANON_SERIAL;
203 push @extra_options, (anon_serial_id => $ANON_SERIAL);
206 # instantiate a module
209 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
210 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
213 my %initialize_options = %options;
214 delete @initialize_options{qw(
221 my $meta = $class->initialize( $package_name, %initialize_options, @extra_options);
223 Mouse::Meta::Module::weaken_metaclass($package_name)
227 $meta->add_method('meta' => sub {
228 $class->initialize(ref($_[0]) || $_[0]);
231 $meta->superclasses(@{$options{superclasses}})
232 if exists $options{superclasses};
235 # process attributes first, so that they can
236 # install accessors, but locally defined methods
237 # can then overwrite them. It is maybe a little odd, but
238 # I think this should be the order of things.
239 if (defined $attributes) {
240 if(ref($attributes) eq 'ARRAY'){
241 foreach my $attr (@{$attributes}) {
242 $meta->add_attribute($attr->{name} => $attr);
246 while(my($name, $attr) = each %{$attributes}){
247 $meta->add_attribute($name => $attr);
251 if (exists $options{methods}) {
252 foreach my $method_name (keys %{$options{methods}}) {
253 $meta->add_method($method_name, $options{methods}->{$method_name});
256 if (exists $options{roles}){
257 Mouse::Util::apply_all_roles($package_name, @{$options{roles}});
260 if(!$mortal && exists $meta->{anon_serial_id}){
261 $IMMORTALS{$cache_key} = $meta;
270 my $serial_id = $self->{anon_serial_id};
272 return if !$serial_id;
274 my $stash = $self->namespace;
276 @{$self->{superclasses}} = () if exists $self->{superclasses};
278 Mouse::Meta::Module::remove_metaclass_by_name($self->name);
281 delete ${$ANON_PREFIX}{ $serial_id . '::' };
288 my($class, $message, %args) = @_;
290 local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0);
291 local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
293 if(exists $args{longmess} && !$args{longmess}){ # intentionaly longmess => 0
294 Carp::croak($message);
297 Carp::confess($message);
307 Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Role
313 L<Class::MOP::Module>
315 L<Class::MOP::Package>