WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/app/parse.h



/** @addtogroup net_app
 *  @{
 */
 
/** @file
 *  Generic command line arguments parsing functions.
 */
 
#ifndef __NET_APP_PARSE__
#define __NET_APP_PARSE__
 

 *  @param parameter The parameter name. Input parameter.
 */
void    print_unrecognized( int index, const char * parameter );
 
/** Parses the next parameter as an integral number.
 *  The actual parameter is pointed by the index.
 *  Parses the offseted actual parameter value if the offset is set or the next one if not.
 *  @param argc The total number of the parameters. Input parameter.
 *  @param argv The parameters. Input parameter.
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 *  @param value The parsed parameter value. Output parameter.
 *  @param name The parameter name to be printed on errors. Input parameter.
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 *  @returns EOK on success.
 *  @returns EINVAL if the parameter is missing.
 *  @returns EINVAL if the parameter is in wrong format.
 */
int parse_parameter_int( int argc, char ** argv, int * index, int * value, const char * name, int offset );
 
/** Parses the next parameter as a character string.
 *  The actual parameter is pointed by the index.
 *  Uses the offseted actual parameter value if the offset is set or the next one if not.
 *  Increments the actual index by the number of processed parameters.
 *  @param argc The total number of the parameters. Input parameter.
 *  @param argv The parameters. Input parameter.
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 *  @param value The parsed parameter value. Output parameter.
 *  @param name The parameter name to be printed on errors. Input parameter.
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 *  @returns EOK on success.
 *  @returns EINVAL if the parameter is missing.
 */
int parse_parameter_string( int argc, char ** argv, int * index, char ** value, const char * name, int offset );
 
/** Parses the next named parameter as an integral number.
 *  The actual parameter is pointed by the index.
 *  Uses the offseted actual parameter if the offset is set or the next one if not.
 *  Translates the parameter using the parse_value function.
 *  Increments the actual index by the number of processed parameters.
 *  @param argc The total number of the parameters. Input parameter.
 *  @param argv The parameters. Input parameter.
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 *  @param value The parsed parameter value. Output parameter.
 *  @param name The parameter name to be printed on errors. Input parameter.
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 *  @param parse_value The translation function to parse the named value.
 *  @returns EOK on success.

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/app/parse.h – Rev 4709 → 4723

Rev 4709		Rev 4723
Line 29...		Line 29...
29	/** @addtogroup net_app	29	/** @addtogroup net_app
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Generic application parsing functions.	34	* Generic command line arguments parsing functions.
35	*/	35	*/
36		36
37	#ifndef __NET_APP_PARSE__	37	#ifndef __NET_APP_PARSE__
38	#define __NET_APP_PARSE__	38	#define __NET_APP_PARSE__
39		39
Line 42...		Line 42...
42	* @param parameter The parameter name. Input parameter.	42	* @param parameter The parameter name. Input parameter.
43	*/	43	*/
44	void print_unrecognized( int index, const char * parameter );	44	void print_unrecognized( int index, const char * parameter );
45		45
46	/** Parses the next parameter as an integral number.	46	/** Parses the next parameter as an integral number.
-		47	* The actual parameter is pointed by the index.
47	* Uses the offseted actual parameter if the offset is set or the next one if not.	48	* Parses the offseted actual parameter value if the offset is set or the next one if not.
48	* @param argc The total number of the parameters. Input parameter.	49	* @param argc The total number of the parameters. Input parameter.
49	* @param argv The parameters. Input parameter.	50	* @param argv The parameters. Input parameter.
50	* @param index The actual parameter index. Input/output parameter.	51	* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
51	* @param value The parsed parameter value. Output parameter.	52	* @param value The parsed parameter value. Output parameter.
52	* @param name The parameter name to be printed on errors. Input parameter.	53	* @param name The parameter name to be printed on errors. Input parameter.
53	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.	54	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
54	* @returns EOK on success.	55	* @returns EOK on success.
55	* @returns EINVAL if the parameter is missing.	56	* @returns EINVAL if the parameter is missing.
56	* @returns EINVAL if the parameter is in wrong format.	57	* @returns EINVAL if the parameter is in wrong format.
57	*/	58	*/
58	int parse_parameter_int( int argc, char ** argv, int * index, int * value, const char * name, int offset );	59	int parse_parameter_int( int argc, char ** argv, int * index, int * value, const char * name, int offset );
59		60
60	/** Parses the next parameter as a character string.	61	/** Parses the next parameter as a character string.
-		62	* The actual parameter is pointed by the index.
61	* Uses the offseted actual parameter if the offset is set or the next one if not.	63	* Uses the offseted actual parameter value if the offset is set or the next one if not.
-		64	* Increments the actual index by the number of processed parameters.
62	* @param argc The total number of the parameters. Input parameter.	65	* @param argc The total number of the parameters. Input parameter.
63	* @param argv The parameters. Input parameter.	66	* @param argv The parameters. Input parameter.
64	* @param index The actual parameter index. Input/output parameter.	67	* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
65	* @param value The parsed parameter value. Output parameter.	68	* @param value The parsed parameter value. Output parameter.
66	* @param name The parameter name to be printed on errors. Input parameter.	69	* @param name The parameter name to be printed on errors. Input parameter.
67	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.	70	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
68	* @returns EOK on success.	71	* @returns EOK on success.
69	* @returns EINVAL if the parameter is missing.	72	* @returns EINVAL if the parameter is missing.
70	*/	73	*/
71	int parse_parameter_string( int argc, char ** argv, int * index, char ** value, const char * name, int offset );	74	int parse_parameter_string( int argc, char ** argv, int * index, char ** value, const char * name, int offset );
72		75
73	/** Parses the next named parameter as an integral number.	76	/** Parses the next named parameter as an integral number.
-		77	* The actual parameter is pointed by the index.
74	* Uses the offseted actual parameter if the offset is set or the next one if not.	78	* Uses the offseted actual parameter if the offset is set or the next one if not.
75	* Translates the parameter using the parse_value function.	79	* Translates the parameter using the parse_value function.
-		80	* Increments the actual index by the number of processed parameters.
76	* @param argc The total number of the parameters. Input parameter.	81	* @param argc The total number of the parameters. Input parameter.
77	* @param argv The parameters. Input parameter.	82	* @param argv The parameters. Input parameter.
78	* @param index The actual parameter index. Input/output parameter.	83	* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
79	* @param value The parsed parameter value. Output parameter.	84	* @param value The parsed parameter value. Output parameter.
80	* @param name The parameter name to be printed on errors. Input parameter.	85	* @param name The parameter name to be printed on errors. Input parameter.
81	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.	86	* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
82	* @param parse_value The translation function to parse the named value.	87	* @param parse_value The translation function to parse the named value.
83	* @returns EOK on success.	88	* @returns EOK on success.