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