xref: /freebsd/include/getopt.h (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1 /*	$NetBSD: getopt.h,v 1.4 2000/07/07 10:43:54 ad Exp $	*/
2 /*	$FreeBSD$ */
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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #ifndef _GETOPT_H_
41 #define _GETOPT_H_
42 
43 #include <sys/cdefs.h>
44 
45 /*
46  * GNU-like getopt_long()/getopt_long_only() with 4.4BSD optreset extension.
47  * getopt() is declared here too for GNU programs.
48  */
49 #define no_argument        0
50 #define required_argument  1
51 #define optional_argument  2
52 
53 struct option {
54 	/* name of long option */
55 	const char *name;
56 	/*
57 	 * one of no_argument, required_argument, and optional_argument:
58 	 * whether option takes an argument
59 	 */
60 	int has_arg;
61 	/* if not NULL, set *flag to val when option found */
62 	int *flag;
63 	/* if flag not NULL, value to set *flag to; else return value */
64 	int val;
65 };
66 
67 __BEGIN_DECLS
68 int	getopt_long(int, char * const *, const char *,
69 	const struct option *, int *);
70 int	getopt_long_only(int, char * const *, const char *,
71 	const struct option *, int *);
72 #ifndef _GETOPT_DECLARED
73 #define	_GETOPT_DECLARED
74 int	 getopt(int, char * const [], const char *);
75 
76 extern char *optarg;			/* getopt(3) external variables */
77 extern int optind, opterr, optopt;
78 #endif
79 #ifndef _OPTRESET_DECLARED
80 #define	_OPTRESET_DECLARED
81 extern int optreset;			/* getopt(3) external variable */
82 #endif
83 __END_DECLS
84 
85 #endif /* !_GETOPT_H_ */
86