Commit | Line | Data |
306290e8 |
1 | package Mouse::Meta::Class; |
c3398f5b |
2 | use strict; |
3 | use warnings; |
4 | |
cecfb973 |
5 | use Scalar::Util qw/blessed weaken/; |
6d28c5cf |
6 | |
fce211ae |
7 | use Mouse::Util qw/get_linear_isa not_supported/; |
72b88a88 |
8 | |
6d28c5cf |
9 | use Mouse::Meta::Method::Constructor; |
10 | use Mouse::Meta::Method::Destructor; |
11 | use Mouse::Meta::Module; |
12 | |
3a63a2e7 |
13 | use base qw(Mouse::Meta::Module); |
14 | |
6cfa1e5e |
15 | sub method_metaclass(){ 'Mouse::Meta::Method' } # required for get_method() |
3a63a2e7 |
16 | |
8e64d0fa |
17 | sub _construct_meta { |
88ed7189 |
18 | my($class, %args) = @_; |
c3398f5b |
19 | |
8536d351 |
20 | $args{attributes} ||= {}; |
21 | $args{methods} ||= {}; |
22 | $args{roles} ||= []; |
23 | |
c3398f5b |
24 | $args{superclasses} = do { |
25 | no strict 'refs'; |
88ed7189 |
26 | \@{ $args{package} . '::ISA' }; |
c3398f5b |
27 | }; |
28 | |
7a50b450 |
29 | #return Mouse::Meta::Class->initialize($class)->new_object(%args) |
30 | # if $class ne __PACKAGE__; |
31 | |
8e64d0fa |
32 | return bless \%args, ref($class) || $class; |
7a50b450 |
33 | } |
34 | |
35 | sub create_anon_class{ |
36 | my $self = shift; |
37 | return $self->create(undef, @_); |
38 | } |
39 | |
40 | sub is_anon_class{ |
41 | return exists $_[0]->{anon_serial_id}; |
c3398f5b |
42 | } |
43 | |
afc73948 |
44 | sub roles { $_[0]->{roles} } |
c3398f5b |
45 | |
46 | sub superclasses { |
47 | my $self = shift; |
48 | |
49 | if (@_) { |
50 | Mouse::load_class($_) for @_; |
51 | @{ $self->{superclasses} } = @_; |
52 | } |
53 | |
8e64d0fa |
54 | return @{ $self->{superclasses} }; |
55 | } |
56 | |
57 | sub find_method_by_name{ |
58 | my($self, $method_name) = @_; |
59 | defined($method_name) |
60 | or $self->throw_error('You must define a method name to find'); |
61 | foreach my $class( $self->linearized_isa ){ |
62 | my $method = $self->initialize($class)->get_method($method_name); |
63 | return $method if defined $method; |
64 | } |
65 | return undef; |
66 | } |
67 | |
68 | sub get_all_methods { |
69 | my($self) = @_; |
70 | return map{ $self->find_method_by_name($self) } $self->get_all_method_names; |
c3398f5b |
71 | } |
72 | |
60cfc6ad |
73 | sub get_all_method_names { |
74 | my $self = shift; |
75 | my %uniq; |
76 | return grep { $uniq{$_}++ == 0 } |
3a63a2e7 |
77 | map { Mouse::Meta::Class->initialize($_)->get_method_list() } |
60cfc6ad |
78 | $self->linearized_isa; |
79 | } |
80 | |
c3398f5b |
81 | sub add_attribute { |
82 | my $self = shift; |
c3398f5b |
83 | |
60f6eba9 |
84 | if (@_ == 1 && blessed($_[0])) { |
85 | my $attr = shift @_; |
86 | $self->{'attributes'}{$attr->name} = $attr; |
7a50b450 |
87 | } |
88 | else { |
60f6eba9 |
89 | my $names = shift @_; |
90 | $names = [$names] if !ref($names); |
91 | my $metaclass = 'Mouse::Meta::Attribute'; |
7a50b450 |
92 | my %options = (@_ == 1 ? %{$_[0]} : @_); |
60f6eba9 |
93 | |
94 | if ( my $metaclass_name = delete $options{metaclass} ) { |
95 | my $new_class = Mouse::Util::resolve_metaclass_alias( |
96 | 'Attribute', |
97 | $metaclass_name |
98 | ); |
99 | if ( $metaclass ne $new_class ) { |
100 | $metaclass = $new_class; |
101 | } |
102 | } |
103 | |
104 | for my $name (@$names) { |
105 | if ($name =~ s/^\+//) { |
7a50b450 |
106 | $metaclass->clone_parent($self, $name, %options); |
60f6eba9 |
107 | } |
108 | else { |
7a50b450 |
109 | $metaclass->create($self, $name, %options); |
60f6eba9 |
110 | } |
111 | } |
112 | } |
c3398f5b |
113 | } |
114 | |
d60824af |
115 | sub compute_all_applicable_attributes { shift->get_all_attributes(@_) } |
116 | sub get_all_attributes { |
72b88a88 |
117 | my $self = shift; |
118 | my (@attr, %seen); |
119 | |
120 | for my $class ($self->linearized_isa) { |
121 | my $meta = $self->_metaclass_cache($class) |
122 | or next; |
123 | |
124 | for my $name (keys %{ $meta->get_attribute_map }) { |
125 | next if $seen{$name}++; |
126 | push @attr, $meta->get_attribute($name); |
127 | } |
128 | } |
129 | |
130 | return @attr; |
131 | } |
132 | |
8536d351 |
133 | sub linearized_isa { @{ get_linear_isa($_[0]->name) } } |
134 | |
135 | sub new_object { |
c68b4110 |
136 | my $self = shift; |
7a50b450 |
137 | my %args = (@_ == 1 ? %{$_[0]} : @_); |
c3398f5b |
138 | |
fce211ae |
139 | my $instance = bless {}, $self->name; |
140 | |
53c495ce |
141 | my @triggers_queue; |
142 | |
fce211ae |
143 | foreach my $attribute ($self->get_all_attributes) { |
8536d351 |
144 | my $from = $attribute->init_arg; |
145 | my $key = $attribute->name; |
146 | |
7a50b450 |
147 | if (defined($from) && exists($args{$from})) { |
148 | $args{$from} = $attribute->coerce_constraint($args{$from}) |
8536d351 |
149 | if $attribute->should_coerce; |
7a50b450 |
150 | $attribute->verify_against_type_constraint($args{$from}); |
8536d351 |
151 | |
7a50b450 |
152 | $instance->{$key} = $args{$from}; |
8536d351 |
153 | |
154 | weaken($instance->{$key}) |
fce211ae |
155 | if ref($instance->{$key}) && $attribute->is_weak_ref; |
8536d351 |
156 | |
157 | if ($attribute->has_trigger) { |
53c495ce |
158 | push @triggers_queue, [ $attribute->trigger, $args{$from} ]; |
8536d351 |
159 | } |
160 | } |
161 | else { |
162 | if ($attribute->has_default || $attribute->has_builder) { |
163 | unless ($attribute->is_lazy) { |
164 | my $default = $attribute->default; |
165 | my $builder = $attribute->builder; |
166 | my $value = $attribute->has_builder |
167 | ? $instance->$builder |
168 | : ref($default) eq 'CODE' |
169 | ? $default->($instance) |
170 | : $default; |
171 | |
172 | $value = $attribute->coerce_constraint($value) |
173 | if $attribute->should_coerce; |
174 | $attribute->verify_against_type_constraint($value); |
175 | |
176 | $instance->{$key} = $value; |
177 | |
178 | weaken($instance->{$key}) |
fce211ae |
179 | if ref($instance->{$key}) && $attribute->is_weak_ref; |
8536d351 |
180 | } |
181 | } |
182 | else { |
183 | if ($attribute->is_required) { |
fce211ae |
184 | $self->throw_error("Attribute (".$attribute->name.") is required"); |
8536d351 |
185 | } |
186 | } |
187 | } |
188 | } |
53c495ce |
189 | |
190 | foreach my $trigger_and_value(@triggers_queue){ |
191 | my($trigger, $value) = @{$trigger_and_value}; |
192 | $trigger->($instance, $value); |
193 | } |
194 | |
8536d351 |
195 | return $instance; |
196 | } |
c3398f5b |
197 | |
7a59f4e8 |
198 | sub clone_object { |
199 | my $class = shift; |
200 | my $instance = shift; |
201 | |
202 | (blessed($instance) && $instance->isa($class->name)) |
fce211ae |
203 | || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($instance)"); |
7a59f4e8 |
204 | |
205 | $class->clone_instance($instance, @_); |
206 | } |
207 | |
208 | sub clone_instance { |
209 | my ($class, $instance, %params) = @_; |
210 | |
211 | (blessed($instance)) |
fce211ae |
212 | || $class->throw_error("You can only clone instances, ($instance) is not a blessed instance"); |
7a59f4e8 |
213 | |
214 | my $clone = bless { %$instance }, ref $instance; |
215 | |
d60824af |
216 | foreach my $attr ($class->get_all_attributes()) { |
7a59f4e8 |
217 | if ( defined( my $init_arg = $attr->init_arg ) ) { |
218 | if (exists $params{$init_arg}) { |
219 | $clone->{ $attr->name } = $params{$init_arg}; |
220 | } |
221 | } |
222 | } |
223 | |
224 | return $clone; |
225 | |
226 | } |
227 | |
fc1d8369 |
228 | sub make_immutable { |
229 | my $self = shift; |
6a1d1835 |
230 | my %args = ( |
231 | inline_constructor => 1, |
e578d610 |
232 | inline_destructor => 1, |
6a1d1835 |
233 | @_, |
234 | ); |
235 | |
fc1d8369 |
236 | $self->{is_immutable}++; |
c7a6403f |
237 | |
6a1d1835 |
238 | if ($args{inline_constructor}) { |
c7a6403f |
239 | $self->add_method('new' => Mouse::Meta::Method::Constructor->generate_constructor_method_inline( $self )); |
240 | } |
241 | |
8632b6fe |
242 | if ($args{inline_destructor}) { |
243 | $self->add_method('DESTROY' => Mouse::Meta::Method::Destructor->generate_destructor_method_inline( $self )); |
244 | } |
2276cb14 |
245 | |
246 | # Moose's make_immutable returns true allowing calling code to skip setting an explicit true value |
247 | # at the end of a source file. |
248 | return 1; |
fc1d8369 |
249 | } |
ad958001 |
250 | |
fce211ae |
251 | sub make_mutable { not_supported } |
ad958001 |
252 | |
6cfa1e5e |
253 | sub is_immutable { $_[0]->{is_immutable} } |
254 | sub is_mutable { !$_[0]->{is_immutable} } |
84ef660f |
255 | |
4859d490 |
256 | sub _install_modifier { |
257 | my ( $self, $into, $type, $name, $code ) = @_; |
4f5b44a0 |
258 | |
259 | # which is modifer class available? |
260 | my $modifier_class = do { |
261 | if (eval "require Class::Method::Modifiers::Fast; 1") { |
262 | 'Class::Method::Modifiers::Fast'; |
263 | } elsif (eval "require Class::Method::Modifiers; 1") { |
264 | 'Class::Method::Modifiers'; |
265 | } else { |
266 | Carp::croak("Method modifiers require the use of Class::Method::Modifiers or Class::Method::Modifiers::Fast. Please install it from CPAN and file a bug report with this application."); |
267 | } |
268 | }; |
269 | my $modifier = $modifier_class->can('_install_modifier'); |
270 | |
271 | # replace this method itself :) |
272 | { |
4f5b44a0 |
273 | no warnings 'redefine'; |
4f9945f5 |
274 | *_install_modifier = sub { |
4f5b44a0 |
275 | my ( $self, $into, $type, $name, $code ) = @_; |
276 | $modifier->( |
277 | $into, |
278 | $type, |
279 | $name, |
280 | $code |
281 | ); |
6cfa1e5e |
282 | $self->{methods}{$name}++; # register it to the method map |
283 | return; |
4f5b44a0 |
284 | }; |
1b79a118 |
285 | } |
4f5b44a0 |
286 | |
287 | # call me. for first time. |
288 | $self->_install_modifier( $into, $type, $name, $code ); |
4859d490 |
289 | } |
290 | |
50dc6ee5 |
291 | sub add_before_method_modifier { |
4859d490 |
292 | my ( $self, $name, $code ) = @_; |
293 | $self->_install_modifier( $self->name, 'before', $name, $code ); |
50dc6ee5 |
294 | } |
295 | |
296 | sub add_around_method_modifier { |
4859d490 |
297 | my ( $self, $name, $code ) = @_; |
298 | $self->_install_modifier( $self->name, 'around', $name, $code ); |
50dc6ee5 |
299 | } |
300 | |
301 | sub add_after_method_modifier { |
4859d490 |
302 | my ( $self, $name, $code ) = @_; |
303 | $self->_install_modifier( $self->name, 'after', $name, $code ); |
50dc6ee5 |
304 | } |
305 | |
67199842 |
306 | sub add_override_method_modifier { |
307 | my ($self, $name, $code) = @_; |
308 | |
6cfa1e5e |
309 | my $package = $self->name; |
67199842 |
310 | |
6cfa1e5e |
311 | my $body = $package->can($name) |
312 | or $self->throw_error("You cannot override '$name' because it has no super method"); |
67199842 |
313 | |
6cfa1e5e |
314 | $self->add_method($name => sub { $code->($package, $body, @_) }); |
67199842 |
315 | } |
316 | |
47f36c05 |
317 | sub does_role { |
318 | my ($self, $role_name) = @_; |
ad958001 |
319 | |
47f36c05 |
320 | (defined $role_name) |
fce211ae |
321 | || $self->throw_error("You must supply a role name to look for"); |
ad958001 |
322 | |
f7fec86c |
323 | for my $class ($self->linearized_isa) { |
08f7a8db |
324 | my $meta = Mouse::Meta::Module::class_of($class); |
3a63a2e7 |
325 | next unless $meta && $meta->can('roles'); |
326 | |
327 | for my $role (@{ $meta->roles }) { |
ff687069 |
328 | |
3a63a2e7 |
329 | return 1 if $role->does_role($role_name); |
f7fec86c |
330 | } |
47f36c05 |
331 | } |
ad958001 |
332 | |
47f36c05 |
333 | return 0; |
334 | } |
335 | |
c3398f5b |
336 | 1; |
337 | |
338 | __END__ |
339 | |
340 | =head1 NAME |
341 | |
306290e8 |
342 | Mouse::Meta::Class - hook into the Mouse MOP |
c3398f5b |
343 | |
344 | =head1 METHODS |
345 | |
306290e8 |
346 | =head2 initialize ClassName -> Mouse::Meta::Class |
c3398f5b |
347 | |
306290e8 |
348 | Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only |
349 | one instance should exist for a given class. |
c3398f5b |
350 | |
306290e8 |
351 | =head2 new %args -> Mouse::Meta::Class |
c3398f5b |
352 | |
306290e8 |
353 | Creates a new Mouse::Meta::Class. Don't call this directly. |
c3398f5b |
354 | |
355 | =head2 name -> ClassName |
356 | |
357 | Returns the name of the owner class. |
358 | |
359 | =head2 superclasses -> [ClassName] |
360 | |
361 | Gets (or sets) the list of superclasses of the owner class. |
362 | |
60f6eba9 |
363 | =head2 add_attribute (Mouse::Meta::Attribute| name => spec) |
c3398f5b |
364 | |
306290e8 |
365 | Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner |
366 | class. |
c3398f5b |
367 | |
d60824af |
368 | =head2 get_all_attributes -> (Mouse::Meta::Attribute) |
72b88a88 |
369 | |
370 | Returns the list of all L<Mouse::Meta::Attribute> instances associated with |
371 | this class and its superclasses. |
372 | |
306290e8 |
373 | =head2 get_attribute_map -> { name => Mouse::Meta::Attribute } |
c3398f5b |
374 | |
375 | Returns a mapping of attribute names to their corresponding |
306290e8 |
376 | L<Mouse::Meta::Attribute> objects. |
c3398f5b |
377 | |
c68b4110 |
378 | =head2 get_attribute_list -> { name => Mouse::Meta::Attribute } |
379 | |
380 | This returns a list of attribute names which are defined in the local |
381 | class. If you want a list of all applicable attributes for a class, |
d60824af |
382 | use the C<get_all_attributes> method. |
c68b4110 |
383 | |
cbc437f2 |
384 | =head2 has_attribute Name -> Bool |
66eea168 |
385 | |
386 | Returns whether we have a L<Mouse::Meta::Attribute> with the given name. |
387 | |
306290e8 |
388 | =head2 get_attribute Name -> Mouse::Meta::Attribute | undef |
c3398f5b |
389 | |
306290e8 |
390 | Returns the L<Mouse::Meta::Attribute> with the given name. |
c3398f5b |
391 | |
392 | =head2 linearized_isa -> [ClassNames] |
393 | |
394 | Returns the list of classes in method dispatch order, with duplicates removed. |
395 | |
f7b11a21 |
396 | =head2 clone_object Instance -> Instance |
397 | |
398 | Clones the given C<Instance> which must be an instance governed by this |
399 | metaclass. |
400 | |
401 | =head2 clone_instance Instance, Parameters -> Instance |
402 | |
518e303a |
403 | The clone_instance method has been made private. |
404 | The public version is deprecated. |
f7b11a21 |
405 | |
c3398f5b |
406 | =cut |
407 | |