Rev 4723 | 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. |
||
| 4756 | mejdrech | 41 | * @param[in] index The index of the parameter. |
| 42 | * @param[in] parameter The parameter name. |
||
| 4709 | mejdrech | 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. |
||
| 4756 | mejdrech | 49 | * @param[in] argc The total number of the parameters. |
| 50 | * @param[in] argv The parameters. |
||
| 51 | * @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
||
| 52 | * @param[out] value The parsed parameter value. |
||
| 53 | * @param[in] name The parameter name to be printed on errors. |
||
| 54 | * @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
||
| 4709 | mejdrech | 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. |
||
| 4756 | mejdrech | 65 | * @param[in] argc The total number of the parameters. |
| 66 | * @param[in] argv The parameters. |
||
| 67 | * @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
||
| 68 | * @param[out] value The parsed parameter value. |
||
| 69 | * @param[in] name The parameter name to be printed on errors. |
||
| 70 | * @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
||
| 4709 | mejdrech | 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. |
| 4756 | mejdrech | 81 | * @param[in] argc The total number of the parameters. |
| 82 | * @param[in] argv The parameters. |
||
| 83 | * @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
||
| 84 | * @param[out] value The parsed parameter value. |
||
| 85 | * @param[in] name The parameter name to be printed on errors. |
||
| 86 | * @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
||
| 87 | * @param[in] parse_value The translation function to parse the named value. |
||
| 4709 | mejdrech | 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 | */ |