lib/glob-libc.h

   1 /* Copyright (C) 1991,92,95-98,2000,2001,2004-2007 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _GLOB_H
  18 #define _GLOB_H 1
  19
  20 #ifndef __GLOB_GNULIB
  21 # include <sys/cdefs.h>
  22 #endif
  23
  24 /* GCC 2.95 and later have "__restrict"; C99 compilers have
  25    "restrict", and "configure" may have defined "restrict".
  26    Other compilers use __restrict, __restrict__, and _Restrict, and
  27    'configure' might #define 'restrict' to those words, so pick a
  28    different name.  */
  29 #ifndef _Restrict_
  30 # if 199901L <= __STDC_VERSION__
  31 #  define _Restrict_ restrict
  32 # elif 2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__)
  33 #  define _Restrict_ __restrict
  34 # else
  35 #  define _Restrict_
  36 # endif
  37 #endif
  38
  39 __BEGIN_DECLS
  40
  41 /* We need `size_t' for the following definitions.  */
  42 #ifndef __size_t
  43 # if defined __GNUC__ && __GNUC__ >= 2
  44 typedef __SIZE_TYPE__ __size_t;
  45 #  ifdef __USE_XOPEN
  46 typedef __SIZE_TYPE__ size_t;
  47 #  endif
  48 # else
  49 #  include <stddef.h>
  50 #  ifndef __size_t
  51 #   define __size_t size_t
  52 #  endif
  53 # endif
  54 #else
  55 /* The GNU CC stddef.h version defines __size_t as empty.  We need a real
  56    definition.  */
  57 # undef __size_t
  58 # define __size_t size_t
  59 #endif
  60
  61 /* Bits set in the FLAGS argument to `glob'.  */
  62 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
  63 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
  64 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
  65 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
  66 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
  67 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
  68 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
  69 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
  70
  71 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
  72 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
  73 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
  74 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
  75 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
  76 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
  77 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
  78 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
  79                                       if the user name is not available.  */
  80 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  81                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
  82                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
  83                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
  84 #else
  85 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  86                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
  87                          GLOB_PERIOD)
  88 #endif
  89
  90 /* Error returns from `glob'.  */
  91 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
  92 #define GLOB_ABORTED    2       /* Read error.  */
  93 #define GLOB_NOMATCH    3       /* No matches found.  */
  94 #define GLOB_NOSYS      4       /* Not implemented.  */
  95 #ifdef __USE_GNU
  96 /* Previous versions of this file defined GLOB_ABEND instead of
  97    GLOB_ABORTED.  Provide a compatibility definition here.  */
  98 # define GLOB_ABEND GLOB_ABORTED
  99 #endif
 100
 101 /* Structure describing a globbing run.  */
 102 #ifdef __USE_GNU
 103 struct stat;
 104 #endif
 105 typedef struct
 106   {
 107     __size_t gl_pathc;          /* Count of paths matched by the pattern.  */
 108     char **gl_pathv;            /* List of matched pathnames.  */
 109     __size_t gl_offs;           /* Slots to reserve in `gl_pathv'.  */
 110     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
 111
 112     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 113        are used instead of the normal file access functions.  */
 114     void (*gl_closedir) (void *);
 115 #ifdef __USE_GNU
 116     struct dirent *(*gl_readdir) (void *);
 117 #else
 118     void *(*gl_readdir) (void *);
 119 #endif
 120     void *(*gl_opendir) (const char *);
 121 #ifdef __USE_GNU
 122     int (*gl_lstat) (const char *_Restrict_, struct stat *_Restrict_);
 123     int (*gl_stat) (const char *_Restrict_, struct stat *_Restrict_);
 124 #else
 125     int (*gl_lstat) (const char *_Restrict_, void *_Restrict_);
 126     int (*gl_stat) (const char *_Restrict_, void *_Restrict_);
 127 #endif
 128   } glob_t;
 129
 130 #if defined __USE_LARGEFILE64 && !defined __GLOB_GNULIB
 131 # ifdef __USE_GNU
 132 struct stat64;
 133 # endif
 134 typedef struct
 135   {
 136     __size_t gl_pathc;
 137     char **gl_pathv;
 138     __size_t gl_offs;
 139     int gl_flags;
 140
 141     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 142        are used instead of the normal file access functions.  */
 143     void (*gl_closedir) (void *);
 144 # ifdef __USE_GNU
 145     struct dirent64 *(*gl_readdir) (void *);
 146 # else
 147     void *(*gl_readdir) (void *);
 148 # endif
 149     void *(*gl_opendir) (const char *);
 150 # ifdef __USE_GNU
 151     int (*gl_lstat) (const char *_Restrict_, struct stat64 *_Restrict_);
 152     int (*gl_stat) (const char *_Restrict_, struct stat64 *_Restrict_);
 153 # else
 154     int (*gl_lstat) (const char *_Restrict_, void *_Restrict_);
 155     int (*gl_stat) (const char *_Restrict_, void *_Restrict_);
 156 # endif
 157   } glob64_t;
 158 #endif
 159
 160 #if __USE_FILE_OFFSET64 && __GNUC__ < 2 && !defined __GLOB_GNULIB
 161 # define glob glob64
 162 # define globfree globfree64
 163 #endif
 164
 165 /* Do glob searching for PATTERN, placing results in PGLOB.
 166    The bits defined above may be set in FLAGS.
 167    If a directory cannot be opened or read and ERRFUNC is not nil,
 168    it is called with the pathname that caused the error, and the
 169    `errno' value from the failing call; if it returns non-zero
 170    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
 171    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
 172    Otherwise, `glob' returns zero.  */
 173 #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2 || defined __GLOB_GNULIB
 174 extern int glob (const char *_Restrict_ __pattern, int __flags,
 175                  int (*__errfunc) (const char *, int),
 176                  glob_t *_Restrict_ __pglob) __THROW;
 177
 178 /* Free storage allocated in PGLOB by a previous `glob' call.  */
 179 extern void globfree (glob_t *__pglob) __THROW;
 180 #else
 181 extern int __REDIRECT_NTH (glob, (const char *_Restrict_ __pattern,
 182                                   int __flags,
 183                                   int (*__errfunc) (const char *, int),
 184                                   glob_t *_Restrict_ __pglob), glob64);
 185
 186 extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
 187 #endif
 188
 189 #if defined __USE_LARGEFILE64 && !defined __GLOB_GNULIB
 190 extern int glob64 (const char *_Restrict_ __pattern, int __flags,
 191                    int (*__errfunc) (const char *, int),
 192                    glob64_t *_Restrict_ __pglob) __THROW;
 193
 194 extern void globfree64 (glob64_t *__pglob) __THROW;
 195 #endif
 196
 197
 198 #ifdef __USE_GNU
 199 /* Return nonzero if PATTERN contains any metacharacters.
 200    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
 201
 202    This function is not part of the interface specified by POSIX.2
 203    but several programs want to use it.  */
 204 extern int glob_pattern_p (const char *__pattern, int __quote) __THROW;
 205 #endif
 206
 207 __END_DECLS
 208
 209 #endif /* glob.h  */