package namespace::clean;
-# ABSTRACT: Keep imports and functions out of your namespace
use warnings;
use strict;
-use vars qw( $STORAGE_VAR );
-use Sub::Name 0.04 qw(subname);
-use Sub::Identify 0.04 qw(sub_fullname);
-use Package::Stash 0.03;
-use B::Hooks::EndOfScope 0.07;
-
-my ($ADD_SYMBOL, $HAS_SYMBOL, $GET_SYMBOL, $LIST_ALL_SYMBOLS, $REMOVE_GLOB);
-BEGIN {
- if ($Package::Stash::VERSION > 0.13) {
- $ADD_SYMBOL = 'add_symbol';
- $HAS_SYMBOL = 'has_symbol';
- $GET_SYMBOL = 'get_symbol';
- $LIST_ALL_SYMBOLS = 'list_all_symbols';
- $REMOVE_GLOB = 'remove_glob';
+use Package::Stash;
+
+our $VERSION = '0.25';
+our $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
+
+use B::Hooks::EndOfScope 'on_scope_end';
+
+
+# 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_005_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 $DebuggerFixup = sub {
+ my ($f, $sub, $cleanee_stash, $deleted_stash) = @_;
+
+ if (FIXUP_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 =
+ 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 {
+ 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 (FIXUP_NEEDED && !FIXUP_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);
+}
+
+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 {
- $ADD_SYMBOL = 'add_package_symbol';
- $HAS_SYMBOL = 'has_package_symbol';
- $GET_SYMBOL = 'get_package_symbol';
- $LIST_ALL_SYMBOLS = 'list_all_package_symbols';
- $REMOVE_GLOB = 'remove_package_glob';
+
+ # 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;
+ }
+}
+
+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;
+}
+
+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);
+}
+
+sub get_functions {
+ my ($pragma, $class) = @_;
+
+ my $stash = Package::Stash->new($class);
+ return {
+ map { $_ => $stash->get_symbol("&$_") }
+ $stash->list_all_symbols('CODE')
+ };
}
-$STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
+'Danger! Laws of Thermodynamics may not apply.'
+
+__END__
+
+=head1 NAME
+
+namespace::clean - Keep imports and functions out of your namespace
=head1 SYNOPSIS
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<namespace::clean> what packages
+It is also possible to explicitly tell C<namespace::clean> what packages
to remove when the surrounding scope has finished compiling. Here is an
example:
If you don't care about C<namespace::clean>s discover-and-C<-except> logic, and
just want to remove subroutines, try L</clean_subroutines>.
-=method clean_subroutines
+=head1 METHODS
+
+=head2 clean_subroutines
This exposes the actual subroutine-removal logic.
effect at a specific time (e.g. C<namespace::clean> acts on scope compile end)
it is your responsibility to make sure it runs at that time.
-=cut
-
-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");
- SYMBOL:
- for my $f (@_) {
- my $variable = "&$f";
- # ignore already removed symbols
- next SYMBOL if $store->{exclude}{ $f };
-
- next SYMBOL unless $cleanee_stash->$HAS_SYMBOL($variable);
-
- if (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_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_SYMBOL($variable, $sub);
- }
- }
-
- my ($scalar, $array, $hash, $io) = map {
- $cleanee_stash->$GET_SYMBOL($_ . $f)
- } '$', '@', '%', '';
- $cleanee_stash->$REMOVE_GLOB($f);
- for my $var (['$', $scalar], ['@', $array], ['%', $hash], ['', $io]) {
- next unless defined $var->[1];
- $cleanee_stash->$ADD_SYMBOL($var->[0] . $f, $var->[1]);
- }
- }
-};
-
-sub clean_subroutines {
- my ($nc, $cleanee, @subs) = @_;
- $RemoveSubs->($cleanee, {}, @subs);
-}
-
-=method import
+=head2 import
Makes a snapshot of the current defined functions and installs a
L<B::Hooks::EndOfScope> 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;
- }
-}
-
-=method unimport
+=head2 unimport
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;
-}
-
-=method get_class_store
+=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);
-}
-
-=method get_functions
+=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
Many thanks to Matt S Trout for the inspiration on the whole idea.
-=cut
+=head1 AUTHORS
-no warnings;
-'Danger! Laws of Thermodynamics may not apply.'
+=over
+
+=item *
+
+Robert 'phaylon' Sedlacek <rs@474.at>
+
+=item *
+
+Florian Ragwitz <rafl@debian.org>
+
+=item *
+
+Jesse Luehrs <doy@tozt.net>
+
+=item *
+
+Peter Rabbitson <ribasushi@cpan.org>
+
+=item *
+
+Father Chrysostomos <sprout@cpan.org>
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+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