lib/librte_cmdline/cmdline_parse_string.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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 <zer0@droids-corp.org>
  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 #include <stdio.h>
  62 #include <inttypes.h>
  63 #include <ctype.h>
  64 #include <string.h>
  65 #include <stdarg.h>
  66 #include <errno.h>
  67 #include <rte_string_fns.h>
  68
  69 #include "cmdline_parse.h"
  70 #include "cmdline_parse_string.h"
  71
  72 struct cmdline_token_ops cmdline_token_string_ops = {
  73         .parse = cmdline_parse_string,
  74         .complete_get_nb = cmdline_complete_get_nb_string,
  75         .complete_get_elt = cmdline_complete_get_elt_string,
  76         .get_help = cmdline_get_help_string,
  77 };
  78
  79 #define MULTISTRING_HELP "Mul-choice STRING"
  80 #define ANYSTRING_HELP   "Any STRING"
  81 #define FIXEDSTRING_HELP "Fixed STRING"
  82
  83 static unsigned int
  84 get_token_len(const char *s)
  85 {
  86         char c;
  87         unsigned int i=0;
  88
  89         c = s[i];
  90         while (c!='#' && c!='\0') {
  91                 i++;
  92                 c = s[i];
  93         }
  94         return i;
  95 }
  96
  97 static const char *
  98 get_next_token(const char *s)
  99 {
 100         unsigned int i;
 101         i = get_token_len(s);
 102         if (s[i] == '#')
 103                 return s+i+1;
 104         return NULL;
 105 }
 106
 107 int
 108 cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 109 {
 110         struct cmdline_token_string *tk2;
 111         struct cmdline_token_string_data *sd;
 112         unsigned int token_len;
 113         const char *str;
 114
 115         if (!tk || !buf || ! *buf)
 116                 return -1;
 117
 118         tk2 = (struct cmdline_token_string *)tk;
 119
 120         sd = &tk2->string_data;
 121
 122         /* fixed string */
 123         if (sd->str) {
 124                 str = sd->str;
 125                 do {
 126                         token_len = get_token_len(str);
 127
 128                         /* if token is too big... */
 129                         if (token_len >= STR_TOKEN_SIZE - 1) {
 130                                 continue;
 131                         }
 132
 133                         if ( strncmp(buf, str, token_len) ) {
 134                                 continue;
 135                         }
 136
 137                         if ( !cmdline_isendoftoken(*(buf+token_len)) ) {
 138                                 continue;
 139                         }
 140
 141                         break;
 142                 } while ( (str = get_next_token(str)) != NULL );
 143
 144                 if (!str)
 145                         return -1;
 146         }
 147         /* unspecified string */
 148         else {
 149                 token_len = 0;
 150                 while(!cmdline_isendoftoken(buf[token_len]) &&
 151                       token_len < (STR_TOKEN_SIZE-1))
 152                         token_len++;
 153
 154                 /* return if token too long */
 155                 if (token_len >= STR_TOKEN_SIZE - 1) {
 156                         return -1;
 157                 }
 158         }
 159
 160         if (res) {
 161                 /* we are sure that token_len is < STR_TOKEN_SIZE-1 */
 162                 rte_snprintf(res, STR_TOKEN_SIZE, "%s", buf);
 163                 *((char *)res + token_len) = 0;
 164         }
 165
 166
 167         return token_len;
 168 }
 169
 170 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk)
 171 {
 172         struct cmdline_token_string *tk2;
 173         struct cmdline_token_string_data *sd;
 174         const char *str;
 175         int ret = 1;
 176
 177         if (!tk)
 178                 return -1;
 179
 180         tk2 = (struct cmdline_token_string *)tk;
 181         sd = &tk2->string_data;
 182
 183         if (!sd->str)
 184                 return 0;
 185
 186         str = sd->str;
 187         while( (str = get_next_token(str)) != NULL ) {
 188                 ret++;
 189         }
 190         return ret;
 191 }
 192
 193 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx,
 194                                     char *dstbuf, unsigned int size)
 195 {
 196         struct cmdline_token_string *tk2;
 197         struct cmdline_token_string_data *sd;
 198         const char *s;
 199         unsigned int len;
 200
 201         if (!tk || !dstbuf || idx < 0)
 202                 return -1;
 203
 204         tk2 = (struct cmdline_token_string *)tk;
 205         sd = &tk2->string_data;
 206
 207         s = sd->str;
 208
 209         while (idx-- && s)
 210                 s = get_next_token(s);
 211
 212         if (!s)
 213                 return -1;
 214
 215         len = get_token_len(s);
 216         if (len > size - 1)
 217                 return -1;
 218
 219         memcpy(dstbuf, s, len);
 220         dstbuf[len] = '\0';
 221         return 0;
 222 }
 223
 224
 225 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
 226                             unsigned int size)
 227 {
 228         struct cmdline_token_string *tk2;
 229         struct cmdline_token_string_data *sd;
 230         const char *s;
 231
 232         if (!tk || !dstbuf)
 233                 return -1;
 234
 235         tk2 = (struct cmdline_token_string *)tk;
 236         sd = &tk2->string_data;
 237
 238         s = sd->str;
 239
 240         if (s) {
 241                 if (get_next_token(s))
 242                         rte_snprintf(dstbuf, size, MULTISTRING_HELP);
 243                 else
 244                         rte_snprintf(dstbuf, size, FIXEDSTRING_HELP);
 245         } else
 246                 rte_snprintf(dstbuf, size, ANYSTRING_HELP);
 247
 248         return 0;
 249 }