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