The default maxdepth of 'dump' method is now 3, instead of 2.
[gitmo/Mouse.git] / lib / Mouse / Util.pm
index 8afb940..b7ab693 100644 (file)
@@ -1,80 +1,99 @@
 package Mouse::Util;
 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.40_03';
+    our $VERSION = '0.49';
 
-    my $need_pp = !!$ENV{MOUSE_PUREPERL};
-
-    if(!$need_pp && !exists $INC{'Mouse/PurePerl.pm'}){
-        local $@;
+    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
-        $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{
             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($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;
+    *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{
@@ -93,46 +112,52 @@ 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;
-                    }
+        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;
 }
 
 
@@ -175,7 +200,7 @@ sub is_valid_class_name {
     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;
 }
@@ -240,9 +265,8 @@ sub load_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 +283,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 +310,17 @@ sub english_list {
     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
 
@@ -309,17 +344,17 @@ sub dump :method {
 
     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);
     return $dd->Dump();
 }
 
 # general does() method
-sub does :method;
-*does = \&does_role; # alias
+sub does :method {
+    goto &does_role;
+}
 
 1;
-
 __END__
 
 =head1 NAME
@@ -328,7 +363,7 @@ Mouse::Util - Features, with or without their dependencies
 
 =head1 VERSION
 
-This document describes Mouse version 0.40_03
+This document describes Mouse version 0.49
 
 =head1 IMPLEMENTATIONS FOR
 
@@ -374,10 +409,14 @@ C<eval "use $module"> or using C<require>.
 
 =head3 C<get_code_info>
 
-=head1 UTILITIES FOR MOUSE
+=head1 Mouse specific utilities
 
 =head3 C<not_supported>
 
+=head3 C<get_code_package>
+
+=head3 C<get_code_ref>
+
 =head1 SEE ALSO
 
 L<Moose::Util>