lib/Mouse/Util.pm

   1 package Mouse::Util;
   2 use Mouse::Exporter; # enables strict and warnings
   3
   4 use Carp qw(confess);
   5 use Scalar::Util qw(blessed);
   6 use B ();
   7
   8 use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
   9
  10 Mouse::Exporter->setup_import_methods(
  11     as_is => [qw(
  12         find_meta
  13         does_role
  14         resolve_metaclass_alias
  15         apply_all_roles
  16         english_list
  17
  18         load_class
  19         is_class_loaded
  20
  21         get_linear_isa
  22         get_code_info
  23
  24         get_code_package
  25
  26         not_supported
  27
  28         does meta dump
  29         _MOUSE_VERBOSE
  30     )],
  31     groups => {
  32         default => [], # export no functions by default
  33         meta    => [qw(does meta dump _MOUSE_VERBOSE)],
  34     },
  35     _export_to_main => 1,
  36 );
  37
  38 # aliases as public APIs
  39 # it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
  40 require Mouse::Meta::Module; # for the entities of metaclass cache utilities
  41
  42 BEGIN {
  43     *class_of                    = \&Mouse::Meta::Module::class_of;
  44     *get_metaclass_by_name       = \&Mouse::Meta::Module::get_metaclass_by_name;
  45     *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances;
  46     *get_all_metaclass_names     = \&Mouse::Meta::Module::get_all_metaclass_names;
  47 }
  48
  49 # Moose::Util compatible utilities
  50
  51 sub find_meta{
  52     return class_of( $_[0] );
  53 }
  54
  55 sub does_role{
  56     my ($class_or_obj, $role_name) = @_;
  57
  58     my $meta = class_of($class_or_obj);
  59
  60     (defined $role_name)
  61         || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
  62
  63     return defined($meta) && $meta->does_role($role_name);
  64 }
  65
  66 BEGIN {
  67     my $impl;
  68     if ($] >= 5.009_005) {
  69         require mro;
  70         $impl = \&mro::get_linear_isa;
  71     } else {
  72         my $e = do {
  73             local $@;
  74             eval { require MRO::Compat };
  75             $@;
  76         };
  77         if (!$e) {
  78             $impl = \&mro::get_linear_isa;
  79         } else {
  80 #       VVVVV   CODE TAKEN FROM MRO::COMPAT   VVVVV
  81             my $_get_linear_isa_dfs; # this recurses so it isn't pretty
  82             $_get_linear_isa_dfs = sub {
  83                 no strict 'refs';
  84
  85                 my $classname = shift;
  86
  87                 my @lin = ($classname);
  88                 my %stored;
  89                 foreach my $parent (@{"$classname\::ISA"}) {
  90                     my $plin = $_get_linear_isa_dfs->($parent);
  91                     foreach  my $p(@$plin) {
  92                         next if exists $stored{$p};
  93                         push(@lin, $p);
  94                         $stored{$p} = 1;
  95                     }
  96                 }
  97                 return \@lin;
  98             };
  99 #       ^^^^^   CODE TAKEN FROM MRO::COMPAT   ^^^^^
 100             $impl = $_get_linear_isa_dfs;
 101         }
 102     }
 103
 104
 105     no warnings 'once';
 106     *get_linear_isa = $impl;
 107 }
 108
 109 { # taken from Sub::Identify
 110     sub get_code_info($) {
 111         my ($coderef) = @_;
 112         ref($coderef) or return;
 113
 114         my $cv = B::svref_2object($coderef);
 115         $cv->isa('B::CV') or return;
 116
 117         my $gv = $cv->GV;
 118         $gv->isa('B::GV') or return;
 119
 120         return ($gv->STASH->NAME, $gv->NAME);
 121     }
 122
 123     sub get_code_package{
 124         my($coderef) = @_;
 125
 126         my $cv = B::svref_2object($coderef);
 127         $cv->isa('B::CV') or return '';
 128
 129         my $gv = $cv->GV;
 130         $gv->isa('B::GV') or return '';
 131
 132         return $gv->STASH->NAME;
 133     }
 134 }
 135
 136 # taken from Mouse::Util (0.90)
 137 {
 138     my %cache;
 139
 140     sub resolve_metaclass_alias {
 141         my ( $type, $metaclass_name, %options ) = @_;
 142
 143         my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
 144
 145         return $cache{$cache_key}{$metaclass_name} ||= do{
 146
 147             my $possible_full_name = join '::',
 148                 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
 149             ;
 150
 151             my $loaded_class = load_first_existing_class(
 152                 $possible_full_name,
 153                 $metaclass_name
 154             );
 155
 156             $loaded_class->can('register_implementation')
 157                 ? $loaded_class->register_implementation
 158                 : $loaded_class;
 159         };
 160     }
 161 }
 162
 163 # Utilities from Class::MOP
 164
 165
 166 # taken from Class/MOP.pm
 167 sub is_valid_class_name {
 168     my $class = shift;
 169
 170     return 0 if ref($class);
 171     return 0 unless defined($class);
 172
 173     return 1 if $class =~ /^\w+(?:::\w+)*$/;
 174
 175     return 0;
 176 }
 177
 178 # taken from Class/MOP.pm
 179 sub load_first_existing_class {
 180     my @classes = @_
 181       or return;
 182
 183     my %exceptions;
 184     for my $class (@classes) {
 185         my $e = _try_load_one_class($class);
 186
 187         if ($e) {
 188             $exceptions{$class} = $e;
 189         }
 190         else {
 191             return $class;
 192         }
 193     }
 194
 195     # not found
 196     confess join(
 197         "\n",
 198         map {
 199             sprintf( "Could not load class (%s) because : %s",
 200                 $_, $exceptions{$_} )
 201           } @classes
 202     );
 203 }
 204
 205 # taken from Class/MOP.pm
 206 my %is_class_loaded_cache;
 207 sub _try_load_one_class {
 208     my $class = shift;
 209
 210     unless ( is_valid_class_name($class) ) {
 211         my $display = defined($class) ? $class : 'undef';
 212         confess "Invalid class name ($display)";
 213     }
 214
 215     return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
 216
 217     my $file = $class . '.pm';
 218     $file =~ s{::}{/}g;
 219
 220     return do {
 221         local $@;
 222         eval { require($file) };
 223         $@;
 224     };
 225 }
 226
 227
 228 sub load_class {
 229     my $class = shift;
 230     my $e = _try_load_one_class($class);
 231     confess "Could not load class ($class) because : $e" if $e;
 232
 233     return 1;
 234 }
 235
 236
 237 sub is_class_loaded {
 238     my $class = shift;
 239
 240     return 0 if ref($class) || !defined($class) || !length($class);
 241
 242     # walk the symbol table tree to avoid autovififying
 243     # \*{${main::}{"Foo::"}} == \*main::Foo::
 244
 245     my $pack = \%::;
 246     foreach my $part (split('::', $class)) {
 247         my $entry = \$pack->{$part . '::'};
 248         return 0 if ref($entry) ne 'GLOB';
 249         $pack = *{$entry}{HASH} or return 0;
 250     }
 251
 252     # check for $VERSION or @ISA
 253     return 1 if exists $pack->{VERSION}
 254              && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
 255     return 1 if exists $pack->{ISA}
 256              && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;
 257
 258     # check for any method
 259     foreach my $name( keys %{$pack} ) {
 260         my $entry = \$pack->{$name};
 261         return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE};
 262     }
 263
 264     # fail
 265     return 0;
 266 }
 267
 268
 269 sub apply_all_roles {
 270     my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift);
 271
 272     my @roles;
 273
 274     # Basis of Data::OptList
 275     my $max = scalar(@_);
 276     for (my $i = 0; $i < $max ; $i++) {
 277         if ($i + 1 < $max && ref($_[$i + 1])) {
 278             push @roles, [ $_[$i++] => $_[$i] ];
 279         } else {
 280             push @roles, [ $_[$i]   => undef ];
 281         }
 282         my $role_name = $roles[-1][0];
 283         load_class($role_name);
 284         ( $role_name->can('meta') && $role_name->meta->isa('Mouse::Meta::Role') )
 285             || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role");
 286     }
 287
 288     if ( scalar @roles == 1 ) {
 289         my ( $role, $params ) = @{ $roles[0] };
 290         $role->meta->apply( $applicant, ( defined $params ? %$params : () ) );
 291     }
 292     else {
 293         Mouse::Meta::Role->combine(@roles)->apply($applicant);
 294     }
 295     return;
 296 }
 297
 298 # taken from Moose::Util 0.90
 299 sub english_list {
 300     return $_[0] if @_ == 1;
 301
 302     my @items = sort @_;
 303
 304     return "$items[0] and $items[1]" if @items == 2;
 305
 306     my $tail = pop @items;
 307
 308     return join q{, }, @items, "and $tail";
 309 }
 310
 311
 312 # common utilities
 313
 314 sub not_supported{
 315     my($feature) = @_;
 316
 317     $feature ||= ( caller(1) )[3]; # subroutine name
 318
 319     local $Carp::CarpLevel = $Carp::CarpLevel + 1;
 320     Carp::confess("Mouse does not currently support $feature");
 321 }
 322
 323 sub meta{
 324     return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
 325 }
 326
 327 sub dump {
 328     my($self, $maxdepth) = @_;
 329
 330     require 'Data/Dumper.pm'; # we don't want to create its namespace
 331     my $dd = Data::Dumper->new([$self]);
 332     $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
 333     $dd->Indent(1);
 334     return $dd->Dump();
 335 }
 336
 337 sub does :method;
 338 *does = \&does_role; # alias
 339
 340 1;
 341
 342 __END__
 343
 344 =head1 NAME
 345
 346 Mouse::Util - Features, with or without their dependencies
 347
 348 =head1 IMPLEMENTATIONS FOR
 349
 350 =head2 Moose::Util
 351
 352 =head3 C<find_meta>
 353
 354 =head3 C<does_role>
 355
 356 =head3 C<resolve_metaclass_alias>
 357
 358 =head3 C<apply_all_roles>
 359
 360 =head3 C<english_list>
 361
 362 =head2 Class::MOP
 363
 364 =head3 C<< is_class_loaded(ClassName) -> Bool >>
 365
 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.
 369
 370 =head3 C<< load_class(ClassName) >>
 371
 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>.
 375
 376 =head3 C<< Mouse::Util::class_of(ClassName or Object) >>
 377
 378 =head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
 379
 380 =head3 C<< Mouse::Util::get_all_metaclass_instances() >>
 381
 382 =head3 C<< Mouse::Util::get_all_metaclass_names() >>
 383
 384 =head2 MRO::Compat
 385
 386 =head3 C<get_linear_isa>
 387
 388 =head2 Sub::Identify
 389
 390 =head3 C<get_code_info>
 391
 392 =head1 UTILITIES FOR MOUSE
 393
 394 =head3 C<not_supported>
 395
 396 =head1 SEE ALSO
 397
 398 L<Moose::Util>
 399
 400 L<Class::MOP>
 401
 402 L<Sub::Identify>
 403
 404 L<MRO::Compat>
 405
 406 =cut
 407