X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnamespace%2Fclean.pm;h=5d41c9de630c8e0b164cfce5abd0748398c1909e;hb=39dbc69b27dbf7800719b3e60a9042b9a1ae58f8;hp=fbcfeec1eb0c503b70022d9c8bf4498e360c8175;hpb=9bb3eaa29ca8582e3c9f86cbc7d9bfebf857282d;p=p5sagit%2Fnamespace-clean.git diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm index fbcfeec..5d41c9d 100644 --- a/lib/namespace/clean.pm +++ b/lib/namespace/clean.pm @@ -1,96 +1,235 @@ 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.25'; +our $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; -our $VERSION = '0.21'; - -$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; +use B::Hooks::EndOfScope 'on_scope_end'; +# FIXME This is a crock of shit, needs to go away +# currently here to work around https://rt.cpan.org/Ticket/Display.html?id=74151 +# kill with fire when PS::XS is *finally* fixed BEGIN { + my $provider; - use warnings; - use strict; + if ( $] < 5.008007 ) { + require Package::Stash::PP; + $provider = 'Package::Stash::PP'; + } + else { + require Package::Stash; + $provider = 'Package::Stash'; + } + eval <<"EOS" or die $@; + +sub stash_for (\$) { + $provider->new(\$_[0]); +} + +1; + +EOS +} - # when changing also change in Makefile.PL - my $b_h_eos_req = '0.07'; +use namespace::clean::_Util qw( DEBUGGER_NEEDS_CV_RENAME DEBUGGER_NEEDS_CV_PIVOT ); + +# 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 $DebuggerFixup = sub { + my ($f, $sub, $cleanee_stash, $deleted_stash) = @_; - if (! $ENV{NAMESPACE_CLEAN_USE_PP} and eval { - require B::Hooks::EndOfScope; - B::Hooks::EndOfScope->VERSION($b_h_eos_req); - 1 - } ) { - B::Hooks::EndOfScope->import('on_scope_end'); + if (DEBUGGER_NEEDS_CV_RENAME) { + # + # Note - both get_subname and set_subname are only compiled when CV_RENAME + # is true ( the 5.8.9 ~ 5.12 range ). On other perls this entire block is + # constant folded away, and so are the definitions in ::_Util + # + # Do not be surprised that they are missing without DEBUGGER_NEEDS_CV_RENAME + # + namespace::clean::_Util::get_subname( $sub ) eq ( $cleanee_stash->name . "::$f" ) + and + $deleted_stash->add_symbol( + "&$f", + namespace::clean::_Util::set_subname( $deleted_stash->name . "::$f", $sub ), + ); } else { - eval <<'PP' or die $@; + $deleted_stash->add_symbol("&$f", $sub); + } +}; - use Tie::Hash (); +my $RemoveSubs = sub { + my $cleanee = shift; + my $store = shift; + my $cleanee_stash = stash_for($cleanee); + my $deleted_stash; - { - package namespace::clean::_TieHintHash; + SYMBOL: + for my $f (@_) { - use warnings; - use strict; + # ignore already removed symbols + next SYMBOL if $store->{exclude}{ $f }; - use base 'Tie::ExtraHash'; - } + my $sub = $cleanee_stash->get_symbol("&$f") + or next SYMBOL; - { - package namespace::clean::_ScopeGuard; + my $need_debugger_fixup = + ( DEBUGGER_NEEDS_CV_RENAME or DEBUGGER_NEEDS_CV_PIVOT ) + && + $^P + && + ref(my $globref = \$cleanee_stash->namespace->{$f}) eq 'GLOB' + ; - use warnings; - use strict; + if ($need_debugger_fixup) { + # convince the Perl debugger to work + # see the comment on top of $DebuggerFixup + $DebuggerFixup->( + $f, + $sub, + $cleanee_stash, + $deleted_stash ||= stash_for("namespace::clean::deleted::$cleanee"), + ); + } - sub arm { bless [ $_[1] ] } + my @symbols = map { + my $name = $_ . $f; + my $def = $cleanee_stash->get_symbol($name); + defined($def) ? [$name, $def] : () + } '$', '@', '%', ''; - sub DESTROY { $_[0]->[0]->() } - } + $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 (DEBUGGER_NEEDS_CV_PIVOT && $need_debugger_fixup) { + *$globref = $deleted_stash->namespace->{$f}; + } - sub on_scope_end (&) { - $^H |= 0x020000; + $cleanee_stash->add_symbol(@$_) for @symbols; + } +}; - if( my $stack = tied( %^H ) ) { - if ( (my $c = ref $stack) ne 'namespace::clean::_TieHintHash') { - die <($cleanee, {}, @subs); +} - foreign tie() of %^H detected -======================================================================== +sub import { + my ($pragma, @args) = @_; -namespace::clean is currently operating in pure-perl fallback mode, because -your system is lacking the necessary dependency B::Hooks::EndOfScope $b_h_eos_req. -In this mode namespace::clean expects to be able to tie() the hinthash %^H, -however it is apparently already tied by means unknown to the tie-class -$c + my (%args, $is_explicit); -Since this is a no-win situation execution will abort here and now. Please -try to find out which other module is relying on hinthash tie() ability, -and file a bug for both the perpetrator and namespace::clean, so that the -authors can figure out an acceptable way of moving forward. + ARG: + while (@args) { -EOE - } - push @$stack, namespace::clean::_ScopeGuard->arm(shift); + if ($args[0] =~ /^\-/) { + my $key = shift @args; + my $value = shift @args; + $args{ $key } = $value; + } + else { + $is_explicit++; + last ARG; + } + } + + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; + if ($is_explicit) { + on_scope_end { + $RemoveSubs->($cleanee, {}, @args); + }; } else { - tie( %^H, 'namespace::clean::_TieHintHash', namespace::clean::_ScopeGuard->arm(shift) ); + + # calling class, all current functions and our storage + my $functions = $pragma->get_functions($cleanee); + my $store = $pragma->get_class_store($cleanee); + my $stash = stash_for($cleanee); + + # except parameter can be array ref or single value + my %except = map {( $_ => 1 )} ( + $args{ -except } + ? ( ref $args{ -except } eq 'ARRAY' ? @{ $args{ -except } } : $args{ -except } ) + : () + ); + + # register symbols for removal, if they have a CODE entry + for my $f (keys %$functions) { + next if $except{ $f }; + next unless $stash->has_symbol("&$f"); + $store->{remove}{ $f } = 1; + } + + # register EOF handler on first call to import + unless ($store->{handler_is_installed}) { + on_scope_end { + $RemoveSubs->($cleanee, $store, keys %{ $store->{remove} }); + }; + $store->{handler_is_installed} = 1; + } + + return 1; } - } +} - 1; +sub unimport { + my ($pragma, %args) = @_; -PP + # the calling class, the current functions and our storage + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; + my $functions = $pragma->get_functions($cleanee); + my $store = $pragma->get_class_store($cleanee); - } + # register all unknown previous functions as excluded + for my $f (keys %$functions) { + next if $store->{remove}{ $f } + or $store->{exclude}{ $f }; + $store->{exclude}{ $f } = 1; + } + + return 1; } +sub get_class_store { + my ($pragma, $class) = @_; + my $stash = stash_for($class); + my $var = "%$STORAGE_VAR"; + $stash->add_symbol($var, {}) + unless $stash->has_symbol($var); + return $stash->get_symbol($var); +} + +sub get_functions { + my ($pragma, $class) = @_; + + my $stash = stash_for($class); + return { + map { $_ => $stash->get_symbol("&$_") } + $stash->list_all_symbols('CODE') + }; +} + +'Danger! Laws of Thermodynamics may not apply.' + +__END__ + =head1 NAME namespace::clean - Keep imports and functions out of your namespace @@ -221,177 +360,11 @@ subroutines B and not wait for scope end. If you want to have this effect at a specific time (e.g. C acts on scope compile end) it is your responsibility to make sure it runs at that time. -=cut - -# Constant to optimise away the unused code branches -use constant RENAME_SUB => $] > 5.008_008_9 && $] < 5.013_006_1; -{ no strict; delete ${__PACKAGE__."::"}{RENAME_SUB} } - -# 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 $DebuggerFixup = sub { - my ($f, $sub, $cleanee_stash, $deleted_stash) = @_; - - if (RENAME_SUB) { - if (! defined $sub_utils_loaded ) { - $sub_utils_loaded = do { - - # 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: $@"; - - # 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); - $deleted_stash->add_symbol("&$f", $sub); - } - } - else { - $deleted_stash->add_symbol("&$f", $sub); - } -}; - -my $RemoveSubs = sub { - my $cleanee = shift; - my $store = shift; - my $cleanee_stash = Package::Stash->new($cleanee); - my $deleted_stash; - - SYMBOL: - for my $f (@_) { - - # ignore already removed symbols - next SYMBOL if $store->{exclude}{ $f }; - - my $sub = $cleanee_stash->get_symbol("&$f") - or next SYMBOL; - - my $need_debugger_fixup = - $^P - && - ref(my $globref = \$cleanee_stash->namespace->{$f}) eq 'GLOB' - ; - - if ($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 { - my $name = $_ . $f; - my $def = $cleanee_stash->get_symbol($name); - defined($def) ? [$name, $def] : () - } '$', '@', '%', ''; - - $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 (!RENAME_SUB && $need_debugger_fixup) { - *$globref = $deleted_stash->namespace->{$f}; - } - - $cleanee_stash->add_symbol(@$_) for @symbols; - } -}; - -sub clean_subroutines { - my ($nc, $cleanee, @subs) = @_; - $RemoveSubs->($cleanee, {}, @subs); -} - =head2 import Makes a snapshot of the current defined functions and installs a L hook in the current scope to invoke the cleanups. -=cut - -sub import { - my ($pragma, @args) = @_; - - my (%args, $is_explicit); - - ARG: - while (@args) { - - if ($args[0] =~ /^\-/) { - my $key = shift @args; - my $value = shift @args; - $args{ $key } = $value; - } - else { - $is_explicit++; - last ARG; - } - } - - my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; - if ($is_explicit) { - on_scope_end { - $RemoveSubs->($cleanee, {}, @args); - }; - } - else { - - # calling class, all current functions and our storage - my $functions = $pragma->get_functions($cleanee); - my $store = $pragma->get_class_store($cleanee); - my $stash = Package::Stash->new($cleanee); - - # except parameter can be array ref or single value - my %except = map {( $_ => 1 )} ( - $args{ -except } - ? ( ref $args{ -except } eq 'ARRAY' ? @{ $args{ -except } } : $args{ -except } ) - : () - ); - - # register symbols for removal, if they have a CODE entry - for my $f (keys %$functions) { - next if $except{ $f }; - next unless $stash->has_symbol("&$f"); - $store->{remove}{ $f } = 1; - } - - # register EOF handler on first call to import - unless ($store->{handler_is_installed}) { - on_scope_end { - $RemoveSubs->($cleanee, $store, keys %{ $store->{remove} }); - }; - $store->{handler_is_installed} = 1; - } - - return 1; - } -} =head2 unimport @@ -401,60 +374,17 @@ This method will be called when you do a It will start a new section of code that defines functions to clean up. -=cut - -sub unimport { - my ($pragma, %args) = @_; - - # the calling class, the current functions and our storage - my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; - my $functions = $pragma->get_functions($cleanee); - my $store = $pragma->get_class_store($cleanee); - - # register all unknown previous functions as excluded - for my $f (keys %$functions) { - next if $store->{remove}{ $f } - or $store->{exclude}{ $f }; - $store->{exclude}{ $f } = 1; - } - - return 1; -} - =head2 get_class_store This returns a reference to a hash in a passed package containing information about function names included and excluded from removal. -=cut - -sub get_class_store { - my ($pragma, $class) = @_; - my $stash = Package::Stash->new($class); - my $var = "%$STORAGE_VAR"; - $stash->add_symbol($var, {}) - unless $stash->has_symbol($var); - return $stash->get_symbol($var); -} - =head2 get_functions Takes a class as argument and returns all currently defined functions in it as a hash reference with the function name as key and a typeglob reference to the symbol as value. -=cut - -sub get_functions { - my ($pragma, $class) = @_; - - my $stash = Package::Stash->new($class); - return { - map { $_ => $stash->get_symbol("&$_") } - $stash->list_all_symbols('CODE') - }; -} - =head1 IMPLEMENTATION DETAILS This module works through the effect that a @@ -472,17 +402,6 @@ will be stable in future releases. Just for completeness sake, if you want to remove the symbol completely, use C instead. -=head1 CAVEATS - -This module is fully functional in a pure-perl environment, where -L (with the XS dependency L), may -not be available. However in this case this module falls back to a -L 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. - =head1 SEE ALSO L @@ -511,15 +430,14 @@ Jesse Luehrs Peter Rabbitson +=item * + +Father Chrysostomos + =back =head1 COPYRIGHT AND LICENSE -This software is copyright (c) 2011 by Robert 'phaylon' Sedlacek. +This software is copyright (c) 2011 by L This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. - -=cut - -no warnings; -'Danger! Laws of Thermodynamics may not apply.'