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_09';
43 my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
46 # XXX: XSLoader tries to get the object path from caller's file name
47 # $hack_mouse_file fools its mechanism
49 (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm
50 $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
52 XSLoader::load('Mouse', $VERSION);
53 Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
54 Mouse::Util->import({ into => 'Mouse::Meta::Method::Destructor::XS' }, ':meta');
55 Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta');
62 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
65 *MOUSE_XS = sub(){ $xs };
72 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
74 # aliases as public APIs
75 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
76 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
79 *class_of = \&Mouse::Meta::Module::_class_of;
80 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
81 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
82 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
85 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
86 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
87 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
90 our $in_global_destruction = 0;
91 END{ $in_global_destruction = 1 }
93 # Moose::Util compatible utilities
96 return class_of( $_[0] );
100 my ($class_or_obj, $role_name) = @_;
102 my $meta = class_of($class_or_obj);
105 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
107 return defined($meta) && $meta->does_role($role_name);
112 if ($] >= 5.009_005) {
114 $get_linear_isa = \&mro::get_linear_isa;
116 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
117 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
118 $_get_linear_isa_dfs = sub {
121 my @lin = ($classname);
125 foreach my $parent (@{"$classname\::ISA"}) {
126 my $plin = $_get_linear_isa_dfs->($parent);
127 foreach my $p(@$plin) {
128 next if exists $stored{$p};
135 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
137 eval{ require Class::C3 };
139 # MRO::Compat::__get_linear_isa has no prototype, so
140 # we define a prototyped version for compatibility with core's
141 # See also MRO::Compat::__get_linear_isa.
142 $get_linear_isa = sub ($;$){
143 my($classname, $type) = @_;
147 $type = exists $MRO{$classname} ? 'c3' : 'dfs';
150 ? [Class::C3::calculateMRO($classname)]
151 : $_get_linear_isa_dfs->($classname);
\r
155 *get_linear_isa = $get_linear_isa;
159 # taken from Mouse::Util (0.90)
163 sub resolve_metaclass_alias {
164 my ( $type, $metaclass_name, %options ) = @_;
166 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
168 return $cache{$cache_key}{$metaclass_name} ||= do{
170 my $possible_full_name = join '::',
171 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
174 my $loaded_class = load_first_existing_class(
179 $loaded_class->can('register_implementation')
180 ? $loaded_class->register_implementation
186 # Utilities from Class::MOP
189 sub get_code_package;
191 # taken from Class/MOP.pm
192 sub is_valid_class_name {
195 return 0 if ref($class);
196 return 0 unless defined($class);
198 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
203 # taken from Class/MOP.pm
204 sub load_first_existing_class {
209 for my $class (@classes) {
210 my $e = _try_load_one_class($class);
213 $exceptions{$class} = $e;
224 sprintf( "Could not load class (%s) because : %s",
225 $_, $exceptions{$_} )
230 # taken from Class/MOP.pm
231 my %is_class_loaded_cache;
232 sub _try_load_one_class {
235 unless ( is_valid_class_name($class) ) {
236 my $display = defined($class) ? $class : 'undef';
237 Carp::confess "Invalid class name ($display)";
240 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
242 my $file = $class . '.pm';
247 eval { require($file) };
255 my $e = _try_load_one_class($class);
256 Carp::confess "Could not load class ($class) because : $e" if $e;
264 sub apply_all_roles {
265 my $applicant = Scalar::Util::blessed($_[0])
267 : Mouse::Meta::Class->initialize(shift); # class or role name
271 # Basis of Data::OptList
272 my $max = scalar(@_);
273 for (my $i = 0; $i < $max ; $i++) {
274 if ($i + 1 < $max && ref($_[$i + 1])) {
275 push @roles, [ $_[$i] => $_[++$i] ];
277 push @roles, [ $_[$i] => undef ];
279 my $role_name = $roles[-1][0];
280 load_class($role_name);
282 is_a_metarole( get_metaclass_by_name($role_name) )
283 || $applicant->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
286 if ( scalar @roles == 1 ) {
287 my ( $role_name, $params ) = @{ $roles[0] };
288 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
291 Mouse::Meta::Role->combine(@roles)->apply($applicant);
296 # taken from Moose::Util 0.90
298 return $_[0] if @_ == 1;
302 return "$items[0] and $items[1]" if @items == 2;
304 my $tail = pop @items;
306 return join q{, }, @items, "and $tail";
315 $feature ||= ( caller(1) )[3]; # subroutine name
317 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
318 Carp::confess("Mouse does not currently support $feature");
321 # general meta() method
323 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
326 # general dump() method
328 my($self, $maxdepth) = @_;
330 require 'Data/Dumper.pm'; # we don't want to create its namespace
331 my $dd = Data::Dumper->new([$self]);
332 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
337 # general does() method
339 *does = \&does_role; # alias
347 Mouse::Util - Features, with or without their dependencies
351 This document describes Mouse version 0.40_09
353 =head1 IMPLEMENTATIONS FOR
361 =head3 C<resolve_metaclass_alias>
363 =head3 C<apply_all_roles>
365 =head3 C<english_list>
369 =head3 C<< is_class_loaded(ClassName) -> Bool >>
371 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
372 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
373 locally-defined method.
375 =head3 C<< load_class(ClassName) >>
377 This will load a given C<ClassName> (or die if it is not loadable).
378 This function can be used in place of tricks like
379 C<eval "use $module"> or using C<require>.
381 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
383 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
385 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
387 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
391 =head3 C<get_linear_isa>
395 =head3 C<get_code_info>
397 =head1 UTILITIES FOR MOUSE
399 =head3 C<not_supported>