1 |
/* Copyright (C) 1991,92,95-98,2000,2001,2004 Free Software Foundation, Inc. |
/* glob_.h -- Find a path matching a pattern. |
|
This file is part of the GNU C Library. |
|
2 |
|
|
3 |
The GNU C Library is free software; you can redistribute it and/or |
Copyright (C) 2005 Free Software Foundation, Inc. |
|
modify it under the terms of the GNU Lesser General Public |
|
|
License as published by the Free Software Foundation; either |
|
|
version 2.1 of the License, or (at your option) any later version. |
|
4 |
|
|
5 |
The GNU C Library is distributed in the hope that it will be useful, |
Written by Derek Price <derek@ximbiot.com> & Paul Eggert <eggert@CS.UCLA.EDU> |
6 |
|
|
7 |
|
This program is free software; you can redistribute it and/or modify |
8 |
|
it under the terms of the GNU General Public License as published by |
9 |
|
the Free Software Foundation; either version 2, or (at your option) |
10 |
|
any later version. |
11 |
|
|
12 |
|
This program is distributed in the hope that it will be useful, |
13 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 |
Lesser General Public License for more details. |
GNU General Public License for more details. |
16 |
|
|
17 |
|
You should have received a copy of the GNU General Public License |
18 |
|
along with this program; if not, write to the Free Software Foundation, |
19 |
|
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ |
20 |
|
|
21 |
|
#ifndef GLOB_H |
22 |
|
#define GLOB_H 1 |
23 |
|
|
24 |
You should have received a copy of the GNU Lesser General Public |
#ifdef HAVE_SYS_CDEFS_H |
|
License along with the GNU C Library; if not, write to the Free |
|
|
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
|
|
02111-1307 USA. */ |
|
|
|
|
|
#ifndef _GLOB_H |
|
|
#define _GLOB_H 1 |
|
|
|
|
|
/* Note the reversal of the common HAVE_SYS_CDEFS_H idiom below. In this |
|
|
way, #ifndef _SYS_CDEFS_H may be used to include <sys/cdefs.h> both when |
|
|
it has been checked for via the GNULIB configure test and found and when |
|
|
it has not been checked for, which we can presume means that the <glob.h> |
|
|
GNULIB shares with GLIBC is being included as a system header and not as |
|
|
part of GNULIB, in which case <sys/cdefs.h> may be assumed. */ |
|
|
#ifndef _SYS_CDEFS_H |
|
25 |
# include <sys/cdefs.h> |
# include <sys/cdefs.h> |
26 |
#endif |
#endif |
27 |
|
|
28 |
|
#include <stddef.h> |
29 |
|
|
30 |
#ifndef __BEGIN_DECLS |
#ifndef __BEGIN_DECLS |
31 |
# define __BEGIN_DECLS |
# define __BEGIN_DECLS |
32 |
# define __END_DECLS |
# define __END_DECLS |
35 |
# define __THROW |
# define __THROW |
36 |
#endif |
#endif |
37 |
|
|
38 |
__BEGIN_DECLS |
#ifndef __size_t |
|
|
|
|
/* We need `size_t' for the following definitions. */ |
|
|
#ifndef GLOB_PREFIX |
|
|
# ifndef __size_t |
|
|
# if defined __GNUC__ && __GNUC__ >= 2 |
|
|
typedef __SIZE_TYPE__ __size_t; |
|
|
# ifdef __USE_XOPEN |
|
|
typedef __SIZE_TYPE__ size_t; |
|
|
# endif |
|
|
# else |
|
|
# include <stddef.h> |
|
|
# ifndef __size_t |
|
|
# define __size_t size_t |
|
|
# endif |
|
|
# endif |
|
|
# else |
|
|
/* The GNU CC stddef.h version defines __size_t as empty. We need a real |
|
|
definition. */ |
|
|
# undef __size_t |
|
|
# define __size_t size_t |
|
|
# endif |
|
|
#else /* GLOB_PREFIX */ |
|
|
# include <stddef.h> |
|
|
# undef __size_t |
|
39 |
# define __size_t size_t |
# define __size_t size_t |
40 |
#endif /* !GLOB_PREFIX */ |
#endif |
41 |
|
#ifndef __const |
42 |
|
# define __const const |
43 |
|
#endif |
44 |
|
#ifndef __restrict |
45 |
|
# define __restrict restrict |
46 |
|
#endif |
47 |
|
#ifndef __USE_GNU |
48 |
|
# define __USE_GNU 1 |
49 |
|
#endif |
50 |
|
|
51 |
#ifdef GLOB_PREFIX |
|
52 |
/* get struct stat */ |
#ifndef HAVE_DIRENT_H |
53 |
# include <sys/stat.h> |
# define dirent direct |
|
|
|
|
/* The following are necessary with MSVC and who knows where else. */ |
|
|
# ifndef __const |
|
|
# define __const const |
|
|
# endif |
|
|
# ifndef __restrict |
|
|
# define __restrict restrict |
|
|
# endif |
|
|
# ifndef __USE_GNU |
|
|
# define __USE_GNU 1 |
|
|
# endif |
|
|
#endif /* GLOB_PREFIX */ |
|
|
|
|
|
/* Bits set in the FLAGS argument to `glob'. */ |
|
|
#define GLOB_ERR (1 << 0)/* Return on read errors. */ |
|
|
#define GLOB_MARK (1 << 1)/* Append a slash to each name. */ |
|
|
#define GLOB_NOSORT (1 << 2)/* Don't sort the names. */ |
|
|
#define GLOB_DOOFFS (1 << 3)/* Insert PGLOB->gl_offs NULLs. */ |
|
|
#define GLOB_NOCHECK (1 << 4)/* If nothing matches, return the pattern. */ |
|
|
#define GLOB_APPEND (1 << 5)/* Append to results of a previous call. */ |
|
|
#define GLOB_NOESCAPE (1 << 6)/* Backslashes don't quote metacharacters. */ |
|
|
#define GLOB_PERIOD (1 << 7)/* Leading `.' can be matched by metachars. */ |
|
|
|
|
|
#if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU |
|
|
# define GLOB_MAGCHAR (1 << 8)/* Set in gl_flags if any metachars seen. */ |
|
|
# define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions. */ |
|
|
# define GLOB_BRACE (1 << 10)/* Expand "{a,b}" to "a" "b". */ |
|
|
# define GLOB_NOMAGIC (1 << 11)/* If no magic chars, return the pattern. */ |
|
|
# define GLOB_TILDE (1 << 12)/* Expand ~user and ~ to home directories. */ |
|
|
# define GLOB_ONLYDIR (1 << 13)/* Match only directories. */ |
|
|
# define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error |
|
|
if the user name is not available. */ |
|
|
# define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \ |
|
|
GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \ |
|
|
GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE| \ |
|
|
GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK) |
|
|
#else |
|
|
# define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \ |
|
|
GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \ |
|
|
GLOB_PERIOD) |
|
|
#endif |
|
|
|
|
|
/* Error returns from `glob'. */ |
|
|
#define GLOB_NOSPACE 1 /* Ran out of memory. */ |
|
|
#define GLOB_ABORTED 2 /* Read error. */ |
|
|
#define GLOB_NOMATCH 3 /* No matches found. */ |
|
|
#define GLOB_NOSYS 4 /* Not implemented. */ |
|
|
#ifdef __USE_GNU |
|
|
/* Previous versions of this file defined GLOB_ABEND instead of |
|
|
GLOB_ABORTED. Provide a compatibility definition here. */ |
|
|
# define GLOB_ABEND GLOB_ABORTED |
|
|
#endif |
|
|
|
|
|
/* Structure describing a globbing run. */ |
|
|
#ifdef __USE_GNU |
|
|
struct stat; |
|
|
#endif |
|
|
typedef struct |
|
|
{ |
|
|
__size_t gl_pathc; /* Count of paths matched by the pattern. */ |
|
|
char **gl_pathv; /* List of matched pathnames. */ |
|
|
__size_t gl_offs; /* Slots to reserve in `gl_pathv'. */ |
|
|
int gl_flags; /* Set to FLAGS, maybe | GLOB_MAGCHAR. */ |
|
|
|
|
|
/* If the GLOB_ALTDIRFUNC flag is set, the following functions |
|
|
are used instead of the normal file access functions. */ |
|
|
void (*gl_closedir) (void *); |
|
|
#ifdef __USE_GNU |
|
|
# if defined HAVE_DIRENT_H || defined __GNU_LIBRARY__ |
|
|
struct dirent *(*gl_readdir) (void *); |
|
|
# else |
|
|
struct direct *(*gl_readdir) (void *); |
|
|
# endif |
|
|
#else |
|
|
void *(*gl_readdir) (void *); |
|
|
#endif |
|
|
void *(*gl_opendir) (__const char *); |
|
|
#ifdef __USE_GNU |
|
|
int (*gl_lstat) (__const char *__restrict, struct stat *__restrict); |
|
|
int (*gl_stat) (__const char *__restrict, struct stat *__restrict); |
|
|
#else |
|
|
int (*gl_lstat) (__const char *__restrict, void *__restrict); |
|
|
int (*gl_stat) (__const char *__restrict, void *__restrict); |
|
|
#endif |
|
|
} glob_t; |
|
|
|
|
|
#if !defined GLOB_PREFIX && defined __USE_LARGEFILE64 |
|
|
# ifdef __USE_GNU |
|
|
struct stat64; |
|
|
# endif |
|
|
typedef struct |
|
|
{ |
|
|
__size_t gl_pathc; |
|
|
char **gl_pathv; |
|
|
__size_t gl_offs; |
|
|
int gl_flags; |
|
|
|
|
|
/* If the GLOB_ALTDIRFUNC flag is set, the following functions |
|
|
are used instead of the normal file access functions. */ |
|
|
void (*gl_closedir) (void *); |
|
|
# ifdef __USE_GNU |
|
|
struct dirent64 *(*gl_readdir) (void *); |
|
|
# else |
|
|
void *(*gl_readdir) (void *); |
|
|
# endif |
|
|
void *(*gl_opendir) (__const char *); |
|
|
# ifdef __USE_GNU |
|
|
int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict); |
|
|
int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict); |
|
|
# else |
|
|
int (*gl_lstat) (__const char *__restrict, void *__restrict); |
|
|
int (*gl_stat) (__const char *__restrict, void *__restrict); |
|
|
# endif |
|
|
} glob64_t; |
|
|
#endif |
|
|
|
|
|
#ifdef GLOB_PREFIX |
|
|
# define __GLOB_CONCAT(x, y) x ## y |
|
|
# define __GLOB_XCONCAT(x, y) __GLOB_CONCAT (x, y) |
|
|
# define __GLOB_ID(y) __GLOB_XCONCAT (GLOB_PREFIX, y) |
|
|
# define glob __GLOB_ID (glob) |
|
|
# define globfree __GLOB_ID (globfree) |
|
|
# define glob_pattern_p __GLOB_ID (glob_pattern_p) |
|
|
#else |
|
|
# if __USE_FILE_OFFSET64 && __GNUC__ < 2 |
|
|
# define glob glob64 |
|
|
# define globfree globfree64 |
|
|
# endif |
|
|
#endif |
|
|
|
|
|
/* Do glob searching for PATTERN, placing results in PGLOB. |
|
|
The bits defined above may be set in FLAGS. |
|
|
If a directory cannot be opened or read and ERRFUNC is not nil, |
|
|
it is called with the pathname that caused the error, and the |
|
|
`errno' value from the failing call; if it returns non-zero |
|
|
`glob' returns GLOB_ABEND; if it returns zero, the error is ignored. |
|
|
If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned. |
|
|
Otherwise, `glob' returns zero. */ |
|
|
#if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2 || defined GLOB_PREFIX |
|
|
extern int glob (__const char *__restrict __pattern, int __flags, |
|
|
int (*__errfunc) (__const char *, int), |
|
|
glob_t *__restrict __pglob) __THROW; |
|
|
|
|
|
/* Free storage allocated in PGLOB by a previous `glob' call. */ |
|
|
extern void globfree (glob_t *__pglob) __THROW; |
|
|
#else |
|
|
extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern, |
|
|
int __flags, |
|
|
int (*__errfunc) (__const char *, int), |
|
|
glob_t *__restrict __pglob), glob64); |
|
|
|
|
|
extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64); |
|
|
#endif |
|
|
|
|
|
#if !defined GLOB_PREFIX && defined __USE_LARGEFILE64 |
|
|
extern int glob64 (__const char *__restrict __pattern, int __flags, |
|
|
int (*__errfunc) (__const char *, int), |
|
|
glob64_t *__restrict __pglob) __THROW; |
|
|
|
|
|
extern void globfree64 (glob64_t *__pglob) __THROW; |
|
|
#endif |
|
|
|
|
|
|
|
|
#ifdef __USE_GNU |
|
|
/* Return nonzero if PATTERN contains any metacharacters. |
|
|
Metacharacters can be quoted with backslashes if QUOTE is nonzero. |
|
|
|
|
|
This function is not part of the interface specified by POSIX.2 |
|
|
but several programs want to use it. */ |
|
|
extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW; |
|
54 |
#endif |
#endif |
55 |
|
|
56 |
__END_DECLS |
#define glob rpl_glob |
57 |
|
#define globfree rpl_globfree |
58 |
|
#define glob_pattern_p rpl_glob_pattern_p |
59 |
|
|
60 |
|
#define __GLOB_GNULIB 1 |
61 |
|
|
62 |
|
/* Now the standard GNU C Library header should work. */ |
63 |
|
#include "glob-libc.h" |
64 |
|
|
65 |
#endif /* glob.h */ |
#endif /* GLOB_H */ |