xref: /freebsd/include/getopt.h (revision 1843dfb05ed80149f5a412180af882e3cb8f451b)
1 /*	$NetBSD: getopt.h,v 1.4 2000/07/07 10:43:54 ad Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause
5  *
6  * Copyright (c) 2000 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Dieter Baron and Thomas Klausner.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _GETOPT_H_
35 #define _GETOPT_H_
36 
37 #include <sys/cdefs.h>
38 
39 /*
40  * GNU-like getopt_long()/getopt_long_only() with 4.4BSD optreset extension.
41  * getopt() is declared here too for GNU programs.
42  */
43 #define no_argument        0
44 #define required_argument  1
45 #define optional_argument  2
46 
47 struct option {
48 	/* name of long option */
49 	const char *name;
50 	/*
51 	 * one of no_argument, required_argument, and optional_argument:
52 	 * whether option takes an argument
53 	 */
54 	int has_arg;
55 	/* if not NULL, set *flag to val when option found */
56 	int *flag;
57 	/* if flag not NULL, value to set *flag to; else return value */
58 	int val;
59 };
60 
61 __BEGIN_DECLS
62 int	getopt_long(int, char * const *, const char *,
63 	const struct option *, int *);
64 int	getopt_long_only(int, char * const *, const char *,
65 	const struct option *, int *);
66 #ifndef _GETOPT_DECLARED
67 #define	_GETOPT_DECLARED
68 int	 getopt(int, char * const [], const char *);
69 
70 extern char *optarg;			/* getopt(3) external variables */
71 extern int optind, opterr, optopt;
72 #endif
73 #ifndef _OPTRESET_DECLARED
74 #define	_OPTRESET_DECLARED
75 extern int optreset;			/* getopt(3) external variable */
76 #endif
77 __END_DECLS
78 
79 #endif /* !_GETOPT_H_ */
80