2 use Mouse::Exporter; # enables strict and warnings
4 sub get_linear_isa($;$); # must be here
7 # This is used in Mouse::PurePerl
8 Mouse::Exporter->setup_import_methods(
12 resolve_metaclass_alias
30 default => [], # export no functions by default
32 # The ':meta' group is 'use metaclass' for Mouse
33 meta => [qw(does meta dump)],
38 # Because Mouse::Util is loaded first in all the Mouse sub-modules,
39 # XS loader is placed here, not in Mouse.pm.
41 our $VERSION = '0.40_07';
43 my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
48 # XXX: XSLoader tries to get the object path from caller's file name
49 # $hack_mouse_file fools its mechanism
51 (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm
52 $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
54 XSLoader::load('Mouse', $VERSION);
60 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
63 *_MOUSE_XS = sub(){ $xs };
70 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
72 # aliases as public APIs
73 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
74 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
77 *class_of = \&Mouse::Meta::Module::_class_of;
78 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
79 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
80 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
83 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
84 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
85 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
89 # Moose::Util compatible utilities
92 return class_of( $_[0] );
96 my ($class_or_obj, $role_name) = @_;
98 my $meta = class_of($class_or_obj);
101 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
103 return defined($meta) && $meta->does_role($role_name);
108 if ($] >= 5.009_005) {
110 $get_linear_isa = \&mro::get_linear_isa;
114 eval { require MRO::Compat };
118 $get_linear_isa = \&mro::get_linear_isa;
120 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
121 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
122 $_get_linear_isa_dfs = sub ($;$){
125 my $classname = shift;
127 my @lin = ($classname);
129 foreach my $parent (@{"$classname\::ISA"}) {
130 my $plin = $_get_linear_isa_dfs->($parent);
131 foreach my $p(@$plin) {
132 next if exists $stored{$p};
139 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
140 $get_linear_isa = $_get_linear_isa_dfs;
144 *get_linear_isa = $get_linear_isa;
148 # taken from Mouse::Util (0.90)
152 sub resolve_metaclass_alias {
153 my ( $type, $metaclass_name, %options ) = @_;
155 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
157 return $cache{$cache_key}{$metaclass_name} ||= do{
159 my $possible_full_name = join '::',
160 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
163 my $loaded_class = load_first_existing_class(
168 $loaded_class->can('register_implementation')
169 ? $loaded_class->register_implementation
175 # Utilities from Class::MOP
178 sub get_code_package;
180 # taken from Class/MOP.pm
181 sub is_valid_class_name {
184 return 0 if ref($class);
185 return 0 unless defined($class);
187 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
192 # taken from Class/MOP.pm
193 sub load_first_existing_class {
198 for my $class (@classes) {
199 my $e = _try_load_one_class($class);
202 $exceptions{$class} = $e;
213 sprintf( "Could not load class (%s) because : %s",
214 $_, $exceptions{$_} )
219 # taken from Class/MOP.pm
220 my %is_class_loaded_cache;
221 sub _try_load_one_class {
224 unless ( is_valid_class_name($class) ) {
225 my $display = defined($class) ? $class : 'undef';
226 Carp::confess "Invalid class name ($display)";
229 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
231 my $file = $class . '.pm';
236 eval { require($file) };
244 my $e = _try_load_one_class($class);
245 Carp::confess "Could not load class ($class) because : $e" if $e;
253 sub apply_all_roles {
254 my $applicant = Scalar::Util::blessed($_[0])
256 : Mouse::Meta::Class->initialize(shift); # class or role name
260 # Basis of Data::OptList
261 my $max = scalar(@_);
262 for (my $i = 0; $i < $max ; $i++) {
263 if ($i + 1 < $max && ref($_[$i + 1])) {
264 push @roles, [ $_[$i] => $_[++$i] ];
266 push @roles, [ $_[$i] => undef ];
268 my $role_name = $roles[-1][0];
269 load_class($role_name);
271 is_a_metarole( get_metaclass_by_name($role_name) )
272 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
275 if ( scalar @roles == 1 ) {
276 my ( $role_name, $params ) = @{ $roles[0] };
277 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
280 Mouse::Meta::Role->combine(@roles)->apply($applicant);
285 # taken from Moose::Util 0.90
287 return $_[0] if @_ == 1;
291 return "$items[0] and $items[1]" if @items == 2;
293 my $tail = pop @items;
295 return join q{, }, @items, "and $tail";
304 $feature ||= ( caller(1) )[3]; # subroutine name
306 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
307 Carp::confess("Mouse does not currently support $feature");
310 # general meta() method
312 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
315 # general dump() method
317 my($self, $maxdepth) = @_;
319 require 'Data/Dumper.pm'; # we don't want to create its namespace
320 my $dd = Data::Dumper->new([$self]);
321 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
326 # general does() method
328 *does = \&does_role; # alias
336 Mouse::Util - Features, with or without their dependencies
340 This document describes Mouse version 0.40_07
342 =head1 IMPLEMENTATIONS FOR
350 =head3 C<resolve_metaclass_alias>
352 =head3 C<apply_all_roles>
354 =head3 C<english_list>
358 =head3 C<< is_class_loaded(ClassName) -> Bool >>
360 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
361 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
362 locally-defined method.
364 =head3 C<< load_class(ClassName) >>
366 This will load a given C<ClassName> (or die if it is not loadable).
367 This function can be used in place of tricks like
368 C<eval "use $module"> or using C<require>.
370 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
372 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
374 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
376 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
380 =head3 C<get_linear_isa>
384 =head3 C<get_code_info>
386 =head1 UTILITIES FOR MOUSE
388 =head3 C<not_supported>