home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _5cf294bdf1e1e8845de24ba8ee1d70be < prev    next >
Text File  |  2000-03-23  |  10KB  |  193 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>AutoLoader - load subroutines only on demand</TITLE>
  5. <LINK REL="stylesheet" HREF="../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> AutoLoader - load subroutines only on demand</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#subroutine stubs">Subroutine Stubs</A></LI>
  28.         <LI><A HREF="#using autoloader's autoload subroutine">Using <STRONG>AutoLoader</STRONG>'s AUTOLOAD Subroutine</A></LI>
  29.         <LI><A HREF="#overriding autoloader's autoload subroutine">Overriding <STRONG>AutoLoader</STRONG>'s AUTOLOAD Subroutine</A></LI>
  30.         <LI><A HREF="#package lexicals">Package Lexicals</A></LI>
  31.         <LI><A HREF="#autoloader vs. selfloader"><STRONG>AutoLoader</STRONG> vs. <STRONG>SelfLoader</STRONG></A></LI>
  32.     </UL>
  33.  
  34.     <LI><A HREF="#caveats">CAVEATS</A></LI>
  35.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  36. </UL>
  37. <!-- INDEX END -->
  38.  
  39. <HR>
  40. <P>
  41. <H1><A NAME="name">NAME</A></H1>
  42. <P>AutoLoader - load subroutines only on demand</P>
  43. <P>
  44. <HR>
  45. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  46. <UL>
  47. <LI>Linux</LI>
  48. <LI>Solaris</LI>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <PRE>
  54.     package Foo;
  55.     use AutoLoader 'AUTOLOAD';   # import the default AUTOLOAD subroutine</PRE>
  56. <PRE>
  57.     package Bar;
  58.     use AutoLoader;              # don't import AUTOLOAD, define our own
  59.     sub AUTOLOAD {
  60.         ...
  61.         $AutoLoader::AUTOLOAD = "...";
  62.         goto &AutoLoader::AUTOLOAD;
  63.     }</PRE>
  64. <P>
  65. <HR>
  66. <H1><A NAME="description">DESCRIPTION</A></H1>
  67. <P>The <STRONG>AutoLoader</STRONG> module works with the <STRONG>AutoSplit</STRONG> module and the
  68. <CODE>__END__</CODE> token to defer the loading of some subroutines until they are
  69. used rather than loading them all at once.</P>
  70. <P>To use <STRONG>AutoLoader</STRONG>, the author of a module has to place the
  71. definitions of subroutines to be autoloaded after an <CODE>__END__</CODE> token.
  72. (See <A HREF="../lib/Pod/perldata.html">the perldata manpage</A>.)  The <STRONG>AutoSplit</STRONG> module can then be run manually to
  73. extract the definitions into individual files <EM>auto/funcname.al</EM>.</P>
  74. <P><STRONG>AutoLoader</STRONG> implements an AUTOLOAD subroutine.  When an undefined
  75. subroutine in is called in a client module of <STRONG>AutoLoader</STRONG>,
  76. <STRONG>AutoLoader</STRONG>'s AUTOLOAD subroutine attempts to locate the subroutine in a
  77. file with a name related to the location of the file from which the
  78. client module was read.  As an example, if <EM>POSIX.pm</EM> is located in
  79. <EM>/usr/local/lib/perl5/POSIX.pm</EM>, <STRONG>AutoLoader</STRONG> will look for perl
  80. subroutines <STRONG>POSIX</STRONG> in <EM>/usr/local/lib/perl5/auto/POSIX/*.al</EM>, where
  81. the <CODE>.al</CODE> file has the same name as the subroutine, sans package.  If
  82. such a file exists, AUTOLOAD will read and evaluate it,
  83. thus (presumably) defining the needed subroutine.  AUTOLOAD will then
  84. <A HREF="../lib/Pod/perlfunc.html#item_goto"><CODE>goto</CODE></A> the newly defined subroutine.</P>
  85. <P>Once this process completes for a given function, it is defined, so
  86. future calls to the subroutine will bypass the AUTOLOAD mechanism.</P>
  87. <P>
  88. <H2><A NAME="subroutine stubs">Subroutine Stubs</A></H2>
  89. <P>In order for object method lookup and/or prototype checking to operate
  90. correctly even when methods have not yet been defined it is necessary to
  91. ``forward declare'' each subroutine (as in <CODE>sub NAME;</CODE>).  See
  92. <A HREF="../lib/Pod/perlsub.html#synopsis">SYNOPSIS in the perlsub manpage</A>.  Such forward declaration creates ``subroutine
  93. stubs'', which are place holders with no code.</P>
  94. <P>The AutoSplit and <STRONG>AutoLoader</STRONG> modules automate the creation of forward
  95. declarations.  The AutoSplit module creates an 'index' file containing
  96. forward declarations of all the AutoSplit subroutines.  When the
  97. AutoLoader module is 'use'd it loads these declarations into its callers
  98. package.</P>
  99. <P>Because of this mechanism it is important that <STRONG>AutoLoader</STRONG> is always
  100. <A HREF="../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A>d and not <A HREF="../lib/Pod/perlfunc.html#item_require"><CODE>require</CODE></A>d.</P>
  101. <P>
  102. <H2><A NAME="using autoloader's autoload subroutine">Using <STRONG>AutoLoader</STRONG>'s AUTOLOAD Subroutine</A></H2>
  103. <P>In order to use <STRONG>AutoLoader</STRONG>'s AUTOLOAD subroutine you <EM>must</EM>
  104. explicitly import it:</P>
  105. <PRE>
  106.     use AutoLoader 'AUTOLOAD';</PRE>
  107. <P>
  108. <H2><A NAME="overriding autoloader's autoload subroutine">Overriding <STRONG>AutoLoader</STRONG>'s AUTOLOAD Subroutine</A></H2>
  109. <P>Some modules, mainly extensions, provide their own AUTOLOAD subroutines.
  110. They typically need to check for some special cases (such as constants)
  111. and then fallback to <STRONG>AutoLoader</STRONG>'s AUTOLOAD for the rest.</P>
  112. <P>Such modules should <EM>not</EM> import <STRONG>AutoLoader</STRONG>'s AUTOLOAD subroutine.
  113. Instead, they should define their own AUTOLOAD subroutines along these
  114. lines:</P>
  115. <PRE>
  116.     use AutoLoader;
  117.     use Carp;</PRE>
  118. <PRE>
  119.     sub AUTOLOAD {
  120.         my $sub = $AUTOLOAD;
  121.         (my $constname = $sub) =~ s/.*:://;
  122.         my $val = constant($constname, @_ ? $_[0] : 0);
  123.         if ($! != 0) {
  124.             if ($! =~ /Invalid/ || $!{EINVAL}) {
  125.                 $AutoLoader::AUTOLOAD = $sub;
  126.                 goto &AutoLoader::AUTOLOAD;
  127.             }
  128.             else {
  129.                 croak "Your vendor has not defined constant $constname";
  130.             }
  131.         }
  132.         *$sub = sub { $val }; # same as: eval "sub $sub { $val }";
  133.         goto &$sub;
  134.     }</PRE>
  135. <P>If any module's own AUTOLOAD subroutine has no need to fallback to the
  136. AutoLoader's AUTOLOAD subroutine (because it doesn't have any AutoSplit
  137. subroutines), then that module should not use <STRONG>AutoLoader</STRONG> at all.</P>
  138. <P>
  139. <H2><A NAME="package lexicals">Package Lexicals</A></H2>
  140. <P>Package lexicals declared with <A HREF="../lib/Pod/perlfunc.html#item_my"><CODE>my</CODE></A> in the main block of a package
  141. using <STRONG>AutoLoader</STRONG> will not be visible to auto-loaded subroutines, due to
  142. the fact that the given scope ends at the <CODE>__END__</CODE> marker.  A module
  143. using such variables as package globals will not work properly under the
  144. <STRONG>AutoLoader</STRONG>.</P>
  145. <P>The <CODE>vars</CODE> pragma (see <A HREF="../lib/Pod/perlmod.html#vars">vars in the perlmod manpage</A>) may be used in such
  146. situations as an alternative to explicitly qualifying all globals with
  147. the package namespace.  Variables pre-declared with this pragma will be
  148. visible to any autoloaded routines (but will not be invisible outside
  149. the package, unfortunately).</P>
  150. <P>
  151. <H2><A NAME="autoloader vs. selfloader"><STRONG>AutoLoader</STRONG> vs. <STRONG>SelfLoader</STRONG></A></H2>
  152. <P>The <STRONG>AutoLoader</STRONG> is similar in purpose to <STRONG>SelfLoader</STRONG>: both delay the
  153. loading of subroutines.</P>
  154. <P><STRONG>SelfLoader</STRONG> uses the <CODE>__DATA__</CODE> marker rather than <CODE>__END__</CODE>.
  155. While this avoids the use of a hierarchy of disk files and the
  156. associated open/close for each routine loaded, <STRONG>SelfLoader</STRONG> suffers a
  157. startup speed disadvantage in the one-time parsing of the lines after
  158. <CODE>__DATA__</CODE>, after which routines are cached.  <STRONG>SelfLoader</STRONG> can also
  159. handle multiple packages in a file.</P>
  160. <P><STRONG>AutoLoader</STRONG> only reads code as it is requested, and in many cases
  161. should be faster, but requires a mechanism like <STRONG>AutoSplit</STRONG> be used to
  162. create the individual files.  <A HREF="../lib/ExtUtils/MakeMaker.html">the ExtUtils::MakeMaker manpage</A> will invoke
  163. <STRONG>AutoSplit</STRONG> automatically if <STRONG>AutoLoader</STRONG> is used in a module source
  164. file.</P>
  165. <P>
  166. <HR>
  167. <H1><A NAME="caveats">CAVEATS</A></H1>
  168. <P>AutoLoaders prior to Perl 5.002 had a slightly different interface.  Any
  169. old modules which use <STRONG>AutoLoader</STRONG> should be changed to the new calling
  170. style.  Typically this just means changing a require to a use, adding
  171. the explicit <CODE>'AUTOLOAD'</CODE> import if needed, and removing <STRONG>AutoLoader</STRONG>
  172. from <CODE>@ISA</CODE>.</P>
  173. <P>On systems with restrictions on file name length, the file corresponding
  174. to a subroutine may have a shorter name that the routine itself.  This
  175. can lead to conflicting file names.  The <EM>AutoSplit</EM> package warns of
  176. these potential conflicts when used to split a module.</P>
  177. <P>AutoLoader may fail to find the autosplit files (or even find the wrong
  178. ones) in cases where <CODE>@INC</CODE> contains relative paths, <STRONG>and</STRONG> the program
  179. does <A HREF="../lib/Pod/perlfunc.html#item_chdir"><CODE>chdir</CODE></A>.</P>
  180. <P>
  181. <HR>
  182. <H1><A NAME="see also">SEE ALSO</A></H1>
  183. <P><A HREF="../lib/SelfLoader.html">the SelfLoader manpage</A> - an autoloader that doesn't use external files.</P>
  184. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  185. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  186. <STRONG><P CLASS=block> AutoLoader - load subroutines only on demand</P></STRONG>
  187. </TD></TR>
  188. </TABLE>
  189.  
  190. </BODY>
  191.  
  192. </HTML>
  193.