Formerly ../posix/wordexp.h.~4~
[kopensolaris-gnu/glibc.git] / posix / wordexp.h
1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 #ifndef _WORDEXP_H
20
21 #define _WORDEXP_H      1
22 #include <features.h>
23
24 /* Bits set in the FLAGS argument to `wordexp'.  */
25 enum
26   {
27     WRDE_DOOFFS = (1 << 0),     /* Insert PWORDEXP->we_offs NULLs.  */
28     WRDE_APPEND = (1 << 1),     /* Append to results of a previous call.  */
29     WRDE_NOCMD  = (1 << 2),     /* Don't do command substitution.  */
30     WRDE_REUSE  = (1 << 3),     /* Reuse storage in PWORDEXP.  */
31     WRDE_SHOWERR= (1 << 4),     /* Don't redirect stderr to /dev/null.  */
32     WRDE_UNDEF  = (1 << 5),     /* Error for expanding undefined variables.  */
33     __WRDE_FLAGS = (WRDE_DOOFFS|WRDE_APPEND|WRDE_NOCMD|
34                     WRDE_REUSE|WRDE_SHOWERR|WRDE_UNDEF),
35   };
36
37 /* Structure describing a word-expansion run.  */
38 typedef struct
39   {
40     int we_wordc;       /* Count of words matched.  */
41     char **we_wordv;    /* List of expanded words.  */
42     int we_offs;        /* Slots to reserve in `we_wordv'.  */
43   } wordexp_t;
44
45 /* Possible nonzero return values from `wordexp'.  */
46 enum
47   {
48     WRDE_NOSPACE = 1,   /* Ran out of memory.  */
49     WRDE_BADCHAR,       /* A metacharacter appears in the wrong place.  */
50     WRDE_BADVAL,        /* Reference to undefined variable with WRDE_UNDEF.  */
51     WRDE_CMDSUB,        /* Command substitution with WRDE_NOCMD.  */
52     WRDE_SYNTAX         /* Shell syntax error.  */
53   }
54
55 /* Do word expansion of WORDS into PWORDEXP.  */
56 extern int EXFUN(wordexp, (CONST char *__words, wordexp_t *__pwordexp,
57                            int __flags));
58
59 /* Free the storage allocated by a `wordexp' call.  */
60 extern void EXFUN(wordfree, (wordexp_t *));
61
62 #endif  /* wordexp.h  */