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');
57 Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta');
64 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
67 *MOUSE_XS = sub(){ $xs };
74 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
76 # aliases as public APIs
77 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
78 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
81 *class_of = \&Mouse::Meta::Module::_class_of;
82 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
83 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
84 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
87 generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
88 generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
89 generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
92 our $in_global_destruction = 0;
93 END{ $in_global_destruction = 1 }
95 # Moose::Util compatible utilities
98 return class_of( $_[0] );
102 my ($class_or_obj, $role_name) = @_;
104 my $meta = class_of($class_or_obj);
107 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
109 return defined($meta) && $meta->does_role($role_name);
114 if ($] >= 5.009_005) {
116 $get_linear_isa = \&mro::get_linear_isa;
120 eval { require MRO::Compat };
124 $get_linear_isa = \&mro::get_linear_isa;
126 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
127 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
128 $_get_linear_isa_dfs = sub ($;$){
131 my $classname = shift;
133 my @lin = ($classname);
135 foreach my $parent (@{"$classname\::ISA"}) {
136 my $plin = $_get_linear_isa_dfs->($parent);
137 foreach my $p(@$plin) {
138 next if exists $stored{$p};
145 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
146 $get_linear_isa = $_get_linear_isa_dfs;
150 *get_linear_isa = $get_linear_isa;
154 # taken from Mouse::Util (0.90)
158 sub resolve_metaclass_alias {
159 my ( $type, $metaclass_name, %options ) = @_;
161 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
163 return $cache{$cache_key}{$metaclass_name} ||= do{
165 my $possible_full_name = join '::',
166 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
169 my $loaded_class = load_first_existing_class(
174 $loaded_class->can('register_implementation')
175 ? $loaded_class->register_implementation
181 # Utilities from Class::MOP
184 sub get_code_package;
186 # taken from Class/MOP.pm
187 sub is_valid_class_name {
190 return 0 if ref($class);
191 return 0 unless defined($class);
193 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
198 # taken from Class/MOP.pm
199 sub load_first_existing_class {
204 for my $class (@classes) {
205 my $e = _try_load_one_class($class);
208 $exceptions{$class} = $e;
219 sprintf( "Could not load class (%s) because : %s",
220 $_, $exceptions{$_} )
225 # taken from Class/MOP.pm
226 my %is_class_loaded_cache;
227 sub _try_load_one_class {
230 unless ( is_valid_class_name($class) ) {
231 my $display = defined($class) ? $class : 'undef';
232 Carp::confess "Invalid class name ($display)";
235 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
237 my $file = $class . '.pm';
242 eval { require($file) };
250 my $e = _try_load_one_class($class);
251 Carp::confess "Could not load class ($class) because : $e" if $e;
259 sub apply_all_roles {
260 my $applicant = Scalar::Util::blessed($_[0])
262 : Mouse::Meta::Class->initialize(shift); # class or role name
266 # Basis of Data::OptList
267 my $max = scalar(@_);
268 for (my $i = 0; $i < $max ; $i++) {
269 if ($i + 1 < $max && ref($_[$i + 1])) {
270 push @roles, [ $_[$i] => $_[++$i] ];
272 push @roles, [ $_[$i] => undef ];
274 my $role_name = $roles[-1][0];
275 load_class($role_name);
277 is_a_metarole( get_metaclass_by_name($role_name) )
278 || $applicant->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
281 if ( scalar @roles == 1 ) {
282 my ( $role_name, $params ) = @{ $roles[0] };
283 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
286 Mouse::Meta::Role->combine(@roles)->apply($applicant);
291 # taken from Moose::Util 0.90
293 return $_[0] if @_ == 1;
297 return "$items[0] and $items[1]" if @items == 2;
299 my $tail = pop @items;
301 return join q{, }, @items, "and $tail";
310 $feature ||= ( caller(1) )[3]; # subroutine name
312 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
313 Carp::confess("Mouse does not currently support $feature");
316 # general meta() method
318 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
321 # general dump() method
323 my($self, $maxdepth) = @_;
325 require 'Data/Dumper.pm'; # we don't want to create its namespace
326 my $dd = Data::Dumper->new([$self]);
327 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
332 # general does() method
334 *does = \&does_role; # alias
342 Mouse::Util - Features, with or without their dependencies
346 This document describes Mouse version 0.40_08
348 =head1 IMPLEMENTATIONS FOR
356 =head3 C<resolve_metaclass_alias>
358 =head3 C<apply_all_roles>
360 =head3 C<english_list>
364 =head3 C<< is_class_loaded(ClassName) -> Bool >>
366 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
367 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
368 locally-defined method.
370 =head3 C<< load_class(ClassName) >>
372 This will load a given C<ClassName> (or die if it is not loadable).
373 This function can be used in place of tricks like
374 C<eval "use $module"> or using C<require>.
376 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
378 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
380 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
382 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
386 =head3 C<get_linear_isa>
390 =head3 C<get_code_info>
392 =head1 UTILITIES FOR MOUSE
394 =head3 C<not_supported>