Standardize the multiple-include protect.
[kopensolaris-gnu/glibc.git] / posix / glob.h
1 /* Copyright (C) 1991, 1992, 1995, 1996, 1997 Free Software Foundation, Inc.
2
3    This file is part of the GNU C Library.  Its master source is NOT part of
4    the C library, however.  The master source lives in /gd/gnu/lib.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Library General Public License as
8    published by the Free Software Foundation; either version 2 of the
9    License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Library General Public License for more details.
15
16    You should have received a copy of the GNU Library General Public
17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 #ifndef _GLOB_H
22 #define _GLOB_H 1
23
24 #ifdef  __cplusplus
25 extern "C"
26 {
27 #endif
28
29 #undef  __ptr_t
30 #if (defined (__cplusplus) || (defined (__STDC__) && __STDC__) \
31      || defined (WIN32))
32 #undef  __P
33 #define __P(protos)     protos
34 #define __ptr_t void *
35 #else /* Not C++ or ANSI C.  */
36 #undef  __P
37 #define __P(protos)     ()
38 #undef  const
39 #define const
40 #define __ptr_t char *
41 #endif /* C++ or ANSI C.  */
42
43 /* Bits set in the FLAGS argument to `glob'.  */
44 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
45 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
46 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
47 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
48 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
49 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
50 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
51 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
52 #define __GLOB_FLAGS    (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
53                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
54                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
55                          GLOB_NOMAGIC|GLOB_TILDE)
56
57 #if !defined (_POSIX_C_SOURCE) || _POSIX_C_SOURCE < 2 || defined (_BSD_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 #endif
64
65 /* Error returns from `glob'.  */
66 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
67 #define GLOB_ABORTED    2       /* Read error.  */
68 #define GLOB_NOMATCH    3       /* No matches found.  */
69
70 #ifdef _GNU_SOURCE
71 /* Previous versions of this file defined GLOB_ABEND instead of
72    GLOB_ABORTED.  Provide a compatibility definition here.  */
73 # define GLOB_ABEND GLOB_ABORTED
74 #endif
75
76 /* Structure describing a globbing run.  */
77 #if !defined (_AMIGA) && !defined (VMS) /* Buggy compiler.   */
78 struct stat;
79 #endif
80 typedef struct
81   {
82     int gl_pathc;               /* Count of paths matched by the pattern.  */
83     char **gl_pathv;            /* List of matched pathnames.  */
84     int gl_offs;                /* Slots to reserve in `gl_pathv'.  */
85     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
86
87     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
88        are used instead of the normal file access functions.  */
89     void (*gl_closedir) __P ((void *));
90     struct dirent *(*gl_readdir) __P ((void *));
91     __ptr_t (*gl_opendir) __P ((const char *));
92     int (*gl_lstat) __P ((const char *, struct stat *));
93     int (*gl_stat) __P ((const char *, struct stat *));
94   } glob_t;
95
96 /* Do glob searching for PATTERN, placing results in PGLOB.
97    The bits defined above may be set in FLAGS.
98    If a directory cannot be opened or read and ERRFUNC is not nil,
99    it is called with the pathname that caused the error, and the
100    `errno' value from the failing call; if it returns non-zero
101    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
102    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
103    Otherwise, `glob' returns zero.  */
104 extern int glob __P ((const char *__pattern, int __flags,
105                       int (*__errfunc) __P ((const char *, int)),
106                       glob_t *__pglob));
107
108 /* Free storage allocated in PGLOB by a previous `glob' call.  */
109 extern void globfree __P ((glob_t *__pglob));
110
111
112 #ifdef _GNU_SOURCE
113 /* Return nonzero if PATTERN contains any metacharacters.
114    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
115
116    This function is not part of the interface specified by POSIX.2
117    but several programs want to use it.  */
118 extern int __glob_pattern_p __P ((__const char *__pattern, int __quote));
119 extern int glob_pattern_p __P ((__const char *__pattern, int __quote));
120 #endif
121
122 #ifdef  __cplusplus
123 }
124 #endif
125
126 #endif /* glob.h  */