home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _8f84ca36df1971d6d0d2f66925703743 < prev    next >
Text File  |  2000-03-23  |  5KB  |  138 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Recurse - Recurse over files, performing some function.</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> File::Recurse - Recurse over files, performing some function.</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="#context">Context</A></LI>
  28.         <LI><A HREF="#controling recursion">Controling Recursion</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  32.     <LI><A HREF="#author">AUTHOR</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>File::Recurse - Recurse over files, performing some function.</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  43. <UL>
  44. <LI>Linux</LI>
  45. <LI>Solaris</LI>
  46. <LI>Windows</LI>
  47. </UL>
  48. <HR>
  49. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  50. <PRE>
  51.         use File::Recurse;
  52.         use File::Copy;</PRE>
  53. <PRE>
  54.         recurse { print } "/tmp";
  55.         recurse {copy($_,"elsewhere") if -f $_} "dir";
  56.         recurse(\&func, "/");</PRE>
  57. <P>
  58. <HR>
  59. <H1><A NAME="description">DESCRIPTION</A></H1>
  60. <P>The <CODE>File::Recurse</CODE> module is designed for performing an operation
  61. on a tree of directories and files. The basic usage is simmilar
  62. to the <EM>find.pl</EM> library. Once one uses the File::Recurse module,
  63. you need only call the <CODE>recurse</CODE> function in order to perform
  64. recursive directory operations.</P>
  65. <P>The function takes two parameters a function reference and a
  66. directory. The function referenced by the first parameter
  67. should expect to take one
  68. parameter: the full path to the file currently being operated on. This
  69. function is called once for every file and directory under the
  70. directory named by the second parameter.</P>
  71. <P>For example:</P>
  72. <PRE>
  73.         recurse(\&func, "/");</PRE>
  74. <P>would start at the top level of the filesystem and call ``func''
  75. for every file and directory found (not including ``/'').</P>
  76. <P>Perl allows a second form of calling this function which can be
  77. useful for situations where you want to do something simple in
  78. the function. In these cases, you can define an anonymous function
  79. by using braces like so:</P>
  80. <PRE>
  81.         recurse {print $_[0]} "/";</PRE>
  82. <P>This would print every file and directory in the filesystem. However,
  83. as an added convenience you can access the pathname in the variable
  84. <CODE>$_</CODE>. So the above could be rewritten as:</P>
  85. <PRE>
  86.         recurse { print } "/";</PRE>
  87. <P>
  88. <H2><A NAME="context">Context</A></H2>
  89. <P>There is an optional third parameter which can be any scalar value
  90. (including a reference). This value is ignored by recurse, but will be
  91. passed as the second parameter to the user-defined function. This can
  92. be useful for building library routines that use recurse, so that
  93. they do not have to pass state to the function as global variables.</P>
  94. <P>
  95. <H2><A NAME="controling recursion">Controling Recursion</A></H2>
  96. <P>If you want to control how recursion happens, you have several
  97. options. First, there are some global variables that affect the overall
  98. operation of the recurse routine:</P>
  99. <DL>
  100. <DT><STRONG><A NAME="item_%24MAX_DEPTH"><CODE>$MAX_DEPTH</CODE></A></STRONG><BR>
  101. <DD>
  102. This variable controls how far down a tree of directories recurse
  103. will go before it assumes that something bad has happened. Default:
  104. 100.
  105. <P></P>
  106. <DT><STRONG><A NAME="item_%24FOLLOW_SYMLINKS"><CODE>$FOLLOW_SYMLINKS</CODE></A></STRONG><BR>
  107. <DD>
  108. This variable tells recurse if it should descend into directories that are
  109. symbolic links. Default: 0.
  110. <P></P></DL>
  111. <P>Normally, the return value of the function called is not used, but
  112. if it is -1 or -2, there is a special action taken.</P>
  113. <P>If the function returns -1 and the current filename refers to a
  114. directory, recurse will <STRONG>not</STRONG> descend into that directory. This
  115. can be used to prune searches and focus only on those directories
  116. which should be followed.</P>
  117. <P>If the function returns -2, the search is terminated, and recurse
  118. will return. This can be used to bail when a problem occurs, and you
  119. don't want to exit the program, or to end the search for some
  120. file once it is found.</P>
  121. <P>
  122. <HR>
  123. <H1><A NAME="see also">SEE ALSO</A></H1>
  124. <P><A HREF="../../../site/lib/File/Tools.html">the File::Tools manpage</A></P>
  125. <P>
  126. <HR>
  127. <H1><A NAME="author">AUTHOR</A></H1>
  128. <P>Written in 1996 by Aaron Sherman, <A HREF="mailto:ajs@ajs.com">ajs@ajs.com</A></P>
  129. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  130. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  131. <STRONG><P CLASS=block> File::Recurse - Recurse over files, performing some function.</P></STRONG>
  132. </TD></TR>
  133. </TABLE>
  134.  
  135. </BODY>
  136.  
  137. </HTML>
  138.