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