Commit | Line | Data |
3a63a2e7 |
1 | package Mouse::Meta::Module; |
bc69ee88 |
2 | use Mouse::Util qw/:meta get_code_package load_class not_supported/; # enables strict and warnings |
3a63a2e7 |
3 | |
6d28c5cf |
4 | use Carp (); |
ad022aac |
5 | use Scalar::Util qw/blessed weaken/; |
fce211ae |
6 | |
fe1221ad |
7 | my %METAS; |
8536d351 |
8 | |
deb9a0f3 |
9 | sub _metaclass_cache { # DEPRECATED |
739525d0 |
10 | my($class, $name) = @_; |
fe1221ad |
11 | return $METAS{$name}; |
739525d0 |
12 | } |
8536d351 |
13 | |
739525d0 |
14 | sub initialize { |
15 | my($class, $package_name, @args) = @_; |
8536d351 |
16 | |
739525d0 |
17 | ($package_name && !ref($package_name)) |
18 | || $class->throw_error("You must pass a package name and it cannot be blessed"); |
8536d351 |
19 | |
fe1221ad |
20 | return $METAS{$package_name} |
739525d0 |
21 | ||= $class->_construct_meta(package => $package_name, @args); |
22 | } |
8536d351 |
23 | |
739525d0 |
24 | sub class_of{ |
25 | my($class_or_instance) = @_; |
26 | return undef unless defined $class_or_instance; |
23274b88 |
27 | return $METAS{ ref($class_or_instance) || $class_or_instance }; |
8536d351 |
28 | } |
29 | |
739525d0 |
30 | # Means of accessing all the metaclasses that have |
31 | # been initialized thus far |
fe1221ad |
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]} } |
739525d0 |
40 | |
41 | |
42 | |
3a63a2e7 |
43 | sub name { $_[0]->{package} } |
3a63a2e7 |
44 | |
739525d0 |
45 | # The followings are Class::MOP specific methods |
46 | |
47 | #sub version { no strict 'refs'; ${shift->name.'::VERSION'} } |
48 | #sub authority { no strict 'refs'; ${shift->name.'::AUTHORITY'} } |
49 | #sub identifier { |
50 | # my $self = shift; |
51 | # return join '-' => ( |
52 | # $self->name, |
53 | # ($self->version || ()), |
54 | # ($self->authority || ()), |
55 | # ); |
56 | #} |
23264b5b |
57 | |
8536d351 |
58 | # add_attribute is an abstract method |
59 | |
deb9a0f3 |
60 | sub get_attribute_map { # DEPRECATED |
3a683350 |
61 | Carp::cluck('get_attribute_map() has been deprecated'); |
62 | return $_[0]->{attributes}; |
63 | } |
64 | |
8536d351 |
65 | sub has_attribute { exists $_[0]->{attributes}->{$_[1]} } |
66 | sub get_attribute { $_[0]->{attributes}->{$_[1]} } |
67 | sub get_attribute_list{ keys %{$_[0]->{attributes}} } |
6cfa1e5e |
68 | sub remove_attribute { delete $_[0]->{attributes}->{$_[1]} } |
23264b5b |
69 | |
3a63a2e7 |
70 | sub namespace{ |
71 | my $name = $_[0]->{package}; |
72 | no strict 'refs'; |
73 | return \%{ $name . '::' }; |
74 | } |
75 | |
76 | sub add_method { |
77 | my($self, $name, $code) = @_; |
78 | |
79 | if(!defined $name){ |
1b9e472d |
80 | $self->throw_error('You must pass a defined name'); |
3a63a2e7 |
81 | } |
1b9e472d |
82 | if(!defined $code){ |
83 | $self->throw_error('You must pass a defined code'); |
84 | } |
85 | |
3a63a2e7 |
86 | if(ref($code) ne 'CODE'){ |
78dc5ed1 |
87 | $code = \&{$code}; # coerce |
3a63a2e7 |
88 | } |
89 | |
8e64d0fa |
90 | $self->{methods}->{$name}++; # Moose stores meta object here. |
3a63a2e7 |
91 | |
92 | my $pkg = $self->name; |
93 | no strict 'refs'; |
94 | no warnings 'redefine'; |
95 | *{ $pkg . '::' . $name } = $code; |
96 | } |
97 | |
01afd8ff |
98 | # XXX: for backward compatibility |
99 | my %foreign = map{ $_ => undef } qw( |
100 | Mouse Mouse::Role Mouse::Util Mouse::Util::TypeConstraints |
101 | Carp Scalar::Util |
102 | ); |
103 | sub _code_is_mine{ |
104 | my($self, $code) = @_; |
8e64d0fa |
105 | |
01afd8ff |
106 | my $package = get_code_package($code); |
8e64d0fa |
107 | |
01afd8ff |
108 | return !exists $foreign{$package}; |
3a63a2e7 |
109 | } |
110 | |
111 | sub has_method { |
112 | my($self, $method_name) = @_; |
113 | |
78dc5ed1 |
114 | defined($method_name) |
115 | or $self->throw_error('You must define a method name'); |
116 | |
8e64d0fa |
117 | return 1 if $self->{methods}->{$method_name}; |
5fd0bdcf |
118 | |
01afd8ff |
119 | my $code = do{ no strict 'refs'; *{$self->{package} . '::' . $method_name}{CODE} }; |
3a63a2e7 |
120 | |
121 | return $code && $self->_code_is_mine($code); |
122 | } |
123 | |
8536d351 |
124 | sub get_method{ |
6cfa1e5e |
125 | my($self, $method_name) = @_; |
126 | |
127 | if($self->has_method($method_name)){ |
128 | my $method_metaclass = $self->method_metaclass; |
129 | load_class($method_metaclass); |
130 | |
131 | my $package = $self->name; |
132 | return $method_metaclass->new( |
133 | body => $package->can($method_name), |
134 | name => $method_name, |
135 | package => $package, |
136 | ); |
137 | } |
138 | |
139 | return undef; |
8536d351 |
140 | } |
3a63a2e7 |
141 | |
8e64d0fa |
142 | sub get_method_list { |
3a63a2e7 |
143 | my($self) = @_; |
8e64d0fa |
144 | |
145 | return grep { $self->has_method($_) } keys %{ $self->namespace }; |
3a63a2e7 |
146 | } |
147 | |
7a50b450 |
148 | { |
149 | my $ANON_SERIAL = 0; |
7a50b450 |
150 | |
151 | my %IMMORTALS; |
152 | |
153 | sub create { |
7eb3a8d5 |
154 | my($self, $package_name, %options) = @_; |
7a50b450 |
155 | |
7eb3a8d5 |
156 | my $class = ref($self) || $self; |
157 | $self->throw_error('You must pass a package name') if @_ < 2; |
7a50b450 |
158 | |
8f40866c |
159 | my $superclasses; |
7a50b450 |
160 | if(exists $options{superclasses}){ |
7eb3a8d5 |
161 | if($self->isa('Mouse::Meta::Role')){ |
7a50b450 |
162 | delete $options{superclasses}; |
163 | } |
8f40866c |
164 | else{ |
165 | $superclasses = delete $options{superclasses}; |
166 | (ref $superclasses eq 'ARRAY') |
7eb3a8d5 |
167 | || $self->throw_error("You must pass an ARRAY ref of superclasses"); |
8f40866c |
168 | } |
7a50b450 |
169 | } |
170 | |
8f40866c |
171 | my $attributes = delete $options{attributes}; |
172 | if(defined $attributes){ |
173 | (ref $attributes eq 'ARRAY' || ref $attributes eq 'HASH') |
7eb3a8d5 |
174 | || $self->throw_error("You must pass an ARRAY ref of attributes"); |
8f40866c |
175 | } |
176 | my $methods = delete $options{methods}; |
177 | if(defined $methods){ |
178 | (ref $methods eq 'HASH') |
7eb3a8d5 |
179 | || $self->throw_error("You must pass a HASH ref of methods"); |
8f40866c |
180 | } |
181 | my $roles = delete $options{roles}; |
182 | if(defined $roles){ |
183 | (ref $roles eq 'ARRAY') |
7eb3a8d5 |
184 | || $self->throw_error("You must pass an ARRAY ref of roles"); |
8f40866c |
185 | } |
7a50b450 |
186 | my $mortal; |
187 | my $cache_key; |
188 | |
189 | if(!defined $package_name){ # anonymous |
190 | $mortal = !$options{cache}; |
191 | |
192 | # anonymous but immortal |
193 | if(!$mortal){ |
8e64d0fa |
194 | # something like Super::Class|Super::Class::2=Role|Role::1 |
195 | $cache_key = join '=' => ( |
8f40866c |
196 | join('|', @{$superclasses || []}), |
197 | join('|', sort @{$roles || []}), |
7a50b450 |
198 | ); |
199 | return $IMMORTALS{$cache_key} if exists $IMMORTALS{$cache_key}; |
200 | } |
8f40866c |
201 | $options{anon_serial_id} = ++$ANON_SERIAL; |
202 | $package_name = $class . '::__ANON__::' . $ANON_SERIAL; |
7a50b450 |
203 | } |
204 | |
205 | # instantiate a module |
206 | { |
207 | no strict 'refs'; |
208 | ${ $package_name . '::VERSION' } = delete $options{version} if exists $options{version}; |
209 | ${ $package_name . '::AUTHORITY' } = delete $options{authority} if exists $options{authority}; |
210 | } |
211 | |
7eb3a8d5 |
212 | my $meta = $self->initialize( $package_name, %options); |
7a50b450 |
213 | |
fe1221ad |
214 | weaken $METAS{$package_name} |
7a50b450 |
215 | if $mortal; |
216 | |
7eb3a8d5 |
217 | $meta->add_method(meta => sub{ |
218 | $self->initialize(ref($_[0]) || $_[0]); |
7a50b450 |
219 | }); |
220 | |
8f40866c |
221 | $meta->superclasses(@{$superclasses}) |
222 | if defined $superclasses; |
7a50b450 |
223 | |
224 | # NOTE: |
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'){ |
8f40866c |
231 | # array of Mouse::Meta::Attribute |
7a50b450 |
232 | foreach my $attr (@{$attributes}) { |
8f40866c |
233 | $meta->add_attribute($attr); |
7a50b450 |
234 | } |
235 | } |
236 | else{ |
8f40866c |
237 | # hash map of name and attribute spec pairs |
7a50b450 |
238 | while(my($name, $attr) = each %{$attributes}){ |
239 | $meta->add_attribute($name => $attr); |
240 | } |
241 | } |
242 | } |
8f40866c |
243 | if (defined $methods) { |
244 | while(my($method_name, $method_body) = each %{$methods}){ |
245 | $meta->add_method($method_name, $method_body); |
7a50b450 |
246 | } |
247 | } |
8f40866c |
248 | if (defined $roles){ |
249 | Mouse::Util::apply_all_roles($package_name, @{$roles}); |
7a50b450 |
250 | } |
251 | |
8f40866c |
252 | if($cache_key){ |
7a50b450 |
253 | $IMMORTALS{$cache_key} = $meta; |
254 | } |
255 | |
256 | return $meta; |
257 | } |
258 | |
259 | sub DESTROY{ |
260 | my($self) = @_; |
261 | |
262 | my $serial_id = $self->{anon_serial_id}; |
263 | |
264 | return if !$serial_id; |
265 | |
e75f21db |
266 | # @ISA is a magical variable, so we clear it manually. |
267 | @{$self->{superclasses}} = () if exists $self->{superclasses}; |
268 | |
269 | # Then, clear the symbol table hash |
270 | %{$self->namespace} = (); |
7a50b450 |
271 | |
8f40866c |
272 | my $name = $self->name; |
273 | delete $METAS{$name}; |
274 | |
e75f21db |
275 | $name =~ s/ $serial_id \z//xms; |
7a50b450 |
276 | |
277 | no strict 'refs'; |
8f40866c |
278 | delete ${$name}{ $serial_id . '::' }; |
7a50b450 |
279 | |
280 | return; |
281 | } |
282 | } |
283 | |
8536d351 |
284 | sub throw_error{ |
285 | my($class, $message, %args) = @_; |
286 | |
fce211ae |
287 | local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0); |
8e64d0fa |
288 | local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though |
3a63a2e7 |
289 | |
8536d351 |
290 | if(exists $args{longmess} && !$args{longmess}){ # intentionaly longmess => 0 |
291 | Carp::croak($message); |
292 | } |
293 | else{ |
294 | Carp::confess($message); |
295 | } |
296 | } |
3a63a2e7 |
297 | |
298 | 1; |
299 | |
300 | __END__ |
301 | |
302 | =head1 NAME |
303 | |
1820fffe |
304 | Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Role |
3a63a2e7 |
305 | |
b995be6a |
306 | =head1 SEE ALSO |
307 | |
31c5194b |
308 | L<Class::MOP::Class> |
309 | |
310 | L<Class::MOP::Module> |
311 | |
312 | L<Class::MOP::Package> |
b995be6a |
313 | |
3a63a2e7 |
314 | =cut |
2cea7a5f |
315 | |