1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
13 #include <ecoli_malloc.h>
14 #include <ecoli_log.h>
15 #include <ecoli_test.h>
16 #include <ecoli_strvec.h>
17 #include <ecoli_node.h>
18 #include <ecoli_config.h>
19 #include <ecoli_parse.h>
20 #include <ecoli_complete.h>
21 #include <ecoli_node_str.h>
22 #include <ecoli_node_option.h>
23 #include <ecoli_node_or.h>
24 #include <ecoli_node_many.h>
25 #include <ecoli_node_seq.h>
27 EC_LOG_TYPE_REGISTER(node_seq);
31 struct ec_node **table;
36 ec_node_seq_parse(const struct ec_node *gen_node,
37 struct ec_parse *state,
38 const struct ec_strvec *strvec)
40 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
41 struct ec_strvec *childvec = NULL;
46 for (i = 0; i < node->len; i++) {
47 childvec = ec_strvec_ndup(strvec, len,
48 ec_strvec_len(strvec) - len);
52 ret = ec_node_parse_child(node->table[i], state, childvec);
56 ec_strvec_free(childvec);
59 if (ret == EC_PARSE_NOMATCH) {
60 ec_parse_free_children(state);
61 return EC_PARSE_NOMATCH;
70 ec_strvec_free(childvec);
75 __ec_node_seq_complete(struct ec_node **table, size_t table_len,
77 const struct ec_strvec *strvec)
79 struct ec_parse *parse = ec_comp_get_state(comp);
80 struct ec_strvec *childvec = NULL;
88 * Example of completion for a sequence node = [n1,n2] and an
91 * result = complete(n1, [a,b,c,d]) +
92 * complete(n2, [b,c,d]) if n1 matches [a] +
93 * complete(n2, [c,d]) if n1 matches [a,b] +
94 * complete(n2, [d]) if n1 matches [a,b,c] +
95 * complete(n2, []) if n1 matches [a,b,c,d]
98 /* first, try to complete with the first node of the table */
99 ret = ec_node_complete_child(table[0], comp, strvec);
103 /* then, if the first node of the table matches the beginning of the
104 * strvec, try to complete the rest */
105 for (i = 0; i < ec_strvec_len(strvec); i++) {
106 childvec = ec_strvec_ndup(strvec, 0, i);
107 if (childvec == NULL)
110 ret = ec_node_parse_child(table[0], parse, childvec);
114 ec_strvec_free(childvec);
117 if ((unsigned int)ret != i) {
118 if (ret != EC_PARSE_NOMATCH)
119 ec_parse_del_last_child(parse);
123 childvec = ec_strvec_ndup(strvec, i, ec_strvec_len(strvec) - i);
124 if (childvec == NULL) {
125 ec_parse_del_last_child(parse);
129 ret = __ec_node_seq_complete(&table[1],
132 ec_parse_del_last_child(parse);
133 ec_strvec_free(childvec);
143 ec_strvec_free(childvec);
148 ec_node_seq_complete(const struct ec_node *gen_node,
149 struct ec_comp *comp,
150 const struct ec_strvec *strvec)
152 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
154 return __ec_node_seq_complete(node->table, node->len, comp,
158 static void ec_node_seq_free_priv(struct ec_node *gen_node)
160 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
162 ec_free(node->table);
165 static const struct ec_config_schema ec_node_seq_subschema[] = {
167 .desc = "A child node which is part of the sequence.",
168 .type = EC_CONFIG_TYPE_NODE,
172 static const struct ec_config_schema ec_node_seq_schema[] = {
175 .desc = "The list of children nodes, to be parsed in sequence.",
176 .type = EC_CONFIG_TYPE_LIST,
177 .subschema = ec_node_seq_subschema,
178 .subschema_len = EC_COUNT_OF(ec_node_seq_subschema),
182 static int ec_node_seq_set_config(struct ec_node *gen_node,
183 const struct ec_config *config)
185 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
186 const struct ec_config *children = NULL, *child;
187 struct ec_node **table = NULL;
190 children = ec_config_dict_get(config, "children");
191 if (children == NULL) {
197 TAILQ_FOREACH(child, &children->list, next)
200 table = ec_malloc(n * sizeof(*table));
205 TAILQ_FOREACH(child, &children->list, next) {
206 table[n] = ec_node_clone(child->node);
210 for (i = 0; i < node->len; i++)
211 ec_node_free(node->table[i]);
212 ec_free(node->table);
220 for (i = 0; i < n; i++)
221 ec_node_free(table[i]);
228 ec_node_seq_get_children_count(const struct ec_node *gen_node)
230 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
234 static struct ec_node *
235 ec_node_seq_get_child(const struct ec_node *gen_node, size_t i)
237 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
242 return node->table[i];
246 ec_node_seq_get_child_refs(const struct ec_node *gen_node, size_t i)
251 /* each child node is referenced twice: once in the config and
252 * once in the node->table[] */
256 static struct ec_node_type ec_node_seq_type = {
258 .schema = ec_node_seq_schema,
259 .schema_len = EC_COUNT_OF(ec_node_seq_schema),
260 .set_config = ec_node_seq_set_config,
261 .parse = ec_node_seq_parse,
262 .complete = ec_node_seq_complete,
263 .size = sizeof(struct ec_node_seq),
264 .free_priv = ec_node_seq_free_priv,
265 .get_children_count = ec_node_seq_get_children_count,
266 .get_child = ec_node_seq_get_child,
267 .get_child_refs = ec_node_seq_get_child_refs,
270 EC_NODE_TYPE_REGISTER(ec_node_seq_type);
272 int ec_node_seq_add(struct ec_node *gen_node, struct ec_node *child)
274 struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
275 const struct ec_config *cur_config = NULL;
276 struct ec_config *config = NULL, *children;
279 assert(node != NULL);
281 /* XXX factorize this code in a helper */
283 if (ec_node_check_type(gen_node, &ec_node_seq_type) < 0)
286 cur_config = ec_node_get_config(gen_node);
287 if (cur_config == NULL)
288 config = ec_config_dict();
290 config = ec_config_dup(cur_config);
294 children = ec_config_dict_get(config, "children");
295 if (children == NULL) {
296 children = ec_config_list();
297 if (children == NULL)
300 if (ec_config_dict_set(config, "children", children) < 0)
301 goto fail; /* children list is freed on error */
304 if (ec_config_list_add(children, ec_config_node(child)) < 0) {
309 ret = ec_node_set_config(gen_node, config);
310 config = NULL; /* freed */
317 ec_config_free(config);
322 struct ec_node *__ec_node_seq(const char *id, ...)
324 struct ec_config *config = NULL, *children = NULL;
325 struct ec_node *gen_node = NULL;
326 struct ec_node *child;
331 child = va_arg(ap, struct ec_node *);
333 gen_node = __ec_node(&ec_node_seq_type, id);
334 if (gen_node == NULL)
335 goto fail_free_children;
337 config = ec_config_dict();
339 goto fail_free_children;
341 children = ec_config_list();
342 if (children == NULL)
343 goto fail_free_children;
345 for (; child != EC_NODE_ENDLIST; child = va_arg(ap, struct ec_node *)) {
347 goto fail_free_children;
349 if (ec_config_list_add(children, ec_config_node(child)) < 0) {
351 goto fail_free_children;
355 if (ec_config_dict_set(config, "children", children) < 0) {
356 children = NULL; /* freed */
361 ret = ec_node_set_config(gen_node, config);
362 config = NULL; /* freed */
371 for (; child != EC_NODE_ENDLIST; child = va_arg(ap, struct ec_node *))
374 ec_node_free(gen_node); /* will also free added children */
375 ec_config_free(children);
376 ec_config_free(config);
382 /* LCOV_EXCL_START */
383 static int ec_node_seq_testcase(void)
385 struct ec_node *node = NULL;
388 node = EC_NODE_SEQ(EC_NO_ID,
389 ec_node_str(EC_NO_ID, "foo"),
390 ec_node_str(EC_NO_ID, "bar")
393 EC_LOG(EC_LOG_ERR, "cannot create node\n");
396 testres |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
397 testres |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar", "toto");
398 testres |= EC_TEST_CHECK_PARSE(node, -1, "foo");
399 testres |= EC_TEST_CHECK_PARSE(node, -1, "foox", "bar");
400 testres |= EC_TEST_CHECK_PARSE(node, -1, "foo", "barx");
401 testres |= EC_TEST_CHECK_PARSE(node, -1, "bar", "foo");
402 testres |= EC_TEST_CHECK_PARSE(node, -1, "", "foo");
404 testres |= (ec_node_seq_add(node, ec_node_str(EC_NO_ID, "grr")) < 0);
405 testres |= EC_TEST_CHECK_PARSE(node, 3, "foo", "bar", "grr");
409 /* test completion */
410 node = EC_NODE_SEQ(EC_NO_ID,
411 ec_node_str(EC_NO_ID, "foo"),
412 ec_node_option(EC_NO_ID, ec_node_str(EC_NO_ID, "toto")),
413 ec_node_str(EC_NO_ID, "bar")
416 EC_LOG(EC_LOG_ERR, "cannot create node\n");
419 testres |= EC_TEST_CHECK_COMPLETE(node,
421 "foo", EC_NODE_ENDLIST);
422 testres |= EC_TEST_CHECK_COMPLETE(node,
423 "f", EC_NODE_ENDLIST,
424 "foo", EC_NODE_ENDLIST);
425 testres |= EC_TEST_CHECK_COMPLETE(node,
426 "foo", EC_NODE_ENDLIST,
427 "foo", EC_NODE_ENDLIST);
428 testres |= EC_TEST_CHECK_COMPLETE(node,
429 "foo", "", EC_NODE_ENDLIST,
430 "bar", "toto", EC_NODE_ENDLIST);
431 testres |= EC_TEST_CHECK_COMPLETE(node,
432 "foo", "t", EC_NODE_ENDLIST,
433 "toto", EC_NODE_ENDLIST);
434 testres |= EC_TEST_CHECK_COMPLETE(node,
435 "foo", "b", EC_NODE_ENDLIST,
436 "bar", EC_NODE_ENDLIST);
437 testres |= EC_TEST_CHECK_COMPLETE(node,
438 "foo", "bar", EC_NODE_ENDLIST,
439 "bar", EC_NODE_ENDLIST);
440 testres |= EC_TEST_CHECK_COMPLETE(node,
441 "x", EC_NODE_ENDLIST,
443 testres |= EC_TEST_CHECK_COMPLETE(node,
444 "foobarx", EC_NODE_ENDLIST,
452 static struct ec_test ec_node_seq_test = {
454 .test = ec_node_seq_testcase,
457 EC_TEST_REGISTER(ec_node_seq_test);