Commit | Line | Data |
4093c859 |
1 | package Mouse::Util; |
bc69ee88 |
2 | use Mouse::Exporter; # enables strict and warnings |
6d28c5cf |
3 | |
ba153b33 |
4 | sub get_linear_isa($;$); # must be here |
5 | |
df6dd016 |
6 | BEGIN{ |
8aba926d |
7 | # This is used in Mouse::PurePerl |
8 | Mouse::Exporter->setup_import_methods( |
9 | as_is => [qw( |
10 | find_meta |
11 | does_role |
12 | resolve_metaclass_alias |
13 | apply_all_roles |
14 | english_list |
15 | |
16 | load_class |
17 | is_class_loaded |
18 | |
19 | get_linear_isa |
20 | get_code_info |
21 | |
22 | get_code_package |
23 | get_code_ref |
24 | |
25 | not_supported |
26 | |
27 | does meta dump |
28 | )], |
29 | groups => { |
30 | default => [], # export no functions by default |
31 | |
32 | # The ':meta' group is 'use metaclass' for Mouse |
33 | meta => [qw(does meta dump)], |
34 | }, |
35 | ); |
36 | |
37 | |
df6dd016 |
38 | # Because Mouse::Util is loaded first in all the Mouse sub-modules, |
39 | # XS loader is placed here, not in Mouse.pm. |
40 | |
8aba926d |
41 | our $VERSION = '0.40_07'; |
df6dd016 |
42 | |
db5e4409 |
43 | my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL}); |
df6dd016 |
44 | |
db5e4409 |
45 | if($xs){ |
df6dd016 |
46 | local $@; |
34bdc46a |
47 | |
48 | # XXX: XSLoader tries to get the object path from caller's file name |
49 | # $hack_mouse_file fools its mechanism |
50 | |
51 | (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm |
db5e4409 |
52 | $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{ |
df6dd016 |
53 | require XSLoader; |
54 | XSLoader::load('Mouse', $VERSION); |
55 | }; |
1a6d349c |
56 | #warn $@ if $@; |
df6dd016 |
57 | } |
58 | |
db5e4409 |
59 | if(!$xs){ |
df6dd016 |
60 | require 'Mouse/PurePerl.pm'; # we don't want to create its namespace |
61 | } |
db5e4409 |
62 | |
63 | *_MOUSE_XS = sub(){ $xs }; |
df6dd016 |
64 | } |
65 | |
66 | |
5dd5edef |
67 | use Carp (); |
68 | use Scalar::Util (); |
4093c859 |
69 | |
04493075 |
70 | use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE}; |
71 | |
739525d0 |
72 | # aliases as public APIs |
deb9a0f3 |
73 | # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util |
7727a2f0 |
74 | require Mouse::Meta::Module; # for the entities of metaclass cache utilities |
75 | |
76 | BEGIN { |
542f20ad |
77 | *class_of = \&Mouse::Meta::Module::_class_of; |
78 | *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name; |
79 | *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances; |
80 | *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names; |
f48920c1 |
81 | |
82 | # is-a predicates |
e3540312 |
83 | generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint'); |
84 | generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass'); |
85 | generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole'); |
739525d0 |
86 | } |
87 | |
f48920c1 |
88 | |
08f7a8db |
89 | # Moose::Util compatible utilities |
90 | |
91 | sub find_meta{ |
739525d0 |
92 | return class_of( $_[0] ); |
08f7a8db |
93 | } |
94 | |
95 | sub does_role{ |
53875581 |
96 | my ($class_or_obj, $role_name) = @_; |
8e64d0fa |
97 | |
739525d0 |
98 | my $meta = class_of($class_or_obj); |
8e64d0fa |
99 | |
53875581 |
100 | (defined $role_name) |
101 | || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()"); |
102 | |
103 | return defined($meta) && $meta->does_role($role_name); |
08f7a8db |
104 | } |
105 | |
42d7df00 |
106 | BEGIN { |
f15868c3 |
107 | my $get_linear_isa; |
bcd39bf4 |
108 | if ($] >= 5.009_005) { |
388b8ebd |
109 | require mro; |
f15868c3 |
110 | $get_linear_isa = \&mro::get_linear_isa; |
272a1930 |
111 | } else { |
e0396a57 |
112 | my $e = do { |
113 | local $@; |
114 | eval { require MRO::Compat }; |
115 | $@; |
f172d4e7 |
116 | }; |
e0396a57 |
117 | if (!$e) { |
f15868c3 |
118 | $get_linear_isa = \&mro::get_linear_isa; |
272a1930 |
119 | } else { |
120 | # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV |
e0396a57 |
121 | my $_get_linear_isa_dfs; # this recurses so it isn't pretty |
ba153b33 |
122 | $_get_linear_isa_dfs = sub ($;$){ |
272a1930 |
123 | no strict 'refs'; |
124 | |
125 | my $classname = shift; |
126 | |
127 | my @lin = ($classname); |
128 | my %stored; |
129 | foreach my $parent (@{"$classname\::ISA"}) { |
e0396a57 |
130 | my $plin = $_get_linear_isa_dfs->($parent); |
131 | foreach my $p(@$plin) { |
132 | next if exists $stored{$p}; |
133 | push(@lin, $p); |
134 | $stored{$p} = 1; |
272a1930 |
135 | } |
136 | } |
137 | return \@lin; |
138 | }; |
139 | # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^ |
f15868c3 |
140 | $get_linear_isa = $_get_linear_isa_dfs; |
eae80759 |
141 | } |
142 | } |
bcd39bf4 |
143 | |
f15868c3 |
144 | *get_linear_isa = $get_linear_isa; |
eae80759 |
145 | } |
146 | |
3a63a2e7 |
147 | |
08f7a8db |
148 | # taken from Mouse::Util (0.90) |
abfdffe0 |
149 | { |
150 | my %cache; |
151 | |
8e64d0fa |
152 | sub resolve_metaclass_alias { |
153 | my ( $type, $metaclass_name, %options ) = @_; |
154 | |
155 | my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' ); |
156 | |
157 | return $cache{$cache_key}{$metaclass_name} ||= do{ |
abfdffe0 |
158 | |
08f7a8db |
159 | my $possible_full_name = join '::', |
160 | 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name |
161 | ; |
162 | |
8e64d0fa |
163 | my $loaded_class = load_first_existing_class( |
164 | $possible_full_name, |
165 | $metaclass_name |
166 | ); |
167 | |
168 | $loaded_class->can('register_implementation') |
169 | ? $loaded_class->register_implementation |
08f7a8db |
170 | : $loaded_class; |
8e64d0fa |
171 | }; |
abfdffe0 |
172 | } |
173 | } |
174 | |
739525d0 |
175 | # Utilities from Class::MOP |
176 | |
df6dd016 |
177 | sub get_code_info; |
178 | sub get_code_package; |
739525d0 |
179 | |
abfdffe0 |
180 | # taken from Class/MOP.pm |
a81cc7b8 |
181 | sub is_valid_class_name { |
abfdffe0 |
182 | my $class = shift; |
183 | |
184 | return 0 if ref($class); |
185 | return 0 unless defined($class); |
abfdffe0 |
186 | |
ba153b33 |
187 | return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms; |
abfdffe0 |
188 | |
189 | return 0; |
190 | } |
191 | |
192 | # taken from Class/MOP.pm |
193 | sub load_first_existing_class { |
194 | my @classes = @_ |
195 | or return; |
196 | |
23264b5b |
197 | my %exceptions; |
198 | for my $class (@classes) { |
abfdffe0 |
199 | my $e = _try_load_one_class($class); |
200 | |
201 | if ($e) { |
202 | $exceptions{$class} = $e; |
203 | } |
204 | else { |
53875581 |
205 | return $class; |
abfdffe0 |
206 | } |
207 | } |
abfdffe0 |
208 | |
53875581 |
209 | # not found |
5dd5edef |
210 | Carp::confess join( |
abfdffe0 |
211 | "\n", |
212 | map { |
213 | sprintf( "Could not load class (%s) because : %s", |
214 | $_, $exceptions{$_} ) |
215 | } @classes |
216 | ); |
217 | } |
218 | |
219 | # taken from Class/MOP.pm |
3aac966d |
220 | my %is_class_loaded_cache; |
abfdffe0 |
221 | sub _try_load_one_class { |
222 | my $class = shift; |
223 | |
6cfa1e5e |
224 | unless ( is_valid_class_name($class) ) { |
225 | my $display = defined($class) ? $class : 'undef'; |
5dd5edef |
226 | Carp::confess "Invalid class name ($display)"; |
6cfa1e5e |
227 | } |
228 | |
3aac966d |
229 | return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class); |
abfdffe0 |
230 | |
231 | my $file = $class . '.pm'; |
232 | $file =~ s{::}{/}g; |
233 | |
234 | return do { |
235 | local $@; |
236 | eval { require($file) }; |
237 | $@; |
238 | }; |
239 | } |
240 | |
6cfa1e5e |
241 | |
242 | sub load_class { |
243 | my $class = shift; |
244 | my $e = _try_load_one_class($class); |
5dd5edef |
245 | Carp::confess "Could not load class ($class) because : $e" if $e; |
6cfa1e5e |
246 | |
247 | return 1; |
248 | } |
249 | |
df6dd016 |
250 | sub is_class_loaded; |
6cfa1e5e |
251 | |
252 | |
2e92bb89 |
253 | sub apply_all_roles { |
5dd5edef |
254 | my $applicant = Scalar::Util::blessed($_[0]) |
255 | ? shift # instance |
256 | : Mouse::Meta::Class->initialize(shift); # class or role name |
2e92bb89 |
257 | |
21498b08 |
258 | my @roles; |
f6715552 |
259 | |
260 | # Basis of Data::OptList |
21498b08 |
261 | my $max = scalar(@_); |
262 | for (my $i = 0; $i < $max ; $i++) { |
263 | if ($i + 1 < $max && ref($_[$i + 1])) { |
b1980b86 |
264 | push @roles, [ $_[$i] => $_[++$i] ]; |
21498b08 |
265 | } else { |
b1980b86 |
266 | push @roles, [ $_[$i] => undef ]; |
21498b08 |
267 | } |
ff687069 |
268 | my $role_name = $roles[-1][0]; |
269 | load_class($role_name); |
0126c27c |
270 | |
f48920c1 |
271 | is_a_metarole( get_metaclass_by_name($role_name) ) |
71e7b544 |
272 | || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role"); |
21498b08 |
273 | } |
274 | |
21498b08 |
275 | if ( scalar @roles == 1 ) { |
b1980b86 |
276 | my ( $role_name, $params ) = @{ $roles[0] }; |
277 | get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () ); |
21498b08 |
278 | } |
279 | else { |
71e7b544 |
280 | Mouse::Meta::Role->combine(@roles)->apply($applicant); |
21498b08 |
281 | } |
23264b5b |
282 | return; |
2e92bb89 |
283 | } |
284 | |
2e33bb59 |
285 | # taken from Moose::Util 0.90 |
286 | sub english_list { |
8e64d0fa |
287 | return $_[0] if @_ == 1; |
288 | |
289 | my @items = sort @_; |
290 | |
291 | return "$items[0] and $items[1]" if @items == 2; |
292 | |
293 | my $tail = pop @items; |
294 | |
295 | return join q{, }, @items, "and $tail"; |
2e33bb59 |
296 | } |
297 | |
53875581 |
298 | |
299 | # common utilities |
300 | |
fce211ae |
301 | sub not_supported{ |
302 | my($feature) = @_; |
303 | |
304 | $feature ||= ( caller(1) )[3]; # subroutine name |
305 | |
1b9e472d |
306 | local $Carp::CarpLevel = $Carp::CarpLevel + 1; |
307 | Carp::confess("Mouse does not currently support $feature"); |
fce211ae |
308 | } |
309 | |
fc8628e3 |
310 | # general meta() method |
311 | sub meta :method{ |
152e5759 |
312 | return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]); |
53875581 |
313 | } |
314 | |
fc8628e3 |
315 | # general dump() method |
316 | sub dump :method { |
53875581 |
317 | my($self, $maxdepth) = @_; |
318 | |
319 | require 'Data/Dumper.pm'; # we don't want to create its namespace |
320 | my $dd = Data::Dumper->new([$self]); |
321 | $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2); |
322 | $dd->Indent(1); |
323 | return $dd->Dump(); |
324 | } |
325 | |
fc8628e3 |
326 | # general does() method |
53875581 |
327 | sub does :method; |
328 | *does = \&does_role; # alias |
329 | |
4093c859 |
330 | 1; |
331 | |
f38ce2d0 |
332 | __END__ |
333 | |
334 | =head1 NAME |
335 | |
bedd575c |
336 | Mouse::Util - Features, with or without their dependencies |
f38ce2d0 |
337 | |
a25ca8d6 |
338 | =head1 VERSION |
339 | |
8aba926d |
340 | This document describes Mouse version 0.40_07 |
a25ca8d6 |
341 | |
f38ce2d0 |
342 | =head1 IMPLEMENTATIONS FOR |
343 | |
ea249879 |
344 | =head2 Moose::Util |
345 | |
346 | =head3 C<find_meta> |
347 | |
348 | =head3 C<does_role> |
349 | |
350 | =head3 C<resolve_metaclass_alias> |
351 | |
352 | =head3 C<apply_all_roles> |
353 | |
354 | =head3 C<english_list> |
355 | |
356 | =head2 Class::MOP |
357 | |
5bacd9bf |
358 | =head3 C<< is_class_loaded(ClassName) -> Bool >> |
ea249879 |
359 | |
1820fffe |
360 | Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which |
361 | involves checking for the existence of C<$VERSION>, C<@ISA>, and any |
362 | locally-defined method. |
363 | |
364 | =head3 C<< load_class(ClassName) >> |
365 | |
739525d0 |
366 | This will load a given C<ClassName> (or die if it is not loadable). |
1820fffe |
367 | This function can be used in place of tricks like |
368 | C<eval "use $module"> or using C<require>. |
ea249879 |
369 | |
5164490d |
370 | =head3 C<< Mouse::Util::class_of(ClassName or Object) >> |
739525d0 |
371 | |
5164490d |
372 | =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >> |
739525d0 |
373 | |
5164490d |
374 | =head3 C<< Mouse::Util::get_all_metaclass_instances() >> |
739525d0 |
375 | |
5164490d |
376 | =head3 C<< Mouse::Util::get_all_metaclass_names() >> |
739525d0 |
377 | |
ea249879 |
378 | =head2 MRO::Compat |
379 | |
380 | =head3 C<get_linear_isa> |
381 | |
382 | =head2 Sub::Identify |
383 | |
384 | =head3 C<get_code_info> |
385 | |
386 | =head1 UTILITIES FOR MOUSE |
387 | |
bedd575c |
388 | =head3 C<not_supported> |
f38ce2d0 |
389 | |
1820fffe |
390 | =head1 SEE ALSO |
391 | |
392 | L<Moose::Util> |
393 | |
5164490d |
394 | L<Class::MOP> |
1820fffe |
395 | |
396 | L<Sub::Identify> |
397 | |
398 | L<MRO::Compat> |
399 | |
f38ce2d0 |
400 | =cut |
401 | |