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.45';
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');
88 # duck type predicates
89 generate_can_predicate_for(['_compiled_type_constraint'] => 'is_a_type_constraint');
90 generate_can_predicate_for(['create_anon_class'] => 'is_a_metaclass');
91 generate_can_predicate_for(['create_anon_role'] => 'is_a_metarole');
94 our $in_global_destruction = 0;
95 END{ $in_global_destruction = 1 }
97 # Moose::Util compatible utilities
100 return class_of( $_[0] );
104 my ($class_or_obj, $role_name) = @_;
106 my $meta = class_of($class_or_obj);
109 || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
111 return defined($meta) && $meta->does_role($role_name);
116 if ($] >= 5.009_005) {
118 $get_linear_isa = \&mro::get_linear_isa;
120 # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
121 my $_get_linear_isa_dfs; # this recurses so it isn't pretty
122 $_get_linear_isa_dfs = sub {
125 my @lin = ($classname);
129 foreach my $parent (@{"$classname\::ISA"}) {
130 my $plin = $_get_linear_isa_dfs->($parent);
131 foreach my $p(@$plin) {
132 next if exists $stored{$p};
139 # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^
141 # MRO::Compat::__get_linear_isa has no prototype, so
142 # we define a prototyped version for compatibility with core's
143 # See also MRO::Compat::__get_linear_isa.
144 $get_linear_isa = sub ($;$){
145 my($classname, $type) = @_;
146 package # hide from PAUSE
150 $type = exists $MRO{$classname} ? 'c3' : 'dfs';
154 return [ calculateMRO($classname) ];
156 elsif($type eq 'dfs'){
157 return $_get_linear_isa_dfs->($classname);
160 Carp::croak("Unknown mro type '$type'");
165 *get_linear_isa = $get_linear_isa;
169 # taken from Mouse::Util (0.90)
173 sub resolve_metaclass_alias {
174 my ( $type, $metaclass_name, %options ) = @_;
176 my @trait = $options{trait} ? ('Trait') : ();
177 my $cache_key = join '-',
178 $type, @trait, $metaclass_name;
180 return $cache{$cache_key} ||= do{
182 my $possible_full_name = join '::',
183 'Mouse::Meta', $type, 'Custom', @trait, $metaclass_name
186 my $loaded_class = load_first_existing_class(
191 $loaded_class->can('register_implementation')
192 ? $loaded_class->register_implementation
198 # Utilities from Class::MOP
201 sub get_code_package;
203 # taken from Class/MOP.pm
204 sub is_valid_class_name {
207 return 0 if ref($class);
208 return 0 unless defined($class);
210 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
215 # taken from Class/MOP.pm
216 sub load_first_existing_class {
221 for my $class (@classes) {
222 my $e = _try_load_one_class($class);
225 $exceptions{$class} = $e;
236 sprintf( "Could not load class (%s) because : %s",
237 $_, $exceptions{$_} )
242 # taken from Class/MOP.pm
243 my %is_class_loaded_cache;
244 sub _try_load_one_class {
247 unless ( is_valid_class_name($class) ) {
248 my $display = defined($class) ? $class : 'undef';
249 Carp::confess "Invalid class name ($display)";
252 return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
254 my $file = $class . '.pm';
259 eval { require($file) };
267 my $e = _try_load_one_class($class);
268 Carp::confess "Could not load class ($class) because : $e" if $e;
275 sub apply_all_roles {
276 my $applicant = Scalar::Util::blessed($_[0])
278 : Mouse::Meta::Class->initialize(shift); # class or role name
282 # Basis of Data::OptList
283 my $max = scalar(@_);
284 for (my $i = 0; $i < $max ; $i++) {
285 my $role_name = $_[$i];
287 if ($i + 1 < $max && ref($_[$i + 1])) {
288 push @roles, [ $role_name=> $_[++$i] ];
290 push @roles, [ $role_name => undef ];
292 load_class($role_name);
294 is_a_metarole( get_metaclass_by_name($role_name) )
295 || $applicant->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
298 if ( scalar @roles == 1 ) {
299 my ( $role_name, $params ) = @{ $roles[0] };
300 get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () );
303 Mouse::Meta::Role->combine(@roles)->apply($applicant);
308 # taken from Moose::Util 0.90
310 return $_[0] if @_ == 1;
314 return "$items[0] and $items[1]" if @items == 2;
316 my $tail = pop @items;
318 return join q{, }, @items, "and $tail";
326 $feature ||= ( caller(1) )[3]; # subroutine name
328 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
329 Carp::confess("Mouse does not currently support $feature");
332 # general meta() method
334 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
337 # general dump() method
339 my($self, $maxdepth) = @_;
341 require 'Data/Dumper.pm'; # we don't want to create its namespace
342 my $dd = Data::Dumper->new([$self]);
343 $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
348 # general does() method
350 *does = \&does_role; # alias
357 Mouse::Util - Features, with or without their dependencies
361 This document describes Mouse version 0.45
363 =head1 IMPLEMENTATIONS FOR
371 =head3 C<resolve_metaclass_alias>
373 =head3 C<apply_all_roles>
375 =head3 C<english_list>
379 =head3 C<< is_class_loaded(ClassName) -> Bool >>
381 Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
382 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
383 locally-defined method.
385 =head3 C<< load_class(ClassName) >>
387 This will load a given C<ClassName> (or die if it is not loadable).
388 This function can be used in place of tricks like
389 C<eval "use $module"> or using C<require>.
391 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
393 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
395 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
397 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
401 =head3 C<get_linear_isa>
405 =head3 C<get_code_info>
407 =head1 Mouse specific utilities
409 =head3 C<not_supported>
411 =head3 C<get_code_package>
413 =head3 C<get_code_ref>