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