src/lib/cmdline_parse_string.c

   1 /*-
   2  * Copyright (c) <2010>, Intel Corporation
   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  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  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
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  32  * OF THE POSSIBILITY OF SUCH DAMAGE.
  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
  67 #include "cmdline_parse.h"
  68 #include "cmdline_parse_string.h"
  69
  70 struct cmdline_token_ops cmdline_token_string_ops = {
  71         .parse = cmdline_parse_string,
  72         .complete_get_nb = cmdline_complete_get_nb_string,
  73         .complete_get_elt = cmdline_complete_get_elt_string,
  74         .get_help = cmdline_get_help_string,
  75 };
  76
  77 #define MULTISTRING_HELP "Mul-choice STRING"
  78 #define ANYSTRING_HELP   "Any STRING"
  79 #define FIXEDSTRING_HELP "Fixed STRING"
  80
  81 static unsigned int
  82 get_token_len(const char *s)
  83 {
  84         char c;
  85         unsigned int i=0;
  86
  87         c = s[i];
  88         while (c!='#' && c!='\0') {
  89                 i++;
  90                 c = s[i];
  91         }
  92         return i;
  93 }
  94
  95 static const char *
  96 get_next_token(const char *s)
  97 {
  98         unsigned int i;
  99         i = get_token_len(s);
 100         if (s[i] == '#')
 101                 return s+i+1;
 102         return NULL;
 103 }
 104
 105 static int parse_fixed_string(struct cmdline_token_string_data *sd,
 106                               const char *buf, unsigned token_len)
 107 {
 108         unsigned int conf_token_len;
 109         const char *str;
 110
 111         str = sd->str;
 112         for (str = sd->str; str != NULL ; str = get_next_token(str)) {
 113
 114                 conf_token_len = get_token_len(str);
 115
 116                 /* if token from config is too big... */
 117                 if (conf_token_len >= STR_TOKEN_SIZE - 1)
 118                         continue;
 119
 120                 /* compare conf token and user token */
 121                 if (token_len == conf_token_len &&
 122                     strncmp(buf, str, token_len) == 0)
 123                         return 0;
 124         }
 125
 126         return -1;
 127 }
 128
 129 int
 130 cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 131 {
 132         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 133         struct cmdline_token_string_data *sd = &tk2->string_data;;
 134         unsigned int token_len;
 135
 136         token_len = strlen(buf);
 137
 138         if (token_len >= (STR_TOKEN_SIZE - 1) || token_len == 0)
 139                 return -1;
 140
 141         /* fixed string */
 142         if (sd->str) {
 143                 if (parse_fixed_string(sd, buf, token_len) < 0)
 144                         return -1;
 145         }
 146
 147         /* we already checked that token_len is < STR_TOKEN_SIZE-1 */
 148         if (res)
 149                 strcpy(res, buf);
 150
 151         return token_len;
 152 }
 153
 154 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk)
 155 {
 156         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 157         struct cmdline_token_string_data *sd = &tk2->string_data;;
 158         int ret=1;
 159         const char *str;
 160
 161         if (!sd->str)
 162                 return 0;
 163
 164         str = sd->str;
 165         while( (str = get_next_token(str)) != NULL ) {
 166                 ret++;
 167         }
 168         return ret;
 169 }
 170
 171 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx,
 172                                     char *dstbuf, unsigned int size)
 173 {
 174         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 175         struct cmdline_token_string_data *sd = &tk2->string_data;;
 176         const char *s;
 177         unsigned int len;
 178
 179         s = sd->str;
 180
 181         while (idx-- && s)
 182                 s = get_next_token(s);
 183
 184         if (!s)
 185                 return -1;
 186
 187         len = get_token_len(s);
 188         if (len > size - 1)
 189                 return -1;
 190
 191         memcpy(dstbuf, s, len);
 192         dstbuf[len] = '\0';
 193         return 0;
 194 }
 195
 196
 197 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
 198                             unsigned int size)
 199 {
 200         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 201         struct cmdline_token_string_data *sd = &tk2->string_data;;
 202         const char *s;
 203
 204         s = sd->str;
 205
 206         if (s) {
 207                 if (get_next_token(s)) {
 208                         strncpy(dstbuf, MULTISTRING_HELP, size);
 209                 }
 210                 else {
 211                         strncpy(dstbuf, FIXEDSTRING_HELP, size);
 212                 }
 213         }
 214         else {
 215                 strncpy(dstbuf, ANYSTRING_HELP, size);
 216         }
 217
 218         dstbuf[size-1] = '\0';
 219
 220         return 0;
 221 }