1 package Mouse::Meta::Module;
2 use Mouse::Util qw/:meta/; # enables strict and warnings
9 if(Mouse::Util::MOUSE_XS){
10 # register meta storage for performance
11 Mouse::Util::__register_metaclass_storage(\%METAS, 0);
13 # ensure thread safety
14 *CLONE = sub { Mouse::Util::__register_metaclass_storage(\%METAS, 1) };
17 sub _metaclass_cache { # DEPRECATED
18 my($self, $name) = @_;
19 Carp::cluck('_metaclass_cache() has been deprecated. Use Mouse::Util::get_metaclass_by_name() instead');
24 my($class, $package_name, @args) = @_;
26 ($package_name && !ref($package_name))
27 || $class->throw_error("You must pass a package name and it cannot be blessed");
29 return $METAS{$package_name}
30 ||= $class->_construct_meta(package => $package_name, @args);
34 my($class, $package_name, @args) = @_;
36 $package_name = $package_name->name if ref $package_name;
38 ($package_name && !ref($package_name))
39 || $class->throw_error("You must pass a package name and it cannot be blessed");
41 if(exists $METAS{$package_name}) {
42 unshift @args, %{ $METAS{$package_name} };
44 delete $METAS{$package_name};
45 return $class->initialize($package_name, @args);
49 my($class_or_instance) = @_;
50 return undef unless defined $class_or_instance;
51 return $METAS{ ref($class_or_instance) || $class_or_instance };
54 # Means of accessing all the metaclasses that have
55 # been initialized thus far
56 #sub _get_all_metaclasses { %METAS }
57 sub _get_all_metaclass_instances { values %METAS }
58 sub _get_all_metaclass_names { keys %METAS }
59 sub _get_metaclass_by_name { $METAS{$_[0]} }
60 #sub _store_metaclass_by_name { $METAS{$_[0]} = $_[1] }
61 #sub _weaken_metaclass { weaken($METAS{$_[0]}) }
62 #sub _does_metaclass_exist { defined $METAS{$_[0]} }
63 #sub _remove_metaclass_by_name { delete $METAS{$_[0]} }
69 # add_attribute is an abstract method
71 sub get_attribute_map { # DEPRECATED
72 Carp::cluck('get_attribute_map() has been deprecated. Use get_attribute_list() and get_attribute() instead');
73 return $_[0]->{attributes};
76 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
77 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
78 sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} }
80 sub get_attribute_list{ keys %{$_[0]->{attributes}} }
82 # XXX: not completely compatible with Moose
83 my %foreign = map{ $_ => undef } qw(
84 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
85 Carp Scalar::Util List::Util
87 sub _get_method_body {
88 my($self, $method_name) = @_;
89 my $code = Mouse::Util::get_code_ref($self->{package}, $method_name);
90 return $code && !exists $foreign{ Mouse::Util::get_code_package($code) }
98 my($self, $method_name) = @_;
100 or $self->throw_error('You must define a method name');
102 return defined( $self->{methods}{$method_name} )
103 || defined( $self->_get_method_body($method_name) );
106 sub get_method_body {
107 my($self, $method_name) = @_;
108 defined($method_name)
109 or $self->throw_error('You must define a method name');
111 return $self->{methods}{$method_name}
112 ||= $self->_get_method_body($method_name);
116 my($self, $method_name) = @_;
118 if(my $code = $self->get_method_body($method_name)){
119 return Mouse::Util::load_class($self->method_metaclass)->wrap(
121 name => $method_name,
122 package => $self->name,
123 associated_metaclass => $self,
130 sub get_method_list {
133 return grep { $self->has_method($_) } keys %{ $self->namespace };
136 sub _collect_methods { # Mouse specific
137 my($meta, @args) = @_;
140 foreach my $arg(@args){
141 if(my $type = ref $arg){
142 if($type eq 'Regexp'){
143 push @methods, grep { $_ =~ $arg } $meta->get_all_method_names;
145 elsif($type eq 'ARRAY'){
146 push @methods, @{$arg};
149 my $subname = ( caller(1) )[3];
152 'Methods passed to %s must be provided as a list,'
153 . ' ArrayRef or regular expression, not %s',
167 my $ANON_SERIAL = 0; # anonymous class/role id
168 my %IMMORTALS; # immortal anonymous classes
171 my($self, $package_name, %options) = @_;
173 my $class = ref($self) || $self;
174 $self->throw_error('You must pass a package name') if @_ < 2;
177 if(exists $options{superclasses}){
178 if(Mouse::Util::is_a_metarole($self)){
179 delete $options{superclasses};
182 $superclasses = delete $options{superclasses};
183 (ref $superclasses eq 'ARRAY')
184 || $self->throw_error("You must pass an ARRAY ref of superclasses");
188 my $attributes = delete $options{attributes};
189 if(defined $attributes){
190 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
191 || $self->throw_error("You must pass an ARRAY ref of attributes");
193 my $methods = delete $options{methods};
194 if(defined $methods){
195 (ref $methods eq 'HASH')
196 || $self->throw_error("You must pass a HASH ref of methods");
198 my $roles = delete $options{roles};
200 (ref $roles eq 'ARRAY')
201 || $self->throw_error("You must pass an ARRAY ref of roles");
206 if(!defined $package_name){ # anonymous
207 $mortal = !$options{cache};
209 # anonymous but immortal
211 # something like Super::Class|Super::Class::2=Role|Role::1
212 $cache_key = join '=' => (
213 join('|', @{$superclasses || []}),
214 join('|', sort @{$roles || []}),
216 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
218 $options{anon_serial_id} = ++$ANON_SERIAL;
219 $package_name = $class . '::__ANON__::' . $ANON_SERIAL;
222 # instantiate a module
225 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
226 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
229 my $meta = $self->initialize( $package_name, %options);
231 Scalar::Util::weaken($METAS{$package_name})
234 $meta->add_method(meta => sub {
235 $self->initialize(ref($_[0]) || $_[0]);
238 $meta->superclasses(@{$superclasses})
239 if defined $superclasses;
242 # process attributes first, so that they can
243 # install accessors, but locally defined methods
244 # can then overwrite them. It is maybe a little odd, but
245 # I think this should be the order of things.
246 if (defined $attributes) {
247 if(ref($attributes) eq 'ARRAY'){
248 # array of Mouse::Meta::Attribute
249 foreach my $attr (@{$attributes}) {
250 $meta->add_attribute($attr);
254 # hash map of name and attribute spec pairs
255 while(my($name, $attr) = each %{$attributes}){
256 $meta->add_attribute($name => $attr);
260 if (defined $methods) {
261 while(my($method_name, $method_body) = each %{$methods}){
262 $meta->add_method($method_name, $method_body);
266 Mouse::Util::apply_all_roles($package_name, @{$roles});
270 $IMMORTALS{$cache_key} = $meta;
279 return if $Mouse::Util::in_global_destruction;
281 my $serial_id = $self->{anon_serial_id};
282 return if !$serial_id;
284 # XXX: cleaning stash with threads causes panic/SEGV on legacy perls.
285 if(exists $INC{'threads.pm'}) {
286 # (caller)[2] indicates the caller's line number,
287 # which is zero when the current thread is joining (destroying).
288 return if( (caller)[2] == 0);
291 # clean up mortal anonymous class stuff
293 # @ISA is a magical variable, so we must clear it manually.
294 @{$self->{superclasses}} = () if exists $self->{superclasses};
296 # Then, clear the symbol table hash
297 %{$self->namespace} = ();
299 my $name = $self->name;
300 delete $METAS{$name};
302 $name =~ s/ $serial_id \z//xms;
304 delete ${$name}{ $serial_id . '::' };
314 Mouse::Meta::Module - The common base class of Mouse::Meta::Class and Mouse::Meta::Role
318 This document describes Mouse version 0.82
322 This class is an abstract base class of meta classes and meta roles.
328 L<Class::MOP::Module>
330 L<Class::MOP::Package>