include/wordexp.h

   1 /*      $NetBSD: wordexp.h,v 1.2 2008/04/01 19:23:28 drochner Exp $     */
   2
   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  * $FreeBSD: /repoman/r/ncvs/src/include/wordexp.h,v 1.4 2003/01/03 12:03:38 tjr Exp $
  29  */
  30
  31 #ifndef _WORDEXP_H_
  32 #define _WORDEXP_H_
  33
  34 #include <sys/cdefs.h>
  35 #include <sys/featuretest.h>
  36 #include <machine/ansi.h>
  37
  38 #ifdef  _BSD_SIZE_T_
  39 typedef _BSD_SIZE_T_    size_t;
  40 #undef  _BSD_SIZE_T_
  41 #endif
  42
  43
  44 typedef struct {
  45         size_t  we_wordc;               /* count of words matched */
  46         char            **we_wordv;     /* pointer to list of words */
  47         size_t  we_offs;                /* slots to reserve in we_wordv */
  48                                         /* following are internals */
  49         char            *we_strings;    /* storage for wordv strings */
  50         size_t  we_nbytes;              /* size of we_strings */
  51 } wordexp_t;
  52
  53 /*
  54  * Flags for wordexp().
  55  */
  56 #define WRDE_APPEND     0x1             /* append to previously generated */
  57 #define WRDE_DOOFFS     0x2             /* we_offs member is valid */
  58 #define WRDE_NOCMD      0x4             /* disallow command substitution */
  59 #define WRDE_REUSE      0x8             /* reuse wordexp_t */
  60 #define WRDE_SHOWERR    0x10            /* don't redirect stderr to /dev/null */
  61 #define WRDE_UNDEF      0x20            /* disallow undefined shell vars */
  62
  63 /*
  64  * Return values from wordexp().
  65  */
  66 #define WRDE_BADCHAR    1               /* unquoted special character */
  67 #define WRDE_BADVAL     2               /* undefined variable */
  68 #define WRDE_CMDSUB     3               /* command substitution not allowed */
  69 #define WRDE_NOSPACE    4               /* no memory for result */
  70 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
  71 #define WRDE_NOSYS      5               /* obsolete, reserved */
  72 #endif
  73 #define WRDE_SYNTAX     6               /* shell syntax error */
  74 #define WRDE_ERRNO      7               /* other errors see errno */
  75
  76 __BEGIN_DECLS
  77 int     wordexp(const char * __restrict, wordexp_t * __restrict, int);
  78 void    wordfree(wordexp_t *);
  79 __END_DECLS
  80
  81 #endif /* !_WORDEXP_H_ */