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 };
71 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
73 # aliases as public APIs
74 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
75 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
78 *class_of = \&Mouse::Meta::Module::_class_of;
79 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
80 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
81 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
84 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
85 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
86 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
89 our $in_global_destruction = 0;
90 END{ $in_global_destruction = 1 }
92 # Moose::Util compatible utilities
95 return class_of( $_[0] );
99 my ($class_or_obj, $role_name) = @_;
101 my $meta = class_of($class_or_obj);
104 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
106 return defined($meta) && $meta->does_role($role_name);
111 if ($] >= 5.009_005) {
113 $get_linear_isa = \&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 @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 ^^^^^
136 eval{ require Class::C3 };
138 # MRO::Compat::__get_linear_isa has no prototype, so
139 # we define a prototyped version for compatibility with core's
140 # See also MRO::Compat::__get_linear_isa.
141 $get_linear_isa = sub ($;$){
142 my($classname, $type) = @_;
146 $type = exists $MRO{$classname} ? 'c3' : 'dfs';
149 ? [Class::C3::calculateMRO($classname)]
150 : $_get_linear_isa_dfs->($classname);
\r
154 *get_linear_isa = $get_linear_isa;
158 # taken from Mouse::Util (0.90)
162 sub resolve_metaclass_alias {
163 my ( $type, $metaclass_name, %options ) = @_;
165 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
167 return $cache{$cache_key}{$metaclass_name} ||= do{
169 my $possible_full_name = join '::',
170 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
173 my $loaded_class = load_first_existing_class(
178 $loaded_class->can('register_implementation')
179 ? $loaded_class->register_implementation
185 # Utilities from Class::MOP
188 sub get_code_package;
190 # taken from Class/MOP.pm
191 sub is_valid_class_name {
194 return 0 if ref($class);
195 return 0 unless defined($class);
197 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
202 # taken from Class/MOP.pm
203 sub load_first_existing_class {
208 for my $class (@classes) {
209 my $e = _try_load_one_class($class);
212 $exceptions{$class} = $e;
223 sprintf( "Could not load class (%s) because : %s",
224 $_, $exceptions{$_} )
229 # taken from Class/MOP.pm
230 my %is_class_loaded_cache;
231 sub _try_load_one_class {
234 unless ( is_valid_class_name($class) ) {
235 my $display = defined($class) ? $class : 'undef';
236 Carp::confess "Invalid class name ($display)";
239 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
241 my $file = $class . '.pm';
246 eval { require($file) };
254 my $e = _try_load_one_class($class);
255 Carp::confess "Could not load class ($class) because : $e" if $e;
262 sub apply_all_roles {
263 my $applicant = Scalar::Util::blessed($_[0])
265 : Mouse::Meta::Class->initialize(shift); # class or role name
269 # Basis of Data::OptList
270 my $max = scalar(@_);
271 for (my $i = 0; $i < $max ; $i++) {
272 if ($i + 1 < $max && ref($_[$i + 1])) {
273 push @roles, [ $_[$i] => $_[++$i] ];
275 push @roles, [ $_[$i] => undef ];
277 my $role_name = $roles[-1][0];
278 load_class($role_name);
280 is_a_metarole( get_metaclass_by_name($role_name) )
281 || $applicant->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
284 if ( scalar @roles == 1 ) {
285 my ( $role_name, $params ) = @{ $roles[0] };
286 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
289 Mouse::Meta::Role->combine(@roles)->apply($applicant);
294 # taken from Moose::Util 0.90
296 return $_[0] if @_ == 1;
300 return "$items[0] and $items[1]" if @items == 2;
302 my $tail = pop @items;
304 return join q{, }, @items, "and $tail";
312 $feature ||= ( caller(1) )[3]; # subroutine name
314 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
315 Carp::confess("Mouse does not currently support $feature");
318 # general meta() method
320 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
323 # general dump() method
325 my($self, $maxdepth) = @_;
327 require 'Data/Dumper.pm'; # we don't want to create its namespace
328 my $dd = Data::Dumper->new([$self]);
329 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
334 # general does() method
336 *does = \&does_role; # alias
343 Mouse::Util - Features, with or without their dependencies
347 This document describes Mouse version 0.40_09
349 =head1 IMPLEMENTATIONS FOR
357 =head3 C<resolve_metaclass_alias>
359 =head3 C<apply_all_roles>
361 =head3 C<english_list>
365 =head3 C<< is_class_loaded(ClassName) -> Bool >>
367 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
368 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
369 locally-defined method.
371 =head3 C<< load_class(ClassName) >>
373 This will load a given C<ClassName> (or die if it is not loadable).
374 This function can be used in place of tricks like
375 C<eval "use $module"> or using C<require>.
377 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
379 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
381 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
383 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
387 =head3 C<get_linear_isa>
391 =head3 C<get_code_info>
393 =head1 Mouse specific utilities
395 =head3 C<not_supported>
397 =head3 C<get_code_package>
399 =head3 C<get_code_ref>