Subversion Repositories HelenOS

Rev

Rev 4709 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4709 mejdrech 1 
/*
2 
 * Copyright (c) 2009 Lukas Mejdrech
3 
 * All rights reserved.
4 
 *
5 
 * Redistribution and use in source and binary forms, with or without
6 
 * modification, are permitted provided that the following conditions
7 
 * are met:
8 
 *
9 
 * - Redistributions of source code must retain the above copyright
10 
 *   notice, this list of conditions and the following disclaimer.
11 
 * - Redistributions in binary form must reproduce the above copyright
12 
 *   notice, this list of conditions and the following disclaimer in the
13 
 *   documentation and/or other materials provided with the distribution.
14 
 * - The name of the author may not be used to endorse or promote products
15 
 *   derived from this software without specific prior written permission.
16 
 *
17 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
 */
28 
 
29 
/** @addtogroup net_app
30 
 *  @{
31 
 */
32 
 
33 
/** @file
4723 mejdrech 34 
 *  Generic command line arguments parsing functions.
4709 mejdrech 35 
 */
36 
 
37 
#ifndef __NET_APP_PARSE__
38 
#define __NET_APP_PARSE__
39 
 
40 
/** Prints the parameter unrecognized message and the application help.
41 
 *  @param index The index of the parameter. Input parameter.
42 
 *  @param parameter The parameter name. Input parameter.
43 
 */
44 
void    print_unrecognized( int index, const char * parameter );
45 
 
46 
/** Parses the next parameter as an integral number.
4723 mejdrech 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.
4709 mejdrech 49 
 *  @param argc The total number of the parameters. Input parameter.
50 
 *  @param argv The parameters. Input parameter.
4723 mejdrech 51 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
4709 mejdrech 52 
 *  @param value The parsed parameter value. Output parameter.
53 
 *  @param name The parameter name to be printed on errors. Input parameter.
54 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
55 
 *  @returns EOK on success.
56 
 *  @returns EINVAL if the parameter is missing.
57 
 *  @returns EINVAL if the parameter is in wrong format.
58 
 */
59 
int parse_parameter_int( int argc, char ** argv, int * index, int * value, const char * name, int offset );
60 
 
61 
/** Parses the next parameter as a character string.
4723 mejdrech 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.
64 
 *  Increments the actual index by the number of processed parameters.
4709 mejdrech 65 
 *  @param argc The total number of the parameters. Input parameter.
66 
 *  @param argv The parameters. Input parameter.
4723 mejdrech 67 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
4709 mejdrech 68 
 *  @param value The parsed parameter value. Output parameter.
69 
 *  @param name The parameter name to be printed on errors. Input parameter.
70 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
71 
 *  @returns EOK on success.
72 
 *  @returns EINVAL if the parameter is missing.
73 
 */
74 
int parse_parameter_string( int argc, char ** argv, int * index, char ** value, const char * name, int offset );
75 
 
76 
/** Parses the next named parameter as an integral number.
4723 mejdrech 77 
 *  The actual parameter is pointed by the index.
4709 mejdrech 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.
4723 mejdrech 80 
 *  Increments the actual index by the number of processed parameters.
4709 mejdrech 81 
 *  @param argc The total number of the parameters. Input parameter.
82 
 *  @param argv The parameters. Input parameter.
4723 mejdrech 83 
 *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
4709 mejdrech 84 
 *  @param value The parsed parameter value. Output parameter.
85 
 *  @param name The parameter name to be printed on errors. Input parameter.
86 
 *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
87 
 *  @param parse_value The translation function to parse the named value.
88 
 *  @returns EOK on success.
89 
 *  @returns EINVAL if the parameter is missing.
90 
 *  @returns ENOENT if the parameter name has not been found.
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 ));
93 
 
94 
#endif
95 
 
96 
/** @}
97 
 */