Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/* SPDX-License-Identifier: BSD-2-Clause-Views */
/* Jim - A small embeddable Tcl interpreter
*
* Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
* Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
* Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
* Copyright 2008 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
* Copyright 2008 Andrew Lunn <andrew@lunn.ch>
* Copyright 2008 Duane Ellis <openocd@duaneellis.com>
* Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
* Copyright 2008 Steve Bennett <steveb@workware.net.au>
* Copyright 2009 Nico Coesel <ncoesel@dealogic.nl>
* Copyright 2009 Zachary T Welch zw@superlucidity.net
* Copyright 2009 David Brownell
* Copyright (c) 2005-2011 Jim Tcl Project. All rights reserved.
*/
#ifndef OPENOCD_HELPER_JIM_NVP_H
#define OPENOCD_HELPER_JIM_NVP_H
#include <jim.h>
/** Name Value Pairs, aka: NVP
* - Given a string - return the associated int.
* - Given a number - return the associated string.
* .
*
* Very useful when the number is not a simple index into an array of
* known string, or there may be multiple strings (aliases) that mean then same
* thing.
*
* An NVP Table is terminated with ".name = NULL".
*
* During the 'name2value' operation, if no matching string is found
* the pointer to the terminal element (with p->name == NULL) is returned.
*
* Example:
* \code
* const struct jim_nvp yn[] = {
* { "yes", 1 },
* { "no" , 0 },
* { "yep", 1 },
* { "nope", 0 },
* { NULL, -1 },
* };
*
* struct jim_nvp *result
* e = jim_nvp_name2value(interp, yn, "y", &result);
* returns &yn[0];
* e = jim_nvp_name2value(interp, yn, "n", &result);
* returns &yn[1];
* e = jim_nvp_name2value(interp, yn, "Blah", &result);
* returns &yn[4];
* \endcode
*
* During the number2name operation, the first matching value is returned.
*/
struct jim_nvp {
const char *name;
int value;
};
int jim_get_nvp(Jim_Interp *interp,
Jim_Obj *objptr,
const struct jim_nvp *nvp_table,
const struct jim_nvp **result);
/* Name Value Pairs Operations */
struct jim_nvp *jim_nvp_name2value_simple(const struct jim_nvp *nvp_table, const char *name);
struct jim_nvp *jim_nvp_name2value_nocase_simple(const struct jim_nvp *nvp_table, const char *name);
struct jim_nvp *jim_nvp_value2name_simple(const struct jim_nvp *nvp_table, int v);
int jim_nvp_name2value(Jim_Interp *interp,
const struct jim_nvp *nvp_table,
const char *name,
struct jim_nvp **result);
int jim_nvp_name2value_nocase(Jim_Interp *interp,
const struct jim_nvp *nvp_table,
const char *name,
struct jim_nvp **result);
int jim_nvp_value2name(Jim_Interp *interp, const struct jim_nvp *nvp_table, int value, struct jim_nvp **result);
int jim_nvp_name2value_obj(Jim_Interp *interp,
const struct jim_nvp *nvp_table,
Jim_Obj *name_obj,
struct jim_nvp **result);
int jim_nvp_name2value_obj_nocase(Jim_Interp *interp,
const struct jim_nvp *nvp_table,
Jim_Obj *name_obj,
struct jim_nvp **result);
int jim_nvp_value2name_obj(Jim_Interp *interp,
const struct jim_nvp *nvp_table,
Jim_Obj *value_obj,
struct jim_nvp **result);
/** prints a nice 'unknown' parameter error message to the 'result' */
void jim_set_result_nvp_unknown(Jim_Interp *interp,
Jim_Obj *param_name,
Jim_Obj *param_value,
const struct jim_nvp *nvp_table);
/** Debug: convert argc/argv into a printable string for printf() debug
*
* \param interp - the interpreter
* \param argc - arg count
* \param argv - the objects
*
* \returns string pointer holding the text.
*
* Note, next call to this function will free the old (last) string.
*
* For example might want do this:
* \code
* fp = fopen("some.file.log", "a");
* fprintf(fp, "PARAMS are: %s\n", Jim_DebugArgvString(interp, argc, argv));
* fclose(fp);
* \endcode
*/
const char *jim_debug_argv_string(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
/** A TCL -ish GetOpt like code.
*
* Some TCL objects have various "configuration" values.
* For example - in Tcl/Tk the "buttons" have many options.
*
* Useful when dealing with command options.
* that may come in any order...
*
* Does not support "-foo = 123" type options.
* Only supports tcl type options, like "-foo 123"
*/
struct jim_getopt_info {
Jim_Interp *interp;
int argc;
Jim_Obj *const *argv;
int isconfigure; /* non-zero if configure */
};
/** GetOpt - how to.
*
* Example (short and incomplete):
* \code
* struct jim_getopt_info goi;
*
* jim_getopt_setup(&goi, interp, argc, argv);
*
* while (goi.argc) {
* e = jim_getopt_nvp(&goi, nvp_options, &n);
* if (e != JIM_OK) {
* jim_getopt_nvp_unknown(&goi, nvp_options, 0);
* return e;
* }
*
* switch (n->value) {
* case ALIVE:
* printf("Option ALIVE specified\n");
* break;
* case FIRST:
* if (goi.argc < 1) {
* .. not enough args error ..
* }
* jim_getopt_string(&goi, &cp, NULL);
* printf("FIRSTNAME: %s\n", cp);
* case AGE:
* jim_getopt_wide(&goi, &w);
* printf("AGE: %d\n", (int)(w));
* break;
* case POLITICS:
* e = jim_getopt_nvp(&goi, nvp_politics, &n);
* if (e != JIM_OK) {
* jim_getopt_nvp_unknown(&goi, nvp_politics, 1);
* return e;
* }
* }
* }
*
* \endcode
*
*/
/** Setup GETOPT
*
* \param goi - get opt info to be initialized
* \param interp - jim interp
* \param argc - argc count.
* \param argv - argv (will be copied)
*
* \code
* struct jim_getopt_info goi;
*
* Jim_GetOptSetup(&goi, interp, argc, argv);
* \endcode
*/
int jim_getopt_setup(struct jim_getopt_info *goi,
Jim_Interp *interp,
int argc,
Jim_Obj *const *argv);
/** Debug - Dump parameters to stderr
* \param goi - current parameters
*/
void jim_getopt_debug(struct jim_getopt_info *goi);
/** Remove argv[0] from the list.
*
* \param goi - get opt info
* \param puthere - where param is put
*
*/
int jim_getopt_obj(struct jim_getopt_info *goi, Jim_Obj **puthere);
/** Remove argv[0] as string.
*
* \param goi - get opt info
* \param puthere - where param is put
* \param len - return its length
*/
int jim_getopt_string(struct jim_getopt_info *goi, const char **puthere, int *len);
/** Remove argv[0] as double.
*
* \param goi - get opt info
* \param puthere - where param is put.
*
*/
int jim_getopt_double(struct jim_getopt_info *goi, double *puthere);
/** Remove argv[0] as wide.
*
* \param goi - get opt info
* \param puthere - where param is put.
*/
int jim_getopt_wide(struct jim_getopt_info *goi, jim_wide *puthere);
/** Remove argv[0] as NVP.
*
* \param goi - get opt info
* \param lookup - nvp lookup table
* \param puthere - where param is put.
*
*/
int jim_getopt_nvp(struct jim_getopt_info *goi, const struct jim_nvp *lookup, struct jim_nvp **puthere);
/** Create an appropriate error message for an NVP.
*
* \param goi - options info
* \param lookup - the NVP table that was used.
* \param hadprefix - 0 or 1 if the option had a prefix.
*
* This function will set the "interp->result" to a human readable
* error message listing the available options.
*
* This function assumes the previous option argv[-1] is the unknown string.
*
* If this option had some prefix, then pass "hadprefix = 1" else pass "hadprefix = 0"
*
* Example:
* \code
*
* while (goi.argc) {
* // Get the next option
* e = jim_getopt_nvp(&goi, cmd_options, &n);
* if (e != JIM_OK) {
* // option was not recognized
* // pass 'hadprefix = 0' because there is no prefix
* jim_getopt_nvp_unknown(&goi, cmd_options, 0);
* return e;
* }
*
* switch (n->value) {
* case OPT_SEX:
* // handle: --sex male | female | lots | needmore
* e = jim_getopt_nvp(&goi, &nvp_sex, &n);
* if (e != JIM_OK) {
* jim_getopt_nvp_unknown(&ogi, nvp_sex, 1);
* return e;
* }
* printf("Code: (%d) is %s\n", n->value, n->name);
* break;
* case ...:
* [snip]
* }
* }
* \endcode
*
*/
void jim_getopt_nvp_unknown(struct jim_getopt_info *goi, const struct jim_nvp *lookup, int hadprefix);
/** Remove argv[0] as Enum
*
* \param goi - get opt info
* \param lookup - lookup table.
* \param puthere - where param is put.
*
*/
int jim_getopt_enum(struct jim_getopt_info *goi, const char *const *lookup, int *puthere);
#endif /* OPENOCD_HELPER_JIM_NVP_H */
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
Click anywhere in the source to view detailed information here...