Version 0.06
[p5sagit/Devel-GlobalDestruction.git] / lib / Devel / GlobalDestruction.pm
index 901f1ad..9030ae7 100644 (file)
-#!/usr/bin/perl
-
 package Devel::GlobalDestruction;
 
 use strict;
 use warnings;
 
-use vars qw($VERSION @ISA);
+our $VERSION = '0.06';
 
-BEGIN {
-       $VERSION = '0.02';
+use Sub::Exporter -setup => {
+    exports => [ qw(in_global_destruction) ],
+    groups  => { default => [ -all ] },
+};
 
-       local $@;
+# we run 5.14+ - everything is in core
+#
+if (defined ${^GLOBAL_PHASE}) {
+    eval 'sub in_global_destruction () { ${^GLOBAL_PHASE} eq q[DESTRUCT] }';
+}
+# try to load the xs version if it was compiled
+#
+elsif (eval {
+    require XSLoader;
+    XSLoader::load(__PACKAGE__, $VERSION);
+    1;
+}) {
+    # the eval already installed everything, nothing to do
+}
+# Not core nor XS
+#
+else {
+
+  # SpeedyCGI runs END blocks every cycle but somehow keeps object instances
+  # hence DIAF
+  die("The pure-perl version of @{[__PACKAGE__]} can not function correctly under CGI::SpeedyCGI. "
+    . "Please ensure you have a working compiler, and reinstall @{[__PACKAGE__]} to enable the XS "
+    . "codepath.\n"
+  ) if $CGI::SpeedyCGI::i_am_speedy;
+
+  eval <<'PP_IGD' or die $@;
+
+my ($in_global_destruction, $before_is_installed);
+
+sub in_global_destruction { $in_global_destruction }
+
+# This block will fire towards the end of the program execution
+# Since there is no way for us to generate an END which will execute *last*
+# this is *NOT 100% INCOMPATIBLE* with XS/${^GLOBAL_PHASE}. We *may* end up
+# with a true in_gloal_destruction() in the middle of another END block
+# There are no practical cases where this matters.
+#
+END {
+  $in_global_destruction = 1;
+}
 
-       eval {
-               require XSLoader;
-               __PACKAGE__->XSLoader::load($VERSION);
-               1;
-       } or do {
-               require DynaLoader;
-               push @ISA, 'DynaLoader';
-               __PACKAGE__->bootstrap($VERSION);
-       };
+# threads do not execute the global ENDs (it would be stupid). However
+# one can register a new END via simple string eval within a thread, and
+# achieve the same result. A logical place to do this would be CLONE, which
+# is claimed to run in the context of the new thread. However this does
+# not really seem to be the case - any END evaled in a CLONE is ignored :(
+# Hence blatantly hooking threads::create
+#
+if ($INC{'threads.pm'}) {
+  my $orig_create = threads->can('create');
+  no warnings 'redefine';
+  *threads::create = sub {
+    { local $@; eval 'END { $in_global_destruction = 1 }' };
+    goto $orig_create;
+  };
+  $before_is_installed = 1;
 }
 
-use Sub::Exporter -setup => {
-       exports => [ qw(in_global_destruction) ],
-       groups  => { default => [ -all ] },
-};
+# just in case threads got loaded after us (silly)
+sub CLONE {
+  unless ($before_is_installed) {
+    require Carp;
+    Carp::croak("You must load the 'threads' module before @{[ __PACKAGE__ ]}");
+  }
+}
 
-__PACKAGE__
+1;  # keep eval happy
 
-__END__
+PP_IGD
 
-=pod
+}
+
+1;  # keep require happy
+
+
+__END__
 
 =head1 NAME
 
-Devel::GlobalDestruction - Expose PL_dirty, the flag which marks global
+Devel::GlobalDestruction - Expose the flag which marks global
 destruction.
 
 =head1 SYNOPSIS
 
-       package Foo;
-       use Devel::GlobalDestruction;
+    package Foo;
+    use Devel::GlobalDestruction;
 
-       use namespace::clean; # to avoid having an "in_global_destruction" method
+    use namespace::clean; # to avoid having an "in_global_destruction" method
 
-       sub DESTROY {
-               return if in_global_destruction;
+    sub DESTROY {
+        return if in_global_destruction;
 
-               do_something_a_little_tricky();
-       }
+        do_something_a_little_tricky();
+    }
 
 =head1 DESCRIPTION
 
@@ -72,26 +125,26 @@ This module uses L<Sub::Exporter> so the exports may be renamed, aliased, etc.
 
 =item in_global_destruction
 
-Returns the current value of C<PL_dirty>.
+Returns true if the interpreter is in global destruction. In perl 5.14+, this
+returns C<${^GLOBAL_PHASE} eq 'DESTRUCT'>, and on earlier perls, it returns the
+current value of C<PL_dirty>.
 
 =back
 
-=head1 VERSION CONTROL
+=head1 AUTHORS
 
-This module is maintained using Darcs. You can get the latest version from
-L<http://nothingmuch.woobling.org/code>, and use C<darcs send> to commit
-changes.
+Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
 
-=head1 AUTHOR
+Florian Ragwitz E<lt>rafl@debian.orgE<gt>
 
-Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
+Jesse Luehrs E<lt>doy@tozt.netE<gt>
+
+Peter Rabbitson E<lt>ribasushi@cpan.orgE<gt>
 
 =head1 COPYRIGHT
 
-       Copyright (c) 2008 Yuval Kogman. All rights reserved
-       This program is free software; you can redistribute
-       it and/or modify it under the same terms as Perl itself.
+    Copyright (c) 2008 Yuval Kogman. All rights reserved
+    This program is free software; you can redistribute
+    it and/or modify it under the same terms as Perl itself.
 
 =cut
-
-