X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=0e4d8652ecd184ba3dcd3e758ec9c822e729f4f4;hp=625ed4eb4d07dff733e13c597efc69abcd59cbfd;hb=1820fffecb0bd1da64edc16ecde534178b841d14;hpb=577be3900a87552be0c16d354f2302ef7030cc2c diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index 625ed4e..0e4d865 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,159 +1,375 @@ -#!/usr/bin/env perl package Mouse::Util; use strict; use warnings; -use base 'Exporter'; +use base qw/Exporter/; -our %dependencies = ( - 'Scalar::Util' => { +use Carp qw(confess); +use B (); -# VVVVV CODE TAKEN FROM SCALAR::UTIL VVVVV - 'blessed' => do { - do { - no strict 'refs'; - *UNIVERSAL::a_sub_not_likely_to_be_here = sub { - my $ref = ref($_[0]); - - # deviation from Scalar::Util - # XS returns undef, PP returns GLOB. - # let's make that more consistent by having PP return - # undef if it's a GLOB. :/ - - # \*STDOUT would be allowed as an object in PP blessed - # but not XS - return $ref eq 'GLOB' ? undef : $ref; - }; - }; +our @EXPORT_OK = qw( + find_meta + does_role + resolve_metaclass_alias + apply_all_roles + english_list - sub { - local($@, $SIG{__DIE__}, $SIG{__WARN__}); - length(ref($_[0])) - ? eval { $_[0]->a_sub_not_likely_to_be_here } - : undef; - }, - }, - 'looks_like_number' => sub { - local $_ = shift; - - # checks from perlfaq4 - return 0 if !defined($_) or ref($_); - return 1 if (/^[+-]?\d+$/); # is a +/- integer - return 1 if (/^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/); # a C float - return 1 if ($] >= 5.008 and /^(Inf(inity)?|NaN)$/i) or ($] >= 5.006001 and /^Inf$/i); - - 0; - }, - 'reftype' => sub { - local($@, $SIG{__DIE__}, $SIG{__WARN__}); - my $r = shift; - my $t; - - length($t = ref($r)) or return undef; - - # This eval will fail if the reference is not blessed - eval { $r->a_sub_not_likely_to_be_here; 1 } - ? do { - $t = eval { - # we have a GLOB or an IO. Stringify a GLOB gives it's name - my $q = *$r; - $q =~ /^\*/ ? "GLOB" : "IO"; - } - or do { - # OK, if we don't have a GLOB what parts of - # a glob will it populate. - # NOTE: A glob always has a SCALAR - local *glob = $r; - defined *glob{ARRAY} && "ARRAY" - or defined *glob{HASH} && "HASH" - or defined *glob{CODE} && "CODE" - or length(ref(${$r})) ? "REF" : "SCALAR"; - } - } - : $t - }, - 'openhandle' => sub { - my $fh = shift; - my $rt = reftype($fh) || ''; - - return defined(fileno($fh)) ? $fh : undef - if $rt eq 'IO'; - - if (reftype(\$fh) eq 'GLOB') { # handle openhandle(*DATA) - $fh = \(my $tmp=$fh); - } - elsif ($rt ne 'GLOB') { - return undef; - } - - (tied(*$fh) or defined(fileno($fh))) - ? $fh : undef; - }, - weaken => { - loaded => \&Scalar::Util::weaken, - not_loaded => sub { die "Scalar::Util required for weak reference support" }, - }, -# ^^^^^ CODE TAKEN FROM SCALAR::UTIL ^^^^^ - }, - 'MRO::Compat' => { + load_class + is_class_loaded + + get_linear_isa + get_code_info + + not_supported + + does meta dump +); +our %EXPORT_TAGS = ( + all => \@EXPORT_OK, + meta => [qw(does meta dump)], +); + +# 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 $e = do { + local $@; + eval { require MRO::Compat }; + $@; + }; + if (!$e) { + $impl = \&mro::get_linear_isa; + } else { # VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV - 'get_linear_isa' => { - loaded => \&mro::get_linear_isa, - not_loaded => do { - # this recurses so it isn't pretty - my $code; - $code = sub { - no strict 'refs'; - - my $classname = shift; - - 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 $_get_linear_isa_dfs; # this recurses so it isn't pretty + $_get_linear_isa_dfs = sub { + no strict 'refs'; + + my $classname = shift; + + my @lin = ($classname); + my %stored; + foreach my $parent (@{"$classname\::ISA"}) { + my $plin = $_get_linear_isa_dfs->($parent); + foreach my $p(@$plin) { + next if exists $stored{$p}; + push(@lin, $p); + $stored{$p} = 1; } - return \@lin; } - }, - }, + return \@lin; + }; # ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^ - }, -); + $impl = $_get_linear_isa_dfs; + } + } -our @EXPORT_OK = map { keys %$_ } values %dependencies; -for my $module_name (keys %dependencies) { - (my $file = "$module_name.pm") =~ s{::}{/}g; + no warnings 'once'; + *get_linear_isa = $impl; +} - my $loaded = do { - local $SIG{__DIE__} = 'DEFAULT'; - eval "require '$file'; 1"; - }; +{ # taken from Sub::Identify + sub get_code_info($) { + my ($coderef) = @_; + ref($coderef) or return; - for my $method_name (keys %{ $dependencies{ $module_name } }) { - my $producer = $dependencies{$module_name}{$method_name}; - my $implementation; + 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); + } +} - if (ref($producer) eq 'HASH') { - $implementation = $loaded - ? $producer->{loaded} - : $producer->{not_loaded}; +# taken from Mouse::Util (0.90) +{ + my %cache; + + sub resolve_metaclass_alias { + my ( $type, $metaclass_name, %options ) = @_; + + my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' ); + + return $cache{$cache_key}{$metaclass_name} ||= do{ + + 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 + ); + + $loaded_class->can('register_implementation') + ? $loaded_class->register_implementation + : $loaded_class; + }; + } +} + +# taken from Class/MOP.pm +sub is_valid_class_name { + my $class = shift; + + return 0 if ref($class); + return 0 unless defined($class); + + return 1 if $class =~ /^\w+(?:::\w+)*$/; + + return 0; +} + +# taken from Class/MOP.pm +sub load_first_existing_class { + my @classes = @_ + or return; + + my %exceptions; + for my $class (@classes) { + my $e = _try_load_one_class($class); + + if ($e) { + $exceptions{$class} = $e; } else { - $implementation = $loaded - ? $module_name->can($method_name) - : $producer; + return $class; } + } + + # not found + confess join( + "\n", + map { + sprintf( "Could not load class (%s) because : %s", + $_, $exceptions{$_} ) + } @classes + ); +} + +# taken from Class/MOP.pm +sub _try_load_one_class { + my $class = shift; - no strict 'refs'; - *{ __PACKAGE__ . '::' . $method_name } = $implementation; + 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; + + return do { + local $@; + eval { require($file) }; + $@; + }; } +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); + + my @roles; + + # Basis of Data::OptList + my $max = scalar(@_); + for (my $i = 0; $i < $max ; $i++) { + if ($i + 1 < $max && ref($_[$i + 1])) { + push @roles, [ $_[$i++] => $_[$i] ]; + } else { + push @roles, [ $_[$i] => {} ]; + } + 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"); + } + + if ( scalar @roles == 1 ) { + my ( $role, $params ) = @{ $roles[0] }; + $role->meta->apply( $meta, ( defined $params ? %$params : () ) ); + } + 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__ + +=head1 NAME + +Mouse::Util - features, with or without their dependencies + +=head1 IMPLEMENTATIONS FOR + +=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 + +L + +=cut +