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