1 package Mouse::Meta::Module;
2 use Mouse::Util qw/:meta get_code_package load_class not_supported/; # enables strict and warnings
5 use Scalar::Util qw/blessed weaken/;
9 sub _metaclass_cache { # DEPRECATED
10 my($class, $name) = @_;
15 my($class, $package_name, @args) = @_;
17 ($package_name && !ref($package_name))
18 || $class->throw_error("You must pass a package name and it cannot be blessed");
20 return $METAS{$package_name}
21 ||= $class->_construct_meta(package => $package_name, @args);
25 my($class_or_instance) = @_;
26 return undef unless defined $class_or_instance;
27 return $METAS{ ref($class_or_instance) || $class_or_instance };
30 # Means of accessing all the metaclasses that have
31 # been initialized thus far
32 #sub get_all_metaclasses { %METAS }
33 sub get_all_metaclass_instances { values %METAS }
34 sub get_all_metaclass_names { keys %METAS }
35 sub get_metaclass_by_name { $METAS{$_[0]} }
36 #sub store_metaclass_by_name { $METAS{$_[0]} = $_[1] }
37 #sub weaken_metaclass { weaken($METAS{$_[0]}) }
38 #sub does_metaclass_exist { defined $METAS{$_[0]} }
39 #sub remove_metaclass_by_name { delete $METAS{$_[0]} }
43 sub name { $_[0]->{package} }
45 # The followings are Class::MOP specific methods
47 #sub version { no strict 'refs'; ${shift->name.'::VERSION'} }
48 #sub authority { no strict 'refs'; ${shift->name.'::AUTHORITY'} }
51 # return join '-' => (
53 # ($self->version || ()),
54 # ($self->authority || ()),
58 # add_attribute is an abstract method
60 sub get_attribute_map { # DEPRECATED
61 Carp::cluck('get_attribute_map() has been deprecated');
62 return $_[0]->{attributes};
65 sub has_attribute { exists $_[0]->{attributes}->{$_[1]} }
66 sub get_attribute { $_[0]->{attributes}->{$_[1]} }
67 sub get_attribute_list{ keys %{$_[0]->{attributes}} }
68 sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} }
71 my $name = $_[0]->{package};
73 return \%{ $name . '::' };
77 my($self, $name, $code) = @_;
80 $self->throw_error('You must pass a defined name');
83 $self->throw_error('You must pass a defined code');
86 if(ref($code) ne 'CODE'){
87 $code = \&{$code}; # coerce
90 $self->{methods}->{$name}++; # Moose stores meta object here.
92 my $pkg = $self->name;
94 no warnings 'redefine';
95 *{ $pkg . '::' . $name } = $code;
98 # XXX: for backward compatibility
99 my %foreign = map{ $_ => undef } qw(
100 Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints
104 my($self, $code) = @_;
106 my $package = get_code_package($code);
108 return !exists $foreign{$package};
112 my($self, $method_name) = @_;
114 defined($method_name)
115 or $self->throw_error('You must define a method name');
117 return 1 if $self->{methods}->{$method_name};
119 my $code = do{ no strict 'refs'; *{$self->{package} . '::' . $method_name}{CODE} };
121 return $code && $self->_code_is_mine($code);
125 my($self, $method_name) = @_;
127 if($self->has_method($method_name)){
128 my $method_metaclass = $self->method_metaclass;
129 load_class($method_metaclass);
131 my $package = $self->name;
132 return $method_metaclass->new(
133 body => $package->can($method_name),
134 name => $method_name,
142 sub get_method_list {
145 return grep { $self->has_method($_) } keys %{ $self->namespace };
154 my($self, $package_name, %options) = @_;
156 my $class = ref($self) || $self;
157 $self->throw_error('You must pass a package name') if @_ < 2;
160 if(exists $options{superclasses}){
161 if($self->isa('Mouse::Meta::Role')){
162 delete $options{superclasses};
165 $superclasses = delete $options{superclasses};
166 (ref $superclasses eq 'ARRAY')
167 || $self->throw_error("You must pass an ARRAY ref of superclasses");
171 my $attributes = delete $options{attributes};
172 if(defined $attributes){
173 (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH')
174 || $self->throw_error("You must pass an ARRAY ref of attributes");
176 my $methods = delete $options{methods};
177 if(defined $methods){
178 (ref $methods eq 'HASH')
179 || $self->throw_error("You must pass a HASH ref of methods");
181 my $roles = delete $options{roles};
183 (ref $roles eq 'ARRAY')
184 || $self->throw_error("You must pass an ARRAY ref of 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('|', @{$superclasses || []}),
197 join('|', sort @{$roles || []}),
199 return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key};
201 $options{anon_serial_id} = ++$ANON_SERIAL;
202 $package_name = $class . '::__ANON__::' . $ANON_SERIAL;
205 # instantiate a module
208 ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version};
209 ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority};
212 my $meta = $self->initialize( $package_name, %options);
214 weaken $METAS{$package_name}
217 $meta->add_method(meta => sub{
218 $self->initialize(ref($_[0]) || $_[0]);
221 $meta->superclasses(@{$superclasses})
222 if defined $superclasses;
225 # process attributes first, so that they can
226 # install accessors, but locally defined methods
227 # can then overwrite them. It is maybe a little odd, but
228 # I think this should be the order of things.
229 if (defined $attributes) {
230 if(ref($attributes) eq 'ARRAY'){
231 # array of Mouse::Meta::Attribute
232 foreach my $attr (@{$attributes}) {
233 $meta->add_attribute($attr);
237 # hash map of name and attribute spec pairs
238 while(my($name, $attr) = each %{$attributes}){
239 $meta->add_attribute($name => $attr);
243 if (defined $methods) {
244 while(my($method_name, $method_body) = each %{$methods}){
245 $meta->add_method($method_name, $method_body);
249 Mouse::Util::apply_all_roles($package_name, @{$roles});
253 $IMMORTALS{$cache_key} = $meta;
262 my $serial_id = $self->{anon_serial_id};
264 return if !$serial_id;
266 # @ISA is a magical variable, so we clear it manually.
267 @{$self->{superclasses}} = () if exists $self->{superclasses};
269 # Then, clear the symbol table hash
270 %{$self->namespace} = ();
272 my $name = $self->name;
273 delete $METAS{$name};
275 $name =~ s/ $serial_id \z//xms;
278 delete ${$name}{ $serial_id . '::' };
285 my($class, $message, %args) = @_;
287 local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0);
288 local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
290 if(exists $args{longmess} && !$args{longmess}){ # intentionaly longmess => 0
291 Carp::croak($message);
294 Carp::confess($message);
304 Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Role
310 L<Class::MOP::Module>
312 L<Class::MOP::Package>