lib/librte_cmdline/cmdline_parse_string.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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 /*
  36  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  37  * All rights reserved.
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in the
  45  *       documentation and/or other materials provided with the distribution.
  46  *     * Neither the name of the University of California, Berkeley nor the
  47  *       names of its contributors may be used to endorse or promote products
  48  *       derived from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  51  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  52  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  53  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  54  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  55  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  57  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #include <stdio.h>
  63 #include <inttypes.h>
  64 #include <ctype.h>
  65 #include <string.h>
  66 #include <stdarg.h>
  67 #include <errno.h>
  68 #include <rte_string_fns.h>
  69
  70 #include "cmdline_parse.h"
  71 #include "cmdline_parse_string.h"
  72
  73 struct cmdline_token_ops cmdline_token_string_ops = {
  74         .parse = cmdline_parse_string,
  75         .complete_get_nb = cmdline_complete_get_nb_string,
  76         .complete_get_elt = cmdline_complete_get_elt_string,
  77         .get_help = cmdline_get_help_string,
  78 };
  79
  80 #define MULTISTRING_HELP "Mul-choice STRING"
  81 #define ANYSTRING_HELP   "Any STRING"
  82 #define FIXEDSTRING_HELP "Fixed STRING"
  83
  84 static unsigned int
  85 get_token_len(const char *s)
  86 {
  87         char c;
  88         unsigned int i=0;
  89
  90         c = s[i];
  91         while (c!='#' && c!='\0') {
  92                 i++;
  93                 c = s[i];
  94         }
  95         return i;
  96 }
  97
  98 static const char *
  99 get_next_token(const char *s)
 100 {
 101         unsigned int i;
 102         i = get_token_len(s);
 103         if (s[i] == '#')
 104                 return s+i+1;
 105         return NULL;
 106 }
 107
 108 int
 109 cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 110 {
 111         struct cmdline_token_string *tk2;
 112         struct cmdline_token_string_data *sd;
 113         unsigned int token_len;
 114         const char *str;
 115
 116         if (!tk || !buf || ! *buf)
 117                 return -1;
 118
 119         tk2 = (struct cmdline_token_string *)tk;
 120
 121         sd = &tk2->string_data;
 122
 123         /* fixed string */
 124         if (sd->str) {
 125                 str = sd->str;
 126                 do {
 127                         token_len = get_token_len(str);
 128
 129                         /* if token is too big... */
 130                         if (token_len >= STR_TOKEN_SIZE - 1) {
 131                                 continue;
 132                         }
 133
 134                         if ( strncmp(buf, str, token_len) ) {
 135                                 continue;
 136                         }
 137
 138                         if ( !cmdline_isendoftoken(*(buf+token_len)) ) {
 139                                 continue;
 140                         }
 141
 142                         break;
 143                 } while ( (str = get_next_token(str)) != NULL );
 144
 145                 if (!str)
 146                         return -1;
 147         }
 148         /* unspecified string */
 149         else {
 150                 token_len = 0;
 151                 while(!cmdline_isendoftoken(buf[token_len]) &&
 152                       token_len < (STR_TOKEN_SIZE-1))
 153                         token_len++;
 154
 155                 /* return if token too long */
 156                 if (token_len >= STR_TOKEN_SIZE - 1) {
 157                         return -1;
 158                 }
 159         }
 160
 161         if (res) {
 162                 /* we are sure that token_len is < STR_TOKEN_SIZE-1 */
 163                 rte_snprintf(res, STR_TOKEN_SIZE, "%s", buf);
 164                 *((char *)res + token_len) = 0;
 165         }
 166
 167
 168         return token_len;
 169 }
 170
 171 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk)
 172 {
 173         struct cmdline_token_string *tk2;
 174         struct cmdline_token_string_data *sd;
 175         const char *str;
 176         int ret = 1;
 177
 178         if (!tk)
 179                 return -1;
 180
 181         tk2 = (struct cmdline_token_string *)tk;
 182         sd = &tk2->string_data;
 183
 184         if (!sd->str)
 185                 return 0;
 186
 187         str = sd->str;
 188         while( (str = get_next_token(str)) != NULL ) {
 189                 ret++;
 190         }
 191         return ret;
 192 }
 193
 194 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx,
 195                                     char *dstbuf, unsigned int size)
 196 {
 197         struct cmdline_token_string *tk2;
 198         struct cmdline_token_string_data *sd;
 199         const char *s;
 200         unsigned int len;
 201
 202         if (!tk || !dstbuf || idx < 0)
 203                 return -1;
 204
 205         tk2 = (struct cmdline_token_string *)tk;
 206         sd = &tk2->string_data;
 207
 208         s = sd->str;
 209
 210         while (idx-- && s)
 211                 s = get_next_token(s);
 212
 213         if (!s)
 214                 return -1;
 215
 216         len = get_token_len(s);
 217         if (len > size - 1)
 218                 return -1;
 219
 220         memcpy(dstbuf, s, len);
 221         dstbuf[len] = '\0';
 222         return 0;
 223 }
 224
 225
 226 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
 227                             unsigned int size)
 228 {
 229         struct cmdline_token_string *tk2;
 230         struct cmdline_token_string_data *sd;
 231         const char *s;
 232
 233         if (!tk || !dstbuf)
 234                 return -1;
 235
 236         tk2 = (struct cmdline_token_string *)tk;
 237         sd = &tk2->string_data;
 238
 239         s = sd->str;
 240
 241         if (s) {
 242                 if (get_next_token(s))
 243                         rte_snprintf(dstbuf, size, MULTISTRING_HELP);
 244                 else
 245                         rte_snprintf(dstbuf, size, FIXEDSTRING_HELP);
 246         } else
 247                 rte_snprintf(dstbuf, size, ANYSTRING_HELP);
 248
 249         return 0;
 250 }