glob/glob.h

   1 /* Copyright (C) 1991, 1992, 1995, 1996, 1997, 1998 Free Software Foundation,
   2 Inc.
   3
   4 The GNU C Library is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU Library General Public License as
   6 published by the Free Software Foundation; either version 2 of the
   7 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 Library General Public License for more details.
  13
  14 You should have received a copy of the GNU Library General Public License
  15 along with this library; see the file COPYING.LIB.  If not, write to the Free
  16 Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  17 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__
  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 __FreeBSD__
  52 #  define __size_t size_t
  53 # else
  54 #  if defined __GNUC__ && __GNUC__ >= 2
  55 typedef __SIZE_TYPE__ __size_t;
  56 #  else
  57 /* This is a guess.  */
  58 /*hb
  59  *      Conflicts with DECCs aready defined type __size_t.
  60  *      Defining an own type with a name beginning with '__' is no good.
  61  *      Anyway if DECC is used and __SIZE_T is defined then __size_t is
  62  *      already defined (and I hope it's exactly the one we need here).
  63  */
  64 #   if !(defined __DECC && defined __SIZE_T)
  65 typedef unsigned long int __size_t;
  66 #   endif
  67 #  endif
  68 # endif
  69 #else
  70 /* The GNU CC stddef.h version defines __size_t as empty.  We need a real
  71    definition.  */
  72 # undef __size_t
  73 # define __size_t size_t
  74 #endif
  75
  76 /* Bits set in the FLAGS argument to `glob'.  */
  77 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
  78 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
  79 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
  80 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
  81 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
  82 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
  83 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
  84 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
  85
  86 #if (!defined _POSIX_C_SOURCE || _POSIX_C_SOURCE < 2 || defined _BSD_SOURCE \
  87      || defined _GNU_SOURCE)
  88 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
  89 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
  90 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
  91 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
  92 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
  93 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
  94 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
  95                                       if the user name is not available.  */
  96 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  97                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
  98                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
  99                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
 100 #else
 101 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 102                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 103                          GLOB_PERIOD)
 104 #endif
 105
 106 /* Error returns from `glob'.  */
 107 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
 108 #define GLOB_ABORTED    2       /* Read error.  */
 109 #define GLOB_NOMATCH    3       /* No matches found.  */
 110 #define GLOB_NOSYS      4       /* Not implemented.  */
 111 #ifdef _GNU_SOURCE
 112 /* Previous versions of this file defined GLOB_ABEND instead of
 113    GLOB_ABORTED.  Provide a compatibility definition here.  */
 114 # define GLOB_ABEND GLOB_ABORTED
 115 #endif
 116
 117 /* Structure describing a globbing run.  */
 118 #if !defined _AMIGA && !defined VMS /* Buggy compiler.   */
 119 struct stat;
 120 #endif
 121 typedef struct
 122   {
 123     __size_t gl_pathc;          /* Count of paths matched by the pattern.  */
 124     char **gl_pathv;            /* List of matched pathnames.  */
 125     __size_t gl_offs;           /* Slots to reserve in `gl_pathv'.  */
 126     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
 127
 128     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 129        are used instead of the normal file access functions.  */
 130     void (*gl_closedir) __PMT ((void *));
 131     struct dirent *(*gl_readdir) __PMT ((void *));
 132     __ptr_t (*gl_opendir) __PMT ((__const char *));
 133     int (*gl_lstat) __PMT ((__const char *, struct stat *));
 134 #if defined(VMS) && defined(__DECC) && !defined(_POSIX_C_SOURCE)
 135     int (*gl_stat) __PMT ((__const char *, struct stat *, ...));
 136 #else
 137     int (*gl_stat) __PMT ((__const char *, struct stat *));
 138 #endif
 139   } glob_t;
 140
 141 #ifdef _LARGEFILE64_SOURCE
 142 struct stat64;
 143 typedef struct
 144   {
 145     __size_t gl_pathc;
 146     char **gl_pathv;
 147     __size_t gl_offs;
 148     int gl_flags;
 149
 150     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 151        are used instead of the normal file access functions.  */
 152     void (*gl_closedir) __PMT ((void *));
 153     struct dirent64 *(*gl_readdir) __PMT ((void *));
 154     __ptr_t (*gl_opendir) __PMT ((__const char *));
 155     int (*gl_lstat) __PMT ((__const char *, struct stat64 *));
 156     int (*gl_stat) __PMT ((__const char *, struct stat64 *));
 157   } glob64_t;
 158 #endif
 159
 160 #if _FILE_OFFSET_BITS == 64 && __GNUC__ < 2
 161 # define glob glob64
 162 # define globfree globfree64
 163 #else
 164 # ifdef _LARGEFILE64_SOURCE
 165 extern int glob64 __P ((__const char *__pattern, int __flags,
 166                         int (*__errfunc) (__const char *, int),
 167                         glob64_t *__pglob));
 168
 169 extern void globfree64 __P ((glob64_t *__pglob));
 170 # endif
 171 #endif
 172
 173 /* Do glob searching for PATTERN, placing results in PGLOB.
 174    The bits defined above may be set in FLAGS.
 175    If a directory cannot be opened or read and ERRFUNC is not nil,
 176    it is called with the pathname that caused the error, and the
 177    `errno' value from the failing call; if it returns non-zero
 178    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
 179    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
 180    Otherwise, `glob' returns zero.  */
 181 #if _FILE_OFFSET_BITS != 64 || __GNUC__ < 2
 182 extern int glob __P ((__const char *__pattern, int __flags,
 183                       int (*__errfunc) (__const char *, int),
 184                       glob_t *__pglob));
 185
 186 /* Free storage allocated in PGLOB by a previous `glob' call.  */
 187 extern void globfree __P ((glob_t *__pglob));
 188 #else
 189 extern int glob __P ((__const char *__pattern, int __flags,
 190                       int (*__errfunc) (__const char *, int),
 191                       glob_t *__pglob)) __asm__ ("glob64");
 192
 193 extern void globfree __P ((glob_t *__pglob)) __asm__ ("globfree64");
 194 #endif
 195
 196
 197 #ifdef _GNU_SOURCE
 198 /* Return nonzero if PATTERN contains any metacharacters.
 199    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
 200
 201    This function is not part of the interface specified by POSIX.2
 202    but several programs want to use it.  */
 203 extern int glob_pattern_p __P ((__const char *__pattern, int __quote));
 204 #endif
 205
 206 #ifdef  __cplusplus
 207 }
 208 #endif
 209
 210 #endif /* glob.h  */