X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=e86da70900972e41507d506579831d270e9556b3;hp=53af4cfd9778d92690774bc86df58814c930056c;hb=0449307510ab4425a6b340fee9bf85824eb994b1;hpb=52c48ad7f7cf12cefee9c6e15ab00289976e342b diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index 53af4cf..e86da70 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,33 +1,73 @@ package Mouse::Util; use strict; use warnings; -use base qw/Exporter/; -use Carp; +use Exporter; + +use Carp qw(confess); + +use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE}; + +our @ISA = qw(Exporter); our @EXPORT_OK = qw( - get_linear_isa + find_meta + does_role + resolve_metaclass_alias apply_all_roles + english_list + + load_class + is_class_loaded + + get_linear_isa + get_code_info + + not_supported + + does meta dump + _MOUSE_VERBOSE ); our %EXPORT_TAGS = ( all => \@EXPORT_OK, + meta => [qw(does meta dump _MOUSE_VERBOSE)], ); +# Moose::Util compatible utilities + +sub find_meta{ + return Mouse::Meta::Module::class_of( $_[0] ); +} + +sub does_role{ + my ($class_or_obj, $role_name) = @_; + + my $meta = Mouse::Meta::Module::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) { require mro; $impl = \&mro::get_linear_isa; } else { - my $loaded = do { - local $SIG{__DIE__} = 'DEFAULT'; - eval { require MRO::Compat; 1 }; + my $e = do { + local $@; + eval { require MRO::Compat }; + $@; }; - if ($loaded) { + if (!$e) { $impl = \&mro::get_linear_isa; } else { # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV - my $code; # this recurses so it isn't pretty - $code = sub { + my $_get_linear_isa_dfs; # this recurses so it isn't pretty + $_get_linear_isa_dfs = sub { no strict 'refs'; my $classname = shift; @@ -35,59 +75,75 @@ BEGIN { my @lin = ($classname); my %stored; foreach my $parent (@{"$classname\::ISA"}) { - my $plin = $code->($parent); - foreach (@$plin) { - next if exists $stored{$_}; - push(@lin, $_); - $stored{$_} = 1; + my $plin = $_get_linear_isa_dfs->($parent); + foreach my $p(@$plin) { + next if exists $stored{$p}; + push(@lin, $p); + $stored{$p} = 1; } } return \@lin; }; # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^ - $impl = $code; + $impl = $_get_linear_isa_dfs; } } - no strict 'refs'; - *{ __PACKAGE__ . '::get_linear_isa'} = $impl; + + no warnings 'once'; + *get_linear_isa = $impl; } -# taken from Class/MOP.pm +{ # taken from Sub::Identify + sub get_code_info($) { + my ($coderef) = @_; + ref($coderef) or return; + + require B; + + 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); + } +} + +# 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; + }; } } # taken from Class/MOP.pm -sub _is_valid_class_name { +sub is_valid_class_name { my $class = shift; return 0 if ref($class); return 0 unless defined($class); - return 0 unless length($class); return 1 if $class =~ /^\w+(?:::\w+)*$/; @@ -99,14 +155,6 @@ sub load_first_existing_class { my @classes = @_ or return; - foreach my $class (@classes) { - unless ( _is_valid_class_name($class) ) { - my $display = defined($class) ? $class : 'undef'; - confess "Invalid class name ($display)"; - } - } - - my $found; my %exceptions; for my $class (@classes) { my $e = _try_load_one_class($class); @@ -115,12 +163,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 { @@ -134,7 +181,12 @@ sub load_first_existing_class { sub _try_load_one_class { my $class = shift; - return if Mouse::is_class_loaded($class); + unless ( is_valid_class_name($class) ) { + my $display = defined($class) ? $class : 'undef'; + confess "Invalid class name ($display)"; + } + + return if is_class_loaded($class); my $file = $class . '.pm'; $file =~ s{::}{/}g; @@ -146,6 +198,50 @@ sub _try_load_one_class { }; } + +sub load_class { + my $class = shift; + my $e = _try_load_one_class($class); + confess "Could not load class ($class) because : $e" if $e; + + 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:: + + my $pack = \%::; + foreach my $part (split('::', $class)) { + my $entry = \$pack->{$part . '::'}; + return 0 if ref($entry) ne 'GLOB'; + $pack = *{$entry}{HASH} or return 0; + } + + # check for $VERSION or @ISA + return ++$is_class_loaded_cache{$class} if exists $pack->{VERSION} + && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} }; + return ++$is_class_loaded_cache{$class} 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}; + } + + # fail + return 0; +} + + sub apply_all_roles { my $meta = Mouse::Meta::Class->initialize(shift); @@ -157,20 +253,14 @@ 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"); } - foreach my $role_spec (@roles) { - Mouse::load_class( $role_spec->[0] ); - } - - ( $_->[0]->can('meta') && $_->[0]->meta->isa('Mouse::Meta::Role') ) - || croak("You can only consume roles, " - . $_->[0] - . " is not a Moose role") - foreach @roles; - if ( scalar @roles == 1 ) { my ( $role, $params ) = @{ $roles[0] }; $role->meta->apply( $meta, ( defined $params ? %$params : () ) ); @@ -178,9 +268,51 @@ sub apply_all_roles { else { Mouse::Meta::Role->combine_apply($meta, @roles); } + 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 + 1; + Carp::confess("Mouse does not currently support $feature"); +} + +sub meta{ + return Mouse::Meta::Class->initialize($_[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__ @@ -191,9 +323,59 @@ 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 + +=head2 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's not loadable). +This function can be used in place of tricks like +C or using C. + +=head2 MRO::Compat + +=head3 C + +=head2 Sub::Identify + +=head3 C + +=head1 UTILITIES FOR MOUSE + +=over 4 + +=item * + +C + +=back + +=head1 SEE ALSO + +L + +L + +L -=head3 get_linear_isa +L =cut