posix/glob.h

   1 /* Copyright (C) 1991,1992,1995-1998,2000,2001,2004,2010
   2    Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _GLOB_H
  21 #define _GLOB_H 1
  22
  23 #include <sys/cdefs.h>
  24
  25 __BEGIN_DECLS
  26
  27 /* We need `size_t' for the following definitions.  */
  28 #ifndef __size_t
  29 # if defined __GNUC__ && __GNUC__ >= 2
  30 typedef __SIZE_TYPE__ __size_t;
  31 #  if defined __USE_XOPEN || __USE_XOPEN2K8
  32 typedef __SIZE_TYPE__ size_t;
  33 #  endif
  34 # else
  35 #  include <stddef.h>
  36 #  ifndef __size_t
  37 #   define __size_t size_t
  38 #  endif
  39 # endif
  40 #else
  41 /* The GNU CC stddef.h version defines __size_t as empty.  We need a real
  42    definition.  */
  43 # undef __size_t
  44 # define __size_t size_t
  45 #endif
  46
  47 /* Bits set in the FLAGS argument to `glob'.  */
  48 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
  49 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
  50 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
  51 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
  52 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
  53 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
  54 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
  55 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
  56
  57 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
  58 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
  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
  76 /* Error returns from `glob'.  */
  77 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
  78 #define GLOB_ABORTED    2       /* Read error.  */
  79 #define GLOB_NOMATCH    3       /* No matches found.  */
  80 #define GLOB_NOSYS      4       /* Not implemented.  */
  81 #ifdef __USE_GNU
  82 /* Previous versions of this file defined GLOB_ABEND instead of
  83    GLOB_ABORTED.  Provide a compatibility definition here.  */
  84 # define GLOB_ABEND GLOB_ABORTED
  85 #endif
  86
  87 /* Structure describing a globbing run.  */
  88 #ifdef __USE_GNU
  89 struct stat;
  90 #endif
  91 typedef struct
  92   {
  93     __size_t gl_pathc;          /* Count of paths matched by the pattern.  */
  94     char **gl_pathv;            /* List of matched pathnames.  */
  95     __size_t gl_offs;           /* Slots to reserve in `gl_pathv'.  */
  96     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
  97
  98     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
  99        are used instead of the normal file access functions.  */
 100     void (*gl_closedir) (void *);
 101 #ifdef __USE_GNU
 102     struct dirent *(*gl_readdir) (void *);
 103 #else
 104     void *(*gl_readdir) (void *);
 105 #endif
 106     void *(*gl_opendir) (__const char *);
 107 #ifdef __USE_GNU
 108     int (*gl_lstat) (__const char *__restrict, struct stat *__restrict);
 109     int (*gl_stat) (__const char *__restrict, struct stat *__restrict);
 110 #else
 111     int (*gl_lstat) (__const char *__restrict, void *__restrict);
 112     int (*gl_stat) (__const char *__restrict, void *__restrict);
 113 #endif
 114   } glob_t;
 115
 116 #ifdef __USE_LARGEFILE64
 117 # ifdef __USE_GNU
 118 struct stat64;
 119 # endif
 120 typedef struct
 121   {
 122     __size_t gl_pathc;
 123     char **gl_pathv;
 124     __size_t gl_offs;
 125     int gl_flags;
 126
 127     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 128        are used instead of the normal file access functions.  */
 129     void (*gl_closedir) (void *);
 130 # ifdef __USE_GNU
 131     struct dirent64 *(*gl_readdir) (void *);
 132 # else
 133     void *(*gl_readdir) (void *);
 134 # endif
 135     void *(*gl_opendir) (__const char *);
 136 # ifdef __USE_GNU
 137     int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
 138     int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
 139 # else
 140     int (*gl_lstat) (__const char *__restrict, void *__restrict);
 141     int (*gl_stat) (__const char *__restrict, void *__restrict);
 142 # endif
 143   } glob64_t;
 144 #endif
 145
 146 #if __USE_FILE_OFFSET64 && __GNUC__ < 2
 147 # define glob glob64
 148 # define globfree globfree64
 149 #endif
 150
 151 /* Do glob searching for PATTERN, placing results in PGLOB.
 152    The bits defined above may be set in FLAGS.
 153    If a directory cannot be opened or read and ERRFUNC is not nil,
 154    it is called with the pathname that caused the error, and the
 155    `errno' value from the failing call; if it returns non-zero
 156    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
 157    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
 158    Otherwise, `glob' returns zero.  */
 159 #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2
 160 extern int glob (__const char *__restrict __pattern, int __flags,
 161                  int (*__errfunc) (__const char *, int),
 162                  glob_t *__restrict __pglob) __THROW;
 163
 164 /* Free storage allocated in PGLOB by a previous `glob' call.  */
 165 extern void globfree (glob_t *__pglob) __THROW;
 166 #else
 167 extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern,
 168                                   int __flags,
 169                                   int (*__errfunc) (__const char *, int),
 170                                   glob_t *__restrict __pglob), glob64);
 171
 172 extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
 173 #endif
 174
 175 #ifdef __USE_LARGEFILE64
 176 extern int glob64 (__const char *__restrict __pattern, int __flags,
 177                    int (*__errfunc) (__const char *, int),
 178                    glob64_t *__restrict __pglob) __THROW;
 179
 180 extern void globfree64 (glob64_t *__pglob) __THROW;
 181 #endif
 182
 183
 184 #ifdef __USE_GNU
 185 /* Return nonzero if PATTERN contains any metacharacters.
 186    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
 187
 188    This function is not part of the interface specified by POSIX.2
 189    but several programs want to use it.  */
 190 extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW;
 191 #endif
 192
 193 __END_DECLS
 194
 195 #endif /* glob.h  */