home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _ef3e1376630aa79a31bb9aad3c15856c < prev    next >
Encoding:
Text File  |  2000-03-23  |  5.8 KB  |  152 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>AutoSplit - split a package for autoloading</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> AutoSplit - split a package for autoloading</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="#multiple packages">Multiple packages</A></LI>
  28.     </UL>
  29.  
  30.     <LI><A HREF="#diagnostics">DIAGNOSTICS</A></LI>
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>AutoSplit - split a package for autoloading</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Linux</LI>
  43. <LI>Solaris</LI>
  44. <LI>Windows</LI>
  45. </UL>
  46. <HR>
  47. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  48. <PRE>
  49.  autosplit($file, $dir, $keep, $check, $modtime);</PRE>
  50. <PRE>
  51.  autosplit_lib_modules(@modules);</PRE>
  52. <P>
  53. <HR>
  54. <H1><A NAME="description">DESCRIPTION</A></H1>
  55. <P>This function will split up your program into files that the AutoLoader
  56. module can handle. It is used by both the standard perl libraries and by
  57. the MakeMaker utility, to automatically configure libraries for autoloading.</P>
  58. <P>The <CODE>autosplit</CODE> interface splits the specified file into a hierarchy 
  59. rooted at the directory <CODE>$dir</CODE>. It creates directories as needed to reflect
  60. class hierarchy, and creates the file <EM>autosplit.ix</EM>. This file acts as
  61. both forward declaration of all package routines, and as timestamp for the
  62. last update of the hierarchy.</P>
  63. <P>The remaining three arguments to <CODE>autosplit</CODE> govern other options to
  64. the autosplitter.</P>
  65. <DL>
  66. <DT><STRONG><A NAME="item_%24keep">$keep</A></STRONG><BR>
  67. <DD>
  68. If the third argument, <EM>$keep</EM>, is false, then any
  69. pre-existing <CODE>*.al</CODE> files in the autoload directory are removed if
  70. they are no longer part of the module (obsoleted functions).
  71. $keep defaults to 0.
  72. <P></P>
  73. <DT><STRONG><A NAME="item_%24check">$check</A></STRONG><BR>
  74. <DD>
  75. The
  76. fourth argument, <EM>$check</EM>, instructs <CODE>autosplit</CODE> to check the module
  77. currently being split to ensure that it does include a <A HREF="../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A>
  78. specification for the AutoLoader module, and skips the module if
  79. AutoLoader is not detected.
  80. $check defaults to 1.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_%24modtime">$modtime</A></STRONG><BR>
  83. <DD>
  84. Lastly, the <EM>$modtime</EM> argument specifies
  85. that <CODE>autosplit</CODE> is to check the modification time of the module
  86. against that of the <CODE>autosplit.ix</CODE> file, and only split the module if
  87. it is newer.
  88. $modtime defaults to 1.
  89. <P></P></DL>
  90. <P>Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
  91. with:</P>
  92. <PRE>
  93.  perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'</PRE>
  94. <P>Defined as a Make macro, it is invoked with file and directory arguments;
  95. <CODE>autosplit</CODE> will split the specified file into the specified directory and
  96. delete obsolete <CODE>.al</CODE> files, after checking first that the module does use
  97. the AutoLoader, and ensuring that the module is not already currently split
  98. in its current form (the modtime test).</P>
  99. <P>The <CODE>autosplit_lib_modules</CODE> form is used in the building of perl. It takes
  100. as input a list of files (modules) that are assumed to reside in a directory
  101. <STRONG>lib</STRONG> relative to the current directory. Each file is sent to the 
  102. autosplitter one at a time, to be split into the directory <STRONG>lib/auto</STRONG>.</P>
  103. <P>In both usages of the autosplitter, only subroutines defined following the
  104. perl <EM>__END__</EM> token are split out into separate files. Some
  105. routines may be placed prior to this marker to force their immediate loading
  106. and parsing.</P>
  107. <P>
  108. <H2><A NAME="multiple packages">Multiple packages</A></H2>
  109. <P>As of version 1.01 of the AutoSplit module it is possible to have
  110. multiple packages within a single file. Both of the following cases
  111. are supported:</P>
  112. <PRE>
  113.    package NAME;
  114.    __END__
  115.    sub AAA { ... }
  116.    package NAME::option1;
  117.    sub BBB { ... }
  118.    package NAME::option2;
  119.    sub BBB { ... }</PRE>
  120. <PRE>
  121.    package NAME;
  122.    __END__
  123.    sub AAA { ... }
  124.    sub NAME::option1::BBB { ... }
  125.    sub NAME::option2::BBB { ... }</PRE>
  126. <P>
  127. <HR>
  128. <H1><A NAME="diagnostics">DIAGNOSTICS</A></H1>
  129. <P><CODE>AutoSplit</CODE> will inform the user if it is necessary to create the
  130. top-level directory specified in the invocation. It is preferred that
  131. the script or installation process that invokes <CODE>AutoSplit</CODE> have
  132. created the full directory path ahead of time. This warning may
  133. indicate that the module is being split into an incorrect path.</P>
  134. <P><CODE>AutoSplit</CODE> will warn the user of all subroutines whose name causes
  135. potential file naming conflicts on machines with drastically limited
  136. (8 characters or less) file name length. Since the subroutine name is
  137. used as the file name, these warnings can aid in portability to such
  138. systems.</P>
  139. <P>Warnings are issued and the file skipped if <CODE>AutoSplit</CODE> cannot locate
  140. either the <EM>__END__</EM> marker or a ``package Name;''-style specification.</P>
  141. <P><CODE>AutoSplit</CODE> will also emit general diagnostics for inability to
  142. create directories or files.</P>
  143. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  144. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  145. <STRONG><P CLASS=block> AutoSplit - split a package for autoloading</P></STRONG>
  146. </TD></TR>
  147. </TABLE>
  148.  
  149. </BODY>
  150.  
  151. </HTML>
  152.