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 /* Bits set in the FLAGS argument to `glob'.  */
  47 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
  48 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
  49 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
  50 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
  51 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
  52 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
  53 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
  54 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
  55
  56 #if (!defined _POSIX_C_SOURCE || _POSIX_C_SOURCE < 2 || defined _BSD_SOURCE \
  57      || defined _GNU_SOURCE)
  58 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
  59 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
  60 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
  61 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
  62 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
  63 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
  64 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
  65                                       if the user name is not available.  */
  66 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  67                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
  68                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
  69                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
  70 #else
  71 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  72                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
  73                          GLOB_PERIOD)
  74 #endif
  75
  76 /* Error returns from `glob'.  */
  77 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
  78 #define GLOB_ABORTED    2       /* Read error.  */
  79 #define GLOB_NOMATCH    3       /* No matches found.  */
  80
  81 #ifdef _GNU_SOURCE
  82 /* Previous versions of this file defined GLOB_ABEND instead of
  83    GLOB_ABORTED.  Provide a compatibility definition here.  */
  84 # define GLOB_ABEND GLOB_ABORTED
  85 #endif
  86
  87 /* This value is returned if the implementation does not support
  88    `glob'.  Since this is not the case here it will never be
  89    returned but the conformance test suites still require the symbol
  90    to be defined.  */
  91 #ifdef _XOPEN_SOURCE
  92 # define GLOB_NOSYS     (-1)
  93 #endif
  94
  95 /* Structure describing a globbing run.  */
  96 #if !defined _AMIGA && !defined VMS /* Buggy compiler.   */
  97 struct stat;
  98 #endif
  99 typedef struct
 100   {
 101     size_t gl_pathc;            /* Count of paths matched by the pattern.  */
 102     char **gl_pathv;            /* List of matched pathnames.  */
 103     size_t gl_offs;             /* Slots to reserve in `gl_pathv'.  */
 104     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
 105
 106     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
 107        are used instead of the normal file access functions.  */
 108     void (*gl_closedir) __PMT ((void *));
 109     struct dirent *(*gl_readdir) __PMT ((void *));
 110     __ptr_t (*gl_opendir) __PMT ((__const char *));
 111     int (*gl_lstat) __PMT ((__const char *, struct stat *));
 112     int (*gl_stat) __PMT ((__const char *, struct stat *));
 113   } glob_t;
 114
 115 /* Do glob searching for PATTERN, placing results in PGLOB.
 116    The bits defined above may be set in FLAGS.
 117    If a directory cannot be opened or read and ERRFUNC is not nil,
 118    it is called with the pathname that caused the error, and the
 119    `errno' value from the failing call; if it returns non-zero
 120    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
 121    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
 122    Otherwise, `glob' returns zero.  */
 123 extern int glob __P ((__const char *__pattern, int __flags,
 124                       int (*__errfunc) __P ((__const char *, int)),
 125                       glob_t *__pglob));
 126
 127 /* Free storage allocated in PGLOB by a previous `glob' call.  */
 128 extern void globfree __P ((glob_t *__pglob));
 129
 130
 131 #ifdef _GNU_SOURCE
 132 /* Return nonzero if PATTERN contains any metacharacters.
 133    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
 134
 135    This function is not part of the interface specified by POSIX.2
 136    but several programs want to use it.  */
 137 extern int __glob_pattern_p __P ((__const char *__pattern, int __quote));
 138 extern int glob_pattern_p __P ((__const char *__pattern, int __quote));
 139 #endif
 140
 141 #ifdef  __cplusplus
 142 }
 143 #endif
 144
 145 #endif /* glob.h  */