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