X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=5f5d8de149119a2b807f6711b749e143651fc2d4;hp=bcb865eae420e12d0c4ef64330062fa45c7c9f1a;hb=2d2e77f983e8a758e5a19b74e30c8c7ba29863b8;hpb=ff6870694bb440c13826e0f0fa25e760247fd24e diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index bcb865e..5f5d8de 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,22 +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( - load_class - is_class_loaded - get_linear_isa - apply_all_roles - get_code_info - not_supported -); -our %EXPORT_TAGS = ( - all => \@EXPORT_OK, +use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE}; + +Mouse::Exporter->setup_import_methods( + as_is => [qw( + find_meta + does_role + resolve_metaclass_alias + apply_all_roles + english_list + + load_class + is_class_loaded + + get_linear_isa + get_code_info + + get_code_package + + not_supported + + does meta dump + _MOUSE_VERBOSE + )], + groups => { + default => [], # export no functions by default + meta => [qw(does meta dump _MOUSE_VERBOSE)], + }, + _export_to_main => 1, ); +# 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 class_of( $_[0] ); +} + +sub does_role{ + my ($class_or_obj, $role_name) = @_; + + 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; if ($] >= 5.009_005) { @@ -61,48 +107,62 @@ BEGIN { } { # taken from Sub::Identify - sub get_code_info($) { - my ($coderef) = @_; - ref($coderef) or return; + sub get_code_info($) { + my ($coderef) = @_; + ref($coderef) or return; - my $cv = B::svref_2object($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, $gv->NAME); - } + my $gv = $cv->GV; + $gv->isa('B::GV') or return; + + 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 Class/MOP.pm +# taken from Mouse::Util (0.90) { my %cache; sub resolve_metaclass_alias { my ( $type, $metaclass_name, %options ) = @_; - my $cache_key = $type; - return $cache{$cache_key}{$metaclass_name} - if $cache{$cache_key}{$metaclass_name}; + my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' ); - my $possible_full_name = - 'Mouse::Meta::' - . $type - . '::Custom::' - . $metaclass_name; + return $cache{$cache_key}{$metaclass_name} ||= do{ - my $loaded_class = - load_first_existing_class( $possible_full_name, - $metaclass_name ); + my $possible_full_name = join '::', + 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name + ; + + my $loaded_class = load_first_existing_class( + $possible_full_name, + $metaclass_name + ); - return $cache{$cache_key}{$metaclass_name} = $loaded_class->can('register_implementation') - ? $loaded_class->register_implementation - : $loaded_class; + ? $loaded_class->register_implementation + : $loaded_class; + }; } } +# Utilities from Class::MOP + + # taken from Class/MOP.pm sub is_valid_class_name { my $class = shift; @@ -120,7 +180,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); @@ -129,12 +188,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 { @@ -145,6 +203,7 @@ sub load_first_existing_class { } # taken from Class/MOP.pm +my %is_class_loaded_cache; sub _try_load_one_class { my $class = shift; @@ -153,7 +212,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; @@ -174,14 +233,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:: @@ -193,15 +250,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 @@ -210,7 +267,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; @@ -220,46 +277,131 @@ sub apply_all_roles { if ($i + 1 < $max && ref($_[$i + 1])) { 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"); + || $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 : () ) ); + $role->meta->apply( $applicant, ( defined $params ? %$params : () ) ); } else { - Mouse::Meta::Role->combine_apply($meta, @roles); + Mouse::Meta::Role->combine(@roles)->apply($applicant); } return; } +# taken from Moose::Util 0.90 +sub english_list { + return $_[0] if @_ == 1; + + my @items = sort @_; + + return "$items[0] and $items[1]" if @items == 2; + + my $tail = pop @items; + + return join q{, }, @items, "and $tail"; +} + + +# common utilities + sub not_supported{ my($feature) = @_; $feature ||= ( caller(1) )[3]; # subroutine name - local $Carp::CarpLevel = $Carp::CarpLevel + 2; - Carp::croak("Mouse does not currently support $feature"); + local $Carp::CarpLevel = $Carp::CarpLevel + 1; + Carp::confess("Mouse does not currently support $feature"); } +sub meta{ + return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]); +} + +sub dump { + 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(); +} + +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 IMPLEMENTATIONS FOR -=head2 L +=head2 Moose::Util + +=head3 C + +=head3 C + +=head3 C + +=head3 C + +=head3 C + +=head2 Class::MOP + +=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<< 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 + +=head3 C + +=head2 Sub::Identify + +=head3 C + +=head1 UTILITIES FOR MOUSE + +=head3 C + +=head1 SEE ALSO + +L + +L + +L -=head3 get_linear_isa +L =cut