package Mouse::Util;
-use strict;
-use warnings;
-use base qw/Exporter/;
-use Carp qw(confess);
-use B ();
-
-our @EXPORT_OK = qw(
- load_class
- is_class_loaded
- get_linear_isa
- apply_all_roles
- get_code_info
- not_supported
-);
-our %EXPORT_TAGS = (
- all => \@EXPORT_OK,
-);
+use Mouse::Exporter; # enables strict and warnings
+
+sub get_linear_isa($;$); # must be here
+
+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 dump
+ )],
+ groups => {
+ default => [], # export no functions by default
+
+ # The ':meta' group is 'use metaclass' for Mouse
+ meta => [qw(does meta dump)],
+ },
+ );
+
+
+ # Because Mouse::Util is loaded first in all the Mouse sub-modules,
+ # XS loader is placed here, not in Mouse.pm.
+
+ our $VERSION = '0.49';
+
+ my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
+
+ 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{
+ require XSLoader;
+ XSLoader::load('Mouse', $VERSION);
+ 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 $@;
+ }
+
+ 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};
+
+# 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 {
- my $impl;
+ *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;
+
+ # 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 {
+ 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;
- }
+ 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"}) {
+ 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;
- }
- }
+ eval{ require Class::C3 };
+
+ # 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) = @_;
+ package # hide from PAUSE
+ Class::C3;
+ if(!defined $type){
+ our %MRO;
+ $type = exists $MRO{$classname} ? 'c3' : 'dfs';
+ }
+ return $type eq 'c3'
+ ? [calculateMRO($classname)]
+ : $_get_linear_isa_dfs->($classname);
+ };
+ }
- no warnings 'once';
- *get_linear_isa = $impl;
+ *get_linear_isa = $get_linear_isa;
}
-{ # taken from Sub::Identify
- sub get_code_info($) {\r
- my ($coderef) = @_;\r
- ref($coderef) or return;\r
-
- my $cv = B::svref_2object($coderef);\r
- $cv->isa('B::CV') or return;
- my $gv = $cv->GV;\r
- $gv->isa('B::GV') or return;\r
-\r
- return ($gv->STASH->NAME, $gv->NAME);\r
- }\r
-}
-
-# taken from Class/MOP.pm
+# 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' : '' );
+
+ return $cache{$cache_key}{$metaclass_name} ||= do{
- my $possible_full_name =
- 'Mouse::Meta::'
- . $type
- . '::Custom::'
- . $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 );
+ 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;
+ };
}
}
+# Utilities from Class::MOP
+
+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 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
return 0;
}
my @classes = @_
or return;
- my $found;
my %exceptions;
for my $class (@classes) {
my $e = _try_load_one_class($class);
$exceptions{$class} = $e;
}
else {
- $found = $class;
- last;
+ return $class;
}
}
- return $found if $found;
- confess join(
+ # not found
+ Carp::confess join(
"\n",
map {
sprintf( "Could not load class (%s) because : %s",
}
# 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)";
+ Carp::confess "Invalid class name ($display)";
}
- return if is_class_loaded($class);
+ return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
my $file = $class . '.pm';
$file =~ s{::}{/}g;
sub load_class {
my $class = shift;
my $e = _try_load_one_class($class);
- confess "Could not load class ($class) because : $e" if $e;
+ Carp::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 is_class_loaded;
sub apply_all_roles {
- my $meta = Mouse::Meta::Class->initialize(shift);
+ my $consumer = Scalar::Util::blessed($_[0])
+ ? shift # instance
+ : Mouse::Meta::Class->initialize(shift); # class or role name
my @roles;
my $max = scalar(@_);
for (my $i = 0; $i < $max ; $i++) {
if ($i + 1 < $max && ref($_[$i + 1])) {
- push @roles, [ $_[$i++] => $_[$i] ];
+ 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");
+
+ 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, $params ) = @{ $roles[0] };
- $role->meta->apply( $meta, ( defined $params ? %$params : () ) );
+ my ( $role_name, $params ) = @{ $roles[0] };
+ get_metaclass_by_name($role_name)->apply( $consumer, defined $params ? $params : () );
}
else {
- Mouse::Meta::Role->combine_apply($meta, @roles);
+ Mouse::Meta::Role->combine(@roles)->apply($consumer);
}
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";
+}
+
+sub quoted_english_list {
+ return qq{'$_[0]'} if @_ == 1;
+
+ my @items = sort @_;
+
+ return qq{'$items[0]' and '$items[1]'} if @items == 2;
+
+ my $tail = pop @items;
+
+ return join q{, }, (map{ qq{'$_'} } @items), qq{and '$tail'};
+}
+
+# common utilities
+
sub not_supported{
my($feature) = @_;
$feature ||= ( caller(1) )[3]; # subroutine name
- local $Carp::CarpLevel = $Carp::CarpLevel + 2;
- Carp::croak("Mouse does not currently support $feature");
+ local $Carp::CarpLevel = $Carp::CarpLevel + 1;
+ Carp::confess("Mouse does not currently support $feature");
}
-1;
+# 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.49
=head1 IMPLEMENTATIONS FOR
-=head2 L<MRO::Compat>
+=head2 Moose::Util
+
+=head3 C<find_meta>
+
+=head3 C<does_role>
+
+=head3 C<resolve_metaclass_alias>
+
+=head3 C<apply_all_roles>
+
+=head3 C<english_list>
+
+=head2 Class::MOP
+
+=head3 C<< is_class_loaded(ClassName) -> Bool >>
+
+Returns whether C<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<< load_class(ClassName) >>
+
+This will load a given C<ClassName> (or die if it is not loadable).
+This function can be used in place of tricks like
+C<eval "use $module"> or using C<require>.
+
+=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() >>
+
+=head2 MRO::Compat
+
+=head3 C<get_linear_isa>
+
+=head2 Sub::Identify
+
+=head3 C<get_code_info>
+
+=head1 Mouse specific utilities
+
+=head3 C<not_supported>
+
+=head3 C<get_code_package>
+
+=head3 C<get_code_ref>
+
+=head1 SEE ALSO
+
+L<Moose::Util>
+
+L<Class::MOP>
+
+L<Sub::Identify>
-=head3 get_linear_isa
+L<MRO::Compat>
=cut
projects / gitmo/Mouse.git / blobdiff