X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMouse%2FUtil.pm;h=1f5ed413f51482380ece419f2fbf8da02d250f4f;hb=983d58a5ea543a21c48cb04311883f1b36de1874;hp=dfceb14a58ad63598aee96a3130ef2cf9ae55254;hpb=913b59645bf5e7f16128c0e20711090a43676096;p=gitmo%2FMouse.git diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm index dfceb14..1f5ed41 100644 --- a/lib/Mouse/Util.pm +++ b/lib/Mouse/Util.pm @@ -1,6 +1,8 @@ package Mouse::Util; use Mouse::Exporter; # enables strict and warnings +# Note that those which don't exist here are defined in XS or Mouse::PurePerl + # must be here because it will be refered by other modules loaded sub get_linear_isa($;$); ## no critic @@ -38,31 +40,28 @@ BEGIN{ not_supported - does meta dump + 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)], + meta => [qw(does meta dump throw_error)], }, ); + our $VERSION = '0.94'; - # Because Mouse::Util is loaded first in all the Mouse sub-modules, - # XS loader is placed here, not in Mouse.pm. - - our $VERSION = '0.61'; - - my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL}); + 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 $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{ - local $^W = 0; # work around 'redefine' warning to &install_subroutines + local $^W = 0; # workaround 'redefine' warning to &install_subroutines require XSLoader; XSLoader::load('Mouse', $VERSION); Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta'); @@ -70,7 +69,7 @@ BEGIN{ Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta'); return 1; } || 0; - #warn $@ if $@; + warn $@ if $@ && $ENV{MOUSE_XS}; } if(!$xs){ @@ -78,62 +77,14 @@ BEGIN{ } *MOUSE_XS = sub(){ $xs }; -} - -use Carp (); -use Scalar::Util (); - -# 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 - -# 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{ - 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 { + # definition of mro::get_linear_isa() my $get_linear_isa; - if ($] >= 5.009_005) { + if ($] >= 5.010_000) { require mro; $get_linear_isa = \&mro::get_linear_isa; - } else { + } + else { # 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 { @@ -156,7 +107,7 @@ BEGIN { { package # hide from PAUSE Class::C3; - our %MRO; # work around 'once' warnings + our %MRO; # avoid 'once' warnings } # MRO::Compat::__get_linear_isa has no prototype, so @@ -181,6 +132,53 @@ BEGIN { *get_linear_isa = $get_linear_isa; } +use Carp (); +use Scalar::Util (); + +# 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 + +# 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{ + 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); +} # taken from Mouse::Util (0.90) { @@ -215,6 +213,7 @@ sub get_code_info; sub get_code_package; sub is_valid_class_name; +sub is_class_loaded; # taken from Class/MOP.pm sub load_first_existing_class { @@ -273,33 +272,40 @@ sub load_class { return $class; } -sub is_class_loaded; sub apply_all_roles { my $consumer = Scalar::Util::blessed($_[0]) - ? shift # instance - : Mouse::Meta::Class->initialize(shift); # class or role name + ? $_[0] # instance + : Mouse::Meta::Class->initialize($_[0]); # class or role name 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 ]; + for (my $i = 1; $i < $max ; $i++) { + my $role = $_[$i]; + my $role_name; + if(ref $role) { + $role_name = $role->name; + } + else { + $role_name = $role; + load_class($role_name); + $role = get_metaclass_by_name($role_name); } - my $role_name = $roles[-1][0]; - load_class($role_name); - is_a_metarole( get_metaclass_by_name($role_name) ) + if ($i + 1 < $max && ref($_[$i + 1]) eq 'HASH') { + push @roles, [ $role => $_[++$i] ]; + } else { + push @roles, [ $role => undef ]; + } + is_a_metarole($role) || $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( $consumer, defined $params ? $params : () ); + my ( $role, $params ) = @{ $roles[0] }; + $role->apply( $consumer, defined $params ? $params : () ); } else { Mouse::Meta::Role->combine(@roles)->apply($consumer); @@ -329,7 +335,7 @@ sub quoted_english_list { sub not_supported{ my($feature) = @_; - $feature ||= ( caller(1) )[3]; # subroutine name + $feature ||= ( caller(1) )[3] . '()'; # subroutine name local $Carp::CarpLevel = $Carp::CarpLevel + 1; Carp::confess("Mouse does not currently support $feature"); @@ -340,6 +346,22 @@ 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) = @_; @@ -348,6 +370,8 @@ sub dump :method { my $dd = Data::Dumper->new([$self]); $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3); $dd->Indent(1); + $dd->Sortkeys(1); + $dd->Quotekeys(0); return $dd->Dump(); } @@ -361,49 +385,65 @@ __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.61 +This document describes Mouse version 0.94 + +=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 -=head3 C +The same as C. -=head3 C +=head3 C -=head3 C +=head3 C -=head3 C +=head3 C -=head2 Class::MOP +=head3 C -=head3 C<< is_class_loaded(ClassName) -> Bool >> +=head2 Class::MOP functions -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. +The following functions are not exportable. -=head3 C<< load_class(ClassName) >> +=head3 C<< Mouse::Util::is_class_loaded($classname) -> Bool >> -This will load a given C (or die if it is not loadable). +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. + +=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 +=head2 mro (or MRO::Compat) =head3 C @@ -427,6 +467,8 @@ L L +L + L =cut