xref: /freebsd/include/getopt.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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  *
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()/getopt_long_only() with 4.4BSD optreset extension.
40  * getopt() is declared here too for GNU programs.
41  */
42 #define no_argument        0
43 #define required_argument  1
44 #define optional_argument  2
45 
46 struct option {
47 	/* name of long option */
48 	const char *name;
49 	/*
50 	 * one of no_argument, required_argument, and optional_argument:
51 	 * whether option takes an argument
52 	 */
53 	int has_arg;
54 	/* if not NULL, set *flag to val when option found */
55 	int *flag;
56 	/* if flag not NULL, value to set *flag to; else return value */
57 	int val;
58 };
59 
60 __BEGIN_DECLS
61 int	getopt_long(int, char * const *, const char *,
62 	const struct option *, int *);
63 int	getopt_long_only(int, char * const *, const char *,
64 	const struct option *, int *);
65 #ifndef _GETOPT_DECLARED
66 #define	_GETOPT_DECLARED
67 int	 getopt(int, char * const [], const char *);
68 
69 extern char *optarg;			/* getopt(3) external variables */
70 extern int optind, opterr, optopt;
71 #endif
72 #ifndef _OPTRESET_DECLARED
73 #define	_OPTRESET_DECLARED
74 extern int optreset;			/* getopt(3) external variable */
75 #endif
76 __END_DECLS
77 
78 #endif /* !_GETOPT_H_ */
79