1 package Mouse::Meta::Module;
2 use Mouse::Util qw/:meta get_code_package get_code_ref not_supported/; # 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($class, $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 delete $METAS{$package_name};
42 return $class->initialize($package_name, @args);
46 my($class_or_instance) = @_;
47 return undef unless defined $class_or_instance;
48 return $METAS{ ref($class_or_instance) || $class_or_instance };
51 # Means of accessing all the metaclasses that have
52 # been initialized thus far
53 #sub _get_all_metaclasses { %METAS }
54 sub _get_all_metaclass_instances { values %METAS }
55 sub _get_all_metaclass_names { keys %METAS }
56 sub _get_metaclass_by_name { $METAS{$_[0]} }
57 #sub _store_metaclass_by_name { $METAS{$_[0]} = $_[1] }
58 #sub _weaken_metaclass { weaken($METAS{$_[0]}) }
59 #sub _does_metaclass_exist { defined $METAS{$_[0]} }
60 #sub _remove_metaclass_by_name { delete $METAS{$_[0]} }
66 # The followings are Class::MOP specific methods
68 #sub version { no strict 'refs'; ${shift->name.'::VERSION'} }
69 #sub authority { no strict 'refs'; ${shift->name.'::AUTHORITY'} }
72 # return join '-' => (
74 # ($self->version || ()),
75 # ($self->authority || ()),
79 # add_attribute is an abstract method
81 sub get_attribute_map { # DEPRECATED
82 Carp::cluck('get_attribute_map() has been deprecated. Use get_attribute_list() and get_attribute() instead');
83 return $_[0]->{attributes};
86 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
87 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
88 sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} }
90 sub get_attribute_list{ keys %{$_[0]->{attributes}} }
92 # XXX: for backward compatibility
93 my %foreign = map{ $_ => undef } qw(
94 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
95 Carp Scalar::Util List::Util
98 # my($self, $code) = @_;
100 return !exists $foreign{ get_code_package($_[1]) };
106 my($self, $method_name) = @_;
108 defined($method_name)
109 or $self->throw_error('You must define a method name');
111 return defined($self->{methods}{$method_name}) || do{
112 my $code = get_code_ref($self->{package}, $method_name);
113 $code && $self->_code_is_mine($code);
117 sub get_method_body {
118 my($self, $method_name) = @_;
120 defined($method_name)
121 or $self->throw_error('You must define a method name');
123 return $self->{methods}{$method_name} ||= do{
124 my $code = get_code_ref($self->{package}, $method_name);
125 $code && $self->_code_is_mine($code) ? $code : undef;
130 my($self, $method_name) = @_;
132 if(my $code = $self->get_method_body($method_name)){
133 return Mouse::Util::load_class($self->method_metaclass)->wrap(
135 name => $method_name,
136 package => $self->name,
137 associated_metaclass => $self,
144 sub get_method_list {
147 return grep { $self->has_method($_) } keys %{ $self->namespace };
150 sub _collect_methods { # Mouse specific
151 my($meta, @args) = @_;
154 foreach my $arg(@args){
155 if(my $type = ref $arg){
156 if($type eq 'Regexp'){
157 push @methods, grep { $_ =~ $arg } $meta->get_all_method_names;
159 elsif($type eq 'ARRAY'){
160 push @methods, @{$arg};
163 my $subname = ( caller(1) )[3];
166 'Methods passed to %s must be provided as a list, ArrayRef or regular expression, not %s',
187 my($self, $package_name, %options) = @_;
189 my $class = ref($self) || $self;
190 $self->throw_error('You must pass a package name') if @_ < 2;
193 if(exists $options{superclasses}){
194 if(Mouse::Util::is_a_metarole($self)){
195 delete $options{superclasses};
198 $superclasses = delete $options{superclasses};
199 (ref $superclasses eq 'ARRAY')
200 || $self->throw_error("You must pass an ARRAY ref of superclasses");
204 my $attributes = delete $options{attributes};
205 if(defined $attributes){
206 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
207 || $self->throw_error("You must pass an ARRAY ref of attributes");
209 my $methods = delete $options{methods};
210 if(defined $methods){
211 (ref $methods eq 'HASH')
212 || $self->throw_error("You must pass a HASH ref of methods");
214 my $roles = delete $options{roles};
216 (ref $roles eq 'ARRAY')
217 || $self->throw_error("You must pass an ARRAY ref of roles");
222 if(!defined $package_name){ # anonymous
223 $mortal = !$options{cache};
225 # anonymous but immortal
227 # something like Super::Class|Super::Class::2=Role|Role::1
228 $cache_key = join '=' => (
229 join('|', @{$superclasses || []}),
230 join('|', sort @{$roles || []}),
232 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
234 $options{anon_serial_id} = ++$ANON_SERIAL;
235 $package_name = $class . '::__ANON__::' . $ANON_SERIAL;
238 # instantiate a module
241 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
242 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
245 my $meta = $self->initialize( $package_name, %options);
247 Scalar::Util::weaken $METAS{$package_name}
250 $meta->add_method(meta => sub{
251 $self->initialize(ref($_[0]) || $_[0]);
254 $meta->superclasses(@{$superclasses})
255 if defined $superclasses;
258 # process attributes first, so that they can
259 # install accessors, but locally defined methods
260 # can then overwrite them. It is maybe a little odd, but
261 # I think this should be the order of things.
262 if (defined $attributes) {
263 if(ref($attributes) eq 'ARRAY'){
264 # array of Mouse::Meta::Attribute
265 foreach my $attr (@{$attributes}) {
266 $meta->add_attribute($attr);
270 # hash map of name and attribute spec pairs
271 while(my($name, $attr) = each %{$attributes}){
272 $meta->add_attribute($name => $attr);
276 if (defined $methods) {
277 while(my($method_name, $method_body) = each %{$methods}){
278 $meta->add_method($method_name, $method_body);
282 Mouse::Util::apply_all_roles($package_name, @{$roles});
286 $IMMORTALS{$cache_key} = $meta;
295 return if $Mouse::Util::in_global_destruction;
297 my $serial_id = $self->{anon_serial_id};
299 return if !$serial_id;
301 # @ISA is a magical variable, so we clear it manually.
302 @{$self->{superclasses}} = () if exists $self->{superclasses};
304 # Then, clear the symbol table hash
305 %{$self->namespace} = ();
307 my $name = $self->name;
308 delete $METAS{$name};
310 $name =~ s/ $serial_id \z//xms;
313 delete ${$name}{ $serial_id . '::' };
320 my($class, $message, %args) = @_;
322 local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0);
323 local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
325 if(exists $args{longmess} && !$args{longmess}){ # intentionaly longmess => 0
326 Carp::croak($message);
329 Carp::confess($message);
338 Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Role
342 This document describes Mouse version 0.50_03
348 L<Class::MOP::Module>
350 L<Class::MOP::Package>