posix/glob.h

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