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