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