Commit | Line | Data |
306290e8 |
1 | package Mouse::Meta::Class; |
c3398f5b |
2 | use strict; |
3 | use warnings; |
4 | |
fc1d8369 |
5 | use Mouse::Meta::Method::Constructor; |
bbf64e76 |
6 | use Mouse::Meta::Method::Destructor; |
6c169c50 |
7 | use Scalar::Util qw/blessed/; |
8 | use Mouse::Util qw/get_linear_isa/; |
7a59f4e8 |
9 | use Carp 'confess'; |
72b88a88 |
10 | |
c3398f5b |
11 | do { |
12 | my %METACLASS_CACHE; |
72b88a88 |
13 | |
14 | # because Mouse doesn't introspect existing classes, we're forced to |
15 | # only pay attention to other Mouse classes |
16 | sub _metaclass_cache { |
17 | my $class = shift; |
18 | my $name = shift; |
19 | return $METACLASS_CACHE{$name}; |
20 | } |
21 | |
c3398f5b |
22 | sub initialize { |
23 | my $class = shift; |
24 | my $name = shift; |
25 | $METACLASS_CACHE{$name} = $class->new(name => $name) |
26 | if !exists($METACLASS_CACHE{$name}); |
27 | return $METACLASS_CACHE{$name}; |
28 | } |
29 | }; |
30 | |
31 | sub new { |
32 | my $class = shift; |
6cbacbf6 |
33 | my %args = @_; |
c3398f5b |
34 | |
35 | $args{attributes} = {}; |
36 | $args{superclasses} = do { |
37 | no strict 'refs'; |
38 | \@{ $args{name} . '::ISA' }; |
39 | }; |
47f36c05 |
40 | $args{roles} ||= []; |
c3398f5b |
41 | |
42 | bless \%args, $class; |
43 | } |
44 | |
45 | sub name { $_[0]->{name} } |
46 | |
47 | sub superclasses { |
48 | my $self = shift; |
49 | |
50 | if (@_) { |
51 | Mouse::load_class($_) for @_; |
52 | @{ $self->{superclasses} } = @_; |
53 | } |
54 | |
55 | @{ $self->{superclasses} }; |
56 | } |
57 | |
d16fe7d7 |
58 | sub add_method { |
59 | my $self = shift; |
60 | my $name = shift; |
61 | my $code = shift; |
62 | |
63 | my $pkg = $self->name; |
64 | |
65 | no strict 'refs'; |
47b5feb9 |
66 | no warnings 'redefine'; |
8632b6fe |
67 | $self->{'methods'}->{$name}++; # Moose stores meta object here. |
d16fe7d7 |
68 | *{ $pkg . '::' . $name } = $code; |
69 | } |
70 | |
2e92bb89 |
71 | # copied from Class::Inspector |
4724d42e |
72 | my $get_methods_for_class = sub { |
2e92bb89 |
73 | my $self = shift; |
4724d42e |
74 | my $name = shift; |
2e92bb89 |
75 | |
76 | no strict 'refs'; |
77 | # Get all the CODE symbol table entries |
8632b6fe |
78 | my @functions = |
478cab2c |
79 | grep !/^(?:has|with|around|before|after|blessed|extends|confess|override|super)$/, |
2e92bb89 |
80 | grep { defined &{"${name}::$_"} } |
81 | keys %{"${name}::"}; |
4724d42e |
82 | push @functions, keys %{$self->{'methods'}->{$name}} if $self; |
2e92bb89 |
83 | wantarray ? @functions : \@functions; |
4724d42e |
84 | }; |
85 | |
86 | sub get_method_list { |
87 | my $self = shift; |
88 | $get_methods_for_class->($self, $self->name); |
2e92bb89 |
89 | } |
90 | |
60cfc6ad |
91 | sub get_all_method_names { |
92 | my $self = shift; |
93 | my %uniq; |
94 | return grep { $uniq{$_}++ == 0 } |
95 | map { $get_methods_for_class->(undef, $_) } |
96 | $self->linearized_isa; |
97 | } |
98 | |
c3398f5b |
99 | sub add_attribute { |
100 | my $self = shift; |
101 | my $attr = shift; |
102 | |
103 | $self->{'attributes'}{$attr->name} = $attr; |
104 | } |
105 | |
72b88a88 |
106 | sub compute_all_applicable_attributes { |
107 | my $self = shift; |
108 | my (@attr, %seen); |
109 | |
110 | for my $class ($self->linearized_isa) { |
111 | my $meta = $self->_metaclass_cache($class) |
112 | or next; |
113 | |
114 | for my $name (keys %{ $meta->get_attribute_map }) { |
115 | next if $seen{$name}++; |
116 | push @attr, $meta->get_attribute($name); |
117 | } |
118 | } |
119 | |
120 | return @attr; |
121 | } |
122 | |
c3398f5b |
123 | sub get_attribute_map { $_[0]->{attributes} } |
66eea168 |
124 | sub has_attribute { exists $_[0]->{attributes}->{$_[1]} } |
c3398f5b |
125 | sub get_attribute { $_[0]->{attributes}->{$_[1]} } |
126 | |
00ca1c62 |
127 | sub linearized_isa { @{ get_linear_isa($_[0]->name) } } |
c3398f5b |
128 | |
7a59f4e8 |
129 | sub clone_object { |
130 | my $class = shift; |
131 | my $instance = shift; |
132 | |
133 | (blessed($instance) && $instance->isa($class->name)) |
1a0f0802 |
134 | || confess "You must pass an instance of the metaclass (" . $class->name . "), not ($instance)"; |
7a59f4e8 |
135 | |
136 | $class->clone_instance($instance, @_); |
137 | } |
138 | |
139 | sub clone_instance { |
140 | my ($class, $instance, %params) = @_; |
141 | |
142 | (blessed($instance)) |
e42bee44 |
143 | || confess "You can only clone instances, ($instance) is not a blessed instance"; |
7a59f4e8 |
144 | |
145 | my $clone = bless { %$instance }, ref $instance; |
146 | |
147 | foreach my $attr ($class->compute_all_applicable_attributes()) { |
148 | if ( defined( my $init_arg = $attr->init_arg ) ) { |
149 | if (exists $params{$init_arg}) { |
150 | $clone->{ $attr->name } = $params{$init_arg}; |
151 | } |
152 | } |
153 | } |
154 | |
155 | return $clone; |
156 | |
157 | } |
158 | |
fc1d8369 |
159 | sub make_immutable { |
160 | my $self = shift; |
6a1d1835 |
161 | my %args = ( |
162 | inline_constructor => 1, |
163 | @_, |
164 | ); |
165 | |
fc1d8369 |
166 | my $name = $self->name; |
167 | $self->{is_immutable}++; |
c7a6403f |
168 | |
6a1d1835 |
169 | if ($args{inline_constructor}) { |
c7a6403f |
170 | $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self )); |
171 | } |
172 | |
8632b6fe |
173 | if ($args{inline_destructor}) { |
174 | $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self )); |
175 | } |
2276cb14 |
176 | |
177 | # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value |
178 | # at the end of a source file. |
179 | return 1; |
fc1d8369 |
180 | } |
ad958001 |
181 | |
182 | sub make_mutable { confess "Mouse does not currently support 'make_mutable'" } |
183 | |
fc1d8369 |
184 | sub is_immutable { $_[0]->{is_immutable} } |
84ef660f |
185 | |
186 | sub attribute_metaclass { "Mouse::Meta::Class" } |
7a59f4e8 |
187 | |
4859d490 |
188 | sub _install_modifier { |
189 | my ( $self, $into, $type, $name, $code ) = @_; |
fa9a3caa |
190 | if (eval "require Class::Method::Modifiers::Fast; 1") { |
191 | Class::Method::Modifiers::Fast::_install_modifier( |
4859d490 |
192 | $into, |
193 | $type, |
194 | $name, |
195 | $code |
196 | ); |
197 | } |
198 | else { |
199 | require Class::Method::Modifiers; |
200 | Class::Method::Modifiers::_install_modifier( |
201 | $into, |
202 | $type, |
203 | $name, |
204 | $code |
205 | ); |
206 | } |
207 | } |
208 | |
50dc6ee5 |
209 | sub add_before_method_modifier { |
4859d490 |
210 | my ( $self, $name, $code ) = @_; |
211 | $self->_install_modifier( $self->name, 'before', $name, $code ); |
50dc6ee5 |
212 | } |
213 | |
214 | sub add_around_method_modifier { |
4859d490 |
215 | my ( $self, $name, $code ) = @_; |
216 | $self->_install_modifier( $self->name, 'around', $name, $code ); |
50dc6ee5 |
217 | } |
218 | |
219 | sub add_after_method_modifier { |
4859d490 |
220 | my ( $self, $name, $code ) = @_; |
221 | $self->_install_modifier( $self->name, 'after', $name, $code ); |
50dc6ee5 |
222 | } |
223 | |
47f36c05 |
224 | sub roles { $_[0]->{roles} } |
225 | |
226 | sub does_role { |
227 | my ($self, $role_name) = @_; |
ad958001 |
228 | |
47f36c05 |
229 | (defined $role_name) |
230 | || confess "You must supply a role name to look for"; |
ad958001 |
231 | |
47f36c05 |
232 | for my $role (@{ $self->{roles} }) { |
233 | return 1 if $role->name eq $role_name; |
234 | } |
ad958001 |
235 | |
47f36c05 |
236 | return 0; |
237 | } |
238 | |
ae3edb8a |
239 | sub create { |
1a72f15c |
240 | my ($self, $package_name, %options) = @_; |
ae3edb8a |
241 | |
242 | (ref $options{superclasses} eq 'ARRAY') |
243 | || confess "You must pass an ARRAY ref of superclasses" |
244 | if exists $options{superclasses}; |
ad958001 |
245 | |
ae3edb8a |
246 | (ref $options{attributes} eq 'ARRAY') |
247 | || confess "You must pass an ARRAY ref of attributes" |
ad958001 |
248 | if exists $options{attributes}; |
249 | |
ae3edb8a |
250 | (ref $options{methods} eq 'HASH') |
251 | || confess "You must pass a HASH ref of methods" |
ad958001 |
252 | if exists $options{methods}; |
ae3edb8a |
253 | |
254 | do { |
ae3edb8a |
255 | ( defined $package_name && $package_name ) |
256 | || confess "You must pass a package name"; |
257 | |
258 | my $code = "package $package_name;"; |
259 | $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';" |
260 | if exists $options{version}; |
261 | $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';" |
262 | if exists $options{authority}; |
263 | |
264 | eval $code; |
265 | confess "creation of $package_name failed : $@" if $@; |
266 | }; |
267 | |
dd3c04d7 |
268 | my %initialize_options = %options; |
269 | delete @initialize_options{qw( |
ae3edb8a |
270 | package |
271 | superclasses |
272 | attributes |
273 | methods |
274 | version |
275 | authority |
276 | )}; |
dd3c04d7 |
277 | my $meta = $self->initialize( $package_name => %initialize_options ); |
ae3edb8a |
278 | |
279 | # FIXME totally lame |
280 | $meta->add_method('meta' => sub { |
1a72f15c |
281 | $self->initialize(ref($_[0]) || $_[0]); |
ae3edb8a |
282 | }); |
283 | |
284 | $meta->superclasses(@{$options{superclasses}}) |
285 | if exists $options{superclasses}; |
286 | # NOTE: |
287 | # process attributes first, so that they can |
288 | # install accessors, but locally defined methods |
289 | # can then overwrite them. It is maybe a little odd, but |
290 | # I think this should be the order of things. |
291 | if (exists $options{attributes}) { |
292 | foreach my $attr (@{$options{attributes}}) { |
293 | Mouse::Meta::Attribute->create($meta, $attr->{name}, %$attr); |
294 | } |
295 | } |
296 | if (exists $options{methods}) { |
297 | foreach my $method_name (keys %{$options{methods}}) { |
298 | $meta->add_method($method_name, $options{methods}->{$method_name}); |
299 | } |
300 | } |
301 | return $meta; |
302 | } |
303 | |
304 | { |
305 | my $ANON_CLASS_SERIAL = 0; |
306 | my $ANON_CLASS_PREFIX = 'Mouse::Meta::Class::__ANON__::SERIAL::'; |
307 | sub create_anon_class { |
308 | my ( $class, %options ) = @_; |
309 | my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL; |
310 | return $class->create( $package_name, %options ); |
311 | } |
312 | } |
313 | |
c3398f5b |
314 | 1; |
315 | |
316 | __END__ |
317 | |
318 | =head1 NAME |
319 | |
306290e8 |
320 | Mouse::Meta::Class - hook into the Mouse MOP |
c3398f5b |
321 | |
322 | =head1 METHODS |
323 | |
306290e8 |
324 | =head2 initialize ClassName -> Mouse::Meta::Class |
c3398f5b |
325 | |
306290e8 |
326 | Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only |
327 | one instance should exist for a given class. |
c3398f5b |
328 | |
306290e8 |
329 | =head2 new %args -> Mouse::Meta::Class |
c3398f5b |
330 | |
306290e8 |
331 | Creates a new Mouse::Meta::Class. Don't call this directly. |
c3398f5b |
332 | |
333 | =head2 name -> ClassName |
334 | |
335 | Returns the name of the owner class. |
336 | |
337 | =head2 superclasses -> [ClassName] |
338 | |
339 | Gets (or sets) the list of superclasses of the owner class. |
340 | |
306290e8 |
341 | =head2 add_attribute Mouse::Meta::Attribute |
c3398f5b |
342 | |
306290e8 |
343 | Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner |
344 | class. |
c3398f5b |
345 | |
72b88a88 |
346 | =head2 compute_all_applicable_attributes -> (Mouse::Meta::Attribute) |
347 | |
348 | Returns the list of all L<Mouse::Meta::Attribute> instances associated with |
349 | this class and its superclasses. |
350 | |
306290e8 |
351 | =head2 get_attribute_map -> { name => Mouse::Meta::Attribute } |
c3398f5b |
352 | |
353 | Returns a mapping of attribute names to their corresponding |
306290e8 |
354 | L<Mouse::Meta::Attribute> objects. |
c3398f5b |
355 | |
cbc437f2 |
356 | =head2 has_attribute Name -> Bool |
66eea168 |
357 | |
358 | Returns whether we have a L<Mouse::Meta::Attribute> with the given name. |
359 | |
306290e8 |
360 | =head2 get_attribute Name -> Mouse::Meta::Attribute | undef |
c3398f5b |
361 | |
306290e8 |
362 | Returns the L<Mouse::Meta::Attribute> with the given name. |
c3398f5b |
363 | |
364 | =head2 linearized_isa -> [ClassNames] |
365 | |
366 | Returns the list of classes in method dispatch order, with duplicates removed. |
367 | |
f7b11a21 |
368 | =head2 clone_object Instance -> Instance |
369 | |
370 | Clones the given C<Instance> which must be an instance governed by this |
371 | metaclass. |
372 | |
373 | =head2 clone_instance Instance, Parameters -> Instance |
374 | |
375 | Clones the given C<Instance> and sets any additional parameters. |
376 | |
c3398f5b |
377 | =cut |
378 | |