1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2002 Tim J. Robbins.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _WORDEXP_H_
30#define _WORDEXP_H_
31
32#include <sys/cdefs.h>
33#include <sys/_types.h>
34
35#if __XSI_VISIBLE && !defined(_SIZE_T_DECLARED)
36typedef __size_t size_t;
37#define _SIZE_T_DECLARED
38#endif
39
40typedef struct {
41 __size_t we_wordc; /* count of words matched */
42 char **we_wordv; /* pointer to list of words */
43 __size_t we_offs; /* slots to reserve in we_wordv */
44 char *we_strings; /* storage for wordv strings */
45 __size_t we_nbytes; /* size of we_strings */
46} wordexp_t;
47
48/*
49 * Flags for wordexp().
50 */
51#define WRDE_APPEND 0x1 /* append to previously generated */
52#define WRDE_DOOFFS 0x2 /* we_offs member is valid */
53#define WRDE_NOCMD 0x4 /* disallow command substitution */
54#define WRDE_REUSE 0x8 /* reuse wordexp_t */
55#define WRDE_SHOWERR 0x10 /* don't redirect stderr to /dev/null */
56#define WRDE_UNDEF 0x20 /* disallow undefined shell vars */
57
58/*
59 * Return values from wordexp().
60 */
61#define WRDE_BADCHAR 1 /* unquoted special character */
62#define WRDE_BADVAL 2 /* undefined variable */
63#define WRDE_CMDSUB 3 /* command substitution not allowed */
64#define WRDE_NOSPACE 4 /* no memory for result */
65#if __XSI_VISIBLE
66#define WRDE_NOSYS 5 /* obsolete, reserved */
67#endif
68#define WRDE_SYNTAX 6 /* shell syntax error */
69
70__BEGIN_DECLS
71int wordexp(const char * __restrict, wordexp_t * __restrict, int);
72void wordfree(wordexp_t *);
73__END_DECLS
74
75#endif /* !_WORDEXP_H_ */