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