package namespace::clean;
-# ABSTRACT: Keep imports and functions out of your namespace
use warnings;
use strict;
use vars qw( $STORAGE_VAR );
use Package::Stash;
-our $VERSION = '0.20_01';
+our $VERSION = '0.21_01';
$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
+# FIXME - all of this buggery will migrate to B::H::EOS soon
BEGIN {
- if (eval {
+ # when changing also change in Makefile.PL
+ my $b_h_eos_req = '0.07';
+
+ if (! $ENV{NAMESPACE_CLEAN_USE_PP} and eval {
require B::Hooks::EndOfScope;
- B::Hooks::EndOfScope->VERSION('0.07'); # when changing also change in Makefile.PL
+ B::Hooks::EndOfScope->VERSION($b_h_eos_req);
1
} ) {
B::Hooks::EndOfScope->import('on_scope_end');
}
- else {
- eval <<'PP' or die $@;
-
- {
- package namespace::clean::_ScopeGuard;
-
- sub arm { bless [ $_[1] ] }
-
- sub DESTROY { $_[0]->[0]->() }
+ elsif ($] < 5.009_003_9) {
+ require namespace::clean::_PP_OSE_5_8;
+ *on_scope_end = \&namespace::clean::_PP_OSE_5_8::on_scope_end;
}
-
- use Tie::Hash ();
-
- sub on_scope_end (&) {
- $^H |= 0x020000;
-
- if( my $stack = tied( %^H ) ) {
- push @$stack, namespace::clean::_ScopeGuard->arm(shift);
- }
- else {
- tie( %^H, 'Tie::ExtraHash', namespace::clean::_ScopeGuard->arm(shift) );
- }
+ else {
+ require namespace::clean::_PP_OSE;
+ *on_scope_end = \&namespace::clean::_PP_OSE::on_scope_end;
}
+}
- 1;
-
-PP
+=head1 NAME
- }
-}
+namespace::clean - Keep imports and functions out of your namespace
=head1 SYNOPSIS
=cut
+# Constant to optimise away the unused code branches
+use constant FIXUP_NEEDED => $] < 5.015_005_1;
+use constant FIXUP_RENAME_SUB => $] > 5.008_008_9 && $] < 5.013_006_1;
+{
+ no strict;
+ delete ${__PACKAGE__."::"}{FIXUP_NEEDED};
+ delete ${__PACKAGE__."::"}{FIXUP_RENAME_SUB};
+}
+
+# Debugger fixup necessary before perl 5.15.5
+#
+# In perl 5.8.9-5.12, it assumes that sub_fullname($sub) can
+# always be used to find the CV again.
+# In perl 5.8.8 and 5.14, it assumes that the name of the glob
+# passed to entersub can be used to find the CV.
+# since we are deleting the glob where the subroutine was originally
+# defined, those assumptions no longer hold.
+#
+# So in 5.8.9-5.12 we need to move it elsewhere and point the
+# CV's name to the new glob.
+#
+# In 5.8.8 and 5.14 we move it elsewhere and rename the
+# original glob by assigning the new glob back to it.
my $sub_utils_loaded;
-my $DebuggerRename = sub {
+my $DebuggerFixup = sub {
my ($f, $sub, $cleanee_stash, $deleted_stash) = @_;
- if (! defined $sub_utils_loaded ) {
- $sub_utils_loaded = do {
- my $sn_ver = 0.04;
- eval { require Sub::Name; Sub::Name->VERSION($sn_ver) }
- or die "Sub::Name $sn_ver required when running under -d or equivalent: $@";
+ if (FIXUP_RENAME_SUB) {
+ if (! defined $sub_utils_loaded ) {
+ $sub_utils_loaded = do {
- my $si_ver = 0.04;
- eval { require Sub::Identify; Sub::Identify->VERSION($si_ver) }
- or die "Sub::Identify $si_ver required when running under -d or equivalent: $@";
+ # when changing version also change in Makefile.PL
+ my $sn_ver = 0.04;
+ eval { require Sub::Name; Sub::Name->VERSION($sn_ver) }
+ or die "Sub::Name $sn_ver required when running under -d or equivalent: $@";
- 1;
- } ? 1 : 0;
- }
+ # when changing version also change in Makefile.PL
+ my $si_ver = 0.04;
+ eval { require Sub::Identify; Sub::Identify->VERSION($si_ver) }
+ or die "Sub::Identify $si_ver required when running under -d or equivalent: $@";
+
+ 1;
+ } ? 1 : 0;
+ }
- if ( Sub::Identify::sub_fullname($sub) eq ($cleanee_stash->name . "::$f") ) {
- my $new_fq = $deleted_stash->name . "::$f";
- Sub::Name::subname($new_fq, $sub);
+ if ( Sub::Identify::sub_fullname($sub) eq ($cleanee_stash->name . "::$f") ) {
+ my $new_fq = $deleted_stash->name . "::$f";
+ Sub::Name::subname($new_fq, $sub);
+ $deleted_stash->add_symbol("&$f", $sub);
+ }
+ }
+ else {
$deleted_stash->add_symbol("&$f", $sub);
}
};
my $sub = $cleanee_stash->get_symbol("&$f")
or next SYMBOL;
- if ($^P and ref(\$cleanee_stash->namespace->{$f}) eq 'GLOB') {
- # convince the Perl debugger to work
- # it assumes that sub_fullname($sub) can always be used to find the CV again
- # since we are deleting the glob where the subroutine was originally
- # defined, that assumption no longer holds, so we need to move it
- # elsewhere and point the CV's name to the new glob.
- $DebuggerRename->(
- $f,
- $sub,
- $cleanee_stash,
- $deleted_stash ||= Package::Stash->new("namespace::clean::deleted::$cleanee"),
- );
+ my $need_debugger_fixup =
+ FIXUP_NEEDED
+ &&
+ $^P
+ &&
+ ref(my $globref = \$cleanee_stash->namespace->{$f}) eq 'GLOB'
+ ;
+
+ if (FIXUP_NEEDED && $need_debugger_fixup) {
+ # convince the Perl debugger to work
+ # see the comment on top of $DebuggerFixup
+ $DebuggerFixup->(
+ $f,
+ $sub,
+ $cleanee_stash,
+ $deleted_stash ||= Package::Stash->new("namespace::clean::deleted::$cleanee"),
+ );
}
my @symbols = map {
$cleanee_stash->remove_glob($f);
+ # if this perl needs no renaming trick we need to
+ # rename the original glob after the fact
+ # (see commend of $DebuggerFixup
+ if (FIXUP_NEEDED && !FIXUP_RENAME_SUB && $need_debugger_fixup) {
+ *$globref = $deleted_stash->namespace->{$f};
+ }
+
$cleanee_stash->add_symbol(@$_) for @symbols;
}
};
Just for completeness sake, if you want to remove the symbol completely,
use C<undef> instead.
-=head1 CAVEATS
-
-This module is fully functional in a pure-perl environment, where
-L<B::Hooks::EndOfScope> (with the XS dependency L<Variable::Magic>), may
-not be available. However in this case this module falls back to a
-L<tie()|perlfunc/tie> of L<%^H|perlvar/%^H> which may or may not interfere
-with some crack you may be doing independently of namespace::clean.
-
-If you want to ensure that your codebase is protected from this unlikely
-clash, you need to explicitly depend on L<B::Hooks::EndOfScope>.
-
=head1 SEE ALSO
L<B::Hooks::EndOfScope>
Peter Rabbitson <ribasushi@cpan.org>
+=item *
+
+Father Chrysostomos <sprout@cpan.org>
+
=back
=head1 COPYRIGHT AND LICENSE
-This software is copyright (c) 2011 by Robert 'phaylon' Sedlacek.
+This software is copyright (c) 2011 by L</AUTHORS>
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
projects / p5sagit/namespace-clean.git / blobdiff