X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=9a34e0caae9386e9e246a445e7f7765acb6522bf;hp=35c117d1acbf2c6163acfe6ae41cd8e7433ceff9;hb=0e81c55d54fbd14fb67d6f22c184df2d0d7059c0;hpb=ea249879d28f5ce42afb95feeb7dcb6d37fcd241 diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index 35c117d..9a34e0c 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,47 +1,68 @@ package Mouse::Util; -use strict; -use warnings; -use base qw/Exporter/; +use Mouse::Exporter; # enables strict and warnings use Carp qw(confess); +use Scalar::Util qw(blessed); use B (); -our @EXPORT_OK = qw( - find_meta - does_role - resolve_metaclass_alias - apply_all_roles - english_list +use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE}; - load_class - is_class_loaded +Mouse::Exporter->setup_import_methods( + as_is => [qw( + find_meta + does_role + resolve_metaclass_alias + apply_all_roles + english_list - get_linear_isa - get_code_info + load_class + is_class_loaded - not_supported -); -our %EXPORT_TAGS = ( - all => \@EXPORT_OK, + get_linear_isa + get_code_info + + get_code_package + + not_supported + + does meta dump + _MOUSE_VERBOSE + )], + groups => { + default => [], # export no functions by default + + # The ':meta' group is 'use metaclass' for Mouse + meta => [qw(does meta dump _MOUSE_VERBOSE)], + }, ); +# aliases as public APIs +# it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util +require Mouse::Meta::Module; # for the entities of metaclass cache utilities + +BEGIN { + *class_of = \&Mouse::Meta::Module::class_of; + *get_metaclass_by_name = \&Mouse::Meta::Module::get_metaclass_by_name; + *get_all_metaclass_instances = \&Mouse::Meta::Module::get_all_metaclass_instances; + *get_all_metaclass_names = \&Mouse::Meta::Module::get_all_metaclass_names; +} + # Moose::Util compatible utilities sub find_meta{ - return Mouse::Meta::Module::class_of( $_[0] ); + return class_of( $_[0] ); } sub does_role{ - my ($class_or_obj, $role) = @_; + my ($class_or_obj, $role_name) = @_; - my $meta = Mouse::Meta::Module::class_of($class_or_obj); - - return 0 unless defined $meta; - return 1 if $meta->does_role($role); - return 0; -} + my $meta = class_of($class_or_obj); + (defined $role_name) + || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()"); + return defined($meta) && $meta->does_role($role_name); +} BEGIN { my $impl; @@ -99,6 +120,18 @@ BEGIN { return ($gv->STASH->NAME, $gv->NAME); } + + sub get_code_package{ + my($coderef) = @_; + + my $cv = B::svref_2object($coderef); + $cv->isa('B::CV') or return ''; + + my $gv = $cv->GV; + $gv->isa('B::GV') or return ''; + + return $gv->STASH->NAME; + } } # taken from Mouse::Util (0.90) @@ -128,6 +161,9 @@ BEGIN { } } +# Utilities from Class::MOP + + # taken from Class/MOP.pm sub is_valid_class_name { my $class = shift; @@ -145,7 +181,6 @@ sub load_first_existing_class { my @classes = @_ or return; - my $found; my %exceptions; for my $class (@classes) { my $e = _try_load_one_class($class); @@ -154,12 +189,11 @@ sub load_first_existing_class { $exceptions{$class} = $e; } else { - $found = $class; - last; + return $class; } } - return $found if $found; + # not found confess join( "\n", map { @@ -170,6 +204,7 @@ sub load_first_existing_class { } # taken from Class/MOP.pm +my %is_class_loaded_cache; sub _try_load_one_class { my $class = shift; @@ -178,7 +213,7 @@ sub _try_load_one_class { confess "Invalid class name ($display)"; } - return if is_class_loaded($class); + return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class); my $file = $class . '.pm'; $file =~ s{::}{/}g; @@ -199,14 +234,12 @@ sub load_class { return 1; } -my %is_class_loaded_cache; + sub is_class_loaded { my $class = shift; return 0 if ref($class) || !defined($class) || !length($class); - return 1 if $is_class_loaded_cache{$class}; - # walk the symbol table tree to avoid autovififying # \*{${main::}{"Foo::"}} == \*main::Foo:: @@ -218,15 +251,15 @@ sub is_class_loaded { } # check for $VERSION or @ISA - return ++$is_class_loaded_cache{$class} if exists $pack->{VERSION} + return 1 if exists $pack->{VERSION} && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} }; - return ++$is_class_loaded_cache{$class} if exists $pack->{ISA} + return 1 if exists $pack->{ISA} && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0; # check for any method foreach my $name( keys %{$pack} ) { my $entry = \$pack->{$name}; - return ++$is_class_loaded_cache{$class} if ref($entry) ne 'GLOB' || defined *{$entry}{CODE}; + return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE}; } # fail @@ -235,7 +268,7 @@ sub is_class_loaded { sub apply_all_roles { - my $meta = Mouse::Meta::Class->initialize(shift); + my $applicant = blessed($_[0]) ? shift : Mouse::Meta::Class->initialize(shift); my @roles; @@ -243,22 +276,24 @@ sub apply_all_roles { my $max = scalar(@_); for (my $i = 0; $i < $max ; $i++) { if ($i + 1 < $max && ref($_[$i + 1])) { - push @roles, [ $_[$i++] => $_[$i] ]; + push @roles, [ $_[$i] => $_[++$i] ]; } else { - push @roles, [ $_[$i] => {} ]; + push @roles, [ $_[$i] => undef ]; } my $role_name = $roles[-1][0]; load_class($role_name); - ( $role_name->can('meta') && $role_name->meta->isa('Mouse::Meta::Role') ) - || $meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role"); + + my $metarole = get_metaclass_by_name($role_name); + ( $metarole && $metarole->isa('Mouse::Meta::Role') ) + || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role"); } if ( scalar @roles == 1 ) { - my ( $role, $params ) = @{ $roles[0] }; - $role->meta->apply( $meta, ( defined $params ? %$params : () ) ); + my ( $role_name, $params ) = @{ $roles[0] }; + get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () ); } else { - Mouse::Meta::Role->combine_apply($meta, @roles); + Mouse::Meta::Role->combine(@roles)->apply($applicant); } return; } @@ -276,6 +311,9 @@ sub english_list { return join q{, }, @items, "and $tail"; } + +# common utilities + sub not_supported{ my($feature) = @_; @@ -285,13 +323,37 @@ sub not_supported{ Carp::confess("Mouse does not currently support $feature"); } +# general meta() method +sub meta :method{ + return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]); +} + +# general dump() method +sub dump :method { + my($self, $maxdepth) = @_; + + require 'Data/Dumper.pm'; # we don't want to create its namespace + my $dd = Data::Dumper->new([$self]); + $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2); + $dd->Indent(1); + return $dd->Dump(); +} + +# general does() method +sub does :method; +*does = \&does_role; # alias + 1; __END__ =head1 NAME -Mouse::Util - features, with or without their dependencies +Mouse::Util - Features, with or without their dependencies + +=head1 VERSION + +This document describes Mouse version 0.40 =head1 IMPLEMENTATIONS FOR @@ -309,9 +371,25 @@ Mouse::Util - features, with or without their dependencies =head2 Class::MOP -=head3 C +=head3 C<< is_class_loaded(ClassName) -> Bool >> + +Returns whether C is actually loaded or not. It uses a heuristic which +involves checking for the existence of C<$VERSION>, C<@ISA>, and any +locally-defined method. + +=head3 C<< load_class(ClassName) >> + +This will load a given C (or die if it is not loadable). +This function can be used in place of tricks like +C or using C. -=head3 C +=head3 C<< Mouse::Util::class_of(ClassName or Object) >> + +=head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >> + +=head3 C<< Mouse::Util::get_all_metaclass_instances() >> + +=head3 C<< Mouse::Util::get_all_metaclass_names() >> =head2 MRO::Compat @@ -323,13 +401,17 @@ Mouse::Util - features, with or without their dependencies =head1 UTILITIES FOR MOUSE -=over 4 +=head3 C + +=head1 SEE ALSO + +L -=item * +L -C +L -=back +L =cut