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_03';
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 $need_pp = !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
35 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
37 Mouse::Exporter->setup_import_methods(
41 resolve_metaclass_alias
60 default => [], # export no functions by default
62 # The ':meta' group is 'use metaclass' for Mouse
63 meta => [qw(does meta dump _MOUSE_VERBOSE)],
67 # aliases as public APIs
68 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
69 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
72 *class_of = \&Mouse::Meta::Module::class_of;
73 *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name;
74 *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
75 *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names;
78 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
79 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
80 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
84 # Moose::Util compatible utilities
87 return class_of( $_[0] );
91 my ($class_or_obj, $role_name) = @_;
93 my $meta = class_of($class_or_obj);
96 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
98 return defined($meta) && $meta->does_role($role_name);
103 if ($] >= 5.009_005) {
105 $impl = \&mro::get_linear_isa;
109 eval { require MRO::Compat };
113 $impl = \&mro::get_linear_isa;
115 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
116 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
117 $_get_linear_isa_dfs = sub {
120 my $classname = shift;
122 my @lin = ($classname);
124 foreach my $parent (@{"$classname\::ISA"}) {
125 my $plin = $_get_linear_isa_dfs->($parent);
126 foreach my $p(@$plin) {
127 next if exists $stored{$p};
134 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
135 $impl = $_get_linear_isa_dfs;
141 *get_linear_isa = $impl;
145 # taken from Mouse::Util (0.90)
149 sub resolve_metaclass_alias {
150 my ( $type, $metaclass_name, %options ) = @_;
152 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
154 return $cache{$cache_key}{$metaclass_name} ||= do{
156 my $possible_full_name = join '::',
157 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
160 my $loaded_class = load_first_existing_class(
165 $loaded_class->can('register_implementation')
166 ? $loaded_class->register_implementation
172 # Utilities from Class::MOP
175 sub get_code_package;
177 # taken from Class/MOP.pm
178 sub is_valid_class_name {
181 return 0 if ref($class);
182 return 0 unless defined($class);
184 return 1 if $class =~ /^\w+(?:::\w+)*$/;
189 # taken from Class/MOP.pm
190 sub load_first_existing_class {
195 for my $class (@classes) {
196 my $e = _try_load_one_class($class);
199 $exceptions{$class} = $e;
210 sprintf( "Could not load class (%s) because : %s",
211 $_, $exceptions{$_} )
216 # taken from Class/MOP.pm
217 my %is_class_loaded_cache;
218 sub _try_load_one_class {
221 unless ( is_valid_class_name($class) ) {
222 my $display = defined($class) ? $class : 'undef';
223 Carp::confess "Invalid class name ($display)";
226 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
228 my $file = $class . '.pm';
233 eval { require($file) };
241 my $e = _try_load_one_class($class);
242 Carp::confess "Could not load class ($class) because : $e" if $e;
250 sub apply_all_roles {
251 my $applicant = Scalar::Util::blessed($_[0])
253 : Mouse::Meta::Class->initialize(shift); # class or role name
257 # Basis of Data::OptList
258 my $max = scalar(@_);
259 for (my $i = 0; $i < $max ; $i++) {
260 if ($i + 1 < $max && ref($_[$i + 1])) {
261 push @roles, [ $_[$i] => $_[++$i] ];
263 push @roles, [ $_[$i] => undef ];
265 my $role_name = $roles[-1][0];
266 load_class($role_name);
268 is_a_metarole( get_metaclass_by_name($role_name) )
269 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
272 if ( scalar @roles == 1 ) {
273 my ( $role_name, $params ) = @{ $roles[0] };
274 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
277 Mouse::Meta::Role->combine(@roles)->apply($applicant);
282 # taken from Moose::Util 0.90
284 return $_[0] if @_ == 1;
288 return "$items[0] and $items[1]" if @items == 2;
290 my $tail = pop @items;
292 return join q{, }, @items, "and $tail";
301 $feature ||= ( caller(1) )[3]; # subroutine name
303 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
304 Carp::confess("Mouse does not currently support $feature");
307 # general meta() method
309 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
312 # general dump() method
314 my($self, $maxdepth) = @_;
316 require 'Data/Dumper.pm'; # we don't want to create its namespace
317 my $dd = Data::Dumper->new([$self]);
318 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
323 # general does() method
325 *does = \&does_role; # alias
333 Mouse::Util - Features, with or without their dependencies
337 This document describes Mouse version 0.40_03
339 =head1 IMPLEMENTATIONS FOR
347 =head3 C<resolve_metaclass_alias>
349 =head3 C<apply_all_roles>
351 =head3 C<english_list>
355 =head3 C<< is_class_loaded(ClassName) -> Bool >>
357 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
358 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
359 locally-defined method.
361 =head3 C<< load_class(ClassName) >>
363 This will load a given C<ClassName> (or die if it is not loadable).
364 This function can be used in place of tricks like
365 C<eval "use $module"> or using C<require>.
367 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
369 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
371 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
373 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
377 =head3 C<get_linear_isa>
381 =head3 C<get_code_info>
383 =head1 UTILITIES FOR MOUSE
385 =head3 C<not_supported>