X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnamespace%2Fclean.pm;h=9ee2893f04af5d49bd23532f2372bba188ec6b73;hb=271df965daa723231e749006028de25cd3cb8a19;hp=91d0be4bf53abfbb1be898e84f93b230cf679d5b;hpb=52bbba50a157d0e29ad24054603399a16494ff17;p=p5sagit%2Fnamespace-clean.git diff --git a/lib/namespace/clean.pm b/lib/namespace/clean.pm index 91d0be4..9ee2893 100644 --- a/lib/namespace/clean.pm +++ b/lib/namespace/clean.pm @@ -1,26 +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 Symbol qw( qualify_to_ref ); -use B::Hooks::EndOfScope; - -=head1 VERSION - -0.10 +use vars qw( $STORAGE_VAR ); +use Package::Stash 0.22; +use B::Hooks::EndOfScope 0.07; -=cut - -$VERSION = 0.10; -$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; +$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE'; =head1 SYNOPSIS @@ -60,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 @@ -81,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: @@ -114,58 +102,138 @@ the installed C method. So your classes should look like: Same goes for L. -=head1 METHODS +=head2 Cleaning other packages -You shouldn't need to call any of these. Just C the package at the -appropriate place. +You can tell C that you want to clean up another package +instead of the one importing. To do this you have to pass in the C<-cleanee> +option like this: -=cut + package My::MooseX::namespace::clean; + use strict; -=head2 import + use namespace::clean (); # no cleanup, just load -Makes a snapshot of the current defined functions and installs a -L hook in the current scope to invoke the cleanups. + sub import { + namespace::clean->import( + -cleanee => scalar(caller), + -except => 'meta', + ); + } + +If you don't care about Cs discover-and-C<-except> logic, and +just want to remove subroutines, try L. + +=method clean_subroutines + +This exposes the actual subroutine-removal logic. + + namespace::clean->clean_subroutines($cleanee, qw( subA subB )); + +will remove C and C from C<$cleanee>. Note that this will remove the +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 +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; + SYMBOL: for my $f (@_) { # ignore already removed symbols next SYMBOL if $store->{exclude}{ $f }; - no strict 'refs'; - # keep original value to restore non-code slots - { no warnings 'uninitialized'; # fix possible unimports - local *__tmp = *{ ${ "${cleanee}::" }{ $f } }; - delete ${ "${cleanee}::" }{ $f }; + 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"), + ); } - SLOT: - # restore non-code slots to symbol - for my $t (qw( SCALAR ARRAY HASH IO FORMAT )) { - next SLOT unless defined *__tmp{ $t }; - *{ "${cleanee}::$f" } = *__tmp{ $t }; - } + 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; } }; +sub clean_subroutines { + my ($nc, $cleanee, @subs) = @_; + $RemoveSubs->($cleanee, {}, @subs); +} + +=method 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); - if (@args and $args[0] =~ /^\-/) { - %args = @args; - @args = (); - } - elsif (@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 = caller; + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; if ($is_explicit) { on_scope_end { $RemoveSubs->($cleanee, {}, @args); @@ -176,6 +244,7 @@ sub import { # 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 )} ( @@ -187,8 +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 $functions->{ $f } - and *{ $functions->{ $f } }{CODE}; + next unless $stash->has_symbol("&$f"); $store->{remove}{ $f } = 1; } @@ -204,7 +272,7 @@ sub import { } } -=head2 unimport +=method unimport This method will be called when you do a @@ -215,10 +283,10 @@ It will start a new section of code that defines functions to clean up. =cut sub unimport { - my ($pragma) = @_; + my ($pragma, %args) = @_; # the calling class, the current functions and our storage - my $cleanee = caller; + my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller; my $functions = $pragma->get_functions($cleanee); my $store = $pragma->get_class_store($cleanee); @@ -232,20 +300,23 @@ 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 sub get_class_store { my ($pragma, $class) = @_; - no strict 'refs'; - return \%{ "${class}::${STORAGE_VAR}" }; + 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 +=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 @@ -256,18 +327,16 @@ reference to the symbol as value. sub get_functions { my ($pragma, $class) = @_; + my $stash = Package::Stash->new($class); return { - map { @$_ } # key => value - grep { *{ $_->[1] }{CODE} } # only functions - map { [$_, qualify_to_ref( $_, $class )] } # get globref - grep { $_ !~ /::$/ } # no packages - do { no strict 'refs'; keys %{ "${class}::" } } # symbol entries + map { $_ => $stash->get_symbol("&$_") } + $stash->list_all_symbols('CODE') }; } =head1 IMPLEMENTATION DETAILS -This module works through the effect that a +This module works through the effect that a delete $SomePackage::{foo}; @@ -286,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