Commit | Line | Data |
---|---|---|
d2839953 RC |
1 | /* |
2 | * Command line options parser. | |
3 | * | |
965f77c4 | 4 | * Copyright (C) 1999-2019, Broadcom. |
d2839953 RC |
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 | * | |
24 | * | |
25 | * <<Broadcom-WL-IPTag/Open:>> | |
26 | * | |
27 | * $Id: miniopt.h 672943 2016-11-30 08:54:06Z $ | |
28 | */ | |
29 | ||
30 | #ifndef MINI_OPT_H | |
31 | #define MINI_OPT_H | |
32 | ||
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif // endif | |
36 | ||
37 | /* ---- Include Files ---------------------------------------------------- */ | |
38 | ||
39 | /* ---- Constants and Types ---------------------------------------------- */ | |
40 | ||
41 | #define MINIOPT_MAXKEY 128 /* Max options */ | |
42 | typedef struct miniopt { | |
43 | ||
44 | /* These are persistent after miniopt_init() */ | |
45 | const char* name; /* name for prompt in error strings */ | |
46 | const char* flags; /* option chars that take no args */ | |
47 | bool longflags; /* long options may be flags */ | |
48 | bool opt_end; /* at end of options (passed a "--") */ | |
49 | ||
50 | /* These are per-call to miniopt() */ | |
51 | ||
52 | int consumed; /* number of argv entries cosumed in | |
53 | * the most recent call to miniopt() | |
54 | */ | |
55 | bool positional; | |
56 | bool good_int; /* 'val' member is the result of a sucessful | |
57 | * strtol conversion of the option value | |
58 | */ | |
59 | char opt; | |
60 | char key[MINIOPT_MAXKEY]; | |
61 | char* valstr; /* positional param, or value for the option, | |
62 | * or null if the option had | |
63 | * no accompanying value | |
64 | */ | |
65 | uint uval; /* strtol translation of valstr */ | |
66 | int val; /* strtol translation of valstr */ | |
67 | } miniopt_t; | |
68 | ||
69 | void miniopt_init(miniopt_t *t, const char* name, const char* flags, bool longflags); | |
70 | int miniopt(miniopt_t *t, char **argv); | |
71 | ||
72 | /* ---- Variable Externs ------------------------------------------------- */ | |
73 | /* ---- Function Prototypes ---------------------------------------------- */ | |
74 | ||
75 | #ifdef __cplusplus | |
76 | } | |
77 | #endif // endif | |
78 | ||
79 | #endif /* MINI_OPT_H */ |