Initial revision
[kopensolaris-gnu/glibc.git] / posix / wordexp.h
1 /* Copyright (C) 1991 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 modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 1, or (at your option)
7 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
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with the GNU C Library; see the file COPYING.  If not, write to
16 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
17
18 #ifndef _WORDEXP_H
19
20 #define _WORDEXP_H      1
21 #include <features.h>
22
23 /* Bits set in the FLAGS argument to `wordexp'.  */
24 enum
25   {
26     WRDE_DOOFFS = (1 << 0),     /* Insert PWORDEXP->we_offs NULLs.  */
27     WRDE_APPEND = (1 << 1),     /* Append to results of a previous call.  */
28     WRDE_NOCMD  = (1 << 2),     /* Don't do command substitution.  */
29     WRDE_REUSE  = (1 << 3),     /* Reuse storage in PWORDEXP.  */
30     WRDE_SHOWERR= (1 << 4),     /* Don't redirect stderr to /dev/null.  */
31     WRDE_UNDEF  = (1 << 5),     /* Error for expanding undefined variables.  */
32     __WRDE_FLAGS = (WRDE_DOOFFS|WRDE_APPEND|WRDE_NOCMD|
33                     WRDE_REUSE|WRDE_SHOWERR|WRDE_UNDEF),
34   };
35
36 /* Structure describing a word-expansion run.  */
37 typedef struct
38   {
39     int we_wordc;       /* Count of words matched.  */
40     char **we_wordv;    /* List of expanded words.  */
41     int we_offs;        /* Slots to reserve in `we_wordv'.  */
42   } wordexp_t;
43
44 /* Possible nonzero return values from `wordexp'.  */
45 enum
46   {
47     WRDE_ABEND = 1,     /* WORDS contains unquoted metacharacters.  */
48     WRDE_NOSPACE,       /* 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  */