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