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