2 use Mouse::Exporter; # enables strict and warnings
5 # Because Mouse::Util is loaded first in all the Mouse sub-modules,
6 # XS loader is placed here, not in Mouse.pm.
10 my $need_pp = !!$ENV{MOUSE_PUREPERL};
12 if(!$need_pp && !exists $INC{'Mouse/PurePerl.pm'}){
16 XSLoader::load('Mouse', $VERSION);
18 warn $@ if $@; # for DEBUGGING
22 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
28 use Scalar::Util qw(blessed);
30 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
32 Mouse::Exporter->setup_import_methods(
36 resolve_metaclass_alias
54 default => [], # export no functions by default
56 # The ':meta' group is 'use metaclass' for Mouse
57 meta => [qw(does meta dump _MOUSE_VERBOSE)],
61 # aliases as public APIs
62 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
63 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
66 *class_of = \&Mouse::Meta::Module::class_of;
67 *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name;
68 *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
69 *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names;
72 # Moose::Util compatible utilities
75 return class_of( $_[0] );
79 my ($class_or_obj, $role_name) = @_;
81 my $meta = class_of($class_or_obj);
84 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
86 return defined($meta) && $meta->does_role($role_name);
91 if ($] >= 5.009_005) {
93 $impl = \&mro::get_linear_isa;
97 eval { require MRO::Compat };
101 $impl = \&mro::get_linear_isa;
103 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
104 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
105 $_get_linear_isa_dfs = sub {
108 my $classname = shift;
110 my @lin = ($classname);
112 foreach my $parent (@{"$classname\::ISA"}) {
113 my $plin = $_get_linear_isa_dfs->($parent);
114 foreach my $p(@$plin) {
115 next if exists $stored{$p};
122 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
123 $impl = $_get_linear_isa_dfs;
129 *get_linear_isa = $impl;
133 # taken from Mouse::Util (0.90)
137 sub resolve_metaclass_alias {
138 my ( $type, $metaclass_name, %options ) = @_;
140 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
142 return $cache{$cache_key}{$metaclass_name} ||= do{
144 my $possible_full_name = join '::',
145 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
148 my $loaded_class = load_first_existing_class(
153 $loaded_class->can('register_implementation')
154 ? $loaded_class->register_implementation
160 # Utilities from Class::MOP
163 sub get_code_package;
165 # taken from Class/MOP.pm
166 sub is_valid_class_name {
169 return 0 if ref($class);
170 return 0 unless defined($class);
172 return 1 if $class =~ /^\w+(?:::\w+)*$/;
177 # taken from Class/MOP.pm
178 sub load_first_existing_class {
183 for my $class (@classes) {
184 my $e = _try_load_one_class($class);
187 $exceptions{$class} = $e;
198 sprintf( "Could not load class (%s) because : %s",
199 $_, $exceptions{$_} )
204 # taken from Class/MOP.pm
205 my %is_class_loaded_cache;
206 sub _try_load_one_class {
209 unless ( is_valid_class_name($class) ) {
210 my $display = defined($class) ? $class : 'undef';
211 confess "Invalid class name ($display)";
214 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
216 my $file = $class . '.pm';
221 eval { require($file) };
229 my $e = _try_load_one_class($class);
230 confess "Could not load class ($class) because : $e" if $e;
238 sub apply_all_roles {
239 my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift);
243 # Basis of Data::OptList
244 my $max = scalar(@_);
245 for (my $i = 0; $i < $max ; $i++) {
246 if ($i + 1 < $max && ref($_[$i + 1])) {
247 push @roles, [ $_[$i] => $_[++$i] ];
249 push @roles, [ $_[$i] => undef ];
251 my $role_name = $roles[-1][0];
252 load_class($role_name);
254 my $metarole = get_metaclass_by_name($role_name);
255 ( $metarole && $metarole->isa('Mouse::Meta::Role') )
256 || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
259 if ( scalar @roles == 1 ) {
260 my ( $role_name, $params ) = @{ $roles[0] };
261 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
264 Mouse::Meta::Role->combine(@roles)->apply($applicant);
269 # taken from Moose::Util 0.90
271 return $_[0] if @_ == 1;
275 return "$items[0] and $items[1]" if @items == 2;
277 my $tail = pop @items;
279 return join q{, }, @items, "and $tail";
288 $feature ||= ( caller(1) )[3]; # subroutine name
290 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
291 Carp::confess("Mouse does not currently support $feature");
294 # general meta() method
296 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
299 # general dump() method
301 my($self, $maxdepth) = @_;
303 require 'Data/Dumper.pm'; # we don't want to create its namespace
304 my $dd = Data::Dumper->new([$self]);
305 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
310 # general does() method
312 *does = \&does_role; # alias
320 Mouse::Util - Features, with or without their dependencies
324 This document describes Mouse version 0.40
326 =head1 IMPLEMENTATIONS FOR
334 =head3 C<resolve_metaclass_alias>
336 =head3 C<apply_all_roles>
338 =head3 C<english_list>
342 =head3 C<< is_class_loaded(ClassName) -> Bool >>
344 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
345 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
346 locally-defined method.
348 =head3 C<< load_class(ClassName) >>
350 This will load a given C<ClassName> (or die if it is not loadable).
351 This function can be used in place of tricks like
352 C<eval "use $module"> or using C<require>.
354 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
356 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
358 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
360 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
364 =head3 C<get_linear_isa>
368 =head3 C<get_code_info>
370 =head1 UTILITIES FOR MOUSE
372 =head3 C<not_supported>