glob/glob.h

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