2 use Mouse::Exporter; # enables strict and warnings
5 # Because Mouse::Util is loaded first in all the Mouse sub-modules,
6 # XS loader is placed here, not in Mouse.pm.
8 our $VERSION = '0.40_01';
10 my $need_pp = !!$ENV{MOUSE_PUREPERL};
12 if(!$need_pp && !exists $INC{'Mouse/PurePerl.pm'}){
15 # XXX: XSLoader tries to get the object path from caller's file name
16 # $hack_mouse_file fools its mechanism
18 (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm
19 print "$hack_mouse_file\n";
20 $need_pp = !eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
22 XSLoader::load('Mouse', $VERSION);
28 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
34 use Scalar::Util qw(blessed);
36 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
38 Mouse::Exporter->setup_import_methods(
42 resolve_metaclass_alias
61 default => [], # export no functions by default
63 # The ':meta' group is 'use metaclass' for Mouse
64 meta => [qw(does meta dump _MOUSE_VERBOSE)],
68 # aliases as public APIs
69 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
70 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
73 *class_of = \&Mouse::Meta::Module::class_of;
74 *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name;
75 *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
76 *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names;
79 # Moose::Util compatible utilities
82 return class_of( $_[0] );
86 my ($class_or_obj, $role_name) = @_;
88 my $meta = class_of($class_or_obj);
91 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
93 return defined($meta) && $meta->does_role($role_name);
98 if ($] >= 5.009_005) {
100 $impl = \&mro::get_linear_isa;
104 eval { require MRO::Compat };
108 $impl = \&mro::get_linear_isa;
110 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
111 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
112 $_get_linear_isa_dfs = sub {
115 my $classname = shift;
117 my @lin = ($classname);
119 foreach my $parent (@{"$classname\::ISA"}) {
120 my $plin = $_get_linear_isa_dfs->($parent);
121 foreach my $p(@$plin) {
122 next if exists $stored{$p};
129 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
130 $impl = $_get_linear_isa_dfs;
136 *get_linear_isa = $impl;
140 # taken from Mouse::Util (0.90)
144 sub resolve_metaclass_alias {
145 my ( $type, $metaclass_name, %options ) = @_;
147 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
149 return $cache{$cache_key}{$metaclass_name} ||= do{
151 my $possible_full_name = join '::',
152 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
155 my $loaded_class = load_first_existing_class(
160 $loaded_class->can('register_implementation')
161 ? $loaded_class->register_implementation
167 # Utilities from Class::MOP
170 sub get_code_package;
172 # taken from Class/MOP.pm
173 sub is_valid_class_name {
176 return 0 if ref($class);
177 return 0 unless defined($class);
179 return 1 if $class =~ /^\w+(?:::\w+)*$/;
184 # taken from Class/MOP.pm
185 sub load_first_existing_class {
190 for my $class (@classes) {
191 my $e = _try_load_one_class($class);
194 $exceptions{$class} = $e;
205 sprintf( "Could not load class (%s) because : %s",
206 $_, $exceptions{$_} )
211 # taken from Class/MOP.pm
212 my %is_class_loaded_cache;
213 sub _try_load_one_class {
216 unless ( is_valid_class_name($class) ) {
217 my $display = defined($class) ? $class : 'undef';
218 confess "Invalid class name ($display)";
221 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
223 my $file = $class . '.pm';
228 eval { require($file) };
236 my $e = _try_load_one_class($class);
237 confess "Could not load class ($class) because : $e" if $e;
245 sub apply_all_roles {
246 my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift);
250 # Basis of Data::OptList
251 my $max = scalar(@_);
252 for (my $i = 0; $i < $max ; $i++) {
253 if ($i + 1 < $max && ref($_[$i + 1])) {
254 push @roles, [ $_[$i] => $_[++$i] ];
256 push @roles, [ $_[$i] => undef ];
258 my $role_name = $roles[-1][0];
259 load_class($role_name);
261 Mouse::Util::TypeConstraints::_is_a_metarole( get_metaclass_by_name($role_name) )
262 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
265 if ( scalar @roles == 1 ) {
266 my ( $role_name, $params ) = @{ $roles[0] };
267 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
270 Mouse::Meta::Role->combine(@roles)->apply($applicant);
275 # taken from Moose::Util 0.90
277 return $_[0] if @_ == 1;
281 return "$items[0] and $items[1]" if @items == 2;
283 my $tail = pop @items;
285 return join q{, }, @items, "and $tail";
294 $feature ||= ( caller(1) )[3]; # subroutine name
296 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
297 Carp::confess("Mouse does not currently support $feature");
300 # general meta() method
302 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
305 # general dump() method
307 my($self, $maxdepth) = @_;
309 require 'Data/Dumper.pm'; # we don't want to create its namespace
310 my $dd = Data::Dumper->new([$self]);
311 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
316 # general does() method
318 *does = \&does_role; # alias
326 Mouse::Util - Features, with or without their dependencies
330 This document describes Mouse version 0.40_01
332 =head1 IMPLEMENTATIONS FOR
340 =head3 C<resolve_metaclass_alias>
342 =head3 C<apply_all_roles>
344 =head3 C<english_list>
348 =head3 C<< is_class_loaded(ClassName) -> Bool >>
350 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
351 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
352 locally-defined method.
354 =head3 C<< load_class(ClassName) >>
356 This will load a given C<ClassName> (or die if it is not loadable).
357 This function can be used in place of tricks like
358 C<eval "use $module"> or using C<require>.
360 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
362 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
364 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
366 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
370 =head3 C<get_linear_isa>
374 =head3 C<get_code_info>
376 =head1 UTILITIES FOR MOUSE
378 =head3 C<not_supported>