src/getopt/getopt.h

   1 /*      $OpenBSD: getopt.h,v 1.2 2008/06/26 05:42:04 ray Exp $  */
   2 /*      $NetBSD: getopt.h,v 1.4 2000/07/07 10:43:54 ad Exp $    */
   3
   4 /*-
   5  * Copyright (c) 2000 The NetBSD Foundation, Inc.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to The NetBSD Foundation
   9  * by Dieter Baron and Thomas Klausner.
  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  *
  20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _GETOPT_H_
  34 #define _GETOPT_H_
  35
  36 #include <sys/cdefs.h>
  37
  38 /*
  39  * GNU-like getopt_long() and 4.4BSD getsubopt()/optreset extensions
  40  */
  41 #define no_argument        0
  42 #define required_argument  1
  43 #define optional_argument  2
  44
  45 struct option {
  46         /* name of long option */
  47         const char *name;
  48         /*
  49          * one of no_argument, required_argument, and optional_argument:
  50          * whether option takes an argument
  51          */
  52         int has_arg;
  53         /* if not NULL, set *flag to val when option found */
  54         int *flag;
  55         /* if flag not NULL, value to set *flag to; else return value */
  56         int val;
  57 };
  58
  59 __BEGIN_DECLS
  60 int      getopt_long(int, char * const *, const char *,
  61             const struct option *, int *);
  62 int      getopt_long_only(int, char * const *, const char *,
  63             const struct option *, int *);
  64 #ifndef _GETOPT_DEFINED_
  65 #define _GETOPT_DEFINED_
  66 int      getopt(int, char * const *, const char *);
  67 int      getsubopt(char **, char * const *, char **);
  68
  69 extern   char *optarg;                  /* getopt(3) external variables */
  70 extern   int opterr;
  71 extern   int optind;
  72 extern   int optopt;
  73 extern   int optreset;
  74 extern   char *suboptarg;               /* getsubopt(3) external variable */
  75 #endif
  76 __END_DECLS
  77
  78 #endif /* !_GETOPT_H_ */