xref: /illumos-gate/usr/src/common/util/getoptstr.h (revision d227ea68051b5404410ee1880d0bba1ebb33a4cc)
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 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _GETOPTSTR_H
28 #define	_GETOPTSTR_H
29 
30 /*
31  * Declarations for getoptstr().
32  */
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 
39 #include <sys/types.h>
40 
41 
42 
43 /*
44  * These macros are defined here so getoptstr() callers can handle spaces and
45  * words consistently.
46  */
47 #define	ISSPACE(c)	((c) == ' ' || (c) == '\t')
48 #define	SKIP_WORD(cp)	while (*cp != '\0' && !ISSPACE(*cp)) ++cp;
49 #define	SKIP_SPC(cp)	while (ISSPACE(*cp)) ++cp;
50 
51 
52 struct gos_params {
53 	/* To be set before use. */
54 	const char	*gos_opts;	/* String of acceptable options. */
55 	const char	*gos_strp;	/* String of arguments to process. */
56 
57 	/* Publically readable. */
58 	char		gos_last_opt;	/* Last option seen. */
59 	const char	*gos_optargp;	/* Option argument. */
60 	size_t		gos_optarglen;	/* Length of option argument. */
61 	const char	*gos_errp;	/* Location of erroneous character. */
62 
63 	/* Private state. */
64 	int		gos_pos;	/* Current position in the current */
65 					/* word.  A la _pos in getopt(). */
66 };
67 
68 
69 void	getoptstr_init(struct gos_params *params);
70 int	getoptstr(struct gos_params *params);
71 
72 
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 
78 #endif /* _GETOPTSTR_H */
79