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) };
18 my($class, $package_name, @args) = @_;
20 ($package_name && !ref($package_name))
21 || $class->throw_error("You must pass a package name and it cannot be blessed");
23 return $METAS{$package_name}
24 ||= $class->_construct_meta(package => $package_name, @args);
28 my($class, $package_name, @args) = @_;
30 $package_name = $package_name->name if ref $package_name;
32 ($package_name && !ref($package_name))
33 || $class->throw_error("You must pass a package name and it cannot be blessed");
35 if(exists $METAS{$package_name}) {
36 unshift @args, %{ $METAS{$package_name} };
38 delete $METAS{$package_name};
39 return $class->initialize($package_name, @args);
43 my($class_or_instance) = @_;
44 return undef unless defined $class_or_instance;
45 return $METAS{ ref($class_or_instance) || $class_or_instance };
48 # Means of accessing all the metaclasses that have
49 # been initialized thus far.
50 # The public versions are aliased into Mouse::Util::*.
51 #sub _get_all_metaclasses { %METAS }
52 sub _get_all_metaclass_instances { values %METAS }
53 sub _get_all_metaclass_names { keys %METAS }
54 sub _get_metaclass_by_name { $METAS{$_[0]} }
55 #sub _store_metaclass_by_name { $METAS{$_[0]} = $_[1] }
56 #sub _weaken_metaclass { weaken($METAS{$_[0]}) }
57 #sub _does_metaclass_exist { defined $METAS{$_[0]} }
58 #sub _remove_metaclass_by_name { delete $METAS{$_[0]} }
64 # add_attribute is an abstract method
66 sub get_attribute_map { # DEPRECATED
67 Carp::cluck('get_attribute_map() has been deprecated. Use get_attribute_list() and get_attribute() instead');
68 return $_[0]->{attributes};
71 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
72 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
73 sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} }
75 sub get_attribute_list{ keys %{$_[0]->{attributes}} }
77 # XXX: not completely compatible with Moose
78 my %foreign = map{ $_ => undef } qw(
79 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
80 Carp Scalar::Util List::Util
82 sub _get_method_body {
83 my($self, $method_name) = @_;
84 my $code = Mouse::Util::get_code_ref($self->{package}, $method_name);
85 return $code && !exists $foreign{ Mouse::Util::get_code_package($code) }
93 my($self, $method_name) = @_;
95 or $self->throw_error('You must define a method name');
97 return defined( $self->{methods}{$method_name} )
98 || defined( $self->_get_method_body($method_name) );
101 sub get_method_body {
102 my($self, $method_name) = @_;
103 defined($method_name)
104 or $self->throw_error('You must define a method name');
106 return $self->{methods}{$method_name}
107 ||= $self->_get_method_body($method_name);
111 my($self, $method_name) = @_;
113 if(my $code = $self->get_method_body($method_name)){
114 return Mouse::Util::load_class($self->method_metaclass)->wrap(
116 name => $method_name,
117 package => $self->name,
118 associated_metaclass => $self,
125 sub get_method_list {
128 return grep { $self->has_method($_) } keys %{ $self->namespace };
131 sub _collect_methods { # Mouse specific, used for method modifiers
132 my($meta, @args) = @_;
135 foreach my $arg(@args){
136 if(my $type = ref $arg){
137 if($type eq 'Regexp'){
138 push @methods, grep { $_ =~ $arg } $meta->get_all_method_names;
140 elsif($type eq 'ARRAY'){
141 push @methods, @{$arg};
144 my $subname = ( caller(1) )[3];
147 'Methods passed to %s must be provided as a list,'
148 . ' ArrayRef or regular expression, not %s',
162 my $ANON_SERIAL = 0; # anonymous class/role id
163 my %IMMORTALS; # immortal anonymous classes
166 my($self, $package_name, %options) = @_;
168 my $class = ref($self) || $self;
169 $self->throw_error('You must pass a package name') if @_ < 2;
172 if(exists $options{superclasses}){
173 if(Mouse::Util::is_a_metarole($self)){
174 delete $options{superclasses};
177 $superclasses = delete $options{superclasses};
178 (ref $superclasses eq 'ARRAY')
179 || $self->throw_error("You must pass an ARRAY ref of superclasses");
183 my $attributes = delete $options{attributes};
184 if(defined $attributes){
185 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
186 || $self->throw_error("You must pass an ARRAY ref of attributes");
188 my $methods = delete $options{methods};
189 if(defined $methods){
190 (ref $methods eq 'HASH')
191 || $self->throw_error("You must pass a HASH ref of methods");
193 my $roles = delete $options{roles};
195 (ref $roles eq 'ARRAY')
196 || $self->throw_error("You must pass an ARRAY ref of roles");
201 if(!defined $package_name){ # anonymous
202 $mortal = !$options{cache};
204 # anonymous but immortal
206 # something like Super::Class|Super::Class::2=Role|Role::1
207 $cache_key = join '=' => (
208 join('|', @{$superclasses || []}),
209 join('|', sort @{$roles || []}),
211 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
213 $options{anon_serial_id} = ++$ANON_SERIAL;
214 $package_name = $class . '::__ANON__::' . $ANON_SERIAL;
218 # instantiate a module
221 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
222 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
225 my $meta = $self->initialize( $package_name, %options);
227 Scalar::Util::weaken($METAS{$package_name})
230 $meta->add_method(meta => sub {
231 $self->initialize(ref($_[0]) || $_[0]);
234 $meta->superclasses(@{$superclasses})
235 if defined $superclasses;
238 # process attributes first, so that they can
239 # install accessors, but locally defined methods
240 # can then overwrite them. It is maybe a little odd, but
241 # I think this should be the order of things.
242 if (defined $attributes) {
243 if(ref($attributes) eq 'ARRAY'){
244 # array of Mouse::Meta::Attribute
245 foreach my $attr (@{$attributes}) {
246 $meta->add_attribute($attr);
250 # hash map of name and attribute spec pairs
251 while(my($name, $attr) = each %{$attributes}){
252 $meta->add_attribute($name => $attr);
256 if (defined $methods) {
257 while(my($method_name, $method_body) = each %{$methods}){
258 $meta->add_method($method_name, $method_body);
261 if (defined $roles and !$options{in_application_to_instance}){
262 Mouse::Util::apply_all_roles($package_name, @{$roles});
266 $IMMORTALS{$cache_key} = $meta;
275 return if $Mouse::Util::in_global_destruction;
277 my $serial_id = $self->{anon_serial_id};
278 return if !$serial_id;
280 # XXX: cleaning stash with threads causes panic/SEGV on legacy perls.
281 if(exists $INC{'threads.pm'}) {
282 # (caller)[2] indicates the caller's line number,
283 # which is zero when the current thread is joining (destroying).
284 return if( (caller)[2] == 0);
287 # clean up mortal anonymous class stuff
289 # @ISA is a magical variable, so we must clear it manually.
290 @{$self->{superclasses}} = () if exists $self->{superclasses};
292 # Then, clear the symbol table hash
293 %{$self->namespace} = ();
295 my $name = $self->name;
296 delete $METAS{$name};
298 $name =~ s/ $serial_id \z//xms;
300 delete ${$name}{ $serial_id . '::' };
310 Mouse::Meta::Module - The common base class of Mouse::Meta::Class and Mouse::Meta::Role
314 This document describes Mouse version 0.93
318 This class is an abstract base class of meta classes and meta roles.
324 L<Class::MOP::Module>
326 L<Class::MOP::Package>