[p5sagit/Devel-GlobalDestruction.git] / lib / Devel / GlobalDestruction.pm

#!/usr/bin/perl

package Devel::GlobalDestruction;

use strict;
use warnings;

use XSLoader;

our $VERSION = '0.02';

XSLoader::load(__PACKAGE__, $VERSION);

use Sub::Exporter -setup => {
	exports => [ qw(in_global_destruction) ],
	groups  => { default => [ -all ] },
};

__PACKAGE__

__END__

=pod

=head1 NAME

Devel::GlobalDestruction - Expose PL_dirty, the flag which marks global
destruction.

=head1 SYNOPSIS

	package Foo;
	use Devel::GlobalDestruction;

	use namespace::clean; # to avoid having an "in_global_destruction" method

	sub DESTROY {
		return if in_global_destruction;

		do_something_a_little_tricky();
	}

=head1 DESCRIPTION

Perl's global destruction is a little tricky to deal with WRT finalizers
because it's not ordered and objects can sometimes disappear.

Writing defensive destructors is hard and annoying, and usually if global
destruction is happenning you only need the destructors that free up non
process local resources to actually execute.

For these constructors you can avoid the mess by simply bailing out if global
destruction is in effect.

=head1 EXPORTS

This module uses L<Sub::Exporter> so the exports may be renamed, aliased, etc.

=over 4

=item in_global_destruction

Returns the current value of C<PL_dirty>.

=back

=head1 VERSION CONTROL

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.

=head1 AUTHOR

Yuval Kogman E<lt>nothingmuch@woobling.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.

=cut
Commit	Line	Data
a91e8a78	1	#!/usr/bin/perl
	2
	3	package Devel::GlobalDestruction;
	4
	5	use strict;
	6	use warnings;
	7
53e46d40	8	use XSLoader;
a91e8a78	9
d453ae97	10	our $VERSION = '0.02';
a91e8a78	11
53e46d40	12	XSLoader::load(__PACKAGE__, $VERSION);
a91e8a78	13
	14	use Sub::Exporter -setup => {
	15	exports => [ qw(in_global_destruction) ],
	16	groups => { default => [ -all ] },
	17	};
	18
	19	__PACKAGE__
	20
	21	__END__
	22
	23	=pod
	24
	25	=head1 NAME
	26
	27	Devel::GlobalDestruction - Expose PL_dirty, the flag which marks global
	28	destruction.
	29
	30	=head1 SYNOPSIS
	31
	32	package Foo;
	33	use Devel::GlobalDestruction;
	34
	35	use namespace::clean; # to avoid having an "in_global_destruction" method
	36
	37	sub DESTROY {
	38	return if in_global_destruction;
	39
	40	do_something_a_little_tricky();
	41	}
	42
	43	=head1 DESCRIPTION
	44
	45	Perl's global destruction is a little tricky to deal with WRT finalizers
	46	because it's not ordered and objects can sometimes disappear.
	47
	48	Writing defensive destructors is hard and annoying, and usually if global
	49	destruction is happenning you only need the destructors that free up non
	50	process local resources to actually execute.
	51
	52	For these constructors you can avoid the mess by simply bailing out if global
	53	destruction is in effect.
	54
	55	=head1 EXPORTS
	56
	57	This module uses L<Sub::Exporter> so the exports may be renamed, aliased, etc.
	58
	59	=over 4
	60
	61	=item in_global_destruction
	62
	63	Returns the current value of C<PL_dirty>.
	64
	65	=back
	66
	67	=head1 VERSION CONTROL
	68
	69	This module is maintained using Darcs. You can get the latest version from
	70	L<http://nothingmuch.woobling.org/code>, and use C<darcs send> to commit
	71	changes.
	72
	73	=head1 AUTHOR
	74
	75	Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
	76
77	=head1 COPYRIGHT
78
79	Copyright (c) 2008 Yuval Kogman. All rights reserved
80	This program is free software; you can redistribute
81	it and/or modify it under the same terms as Perl itself.
82
83	=cut
84
85