xref: /illumos-gate/usr/src/head/getopt.h (revision 6e6545bfaed3bab9ce836ee82d1abd8f2edba89a)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
24  *
25  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
26  * Use is subject to license terms.
27  */
28 
29 /*
30  * GNU-like getopt_long(), getopt_long_only().
31  * Solaris-specific getopt_clip().
32  */
33 
34 #ifndef	_GETOPT_H
35 #define	_GETOPT_H
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 
42 /*
43  * Values for has_arg field.
44  *
45  * optional_argument is not supported by getopt_clip()
46  */
47 #define	no_argument		0
48 #define	required_argument	1
49 #define	optional_argument	2
50 
51 struct option {
52 	char *name;	/* name of long option */
53 	int has_arg;	/* whether option takes an argument */
54 	int *flag;	/* if not NULL, set *flag to val when option found */
55 	int val;	/* if flag is not NULL, value to set *flag to. */
56 			/* if flag is NULL, return value */
57 };
58 
59 /*
60  * External variables used by these routines.
61  */
62 extern char *optarg;
63 extern int  opterr;
64 extern int  optind;
65 extern int  optopt;
66 
67 /*
68  * The use of getopt_long_only in new development is strongly discouraged.
69  */
70 extern int	getopt_long(int, char * const *, const char *,
71 		    const struct option *, int *);
72 extern int	getopt_long_only(int, char * const *, const char *,
73 		    const struct option *, int *);
74 extern int	getopt_clip(int, char * const *, const char *,
75 		    const struct option *, int *);
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif	/* _GETOPT_H */
82