home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _d4d5ad9cdd6b466c96452c2a1b432fe5 < prev    next >
Text File  |  2000-03-23  |  11KB  |  234 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Glob - Perl extension for BSD glob routine</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::Glob - Perl extension for BSD glob routine</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.     <LI><A HREF="#diagnostics">DIAGNOSTICS</A></LI>
  26.     <LI><A HREF="#notes">NOTES</A></LI>
  27.     <LI><A HREF="#author">AUTHOR</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>File::Glob - Perl extension for BSD glob routine</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.   use File::Glob ':glob';
  47.   @list = glob('*.[ch]');
  48.   $homedir = glob('~gnat', GLOB_TILDE | GLOB_ERR);
  49.   if (GLOB_ERROR) {
  50.     # an error occurred reading $homedir
  51.   }</PRE>
  52. <PRE>
  53.   ## override the core glob (core glob() does this automatically
  54.   ## by default anyway, since v5.6.0)
  55.   use File::Glob ':globally';
  56.   my @sources = <*.{c,h,y}></PRE>
  57. <PRE>
  58.   ## override the core glob, forcing case sensitivity
  59.   use File::Glob qw(:globally :case);
  60.   my @sources = <*.{c,h,y}></PRE>
  61. <PRE>
  62.   ## override the core glob forcing case insensitivity
  63.   use File::Glob qw(:globally :nocase);
  64.   my @sources = <*.{c,h,y}></PRE>
  65. <P>
  66. <HR>
  67. <H1><A NAME="description">DESCRIPTION</A></H1>
  68. <P>File::Glob implements the FreeBSD <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob(3)</CODE></A> routine, which is a superset
  69. of the POSIX <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> (described in IEEE Std 1003.2 ``POSIX.2'').  The
  70. <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> routine takes a mandatory <CODE>pattern</CODE> argument, and an optional
  71. <CODE>flags</CODE> argument, and returns a list of filenames matching the
  72. pattern, with interpretation of the pattern modified by the <CODE>flags</CODE>
  73. variable.  The POSIX defined flags are:</P>
  74. <DL>
  75. <DT><STRONG><A NAME="item_GLOB_ERR"><CODE>GLOB_ERR</CODE></A></STRONG><BR>
  76. <DD>
  77. Force <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> to return an error when it encounters a directory it
  78. cannot open or read.  Ordinarily <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> continues to find matches.
  79. <P></P>
  80. <DT><STRONG><A NAME="item_GLOB_MARK"><CODE>GLOB_MARK</CODE></A></STRONG><BR>
  81. <DD>
  82. Each pathname that is a directory that matches the pattern has a slash
  83. appended.
  84. <P></P>
  85. <DT><STRONG><A NAME="item_GLOB_NOCASE"><CODE>GLOB_NOCASE</CODE></A></STRONG><BR>
  86. <DD>
  87. By default, file names are assumed to be case sensitive; this flag
  88. makes <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> treat case differences as not significant.
  89. <P></P>
  90. <DT><STRONG><A NAME="item_GLOB_NOCHECK"><CODE>GLOB_NOCHECK</CODE></A></STRONG><BR>
  91. <DD>
  92. If the pattern does not match any pathname, then <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> returns a list
  93. consisting of only the pattern.  If <A HREF="#item_GLOB_QUOTE"><CODE>GLOB_QUOTE</CODE></A> is set, its effect
  94. is present in the pattern returned.
  95. <P></P>
  96. <DT><STRONG><A NAME="item_GLOB_NOSORT"><CODE>GLOB_NOSORT</CODE></A></STRONG><BR>
  97. <DD>
  98. By default, the pathnames are sorted in ascending ASCII order; this
  99. flag prevents that sorting (speeding up glob()).
  100. <P></P></DL>
  101. <P>The FreeBSD extensions to the POSIX standard are the following flags:</P>
  102. <DL>
  103. <DT><STRONG><A NAME="item_GLOB_BRACE"><CODE>GLOB_BRACE</CODE></A></STRONG><BR>
  104. <DD>
  105. Pre-process the string to expand <CODE>{pat,pat,...}</CODE> strings like csh(1).
  106. The pattern '{}' is left unexpanded for historical reasons (and <CODE>csh(1)</CODE>
  107. does the same thing to ease typing of <CODE>find(1)</CODE> patterns).
  108. <P></P>
  109. <DT><STRONG><A NAME="item_GLOB_NOMAGIC"><CODE>GLOB_NOMAGIC</CODE></A></STRONG><BR>
  110. <DD>
  111. Same as <A HREF="#item_GLOB_NOCHECK"><CODE>GLOB_NOCHECK</CODE></A> but it only returns the pattern if it does not
  112. contain any of the special characters ``*'', ``?'' or ``[''.  <CODE>NOMAGIC</CODE> is
  113. provided to simplify implementing the historic <CODE>csh(1)</CODE> globbing
  114. behaviour and should probably not be used anywhere else.
  115. <P></P>
  116. <DT><STRONG><A NAME="item_GLOB_QUOTE"><CODE>GLOB_QUOTE</CODE></A></STRONG><BR>
  117. <DD>
  118. Use the backslash ('\') character for quoting: every occurrence of a
  119. backslash followed by a character in the pattern is replaced by that
  120. character, avoiding any special interpretation of the character.
  121. (But see below for exceptions on DOSISH systems).
  122. <P></P>
  123. <DT><STRONG><A NAME="item_GLOB_TILDE"><CODE>GLOB_TILDE</CODE></A></STRONG><BR>
  124. <DD>
  125. Expand patterns that start with '~' to user name home directories.
  126. <P></P>
  127. <DT><STRONG><A NAME="item_GLOB_CSH"><CODE>GLOB_CSH</CODE></A></STRONG><BR>
  128. <DD>
  129. For convenience, <A HREF="#item_GLOB_CSH"><CODE>GLOB_CSH</CODE></A> is a synonym for
  130. <CODE>GLOB_BRACE | GLOB_NOMAGIC | GLOB_QUOTE | GLOB_TILDE</CODE>.
  131. <P></P></DL>
  132. <P>The POSIX provided <CODE>GLOB_APPEND</CODE>, <CODE>GLOB_DOOFFS</CODE>, and the FreeBSD
  133. extensions <CODE>GLOB_ALTDIRFUNC</CODE>, and <CODE>GLOB_MAGCHAR</CODE> flags have not been
  134. implemented in the Perl version because they involve more complex
  135. interaction with the underlying C structures.</P>
  136. <P>
  137. <HR>
  138. <H1><A NAME="diagnostics">DIAGNOSTICS</A></H1>
  139. <P><A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> returns a list of matching paths, possibly zero length.  If an
  140. error occurred, &File::Glob::GLOB_ERROR will be non-zero and <CODE>$!</CODE> will be
  141. set.  &File::Glob::GLOB_ERROR is guaranteed to be zero if no error occurred,
  142. or one of the following values otherwise:</P>
  143. <DL>
  144. <DT><STRONG><A NAME="item_GLOB_NOSPACE"><CODE>GLOB_NOSPACE</CODE></A></STRONG><BR>
  145. <DD>
  146. An attempt to allocate memory failed.
  147. <P></P>
  148. <DT><STRONG><A NAME="item_GLOB_ABEND"><CODE>GLOB_ABEND</CODE></A></STRONG><BR>
  149. <DD>
  150. The glob was stopped because an error was encountered.
  151. <P></P></DL>
  152. <P>In the case where <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> has found some matching paths, but is
  153. interrupted by an error, <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> will return a list of filenames <STRONG>and</STRONG>
  154. set &File::Glob::ERROR.</P>
  155. <P>Note that <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> deviates from POSIX and FreeBSD <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob(3)</CODE></A> behaviour by
  156. not considering <CODE>ENOENT</CODE> and <CODE>ENOTDIR</CODE> as errors - <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob()</CODE></A> will
  157. continue processing despite those errors, unless the <A HREF="#item_GLOB_ERR"><CODE>GLOB_ERR</CODE></A> flag is
  158. set.</P>
  159. <P>Be aware that all filenames returned from File::Glob are tainted.</P>
  160. <P>
  161. <HR>
  162. <H1><A NAME="notes">NOTES</A></H1>
  163. <UL>
  164. <LI>
  165. If you want to use multiple patterns, e.g. <CODE>glob "a* b*"</CODE>, you should
  166. probably throw them in a set as in <CODE>glob "{a*,b*}</CODE>.  This is because
  167. the argument to glob isn't subjected to parsing by the C shell.  Remember
  168. that you can use a backslash to escape things.
  169. <P></P>
  170. <LI>
  171. On DOSISH systems, backslash is a valid directory separator character.
  172. In this case, use of backslash as a quoting character (via GLOB_QUOTE)
  173. interferes with the use of backslash as a directory separator. The
  174. best (simplest, most portable) solution is to use forward slashes for
  175. directory separators, and backslashes for quoting. However, this does
  176. not match ``normal practice'' on these systems. As a concession to user
  177. expectation, therefore, backslashes (under GLOB_QUOTE) only quote the
  178. glob metacharacters '[', ']', '{', '}', '-', '~', and backslash itself.
  179. All other backslashes are passed through unchanged.
  180. <P></P>
  181. <LI>
  182. Win32 users should use the real slash.  If you really want to use
  183. backslashes, consider using Sarathy's File::DosGlob, which comes with
  184. the standard Perl distribution.
  185. <P></P></UL>
  186. <P>
  187. <HR>
  188. <H1><A NAME="author">AUTHOR</A></H1>
  189. <P>The Perl interface was written by Nathan Torkington <<A HREF="mailto:gnat@frii.com">gnat@frii.com</A>>,
  190. and is released under the artistic license.  Further modifications were
  191. made by Greg Bacon <<A HREF="mailto:gbacon@cs.uah.edu">gbacon@cs.uah.edu</A>> and Gurusamy Sarathy
  192. <<A HREF="mailto:gsar@activestate.com">gsar@activestate.com</A>>.  The C glob code has the
  193. following copyright:</P>
  194. <PRE>
  195.     Copyright (c) 1989, 1993 The Regents of the University of California.
  196.     All rights reserved.</PRE>
  197. <PRE>
  198.     This code is derived from software contributed to Berkeley by
  199.     Guido van Rossum.</PRE>
  200. <PRE>
  201.     Redistribution and use in source and binary forms, with or without
  202.     modification, are permitted provided that the following conditions
  203.     are met:</PRE>
  204. <PRE>
  205.     1. Redistributions of source code must retain the above copyright
  206.        notice, this list of conditions and the following disclaimer.
  207.     2. Redistributions in binary form must reproduce the above copyright
  208.        notice, this list of conditions and the following disclaimer in the
  209.        documentation and/or other materials provided with the distribution.
  210.     3. Neither the name of the University nor the names of its contributors
  211.        may be used to endorse or promote products derived from this software
  212.        without specific prior written permission.</PRE>
  213. <PRE>
  214.     THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  215.     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  216.     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  217.     ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  218.     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  219.     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  220.     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  221.     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  222.     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  223.     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  224.     SUCH DAMAGE.</PRE>
  225. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  226. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  227. <STRONG><P CLASS=block> File::Glob - Perl extension for BSD glob routine</P></STRONG>
  228. </TD></TR>
  229. </TABLE>
  230.  
  231. </BODY>
  232.  
  233. </HTML>
  234.