lib/ecoli_node_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_node.h>
  38 #include <ecoli_parsed.h>
  39 #include <ecoli_completed.h>
  40 #include <ecoli_node_str.h>
  41
  42 struct ec_node_str {
  43         struct ec_node gen;
  44         char *string;
  45         unsigned len;
  46 };
  47
  48 static int
  49 ec_node_str_parse(const struct ec_node *gen_node,
  50                 struct ec_parsed *state,
  51                 const struct ec_strvec *strvec)
  52 {
  53         struct ec_node_str *node = (struct ec_node_str *)gen_node;
  54         const char *str;
  55
  56         (void)state;
  57
  58         if (ec_strvec_len(strvec) == 0)
  59                 return EC_PARSED_NOMATCH;
  60
  61         str = ec_strvec_val(strvec, 0);
  62         if (strcmp(str, node->string) != 0)
  63                 return EC_PARSED_NOMATCH;
  64
  65         return 1;
  66 }
  67
  68 static int
  69 ec_node_str_complete(const struct ec_node *gen_node,
  70                 struct ec_completed *completed,
  71                 struct ec_parsed *parsed,
  72                 const struct ec_strvec *strvec)
  73 {
  74         struct ec_completed_item *item = NULL;
  75         struct ec_node_str *node = (struct ec_node_str *)gen_node;
  76         const char *str;
  77         size_t n = 0;
  78         int ret;
  79
  80         (void)parsed;
  81
  82         if (ec_strvec_len(strvec) != 1)
  83                 return 0;
  84
  85         str = ec_strvec_val(strvec, 0);
  86         for (n = 0; n < node->len; n++) {
  87                 if (str[n] != node->string[n])
  88                         break;
  89         }
  90
  91         /* no completion */
  92         if (str[n] != '\0')
  93                 return 0; // XXX add a no_match instead?
  94
  95         item = ec_completed_item(parsed, gen_node);
  96         if (item == NULL)
  97                 return -ENOMEM;
  98         ret = ec_completed_item_set(item, EC_MATCH, node->string);
  99         if (ret < 0) {
 100                 ec_completed_item_free(item);
 101                 return ret;
 102         }
 103         ret = ec_completed_item_add(completed, item);
 104         if (ret < 0) {
 105                 ec_completed_item_free(item);
 106                 return ret;
 107         }
 108
 109         return 0;
 110 }
 111
 112 static const char *ec_node_str_desc(const struct ec_node *gen_node)
 113 {
 114         struct ec_node_str *node = (struct ec_node_str *)gen_node;
 115
 116         return node->string;
 117 }
 118
 119 static void ec_node_str_free_priv(struct ec_node *gen_node)
 120 {
 121         struct ec_node_str *node = (struct ec_node_str *)gen_node;
 122
 123         ec_free(node->string);
 124 }
 125
 126 static size_t ec_node_str_get_max_parse_len(const struct ec_node *gen_node)
 127 {
 128         (void)gen_node;
 129         return 1;
 130 }
 131
 132 static struct ec_node_type ec_node_str_type = {
 133         .name = "str",
 134         .parse = ec_node_str_parse,
 135         .complete = ec_node_str_complete,
 136         .get_max_parse_len = ec_node_str_get_max_parse_len,
 137         .desc = ec_node_str_desc,
 138         .size = sizeof(struct ec_node_str),
 139         .free_priv = ec_node_str_free_priv,
 140 };
 141
 142 EC_NODE_TYPE_REGISTER(ec_node_str_type);
 143
 144 int ec_node_str_set_str(struct ec_node *gen_node, const char *str)
 145 {
 146         struct ec_node_str *node = (struct ec_node_str *)gen_node;
 147
 148         if (str == NULL)
 149                 return -EINVAL;
 150         if (node->string != NULL)
 151                 return -EEXIST; // XXX allow to replace
 152
 153         node->string = ec_strdup(str);
 154         if (node->string == NULL)
 155                 return -ENOMEM;
 156
 157         node->len = strlen(node->string);
 158
 159         return 0;
 160 }
 161
 162 struct ec_node *ec_node_str(const char *id, const char *str)
 163 {
 164         struct ec_node *gen_node = NULL;
 165
 166         gen_node = __ec_node(&ec_node_str_type, id);
 167         if (gen_node == NULL)
 168                 goto fail;
 169
 170         if (ec_node_str_set_str(gen_node, str) < 0)
 171                 goto fail;
 172
 173         return gen_node;
 174
 175 fail:
 176         ec_node_free(gen_node);
 177         return NULL;
 178 }
 179
 180 /* LCOV_EXCL_START */
 181 static int ec_node_str_testcase(void)
 182 {
 183         struct ec_node *node;
 184         int ret = 0;
 185
 186         /* XXX use EC_NO_ID instead of NULL */
 187         node = ec_node_str(NULL, "foo");
 188         if (node == NULL) {
 189                 ec_log(EC_LOG_ERR, "cannot create node\n");
 190                 return -1;
 191         }
 192         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
 193         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "bar");
 194         ret |= EC_TEST_CHECK_PARSE(node, -1, "foobar");
 195         ret |= EC_TEST_CHECK_PARSE(node, -1, " foo");
 196         ret |= EC_TEST_CHECK_PARSE(node, -1, "");
 197         ec_node_free(node);
 198
 199         node = ec_node_str(NULL, "Здравствуйте");
 200         if (node == NULL) {
 201                 ec_log(EC_LOG_ERR, "cannot create node\n");
 202                 return -1;
 203         }
 204         ret |= EC_TEST_CHECK_PARSE(node, 1, "Здравствуйте");
 205         ret |= EC_TEST_CHECK_PARSE(node, 1, "Здравствуйте",
 206                 "John!");
 207         ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
 208         ret |= EC_TEST_CHECK_PARSE(node, -1, "");
 209         ec_node_free(node);
 210
 211         /* an empty string node always matches */
 212         node = ec_node_str(NULL, "");
 213         if (node == NULL) {
 214                 ec_log(EC_LOG_ERR, "cannot create node\n");
 215                 return -1;
 216         }
 217         ret |= EC_TEST_CHECK_PARSE(node, 1, "");
 218         ret |= EC_TEST_CHECK_PARSE(node, 1, "", "foo");
 219         ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
 220         ec_node_free(node);
 221
 222         /* test completion */
 223         node = ec_node_str(NULL, "foo");
 224         if (node == NULL) {
 225                 ec_log(EC_LOG_ERR, "cannot create node\n");
 226                 return -1;
 227         }
 228         ret |= EC_TEST_CHECK_COMPLETE(node,
 229                 EC_NODE_ENDLIST,
 230                 EC_NODE_ENDLIST,
 231                 "");
 232         ret |= EC_TEST_CHECK_COMPLETE(node,
 233                 "", EC_NODE_ENDLIST,
 234                 "foo", EC_NODE_ENDLIST,
 235                 "foo");
 236         ret |= EC_TEST_CHECK_COMPLETE(node,
 237                 "f", EC_NODE_ENDLIST,
 238                 "foo", EC_NODE_ENDLIST,
 239                 "foo");
 240         ret |= EC_TEST_CHECK_COMPLETE(node,
 241                 "foo", EC_NODE_ENDLIST,
 242                 "foo", EC_NODE_ENDLIST,
 243                 "foo");
 244         ret |= EC_TEST_CHECK_COMPLETE(node,
 245                 "x", EC_NODE_ENDLIST,
 246                 EC_NODE_ENDLIST,
 247                 "");
 248         ec_node_free(node);
 249
 250         return ret;
 251 }
 252 /* LCOV_EXCL_STOP */
 253
 254 static struct ec_test ec_node_str_test = {
 255         .name = "node_str",
 256         .test = ec_node_str_testcase,
 257 };
 258
 259 EC_TEST_REGISTER(ec_node_str_test);