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