.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AutoLoader 3"
.TH AutoLoader 3 "2002-11-24" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
AutoLoader \- load subroutines only on demand
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& package Foo;
\& use AutoLoader 'AUTOLOAD'; # import the default AUTOLOAD subroutine
.Ve
.PP
.Vb 7
\& package Bar;
\& use AutoLoader; # don't import AUTOLOAD, define our own
\& sub AUTOLOAD {
\& ...
\& $AutoLoader::AUTOLOAD = "...";
\& goto &AutoLoader::AUTOLOAD;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBAutoLoader\fR module works with the \fBAutoSplit\fR module and the
\&\f(CW\*(C`_\|_END_\|_\*(C'\fR token to defer the loading of some subroutines until they are
used rather than loading them all at once.
.PP
To use \fBAutoLoader\fR, the author of a module has to place the
definitions of subroutines to be autoloaded after an \f(CW\*(C`_\|_END_\|_\*(C'\fR token.
(See perldata.) The \fBAutoSplit\fR module can then be run manually to
extract the definitions into individual files \fIauto/funcname.al\fR.
.PP
\&\fBAutoLoader\fR implements an \s-1AUTOLOAD\s0 subroutine. When an undefined
subroutine in is called in a client module of \fBAutoLoader\fR,
\&\fBAutoLoader\fR's \s-1AUTOLOAD\s0 subroutine attempts to locate the subroutine in a
file with a name related to the location of the file from which the
client module was read. As an example, if \fI\s-1POSIX\s0.pm\fR is located in
\&\fI/usr/local/lib/perl5/POSIX.pm\fR, \fBAutoLoader\fR will look for perl
subroutines \fB\s-1POSIX\s0\fR in \fI/usr/local/lib/perl5/auto/POSIX/*.al\fR, where
the \f(CW\*(C`.al\*(C'\fR file has the same name as the subroutine, sans package. If
such a file exists, \s-1AUTOLOAD\s0 will read and evaluate it,
thus (presumably) defining the needed subroutine. \s-1AUTOLOAD\s0 will then
\&\f(CW\*(C`goto\*(C'\fR the newly defined subroutine.
.PP
Once this process completes for a given function, it is defined, so
future calls to the subroutine will bypass the \s-1AUTOLOAD\s0 mechanism.
.Sh "Subroutine Stubs"
.IX Subsection "Subroutine Stubs"
In order for object method lookup and/or prototype checking to operate
correctly even when methods have not yet been defined it is necessary to
\&\*(L"forward declare\*(R" each subroutine (as in \f(CW\*(C`sub NAME;\*(C'\fR). See
\&\*(L"\s-1SYNOPSIS\s0\*(R" in perlsub. Such forward declaration creates \*(L"subroutine
stubs\*(R", which are place holders with no code.
.PP
The AutoSplit and \fBAutoLoader\fR modules automate the creation of forward
declarations. The AutoSplit module creates an 'index' file containing
forward declarations of all the AutoSplit subroutines. When the
AutoLoader module is 'use'd it loads these declarations into its callers
package.
.PP
Because of this mechanism it is important that \fBAutoLoader\fR is always
\&\f(CW\*(C`use\*(C'\fRd and not \f(CW\*(C`require\*(C'\fRd.
.Sh "Using \fBAutoLoader\fP's \s-1AUTOLOAD\s0 Subroutine"
.IX Subsection "Using AutoLoader's AUTOLOAD Subroutine"
In order to use \fBAutoLoader\fR's \s-1AUTOLOAD\s0 subroutine you \fImust\fR
explicitly import it:
.PP
.Vb 1
\& use AutoLoader 'AUTOLOAD';
.Ve
.Sh "Overriding \fBAutoLoader\fP's \s-1AUTOLOAD\s0 Subroutine"
.IX Subsection "Overriding AutoLoader's AUTOLOAD Subroutine"
Some modules, mainly extensions, provide their own \s-1AUTOLOAD\s0 subroutines.
They typically need to check for some special cases (such as constants)
and then fallback to \fBAutoLoader\fR's \s-1AUTOLOAD\s0 for the rest.
.PP
Such modules should \fInot\fR import \fBAutoLoader\fR's \s-1AUTOLOAD\s0 subroutine.
Instead, they should define their own \s-1AUTOLOAD\s0 subroutines along these
lines:
.PP
.Vb 2
\& use AutoLoader;
\& use Carp;
.Ve
.PP
.Vb 16
\& sub AUTOLOAD {
\& my $sub = $AUTOLOAD;
\& (my $constname = $sub) =~ s/.*:://;
\& my $val = constant($constname, @_ ? $_[0] : 0);
\& if ($! != 0) {
\& if ($! =~ /Invalid/ || $!{EINVAL}) {
\& $AutoLoader::AUTOLOAD = $sub;
\& goto &AutoLoader::AUTOLOAD;
\& }
\& else {
\& croak "Your vendor has not defined constant $constname";
\& }
\& }
\& *$sub = sub { $val }; # same as: eval "sub $sub { $val }";
\& goto &$sub;
\& }
.Ve
.PP
If any module's own \s-1AUTOLOAD\s0 subroutine has no need to fallback to the
AutoLoader's \s-1AUTOLOAD\s0 subroutine (because it doesn't have any AutoSplit
subroutines), then that module should not use \fBAutoLoader\fR at all.
.Sh "Package Lexicals"
.IX Subsection "Package Lexicals"
Package lexicals declared with \f(CW\*(C`my\*(C'\fR in the main block of a package
using \fBAutoLoader\fR will not be visible to auto-loaded subroutines, due to
the fact that the given scope ends at the \f(CW\*(C`_\|_END_\|_\*(C'\fR marker. A module
using such variables as package globals will not work properly under the
\&\fBAutoLoader\fR.
.PP
The \f(CW\*(C`vars\*(C'\fR pragma (see \*(L"vars\*(R" in perlmod) may be used in such
situations as an alternative to explicitly qualifying all globals with
the package namespace. Variables pre-declared with this pragma will be
visible to any autoloaded routines (but will not be invisible outside
the package, unfortunately).
.Sh "Not Using AutoLoader"
.IX Subsection "Not Using AutoLoader"
You can stop using AutoLoader by simply
.PP
.Vb 1
\& no AutoLoader;
.Ve
.Sh "\fBAutoLoader\fP vs. \fBSelfLoader\fP"
.IX Subsection "AutoLoader vs. SelfLoader"
The \fBAutoLoader\fR is similar in purpose to \fBSelfLoader\fR: both delay the
loading of subroutines.
.PP
\&\fBSelfLoader\fR uses the \f(CW\*(C`_\|_DATA_\|_\*(C'\fR marker rather than \f(CW\*(C`_\|_END_\|_\*(C'\fR.
While this avoids the use of a hierarchy of disk files and the
associated open/close for each routine loaded, \fBSelfLoader\fR suffers a
startup speed disadvantage in the one-time parsing of the lines after
\&\f(CW\*(C`_\|_DATA_\|_\*(C'\fR, after which routines are cached. \fBSelfLoader\fR can also
handle multiple packages in a file.
.PP
\&\fBAutoLoader\fR only reads code as it is requested, and in many cases
should be faster, but requires a mechanism like \fBAutoSplit\fR be used to
create the individual files. ExtUtils::MakeMaker will invoke
\&\fBAutoSplit\fR automatically if \fBAutoLoader\fR is used in a module source
file.
.SH "CAVEATS"
.IX Header "CAVEATS"
AutoLoaders prior to Perl 5.002 had a slightly different interface. Any
old modules which use \fBAutoLoader\fR should be changed to the new calling
style. Typically this just means changing a require to a use, adding
the explicit \f(CW'AUTOLOAD'\fR import if needed, and removing \fBAutoLoader\fR
from \f(CW@ISA\fR.
.PP
On systems with restrictions on file name length, the file corresponding
to a subroutine may have a shorter name that the routine itself. This
can lead to conflicting file names. The \fIAutoSplit\fR package warns of
these potential conflicts when used to split a module.
.PP
AutoLoader may fail to find the autosplit files (or even find the wrong
ones) in cases where \f(CW@INC\fR contains relative paths, \fBand\fR the program
does \f(CW\*(C`chdir\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SelfLoader \- an autoloader that doesn't use external files.
|
