miniopt.h revision 8ce1727333a1c411bb88330d69f82386a118c6bf 
1/*
2 * Command line options parser.
3 *
4 * Copyright (C) 1999-2011, Broadcom Corporation
5 *
6 *         Unless you and Broadcom execute a separate written software license
7 * agreement governing use of this software, this software is licensed to you
8 * under the terms of the GNU General Public License version 2 (the "GPL"),
9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10 * following added to such license:
11 *
12 *      As a special exception, the copyright holders of this software give you
13 * permission to link this software with independent modules, and to copy and
14 * distribute the resulting executable under terms of your choice, provided that
15 * you also meet, for each linked independent module, the terms and conditions of
16 * the license of that module.  An independent module is a module which is not
17 * derived from this software.  The special exception does not apply to any
18 * modifications of the software.
19 *
20 *      Notwithstanding the above, under no circumstances may you combine this
21 * software in any way with any other Broadcom software provided under a license
22 * other than the GPL, without Broadcom's express prior written consent.
23 * $Id: miniopt.h 277737 2011-08-16 17:54:59Z $
24 */
25
26
27#ifndef MINI_OPT_H
28#define MINI_OPT_H
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34/* ---- Include Files ---------------------------------------------------- */
35/* ---- Constants and Types ---------------------------------------------- */
36
37#define MINIOPT_MAXKEY	128	/* Max options */
38typedef struct miniopt {
39
40	/* These are persistent after miniopt_init() */
41	const char* name;		/* name for prompt in error strings */
42	const char* flags;		/* option chars that take no args */
43	bool longflags;		/* long options may be flags */
44	bool opt_end;		/* at end of options (passed a "--") */
45
46	/* These are per-call to miniopt() */
47
48	int consumed;		/* number of argv entries cosumed in
49				 * the most recent call to miniopt()
50				 */
51	bool positional;
52	bool good_int;		/* 'val' member is the result of a sucessful
53				 * strtol conversion of the option value
54				 */
55	char opt;
56	char key[MINIOPT_MAXKEY];
57	char* valstr;		/* positional param, or value for the option,
58				 * or null if the option had
59				 * no accompanying value
60				 */
61	uint uval;		/* strtol translation of valstr */
62	int  val;		/* strtol translation of valstr */
63} miniopt_t;
64
65void miniopt_init(miniopt_t *t, const char* name, const char* flags, bool longflags);
66int miniopt(miniopt_t *t, char **argv);
67
68
69/* ---- Variable Externs ------------------------------------------------- */
70/* ---- Function Prototypes ---------------------------------------------- */
71
72
73#ifdef __cplusplus
74	}
75#endif
76
77#endif  /* MINI_OPT_H  */
78