Back to index

glibc  2.9
glob.h
Go to the documentation of this file.
00001 /* Copyright (C) 1991,92,95-98,2000,2001,2004 Free Software Foundation, Inc.
00002    This file is part of the GNU C Library.
00003 
00004    The GNU C Library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Lesser General Public
00006    License as published by the Free Software Foundation; either
00007    version 2.1 of the License, or (at your option) any later version.
00008 
00009    The GNU C Library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Lesser General Public License for more details.
00013 
00014    You should have received a copy of the GNU Lesser General Public
00015    License along with the GNU C Library; if not, write to the Free
00016    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00017    02111-1307 USA.  */
00018 
00019 #ifndef       _GLOB_H
00020 #define       _GLOB_H       1
00021 
00022 #include <sys/cdefs.h>
00023 
00024 __BEGIN_DECLS
00025 
00026 /* We need `size_t' for the following definitions.  */
00027 #ifndef __size_t
00028 # if defined __GNUC__ && __GNUC__ >= 2
00029 typedef __SIZE_TYPE__ __size_t;
00030 #  ifdef __USE_XOPEN
00031 typedef __SIZE_TYPE__ size_t;
00032 #  endif
00033 # else
00034 #  include <stddef.h>
00035 #  ifndef __size_t
00036 #   define __size_t size_t
00037 #  endif
00038 # endif
00039 #else
00040 /* The GNU CC stddef.h version defines __size_t as empty.  We need a real
00041    definition.  */
00042 # undef __size_t
00043 # define __size_t size_t
00044 #endif
00045 
00046 /* Bits set in the FLAGS argument to `glob'.  */
00047 #define       GLOB_ERR      (1 << 0)/* Return on read errors.  */
00048 #define       GLOB_MARK     (1 << 1)/* Append a slash to each name.  */
00049 #define       GLOB_NOSORT   (1 << 2)/* Don't sort the names.  */
00050 #define       GLOB_DOOFFS   (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
00051 #define       GLOB_NOCHECK  (1 << 4)/* If nothing matches, return the pattern.  */
00052 #define       GLOB_APPEND   (1 << 5)/* Append to results of a previous call.  */
00053 #define       GLOB_NOESCAPE (1 << 6)/* Backslashes don't quote metacharacters.  */
00054 #define       GLOB_PERIOD   (1 << 7)/* Leading `.' can be matched by metachars.  */
00055 
00056 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
00057 # define GLOB_MAGCHAR        (1 << 8)/* Set in gl_flags if any metachars seen.  */
00058 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
00059 # define GLOB_BRACE   (1 << 10)/* Expand "{a,b}" to "a" "b".  */
00060 # define GLOB_NOMAGIC        (1 << 11)/* If no magic chars, return the pattern.  */
00061 # define GLOB_TILDE   (1 << 12)/* Expand ~user and ~ to home directories. */
00062 # define GLOB_ONLYDIR        (1 << 13)/* Match only directories.  */
00063 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
00064                                   if the user name is not available.  */
00065 # define __GLOB_FLAGS       (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
00066                       GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
00067                       GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
00068                       GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
00069 #else
00070 # define __GLOB_FLAGS       (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
00071                       GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
00072                       GLOB_PERIOD)
00073 #endif
00074 
00075 /* Error returns from `glob'.  */
00076 #define       GLOB_NOSPACE  1      /* Ran out of memory.  */
00077 #define       GLOB_ABORTED  2      /* Read error.  */
00078 #define       GLOB_NOMATCH  3      /* No matches found.  */
00079 #define GLOB_NOSYS   4      /* Not implemented.  */
00080 #ifdef __USE_GNU
00081 /* Previous versions of this file defined GLOB_ABEND instead of
00082    GLOB_ABORTED.  Provide a compatibility definition here.  */
00083 # define GLOB_ABEND GLOB_ABORTED
00084 #endif
00085 
00086 /* Structure describing a globbing run.  */
00087 #ifdef __USE_GNU
00088 struct stat;
00089 #endif
00090 typedef struct
00091   {
00092     __size_t gl_pathc;             /* Count of paths matched by the pattern.  */
00093     char **gl_pathv;        /* List of matched pathnames.  */
00094     __size_t gl_offs;              /* Slots to reserve in `gl_pathv'.  */
00095     int gl_flags;           /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
00096 
00097     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
00098        are used instead of the normal file access functions.  */
00099     void (*gl_closedir) (void *);
00100 #ifdef __USE_GNU
00101     struct dirent *(*gl_readdir) (void *);
00102 #else
00103     void *(*gl_readdir) (void *);
00104 #endif
00105     void *(*gl_opendir) (__const char *);
00106 #ifdef __USE_GNU
00107     int (*gl_lstat) (__const char *__restrict, struct stat *__restrict);
00108     int (*gl_stat) (__const char *__restrict, struct stat *__restrict);
00109 #else
00110     int (*gl_lstat) (__const char *__restrict, void *__restrict);
00111     int (*gl_stat) (__const char *__restrict, void *__restrict);
00112 #endif
00113   } glob_t;
00114 
00115 #ifdef __USE_LARGEFILE64
00116 # ifdef __USE_GNU
00117 struct stat64;
00118 # endif
00119 typedef struct
00120   {
00121     __size_t gl_pathc;
00122     char **gl_pathv;
00123     __size_t gl_offs;
00124     int gl_flags;
00125 
00126     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
00127        are used instead of the normal file access functions.  */
00128     void (*gl_closedir) (void *);
00129 # ifdef __USE_GNU
00130     struct dirent64 *(*gl_readdir) (void *);
00131 # else
00132     void *(*gl_readdir) (void *);
00133 # endif
00134     void *(*gl_opendir) (__const char *);
00135 # ifdef __USE_GNU
00136     int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
00137     int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
00138 # else
00139     int (*gl_lstat) (__const char *__restrict, void *__restrict);
00140     int (*gl_stat) (__const char *__restrict, void *__restrict);
00141 # endif
00142   } glob64_t;
00143 #endif
00144 
00145 #if __USE_FILE_OFFSET64 && __GNUC__ < 2
00146 # define glob glob64
00147 # define globfree globfree64
00148 #endif
00149 
00150 /* Do glob searching for PATTERN, placing results in PGLOB.
00151    The bits defined above may be set in FLAGS.
00152    If a directory cannot be opened or read and ERRFUNC is not nil,
00153    it is called with the pathname that caused the error, and the
00154    `errno' value from the failing call; if it returns non-zero
00155    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
00156    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
00157    Otherwise, `glob' returns zero.  */
00158 #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2
00159 extern int glob (__const char *__restrict __pattern, int __flags,
00160                int (*__errfunc) (__const char *, int),
00161                glob_t *__restrict __pglob) __THROW;
00162 
00163 /* Free storage allocated in PGLOB by a previous `glob' call.  */
00164 extern void globfree (glob_t *__pglob) __THROW;
00165 #else
00166 extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern,
00167                               int __flags,
00168                               int (*__errfunc) (__const char *, int),
00169                               glob_t *__restrict __pglob), glob64);
00170 
00171 extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
00172 #endif
00173 
00174 #ifdef __USE_LARGEFILE64
00175 extern int glob64 (__const char *__restrict __pattern, int __flags,
00176                  int (*__errfunc) (__const char *, int),
00177                  glob64_t *__restrict __pglob) __THROW;
00178 
00179 extern void globfree64 (glob64_t *__pglob) __THROW;
00180 #endif
00181 
00182 
00183 #ifdef __USE_GNU
00184 /* Return nonzero if PATTERN contains any metacharacters.
00185    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
00186 
00187    This function is not part of the interface specified by POSIX.2
00188    but several programs want to use it.  */
00189 extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW;
00190 #endif
00191 
00192 __END_DECLS
00193 
00194 #endif /* glob.h  */