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=e080bf4c76de2e2057c407fafd5800ecd7098389;hb=0e81c55d54fbd14fb67d6f22c184df2d0d7059c0;hpb=2131374167521ba8734014e5f8b8d439c5d68cba diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index e080bf4..9a34e0c 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,64 +1,86 @@ -#!/usr/bin/env perl package Mouse::Util; -use strict; -use warnings; -use Exporter 'import'; -use Carp; - -our @EXPORT_OK = qw( - blessed - get_linear_isa - looks_like_number - openhandle - reftype - weaken -); -our %EXPORT_TAGS = ( - all => \@EXPORT_OK, +use Mouse::Exporter; # enables strict and warnings + +use Carp qw(confess); +use Scalar::Util qw(blessed); +use B (); + +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 + + # The ':meta' group is 'use metaclass' for Mouse + meta => [qw(does meta dump _MOUSE_VERBOSE)], + }, ); -# We only have to do this nastiness if we haven't loaded XS version of -# Mouse.pm, so check if we're running under PurePerl or not +# 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 { - if ($Mouse::PurePerl) { - _install_pp_func(); - } else { - # If we're running under XS, we can provide - # blessed - # looks_like_number - # reftype - # weaken - # other functions need to be loaded from our respective sources - - if (defined &Scalar::Util::openhandle || eval { require Scalar::Util; 1 }) { - *openhandle = \&Scalar::Util::openhandle; - } else { - # XXX - room for improvement - *openhandle = sub { - my $fh = shift; - my $rt = reftype($fh) || ''; + *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; +} - return defined(fileno($fh)) ? $fh : undef - if $rt eq 'IO'; +# Moose::Util compatible utilities - if (reftype(\$fh) eq 'GLOB') { # handle openhandle(*DATA) - $fh = \(my $tmp=$fh); - } - elsif ($rt ne 'GLOB') { - return undef; - } +sub find_meta{ + return class_of( $_[0] ); +} - (tied(*$fh) or defined(fileno($fh))) - ? $fh : undef; - }; - } +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()"); - if (defined &mro::get_linear_isa || eval { require MRO::Compat; 1; }) { - *get_linear_isa = \&mro::get_linear_isa; + 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 { - # this recurses so it isn't pretty - my $code; - *get_linear_isa = $code = sub { +# VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV + my $_get_linear_isa_dfs; # this recurses so it isn't pretty + $_get_linear_isa_dfs = sub { no strict 'refs'; my $classname = shift; @@ -66,209 +88,330 @@ 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 = $_get_linear_isa_dfs; } } + + + no warnings 'once'; + *get_linear_isa = $impl; } -sub _install_pp_func { - my %dependencies = ( - 'Scalar::Util' => { -# VVVVV CODE TAKEN FROM SCALAR::UTIL VVVVV - 'blessed' => do { - *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; - }; - - 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) || ''; +{ # taken from Sub::Identify + sub get_code_info($) { + my ($coderef) = @_; + ref($coderef) or return; - return defined(fileno($fh)) ? $fh : undef - if $rt eq 'IO'; + my $cv = B::svref_2object($coderef); + $cv->isa('B::CV') or return; - if (reftype(\$fh) eq 'GLOB') { # handle openhandle(*DATA) - $fh = \(my $tmp=$fh); - } - elsif ($rt ne 'GLOB') { - return undef; - } + my $gv = $cv->GV; + $gv->isa('B::GV') or return; - (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' => { -# 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; - } - } - return \@lin; - } - }, - }, -# ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^ - }, - ); + 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) +{ + 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 %loaded; - for my $module_name (keys %dependencies) { - my $loaded = do { - local $SIG{__DIE__} = 'DEFAULT'; - eval "require $module_name; 1"; + 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; }; + } +} + +# Utilities from Class::MOP + + +# taken from Class/MOP.pm +sub is_valid_class_name { + my $class = shift; + + return 0 if ref($class); + return 0 unless defined($class); - $loaded{$module_name} = $loaded; - - for my $method_name (keys %{ $dependencies{ $module_name } }) { - my $producer = $dependencies{$module_name}{$method_name}; - my $implementation; - - if (ref($producer) eq 'HASH') { - $implementation = $loaded - ? $producer->{loaded} - : $producer->{not_loaded}; - } - else { - $implementation = $loaded - ? $module_name->can($method_name) - : $producer; - } - - no strict 'refs'; - *{ __PACKAGE__ . '::' . $method_name } = $implementation; + 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 { + return $class; } } + + # not found + confess join( + "\n", + map { + sprintf( "Could not load class (%s) because : %s", + $_, $exceptions{$_} ) + } @classes + ); } +# taken from Class/MOP.pm +my %is_class_loaded_cache; +sub _try_load_one_class { + my $class = shift; + + unless ( is_valid_class_name($class) ) { + my $display = defined($class) ? $class : 'undef'; + confess "Invalid class name ($display)"; + } + + return undef if $is_class_loaded_cache{$class} ||= 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; +} + + +sub is_class_loaded { + my $class = shift; + + return 0 if ref($class) || !defined($class) || !length($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 1 if exists $pack->{VERSION} + && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} }; + 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 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE}; + } + + # fail + return 0; +} + + sub apply_all_roles { - my $meta = Mouse::Meta::Class->initialize(shift); - my $role = shift; - confess "Mouse::Util only supports 'apply_all_roles' on individual roles at a time" if @_; + my $applicant = blessed($_[0]) ? shift : 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] => undef ]; + } + my $role_name = $roles[-1][0]; + load_class($role_name); + + 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"); + } - Mouse::load_class($role); - $role->meta->apply($meta); + if ( scalar @roles == 1 ) { + my ( $role_name, $params ) = @{ $roles[0] }; + get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () ); + } + else { + 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 + 1; + 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 -=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() >> -=head3 get_linear_isa +=head2 MRO::Compat -=head2 L +=head3 C -=head3 blessed +=head2 Sub::Identify -=head3 looks_like_number +=head3 C -=head3 reftype +=head1 UTILITIES FOR MOUSE -=head3 openhandle +=head3 C -=head3 weaken +=head1 SEE ALSO -C I be implemented in XS. If the user tries to use C -without L, an error is thrown. +L -=head2 Test::Exception +L -=head3 throws_ok +L -=head3 lives_ok +L =cut