X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnamespace%2Fclean.pm;h=9ee2893f04af5d49bd23532f2372bba188ec6b73;hb=271df965daa723231e749006028de25cd3cb8a19;hp=63521871ba1ee747788a57312f270d363a3c7a2d;hpb=0495b5c7558bf9f05c35716ffebb0bbe51f72d12;p=p5sagit%2Fnamespace-clean.git diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm index 6352187..9ee2893 100644 --- a/lib/namespace/clean.pm +++ b/lib/namespace/clean.pm @@ -1,28 +1,14 @@ package namespace::clean; - -=head1 NAME - -namespace::clean - Keep imports and functions out of your namespace - -=cut +# ABSTRACT: Keep imports and functions out of your namespace use warnings; use strict; -use vars qw( $VERSION $STORAGE_VAR $SCOPE_HOOK_KEY $SCOPE_EXPLICIT ); -use B::Hooks::EndOfScope; -use Package::Stash; -use Sub::Identify qw(sub_fullname); -use Sub::Name qw(subname); - -=head1 VERSION - -0.13 - -=cut +use vars qw( $STORAGE_VAR ); +use Package::Stash 0.22; +use B::Hooks::EndOfScope 0.07; -$VERSION = '0.15'; -$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; +$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; =head1 SYNOPSIS @@ -62,7 +48,7 @@ $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; When you define a function, or import one, into a Perl package, it will naturally also be available as a method. This does not per se cause problems, but it can complicate subclassing and, for example, plugin -classes that are included via multiple inheritance by loading them as +classes that are included via multiple inheritance by loading them as base classes. The C pragma will remove all previously declared or @@ -83,9 +69,9 @@ be a module exporting an C method along with some functions: If you just want to C<-except> a single sub, you can pass it directly. For more than one value you have to use an array reference. -=head2 Explicitely removing functions when your scope is compiled +=head2 Explicitly removing functions when your scope is compiled -It is also possible to explicitely tell C what packages +It is also possible to explicitly tell C what packages to remove when the surrounding scope has finished compiling. Here is an example: @@ -137,14 +123,7 @@ option like this: If you don't care about Cs discover-and-C<-except> logic, and just want to remove subroutines, try L. -=head1 METHODS - -You shouldn't need to call any of these. Just C the package at the -appropriate place. - -=cut - -=head2 clean_subroutines +=method clean_subroutines This exposes the actual subroutine-removal logic. @@ -157,35 +136,69 @@ it is your responsibility to make sure it runs at that time. =cut -my $RemoveSubs = sub { +my $sub_utils_loaded; +my $DebuggerRename = 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: $@"; + + 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); + } +}; + +my $RemoveSubs = sub { my $cleanee = shift; my $store = shift; my $cleanee_stash = Package::Stash->new($cleanee); - my $deleted_stash = Package::Stash->new("namespace::clean::deleted::$cleanee"); + my $deleted_stash; + SYMBOL: for my $f (@_) { - my $variable = "&$f"; + # ignore already removed symbols next SYMBOL if $store->{exclude}{ $f }; - next SYMBOL unless $cleanee_stash->has_package_symbol($variable); + my $sub = $cleanee_stash->get_symbol("&$f") + or next SYMBOL; - if (ref(\$cleanee_stash->namespace->{$f}) eq 'GLOB') { + 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. - my $sub = $cleanee_stash->get_package_symbol($variable); - if ( sub_fullname($sub) eq ($cleanee_stash->name . "::$f") ) { - my $new_fq = $deleted_stash->name . "::$f"; - subname($new_fq, $sub); - $deleted_stash->add_package_symbol($variable, $sub); - } + $DebuggerRename->( + $f, + $sub, + $cleanee_stash, + $deleted_stash ||= Package::Stash->new("namespace::clean::deleted::$cleanee"), + ); } - $cleanee_stash->remove_package_symbol($variable); + my @symbols = map { + my $name = $_ . $f; + my $def = $cleanee_stash->get_symbol($name); + defined($def) ? [$name, $def] : () + } '$', '@', '%', ''; + + $cleanee_stash->remove_glob($f); + + $cleanee_stash->add_symbol(@$_) for @symbols; } }; @@ -194,7 +207,7 @@ sub clean_subroutines { $RemoveSubs->($cleanee, {}, @subs); } -=head2 import +=method import Makes a snapshot of the current defined functions and installs a L hook in the current scope to invoke the cleanups. @@ -243,7 +256,7 @@ sub import { # register symbols for removal, if they have a CODE entry for my $f (keys %$functions) { next if $except{ $f }; - next unless $stash->has_package_symbol("&$f"); + next unless $stash->has_symbol("&$f"); $store->{remove}{ $f } = 1; } @@ -259,7 +272,7 @@ sub import { } } -=head2 unimport +=method unimport This method will be called when you do a @@ -287,9 +300,9 @@ sub unimport { return 1; } -=head2 get_class_store +=method get_class_store -This returns a reference to a hash in a passed package containing +This returns a reference to a hash in a passed package containing information about function names included and excluded from removal. =cut @@ -297,10 +310,13 @@ information about function names included and excluded from removal. sub get_class_store { my ($pragma, $class) = @_; my $stash = Package::Stash->new($class); - return $stash->get_package_symbol("%$STORAGE_VAR"); + my $var = "%$STORAGE_VAR"; + $stash->add_symbol($var, {}) + unless $stash->has_symbol($var); + return $stash->get_symbol($var); } -=head2 get_functions +=method 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 @@ -313,20 +329,14 @@ sub get_functions { my $stash = Package::Stash->new($class); return { - map { $_ => $stash->get_package_symbol("&$_") } - $stash->list_all_package_symbols('CODE') + map { $_ => $stash->get_symbol("&$_") } + $stash->list_all_symbols('CODE') }; } -=head1 BUGS - -C will clobber any formats that have the same name as -a deleted sub. This is due to a bug in perl that makes it impossible to -re-assign the FORMAT ref into a new glob. - =head1 IMPLEMENTATION DETAILS -This module works through the effect that a +This module works through the effect that a delete $SomePackage::{foo}; @@ -345,15 +355,9 @@ use C instead. L -=head1 AUTHOR AND COPYRIGHT - -Robert 'phaylon' Sedlacek Crs@474.atE>, with many thanks to -Matt S Trout for the inspiration on the whole idea. - -=head1 LICENSE +=head1 THANKS -This program is free software; you can redistribute it and/or modify -it under the same terms as perl itself. +Many thanks to Matt S Trout for the inspiration on the whole idea. =cut