lib/glob_.h

   1 /* Copyright (C) 1991,92,95-98,2000,2001,2004 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library 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 GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 #ifndef _GLOB_H
  20 #define _GLOB_H 1
  21
  22 /* Note the reversal of the common HAVE_SYS_CDEFS_H idiom below.  In this
  23    way, #ifndef _SYS_CDEFS_H may be used to include <sys/cdefs.h> both when
  24    it has been checked for via the GNULIB configure test and found and when
  25    it has not been checked for, which we can presume means that the <glob.h>
  26    GNULIB shares with GLIBC is being included as a system header and not as
  27    part of GNULIB, in which case <sys/cdefs.h> may be assumed.  */
  28 #ifndef _SYS_CDEFS_H
  29 # include <sys/cdefs.h>
  30 #endif
  31 #ifndef __BEGIN_DECLS
  32 # define __BEGIN_DECLS
  33 # define __END_DECLS
  34 #endif
  35 #ifndef __THROW
  36 # define __THROW
  37 #endif
  38
  39 __BEGIN_DECLS
  40
  41 /* We need `size_t' for the following definitions.  */
  42 #ifndef GLOB_PREFIX
  43 # ifndef __size_t
  44 #  if defined __GNUC__ && __GNUC__ >= 2
  45 typedef __SIZE_TYPE__ __size_t;
  46 #   ifdef __USE_XOPEN
  47 typedef __SIZE_TYPE__ size_t;
  48 #   endif
  49 #  else
  50 #   include <stddef.h>
  51 #   ifndef __size_t
  52 #    define __size_t size_t
  53 #   endif
  54 #  endif
  55 # else
  56 /* The GNU CC stddef.h version defines __size_t as empty.  We need a real
  57    definition.  */
  58 #  undef __size_t
  59 #  define __size_t size_t
  60 # endif
  61 #else /* GLOB_PREFIX */
  62 # include <stddef.h>
  63 # undef __size_t
  64 # define __size_t       size_t
  65 #endif /* !GLOB_PREFIX */
  66
  67 #ifdef GLOB_PREFIX
  68 /* get struct stat */
  69 # include <sys/stat.h>
  70
  71 /* The following are necessary with MSVC and who knows where else.  */
  72 # ifndef __const
  73 #  define __const       const
  74 # endif
  75 # ifndef __restrict
  76 #  define __restrict    restrict
  77 # endif
  78 # ifndef __USE_GNU
  79 #  define __USE_GNU     1
  80 # endif
  81 #endif /* GLOB_PREFIX */
  82
  83 /* Bits set in the FLAGS argument to `glob'.  */
  84 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
  85 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
  86 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
  87 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
  88 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
  89 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
  90 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
  91 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
  92
  93 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
  94 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
  95 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
  96 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
  97 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
  98 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
  99 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
 100 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
 101                                       if the user name is not available.  */
 102 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 103                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 104                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
 105                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
 106 #else
 107 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 108                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 109                          GLOB_PERIOD)
 110 #endif
 111
 112 /* Error returns from `glob'.  */
 113 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
 114 #define GLOB_ABORTED    2       /* Read error.  */
 115 #define GLOB_NOMATCH    3       /* No matches found.  */
 116 #define GLOB_NOSYS      4       /* Not implemented.  */
 117 #ifdef __USE_GNU
 118 /* Previous versions of this file defined GLOB_ABEND instead of
 119    GLOB_ABORTED.  Provide a compatibility definition here.  */
 120 # define GLOB_ABEND GLOB_ABORTED
 121 #endif
 122
 123 /* Structure describing a globbing run.  */
 124 #ifdef __USE_GNU
 125 struct stat;
 126 #endif
 127 typedef struct
 128   {
 129     __size_t gl_pathc;          /* Count of paths matched by the pattern.  */
 130     char **gl_pathv;            /* List of matched pathnames.  */
 131     __size_t gl_offs;           /* Slots to reserve in `gl_pathv'.  */
 132     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
 133
 134     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 135        are used instead of the normal file access functions.  */
 136     void (*gl_closedir) (void *);
 137 #ifdef __USE_GNU
 138 # if defined HAVE_DIRENT_H || defined __GNU_LIBRARY__
 139     struct dirent *(*gl_readdir) (void *);
 140 # else
 141     struct direct *(*gl_readdir) (void *);
 142 # endif
 143 #else
 144     void *(*gl_readdir) (void *);
 145 #endif
 146     void *(*gl_opendir) (__const char *);
 147 #ifdef __USE_GNU
 148     int (*gl_lstat) (__const char *__restrict, struct stat *__restrict);
 149     int (*gl_stat) (__const char *__restrict, struct stat *__restrict);
 150 #else
 151     int (*gl_lstat) (__const char *__restrict, void *__restrict);
 152     int (*gl_stat) (__const char *__restrict, void *__restrict);
 153 #endif
 154   } glob_t;
 155
 156 #if !defined GLOB_PREFIX && defined __USE_LARGEFILE64
 157 # ifdef __USE_GNU
 158 struct stat64;
 159 # endif
 160 typedef struct
 161   {
 162     __size_t gl_pathc;
 163     char **gl_pathv;
 164     __size_t gl_offs;
 165     int gl_flags;
 166
 167     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 168        are used instead of the normal file access functions.  */
 169     void (*gl_closedir) (void *);
 170 # ifdef __USE_GNU
 171     struct dirent64 *(*gl_readdir) (void *);
 172 # else
 173     void *(*gl_readdir) (void *);
 174 # endif
 175     void *(*gl_opendir) (__const char *);
 176 # ifdef __USE_GNU
 177     int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
 178     int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
 179 # else
 180     int (*gl_lstat) (__const char *__restrict, void *__restrict);
 181     int (*gl_stat) (__const char *__restrict, void *__restrict);
 182 # endif
 183   } glob64_t;
 184 #endif
 185
 186 #ifdef GLOB_PREFIX
 187 # define __GLOB_CONCAT(x, y) x ## y
 188 # define __GLOB_XCONCAT(x, y) __GLOB_CONCAT (x, y)
 189 # define __GLOB_ID(y) __GLOB_XCONCAT (GLOB_PREFIX, y)
 190 # define glob __GLOB_ID (glob)
 191 # define globfree __GLOB_ID (globfree)
 192 # define glob_pattern_p __GLOB_ID (glob_pattern_p)
 193 #else
 194 # if __USE_FILE_OFFSET64 && __GNUC__ < 2
 195 #  define glob glob64
 196 #  define globfree globfree64
 197 # endif
 198 #endif
 199
 200 /* Do glob searching for PATTERN, placing results in PGLOB.
 201    The bits defined above may be set in FLAGS.
 202    If a directory cannot be opened or read and ERRFUNC is not nil,
 203    it is called with the pathname that caused the error, and the
 204    `errno' value from the failing call; if it returns non-zero
 205    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
 206    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
 207    Otherwise, `glob' returns zero.  */
 208 #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2 || defined GLOB_PREFIX
 209 extern int glob (__const char *__restrict __pattern, int __flags,
 210                  int (*__errfunc) (__const char *, int),
 211                  glob_t *__restrict __pglob) __THROW;
 212
 213 /* Free storage allocated in PGLOB by a previous `glob' call.  */
 214 extern void globfree (glob_t *__pglob) __THROW;
 215 #else
 216 extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern,
 217                                   int __flags,
 218                                   int (*__errfunc) (__const char *, int),
 219                                   glob_t *__restrict __pglob), glob64);
 220
 221 extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
 222 #endif
 223
 224 #if !defined GLOB_PREFIX && defined __USE_LARGEFILE64
 225 extern int glob64 (__const char *__restrict __pattern, int __flags,
 226                    int (*__errfunc) (__const char *, int),
 227                    glob64_t *__restrict __pglob) __THROW;
 228
 229 extern void globfree64 (glob64_t *__pglob) __THROW;
 230 #endif
 231
 232
 233 #ifdef __USE_GNU
 234 /* Return nonzero if PATTERN contains any metacharacters.
 235    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
 236
 237    This function is not part of the interface specified by POSIX.2
 238    but several programs want to use it.  */
 239 extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW;
 240 #endif
 241
 242 __END_DECLS
 243
 244 #endif /* glob.h  */