api documentation for ec_parse
[protos/libecoli.git] / src / ecoli_node_bypass.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2019, Olivier MATZ <zer0@droids-corp.org>
3  */
4
5 #include <stdio.h>
6 #include <stdlib.h>
7 #include <string.h>
8 #include <assert.h>
9 #include <stdarg.h>
10 #include <errno.h>
11
12 #include <ecoli_malloc.h>
13 #include <ecoli_log.h>
14 #include <ecoli_strvec.h>
15 #include <ecoli_node.h>
16 #include <ecoli_parse.h>
17 #include <ecoli_complete.h>
18 #include <ecoli_node_str.h>
19 #include <ecoli_test.h>
20 #include <ecoli_config.h>
21 #include <ecoli_node_bypass.h>
22
23 EC_LOG_TYPE_REGISTER(node_bypass);
24
25 struct ec_node_bypass {
26         struct ec_node *child;
27 };
28
29 static int
30 ec_node_bypass_parse(const struct ec_node *node,
31                 struct ec_pnode *pstate,
32                 const struct ec_strvec *strvec)
33 {
34         struct ec_node_bypass *priv = ec_node_priv(node);
35
36         return ec_parse_child(priv->child, pstate, strvec);
37 }
38
39 static int
40 ec_node_bypass_complete(const struct ec_node *node,
41                         struct ec_comp *comp,
42                         const struct ec_strvec *strvec)
43 {
44         struct ec_node_bypass *priv = ec_node_priv(node);
45
46         return ec_complete_child(priv->child, comp, strvec);
47 }
48
49 static void ec_node_bypass_free_priv(struct ec_node *node)
50 {
51         struct ec_node_bypass *priv = ec_node_priv(node);
52
53         ec_node_free(priv->child);
54 }
55
56 static size_t
57 ec_node_bypass_get_children_count(const struct ec_node *node)
58 {
59         struct ec_node_bypass *priv = ec_node_priv(node);
60
61         if (priv->child)
62                 return 1;
63         return 0;
64 }
65
66 static int
67 ec_node_bypass_get_child(const struct ec_node *node, size_t i,
68         struct ec_node **child, unsigned int *refs)
69 {
70         struct ec_node_bypass *priv = ec_node_priv(node);
71
72         if (i >= 1)
73                 return -1;
74
75         *child = priv->child;
76         *refs = 2;
77         return 0;
78 }
79
80 static const struct ec_config_schema ec_node_bypass_schema[] = {
81         {
82                 .key = "child",
83                 .desc = "The child node.",
84                 .type = EC_CONFIG_TYPE_NODE,
85         },
86         {
87                 .type = EC_CONFIG_TYPE_NONE,
88         },
89 };
90
91 static int ec_node_bypass_set_config(struct ec_node *node,
92                                 const struct ec_config *config)
93 {
94         struct ec_node_bypass *priv = ec_node_priv(node);
95         const struct ec_config *child;
96
97         child = ec_config_dict_get(config, "child");
98         if (child == NULL)
99                 goto fail;
100         if (ec_config_get_type(child) != EC_CONFIG_TYPE_NODE) {
101                 errno = EINVAL;
102                 goto fail;
103         }
104
105         if (priv->child != NULL)
106                 ec_node_free(priv->child);
107         priv->child = ec_node_clone(child->node);
108
109         return 0;
110
111 fail:
112         return -1;
113 }
114
115 static struct ec_node_type ec_node_bypass_type = {
116         .name = "bypass",
117         .schema = ec_node_bypass_schema,
118         .set_config = ec_node_bypass_set_config,
119         .parse = ec_node_bypass_parse,
120         .complete = ec_node_bypass_complete,
121         .size = sizeof(struct ec_node_bypass),
122         .free_priv = ec_node_bypass_free_priv,
123         .get_children_count = ec_node_bypass_get_children_count,
124         .get_child = ec_node_bypass_get_child,
125 };
126
127 EC_NODE_TYPE_REGISTER(ec_node_bypass_type);
128
129 int
130 ec_node_bypass_set_child(struct ec_node *node, struct ec_node *child)
131 {
132         const struct ec_config *cur_config = NULL;
133         struct ec_config *config = NULL;
134         int ret;
135
136         if (ec_node_check_type(node, &ec_node_bypass_type) < 0)
137                 goto fail;
138
139         cur_config = ec_node_get_config(node);
140         if (cur_config == NULL)
141                 config = ec_config_dict();
142         else
143                 config = ec_config_dup(cur_config);
144         if (config == NULL)
145                 goto fail;
146
147         if (ec_config_dict_set(config, "child", ec_config_node(child)) < 0) {
148                 child = NULL; /* freed */
149                 goto fail;
150         }
151         child = NULL; /* freed */
152
153         ret = ec_node_set_config(node, config);
154         config = NULL; /* freed */
155         if (ret < 0)
156                 goto fail;
157
158         return 0;
159
160 fail:
161         ec_config_free(config);
162         ec_node_free(child);
163         return -1;
164 }
165
166 struct ec_node *ec_node_bypass(const char *id, struct ec_node *child)
167 {
168         struct ec_node *node = NULL;
169
170         if (child == NULL)
171                 goto fail;
172
173         node = ec_node_from_type(&ec_node_bypass_type, id);
174         if (node == NULL)
175                 goto fail;
176
177         ec_node_bypass_set_child(node, child);
178         child = NULL;
179
180         return node;
181
182 fail:
183         ec_node_free(child);
184         return NULL;
185 }
186
187 /* LCOV_EXCL_START */
188 static int ec_node_bypass_testcase(void)
189 {
190         struct ec_node *node;
191         int testres = 0;
192
193         node = ec_node_bypass(EC_NO_ID, ec_node_str(EC_NO_ID, "foo"));
194         if (node == NULL) {
195                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
196                 return -1;
197         }
198         testres |= EC_TEST_CHECK_PARSE(node, 1, "foo");
199         testres |= EC_TEST_CHECK_PARSE(node, 1, "foo", "bar");
200         testres |= EC_TEST_CHECK_PARSE(node, -1, "bar");
201         testres |= EC_TEST_CHECK_PARSE(node, -1);
202         ec_node_free(node);
203
204         /* test completion */
205         node = ec_node_bypass(EC_NO_ID, ec_node_str(EC_NO_ID, "foo"));
206         if (node == NULL) {
207                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
208                 return -1;
209         }
210         testres |= EC_TEST_CHECK_COMPLETE(node,
211                 "", EC_VA_END,
212                 "foo", EC_VA_END);
213         testres |= EC_TEST_CHECK_COMPLETE(node,
214                 "f", EC_VA_END,
215                 "foo", EC_VA_END);
216         testres |= EC_TEST_CHECK_COMPLETE(node,
217                 "b", EC_VA_END,
218                 EC_VA_END);
219         ec_node_free(node);
220
221         return testres;
222 }
223 /* LCOV_EXCL_STOP */
224
225 static struct ec_test ec_node_bypass_test = {
226         .name = "node_bypass",
227         .test = ec_node_bypass_testcase,
228 };
229
230 EC_TEST_REGISTER(ec_node_bypass_test);