blob: aceddbc48757cf1915be7702b0ea6ccd5bc63b7e [file] [log] [blame]
Damien Miller329638e2003-06-03 12:12:50 +10001/* $OpenBSD: glob.h,v 1.8 2003/06/02 19:34:12 millert Exp $ */
Damien Miller3c027682001-03-14 11:39:45 +11002/* $NetBSD: glob.h,v 1.5 1994/10/26 00:55:56 cgd Exp $ */
3
4/*
5 * Copyright (c) 1989, 1993
6 * The Regents of the University of California. All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Guido van Rossum.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
Damien Miller329638e2003-06-03 12:12:50 +100019 * 3. Neither the name of the University nor the names of its contributors
Damien Miller3c027682001-03-14 11:39:45 +110020 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)glob.h 8.1 (Berkeley) 6/2/93
36 */
37
Ben Lindstrom45b14db2001-03-17 01:15:38 +000038#if !defined(HAVE_GLOB_H) || !defined(GLOB_HAS_ALTDIRFUNC) || \
39 !defined(GLOB_HAS_GL_MATCHC)
Damien Miller3c027682001-03-14 11:39:45 +110040
41#ifndef _GLOB_H_
42#define _GLOB_H_
43
44struct stat;
45typedef struct {
46 int gl_pathc; /* Count of total paths so far. */
47 int gl_matchc; /* Count of paths matching pattern. */
48 int gl_offs; /* Reserved at beginning of gl_pathv. */
49 int gl_flags; /* Copy of flags parameter to glob. */
50 char **gl_pathv; /* List of paths matching pattern. */
51 /* Copy of errfunc parameter to glob. */
Damien Miller71eb0c12002-09-11 10:29:11 +100052 int (*gl_errfunc)(const char *, int);
Damien Miller3c027682001-03-14 11:39:45 +110053
54 /*
55 * Alternate filesystem access methods for glob; replacement
56 * versions of closedir(3), readdir(3), opendir(3), stat(2)
57 * and lstat(2).
58 */
Damien Miller71eb0c12002-09-11 10:29:11 +100059 void (*gl_closedir)(void *);
60 struct dirent *(*gl_readdir)(void *);
61 void *(*gl_opendir)(const char *);
62 int (*gl_lstat)(const char *, struct stat *);
63 int (*gl_stat)(const char *, struct stat *);
Damien Miller3c027682001-03-14 11:39:45 +110064} glob_t;
65
66/* Flags */
67#define GLOB_APPEND 0x0001 /* Append to output from previous call. */
68#define GLOB_DOOFFS 0x0002 /* Use gl_offs. */
69#define GLOB_ERR 0x0004 /* Return on error. */
70#define GLOB_MARK 0x0008 /* Append / to matching directories. */
71#define GLOB_NOCHECK 0x0010 /* Return pattern itself if nothing matches. */
72#define GLOB_NOSORT 0x0020 /* Don't sort. */
73
74#define GLOB_ALTDIRFUNC 0x0040 /* Use alternately specified directory funcs. */
75#define GLOB_BRACE 0x0080 /* Expand braces ala csh. */
76#define GLOB_MAGCHAR 0x0100 /* Pattern had globbing characters. */
77#define GLOB_NOMAGIC 0x0200 /* GLOB_NOCHECK without magic chars (csh). */
78#define GLOB_QUOTE 0x0400 /* Quote special chars with \. */
79#define GLOB_TILDE 0x0800 /* Expand tilde names from the passwd file. */
80#define GLOB_NOESCAPE 0x1000 /* Disable backslash escaping. */
Ben Lindstrom9911f122001-03-19 21:29:30 +000081#define GLOB_LIMIT 0x2000 /* Limit pattern match output to ARG_MAX */
Damien Miller3c027682001-03-14 11:39:45 +110082
83/* Error values returned by glob(3) */
84#define GLOB_NOSPACE (-1) /* Malloc call failed. */
85#define GLOB_ABORTED (-2) /* Unignored error. */
86#define GLOB_NOMATCH (-3) /* No match and GLOB_NOCHECK not set. */
87#define GLOB_NOSYS (-4) /* Function not supported. */
88#define GLOB_ABEND GLOB_ABORTED
89
Damien Miller71eb0c12002-09-11 10:29:11 +100090int glob(const char *, int, int (*)(const char *, int), glob_t *);
91void globfree(glob_t *);
Damien Miller3c027682001-03-14 11:39:45 +110092
93#endif /* !_GLOB_H_ */
94
Ben Lindstrom45b14db2001-03-17 01:15:38 +000095#endif /* !defined(HAVE_GLOB_H) || !defined(GLOB_HAS_ALTDIRFUNC) ||
96 !defined(GLOB_HAS_GL_MATCHC */
Damien Miller3c027682001-03-14 11:39:45 +110097