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
33 meta => [qw(does meta dump _MOUSE_VERBOSE)],
38 # aliases as public APIs
39 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
40 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
43 *class_of = \&Mouse::Meta::Module::class_of;
44 *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name;
45 *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
46 *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names;
49 # Moose::Util compatible utilities
52 return class_of( $_[0] );
56 my ($class_or_obj, $role_name) = @_;
58 my $meta = class_of($class_or_obj);
61 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
63 return defined($meta) && $meta->does_role($role_name);
68 if ($] >= 5.009_005) {
70 $impl = \&mro::get_linear_isa;
74 eval { require MRO::Compat };
78 $impl = \&mro::get_linear_isa;
80 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
81 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
82 $_get_linear_isa_dfs = sub {
85 my $classname = shift;
87 my @lin = ($classname);
89 foreach my $parent (@{"$classname\::ISA"}) {
90 my $plin = $_get_linear_isa_dfs->($parent);
91 foreach my $p(@$plin) {
92 next if exists $stored{$p};
99 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
100 $impl = $_get_linear_isa_dfs;
106 *get_linear_isa = $impl;
109 { # taken from Sub::Identify
110 sub get_code_info($) {
112 ref($coderef) or return;
114 my $cv = B::svref_2object($coderef);
115 $cv->isa('B::CV') or return;
118 $gv->isa('B::GV') or return;
120 return ($gv->STASH->NAME, $gv->NAME);
123 sub get_code_package{
126 my $cv = B::svref_2object($coderef);
127 $cv->isa('B::CV') or return '';
130 $gv->isa('B::GV') or return '';
132 return $gv->STASH->NAME;
136 # taken from Mouse::Util (0.90)
140 sub resolve_metaclass_alias {
141 my ( $type, $metaclass_name, %options ) = @_;
143 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
145 return $cache{$cache_key}{$metaclass_name} ||= do{
147 my $possible_full_name = join '::',
148 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
151 my $loaded_class = load_first_existing_class(
156 $loaded_class->can('register_implementation')
157 ? $loaded_class->register_implementation
163 # Utilities from Class::MOP
166 # taken from Class/MOP.pm
167 sub is_valid_class_name {
170 return 0 if ref($class);
171 return 0 unless defined($class);
173 return 1 if $class =~ /^\w+(?:::\w+)*$/;
178 # taken from Class/MOP.pm
179 sub load_first_existing_class {
184 for my $class (@classes) {
185 my $e = _try_load_one_class($class);
188 $exceptions{$class} = $e;
199 sprintf( "Could not load class (%s) because : %s",
200 $_, $exceptions{$_} )
205 # taken from Class/MOP.pm
206 my %is_class_loaded_cache;
207 sub _try_load_one_class {
210 unless ( is_valid_class_name($class) ) {
211 my $display = defined($class) ? $class : 'undef';
212 confess "Invalid class name ($display)";
215 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
217 my $file = $class . '.pm';
222 eval { require($file) };
230 my $e = _try_load_one_class($class);
231 confess "Could not load class ($class) because : $e" if $e;
237 sub is_class_loaded {
240 return 0 if ref($class) || !defined($class) || !length($class);
242 # walk the symbol table tree to avoid autovififying
243 # \*{${main::}{"Foo::"}} == \*main::Foo::
246 foreach my $part (split('::', $class)) {
247 my $entry = \$pack->{$part . '::'};
248 return 0 if ref($entry) ne 'GLOB';
249 $pack = *{$entry}{HASH} or return 0;
252 # check for $VERSION or @ISA
253 return 1 if exists $pack->{VERSION}
254 && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
255 return 1 if exists $pack->{ISA}
256 && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;
258 # check for any method
259 foreach my $name( keys %{$pack} ) {
260 my $entry = \$pack->{$name};
261 return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE};
269 sub apply_all_roles {
270 my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift);
274 # Basis of Data::OptList
275 my $max = scalar(@_);
276 for (my $i = 0; $i < $max ; $i++) {
277 if ($i + 1 < $max && ref($_[$i + 1])) {
278 push @roles, [ $_[$i] => $_[++$i] ];
280 push @roles, [ $_[$i] => undef ];
282 my $role_name = $roles[-1][0];
283 load_class($role_name);
284 my $metarole = get_metaclass_by_name($role_name);
285 ( $metarole && $metarole->isa('Mouse::Meta::Role') )
286 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
289 if ( scalar @roles == 1 ) {
290 my ( $role_name, $params ) = @{ $roles[0] };
291 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
294 Mouse::Meta::Role->combine(@roles)->apply($applicant);
299 # taken from Moose::Util 0.90
301 return $_[0] if @_ == 1;
305 return "$items[0] and $items[1]" if @items == 2;
307 my $tail = pop @items;
309 return join q{, }, @items, "and $tail";
318 $feature ||= ( caller(1) )[3]; # subroutine name
320 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
321 Carp::confess("Mouse does not currently support $feature");
324 # general meta() method
326 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
329 # general dump() method
331 my($self, $maxdepth) = @_;
333 require 'Data/Dumper.pm'; # we don't want to create its namespace
334 my $dd = Data::Dumper->new([$self]);
335 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
340 # general does() method
342 *does = \&does_role; # alias
350 Mouse::Util - Features, with or without their dependencies
352 =head1 IMPLEMENTATIONS FOR
360 =head3 C<resolve_metaclass_alias>
362 =head3 C<apply_all_roles>
364 =head3 C<english_list>
368 =head3 C<< is_class_loaded(ClassName) -> Bool >>
370 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
371 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
372 locally-defined method.
374 =head3 C<< load_class(ClassName) >>
376 This will load a given C<ClassName> (or die if it is not loadable).
377 This function can be used in place of tricks like
378 C<eval "use $module"> or using C<require>.
380 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
382 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
384 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
386 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
390 =head3 C<get_linear_isa>
394 =head3 C<get_code_info>
396 =head1 UTILITIES FOR MOUSE
398 =head3 C<not_supported>