2 use Mouse::Exporter; # enables strict and warnings
5 use Scalar::Util qw(blessed);
8 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
10 Mouse::Exporter->setup_import_methods(
14 resolve_metaclass_alias
32 default => [], # export no functions by default
34 # The ':meta' group is 'use metaclass' for Mouse
35 meta => [qw(does meta dump _MOUSE_VERBOSE)],
40 # aliases as public APIs
41 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
42 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
45 *class_of = \&Mouse::Meta::Module::class_of;
46 *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name;
47 *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
48 *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names;
51 # Moose::Util compatible utilities
54 return class_of( $_[0] );
58 my ($class_or_obj, $role_name) = @_;
60 my $meta = class_of($class_or_obj);
63 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
65 return defined($meta) && $meta->does_role($role_name);
70 if ($] >= 5.009_005) {
72 $impl = \&mro::get_linear_isa;
76 eval { require MRO::Compat };
80 $impl = \&mro::get_linear_isa;
82 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
83 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
84 $_get_linear_isa_dfs = sub {
87 my $classname = shift;
89 my @lin = ($classname);
91 foreach my $parent (@{"$classname\::ISA"}) {
92 my $plin = $_get_linear_isa_dfs->($parent);
93 foreach my $p(@$plin) {
94 next if exists $stored{$p};
101 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
102 $impl = $_get_linear_isa_dfs;
108 *get_linear_isa = $impl;
111 { # taken from Sub::Identify
112 sub get_code_info($) {
114 ref($coderef) or return;
116 my $cv = B::svref_2object($coderef);
117 $cv->isa('B::CV') or return;
120 $gv->isa('B::GV') or return;
122 return ($gv->STASH->NAME, $gv->NAME);
125 sub get_code_package{
128 my $cv = B::svref_2object($coderef);
129 $cv->isa('B::CV') or return '';
132 $gv->isa('B::GV') or return '';
134 return $gv->STASH->NAME;
138 # taken from Mouse::Util (0.90)
142 sub resolve_metaclass_alias {
143 my ( $type, $metaclass_name, %options ) = @_;
145 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
147 return $cache{$cache_key}{$metaclass_name} ||= do{
149 my $possible_full_name = join '::',
150 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
153 my $loaded_class = load_first_existing_class(
158 $loaded_class->can('register_implementation')
159 ? $loaded_class->register_implementation
165 # Utilities from Class::MOP
168 # taken from Class/MOP.pm
169 sub is_valid_class_name {
172 return 0 if ref($class);
173 return 0 unless defined($class);
175 return 1 if $class =~ /^\w+(?:::\w+)*$/;
180 # taken from Class/MOP.pm
181 sub load_first_existing_class {
186 for my $class (@classes) {
187 my $e = _try_load_one_class($class);
190 $exceptions{$class} = $e;
201 sprintf( "Could not load class (%s) because : %s",
202 $_, $exceptions{$_} )
207 # taken from Class/MOP.pm
208 my %is_class_loaded_cache;
209 sub _try_load_one_class {
212 unless ( is_valid_class_name($class) ) {
213 my $display = defined($class) ? $class : 'undef';
214 confess "Invalid class name ($display)";
217 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
219 my $file = $class . '.pm';
224 eval { require($file) };
232 my $e = _try_load_one_class($class);
233 confess "Could not load class ($class) because : $e" if $e;
239 sub is_class_loaded {
242 return 0 if ref($class) || !defined($class) || !length($class);
244 # walk the symbol table tree to avoid autovififying
245 # \*{${main::}{"Foo::"}} == \*main::Foo::
248 foreach my $part (split('::', $class)) {
249 my $entry = \$pack->{$part . '::'};
250 return 0 if ref($entry) ne 'GLOB';
251 $pack = *{$entry}{HASH} or return 0;
254 # check for $VERSION or @ISA
255 return 1 if exists $pack->{VERSION}
256 && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
257 return 1 if exists $pack->{ISA}
258 && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;
260 # check for any method
261 foreach my $name( keys %{$pack} ) {
262 my $entry = \$pack->{$name};
263 return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE};
271 sub apply_all_roles {
272 my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift);
276 # Basis of Data::OptList
277 my $max = scalar(@_);
278 for (my $i = 0; $i < $max ; $i++) {
279 if ($i + 1 < $max && ref($_[$i + 1])) {
280 push @roles, [ $_[$i] => $_[++$i] ];
282 push @roles, [ $_[$i] => undef ];
284 my $role_name = $roles[-1][0];
285 load_class($role_name);
287 my $metarole = get_metaclass_by_name($role_name);
288 ( $metarole && $metarole->isa('Mouse::Meta::Role') )
289 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
292 if ( scalar @roles == 1 ) {
293 my ( $role_name, $params ) = @{ $roles[0] };
294 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
297 Mouse::Meta::Role->combine(@roles)->apply($applicant);
302 # taken from Moose::Util 0.90
304 return $_[0] if @_ == 1;
308 return "$items[0] and $items[1]" if @items == 2;
310 my $tail = pop @items;
312 return join q{, }, @items, "and $tail";
321 $feature ||= ( caller(1) )[3]; # subroutine name
323 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
324 Carp::confess("Mouse does not currently support $feature");
327 # general meta() method
329 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
332 # general dump() method
334 my($self, $maxdepth) = @_;
336 require 'Data/Dumper.pm'; # we don't want to create its namespace
337 my $dd = Data::Dumper->new([$self]);
338 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
343 # general does() method
345 *does = \&does_role; # alias
353 Mouse::Util - Features, with or without their dependencies
355 =head1 IMPLEMENTATIONS FOR
363 =head3 C<resolve_metaclass_alias>
365 =head3 C<apply_all_roles>
367 =head3 C<english_list>
371 =head3 C<< is_class_loaded(ClassName) -> Bool >>
373 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
374 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
375 locally-defined method.
377 =head3 C<< load_class(ClassName) >>
379 This will load a given C<ClassName> (or die if it is not loadable).
380 This function can be used in place of tricks like
381 C<eval "use $module"> or using C<require>.
383 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
385 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
387 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
389 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
393 =head3 C<get_linear_isa>
397 =head3 C<get_code_info>
399 =head1 UTILITIES FOR MOUSE
401 =head3 C<not_supported>