2 use Mouse::Exporter; # enables strict and warnings
4 sub get_linear_isa($;$); # must be here
6 sub install_subroutines { # must be here
9 while(my($name, $code) = splice @_, 0, 2){
11 no warnings 'once', 'redefine';
12 use warnings FATAL => 'uninitialized';
13 *{$into . '::' . $name} = \&{$code};
19 # This is used in Mouse::PurePerl
20 Mouse::Exporter->setup_import_methods(
24 resolve_metaclass_alias
42 default => [], # export no functions by default
44 # The ':meta' group is 'use metaclass' for Mouse
45 meta => [qw(does meta dump)],
50 # Because Mouse::Util is loaded first in all the Mouse sub-modules,
51 # XS loader is placed here, not in Mouse.pm.
53 our $VERSION = '0.50_03';
55 my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
58 # XXX: XSLoader tries to get the object path from caller's file name
59 # $hack_mouse_file fools its mechanism
61 (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm
62 $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
64 XSLoader::load('Mouse', $VERSION);
65 Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
66 Mouse::Util->import({ into => 'Mouse::Meta::Method::Destructor::XS' }, ':meta');
67 Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta');
74 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
77 *MOUSE_XS = sub(){ $xs };
83 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
85 # aliases as public APIs
86 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
87 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
91 *class_of = \&Mouse::Meta::Module::_class_of;
92 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
93 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
94 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
96 *Mouse::load_class = \&load_class;
97 *Mouse::is_class_loaded = \&is_class_loaded;
100 #generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
101 #generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
102 #generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
104 # duck type predicates
105 generate_can_predicate_for(['_compiled_type_constraint'] => 'is_a_type_constraint');
106 generate_can_predicate_for(['create_anon_class'] => 'is_a_metaclass');
107 generate_can_predicate_for(['create_anon_role'] => 'is_a_metarole');
110 our $in_global_destruction = 0;
111 END{ $in_global_destruction = 1 }
113 # Moose::Util compatible utilities
116 return class_of( $_[0] );
120 my ($class_or_obj, $role_name) = @_;
122 my $meta = class_of($class_or_obj);
125 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
127 return defined($meta) && $meta->does_role($role_name);
132 if ($] >= 5.009_005) {
134 $get_linear_isa = \&mro::get_linear_isa;
136 # this code is based on MRO::Compat::__get_linear_isa
137 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
138 $_get_linear_isa_dfs = sub {
141 my @lin = ($classname);
145 foreach my $parent (@{"$classname\::ISA"}) {
146 foreach my $p(@{ $_get_linear_isa_dfs->($parent) }) {
147 next if exists $stored{$p};
156 package # hide from PAUSE
158 our %MRO; # work around 'once' warnings
161 # MRO::Compat::__get_linear_isa has no prototype, so
162 # we define a prototyped version for compatibility with core's
163 # See also MRO::Compat::__get_linear_isa.
164 $get_linear_isa = sub ($;$){
165 my($classname, $type) = @_;
168 $type = exists $Class::C3::MRO{$classname} ? 'c3' : 'dfs';
172 return [Class::C3::calculateMRO($classname)];
175 return $_get_linear_isa_dfs->($classname);
180 *get_linear_isa = $get_linear_isa;
184 # taken from Mouse::Util (0.90)
188 sub resolve_metaclass_alias {
189 my ( $type, $metaclass_name, %options ) = @_;
191 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
193 return $cache{$cache_key}{$metaclass_name} ||= do{
195 my $possible_full_name = join '::',
196 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
199 my $loaded_class = load_first_existing_class(
204 $loaded_class->can('register_implementation')
205 ? $loaded_class->register_implementation
211 # Utilities from Class::MOP
214 sub get_code_package;
216 sub is_valid_class_name;
218 # taken from Class/MOP.pm
219 sub load_first_existing_class {
224 for my $class (@classes) {
225 my $e = _try_load_one_class($class);
228 $exceptions{$class} = $e;
239 sprintf( "Could not load class (%s) because : %s",
240 $_, $exceptions{$_} )
245 # taken from Class/MOP.pm
246 my %is_class_loaded_cache;
247 sub _try_load_one_class {
250 unless ( is_valid_class_name($class) ) {
251 my $display = defined($class) ? $class : 'undef';
252 Carp::confess "Invalid class name ($display)";
255 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
262 eval { require $class };
270 my $e = _try_load_one_class($class);
271 Carp::confess "Could not load class ($class) because : $e" if $e;
278 sub apply_all_roles {
279 my $consumer = Scalar::Util::blessed($_[0])
281 : Mouse::Meta::Class->initialize(shift); # class or role name
285 # Basis of Data::OptList
286 my $max = scalar(@_);
287 for (my $i = 0; $i < $max ; $i++) {
288 if ($i + 1 < $max && ref($_[$i + 1])) {
289 push @roles, [ $_[$i] => $_[++$i] ];
291 push @roles, [ $_[$i] => undef ];
293 my $role_name = $roles[-1][0];
294 load_class($role_name);
296 is_a_metarole( get_metaclass_by_name($role_name) )
297 || $consumer->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
300 if ( scalar @roles == 1 ) {
301 my ( $role_name, $params ) = @{ $roles[0] };
302 get_metaclass_by_name($role_name)->apply( $consumer, defined $params ? $params : () );
305 Mouse::Meta::Role->combine(@roles)->apply($consumer);
310 # taken from Moose::Util 0.90
312 return $_[0] if @_ == 1;
316 return "$items[0] and $items[1]" if @items == 2;
318 my $tail = pop @items;
320 return join q{, }, @items, "and $tail";
323 sub quoted_english_list {
324 return english_list(map { qq{'$_'} } @_);
332 $feature ||= ( caller(1) )[3]; # subroutine name
334 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
335 Carp::confess("Mouse does not currently support $feature");
338 # general meta() method
340 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
343 # general dump() method
345 my($self, $maxdepth) = @_;
347 require 'Data/Dumper.pm'; # we don't want to create its namespace
348 my $dd = Data::Dumper->new([$self]);
349 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3);
354 # general does() method
364 Mouse::Util - Features, with or without their dependencies
368 This document describes Mouse version 0.50_03
370 =head1 IMPLEMENTATIONS FOR
378 =head3 C<resolve_metaclass_alias>
380 =head3 C<apply_all_roles>
382 =head3 C<english_list>
386 =head3 C<< is_class_loaded(ClassName) -> Bool >>
388 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
389 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
390 locally-defined method.
392 =head3 C<< load_class(ClassName) >>
394 This will load a given C<ClassName> (or die if it is not loadable).
395 This function can be used in place of tricks like
396 C<eval "use $module"> or using C<require>.
398 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
400 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
402 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
404 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
408 =head3 C<get_linear_isa>
412 =head3 C<get_code_info>
414 =head1 Mouse specific utilities
416 =head3 C<not_supported>
418 =head3 C<get_code_package>
420 =head3 C<get_code_ref>