1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 /* 35 * Copyright (c) 2009, Olivier MATZ <[email protected]> 36 * All rights reserved. 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions are met: 39 * 40 * * Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * * Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * * Neither the name of the University of California, Berkeley nor the 46 * names of its contributors may be used to endorse or promote products 47 * derived from this software without specific prior written permission. 48 * 49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY 50 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 51 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 52 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY 53 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 54 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 55 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 56 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 57 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 58 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 59 */ 60 61 #ifndef _PARSE_STRING_H_ 62 #define _PARSE_STRING_H_ 63 64 #include <cmdline_parse.h> 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif 69 70 /* size of a parsed string */ 71 #define STR_TOKEN_SIZE 128 72 73 /* size of a parsed multi string */ 74 #define STR_MULTI_TOKEN_SIZE 4096 75 76 typedef char cmdline_fixed_string_t[STR_TOKEN_SIZE]; 77 78 typedef char cmdline_multi_string_t[STR_MULTI_TOKEN_SIZE]; 79 80 struct cmdline_token_string_data { 81 const char *str; 82 }; 83 84 struct cmdline_token_string { 85 struct cmdline_token_hdr hdr; 86 struct cmdline_token_string_data string_data; 87 }; 88 typedef struct cmdline_token_string cmdline_parse_token_string_t; 89 90 extern struct cmdline_token_ops cmdline_token_string_ops; 91 92 int cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *srcbuf, 93 void *res, unsigned ressize); 94 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk); 95 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx, 96 char *dstbuf, unsigned int size); 97 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf, 98 unsigned int size); 99 100 /** 101 * Token marked as TOKEN_STRING_MULTI takes entire parsing string 102 * until “#” sign appear. Everything after “#” sign is treated as a comment. 103 * 104 * Note: 105 * In this case second parameter of TOKEN_STRING_INITIALIZER must be a type of 106 * cmdline_multi_string_t. 107 */ 108 #define TOKEN_STRING_MULTI "" 109 110 #define TOKEN_STRING_INITIALIZER(structure, field, string) \ 111 { \ 112 /* hdr */ \ 113 { \ 114 &cmdline_token_string_ops, /* ops */ \ 115 offsetof(structure, field), /* offset */ \ 116 }, \ 117 /* string_data */ \ 118 { \ 119 string, /* str */ \ 120 }, \ 121 } 122 123 #ifdef __cplusplus 124 } 125 #endif 126 127 #endif /* _PARSE_STRING_H_ */ 128