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 struct ec_node_subset {
49 struct ec_node **table;
54 size_t parsed_len; /* number of parsed node */
55 size_t len; /* consumed strings */
58 /* recursively find the longest list of nodes that matches: the state is
59 * updated accordingly. */
61 __ec_node_subset_parse(struct parse_result *out, struct ec_node **table,
62 size_t table_len, struct ec_parsed *state,
63 const struct ec_strvec *strvec)
65 struct ec_node **child_table;
66 struct ec_strvec *childvec = NULL;
68 struct parse_result best_result, result;
69 struct ec_parsed *best_parsed = NULL;
75 memset(&best_result, 0, sizeof(best_result));
77 child_table = ec_calloc(table_len - 1, sizeof(*child_table));
78 if (child_table == NULL) {
83 for (i = 0; i < table_len; i++) {
84 /* try to parse elt i */
85 ret = ec_node_parse_child(table[i], state, strvec);
86 if (ret == EC_PARSED_NOMATCH)
91 /* build a new table without elt i */
92 for (j = 0; j < table_len; j++) {
94 child_table[j] = table[j];
96 child_table[j - 1] = table[j];
99 /* build a new strvec (ret is the len of matched strvec) */
101 childvec = ec_strvec_ndup(strvec, len,
102 ec_strvec_len(strvec) - len);
103 if (childvec == NULL) {
108 memset(&result, 0, sizeof(result));
109 ret = __ec_node_subset_parse(&result, child_table,
110 table_len - 1, state, childvec);
111 ec_strvec_free(childvec);
116 /* if result is not the best, ignore */
117 if (result.parsed_len < best_result.parsed_len) {
118 struct ec_parsed *child_parsed;
120 memset(&result, 0, sizeof(result));
121 child_parsed = ec_parsed_get_last_child(state);
122 ec_parsed_del_child(state, child_parsed);
123 ec_parsed_free(child_parsed);
127 /* replace the previous best result */
128 ec_parsed_free(best_parsed);
129 best_parsed = ec_parsed_get_last_child(state);
130 ec_parsed_del_child(state, best_parsed);
132 best_result.parsed_len = result.parsed_len + 1;
133 best_result.len = len + result.len;
135 memset(&result, 0, sizeof(result));
139 ec_free(child_table);
140 if (best_parsed != NULL)
141 ec_parsed_add_child(state, best_parsed);
146 ec_parsed_free(best_parsed);
147 ec_strvec_free(childvec);
148 ec_free(child_table);
153 ec_node_subset_parse(const struct ec_node *gen_node,
154 struct ec_parsed *state,
155 const struct ec_strvec *strvec)
157 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
158 struct ec_parsed *parsed = NULL;
159 struct parse_result result;
162 memset(&result, 0, sizeof(result));
164 ret = __ec_node_subset_parse(&result, node->table,
165 node->len, state, strvec);
169 /* if no child node matches, return a matching empty strvec */
170 if (result.parsed_len == 0)
176 ec_parsed_free(parsed);
180 static struct ec_completed *
181 __ec_node_subset_complete(struct ec_node **table, size_t table_len,
182 const struct ec_strvec *strvec)
184 struct ec_completed *completed = NULL;
185 struct ec_completed *child_completed = NULL;
186 struct ec_strvec *childvec = NULL;
187 struct ec_parsed *parsed = NULL;
188 struct ec_node *save;
192 * example with table = [a, b, c]
193 * subset_complete([a,b,c], strvec) returns:
194 * complete(a, strvec) + complete(b, strvec) + complete(c, strvec) +
195 * + __subset_complete([b, c], childvec) if a matches
196 * + __subset_complete([a, c], childvec) if b matches
197 * + __subset_complete([a, b], childvec) if c matches
200 completed = ec_completed();
201 if (completed == NULL)
204 /* first, try to complete with each node of the table */
205 for (i = 0; i < table_len; i++) {
206 if (table[i] == NULL)
209 child_completed = ec_node_complete_strvec(table[i],
212 if (child_completed == NULL)
215 ec_completed_merge(completed, child_completed);
216 child_completed = NULL;
219 /* then, if a node matches, advance in strvec and try to complete with
220 * all the other nodes */
221 for (i = 0; i < table_len; i++) {
222 if (table[i] == NULL)
225 parsed = ec_node_parse_strvec(table[i], strvec);
229 if (!ec_parsed_matches(parsed)) {
230 ec_parsed_free(parsed);
235 len = ec_parsed_len(parsed);
236 childvec = ec_strvec_ndup(strvec, len,
237 ec_strvec_len(strvec) - len);
238 if (childvec == NULL)
243 child_completed = __ec_node_subset_complete(table,
244 table_len, childvec);
246 ec_strvec_free(childvec);
249 if (child_completed == NULL)
252 ec_completed_merge(completed, child_completed);
253 child_completed = NULL;
255 ec_parsed_free(parsed);
261 ec_parsed_free(parsed);
262 ec_completed_free(child_completed);
263 ec_completed_free(completed);
268 static struct ec_completed *ec_node_subset_complete(const struct ec_node *gen_node,
269 const struct ec_strvec *strvec)
271 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
273 return __ec_node_subset_complete(node->table, node->len, strvec);
276 static void ec_node_subset_free_priv(struct ec_node *gen_node)
278 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
281 for (i = 0; i < node->len; i++)
282 ec_node_free(node->table[i]);
283 ec_free(node->table);
286 int ec_node_subset_add(struct ec_node *gen_node, struct ec_node *child)
288 struct ec_node_subset *node = (struct ec_node_subset *)gen_node;
289 struct ec_node **table;
291 assert(node != NULL);
296 gen_node->flags &= ~EC_NODE_F_BUILT;
298 table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
305 table[node->len] = child;
308 child->parent = gen_node;
309 TAILQ_INSERT_TAIL(&gen_node->children, child, next);
314 static struct ec_node_type ec_node_subset_type = {
316 .parse = ec_node_subset_parse,
317 .complete = ec_node_subset_complete,
318 .size = sizeof(struct ec_node_subset),
319 .free_priv = ec_node_subset_free_priv,
322 EC_NODE_TYPE_REGISTER(ec_node_subset_type);
324 struct ec_node *__ec_node_subset(const char *id, ...)
326 struct ec_node *gen_node = NULL;
327 struct ec_node_subset *node = NULL;
328 struct ec_node *child;
334 gen_node = __ec_node(&ec_node_subset_type, id);
335 node = (struct ec_node_subset *)gen_node;
339 for (child = va_arg(ap, struct ec_node *);
340 child != EC_NODE_ENDLIST;
341 child = va_arg(ap, struct ec_node *)) {
343 /* on error, don't quit the loop to avoid leaks */
344 if (fail == 1 || child == NULL ||
345 ec_node_subset_add(gen_node, child) < 0) {
358 ec_node_free(gen_node); /* will also free children */
363 static int ec_node_subset_testcase(void)
365 struct ec_node *node;
368 node = EC_NODE_SUBSET(NULL,
370 ec_node_str(NULL, "foo"),
371 ec_node_str(NULL, "bar")),
372 ec_node_str(NULL, "bar"),
373 ec_node_str(NULL, "toto")
376 ec_log(EC_LOG_ERR, "cannot create node\n");
379 ret |= EC_TEST_CHECK_PARSE(node, 0);
380 ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
381 ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
382 ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar", "titi");
383 ret |= EC_TEST_CHECK_PARSE(node, 3, "bar", "foo", "toto");
384 ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "foo");
385 ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "bar");
386 ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "foo");
387 ret |= EC_TEST_CHECK_PARSE(node, 0, " ");
388 ret |= EC_TEST_CHECK_PARSE(node, 0, "foox");
391 /* test completion */
392 node = EC_NODE_SUBSET(NULL,
393 ec_node_str(NULL, "foo"),
394 ec_node_str(NULL, "bar"),
395 ec_node_str(NULL, "bar2"),
396 ec_node_str(NULL, "toto"),
397 ec_node_str(NULL, "titi")
400 ec_log(EC_LOG_ERR, "cannot create node\n");
403 ret |= EC_TEST_CHECK_COMPLETE(node,
405 "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST,
407 ret |= EC_TEST_CHECK_COMPLETE(node,
408 "bar", "bar2", "", EC_NODE_ENDLIST,
409 "foo", "toto", "titi", EC_NODE_ENDLIST,
411 ret |= EC_TEST_CHECK_COMPLETE(node,
412 "f", EC_NODE_ENDLIST,
413 "oo", EC_NODE_ENDLIST,
415 ret |= EC_TEST_CHECK_COMPLETE(node,
416 "b", EC_NODE_ENDLIST,
417 "ar", "ar2", EC_NODE_ENDLIST,
419 ret |= EC_TEST_CHECK_COMPLETE(node,
420 "bar", EC_NODE_ENDLIST,
421 "", "2", EC_NODE_ENDLIST,
423 ret |= EC_TEST_CHECK_COMPLETE(node,
424 "bar", "b", EC_NODE_ENDLIST,
425 "ar2", EC_NODE_ENDLIST,
427 ret |= EC_TEST_CHECK_COMPLETE(node,
428 "t", EC_NODE_ENDLIST,
429 "oto", "iti", EC_NODE_ENDLIST,
431 ret |= EC_TEST_CHECK_COMPLETE(node,
432 "to", EC_NODE_ENDLIST,
433 "to", EC_NODE_ENDLIST,
435 ret |= EC_TEST_CHECK_COMPLETE(node,
436 "x", EC_NODE_ENDLIST,
444 static struct ec_test ec_node_subset_test = {
445 .name = "node_subset",
446 .test = ec_node_subset_testcase,
449 EC_TEST_REGISTER(ec_node_subset_test);