import of openssh-5.8p1
[openssh.git] / openbsd-compat / glob.h
1 /*      $OpenBSD: glob.h,v 1.11 2010/09/24 13:32:55 djm Exp $   */
2 /*      $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.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    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
38 /* OPENBSD ORIGINAL: include/glob.h */
39
40 #if !defined(HAVE_GLOB_H) || !defined(GLOB_HAS_ALTDIRFUNC) || \
41     !defined(GLOB_HAS_GL_MATCHC) || !defined(GLOB_HAS_GL_STATV) || \
42     !defined(HAVE_DECL_GLOB_NOMATCH) || HAVE_DECL_GLOB_NOMATCH == 0 || \
43     defined(BROKEN_GLOB)
44
45 #ifndef _GLOB_H_
46 #define _GLOB_H_
47
48 #include <sys/stat.h>
49
50 struct stat;
51 typedef struct {
52         int gl_pathc;           /* Count of total paths so far. */
53         int gl_matchc;          /* Count of paths matching pattern. */
54         int gl_offs;            /* Reserved at beginning of gl_pathv. */
55         int gl_flags;           /* Copy of flags parameter to glob. */
56         char **gl_pathv;        /* List of paths matching pattern. */
57         struct stat **gl_statv; /* Stat entries corresponding to gl_pathv */
58                                 /* Copy of errfunc parameter to glob. */
59         int (*gl_errfunc)(const char *, int);
60
61         /*
62          * Alternate filesystem access methods for glob; replacement
63          * versions of closedir(3), readdir(3), opendir(3), stat(2)
64          * and lstat(2).
65          */
66         void (*gl_closedir)(void *);
67         struct dirent *(*gl_readdir)(void *);   
68         void *(*gl_opendir)(const char *);
69         int (*gl_lstat)(const char *, struct stat *);
70         int (*gl_stat)(const char *, struct stat *);
71 } glob_t;
72
73 #define GLOB_APPEND     0x0001  /* Append to output from previous call. */
74 #define GLOB_DOOFFS     0x0002  /* Use gl_offs. */
75 #define GLOB_ERR        0x0004  /* Return on error. */
76 #define GLOB_MARK       0x0008  /* Append / to matching directories. */
77 #define GLOB_NOCHECK    0x0010  /* Return pattern itself if nothing matches. */
78 #define GLOB_NOSORT     0x0020  /* Don't sort. */
79 #define GLOB_NOESCAPE   0x1000  /* Disable backslash escaping. */
80
81 #define GLOB_NOSPACE    (-1)    /* Malloc call failed. */
82 #define GLOB_ABORTED    (-2)    /* Unignored error. */
83 #define GLOB_NOMATCH    (-3)    /* No match and GLOB_NOCHECK not set. */
84 #define GLOB_NOSYS      (-4)    /* Function not supported. */
85
86 #define GLOB_ALTDIRFUNC 0x0040  /* Use alternately specified directory funcs. */
87 #define GLOB_BRACE      0x0080  /* Expand braces ala csh. */
88 #define GLOB_MAGCHAR    0x0100  /* Pattern had globbing characters. */
89 #define GLOB_NOMAGIC    0x0200  /* GLOB_NOCHECK without magic chars (csh). */
90 #define GLOB_QUOTE      0x0400  /* Quote special chars with \. */
91 #define GLOB_TILDE      0x0800  /* Expand tilde names from the passwd file. */
92 #define GLOB_LIMIT      0x2000  /* Limit pattern match output to ARG_MAX */
93 #define GLOB_KEEPSTAT   0x4000  /* Retain stat data for paths in gl_statv. */
94 #define GLOB_ABEND      GLOB_ABORTED /* backward compatibility */
95
96 int     glob(const char *, int, int (*)(const char *, int), glob_t *);
97 void    globfree(glob_t *);
98
99 #endif /* !_GLOB_H_ */
100
101 #endif /* !defined(HAVE_GLOB_H) || !defined(GLOB_HAS_ALTDIRFUNC)  ||
102           !defined(GLOB_HAS_GL_MATCHC) || !defined(GLOH_HAS_GL_STATV) */
103