Document -lbsd-compat when explaining getpgrp.
[kopensolaris-gnu/glibc.git] / posix / glob.h
1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
2
3 This 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 This 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 this library; see the file COPYING.LIB.  If
15 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
16 Cambridge, MA 02139, USA.  */
17
18 #ifndef _GLOB_H
19
20 #define _GLOB_H 1
21
22 #ifdef  __cplusplus
23 extern "C"
24 {
25 #endif
26
27 #if defined (__cplusplus) || (defined (__STDC__) && __STDC__)
28 #undef  __P
29 #define __P(args)       args
30 #else /* Not C++ or ANSI C.  */
31 #undef  __P
32 #define __P(args)       ()
33 #undef  const
34 #define const
35 #endif /* C++ or ANSI C.  */
36
37 /* Bits set in the FLAGS argument to `glob'.  */
38 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
39 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
40 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
41 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
42 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
43 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
44 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
45 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
46 #define __GLOB_FLAGS    (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
47                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|GLOB_PERIOD)
48
49 #if !defined (_POSIX_C_SOURCE) || _POSIX_C_SOURCE < 2 || defined (_BSD_SOURCE)
50 #define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
51 #endif
52
53 /* Error returns from `glob'.  */
54 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
55 #define GLOB_ABEND      2       /* Read error.  */
56 #define GLOB_NOMATCH    3       /* No matches found.  */
57
58 /* Structure describing a globbing run.  */
59   typedef struct
60   {
61     int gl_pathc;               /* Count of paths matched by the pattern.  */
62     char **gl_pathv;            /* List of matched pathnames.  */
63     int gl_offs;                /* Slots to reserve in `gl_pathv'.  */
64     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
65   } glob_t;
66
67 /* Do glob searching for PATTERN, placing results in PGLOB.
68    The bits defined above may be set in FLAGS.
69    If a directory cannot be opened or read and ERRFUNC is not nil,
70    it is called with the pathname that caused the error, and the
71    `errno' value from the failing call; if it returns non-zero
72    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
73    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
74    Otherwise, `glob' returns zero.  */
75   extern int glob __P ((const char *__pattern, int __flags,
76                         int (*__errfunc) __P ((const char *, int)),
77                         glob_t * __pglob));
78
79 /* Free storage allocated in PGLOB by a previous `glob' call.  */
80   extern void globfree __P ((glob_t * __pglob));
81
82 #ifdef  __cplusplus
83 }
84
85 #endif
86
87 #endif /* glob.h  */