2 * Copyright (c) 2016-2017, Olivier MATZ <zer0@droids-corp.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
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.
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.
36 #include <ecoli_malloc.h>
37 #include <ecoli_log.h>
38 #include <ecoli_strvec.h>
39 #include <ecoli_node.h>
40 #include <ecoli_parsed.h>
41 #include <ecoli_completed.h>
42 #include <ecoli_node_subset.h>
43 #include <ecoli_node_str.h>
44 #include <ecoli_node_or.h>
45 #include <ecoli_test.h>
47 EC_LOG_TYPE_REGISTER(node_subset);
49 struct ec_node_subset {
51 struct ec_node **table;
56 size_t parsed_len; /* number of parsed node */
57 size_t len; /* consumed strings */
60 /* recursively find the longest list of nodes that matches: the state is
61 * updated accordingly. */
63 __ec_node_subset_parse(struct parse_result *out, struct ec_node **table,
64 size_t table_len, struct ec_parsed *state,
65 const struct ec_strvec *strvec)
67 struct ec_node **child_table;
68 struct ec_strvec *childvec = NULL;
70 struct parse_result best_result, result;
71 struct ec_parsed *best_parsed = NULL;
77 memset(&best_result, 0, sizeof(best_result));
79 child_table = ec_calloc(table_len - 1, sizeof(*child_table));
80 if (child_table == NULL) {
85 for (i = 0; i < table_len; i++) {
86 /* try to parse elt i */
87 ret = ec_node_parse_child(table[i], state, strvec);
91 if (ret == EC_PARSED_NOMATCH)
94 /* build a new table without elt i */
95 for (j = 0; j < table_len; j++) {
97 child_table[j] = table[j];
99 child_table[j - 1] = table[j];
102 /* build a new strvec (ret is the len of matched strvec) */
104 childvec = ec_strvec_ndup(strvec, len,
105 ec_strvec_len(strvec) - len);
106 if (childvec == NULL) {
111 memset(&result, 0, sizeof(result));
112 ret = __ec_node_subset_parse(&result, child_table,
113 table_len - 1, state, childvec);
114 ec_strvec_free(childvec);
119 /* if result is not the best, ignore */
120 if (result.parsed_len < best_result.parsed_len) {
121 memset(&result, 0, sizeof(result));
122 ec_parsed_del_last_child(state);
126 /* replace the previous best result */
127 ec_parsed_free(best_parsed);
128 best_parsed = ec_parsed_get_last_child(state);
129 ec_parsed_del_child(state, best_parsed);
131 best_result.parsed_len = result.parsed_len + 1;
132 best_result.len = len + result.len;
134 memset(&result, 0, sizeof(result));
138 ec_free(child_table);
139 if (best_parsed != NULL)
140 ec_parsed_add_child(state, best_parsed);
145 ec_parsed_free(best_parsed);
146 ec_strvec_free(childvec);
147 ec_free(child_table);
152 ec_node_subset_parse(const struct ec_node *gen_node,
153 struct ec_parsed *state,
154 const struct ec_strvec *strvec)
156 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
157 struct ec_parsed *parsed = NULL;
158 struct parse_result result;
161 memset(&result, 0, sizeof(result));
163 ret = __ec_node_subset_parse(&result, node->table,
164 node->len, state, strvec);
168 /* if no child node matches, return a matching empty strvec */
169 if (result.parsed_len == 0)
175 ec_parsed_free(parsed);
180 __ec_node_subset_complete(struct ec_node **table, size_t table_len,
181 struct ec_completed *completed,
182 struct ec_parsed *parsed,
183 const struct ec_strvec *strvec)
185 struct ec_strvec *childvec = NULL;
186 struct ec_node *save;
191 * example with table = [a, b, c]
192 * subset_complete([a,b,c], strvec) returns:
193 * complete(a, strvec) + complete(b, strvec) + complete(c, strvec) +
194 * + __subset_complete([b, c], childvec) if a matches
195 * + __subset_complete([a, c], childvec) if b matches
196 * + __subset_complete([a, b], childvec) if c matches
199 /* first, try to complete with each node of the table */
200 for (i = 0; i < table_len; i++) {
201 if (table[i] == NULL)
204 ret = ec_node_complete_child(table[i],
205 completed, parsed, strvec);
210 /* then, if a node matches, advance in strvec and try to complete with
211 * all the other nodes */
212 for (i = 0; i < table_len; i++) {
213 if (table[i] == NULL)
216 ret = ec_node_parse_child(table[i], parsed, strvec);
220 if (ret == EC_PARSED_NOMATCH)
224 childvec = ec_strvec_ndup(strvec, len,
225 ec_strvec_len(strvec) - len);
226 if (childvec == NULL) {
227 ec_parsed_del_last_child(parsed);
233 ret = __ec_node_subset_complete(table, table_len,
234 completed, parsed, childvec);
236 ec_strvec_free(childvec);
238 ec_parsed_del_last_child(parsed);
251 ec_node_subset_complete(const struct ec_node *gen_node,
252 struct ec_completed *completed,
253 struct ec_parsed *parsed,
254 const struct ec_strvec *strvec)
256 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
258 return __ec_node_subset_complete(node->table, node->len, completed,
262 static void ec_node_subset_free_priv(struct ec_node *gen_node)
264 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
267 for (i = 0; i < node->len; i++)
268 ec_node_free(node->table[i]);
269 ec_free(node->table);
272 int ec_node_subset_add(struct ec_node *gen_node, struct ec_node *child)
274 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
275 struct ec_node **table;
277 assert(node != NULL);
282 gen_node->flags &= ~EC_NODE_F_BUILT;
284 table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
291 table[node->len] = child;
294 child->parent = gen_node;
295 TAILQ_INSERT_TAIL(&gen_node->children, child, next);
300 static struct ec_node_type ec_node_subset_type = {
302 .parse = ec_node_subset_parse,
303 .complete = ec_node_subset_complete,
304 .size = sizeof(struct ec_node_subset),
305 .free_priv = ec_node_subset_free_priv,
308 EC_NODE_TYPE_REGISTER(ec_node_subset_type);
310 struct ec_node *__ec_node_subset(const char *id, ...)
312 struct ec_node *gen_node = NULL;
313 struct ec_node_subset *node = NULL;
314 struct ec_node *child;
320 gen_node = __ec_node(&ec_node_subset_type, id);
321 node = (struct ec_node_subset *)gen_node;
325 for (child = va_arg(ap, struct ec_node *);
326 child != EC_NODE_ENDLIST;
327 child = va_arg(ap, struct ec_node *)) {
329 /* on error, don't quit the loop to avoid leaks */
330 if (fail == 1 || child == NULL ||
331 ec_node_subset_add(gen_node, child) < 0) {
344 ec_node_free(gen_node); /* will also free children */
349 /* LCOV_EXCL_START */
350 static int ec_node_subset_testcase(void)
352 struct ec_node *node;
355 node = EC_NODE_SUBSET(NULL,
357 ec_node_str(NULL, "foo"),
358 ec_node_str(NULL, "bar")),
359 ec_node_str(NULL, "bar"),
360 ec_node_str(NULL, "toto")
363 EC_LOG(EC_LOG_ERR, "cannot create node\n");
366 ret |= EC_TEST_CHECK_PARSE(node, 0);
367 ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
368 ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
369 ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar", "titi");
370 ret |= EC_TEST_CHECK_PARSE(node, 3, "bar", "foo", "toto");
371 ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "foo");
372 ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "bar");
373 ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "foo");
374 ret |= EC_TEST_CHECK_PARSE(node, 0, " ");
375 ret |= EC_TEST_CHECK_PARSE(node, 0, "foox");
378 /* test completion */
379 node = EC_NODE_SUBSET(NULL,
380 ec_node_str(NULL, "foo"),
381 ec_node_str(NULL, "bar"),
382 ec_node_str(NULL, "bar2"),
383 ec_node_str(NULL, "toto"),
384 ec_node_str(NULL, "titi")
387 EC_LOG(EC_LOG_ERR, "cannot create node\n");
390 ret |= EC_TEST_CHECK_COMPLETE(node,
392 "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST);
393 ret |= EC_TEST_CHECK_COMPLETE(node,
395 "bar2", "bar", "foo", "toto", "titi", EC_NODE_ENDLIST);
396 ret |= EC_TEST_CHECK_COMPLETE(node,
397 "bar", "bar2", "", EC_NODE_ENDLIST,
398 "foo", "toto", "titi", EC_NODE_ENDLIST);
399 ret |= EC_TEST_CHECK_COMPLETE(node,
400 "f", EC_NODE_ENDLIST,
401 "foo", EC_NODE_ENDLIST);
402 ret |= EC_TEST_CHECK_COMPLETE(node,
403 "b", EC_NODE_ENDLIST,
404 "bar", "bar2", EC_NODE_ENDLIST);
405 ret |= EC_TEST_CHECK_COMPLETE(node,
406 "bar", EC_NODE_ENDLIST,
407 "bar", "bar2", EC_NODE_ENDLIST);
408 ret |= EC_TEST_CHECK_COMPLETE(node,
409 "bar", "b", EC_NODE_ENDLIST,
410 "bar2", EC_NODE_ENDLIST);
411 ret |= EC_TEST_CHECK_COMPLETE(node,
412 "t", EC_NODE_ENDLIST,
413 "toto", "titi", EC_NODE_ENDLIST);
414 ret |= EC_TEST_CHECK_COMPLETE(node,
415 "to", EC_NODE_ENDLIST,
416 "toto", EC_NODE_ENDLIST);
417 ret |= EC_TEST_CHECK_COMPLETE(node,
418 "x", EC_NODE_ENDLIST,
426 static struct ec_test ec_node_subset_test = {
427 .name = "node_subset",
428 .test = ec_node_subset_testcase,
431 EC_TEST_REGISTER(ec_node_subset_test);