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_07';
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{
63 local $^W = 0; # work around 'redefine' warning to &install_subroutines
65 XSLoader::load('Mouse', $VERSION);
66 Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
67 Mouse::Util->import({ into => 'Mouse::Meta::Method::Destructor::XS' }, ':meta');
68 Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta');
75 require 'Mouse/PurePerl.pm'; # we don't want to create its namespace
78 *MOUSE_XS = sub(){ $xs };
84 # aliases as public APIs
85 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
86 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
90 *class_of = \&Mouse::Meta::Module::_class_of;
91 *get_metaclass_by_name = \&Mouse::Meta::Module::_get_metaclass_by_name;
92 *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
93 *get_all_metaclass_names = \&Mouse::Meta::Module::_get_all_metaclass_names;
95 *Mouse::load_class = \&load_class;
96 *Mouse::is_class_loaded = \&is_class_loaded;
99 #generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
100 #generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass');
101 #generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole');
103 # duck type predicates
104 generate_can_predicate_for(['_compiled_type_constraint'] => 'is_a_type_constraint');
105 generate_can_predicate_for(['create_anon_class'] => 'is_a_metaclass');
106 generate_can_predicate_for(['create_anon_role'] => 'is_a_metarole');
109 our $in_global_destruction = 0;
110 END{ $in_global_destruction = 1 }
112 # Moose::Util compatible utilities
115 return class_of( $_[0] );
119 my ($class_or_obj, $role_name) = @_;
121 my $meta = class_of($class_or_obj);
124 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
126 return defined($meta) && $meta->does_role($role_name);
131 if ($] >= 5.009_005) {
133 $get_linear_isa = \&mro::get_linear_isa;
135 # this code is based on MRO::Compat::__get_linear_isa
136 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
137 $_get_linear_isa_dfs = sub {
140 my @lin = ($classname);
144 foreach my $parent (@{"$classname\::ISA"}) {
145 foreach my $p(@{ $_get_linear_isa_dfs->($parent) }) {
146 next if exists $stored{$p};
155 package # hide from PAUSE
157 our %MRO; # work around 'once' warnings
160 # MRO::Compat::__get_linear_isa has no prototype, so
161 # we define a prototyped version for compatibility with core's
162 # See also MRO::Compat::__get_linear_isa.
163 $get_linear_isa = sub ($;$){
164 my($classname, $type) = @_;
167 $type = exists $Class::C3::MRO{$classname} ? 'c3' : 'dfs';
171 return [Class::C3::calculateMRO($classname)];
174 return $_get_linear_isa_dfs->($classname);
179 *get_linear_isa = $get_linear_isa;
183 # taken from Mouse::Util (0.90)
187 sub resolve_metaclass_alias {
188 my ( $type, $metaclass_name, %options ) = @_;
190 my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
192 return $cache{$cache_key}{$metaclass_name} ||= do{
194 my $possible_full_name = join '::',
195 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
198 my $loaded_class = load_first_existing_class(
203 $loaded_class->can('register_implementation')
204 ? $loaded_class->register_implementation
210 # Utilities from Class::MOP
213 sub get_code_package;
215 sub is_valid_class_name;
217 # taken from Class/MOP.pm
218 sub load_first_existing_class {
223 for my $class (@classes) {
224 my $e = _try_load_one_class($class);
227 $exceptions{$class} = $e;
238 sprintf( "Could not load class (%s) because : %s",
239 $_, $exceptions{$_} )
244 # taken from Class/MOP.pm
245 my %is_class_loaded_cache;
246 sub _try_load_one_class {
249 unless ( is_valid_class_name($class) ) {
250 my $display = defined($class) ? $class : 'undef';
251 Carp::confess "Invalid class name ($display)";
254 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
261 eval { require $class };
269 my $e = _try_load_one_class($class);
270 Carp::confess "Could not load class ($class) because : $e" if $e;
277 sub apply_all_roles {
278 my $consumer = Scalar::Util::blessed($_[0])
280 : Mouse::Meta::Class->initialize(shift); # class or role name
284 # Basis of Data::OptList
285 my $max = scalar(@_);
286 for (my $i = 0; $i < $max ; $i++) {
287 if ($i + 1 < $max && ref($_[$i + 1])) {
288 push @roles, [ $_[$i] => $_[++$i] ];
290 push @roles, [ $_[$i] => undef ];
292 my $role_name = $roles[-1][0];
293 load_class($role_name);
295 is_a_metarole( get_metaclass_by_name($role_name) )
296 || $consumer->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
299 if ( scalar @roles == 1 ) {
300 my ( $role_name, $params ) = @{ $roles[0] };
301 get_metaclass_by_name($role_name)->apply( $consumer, defined $params ? $params : () );
304 Mouse::Meta::Role->combine(@roles)->apply($consumer);
309 # taken from Moose::Util 0.90
311 return $_[0] if @_ == 1;
315 return "$items[0] and $items[1]" if @items == 2;
317 my $tail = pop @items;
319 return join q{, }, @items, "and $tail";
322 sub quoted_english_list {
323 return english_list(map { qq{'$_'} } @_);
331 $feature ||= ( caller(1) )[3]; # subroutine name
333 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
334 Carp::confess("Mouse does not currently support $feature");
337 # general meta() method
339 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
342 # general dump() method
344 my($self, $maxdepth) = @_;
346 require 'Data/Dumper.pm'; # we don't want to create its namespace
347 my $dd = Data::Dumper->new([$self]);
348 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3);
353 # general does() method
363 Mouse::Util - Features, with or without their dependencies
367 This document describes Mouse version 0.50_07
369 =head1 IMPLEMENTATIONS FOR
377 =head3 C<resolve_metaclass_alias>
379 =head3 C<apply_all_roles>
381 =head3 C<english_list>
385 =head3 C<< is_class_loaded(ClassName) -> Bool >>
387 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
388 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
389 locally-defined method.
391 =head3 C<< load_class(ClassName) >>
393 This will load a given C<ClassName> (or die if it is not loadable).
394 This function can be used in place of tricks like
395 C<eval "use $module"> or using C<require>.
397 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
399 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
401 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
403 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
407 =head3 C<get_linear_isa>
411 =head3 C<get_code_info>
413 =head1 Mouse specific utilities
415 =head3 C<not_supported>
417 =head3 C<get_code_package>
419 =head3 C<get_code_ref>