include/glob.h

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