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