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_08';
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);
55 Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
56 Mouse::Util->import({ into => 'Mouse::Meta::Method::Destructor::XS' }, ':meta');
63 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
66 *MOUSE_XS = sub(){ $xs };
73 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
75 # aliases as public APIs
76 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
77 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
80 *class_of = \&Mouse::Meta::Module::_class_of;
81 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
82 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
83 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
86 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
87 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
88 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
91 our $in_global_destruction = 0;
92 END{ $in_global_destruction = 1 }
94 # Moose::Util compatible utilities
97 return class_of( $_[0] );
101 my ($class_or_obj, $role_name) = @_;
103 my $meta = class_of($class_or_obj);
106 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
108 return defined($meta) && $meta->does_role($role_name);
113 if ($] >= 5.009_005) {
115 $get_linear_isa = \&mro::get_linear_isa;
119 eval { require MRO::Compat };
123 $get_linear_isa = \&mro::get_linear_isa;
125 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
126 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
127 $_get_linear_isa_dfs = sub ($;$){
130 my $classname = shift;
132 my @lin = ($classname);
134 foreach my $parent (@{"$classname\::ISA"}) {
135 my $plin = $_get_linear_isa_dfs->($parent);
136 foreach my $p(@$plin) {
137 next if exists $stored{$p};
144 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
145 $get_linear_isa = $_get_linear_isa_dfs;
149 *get_linear_isa = $get_linear_isa;
153 # taken from Mouse::Util (0.90)
157 sub resolve_metaclass_alias {
158 my ( $type, $metaclass_name, %options ) = @_;
160 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
162 return $cache{$cache_key}{$metaclass_name} ||= do{
164 my $possible_full_name = join '::',
165 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
168 my $loaded_class = load_first_existing_class(
173 $loaded_class->can('register_implementation')
174 ? $loaded_class->register_implementation
180 # Utilities from Class::MOP
183 sub get_code_package;
185 # taken from Class/MOP.pm
186 sub is_valid_class_name {
189 return 0 if ref($class);
190 return 0 unless defined($class);
192 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
197 # taken from Class/MOP.pm
198 sub load_first_existing_class {
203 for my $class (@classes) {
204 my $e = _try_load_one_class($class);
207 $exceptions{$class} = $e;
218 sprintf( "Could not load class (%s) because : %s",
219 $_, $exceptions{$_} )
224 # taken from Class/MOP.pm
225 my %is_class_loaded_cache;
226 sub _try_load_one_class {
229 unless ( is_valid_class_name($class) ) {
230 my $display = defined($class) ? $class : 'undef';
231 Carp::confess "Invalid class name ($display)";
234 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
236 my $file = $class . '.pm';
241 eval { require($file) };
249 my $e = _try_load_one_class($class);
250 Carp::confess "Could not load class ($class) because : $e" if $e;
258 sub apply_all_roles {
259 my $applicant = Scalar::Util::blessed($_[0])
261 : Mouse::Meta::Class->initialize(shift); # class or role name
265 # Basis of Data::OptList
266 my $max = scalar(@_);
267 for (my $i = 0; $i < $max ; $i++) {
268 if ($i + 1 < $max && ref($_[$i + 1])) {
269 push @roles, [ $_[$i] => $_[++$i] ];
271 push @roles, [ $_[$i] => undef ];
273 my $role_name = $roles[-1][0];
274 load_class($role_name);
276 is_a_metarole( get_metaclass_by_name($role_name) )
277 || $applicant->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
280 if ( scalar @roles == 1 ) {
281 my ( $role_name, $params ) = @{ $roles[0] };
282 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
285 Mouse::Meta::Role->combine(@roles)->apply($applicant);
290 # taken from Moose::Util 0.90
292 return $_[0] if @_ == 1;
296 return "$items[0] and $items[1]" if @items == 2;
298 my $tail = pop @items;
300 return join q{, }, @items, "and $tail";
309 $feature ||= ( caller(1) )[3]; # subroutine name
311 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
312 Carp::confess("Mouse does not currently support $feature");
315 # general meta() method
317 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
320 # general dump() method
322 my($self, $maxdepth) = @_;
324 require 'Data/Dumper.pm'; # we don't want to create its namespace
325 my $dd = Data::Dumper->new([$self]);
326 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
331 # general does() method
333 *does = \&does_role; # alias
341 Mouse::Util - Features, with or without their dependencies
345 This document describes Mouse version 0.40_08
347 =head1 IMPLEMENTATIONS FOR
355 =head3 C<resolve_metaclass_alias>
357 =head3 C<apply_all_roles>
359 =head3 C<english_list>
363 =head3 C<< is_class_loaded(ClassName) -> Bool >>
365 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
366 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
367 locally-defined method.
369 =head3 C<< load_class(ClassName) >>
371 This will load a given C<ClassName> (or die if it is not loadable).
372 This function can be used in place of tricks like
373 C<eval "use $module"> or using C<require>.
375 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
377 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
379 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
381 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
385 =head3 C<get_linear_isa>
389 =head3 C<get_code_info>
391 =head1 UTILITIES FOR MOUSE
393 =head3 C<not_supported>