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