package Mouse::Util;
use Mouse::Exporter; # enables strict and warnings
-sub get_linear_isa($;$); # must be here
+# 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;
+}
BEGIN{
# This is used in Mouse::PurePerl
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.70';
- # Because Mouse::Util is loaded first in all the Mouse sub-modules,
- # XS loader is placed here, not in Mouse.pm.
-
- our $VERSION = '0.50_03';
-
- 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; # workaround 'redefine' warning to &install_subroutines
require XSLoader;
XSLoader::load('Mouse', $VERSION);
Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS' }, ':meta');
return 1;
} || 0;
- #warn $@ if $@;
+ warn $@ if $@ && $ENV{MOUSE_XS};
}
if(!$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 {
+# 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');
require mro;
$get_linear_isa = \&mro::get_linear_isa;
} else {
-# VVVVV CODE TAKEN FROM MRO::COMPAT VVVVV
+ # 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) = @_;
no strict 'refs';
foreach my $parent (@{"$classname\::ISA"}) {
- my $plin = $_get_linear_isa_dfs->($parent);
- foreach my $p(@$plin) {
+ 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 ^^^^^
- eval{ require Class::C3 };
+ {
+ 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) = @_;
- package # hide from PAUSE
- Class::C3;
+
if(!defined $type){
- our %MRO;
- $type = exists $MRO{$classname} ? 'c3' : 'dfs';
+ $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);
}
- return $type eq 'c3'
- ? [calculateMRO($classname)]
- : $_get_linear_isa_dfs->($classname);
};
}
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 =~ /\A \w+ (?: :: \w+ )* \z/xms;
-
- return 0;
-}
+sub is_valid_class_name;
# taken from Class/MOP.pm
sub load_first_existing_class {
}
# taken from Class/MOP.pm
-my %is_class_loaded_cache;
sub _try_load_one_class {
my $class = shift;
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 };
$@;
};
}
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;
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) = @_;
my $dd = Data::Dumper->new([$self]);
$dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3);
$dd->Indent(1);
+ $dd->Sortkeys(1);
+ $dd->Quotekeys(0);
return $dd->Dump();
}
=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.50_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<find_meta($class_or_obj)>
+
+The same as C<Mouse::Util::class_of()>.
-=head3 C<find_meta>
+=head3 C<does_role($class_or_obj, $role_or_obj)>
-=head3 C<does_role>
+=head3 C<resolve_metaclass_alias($category, $name, %options)>
-=head3 C<resolve_metaclass_alias>
+=head3 C<apply_all_roles($applicant, @roles)>
-=head3 C<apply_all_roles>
+=head3 C<english_listi(@items)>
-=head3 C<english_list>
+=head2 Class::MOP functions
-=head2 Class::MOP
+The following functions are not exportable.
-=head3 C<< is_class_loaded(ClassName) -> Bool >>
+=head3 C<< Mouse::Util::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.
+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<< load_class(ClassName) >>
+=head3 C<< Mouse::Util::load_class($classname) -> ClassName >>
-This will load a given C<ClassName> (or die if it is not loadable).
+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<eval "use $module"> or using C<require>.
+C<eval "use $module ()"> or using C<require>.
-=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
projects / gitmo/Mouse.git / blobdiff