getopt.h@ 25477

Last change on this file since 25477 was 25351, checked in by vboxsync, 15 years ago
-space
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 14.0 KB

Line
1	/** @file
2	* IPRT - Command Line Parsing.
3	*/
4
5	/*
6	* Copyright (C) 2007 Sun Microsystems, Inc.
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*
25	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___iprt_getopt_h
31	#define ___iprt_getopt_h
32
33
34	#include <iprt/cdefs.h>
35	#include <iprt/types.h>
36
37	RT_C_DECLS_BEGIN
38
39	/** @defgroup grp_rt_getopt RTGetOpt - Command Line Parsing
40	* @ingroup grp_rt
41	* @{
42	*/
43
44	/** @name RTGETOPTDEF::fFlags
45	*
46	* @remarks When neither of the RTGETOPT_FLAG_HEX, RTGETOPT_FLAG_OCT and RTGETOPT_FLAG_DEC
47	* flags are specified with a integer value format, RTGetOpt will default to
48	* decimal but recognize the 0x prefix when present. RTGetOpt will not look for
49	* for the octal prefix (0).
50	* @{ */
51	/** Requires no extra argument.
52	* (Can be assumed to be 0 for ever.) */
53	#define RTGETOPT_REQ_NOTHING 0
54	/** A value is required or error will be returned. */
55	#define RTGETOPT_REQ_STRING 1
56	/** The value must be a valid signed 8-bit integer or an error will be returned. */
57	#define RTGETOPT_REQ_INT8 2
58	/** The value must be a valid unsigned 8-bit integer or an error will be returned. */
59	#define RTGETOPT_REQ_UINT8 3
60	/** The value must be a valid signed 16-bit integer or an error will be returned. */
61	#define RTGETOPT_REQ_INT16 4
62	/** The value must be a valid unsigned 16-bit integer or an error will be returned. */
63	#define RTGETOPT_REQ_UINT16 5
64	/** The value must be a valid signed 32-bit integer or an error will be returned. */
65	#define RTGETOPT_REQ_INT32 6
66	/** The value must be a valid unsigned 32-bit integer or an error will be returned. */
67	#define RTGETOPT_REQ_UINT32 7
68	/** The value must be a valid signed 64-bit integer or an error will be returned. */
69	#define RTGETOPT_REQ_INT64 8
70	/** The value must be a valid unsigned 64-bit integer or an error will be returned. */
71	#define RTGETOPT_REQ_UINT64 9
72	/** The value must be a valid IPv4 address.
73	* (Not a name, but 4 values in the 0..255 range with dots separating them). */
74	#define RTGETOPT_REQ_IPV4ADDR 10
75	#if 0
76	/** The value must be a valid IPv4 CIDR.
77	* As with RTGETOPT_REQ_IPV4ADDR, no name.
78	* @todo Mix CIDR with types.h or/and net.h first and find a way to make the
79	* mask optional like with ifconfig. See RTCidrStrToIPv4. */
80	#define RTGETOPT_REQ_IPV4CIDR 11
81	#endif
82	/** The value must be a valid ethernet MAC address. */
83	#define RTGETOPT_REQ_MACADDR 14
84	/** The value must be a valid UUID. */
85	#define RTGETOPT_REQ_UUID 15
86	/** The value must be a string with value as "on" or "off". */
87	#define RTGETOPT_REQ_BOOL_ONOFF 16
88	/** The mask of the valid required types. */
89	#define RTGETOPT_REQ_MASK 31
90	/** Treat the value as hexadecimal - only applicable with the RTGETOPT_REQ_INT. */
91	#define RTGETOPT_FLAG_HEX RT_BIT(16)
92	/** Treat the value as octal - only applicable with the RTGETOPT_REQ_INT. */
93	#define RTGETOPT_FLAG_OCT RT_BIT(17)
94	/** Treat the value as decimal - only applicable with the RTGETOPT_REQ_INT. */
95	#define RTGETOPT_FLAG_DEC RT_BIT(18)
96	/** The index value is attached to the argument - only valid for long arguments. */
97	#define RTGETOPT_FLAG_INDEX RT_BIT(19)
98	/** Mask of valid bits - for validation. */
99	#define RTGETOPT_VALID_MASK ( RTGETOPT_REQ_MASK \
100	\| RTGETOPT_FLAG_HEX \
101	\| RTGETOPT_FLAG_OCT \
102	\| RTGETOPT_FLAG_DEC \
103	\| RTGETOPT_FLAG_INDEX)
104	/** @} */
105
106	/**
107	* An option definition.
108	*/
109	typedef struct RTGETOPTDEF
110	{
111	/** The long option.
112	* This is optional */
113	const char *pszLong;
114	/** The short option character.
115	* This doesn't have to be a character, it may also be a \#define or enum value if
116	* there isn't any short version of this option. Must be greater than 0. */
117	int iShort;
118	/** The flags (RTGETOPT_). /
119	unsigned fFlags;
120	} RTGETOPTDEF;
121	/** Pointer to an option definition. */
122	typedef RTGETOPTDEF *PRTGETOPTDEF;
123	/** Pointer to an const option definition. */
124	typedef const RTGETOPTDEF *PCRTGETOPTDEF;
125
126	/**
127	* Option argument union.
128	*
129	* What ends up here depends on argument format in the option definition.
130	*
131	* @remarks Integers will bet put in the \a i and \a u members and sign/zero extended
132	* according to the signedness indicated by the \a fFlags. So, you can choose
133	* use which ever of the integer members for accessing the value regardless
134	* of restrictions indicated in the \a fFlags.
135	*/
136	typedef union RTGETOPTUNION
137	{
138	/** Pointer to the definition on failure or when the option doesn't take an argument.
139	* This can be NULL for some errors. */
140	PCRTGETOPTDEF pDef;
141	/** A RTGETOPT_REQ_STRING option argument. */
142	const char *psz;
143
144	#if !defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86)
145	# error "PORTME: big-endian systems will need to fix the layout here to get the next two fields working right"
146	#endif
147
148	/** A RTGETOPT_REQ_INT8 option argument. */
149	int8_t i8;
150	/** A RTGETOPT_REQ_UINT8 option argument . */
151	uint8_t u8;
152	/** A RTGETOPT_REQ_INT16 option argument. */
153	int16_t i16;
154	/** A RTGETOPT_REQ_UINT16 option argument . */
155	uint16_t u16;
156	/** A RTGETOPT_REQ_INT16 option argument. */
157	int32_t i32;
158	/** A RTGETOPT_REQ_UINT32 option argument . */
159	uint32_t u32;
160	/** A RTGETOPT_REQ_INT64 option argument. */
161	int64_t i64;
162	/** A RTGETOPT_REQ_UINT64 option argument. */
163	uint64_t u64;
164	#ifdef ___iprt_net_h
165	/** A RTGETOPT_REQ_IPV4ADDR option argument. */
166	RTNETADDRIPV4 IPv4Addr;
167	#endif
168	/** A RTGETOPT_REQ_MACADDR option argument. */
169	RTMAC MacAddr;
170	/** A RTGETOPT_REQ_UUID option argument. */
171	RTUUID Uuid;
172	/** A signed integer value. */
173	int64_t i;
174	/** An unsigned integer value. */
175	uint64_t u;
176	/** A boolean flag. */
177	bool f;
178	} RTGETOPTUNION;
179	/** Pointer to an option argument union. */
180	typedef RTGETOPTUNION *PRTGETOPTUNION;
181	/** Pointer to a const option argument union. */
182	typedef RTGETOPTUNION const *PCRTGETOPTUNION;
183
184
185	/**
186	* RTGetOpt state.
187	*/
188	typedef struct RTGETOPTSTATE
189	{
190	/** The next argument. */
191	int iNext;
192	/** Argument array. */
193	char **argv;
194	/** Number of items in argv. */
195	int argc;
196	/** Option definition array. */
197	PCRTGETOPTDEF paOptions;
198	/** Number of items in paOptions. */
199	size_t cOptions;
200	/** The next short option.
201	* (For parsing ls -latrT4 kind of option lists.) */
202	const char *pszNextShort;
203	/** The option definition which matched. NULL otherwise. */
204	PCRTGETOPTDEF pDef;
205	/** The index of an index option, otherwise UINT32_MAX. */
206	uint32_t uIndex;
207	/* More members will be added later for dealing with initial
208	call, optional sorting, '--' and so on. */
209	} RTGETOPTSTATE;
210	/** Pointer to RTGetOpt state. */
211	typedef RTGETOPTSTATE *PRTGETOPTSTATE;
212
213
214	/**
215	* Initialize the RTGetOpt state.
216	*
217	* The passed in argument vector may be sorted if fFlags indicates that this is
218	* desired (to be implemented).
219	*
220	* @returns VINF_SUCCESS, VERR_INVALID_PARAMETER or VERR_INVALID_POINTER.
221	* @param pState The state.
222	*
223	* @param argc Argument count, to be copied from what comes in with
224	* main().
225	* @param argv Argument array, to be copied from what comes in with
226	* main(). This may end up being modified by the
227	* option/argument sorting.
228	* @param paOptions Array of RTGETOPTDEF structures, which must specify what
229	* options are understood by the program.
230	* @param cOptions Number of array items passed in with paOptions.
231	* @param iFirst The argument to start with (in argv).
232	* @param fFlags The flags. MBZ for now.
233	*/
234	RTDECL(int) RTGetOptInit(PRTGETOPTSTATE pState, int argc, char **argv,
235	PCRTGETOPTDEF paOptions, size_t cOptions,
236	int iFirst, uint32_t fFlags);
237
238	/**
239	* Command line argument parser, handling both long and short options and checking
240	* argument formats, if desired.
241	*
242	* This is to be called in a loop until it returns 0 (meaning that all options
243	* were parsed) or a negative value (meaning that an error occured). How non-option
244	* arguments are dealt with depends on the flags passed to RTGetOptInit. The default
245	* (fFlags = 0) is to return VINF_GETOPT_NOT_OPTION with pValueUnion->psz pointing to
246	* the argument string.
247	*
248	* For example, for a program which takes the following options:
249	*
250	* --optwithstring (or -s) and a string argument;
251	* --optwithint (or -i) and a 32-bit signed integer argument;
252	* --verbose (or -v) with no arguments,
253	*
254	* code would look something like this:
255	*
256	* @code
257	int main(int argc, char **argv)
258	{
259	RTR3Init();
260
261	static const RTGETOPTDEF s_aOptions[] =
262	{
263	{ "--optwithstring", 's', RTGETOPT_REQ_STRING },
264	{ "--optwithint", 'i', RTGETOPT_REQ_INT32 },
265	{ "--verbose", 'v', 0 },
266	};
267
268	int ch;
269	RTGETOPTUNION ValueUnion;
270	RTGETOPTSTATE GetState;
271	RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
272	while ((ch = RTGetOpt(&GetState, &ValueUnion)))
273	{
274	// for options that require an argument, ValueUnion has received the value
275	switch (ch)
276	{
277	case 's': // --optwithstring or -s
278	// string argument, copy ValueUnion.psz
279	break;
280
281	case 'i': // --optwithint or -i
282	// integer argument, copy ValueUnion.i32
283	break;
284
285	case 'v': // --verbose or -v
286	g_fOptVerbose = true;
287	break;
288
289	case VINF_GETOPT_NOT_OPTION:
290	// handle non-option argument in ValueUnion.psz.
291	break;
292
293	default:
294	return RTGetOptPrintError(ch, &ValueUnion);
295	}
296	}
297
298	return 0;
299	}
300	@endcode
301	*
302	* @returns 0 when done parsing.
303	* @returns the iShort value of the option. pState->pDef points to the option
304	* definition which matched.
305	* @returns IPRT error status on parse error.
306	* @returns VINF_GETOPT_NOT_OPTION when encountering a non-option argument and
307	* RTGETOPT_FLAG_SORT was not specified. pValueUnion->psz points to the
308	* argument string.
309	* @returns VERR_GETOPT_UNKNOWN_OPTION when encountering an unknown option.
310	* pValueUnion->psz points to the option string.
311	* @returns VERR_GETOPT_REQUIRED_ARGUMENT_MISSING and pValueUnion->pDef if
312	* a required argument (aka value) was missing for an option.
313	* @returns VERR_GETOPT_INVALID_ARGUMENT_FORMAT and pValueUnion->pDef if
314	* argument (aka value) conversion failed.
315	*
316	* @param pState The state previously initialized with RTGetOptInit.
317	* @param pValueUnion Union with value; in the event of an error, psz member
318	* points to erroneous parameter; otherwise, for options
319	* that require an argument, this contains the value of
320	* that argument, depending on the type that is required.
321	*/
322	RTDECL(int) RTGetOpt(PRTGETOPTSTATE pState, PRTGETOPTUNION pValueUnion);
323
324	/**
325	* Fetch an additional value.
326	*
327	* This is used for special cases where an option have more than one value.
328	*
329	*
330	* @returns VINF_SUCCESS on success.
331	* @returns IPRT error status on parse error.
332	* @returns VERR_INVALID_PARAMETER if the flags are wrong.
333	* @returns VERR_GETOPT_UNKNOWN_OPTION when pState->pDef is null.
334	* @returns VERR_GETOPT_REQUIRED_ARGUMENT_MISSING if there are no more
335	* available arguments. pValueUnion->pDef is NULL.
336	* @returns VERR_GETOPT_INVALID_ARGUMENT_FORMAT and pValueUnion->pDef if
337	* value conversion failed.
338	*
339	* @param pState The state previously initialized with RTGetOptInit.
340	* @param pValueUnion Union with value; in the event of an error, psz member
341	* points to erroneous parameter; otherwise, for options
342	* that require an argument, this contains the value of
343	* that argument, depending on the type that is required.
344	* @param fFlags The flags.
345	*/
346	RTDECL(int) RTGetOptFetchValue(PRTGETOPTSTATE pState, PRTGETOPTUNION pValueUnion, uint32_t fFlags);
347
348	/**
349	* Print error messages for a RTGetOpt default case.
350	*
351	* Uses RTMsgError.
352	*
353	* @returns Suitable exit code.
354	*
355	* @param ch The RTGetOpt return value.
356	* @param pValueUnion The value union returned by RTGetOpt.
357	*/
358	RTDECL(int) RTGetOptPrintError(int ch, PCRTGETOPTUNION pValueUnion);
359
360	/** @} */
361
362	RT_C_DECLS_END
363
364	#endif
365

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/getopt.h@ 25477

Download in other formats: