This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
I sometimes outsmart myself.
[perl5.git] / lib / Exporter.pm
index 9a4382f..6459312 100644 (file)
@@ -2,94 +2,86 @@ package Exporter;
 
 require 5.001;
 
-$ExportLevel = 0;
-$Verbose ||= 0;
-$VERSION = '5.562';
+use strict;
+no strict 'refs';
+
+our $Debug = 0;
+our $ExportLevel = 0;
+our $Verbose ||= 0;
+our $VERSION = '5.564';
+$Carp::Internal{Exporter} = 1;
 
 sub export_to_level {
   require Exporter::Heavy;
-  goto &heavy_export_to_level;
+  goto &Exporter::Heavy::heavy_export_to_level;
 }
 
 sub export {
   require Exporter::Heavy;
-  goto &heavy_export;
+  goto &Exporter::Heavy::heavy_export;
 }
 
 sub export_tags {
   require Exporter::Heavy;
-  _push_tags((caller)[0], "EXPORT",    \@_);
+  Exporter::Heavy::_push_tags((caller)[0], "EXPORT",    \@_);
 }
 
 sub export_ok_tags {
   require Exporter::Heavy;
-  _push_tags((caller)[0], "EXPORT_OK", \@_);
+  Exporter::Heavy::_push_tags((caller)[0], "EXPORT_OK", \@_);
 }
 
 sub import {
   my $pkg = shift;
   my $callpkg = caller($ExportLevel);
-  *exports = *{"$pkg\::EXPORT"};
+
+  my($exports, $export_cache) = (\@{"$pkg\::EXPORT"},
+                                 \%{"$pkg\::EXPORT"});
   # We *need* to treat @{"$pkg\::EXPORT_FAIL"} since Carp uses it :-(
-  *fail = *{"$pkg\::EXPORT_FAIL"};
+  my($fail) = \@{"$pkg\::EXPORT_FAIL"};
   return export $pkg, $callpkg, @_
-    if $Verbose or $Debug or @fail > 1;
-  my $args = @_ or @_ = @exports;
+    if $Verbose or $Debug or @$fail > 1;
+  my $args = @_ or @_ = @$exports;
   
-  if ($args and not %exports) {
-    foreach my $sym (@exports, @{"$pkg\::EXPORT_OK"}) {
+  if ($args and not %$export_cache) {
+    foreach my $sym (@$exports, @{"$pkg\::EXPORT_OK"}) {
       $sym =~ s/^&//;
-      $exports{$sym} = 1;
+      $export_cache->{$sym} = 1;
     }
   }
-  for (@_) {
-      #need to match first to avoid "Modification of a read-only value attempted"
-      if (/^\+/ and s/^\+//) {
-          (\&{"$pkg\::$_"})->(); #try AUTOLOAD now so calls are inlined
-      }
-  }
   if ($Verbose or $Debug 
-      or grep {/\W/ or $args and not exists $exports{$_}
-              or @fail and $_ eq $fail[0]
+      or grep {/\W/ or $args and not exists $export_cache->{$_}
+              or @$fail and $_ eq $fail->[0]
               or (@{"$pkg\::EXPORT_OK"} 
                   and $_ eq ${"$pkg\::EXPORT_OK"}[0])} @_) {
     return export $pkg, $callpkg, ($args ? @_ : ());
   }
-  #local $SIG{__WARN__} = sub {require Carp; goto &Carp::carp};
   local $SIG{__WARN__} = 
-       sub {require Carp; local $Carp::CarpLevel = 1; &Carp::carp};
-  foreach $sym (@_) {
+       sub {require Carp; &Carp::carp};
+  foreach my $sym (@_) {
     # shortcut for the common case of no type character
     *{"$callpkg\::$sym"} = \&{"$pkg\::$sym"};
   }
 }
 
-1;
 
-# A simple self test harness. Change 'require Carp' to 'use Carp ()' for testing.
-# package main; eval(join('',<DATA>)) or die $@ unless caller;
-__END__
-package Test;
-$INC{'Exporter.pm'} = 1;
-@ISA = qw(Exporter);
-@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)], T3=>[qw(X3)]);
-@EXPORT_FAIL = qw(B4);
-Exporter::export_ok_tags('T3', 'unknown_tag');
+# Default methods
+
 sub export_fail {
-    map { "Test::$_" } @_      # edit symbols just as an example
+    my $self = shift;
+    @_;
 }
 
-package main;
-$Exporter::Verbose = 1;
-#import Test;
-#import Test qw(X3);           # export ok via export_ok_tags()
-#import Test qw(:T1 !A2 /5/ !/3/ B5);
-import Test qw(:T2 !B4);
-import Test qw(:T2);           # should fail
+
+sub require_version {
+    require Exporter::Heavy;
+    goto &Exporter::Heavy::require_version;
+}
+
+
 1;
 
+
 =head1 NAME
 
 Exporter - Implements default import method for modules
@@ -155,10 +147,11 @@ 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;
+  $subref->(@args);            # Call it as a function
+  $obj->$subref(@args);        # Use it as a method
 
-But there's no way to call that directly as a method, since a method
-must have a name in the symbol table.)
+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
@@ -209,15 +202,6 @@ 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 Constants can be inlined
-
-AUTOLOADed constants can be inlined by prefixing them with a C<+>:
-
-   use Socket qw(+AF_INET);
-
-Thusly prefixed constants are defined during the symbol import phase of
-compilation, which means that by runtime they are true inlined constants.
-
 =head2 Exporting without using Export's import method
 
 Exporter has a special method, 'export_to_level' which is used in situations
@@ -325,4 +309,35 @@ unchanged but will trigger a warning (with C<-w>) to avoid misspelt tags
 names being silently added to @EXPORT or @EXPORT_OK. Future versions
 may make this a fatal error.
 
+=head2 C<AUTOLOAD>ed Constants
+
+Many modules make use of C<AUTOLOAD>ing for constant subroutines to
+avoid having to compile and waste memory on rarely used values (see
+L<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 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.
+
+A workaround for this is to call the constants once in a C<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 C<AUTOLOAD> for C<SO_LINGER> to take place before
+SO_LINGER is encountered later in C<My> package.
+
+If you are writing a package that C<AUTOLOAD>s, consider forcing
+an C<AUTOLOAD> for any constants explicitly imported by other packages
+or which are usually used when your package is C<use>d.
+
 =cut