Subversion Repositories HelenOS

Rev

Rev 4723 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4723 Rev 4756
Line 36... Line 36...
36 
 
 36 
 
37 
#ifndef __NET_APP_PARSE__
 37 
#ifndef __NET_APP_PARSE__
38 
#define __NET_APP_PARSE__
 38 
#define __NET_APP_PARSE__
39 
 
 39 
 
40 
/** Prints the parameter unrecognized message and the application help.
 40 
/** Prints the parameter unrecognized message and the application help.
41 
 *  @param index The index of the parameter. Input parameter.
 41 
 *  @param[in] index The index of the parameter.
42 
 *  @param parameter The parameter name. Input parameter.
 42 
 *  @param[in] parameter The parameter name.
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 
 *  The actual parameter is pointed by the index.
48 
 *  Parses the offseted actual parameter value 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.
49 
 *  @param argc The total number of the parameters. Input parameter.
 49 
 *  @param[in] argc The total number of the parameters.
50 
 *  @param argv The parameters. Input parameter.
 50 
 *  @param[in] argv The parameters.
51 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 51 
 *  @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters.
52 
 *  @param value The parsed parameter value. Output parameter.
 52 
 *  @param[out] value The parsed parameter value.
53 
 *  @param name The parameter name to be printed on errors. Input parameter.
 53 
 *  @param[in] name The parameter name to be printed on errors.
54 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 54 
 *  @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead.
55 
 *  @returns EOK on success.
 55 
 *  @returns EOK on success.
56 
 *  @returns EINVAL if the parameter is missing.
 56 
 *  @returns EINVAL if the parameter is missing.
57 
 *  @returns EINVAL if the parameter is in wrong format.
 57 
 *  @returns EINVAL if the parameter is in wrong format.
58 
 */
 58 
 */
59 
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 );
60 
 
 60 
 
61 
/** 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.
 62 
 *  The actual parameter is pointed by the index.
63 
 *  Uses the offseted actual parameter value 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.
 64 
 *  Increments the actual index by the number of processed parameters.
65 
 *  @param argc The total number of the parameters. Input parameter.
 65 
 *  @param[in] argc The total number of the parameters.
66 
 *  @param argv The parameters. Input parameter.
 66 
 *  @param[in] argv The parameters.
67 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 67 
 *  @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters.
68 
 *  @param value The parsed parameter value. Output parameter.
 68 
 *  @param[out] value The parsed parameter value.
69 
 *  @param name The parameter name to be printed on errors. Input parameter.
 69 
 *  @param[in] name The parameter name to be printed on errors.
70 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 70 
 *  @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead.
71 
 *  @returns EOK on success.
 71 
 *  @returns EOK on success.
72 
 *  @returns EINVAL if the parameter is missing.
 72 
 *  @returns EINVAL if the parameter is missing.
73 
 */
 73 
 */
74 
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 );
75 
 
 75 
 
76 
/** 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.
 77 
 *  The actual parameter is pointed by the index.
78 
 *  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.
79 
 *  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.
 80 
 *  Increments the actual index by the number of processed parameters.
81 
 *  @param argc The total number of the parameters. Input parameter.
 81 
 *  @param[in] argc The total number of the parameters.
82 
 *  @param argv The parameters. Input parameter.
 82 
 *  @param[in] argv The parameters.
83 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
 83 
 *  @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters.
84 
 *  @param value The parsed parameter value. Output parameter.
 84 
 *  @param[out] value The parsed parameter value.
85 
 *  @param name The parameter name to be printed on errors. Input parameter.
 85 
 *  @param[in] name The parameter name to be printed on errors.
86 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 86 
 *  @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead.
87 
 *  @param parse_value The translation function to parse the named value.
 87 
 *  @param[in] parse_value The translation function to parse the named value.
88 
 *  @returns EOK on success.
 88 
 *  @returns EOK on success.
89 
 *  @returns EINVAL if the parameter is missing.
 89 
 *  @returns EINVAL if the parameter is missing.
90 
 *  @returns ENOENT if the parameter name has not been found.
 90 
 *  @returns ENOENT if the parameter name has not been found.
91 
 */
 91 
 */
92 
int parse_parameter_name_int( int argc, char ** argv, int * index, int * value, const char * name, int offset, int ( * parse_value )( const char * value ));
 92 
int parse_parameter_name_int( int argc, char ** argv, int * index, int * value, const char * name, int offset, int ( * parse_value )( const char * value ));