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_05';
10 my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
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 $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
21 XSLoader::load('Mouse', $VERSION);
27 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
30 *_MOUSE_XS = sub(){ $xs };
37 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
39 Mouse::Exporter->setup_import_methods(
43 resolve_metaclass_alias
62 default => [], # export no functions by default
64 # The ':meta' group is 'use metaclass' for Mouse
65 meta => [qw(does meta dump _MOUSE_VERBOSE)],
69 # aliases as public APIs
70 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
71 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
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;
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');
86 # Moose::Util compatible utilities
89 return class_of( $_[0] );
93 my ($class_or_obj, $role_name) = @_;
95 my $meta = class_of($class_or_obj);
98 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
100 return defined($meta) && $meta->does_role($role_name);
105 if ($] >= 5.009_005) {
107 $get_linear_isa = \&mro::get_linear_isa;
111 eval { require MRO::Compat };
115 $get_linear_isa = \&mro::get_linear_isa;
117 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
118 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
119 $_get_linear_isa_dfs = sub {
122 my $classname = shift;
124 my @lin = ($classname);
126 foreach my $parent (@{"$classname\::ISA"}) {
127 my $plin = $_get_linear_isa_dfs->($parent);
128 foreach my $p(@$plin) {
129 next if exists $stored{$p};
136 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
137 $get_linear_isa = $_get_linear_isa_dfs;
143 *get_linear_isa = $get_linear_isa;
147 # taken from Mouse::Util (0.90)
151 sub resolve_metaclass_alias {
152 my ( $type, $metaclass_name, %options ) = @_;
154 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
156 return $cache{$cache_key}{$metaclass_name} ||= do{
158 my $possible_full_name = join '::',
159 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
162 my $loaded_class = load_first_existing_class(
167 $loaded_class->can('register_implementation')
168 ? $loaded_class->register_implementation
174 # Utilities from Class::MOP
177 sub get_code_package;
179 # taken from Class/MOP.pm
180 sub is_valid_class_name {
183 return 0 if ref($class);
184 return 0 unless defined($class);
186 return 1 if $class =~ /^\w+(?:::\w+)*$/;
191 # taken from Class/MOP.pm
192 sub load_first_existing_class {
197 for my $class (@classes) {
198 my $e = _try_load_one_class($class);
201 $exceptions{$class} = $e;
212 sprintf( "Could not load class (%s) because : %s",
213 $_, $exceptions{$_} )
218 # taken from Class/MOP.pm
219 my %is_class_loaded_cache;
220 sub _try_load_one_class {
223 unless ( is_valid_class_name($class) ) {
224 my $display = defined($class) ? $class : 'undef';
225 Carp::confess "Invalid class name ($display)";
228 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
230 my $file = $class . '.pm';
235 eval { require($file) };
243 my $e = _try_load_one_class($class);
244 Carp::confess "Could not load class ($class) because : $e" if $e;
252 sub apply_all_roles {
253 my $applicant = Scalar::Util::blessed($_[0])
255 : Mouse::Meta::Class->initialize(shift); # class or role name
259 # Basis of Data::OptList
260 my $max = scalar(@_);
261 for (my $i = 0; $i < $max ; $i++) {
262 if ($i + 1 < $max && ref($_[$i + 1])) {
263 push @roles, [ $_[$i] => $_[++$i] ];
265 push @roles, [ $_[$i] => undef ];
267 my $role_name = $roles[-1][0];
268 load_class($role_name);
270 is_a_metarole( get_metaclass_by_name($role_name) )
271 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
274 if ( scalar @roles == 1 ) {
275 my ( $role_name, $params ) = @{ $roles[0] };
276 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
279 Mouse::Meta::Role->combine(@roles)->apply($applicant);
284 # taken from Moose::Util 0.90
286 return $_[0] if @_ == 1;
290 return "$items[0] and $items[1]" if @items == 2;
292 my $tail = pop @items;
294 return join q{, }, @items, "and $tail";
303 $feature ||= ( caller(1) )[3]; # subroutine name
305 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
306 Carp::confess("Mouse does not currently support $feature");
309 # general meta() method
311 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
314 # general dump() method
316 my($self, $maxdepth) = @_;
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);
325 # general does() method
327 *does = \&does_role; # alias
335 Mouse::Util - Features, with or without their dependencies
339 This document describes Mouse version 0.40_05
341 =head1 IMPLEMENTATIONS FOR
349 =head3 C<resolve_metaclass_alias>
351 =head3 C<apply_all_roles>
353 =head3 C<english_list>
357 =head3 C<< is_class_loaded(ClassName) -> Bool >>
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.
363 =head3 C<< load_class(ClassName) >>
365 This will load a given C<ClassName> (or die if it is not loadable).
366 This function can be used in place of tricks like
367 C<eval "use $module"> or using C<require>.
369 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
371 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
373 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
375 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
379 =head3 C<get_linear_isa>
383 =head3 C<get_code_info>
385 =head1 UTILITIES FOR MOUSE
387 =head3 C<not_supported>