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