-#!/usr/bin/env perl
package Mouse::Util;
use strict;
use warnings;
-use Exporter 'import';
-use Carp;
+use base qw/Exporter/;
+
+use Carp qw(confess);
+use B ();
our @EXPORT_OK = qw(
- blessed
+ find_meta
+ does_role
+ resolve_metaclass_alias
+ apply_all_roles
+ english_list
+
+ load_class
+ is_class_loaded
+
get_linear_isa
- looks_like_number
- openhandle
- reftype
- weaken
+ get_code_info
+
+ not_supported
+
+ does meta dump
);
our %EXPORT_TAGS = (
all => \@EXPORT_OK,
+ meta => [qw(does meta dump)],
);
-# 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
-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) || '';
+# Moose::Util compatible utilities
- return defined(fileno($fh)) ? $fh : undef
- if $rt eq 'IO';
+sub find_meta{
+ return Mouse::Meta::Module::class_of( $_[0] );
+}
- if (reftype(\$fh) eq 'GLOB') { # handle openhandle(*DATA)
- $fh = \(my $tmp=$fh);
- }
- elsif ($rt ne 'GLOB') {
- return undef;
- }
+sub does_role{
+ my ($class_or_obj, $role_name) = @_;
- (tied(*$fh) or defined(fileno($fh)))
- ? $fh : undef;
- };
- }
+ 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()");
- 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;
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);
+ }
+}
+
+# taken from Mouse::Util (0.90)
+{
+ my %cache;
- my %loaded;
- for my $module_name (keys %dependencies) {
- my $loaded = do {
- local $SIG{__DIE__} = 'DEFAULT';
- eval "require $module_name; 1";
+ 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;
};
+ }
+}
- $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;
+# 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 {
+ 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;
+
+ 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 $role = shift;
- confess "Mouse::Util only supports 'apply_all_roles' on individual roles at a time" if @_;
- Mouse::load_class($role);
- $role->meta->apply($meta);
+ 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 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
+
+=head2 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's not loadable).
+This function can be used in place of tricks like
+C<eval "use $module"> or using C<require>.
+
+=head2 MRO::Compat
+
+=head3 C<get_linear_isa>
+
+=head2 Sub::Identify
-=head3 get_linear_isa
+=head3 C<get_code_info>
-=head2 L<Scalar::Util>
+=head1 UTILITIES FOR MOUSE
-=head3 blessed
+=over 4
-=head3 looks_like_number
+=item *
-=head3 reftype
+C<not_supported>
-=head3 openhandle
+=back
-=head3 weaken
+=head1 SEE ALSO
-C<weaken> I<must> be implemented in XS. If the user tries to use C<weaken>
-without L<Scalar::Util>, an error is thrown.
+L<Moose::Util>
-=head2 Test::Exception
+L<Scalar::Util>
-=head3 throws_ok
+L<Sub::Identify>
-=head3 lives_ok
+L<MRO::Compat>
=cut
projects / gitmo/Mouse.git / blobdiff