lib/ecoli_tk_str.c

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <errno.h>
  32
  33 #include <ecoli_log.h>
  34 #include <ecoli_malloc.h>
  35 #include <ecoli_test.h>
  36 #include <ecoli_strvec.h>
  37 #include <ecoli_tk.h>
  38 #include <ecoli_tk_str.h>
  39
  40 struct ec_tk_str {
  41         struct ec_tk gen;
  42         char *string;
  43         unsigned len;
  44 };
  45
  46 static struct ec_parsed_tk *ec_tk_str_parse(const struct ec_tk *gen_tk,
  47         const struct ec_strvec *strvec)
  48 {
  49         struct ec_tk_str *tk = (struct ec_tk_str *)gen_tk;
  50         struct ec_strvec *match_strvec;
  51         struct ec_parsed_tk *parsed_tk = NULL;
  52         const char *str;
  53
  54         parsed_tk = ec_parsed_tk_new();
  55         if (parsed_tk == NULL)
  56                 goto fail;
  57
  58         if (ec_strvec_len(strvec) == 0)
  59                 return parsed_tk;
  60
  61         str = ec_strvec_val(strvec, 0);
  62         if (strcmp(str, tk->string) != 0)
  63                 return parsed_tk;
  64
  65         match_strvec = ec_strvec_ndup(strvec, 0, 1);
  66         if (match_strvec == NULL)
  67                 goto fail;
  68
  69         ec_parsed_tk_set_match(parsed_tk, gen_tk, match_strvec);
  70
  71         return parsed_tk;
  72
  73  fail:
  74         ec_parsed_tk_free(parsed_tk);
  75         return NULL;
  76 }
  77
  78 static struct ec_completed_tk *ec_tk_str_complete(const struct ec_tk *gen_tk,
  79         const struct ec_strvec *strvec)
  80 {
  81         struct ec_tk_str *tk = (struct ec_tk_str *)gen_tk;
  82         struct ec_completed_tk *completed_tk;
  83         struct ec_completed_tk_elt *completed_tk_elt;
  84         const char *str, *add;
  85         size_t n = 0;
  86
  87         completed_tk = ec_completed_tk_new();
  88         if (completed_tk == NULL)
  89                 return NULL;
  90
  91         if (ec_strvec_len(strvec) > 1)
  92                 return completed_tk;
  93
  94         if (ec_strvec_len(strvec) == 1) {
  95                 str = ec_strvec_val(strvec, 0);
  96                 for (n = 0; n < tk->len; n++) {
  97                         if (str[n] != tk->string[n])
  98                                 break;
  99                 }
 100
 101                 if (str[n] != '\0')
 102                         add = NULL;
 103                 else
 104                         add = tk->string + n;
 105         }
 106
 107         completed_tk_elt = ec_completed_tk_elt_new(gen_tk, add);
 108         if (completed_tk_elt == NULL) {
 109                 ec_completed_tk_free(completed_tk);
 110                 return NULL;
 111         }
 112
 113         ec_completed_tk_add_elt(completed_tk, completed_tk_elt);
 114
 115         return completed_tk;
 116 }
 117
 118 static const char *ec_tk_str_desc(const struct ec_tk *gen_tk)
 119 {
 120         struct ec_tk_str *tk = (struct ec_tk_str *)gen_tk;
 121
 122         return tk->string;
 123 }
 124
 125 static void ec_tk_str_free_priv(struct ec_tk *gen_tk)
 126 {
 127         struct ec_tk_str *tk = (struct ec_tk_str *)gen_tk;
 128
 129         ec_free(tk->string);
 130 }
 131
 132 static struct ec_tk_type ec_tk_str_type = {
 133         .name = "str",
 134         .parse = ec_tk_str_parse,
 135         .complete = ec_tk_str_complete,
 136         .desc = ec_tk_str_desc,
 137         .free_priv = ec_tk_str_free_priv,
 138 };
 139
 140 EC_TK_TYPE_REGISTER(ec_tk_str_type);
 141
 142 struct ec_tk *ec_tk_str_new(const char *id)
 143 {
 144         struct ec_tk *gen_tk = NULL;
 145
 146         gen_tk = ec_tk_new(id, &ec_tk_str_type, sizeof(struct ec_tk_str));
 147         if (gen_tk == NULL)
 148                 return NULL;
 149
 150         return gen_tk;
 151 }
 152
 153 int ec_tk_str_set_str(struct ec_tk *gen_tk, const char *str)
 154 {
 155         struct ec_tk_str *tk = (struct ec_tk_str *)gen_tk;
 156
 157         if (str == NULL)
 158                 return -EINVAL;
 159         if (tk->string != NULL)
 160                 return -EEXIST; // XXX allow to replace
 161
 162         tk->string = ec_strdup(str);
 163         if (tk->string == NULL)
 164                 return -ENOMEM;
 165
 166         tk->len = strlen(tk->string);
 167
 168         return 0;
 169 }
 170
 171 struct ec_tk *ec_tk_str(const char *id, const char *str)
 172 {
 173         struct ec_tk *gen_tk = NULL;
 174
 175         gen_tk = ec_tk_str_new(id);
 176         if (gen_tk == NULL)
 177                 goto fail;
 178
 179         if (ec_tk_str_set_str(gen_tk, str) < 0)
 180                 goto fail;
 181
 182         return gen_tk;
 183
 184 fail:
 185         ec_tk_free(gen_tk);
 186         return NULL;
 187 }
 188
 189 static int ec_tk_str_testcase(void)
 190 {
 191         struct ec_tk *tk;
 192         int ret = 0;
 193
 194         /* XXX use EC_NO_ID instead of NULL */
 195         tk = ec_tk_str(NULL, "foo");
 196         if (tk == NULL) {
 197                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 198                 return -1;
 199         }
 200         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "foo");
 201         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "foo", "bar");
 202         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "foobar");
 203         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, " foo");
 204         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "");
 205         ec_tk_free(tk);
 206
 207         tk = ec_tk_str(NULL, "Здравствуйте");
 208         if (tk == NULL) {
 209                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 210                 return -1;
 211         }
 212         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "Здравствуйте");
 213         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "Здравствуйте",
 214                 "John!");
 215         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "foo");
 216         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "");
 217         ec_tk_free(tk);
 218
 219         /* an empty token string always matches */
 220         tk = ec_tk_str(NULL, "");
 221         if (tk == NULL) {
 222                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 223                 return -1;
 224         }
 225         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "");
 226         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "", "foo");
 227         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "foo");
 228         ec_tk_free(tk);
 229
 230         /* test completion */
 231         tk = ec_tk_str(NULL, "foo");
 232         if (tk == NULL) {
 233                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 234                 return -1;
 235         }
 236         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 237                 "", EC_TK_ENDLIST,
 238                 "foo", EC_TK_ENDLIST,
 239                 "foo");
 240         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 241                 "f", EC_TK_ENDLIST,
 242                 "oo", EC_TK_ENDLIST,
 243                 "oo");
 244         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 245                 "foo", EC_TK_ENDLIST,
 246                 "", EC_TK_ENDLIST,
 247                 "");
 248         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 249                 "x", EC_TK_ENDLIST,
 250                 EC_TK_ENDLIST,
 251                 "");
 252         ec_tk_free(tk);
 253
 254         return ret;
 255 }
 256
 257 static struct ec_test ec_tk_str_test = {
 258         .name = "tk_str",
 259         .test = ec_tk_str_testcase,
 260 };
 261
 262 EC_TEST_REGISTER(ec_tk_str_test);