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