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