mingw/html/lib/File/DosGlob.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>File::DosGlob - DOS like globbing and then some</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;File::DosGlob - DOS like globbing and then some</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#synopsis">SYNOPSIS</a></li>
  24         <li><a href="#description">DESCRIPTION</a></li>
  25         <li><a href="#notes">NOTES</a></li>
  26         <li><a href="#exports__by_request_only_">EXPORTS (by request only)</a></li>
  27         <li><a href="#bugs">BUGS</a></li>
  28         <li><a href="#author">AUTHOR</a></li>
  29         <li><a href="#history">HISTORY</a></li>
  30         <li><a href="#see_also">SEE ALSO</a></li>
  31 </ul>
  32 <!-- INDEX END -->
  33
  34 <hr />
  35 <p>
  36 </p>
  37 <h1><a name="name">NAME</a></h1>
  38 <p>File::DosGlob - DOS like globbing and then some</p>
  39 <p>
  40 </p>
  41 <hr />
  42 <h1><a name="synopsis">SYNOPSIS</a></h1>
  43 <pre>
  44     require 5.004;</pre>
  45 <pre>
  46     # override CORE::glob in current package
  47     use File::DosGlob 'glob';</pre>
  48 <pre>
  49     # override CORE::glob in ALL packages (use with extreme caution!)
  50     use File::DosGlob 'GLOBAL_glob';</pre>
  51 <pre>
  52     @perlfiles = glob  &quot;..\\pe?l/*.p?&quot;;
  53     print &lt;..\\pe?l/*.p?&gt;;</pre>
  54 <pre>
  55     # from the command line (overrides only in main::)
  56     &gt; perl -MFile::DosGlob=glob -e &quot;print &lt;../pe*/*p?&gt;&quot;</pre>
  57 <p>
  58 </p>
  59 <hr />
  60 <h1><a name="description">DESCRIPTION</a></h1>
  61 <p>A module that implements DOS-like globbing with a few enhancements.
  62 It is largely compatible with perlglob.exe (the M$ setargv.obj
  63 version) in all but one respect--it understands wildcards in
  64 directory components.</p>
  65 <p>For example, <code>&lt;..\\l*b\\file/*glob.p?</code>&gt; will work as expected (in
  66 that it will find something like '..\lib\File/DosGlob.pm' alright).
  67 Note that all path components are case-insensitive, and that
  68 backslashes and forward slashes are both accepted, and preserved.
  69 You may have to double the backslashes if you are putting them in
  70 literally, due to double-quotish parsing of the pattern by perl.</p>
  71 <p>Spaces in the argument delimit distinct patterns, so
  72 <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_glob"><code>glob('*.exe *.dll')</code></a> globs all filenames that end in <code>.exe</code>
  73 or <code>.dll</code>.  If you want to put in literal spaces in the glob
  74 pattern, you can escape them with either double quotes, or backslashes.
  75 e.g. <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_glob"><code>glob('c:/&quot;Program Files&quot;/*/*.dll')</code></a>, or
  76 <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_glob"><code>glob('c:/Program\ Files/*/*.dll')</code></a>.  The argument is tokenized using
  77 <code>Text::ParseWords::parse_line()</code>, so see <a href="file://C|\msysgit\mingw\html/lib/Text/ParseWords.html">the Text::ParseWords manpage</a> for details
  78 of the quoting rules used.</p>
  79 <p>Extending it to csh patterns is left as an exercise to the reader.</p>
  80 <p>
  81 </p>
  82 <hr />
  83 <h1><a name="notes">NOTES</a></h1>
  84 <ul>
  85 <li>
  86 <p>Mac OS (Classic) users should note a few differences. The specification
  87 of pathnames in glob patterns adheres to the usual Mac OS conventions:
  88 The path separator is a colon ':', not a slash '/' or backslash '\'. A
  89 full path always begins with a volume name. A relative pathname on Mac
  90 OS must always begin with a ':', except when specifying a file or
  91 directory name in the current working directory, where the leading colon
  92 is optional. If specifying a volume name only, a trailing ':' is
  93 required. Due to these rules, a glob like &lt;*:&gt; will find all
  94 mounted volumes, while a glob like &lt;*&gt; or &lt;:*&gt; will find
  95 all files and directories in the current directory.</p>
  96 <p>Note that updirs in the glob pattern are resolved before the matching begins,
  97 i.e. a pattern like ``*HD:t?p::a*'' will be matched as ``*HD:a*''. Note also,
  98 that a single trailing ':' in the pattern is ignored (unless it's a volume
  99 name pattern like ``*HD:''), i.e. a glob like &lt;:*:&gt; will find both directories
 100 <em>and</em> files (and not, as one might expect, only directories).</p>
 101 <p>The metachars '*', '?' and the escape char '\' are valid characters in
 102 volume, directory and file names on Mac OS. Hence, if you want to match
 103 a '*', '?' or '\' literally, you have to escape these characters. Due to
 104 perl's quoting rules, things may get a bit complicated, when you want to
 105 match a string like '\*' literally, or when you want to match '\' literally,
 106 but treat the immediately following character '*' as metachar. So, here's a
 107 rule of thumb (applies to both single- and double-quoted strings): escape
 108 each '*' or '?' or '\' with a backslash, if you want to treat them literally,
 109 and then double each backslash and your are done. E.g.</p>
 110 <p>- Match '\*' literally</p>
 111 <pre>
 112    escape both '\' and '*'  : '\\\*'
 113    double the backslashes   : '\\\\\\*'</pre>
 114 <p>(Internally, the glob routine sees a '\\\*', which means that both '\' and
 115 '*' are escaped.)</p>
 116 <p>- Match '\' literally, treat '*' as metachar</p>
 117 <pre>
 118    escape '\' but not '*'   : '\\*'
 119    double the backslashes   : '\\\\*'</pre>
 120 <p>(Internally, the glob routine sees a '\\*', which means that '\' is escaped and
 121 '*' is not.)</p>
 122 <p>Note that you also have to quote literal spaces in the glob pattern, as described
 123 above.</p>
 124 </li>
 125 </ul>
 126 <p>
 127 </p>
 128 <hr />
 129 <h1><a name="exports__by_request_only_">EXPORTS (by request only)</a></h1>
 130 <p><a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_glob"><code>glob()</code></a></p>
 131 <p>
 132 </p>
 133 <hr />
 134 <h1><a name="bugs">BUGS</a></h1>
 135 <p>Should probably be built into the core, and needs to stop
 136 pandering to DOS habits.  Needs a dose of optimizium too.</p>
 137 <p>
 138 </p>
 139 <hr />
 140 <h1><a name="author">AUTHOR</a></h1>
 141 <p>Gurusamy Sarathy &lt;<a href="mailto:gsar@activestate.com">gsar@activestate.com</a>&gt;</p>
 142 <p>
 143 </p>
 144 <hr />
 145 <h1><a name="history">HISTORY</a></h1>
 146 <ul>
 147 <li>
 148 <p>Support for globally overriding <a href="file://C|\msysgit\mingw\html/pod/perlfunc.html#item_glob"><code>glob()</code></a> (GSAR 3-JUN-98)</p>
 149 </li>
 150 <li>
 151 <p>Scalar context, independent iterator context fixes (GSAR 15-SEP-97)</p>
 152 </li>
 153 <li>
 154 <p>A few dir-vs-file optimizations result in glob importation being
 155 10 times faster than using perlglob.exe, and using perlglob.bat is
 156 only twice as slow as perlglob.exe (GSAR 28-MAY-97)</p>
 157 </li>
 158 <li>
 159 <p>Several cleanups prompted by lack of compatible perlglob.exe
 160 under Borland (GSAR 27-MAY-97)</p>
 161 </li>
 162 <li>
 163 <p>Initial version (GSAR 20-FEB-97)</p>
 164 </li>
 165 </ul>
 166 <p>
 167 </p>
 168 <hr />
 169 <h1><a name="see_also">SEE ALSO</a></h1>
 170 <p>perl
 171
 172 </p>
 173 <p>perlglob.bat
 174
 175 </p>
 176 <p>Text::ParseWords
 177
 178 </p>
 179 <table border="0" width="100%" cellspacing="0" cellpadding="3">
 180 <tr><td class="block" style="background-color: #cccccc" valign="middle">
 181 <big><strong><span class="block">&nbsp;File::DosGlob - DOS like globbing and then some</span></strong></big>
 182 </td></tr>
 183 </table>
 184
 185 </body>
 186
 187 </html>