1 package Mouse::Meta::Module;
2 use Mouse::Util qw/:meta get_code_package get_code_ref load_class not_supported/; # enables strict and warnings
4 use Mouse::Util::TypeConstraints ();
11 sub _metaclass_cache { # DEPRECATED
12 my($class, $name) = @_;
17 my($class, $package_name, @args) = @_;
19 ($package_name && !ref($package_name))
20 || $class->throw_error("You must pass a package name and it cannot be blessed");
22 return $METAS{$package_name}
23 ||= $class->_construct_meta(package => $package_name, @args);
27 my($class_or_instance) = @_;
28 return undef unless defined $class_or_instance;
29 return $METAS{ ref($class_or_instance) || $class_or_instance };
32 # Means of accessing all the metaclasses that have
33 # been initialized thus far
34 #sub get_all_metaclasses { %METAS }
35 sub get_all_metaclass_instances { values %METAS }
36 sub get_all_metaclass_names { keys %METAS }
37 sub get_metaclass_by_name { $METAS{$_[0]} }
38 #sub store_metaclass_by_name { $METAS{$_[0]} = $_[1] }
39 #sub weaken_metaclass { weaken($METAS{$_[0]}) }
40 #sub does_metaclass_exist { defined $METAS{$_[0]} }
41 #sub remove_metaclass_by_name { delete $METAS{$_[0]} }
47 # The followings are Class::MOP specific methods
49 #sub version { no strict 'refs'; ${shift->name.'::VERSION'} }
50 #sub authority { no strict 'refs'; ${shift->name.'::AUTHORITY'} }
53 # return join '-' => (
55 # ($self->version || ()),
56 # ($self->authority || ()),
60 # add_attribute is an abstract method
62 sub get_attribute_map { # DEPRECATED
63 Carp::cluck('get_attribute_map() has been deprecated');
64 return $_[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]} }
72 # XXX: for backward compatibility
73 my %foreign = map{ $_ => undef } qw(
74 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
78 my($self, $code) = @_;
80 my $package = get_code_package($code);
82 return !exists $foreign{$package};
88 my($self, $method_name) = @_;
91 or $self->throw_error('You must define a method name');
93 return 1 if $self->{methods}{$method_name};
95 my $code = get_code_ref($self->{package}, $method_name);
97 return $code && $self->_code_is_mine($code);
101 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} ||= do{
107 my $code = get_code_ref($self->{package}, $method_name);
108 ($code && $self->_code_is_mine($code)) ? $code : undef;
113 my($self, $method_name) = @_;
115 if($self->has_method($method_name)){
116 my $method_metaclass = $self->method_metaclass;
117 load_class($method_metaclass);
119 return $method_metaclass->wrap(
120 body => $self->get_method_body($method_name),
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 };
142 my($self, $package_name, %options) = @_;
144 my $class = ref($self) || $self;
145 $self->throw_error('You must pass a package name') if @_ < 2;
148 if(exists $options{superclasses}){
149 if(Mouse::Util::TypeConstraints::_is_a_metarole($self)){
150 delete $options{superclasses};
153 $superclasses = delete $options{superclasses};
154 (ref $superclasses eq 'ARRAY')
155 || $self->throw_error("You must pass an ARRAY ref of superclasses");
159 my $attributes = delete $options{attributes};
160 if(defined $attributes){
161 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
162 || $self->throw_error("You must pass an ARRAY ref of attributes");
164 my $methods = delete $options{methods};
165 if(defined $methods){
166 (ref $methods eq 'HASH')
167 || $self->throw_error("You must pass a HASH ref of methods");
169 my $roles = delete $options{roles};
171 (ref $roles eq 'ARRAY')
172 || $self->throw_error("You must pass an ARRAY ref of roles");
177 if(!defined $package_name){ # anonymous
178 $mortal = !$options{cache};
180 # anonymous but immortal
182 # something like Super::Class|Super::Class::2=Role|Role::1
183 $cache_key = join '=' => (
184 join('|', @{$superclasses || []}),
185 join('|', sort @{$roles || []}),
187 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
189 $options{anon_serial_id} = ++$ANON_SERIAL;
190 $package_name = $class . '::__ANON__::' . $ANON_SERIAL;
193 # instantiate a module
196 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
197 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
200 my $meta = $self->initialize( $package_name, %options);
202 Scalar::Util::weaken $METAS{$package_name}
205 $meta->add_method(meta => sub{
206 $self->initialize(ref($_[0]) || $_[0]);
209 $meta->superclasses(@{$superclasses})
210 if defined $superclasses;
213 # process attributes first, so that they can
214 # install accessors, but locally defined methods
215 # can then overwrite them. It is maybe a little odd, but
216 # I think this should be the order of things.
217 if (defined $attributes) {
218 if(ref($attributes) eq 'ARRAY'){
219 # array of Mouse::Meta::Attribute
220 foreach my $attr (@{$attributes}) {
221 $meta->add_attribute($attr);
225 # hash map of name and attribute spec pairs
226 while(my($name, $attr) = each %{$attributes}){
227 $meta->add_attribute($name => $attr);
231 if (defined $methods) {
232 while(my($method_name, $method_body) = each %{$methods}){
233 $meta->add_method($method_name, $method_body);
237 Mouse::Util::apply_all_roles($package_name, @{$roles});
241 $IMMORTALS{$cache_key} = $meta;
250 my $serial_id = $self->{anon_serial_id};
252 return if !$serial_id;
254 # @ISA is a magical variable, so we clear it manually.
255 @{$self->{superclasses}} = () if exists $self->{superclasses};
257 # Then, clear the symbol table hash
258 %{$self->namespace} = ();
260 my $name = $self->name;
261 delete $METAS{$name};
263 $name =~ s/ $serial_id \z//xms;
266 delete ${$name}{ $serial_id . '::' };
273 my($class, $message, %args) = @_;
275 local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0);
276 local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
278 if(exists $args{longmess} && !$args{longmess}){ # intentionaly longmess => 0
279 Carp::croak($message);
282 Carp::confess($message);
292 Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Role
296 This document describes Mouse version 0.40_01
302 L<Class::MOP::Module>
304 L<Class::MOP::Package>