@@ -8,7 +8,56 @@ Revision history for Perl extension Exporter.
x TODO rewrite docs (FUNCTIONS, etc.)
x TODO new functions "combine_tags" (or "generate_tag")
x TODO all indentation 2 spaces
- x TODO README file
+
+5.72 Tue June 9 2015
+ - rename anonymous list -> array in docs from blead
+
+5.70 Sun Apr 13 2014
+ - Bump for release to CPAN
+
+5.70_01 Wed Apr 9 2014 Todd Rinaldo
+ - perl # 39739 - Exporter::Heavy ignores custom $SIG{__WARN__} handlers
+ - perl # 119673 - Documentation fixes.
+
+5.68 Wed Mar 27 2013 Todd Rinaldo
+ - Fix erroneous INSTALLDIRS on perls < 5.8 - allows one to
+ upgrade Exporter on perl 5.6 again
+
+5.67 Thu Sep 20 2012 Todd Rinaldo
+ - Documentation changes from p5p.
+ - Fix logic to install to site after perl 5.11
+
+5.66 Wed Dec 23 2011 Todd Rinaldo
+ - No changes. Production release after CPAN testers cleared.
+
+5.65_01 Wed Dec 14 2011 Todd Rinaldo
+ - Updaate Exporter from blead. Bump to dev version for release testing.
+ - Remove local $_ from Exporter - The changes in that commit did
+ not necessitate the addition of
+ local $_. So the localisation is wasting CPU cycles. Worse, it
+ causes bugs in 5.12 and earlier. (local $_ is always wrong if you
+ don’t control what is in $_ already, because it could be a read-only
+ tied variable.) Actually, it causes bugs in 5.14-15 still, because
+ it seems that the changes to ‘local $_’ still weren’t sufficient (it
+ still calls FETCH, but not STORE). That itself needs fixing, but that
+ should not obviate the need for this change, as Exporter has been liv-
+ ing a double life.
+
+5.65 Tue Aug 30 2011 Todd Rinaldo
+ - No changes. Tests clean. Bumping to production release.
+
+5.64_04 Wed Aug 24 2011 Todd Rinaldo
+ - Re-vamp module to work in Git.
+ - Update Makefile.PL with extra META bits.
+ - Point bugs to perl's RT.
+ - Add a README from Exporter.pm perldoc.
+ - Depend on Carp 1.05 now we're assuming a fix from 1.05
+
+5.64_03 Wed Aug 24 2011 (Cumulative)
+ - Fix RT #74472 Exporter.pm blocks Signal handling
+ - Avoid creating @EXPORT_FAIL in every package using Exporter.
+ - Test exported arrays and hashes without using defined()
+ - Carp 1.05 shipped with 5.8.8. Remove work-around for pre 1.05
5.63 Sat Jul 19 2008
- fix doc bugs (pointed by Philippe Bricout at
@@ -1,13 +1,12 @@
-
+Changes
+lib/Exporter.pm
+lib/Exporter/Heavy.pm
+Makefile.PL
MANIFEST This list of files
-Makefile.PL
-Changes
-#README
-
-lib/Exporter.pm
-lib/Exporter/Heavy.pm
-
-t/Exporter.t
-t/use.t
-t/pod.t
-META.yml Module meta-data (added by MakeMaker)
+META.yml Module meta-data (added by MakeMaker)
+README
+t/Exporter.t
+t/pod.t
+t/use.t
+t/warn.t
+META.json Module JSON meta-data (added by MakeMaker)
@@ -0,0 +1,57 @@
+{
+ "abstract" : "Implements default import method for modules",
+ "author" : [
+ "unknown"
+ ],
+ "dynamic_config" : 1,
+ "generated_by" : "ExtUtils::MakeMaker version 6.62, CPAN::Meta::Converter version 2.120921",
+ "license" : [
+ "perl_5"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : "2"
+ },
+ "name" : "Exporter",
+ "no_index" : {
+ "directory" : [
+ "t",
+ "inc"
+ ]
+ },
+ "prereqs" : {
+ "build" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "0"
+ }
+ },
+ "configure" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "0"
+ }
+ },
+ "runtime" : {
+ "recommends" : {
+ "Test::Pod" : "1.18",
+ "Test::Pod::Coverage" : "1.04"
+ },
+ "requires" : {
+ "Carp" : "1.05"
+ }
+ }
+ },
+ "release_status" : "stable",
+ "resources" : {
+ "bugtracker" : {
+ "web" : "http://rt.perl.org/perlbug/"
+ },
+ "license" : [
+ "http://dev.perl.org/licenses/"
+ ],
+ "repository" : {
+ "url" : "http://perl5.git.perl.org/perl.git/tree/HEAD:/lib"
+ },
+ "x_MailingList" : "http://lists.perl.org/list/perl5-porters.html"
+ },
+ "version" : "5.72"
+}
@@ -1,12 +1,30 @@
---- #YAML:1.0
-name: Exporter
-version: 5.63
-abstract: Implements default import method for modules
-license: perl
-author: ~
-generated_by: ExtUtils::MakeMaker version 6.44
-distribution_type: module
-requires:
+---
+abstract: 'Implements default import method for modules'
+author:
+ - unknown
+build_requires:
+ ExtUtils::MakeMaker: 0
+configure_requires:
+ ExtUtils::MakeMaker: 0
+dynamic_config: 1
+generated_by: 'ExtUtils::MakeMaker version 6.62, CPAN::Meta::Converter version 2.120921'
+license: perl
meta-spec:
- url: http://module-build.sourceforge.net/META-spec-v1.3.html
- version: 1.3
+ url: http://module-build.sourceforge.net/META-spec-v1.4.html
+ version: 1.4
+name: Exporter
+no_index:
+ directory:
+ - t
+ - inc
+recommends:
+ Test::Pod: 1.18
+ Test::Pod::Coverage: 1.04
+requires:
+ Carp: 1.05
+resources:
+ bugtracker: http://rt.perl.org/perlbug/
+ license: http://dev.perl.org/licenses/
+ repository: http://perl5.git.perl.org/perl.git/tree/HEAD:/lib
+ x_MailingList: http://lists.perl.org/list/perl5-porters.html
+version: 5.72
@@ -1,29 +1,29 @@
-
-use 5.006;
-
-use ExtUtils::MakeMaker;
-
-my $EUMM_VERSION = $ExtUtils::MakeMaker::VERSION;
-$EUMM_VERSION =~ s/_//g;
-
-WriteMakefile(
- NAME => 'Exporter',
- VERSION_FROM => 'lib/Exporter.pm',
- INSTALLDIRS => 'perl', # core since forever
- PREREQ_PM => {},
-
- ( $] >= 5.005 ? (
- ABSTRACT_FROM => 'lib/Exporter.pm',
- ) : () ),
- ( $EUMM_VERSION >= 6.31 ? (
- LICENSE => 'perl',
- ) : () ),
- ( $EUMM_VERSION >= 6.32 && 0 ? (
- EXTRA_META => {
- recommends => {
- 'Test::Pod' => 1.18,
- 'Test::Pod::Coverage' => 1.04
- },
- },
- ) : () )
-);
+use 5.006;
+use ExtUtils::MakeMaker;
+
+my $EUMM_VERSION = $ExtUtils::MakeMaker::VERSION;
+$EUMM_VERSION =~ s/_//g;
+
+WriteMakefile(
+ NAME => 'Exporter',
+ VERSION_FROM => 'lib/Exporter.pm',
+ ($] > 5.011) ? () : ( INSTALLDIRS => 'perl' ), # CPAN sourced versions should now install to site
+ PREREQ_PM => {
+ 'Carp' => '1.05',
+ },
+ ( $] >= 5.005 ? ( ABSTRACT_FROM => 'lib/Exporter.pm') : () ),
+ ( $EUMM_VERSION >= 6.31 ? ( LICENSE => 'perl') : () ),
+ dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
+ META_MERGE => {
+ recommends => {
+ 'Test::Pod' => 1.18,
+ 'Test::Pod::Coverage' => 1.04
+ },
+ resources => {
+ license => 'http://dev.perl.org/licenses/',
+ bugtracker => 'http://rt.perl.org/perlbug/',
+ repository => 'http://perl5.git.perl.org/perl.git/tree/HEAD:/lib',
+ MailingList => 'http://lists.perl.org/list/perl5-porters.html',
+ },
+ },
+);
@@ -0,0 +1,435 @@
+NAME
+ Exporter - Implements default import method for modules
+
+SYNOPSIS
+ In module YourModule.pm:
+
+ package YourModule;
+ require Exporter;
+ @ISA = qw(Exporter);
+ @EXPORT_OK = qw(munge frobnicate); # symbols to export on request
+
+ or
+
+ package YourModule;
+ use Exporter 'import'; # gives you Exporter's import() method directly
+ @EXPORT_OK = qw(munge frobnicate); # symbols to export on request
+
+ In other files which wish to use "YourModule":
+
+ use YourModule qw(frobnicate); # import listed symbols
+ frobnicate ($left, $right) # calls YourModule::frobnicate
+
+ Take a look at "Good Practices" for some variants you will like to use
+ in modern Perl code.
+
+DESCRIPTION
+ The Exporter module implements an "import" method which allows a module
+ to export functions and variables to its users' namespaces. Many modules
+ use Exporter rather than implementing their own "import" method because
+ Exporter provides a highly flexible interface, with an implementation
+ optimised for the common case.
+
+ Perl automatically calls the "import" method when processing a "use"
+ statement for a module. Modules and "use" are documented in perlfunc and
+ perlmod. Understanding the concept of modules and how the "use"
+ statement operates is important to understanding the Exporter.
+
+ How to Export
+ The arrays @EXPORT and @EXPORT_OK in a module hold lists of symbols that
+ are going to be exported into the users name space by default, or which
+ they can request to be exported, respectively. The symbols can represent
+ functions, scalars, arrays, hashes, or typeglobs. The symbols must be
+ given by full name with the exception that the ampersand in front of a
+ function is optional, e.g.
+
+ @EXPORT = qw(afunc $scalar @array); # afunc is a function
+ @EXPORT_OK = qw(&bfunc %hash *typeglob); # explicit prefix on &bfunc
+
+ If you are only exporting function names it is recommended to omit the
+ ampersand, as the implementation is faster this way.
+
+ Selecting What To Export
+ Do not export method names!
+
+ Do not export anything else by default without a good reason!
+
+ Exports pollute the namespace of the module user. If you must export try
+ to use @EXPORT_OK in preference to @EXPORT and avoid short or common
+ symbol names to reduce the risk of name clashes.
+
+ Generally anything not exported is still accessible from outside the
+ module using the "YourModule::item_name" (or "$blessed_ref->method")
+ syntax. By convention you can use a leading underscore on names to
+ informally indicate that they are 'internal' and not for public use.
+
+ (It is actually possible to get private functions by saying:
+
+ my $subref = sub { ... };
+ $subref->(@args); # Call it as a function
+ $obj->$subref(@args); # Use it as a method
+
+ However if you use them for methods it is up to you to figure out how to
+ make inheritance work.)
+
+ As a general rule, if the module is trying to be object oriented then
+ export nothing. If it's just a collection of functions then @EXPORT_OK
+ anything but use @EXPORT with caution. For function and method names use
+ barewords in preference to names prefixed with ampersands for the export
+ lists.
+
+ Other module design guidelines can be found in perlmod.
+
+ How to Import
+ In other files which wish to use your module there are three basic ways
+ for them to load your module and import its symbols:
+
+ "use YourModule;"
+ This imports all the symbols from YourModule's @EXPORT into the
+ namespace of the "use" statement.
+
+ "use YourModule ();"
+ This causes perl to load your module but does not import any
+ symbols.
+
+ "use YourModule qw(...);"
+ This imports only the symbols listed by the caller into their
+ namespace. All listed symbols must be in your @EXPORT or @EXPORT_OK,
+ else an error occurs. The advanced export features of Exporter are
+ accessed like this, but with list entries that are syntactically
+ distinct from symbol names.
+
+ Unless you want to use its advanced features, this is probably all you
+ need to know to use Exporter.
+
+Advanced features
+ Specialised Import Lists
+ If any of the entries in an import list begins with !, : or / then the
+ list is treated as a series of specifications which either add to or
+ delete from the list of names to import. They are processed left to
+ right. Specifications are in the form:
+
+ [!]name This name only
+ [!]:DEFAULT All names in @EXPORT
+ [!]:tag All names in $EXPORT_TAGS{tag} anonymous list
+ [!]/pattern/ All names in @EXPORT and @EXPORT_OK which match
+
+ A leading ! indicates that matching names should be deleted from the
+ list of names to import. If the first specification is a deletion it is
+ treated as though preceded by :DEFAULT. If you just want to import extra
+ names in addition to the default set you will still need to include
+ :DEFAULT explicitly.
+
+ e.g., Module.pm defines:
+
+ @EXPORT = qw(A1 A2 A3 A4 A5);
+ @EXPORT_OK = qw(B1 B2 B3 B4 B5);
+ %EXPORT_TAGS = (T1 => [qw(A1 A2 B1 B2)], T2 => [qw(A1 A2 B3 B4)]);
+
+ Note that you cannot use tags in @EXPORT or @EXPORT_OK.
+ Names in EXPORT_TAGS must also appear in @EXPORT or @EXPORT_OK.
+
+ An application using Module can say something like:
+
+ use Module qw(:DEFAULT :T2 !B3 A3);
+
+ Other examples include:
+
+ use Socket qw(!/^[AP]F_/ !SOMAXCONN !SOL_SOCKET);
+ use POSIX qw(:errno_h :termios_h !TCSADRAIN !/^EXIT/);
+
+ Remember that most patterns (using //) will need to be anchored with a
+ leading ^, e.g., "/^EXIT/" rather than "/EXIT/".
+
+ You can say "BEGIN { $Exporter::Verbose=1 }" to see how the
+ specifications are being processed and what is actually being imported
+ into modules.
+
+ Exporting without using Exporter's import method
+ Exporter has a special method, 'export_to_level' which is used in
+ situations where you can't directly call Exporter's import method. The
+ export_to_level method looks like:
+
+ MyPackage->export_to_level($where_to_export, $package, @what_to_export);
+
+ where $where_to_export is an integer telling how far up the calling
+ stack to export your symbols, and @what_to_export is an array telling
+ what symbols *to* export (usually this is @_). The $package argument is
+ currently unused.
+
+ For example, suppose that you have a module, A, which already has an
+ import function:
+
+ package A;
+
+ @ISA = qw(Exporter);
+ @EXPORT_OK = qw ($b);
+
+ sub import
+ {
+ $A::b = 1; # not a very useful import method
+ }
+
+ and you want to Export symbol $A::b back to the module that called
+ package A. Since Exporter relies on the import method to work, via
+ inheritance, as it stands Exporter::import() will never get called.
+ Instead, say the following:
+
+ package A;
+ @ISA = qw(Exporter);
+ @EXPORT_OK = qw ($b);
+
+ sub import
+ {
+ $A::b = 1;
+ A->export_to_level(1, @_);
+ }
+
+ This will export the symbols one level 'above' the current package - ie:
+ to the program or module that used package A.
+
+ Note: Be careful not to modify @_ at all before you call export_to_level
+ - or people using your package will get very unexplained results!
+
+ Exporting without inheriting from Exporter
+ By including Exporter in your @ISA you inherit an Exporter's import()
+ method but you also inherit several other helper methods which you
+ probably don't want. To avoid this you can do
+
+ package YourModule;
+ use Exporter qw( import );
+
+ which will export Exporter's own import() method into YourModule.
+ Everything will work as before but you won't need to include Exporter in
+ @YourModule::ISA.
+
+ Note: This feature was introduced in version 5.57 of Exporter, released
+ with perl 5.8.3.
+
+ Module Version Checking
+ The Exporter module will convert an attempt to import a number from a
+ module into a call to "$module_name->require_version($value)". This can
+ be used to validate that the version of the module being used is greater
+ than or equal to the required version.
+
+ The Exporter module supplies a default "require_version" method which
+ checks the value of $VERSION in the exporting module.
+
+ Since the default "require_version" method treats the $VERSION number as
+ a simple numeric value it will regard version 1.10 as lower than 1.9.
+ For this reason it is strongly recommended that you use numbers with at
+ least two decimal places, e.g., 1.09.
+
+ Managing Unknown Symbols
+ In some situations you may want to prevent certain symbols from being
+ exported. Typically this applies to extensions which have functions or
+ constants that may not exist on some systems.
+
+ The names of any symbols that cannot be exported should be listed in the
+ @EXPORT_FAIL array.
+
+ If a module attempts to import any of these symbols the Exporter will
+ give the module an opportunity to handle the situation before generating
+ an error. The Exporter will call an export_fail method with a list of
+ the failed symbols:
+
+ @failed_symbols = $module_name->export_fail(@failed_symbols);
+
+ If the "export_fail" method returns an empty list then no error is
+ recorded and all the requested symbols are exported. If the returned
+ list is not empty then an error is generated for each symbol and the
+ export fails. The Exporter provides a default "export_fail" method which
+ simply returns the list unchanged.
+
+ Uses for the "export_fail" method include giving better error messages
+ for some symbols and performing lazy architectural checks (put more
+ symbols into @EXPORT_FAIL by default and then take them out if someone
+ actually tries to use them and an expensive check shows that they are
+ usable on that platform).
+
+ Tag Handling Utility Functions
+ Since the symbols listed within %EXPORT_TAGS must also appear in either
+ @EXPORT or @EXPORT_OK, two utility functions are provided which allow
+ you to easily add tagged sets of symbols to @EXPORT or @EXPORT_OK:
+
+ %EXPORT_TAGS = (foo => [qw(aa bb cc)], bar => [qw(aa cc dd)]);
+
+ Exporter::export_tags('foo'); # add aa, bb and cc to @EXPORT
+ Exporter::export_ok_tags('bar'); # add aa, cc and dd to @EXPORT_OK
+
+ Any names which are not tags are added to @EXPORT or @EXPORT_OK
+ unchanged but will trigger a warning (with "-w") to avoid misspelt tags
+ names being silently added to @EXPORT or @EXPORT_OK. Future versions may
+ make this a fatal error.
+
+ Generating combined tags
+ If several symbol categories exist in %EXPORT_TAGS, it's usually useful
+ to create the utility ":all" to simplify "use" statements.
+
+ The simplest way to do this is:
+
+ %EXPORT_TAGS = (foo => [qw(aa bb cc)], bar => [qw(aa cc dd)]);
+
+ # add all the other ":class" tags to the ":all" class,
+ # deleting duplicates
+ {
+ my %seen;
+
+ push @{$EXPORT_TAGS{all}},
+ grep {!$seen{$_}++} @{$EXPORT_TAGS{$_}} foreach keys %EXPORT_TAGS;
+ }
+
+ CGI.pm creates an ":all" tag which contains some (but not really all) of
+ its categories. That could be done with one small change:
+
+ # add some of the other ":class" tags to the ":all" class,
+ # deleting duplicates
+ {
+ my %seen;
+
+ push @{$EXPORT_TAGS{all}},
+ grep {!$seen{$_}++} @{$EXPORT_TAGS{$_}}
+ foreach qw/html2 html3 netscape form cgi internal/;
+ }
+
+ Note that the tag names in %EXPORT_TAGS don't have the leading ':'.
+
+ "AUTOLOAD"ed Constants
+ Many modules make use of "AUTOLOAD"ing for constant subroutines to avoid
+ having to compile and waste memory on rarely used values (see perlsub
+ for details on constant subroutines). Calls to such constant subroutines
+ are not optimized away at compile time because they can't be checked at
+ compile time for constancy.
+
+ Even if a prototype is available at compile time, the body of the
+ subroutine is not (it hasn't been "AUTOLOAD"ed yet). perl needs to
+ examine both the "()" prototype and the body of a subroutine at compile
+ time to detect that it can safely replace calls to that subroutine with
+ the constant value.
+
+ A workaround for this is to call the constants once in a "BEGIN" block:
+
+ package My ;
+
+ use Socket ;
+
+ foo( SO_LINGER ); ## SO_LINGER NOT optimized away; called at runtime
+ BEGIN { SO_LINGER }
+ foo( SO_LINGER ); ## SO_LINGER optimized away at compile time.
+
+ This forces the "AUTOLOAD" for "SO_LINGER" to take place before
+ SO_LINGER is encountered later in "My" package.
+
+ If you are writing a package that "AUTOLOAD"s, consider forcing an
+ "AUTOLOAD" for any constants explicitly imported by other packages or
+ which are usually used when your package is "use"d.
+
+Good Practices
+ Declaring @EXPORT_OK and Friends
+ When using "Exporter" with the standard "strict" and "warnings" pragmas,
+ the "our" keyword is needed to declare the package variables @EXPORT_OK,
+ @EXPORT, @ISA, etc.
+
+ our @ISA = qw(Exporter);
+ our @EXPORT_OK = qw(munge frobnicate);
+
+ If backward compatibility for Perls under 5.6 is important, one must
+ write instead a "use vars" statement.
+
+ use vars qw(@ISA @EXPORT_OK);
+ @ISA = qw(Exporter);
+ @EXPORT_OK = qw(munge frobnicate);
+
+ Playing Safe
+ There are some caveats with the use of runtime statements like "require
+ Exporter" and the assignment to package variables, which can very subtle
+ for the unaware programmer. This may happen for instance with mutually
+ recursive modules, which are affected by the time the relevant
+ constructions are executed.
+
+ The ideal (but a bit ugly) way to never have to think about that is to
+ use "BEGIN" blocks. So the first part of the "SYNOPSIS" code could be
+ rewritten as:
+
+ package YourModule;
+
+ use strict;
+ use warnings;
+
+ our (@ISA, @EXPORT_OK);
+ BEGIN {
+ require Exporter;
+ @ISA = qw(Exporter);
+ @EXPORT_OK = qw(munge frobnicate); # symbols to export on request
+ }
+
+ The "BEGIN" will assure that the loading of Exporter.pm and the
+ assignments to @ISA and @EXPORT_OK happen immediately, leaving no room
+ for something to get awry or just plain wrong.
+
+ With respect to loading "Exporter" and inheriting, there are
+ alternatives with the use of modules like "base" and "parent".
+
+ use base qw( Exporter );
+ # or
+ use parent qw( Exporter );
+
+ Any of these statements are nice replacements for "BEGIN { require
+ Exporter; @ISA = qw(Exporter); }" with the same compile-time effect. The
+ basic difference is that "base" code interacts with declared "fields"
+ while "parent" is a streamlined version of the older "base" code to just
+ establish the IS-A relationship.
+
+ For more details, see the documentation and code of base and parent.
+
+ Another thorough remedy to that runtime vs. compile-time trap is to use
+ Exporter::Easy, which is a wrapper of Exporter that allows all
+ boilerplate code at a single gulp in the use statement.
+
+ use Exporter::Easy (
+ OK => [ qw(munge frobnicate) ],
+ );
+ # @ISA setup is automatic
+ # all assignments happen at compile time
+
+ What not to Export
+ You have been warned already in "Selecting What To Export" to not
+ export:
+
+ * method names (because you don't need to and that's likely to not do
+ what you want),
+
+ * anything by default (because you don't want to surprise your
+ users... badly)
+
+ * anything you don't need to (because less is more)
+
+ There's one more item to add to this list. Do not export variable names.
+ Just because "Exporter" lets you do that, it does not mean you should.
+
+ @EXPORT_OK = qw( $svar @avar %hvar ); # DON'T!
+
+ Exporting variables is not a good idea. They can change under the hood,
+ provoking horrible effects at-a-distance, that are too hard to track and
+ to fix. Trust me: they are not worth it.
+
+ To provide the capability to set/get class-wide settings, it is best
+ instead to provide accessors as subroutines or class methods instead.
+
+SEE ALSO
+ "Exporter" is definitely not the only module with symbol exporter
+ capabilities. At CPAN, you may find a bunch of them. Some are lighter.
+ Some provide improved APIs and features. Peek the one that fits your
+ needs. The following is a sample list of such modules.
+
+ Exporter::Easy
+ Exporter::Lite
+ Exporter::Renaming
+ Exporter::Tidy
+ Sub::Exporter / Sub::Installer
+ Perl6::Export / Perl6::Export::Attrs
+
+LICENSE
+ This library is free software. You can redistribute it and/or modify it
+ under the same terms as Perl itself.
+
@@ -6,9 +6,6 @@ no strict 'refs';
# On one line so MakeMaker will see it.
require Exporter; our $VERSION = $Exporter::VERSION;
-# Carp 1.05+ does this now for us, but we may be running with an old Carp
-$Carp::Internal{'Exporter::Heavy'}++;
-
=head1 NAME
Exporter::Heavy - Exporter guts
@@ -41,8 +38,13 @@ sub _rebuild_cache {
sub heavy_export {
+ # Save the old __WARN__ handler in case it was defined
+ my $oldwarn = $SIG{__WARN__};
+
# First make import warnings look like they're coming from the "use".
local $SIG{__WARN__} = sub {
+ # restore it back so proper stacking occurs
+ local $SIG{__WARN__} = $oldwarn;
my $text = shift;
if ($text =~ s/ at \S*Exporter\S*.pm line \d+.*\n//) {
require Carp;
@@ -9,12 +9,9 @@ require 5.006;
our $Debug = 0;
our $ExportLevel = 0;
our $Verbose ||= 0;
-our $VERSION = '5.63';
+our $VERSION = '5.72';
our (%Cache);
-# Carp 1.05+ does this now for us, but we may be running with an old Carp
-$Carp::Internal{Exporter}++;
-
sub as_heavy {
require Exporter::Heavy;
# Unfortunately, this does not work if the caller is aliased as *name = \&foo
@@ -38,13 +35,15 @@ sub import {
}
# We *need* to treat @{"$pkg\::EXPORT_FAIL"} since Carp uses it :-(
- my($exports, $fail) = (\@{"$pkg\::EXPORT"}, \@{"$pkg\::EXPORT_FAIL"});
+ my $exports = \@{"$pkg\::EXPORT"};
+ # But, avoid creating things if they don't exist, which saves a couple of
+ # hundred bytes per package processed.
+ my $fail = ${$pkg . '::'}{EXPORT_FAIL} && \@{"$pkg\::EXPORT_FAIL"};
return export $pkg, $callpkg, @_
- if $Verbose or $Debug or @$fail > 1;
+ if $Verbose or $Debug or $fail && @$fail > 1;
my $export_cache = ($Cache{$pkg} ||= {});
my $args = @_ or @_ = @$exports;
- local $_;
if ($args and not %$export_cache) {
s/^&//, $export_cache->{$_} = 1
foreach (@$exports, @{"$pkg\::EXPORT_OK"});
@@ -54,7 +53,7 @@ sub import {
# We bomb out of the loop with last as soon as heavy is set.
if ($args or $fail) {
($heavy = (/\W/ or $args and not exists $export_cache->{$_}
- or @$fail and $_ eq $fail->[0])) and last
+ or $fail and @$fail and $_ eq $fail->[0])) and last
foreach (@_);
} else {
($heavy = /\W/) and last
@@ -62,7 +61,7 @@ sub import {
}
return export $pkg, $callpkg, ($args ? @_ : ()) if $heavy;
local $SIG{__WARN__} =
- sub {require Carp; &Carp::carp};
+ sub {require Carp; &Carp::carp} if not $SIG{__WARN__};
# shortcut for the common case of no type character
*{"$callpkg\::$_"} = \&{"$pkg\::$_"} foreach @_;
}
@@ -127,14 +126,14 @@ you will like to use in modern Perl code.
=head1 DESCRIPTION
The Exporter module implements an C<import> method which allows a module
-to export functions and variables to its users' namespaces. Many modules
+to export functions and variables to its users' namespaces. Many modules
use Exporter rather than implementing their own C<import> method because
Exporter provides a highly flexible interface, with an implementation optimised
for the common case.
Perl automatically calls the C<import> method when processing a
-C<use> statement for a module. Modules and C<use> are documented
-in L<perlfunc> and L<perlmod>. Understanding the concept of
+C<use> statement for a module. Modules and C<use> are documented
+in L<perlfunc> and L<perlmod>. Understanding the concept of
modules and how the C<use> statement operates is important to
understanding the Exporter.
@@ -153,7 +152,7 @@ ampersand in front of a function is optional, e.g.
If you are only exporting function names it is recommended to omit the
ampersand, as the implementation is faster this way.
-=head2 Selecting What To Export
+=head2 Selecting What to Export
Do B<not> export method names!
@@ -178,8 +177,8 @@ However if you use them for methods it is up to you to figure out
how to make inheritance work.)
As a general rule, if the module is trying to be object oriented
-then export nothing. If it's just a collection of functions then
-C<@EXPORT_OK> anything but use C<@EXPORT> with caution. For function and
+then export nothing. If it's just a collection of functions then
+C<@EXPORT_OK> anything but use C<@EXPORT> with caution. For function and
method names use barewords in preference to names prefixed with
ampersands for the export lists.
@@ -205,7 +204,7 @@ This causes perl to load your module but does not import any symbols.
This imports only the symbols listed by the caller into their namespace.
All listed symbols must be in your C<@EXPORT> or C<@EXPORT_OK>, else an error
-occurs. The advanced export features of Exporter are accessed like this,
+occurs. The advanced export features of Exporter are accessed like this,
but with list entries that are syntactically distinct from symbol names.
=back
@@ -213,23 +212,23 @@ but with list entries that are syntactically distinct from symbol names.
Unless you want to use its advanced features, this is probably all you
need to know to use Exporter.
-=head1 Advanced features
+=head1 Advanced Features
=head2 Specialised Import Lists
If any of the entries in an import list begins with !, : or / then
the list is treated as a series of specifications which either add to
-or delete from the list of names to import. They are processed left to
+or delete from the list of names to import. They are processed left to
right. Specifications are in the form:
[!]name This name only
[!]:DEFAULT All names in @EXPORT
- [!]:tag All names in $EXPORT_TAGS{tag} anonymous list
+ [!]:tag All names in $EXPORT_TAGS{tag} anonymous array
[!]/pattern/ All names in @EXPORT and @EXPORT_OK which match
A leading ! indicates that matching names should be deleted from the
list of names to import. If the first specification is a deletion it
-is treated as though preceded by :DEFAULT. If you just want to import
+is treated as though preceded by :DEFAULT. If you just want to import
extra names in addition to the default set you will still need to
include :DEFAULT explicitly.
@@ -239,8 +238,9 @@ e.g., F<Module.pm> defines:
@EXPORT_OK = qw(B1 B2 B3 B4 B5);
%EXPORT_TAGS = (T1 => [qw(A1 A2 B1 B2)], T2 => [qw(A1 A2 B3 B4)]);
- Note that you cannot use tags in @EXPORT or @EXPORT_OK.
- Names in EXPORT_TAGS must also appear in @EXPORT or @EXPORT_OK.
+Note that you cannot use tags in @EXPORT or @EXPORT_OK.
+
+Names in EXPORT_TAGS must also appear in @EXPORT or @EXPORT_OK.
An application using Module can say something like:
@@ -258,13 +258,16 @@ You can say C<BEGIN { $Exporter::Verbose=1 }> to see how the
specifications are being processed and what is actually being imported
into modules.
-=head2 Exporting without using Exporter's import method
+=head2 Exporting Without Using Exporter's import Method
Exporter has a special method, 'export_to_level' which is used in situations
-where you can't directly call Exporter's import method. The export_to_level
+where you can't directly call Exporter's
+import method. The export_to_level
method looks like:
- MyPackage->export_to_level($where_to_export, $package, @what_to_export);
+ MyPackage->export_to_level(
+ $where_to_export, $package, @what_to_export
+ );
where C<$where_to_export> is an integer telling how far up the calling stack
to export your symbols, and C<@what_to_export> is an array telling what
@@ -277,7 +280,7 @@ import function:
package A;
@ISA = qw(Exporter);
- @EXPORT_OK = qw ($b);
+ @EXPORT_OK = qw($b);
sub import
{
@@ -285,13 +288,13 @@ import function:
}
and you want to Export symbol C<$A::b> back to the module that called
-package A. Since Exporter relies on the import method to work, via
+package A. Since Exporter relies on the import method to work, via
inheritance, as it stands Exporter::import() will never get called.
Instead, say the following:
package A;
@ISA = qw(Exporter);
- @EXPORT_OK = qw ($b);
+ @EXPORT_OK = qw($b);
sub import
{
@@ -305,14 +308,14 @@ the program or module that used package A.
Note: Be careful not to modify C<@_> at all before you call export_to_level
- or people using your package will get very unexplained results!
-=head2 Exporting without inheriting from Exporter
+=head2 Exporting Without Inheriting from Exporter
By including Exporter in your C<@ISA> you inherit an Exporter's import() method
but you also inherit several other helper methods which you probably don't
-want. To avoid this you can do
+want. To avoid this you can do:
package YourModule;
- use Exporter qw( import );
+ use Exporter qw(import);
which will export Exporter's own import() method into YourModule.
Everything will work as before but you won't need to include Exporter in
@@ -324,22 +327,23 @@ of Exporter, released with perl 5.8.3.
=head2 Module Version Checking
The Exporter module will convert an attempt to import a number from a
-module into a call to C<< $module_name->require_version($value) >>. This can
+module into a call to C<< $module_name->VERSION($value) >>. This can
be used to validate that the version of the module being used is
greater than or equal to the required version.
-The Exporter module supplies a default C<require_version> method which
-checks the value of C<$VERSION> in the exporting module.
+For historical reasons, Exporter supplies a C<require_version> method that
+simply delegates to C<VERSION>. Originally, before C<UNIVERSAL::VERSION>
+existed, Exporter would call C<require_version>.
-Since the default C<require_version> method treats the C<$VERSION> number as
+Since the C<UNIVERSAL::VERSION> method treats the C<$VERSION> number as
a simple numeric value it will regard version 1.10 as lower than
-1.9. For this reason it is strongly recommended that you use numbers
+1.9. For this reason it is strongly recommended that you use numbers
with at least two decimal places, e.g., 1.09.
=head2 Managing Unknown Symbols
In some situations you may want to prevent certain symbols from being
-exported. Typically this applies to extensions which have functions
+exported. Typically this applies to extensions which have functions
or constants that may not exist on some systems.
The names of any symbols that cannot be exported should be listed
@@ -347,15 +351,15 @@ in the C<@EXPORT_FAIL> array.
If a module attempts to import any of these symbols the Exporter
will give the module an opportunity to handle the situation before
-generating an error. The Exporter will call an export_fail method
+generating an error. The Exporter will call an export_fail method
with a list of the failed symbols:
@failed_symbols = $module_name->export_fail(@failed_symbols);
If the C<export_fail> method returns an empty list then no error is
-recorded and all the requested symbols are exported. If the returned
+recorded and all the requested symbols are exported. If the returned
list is not empty then an error is generated for each symbol and the
-export fails. The Exporter provides a default C<export_fail> method which
+export fails. The Exporter provides a default C<export_fail> method which
simply returns the list unchanged.
Uses for the C<export_fail> method include giving better error messages
@@ -377,10 +381,10 @@ you to easily add tagged sets of symbols to C<@EXPORT> or C<@EXPORT_OK>:
Any names which are not tags are added to C<@EXPORT> or C<@EXPORT_OK>
unchanged but will trigger a warning (with C<-w>) to avoid misspelt tags
-names being silently added to C<@EXPORT> or C<@EXPORT_OK>. Future versions
+names being silently added to C<@EXPORT> or C<@EXPORT_OK>. Future versions
may make this a fatal error.
-=head2 Generating combined tags
+=head2 Generating Combined Tags
If several symbol categories exist in C<%EXPORT_TAGS>, it's usually
useful to create the utility ":all" to simplify "use" statements.
@@ -423,7 +427,7 @@ constant subroutines are not optimized away at compile time because
they can't be checked at compile time for constancy.
Even if a prototype is available at compile time, the body of the
-subroutine is not (it hasn't been C<AUTOLOAD>ed yet). perl needs to
+subroutine is not (it hasn't been C<AUTOLOAD>ed yet). perl needs to
examine both the C<()> prototype and the body of a subroutine at
compile time to detect that it can safely replace calls to that
subroutine with the constant value.
@@ -434,9 +438,9 @@ A workaround for this is to call the constants once in a C<BEGIN> block:
use Socket ;
- foo( SO_LINGER ); ## SO_LINGER NOT optimized away; called at runtime
+ foo( SO_LINGER ); ## SO_LINGER NOT optimized away; called at runtime
BEGIN { SO_LINGER }
- foo( SO_LINGER ); ## SO_LINGER optimized away at compile time.
+ foo( SO_LINGER ); ## SO_LINGER optimized away at compile time.
This forces the C<AUTOLOAD> for C<SO_LINGER> to take place before
SO_LINGER is encountered later in C<My> package.
@@ -467,13 +471,13 @@ one must write instead a C<use vars> statement.
There are some caveats with the use of runtime statements
like C<require Exporter> and the assignment to package
-variables, which can very subtle for the unaware programmer.
+variables, which can be very subtle for the unaware programmer.
This may happen for instance with mutually recursive
modules, which are affected by the time the relevant
constructions are executed.
The ideal (but a bit ugly) way to never have to think
-about that is to use C<BEGIN> blocks. So the first part
+about that is to use C<BEGIN> blocks. So the first part
of the L</SYNOPSIS> code could be rewritten as:
package YourModule;
@@ -496,13 +500,13 @@ or just plain wrong.
With respect to loading C<Exporter> and inheriting, there
are alternatives with the use of modules like C<base> and C<parent>.
- use base qw( Exporter );
+ use base qw(Exporter);
# or
- use parent qw( Exporter );
+ use parent qw(Exporter);
Any of these statements are nice replacements for
C<BEGIN { require Exporter; @ISA = qw(Exporter); }>
-with the same compile-time effect. The basic difference
+with the same compile-time effect. The basic difference
is that C<base> code interacts with declared C<fields>
while C<parent> is a streamlined version of the older
C<base> code to just establish the IS-A relationship.
@@ -510,8 +514,8 @@ C<base> code to just establish the IS-A relationship.
For more details, see the documentation and code of
L<base> and L<parent>.
-Another thorough remedy to that runtime vs.
-compile-time trap is to use L<Exporter::Easy>,
+Another thorough remedy to that runtime
+vs. compile-time trap is to use L<Exporter::Easy>,
which is a wrapper of Exporter that allows all
boilerplate code at a single gulp in the
use statement.
@@ -522,9 +526,9 @@ use statement.
# @ISA setup is automatic
# all assignments happen at compile time
-=head2 What not to Export
+=head2 What Not to Export
-You have been warned already in L</Selecting What To Export>
+You have been warned already in L</Selecting What to Export>
to not export:
=over 4
@@ -545,16 +549,16 @@ anything you don't need to (because less is more)
=back
-There's one more item to add to this list. Do B<not>
-export variable names. Just because C<Exporter> lets you
+There's one more item to add to this list. Do B<not>
+export variable names. Just because C<Exporter> lets you
do that, it does not mean you should.
- @EXPORT_OK = qw( $svar @avar %hvar ); # DON'T!
+ @EXPORT_OK = qw($svar @avar %hvar); # DON'T!
-Exporting variables is not a good idea. They can
+Exporting variables is not a good idea. They can
change under the hood, provoking horrible
-effects at-a-distance, that are too hard to track
-and to fix. Trust me: they are not worth it.
+effects at-a-distance that are too hard to track
+and to fix. Trust me: they are not worth it.
To provide the capability to set/get class-wide
settings, it is best instead to provide accessors
@@ -563,10 +567,10 @@ as subroutines or class methods instead.
=head1 SEE ALSO
C<Exporter> is definitely not the only module with
-symbol exporter capabilities. At CPAN, you may find
-a bunch of them. Some are lighter. Some
-provide improved APIs and features. Peek the one
-that fits your needs. The following is
+symbol exporter capabilities. At CPAN, you may find
+a bunch of them. Some are lighter. Some
+provide improved APIs and features. Pick the one
+that fits your needs. The following is
a sample list of such modules.
Exporter::Easy
@@ -578,7 +582,7 @@ a sample list of such modules.
=head1 LICENSE
-This library is free software. You can redistribute it
+This library is free software. You can redistribute it
and/or modify it under the same terms as Perl itself.
=cut
@@ -1,12 +1,5 @@
#!perl -w
-BEGIN {
- if( $ENV{PERL_CORE} ) {
- chdir 't' if -d 't';
- @INC = '../lib';
- }
-}
-
# Can't use Test::Simple/More, they depend on Exporter.
my $test;
sub ok ($;$) {
@@ -25,7 +18,7 @@ sub ok ($;$) {
BEGIN {
$test = 1;
- print "1..30\n";
+ print "1..31\n";
require Exporter;
ok( 1, 'Exporter compiled' );
}
@@ -119,17 +112,21 @@ package Bar;
my @imports = qw($seatbelt &Above stuff @wailing %left);
Testing->import(@imports);
-::ok( (!grep { eval "!defined $_" } map({ /^\w/ ? "&$_" : $_ } @imports)),
- 'import by symbols' );
+::ok( (! grep { my ($s, $n) = @$_; eval "\\$s$n != \\${s}Testing::$n" }
+ map { /^(\W)(\w+)/ ? [$1, $2] : ['&', $_] }
+ @imports),
+ 'import by symbols' );
package Yar;
my @tags = qw(:This :tray);
Testing->import(@tags);
-::ok( (!grep { eval "!defined $_" } map { /^\w/ ? "&$_" : $_ }
- map { @$_ } @{$Testing::EXPORT_TAGS{@tags}}),
- 'import by tags' );
+::ok( (! grep { my ($s, $n) = @$_; eval "\\$s$n != \\${s}Testing::$n" }
+ map { /^(\W)(\w+)/ ? [$1, $2] : ['&', $_] }
+ map { @$_ }
+ @{$Testing::EXPORT_TAGS{@tags}}),
+ 'import by tags' );
package Arrr;
@@ -141,17 +138,22 @@ Testing->import(qw(!lifejacket));
package Mars;
Testing->import('/e/');
-::ok( (!grep { eval "!defined $_" } map { /^\w/ ? "&$_" : $_ }
- grep { /e/ } @Testing::EXPORT, @Testing::EXPORT_OK),
- 'import by regex');
+::ok( (! grep { my ($s, $n) = @$_; eval "\\$s$n != \\${s}Testing::$n" }
+ map { /^(\W)(\w+)/ ? [$1, $2] : ['&', $_] }
+ grep { /e/ }
+ @Testing::EXPORT, @Testing::EXPORT_OK),
+ 'import by regex');
package Venus;
Testing->import('!/e/');
-::ok( (!grep { eval "defined $_" } map { /^\w/ ? "&$_" : $_ }
- grep { /e/ } @Testing::EXPORT, @Testing::EXPORT_OK),
- 'deny import by regex');
+::ok( (! grep { my ($s, $n) = @$_; eval "\\$s$n == \\${s}Testing::$n" }
+ map { /^(\W)(\w+)/ ? [$1, $2] : ['&', $_] }
+ grep { /e/ }
+ @Testing::EXPORT, @Testing::EXPORT_OK),
+ 'deny import by regex');
+
::ok( !defined &lifejacket, 'further denial' );
@@ -220,6 +222,24 @@ my $val = eval { wibble() };
# Check that Carp recognizes Exporter as internal to Perl
require Carp;
+eval { Carp::croak() };
::ok($Carp::Internal{Exporter}, "Carp recognizes Exporter");
::ok($Carp::Internal{'Exporter::Heavy'}, "Carp recognizes Exporter::Heavy");
+package Exporter::for::Tied::_;
+
+@ISA = 'Exporter';
+@EXPORT = 'foo';
+
+package Tied::_;
+
+sub TIESCALAR{bless[]}
+# no tie methods!
+
+{
+ tie my $t, __PACKAGE__;
+ for($t) { # $_ is now tied
+ import Exporter::for::Tied::_;
+ }
+}
+::ok(1, 'import with tied $_');
@@ -0,0 +1,39 @@
+#!perl -w
+
+# Can't use Test::Simple/More, they depend on Exporter.
+my $test;
+sub ok ($;$) {
+ my($ok, $name) = @_;
+
+ # You have to do it this way or VMS will get confused.
+ printf "%sok %d%s\n", ($ok ? '' : 'not '), $test,
+ (defined $name ? " - $name" : '');
+
+ printf "# Failed test at line %d\n", (caller)[2] unless $ok;
+
+ $test++;
+ return $ok;
+}
+
+
+BEGIN {
+ $test = 1;
+ print "1..2\n";
+ require Exporter;
+ ok( 1, 'Exporter compiled' );
+}
+
+package Foo;
+Exporter->import("import");
+@EXPORT_OK = "bar";
+
+package main;
+
+{ # [perl #39739] Exporter::Heavy ignores custom $SIG{__WARN__} handlers
+ my @warn;
+
+ local $SIG{__WARN__} = sub { push @warn, join "", @_ };
+ eval { Foo->import(":quux") };
+ ok(grep(/"quux" is not defined/, @warn), "warnings captured");
+}
+