contrib/cvs-1.12/lib/glob-libc.h

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