X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=393bccf9940732a68df841d3c9234356f263be2b;hb=823419c540f9e77090f31f11e04b14477c0372c4;hp=8afb940c8b3ff501c3f94b4d3a82ceb7187a11ab;hpb=2b68f76d78d96325821e9a6360c3639f8c5637df;p=gitmo%2FMouse.git diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index 8afb940..393bccf 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,80 +1,113 @@ package Mouse::Util; use Mouse::Exporter; # enables strict and warnings -BEGIN{ - # Because Mouse::Util is loaded first in all the Mouse sub-modules, - # XS loader is placed here, not in Mouse.pm. +# must be here because it will be refered by other modules loaded +sub get_linear_isa($;$); ## no critic + +# must be here because it will called in Mouse::Exporter +sub install_subroutines { + my $into = shift; + + while(my($name, $code) = splice @_, 0, 2){ + no strict 'refs'; + no warnings 'once', 'redefine'; + use warnings FATAL => 'uninitialized'; + *{$into . '::' . $name} = \&{$code}; + } + return; +} - our $VERSION = '0.40_03'; +BEGIN{ + # This is used in Mouse::PurePerl + 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 + get_code_ref + + not_supported + + does meta throw_error dump + )], + groups => { + default => [], # export no functions by default + + # The ':meta' group is 'use metaclass' for Mouse + meta => [qw(does meta dump throw_error)], + }, + ); - my $need_pp = !!$ENV{MOUSE_PUREPERL}; + our $VERSION = '0.70'; - if(!$need_pp && !exists $INC{'Mouse/PurePerl.pm'}){ - local $@; + my $xs = !(defined(&is_valid_class_name) || $ENV{MOUSE_PUREPERL} || $ENV{PERL_ONLY}); + # Because Mouse::Util is loaded first in all the Mouse sub-modules, + # XSLoader must be placed here, not in Mouse.pm. + if($xs){ # XXX: XSLoader tries to get the object path from caller's file name # $hack_mouse_file fools its mechanism - (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm - $need_pp = !eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{ + $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{ + local $^W = 0; # workaround 'redefine' warning to &install_subroutines require XSLoader; XSLoader::load('Mouse', $VERSION); - }; - #warn $@ if $@; + Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta'); + Mouse::Util->import({ into => 'Mouse::Meta::Method::Destructor::XS' }, ':meta'); + Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta'); + return 1; + } || 0; + warn $@ if $@ && $ENV{MOUSE_XS}; } - if($need_pp){ + if(!$xs){ require 'Mouse/PurePerl.pm'; # we don't want to create its namespace } -} + *MOUSE_XS = sub(){ $xs }; +} use Carp (); use Scalar::Util (); -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 - get_code_ref - - 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; +# aliases +{ + *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; + + *Mouse::load_class = \&load_class; + *Mouse::is_class_loaded = \&is_class_loaded; + + # is-a predicates + #generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint'); + #generate_isa_predicate_for('Mouse::Meta::Class' => 'is_a_metaclass'); + #generate_isa_predicate_for('Mouse::Meta::Role' => 'is_a_metarole'); + + # duck type predicates + generate_can_predicate_for(['_compiled_type_constraint'] => 'is_a_type_constraint'); + generate_can_predicate_for(['create_anon_class'] => 'is_a_metaclass'); + generate_can_predicate_for(['create_anon_role'] => 'is_a_metarole'); } +our $in_global_destruction = 0; +END{ $in_global_destruction = 1 } + # Moose::Util compatible utilities sub find_meta{ @@ -93,46 +126,56 @@ sub does_role{ } BEGIN { - my $impl; + my $get_linear_isa; if ($] >= 5.009_005) { require mro; - $impl = \&mro::get_linear_isa; + $get_linear_isa = \&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 - 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; - } + # this code is based on MRO::Compat::__get_linear_isa + my $_get_linear_isa_dfs; # this recurses so it isn't pretty + $_get_linear_isa_dfs = sub { + my($classname) = @_; + + my @lin = ($classname); + my %stored; + + no strict 'refs'; + foreach my $parent (@{"$classname\::ISA"}) { + foreach my $p(@{ $_get_linear_isa_dfs->($parent) }) { + next if exists $stored{$p}; + push(@lin, $p); + $stored{$p} = 1; } - return \@lin; - }; -# ^^^^^ CODE TAKEN FROM MRO::COMPAT ^^^^^ - $impl = $_get_linear_isa_dfs; + } + return \@lin; + }; + + { + package # hide from PAUSE + Class::C3; + our %MRO; # avoid 'once' warnings } - } + # MRO::Compat::__get_linear_isa has no prototype, so + # we define a prototyped version for compatibility with core's + # See also MRO::Compat::__get_linear_isa. + $get_linear_isa = sub ($;$){ + my($classname, $type) = @_; + + if(!defined $type){ + $type = exists $Class::C3::MRO{$classname} ? 'c3' : 'dfs'; + } + if($type eq 'c3'){ + require Class::C3; + return [Class::C3::calculateMRO($classname)]; + } + else{ + return $_get_linear_isa_dfs->($classname); + } + }; + } - no warnings 'once'; - *get_linear_isa = $impl; + *get_linear_isa = $get_linear_isa; } @@ -168,17 +211,7 @@ BEGIN { sub get_code_info; sub get_code_package; -# 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; -} +sub is_valid_class_name; # taken from Class/MOP.pm sub load_first_existing_class { @@ -208,7 +241,6 @@ sub load_first_existing_class { } # taken from Class/MOP.pm -my %is_class_loaded_cache; sub _try_load_one_class { my $class = shift; @@ -217,14 +249,14 @@ sub _try_load_one_class { Carp::confess "Invalid class name ($display)"; } - return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class); + return '' if is_class_loaded($class); - my $file = $class . '.pm'; - $file =~ s{::}{/}g; + $class =~ s{::}{/}g; + $class .= '.pm'; return do { local $@; - eval { require($file) }; + eval { require $class }; $@; }; } @@ -235,14 +267,13 @@ sub load_class { my $e = _try_load_one_class($class); Carp::confess "Could not load class ($class) because : $e" if $e; - return 1; + return $class; } sub is_class_loaded; - sub apply_all_roles { - my $applicant = Scalar::Util::blessed($_[0]) + my $consumer = Scalar::Util::blessed($_[0]) ? shift # instance : Mouse::Meta::Class->initialize(shift); # class or role name @@ -259,16 +290,16 @@ sub apply_all_roles { my $role_name = $roles[-1][0]; load_class($role_name); - Mouse::Util::TypeConstraints::_is_a_metarole( get_metaclass_by_name($role_name) ) - || $applicant->meta->throw_error("You can only consume roles, $role_name(".$role_name->meta.") is not a Mouse role"); + is_a_metarole( get_metaclass_by_name($role_name) ) + || $consumer->meta->throw_error("You can only consume roles, $role_name is not a Mouse role"); } if ( scalar @roles == 1 ) { my ( $role_name, $params ) = @{ $roles[0] }; - get_metaclass_by_name($role_name)->apply( $applicant, defined $params ? $params : () ); + get_metaclass_by_name($role_name)->apply( $consumer, defined $params ? $params : () ); } else { - Mouse::Meta::Role->combine(@roles)->apply($applicant); + Mouse::Meta::Role->combine(@roles)->apply($consumer); } return; } @@ -286,6 +317,9 @@ sub english_list { return join q{, }, @items, "and $tail"; } +sub quoted_english_list { + return english_list(map { qq{'$_'} } @_); +} # common utilities @@ -303,68 +337,102 @@ sub meta :method{ return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]); } +# general throw_error() method +# $o->throw_error($msg, depth => $leve, longmess => $croak_or_confess) +sub throw_error :method { + my($self, $message, %args) = @_; + + local $Carp::CarpLevel = $Carp::CarpLevel + 1 + ($args{depth} || 0); + local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though + + if(exists $args{longmess} && !$args{longmess}) { + Carp::croak($message); + } + else{ + Carp::confess($message); + } +} + # 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->Maxdepth(defined($maxdepth) ? $maxdepth : 3); $dd->Indent(1); + $dd->Sortkeys(1); + $dd->Quotekeys(0); return $dd->Dump(); } # general does() method -sub does :method; -*does = \&does_role; # alias +sub does :method { + goto &does_role; +} 1; - __END__ =head1 NAME -Mouse::Util - Features, with or without their dependencies +Mouse::Util - Utilities for working with Mouse classes =head1 VERSION -This document describes Mouse version 0.40_03 +This document describes Mouse version 0.70 + +=head1 SYNOPSIS + + use Mouse::Util; # turns on strict and warnings + +=head1 DESCRIPTION + +This module provides a set of utility functions. Many of these +functions are intended for use in Mouse itself or MouseX modules, but +some of them may be useful for use in your own code. =head1 IMPLEMENTATIONS FOR -=head2 Moose::Util +=head2 Moose::Util functions + +The following functions are exportable. + +=head3 C -=head3 C +The same as C. -=head3 C +=head3 C -=head3 C +=head3 C -=head3 C +=head3 C -=head3 C +=head3 C -=head2 Class::MOP +=head2 Class::MOP functions -=head3 C<< is_class_loaded(ClassName) -> Bool >> +The following functions are not exportable. -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<< Mouse::Util::is_class_loaded($classname) -> Bool >> -=head3 C<< load_class(ClassName) >> +Returns whether I<$classname> 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. -This will load a given C (or die if it is not loadable). +=head3 C<< Mouse::Util::load_class($classname) -> ClassName >> + +This will load a given I<$classname> (or die if it is not loadable). This function can be used in place of tricks like -C or using C. +C or using C. -=head3 C<< Mouse::Util::class_of(ClassName or Object) >> +=head3 C<< Mouse::Util::class_of($classname_or_object) -> MetaClass >> -=head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >> +=head3 C<< Mouse::Util::get_metaclass_by_name($classname) -> MetaClass >> -=head3 C<< Mouse::Util::get_all_metaclass_instances() >> +=head3 C<< Mouse::Util::get_all_metaclass_instances() -> (MetaClasses) >> -=head3 C<< Mouse::Util::get_all_metaclass_names() >> +=head3 C<< Mouse::Util::get_all_metaclass_names() -> (ClassNames) >> =head2 MRO::Compat @@ -374,10 +442,14 @@ C or using C. =head3 C -=head1 UTILITIES FOR MOUSE +=head1 Mouse specific utilities =head3 C +=head3 C + +=head3 C + =head1 SEE ALSO L