4 our($VERSION, @ISA, @EXPORT_OK, @EXPORT_FAIL, %EXPORT_TAGS,
5 $AUTOLOAD, $DEFAULT_FLAGS);
11 # NOTE: The glob() export is only here for compatibility with 5.6.0.
12 # csh_glob() should not be used directly, unless you know what you're doing.
65 if ($_[$i] =~ /^:(case|nocase|globally)$/) {
67 $DEFAULT_FLAGS &= ~GLOB_NOCASE() if $1 eq 'case';
68 $DEFAULT_FLAGS |= GLOB_NOCASE() if $1 eq 'nocase';
69 if ($1 eq 'globally') {
71 *CORE::GLOBAL::glob = \&File::Glob::csh_glob;
77 goto &Exporter::import;
81 # This AUTOLOAD is used to 'autoload' constants from the constant()
82 # XS function. If a constant is not found then control is passed
83 # to the AUTOLOAD in AutoLoader.
86 ($constname = $AUTOLOAD) =~ s/.*:://;
87 my ($error, $val) = constant($constname);
92 eval "sub $AUTOLOAD { $val }";
96 XSLoader::load 'File::Glob', $VERSION;
98 # Preloaded methods go here.
101 return (constant('GLOB_ERROR'))[1];
112 $DEFAULT_FLAGS = GLOB_CSH();
113 if ($^O =~ /^(?:MSWin32|VMS|os2|dos|riscos|MacOS)$/) {
114 $DEFAULT_FLAGS |= GLOB_NOCASE();
117 # Autoload methods go after =cut, and are processed by the autosplit program.
120 my ($pat,$flags) = @_;
121 $flags = $DEFAULT_FLAGS if @_ < 2;
122 return doglob($pat,$flags);
125 # File::Glob::glob() is deprecated because its prototype is different from
126 # CORE::glob() (use bsd_glob() instead)
128 splice @_, 1; # don't pass PL_glob_index as flags!
132 ## borrowed heavily from gsar's File::DosGlob
141 # glob without args defaults to $_
142 $pat = $_ unless defined $pat;
145 $pat =~ s/^\s+//; # Protect against empty elements in
146 $pat =~ s/\s+$//; # things like < *.c> and <*.c >.
147 # These alone shouldn't trigger ParseWords.
149 # XXX this is needed for compatibility with the csh
150 # implementation in Perl. Need to support a flag
151 # to disable this behavior.
152 require Text::ParseWords;
153 @pat = Text::ParseWords::parse_line('\s+',0,$pat);
156 # assume global context if not provided one
157 $cxix = '_G_' unless defined $cxix;
158 $iter{$cxix} = 0 unless exists $iter{$cxix};
160 # if we're just beginning, do it all first
161 if ($iter{$cxix} == 0) {
163 $entries{$cxix} = [ map { doglob($_, $DEFAULT_FLAGS) } @pat ];
166 $entries{$cxix} = [ doglob($pat, $DEFAULT_FLAGS) ];
170 # chuck it all out, quick or slow
173 return @{delete $entries{$cxix}};
176 if ($iter{$cxix} = scalar @{$entries{$cxix}}) {
177 return shift @{$entries{$cxix}};
180 # return undef for EOL
182 delete $entries{$cxix};
193 File::Glob - Perl extension for BSD glob routine
197 use File::Glob ':glob';
198 @list = bsd_glob('*.[ch]');
199 $homedir = bsd_glob('~gnat', GLOB_TILDE | GLOB_ERR);
201 # an error occurred reading $homedir
204 ## override the core glob (CORE::glob() does this automatically
205 ## by default anyway, since v5.6.0)
206 use File::Glob ':globally';
207 my @sources = <*.{c,h,y}>
209 ## override the core glob, forcing case sensitivity
210 use File::Glob qw(:globally :case);
211 my @sources = <*.{c,h,y}>
213 ## override the core glob forcing case insensitivity
214 use File::Glob qw(:globally :nocase);
215 my @sources = <*.{c,h,y}>
219 File::Glob::bsd_glob() implements the FreeBSD glob(3) routine, which is
220 a superset of the POSIX glob() (described in IEEE Std 1003.2 "POSIX.2").
221 bsd_glob() takes a mandatory C<pattern> argument, and an optional
222 C<flags> argument, and returns a list of filenames matching the
223 pattern, with interpretation of the pattern modified by the C<flags>
226 Since v5.6.0, Perl's CORE::glob() is implemented in terms of bsd_glob().
227 Note that they don't share the same prototype--CORE::glob() only accepts
228 a single argument. Due to historical reasons, CORE::glob() will also
229 split its argument on whitespace, treating it as multiple patterns,
230 whereas bsd_glob() considers them as one pattern.
232 The POSIX defined flags for bsd_glob() are:
238 Force bsd_glob() to return an error when it encounters a directory it
239 cannot open or read. Ordinarily bsd_glob() continues to find matches.
243 Make bsd_glob() return an error (GLOB_NOSPACE) when the pattern expands
244 to a size bigger than the system constant C<ARG_MAX> (usually found in
245 limits.h). If your system does not define this constant, bsd_glob() uses
246 C<sysconf(_SC_ARG_MAX)> or C<_POSIX_ARG_MAX> where available (in that
247 order). You can inspect these values using the standard C<POSIX>
252 Each pathname that is a directory that matches the pattern has a slash
257 By default, file names are assumed to be case sensitive; this flag
258 makes bsd_glob() treat case differences as not significant.
260 =item C<GLOB_NOCHECK>
262 If the pattern does not match any pathname, then bsd_glob() returns a list
263 consisting of only the pattern. If C<GLOB_QUOTE> is set, its effect
264 is present in the pattern returned.
268 By default, the pathnames are sorted in ascending ASCII order; this
269 flag prevents that sorting (speeding up bsd_glob()).
273 The FreeBSD extensions to the POSIX standard are the following flags:
279 Pre-process the string to expand C<{pat,pat,...}> strings like csh(1).
280 The pattern '{}' is left unexpanded for historical reasons (and csh(1)
281 does the same thing to ease typing of find(1) patterns).
283 =item C<GLOB_NOMAGIC>
285 Same as C<GLOB_NOCHECK> but it only returns the pattern if it does not
286 contain any of the special characters "*", "?" or "[". C<NOMAGIC> is
287 provided to simplify implementing the historic csh(1) globbing
288 behaviour and should probably not be used anywhere else.
292 Use the backslash ('\') character for quoting: every occurrence of a
293 backslash followed by a character in the pattern is replaced by that
294 character, avoiding any special interpretation of the character.
295 (But see below for exceptions on DOSISH systems).
299 Expand patterns that start with '~' to user name home directories.
303 For convenience, C<GLOB_CSH> is a synonym for
304 C<GLOB_BRACE | GLOB_NOMAGIC | GLOB_QUOTE | GLOB_TILDE | GLOB_ALPHASORT>.
308 The POSIX provided C<GLOB_APPEND>, C<GLOB_DOOFFS>, and the FreeBSD
309 extensions C<GLOB_ALTDIRFUNC>, and C<GLOB_MAGCHAR> flags have not been
310 implemented in the Perl version because they involve more complex
311 interaction with the underlying C structures.
313 The following flag has been added in the Perl implementation for
318 =item C<GLOB_ALPHASORT>
320 If C<GLOB_NOSORT> is not in effect, sort filenames is alphabetical
321 order (case does not matter) rather than in ASCII order.
327 bsd_glob() returns a list of matching paths, possibly zero length. If an
328 error occurred, &File::Glob::GLOB_ERROR will be non-zero and C<$!> will be
329 set. &File::Glob::GLOB_ERROR is guaranteed to be zero if no error occurred,
330 or one of the following values otherwise:
334 =item C<GLOB_NOSPACE>
336 An attempt to allocate memory failed.
340 The glob was stopped because an error was encountered.
344 In the case where bsd_glob() has found some matching paths, but is
345 interrupted by an error, it will return a list of filenames B<and>
346 set &File::Glob::ERROR.
348 Note that bsd_glob() deviates from POSIX and FreeBSD glob(3) behaviour
349 by not considering C<ENOENT> and C<ENOTDIR> as errors - bsd_glob() will
350 continue processing despite those errors, unless the C<GLOB_ERR> flag is
353 Be aware that all filenames returned from File::Glob are tainted.
361 If you want to use multiple patterns, e.g. C<bsd_glob "a* b*">, you should
362 probably throw them in a set as in C<bsd_glob "{a*,b*}">. This is because
363 the argument to bsd_glob() isn't subjected to parsing by the C shell.
364 Remember that you can use a backslash to escape things.
368 On DOSISH systems, backslash is a valid directory separator character.
369 In this case, use of backslash as a quoting character (via GLOB_QUOTE)
370 interferes with the use of backslash as a directory separator. The
371 best (simplest, most portable) solution is to use forward slashes for
372 directory separators, and backslashes for quoting. However, this does
373 not match "normal practice" on these systems. As a concession to user
374 expectation, therefore, backslashes (under GLOB_QUOTE) only quote the
375 glob metacharacters '[', ']', '{', '}', '-', '~', and backslash itself.
376 All other backslashes are passed through unchanged.
380 Win32 users should use the real slash. If you really want to use
381 backslashes, consider using Sarathy's File::DosGlob, which comes with
382 the standard Perl distribution.
386 Mac OS (Classic) users should note a few differences. Since
387 Mac OS is not Unix, when the glob code encounters a tilde glob (e.g.
388 ~user) and the C<GLOB_TILDE> flag is used, it simply returns that
389 pattern without doing any expansion.
391 Glob on Mac OS is case-insensitive by default (if you don't use any
392 flags). If you specify any flags at all and still want glob
393 to be case-insensitive, you must include C<GLOB_NOCASE> in the flags.
395 The path separator is ':' (aka colon), not '/' (aka slash). Mac OS users
396 should be careful about specifying relative pathnames. While a full path
397 always begins with a volume name, a relative pathname should always
398 begin with a ':'. If specifying a volume name only, a trailing ':' is
401 The specification of pathnames in glob patterns adheres to the usual Mac
402 OS conventions: The path separator is a colon ':', not a slash '/'. A
403 full path always begins with a volume name. A relative pathname on Mac
404 OS must always begin with a ':', except when specifying a file or
405 directory name in the current working directory, where the leading colon
406 is optional. If specifying a volume name only, a trailing ':' is
407 required. Due to these rules, a glob like E<lt>*:E<gt> will find all
408 mounted volumes, while a glob like E<lt>*E<gt> or E<lt>:*E<gt> will find
409 all files and directories in the current directory.
411 Note that updirs in the glob pattern are resolved before the matching begins,
412 i.e. a pattern like "*HD:t?p::a*" will be matched as "*HD:a*". Note also,
413 that a single trailing ':' in the pattern is ignored (unless it's a volume
414 name pattern like "*HD:"), i.e. a glob like E<lt>:*:E<gt> will find both
415 directories I<and> files (and not, as one might expect, only directories).
416 You can, however, use the C<GLOB_MARK> flag to distinguish (without a file
417 test) directory names from file names.
419 If the C<GLOB_MARK> flag is set, all directory paths will have a ':' appended.
420 Since a directory like 'lib:' is I<not> a valid I<relative> path on Mac OS,
421 both a leading and a trailing colon will be added, when the directory name in
422 question doesn't contain any colons (e.g. 'lib' becomes ':lib:').
428 The Perl interface was written by Nathan Torkington E<lt>gnat@frii.comE<gt>,
429 and is released under the artistic license. Further modifications were
430 made by Greg Bacon E<lt>gbacon@cs.uah.eduE<gt>, Gurusamy Sarathy
431 E<lt>gsar@activestate.comE<gt>, and Thomas Wegner
432 E<lt>wegner_thomas@yahoo.comE<gt>. The C glob code has the
435 Copyright (c) 1989, 1993 The Regents of the University of California.
438 This code is derived from software contributed to Berkeley by
441 Redistribution and use in source and binary forms, with or without
442 modification, are permitted provided that the following conditions
445 1. Redistributions of source code must retain the above copyright
446 notice, this list of conditions and the following disclaimer.
447 2. Redistributions in binary form must reproduce the above copyright
448 notice, this list of conditions and the following disclaimer in the
449 documentation and/or other materials provided with the distribution.
450 3. Neither the name of the University nor the names of its contributors
451 may be used to endorse or promote products derived from this software
452 without specific prior written permission.
454 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
455 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
456 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
457 ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
458 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
459 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
460 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
461 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
462 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
463 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF