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.
37 #include <ecoli_malloc.h>
38 #include <ecoli_log.h>
39 #include <ecoli_test.h>
40 #include <ecoli_strvec.h>
41 #include <ecoli_node.h>
42 #include <ecoli_parsed.h>
43 #include <ecoli_completed.h>
44 #include <ecoli_node_seq.h>
45 #include <ecoli_node_many.h>
46 #include <ecoli_node_or.h>
47 #include <ecoli_node_weakref.h>
48 #include <ecoli_node_expr.h>
50 EC_LOG_TYPE_REGISTER(node_expr);
56 struct ec_node *child;
58 /* the configuration nodes */
59 struct ec_node *val_node;
60 struct ec_node **bin_ops;
61 unsigned int bin_ops_len;
62 struct ec_node **pre_ops;
63 unsigned int pre_ops_len;
64 struct ec_node **post_ops;
65 unsigned int post_ops_len;
66 struct ec_node **open_ops;
67 struct ec_node **close_ops;
68 unsigned int paren_len;
71 static int ec_node_expr_parse(const struct ec_node *gen_node,
72 struct ec_parsed *state,
73 const struct ec_strvec *strvec)
75 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
77 if (node->child == NULL)
79 return ec_node_parse_child(node->child, state, strvec);
83 ec_node_expr_complete(const struct ec_node *gen_node,
84 struct ec_completed *completed,
85 const struct ec_strvec *strvec)
87 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
89 if (node->child == NULL)
91 return ec_node_complete_child(node->child, completed, strvec);
94 static void ec_node_expr_free_priv(struct ec_node *gen_node)
96 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
99 EC_LOG(EC_LOG_DEBUG, "free %p %p %p\n", node, node->child, node->val_node);
100 ec_node_free(node->val_node);
102 for (i = 0; i < node->bin_ops_len; i++)
103 ec_node_free(node->bin_ops[i]);
104 ec_free(node->bin_ops);
105 for (i = 0; i < node->pre_ops_len; i++)
106 ec_node_free(node->pre_ops[i]);
107 ec_free(node->pre_ops);
108 for (i = 0; i < node->post_ops_len; i++)
109 ec_node_free(node->post_ops[i]);
110 ec_free(node->post_ops);
111 for (i = 0; i < node->paren_len; i++) {
112 ec_node_free(node->open_ops[i]);
113 ec_node_free(node->close_ops[i]);
115 ec_free(node->open_ops);
116 ec_free(node->close_ops);
118 ec_node_free(node->child);
121 static int ec_node_expr_build(struct ec_node_expr *node)
123 struct ec_node *term = NULL, *expr = NULL, *next = NULL,
124 *pre_op = NULL, *post_op = NULL,
125 *post = NULL, *weak = NULL;
129 ec_node_free(node->child);
132 if (node->val_node == NULL)
134 if (node->bin_ops_len == 0 && node->pre_ops_len == 0 &&
135 node->post_ops_len == 0)
139 * Example of created grammar:
146 * term = post post_op*
147 * prod = term ( "*" term )*
148 * sum = prod ( "+" prod )*
152 /* create the object, we will initialize it later: this is
153 * needed because we have a circular dependency */
155 weak = ec_node("weakref", "weak");
159 /* prefix unary operators */
160 pre_op = ec_node("or", "pre-op");
163 for (i = 0; i < node->pre_ops_len; i++) {
164 if (ec_node_or_add(pre_op, ec_node_clone(node->pre_ops[i])) < 0)
168 /* suffix unary operators */
169 post_op = ec_node("or", "post-op");
172 for (i = 0; i < node->post_ops_len; i++) {
173 if (ec_node_or_add(post_op, ec_node_clone(node->post_ops[i])) < 0)
177 post = ec_node("or", "post");
180 if (ec_node_or_add(post, ec_node_clone(node->val_node)) < 0)
182 if (ec_node_or_add(post,
183 EC_NODE_SEQ(EC_NO_ID,
184 ec_node_clone(pre_op),
185 ec_node_clone(weak))) < 0)
187 for (i = 0; i < node->paren_len; i++) {
188 if (ec_node_or_add(post, EC_NODE_SEQ(EC_NO_ID,
189 ec_node_clone(node->open_ops[i]),
191 ec_node_clone(node->close_ops[i]))) < 0)
194 term = EC_NODE_SEQ("term",
196 ec_node_many(EC_NO_ID, ec_node_clone(post_op), 0, 0)
201 for (i = 0; i < node->bin_ops_len; i++) {
202 next = EC_NODE_SEQ("next",
204 ec_node_many(EC_NO_ID,
205 EC_NODE_SEQ(EC_NO_ID,
206 ec_node_clone(node->bin_ops[i]),
220 /* free the initial references */
221 ec_node_free(pre_op);
223 ec_node_free(post_op);
228 /* no need to clone here, the node is not consumed */
229 if (ec_node_weakref_set(weak, expr) < 0)
241 ec_node_free(pre_op);
242 ec_node_free(post_op);
249 static struct ec_node_type ec_node_expr_type = {
251 .parse = ec_node_expr_parse,
252 .complete = ec_node_expr_complete,
253 .size = sizeof(struct ec_node_expr),
254 .free_priv = ec_node_expr_free_priv,
257 EC_NODE_TYPE_REGISTER(ec_node_expr_type);
259 int ec_node_expr_set_val_node(struct ec_node *gen_node, struct ec_node *val_node)
261 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
264 ret = ec_node_check_type(gen_node, &ec_node_expr_type);
269 if (val_node == NULL)
272 ec_node_free(node->val_node);
273 node->val_node = val_node;
274 ec_node_expr_build(node);
279 ec_node_free(val_node);
283 /* add a binary operator */
284 int ec_node_expr_add_bin_op(struct ec_node *gen_node, struct ec_node *op)
286 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
287 struct ec_node **bin_ops;
290 ret = ec_node_check_type(gen_node, &ec_node_expr_type);
295 if (node == NULL || op == NULL)
299 bin_ops = ec_realloc(node->bin_ops,
300 (node->bin_ops_len + 1) * sizeof(*node->bin_ops));
304 node->bin_ops = bin_ops;
305 bin_ops[node->bin_ops_len] = op;
307 ec_node_expr_build(node);
316 /* add a unary pre-operator */
317 int ec_node_expr_add_pre_op(struct ec_node *gen_node, struct ec_node *op)
319 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
320 struct ec_node **pre_ops;
323 ret = ec_node_check_type(gen_node, &ec_node_expr_type);
328 if (node == NULL || op == NULL)
332 pre_ops = ec_realloc(node->pre_ops,
333 (node->pre_ops_len + 1) * sizeof(*node->pre_ops));
337 node->pre_ops = pre_ops;
338 pre_ops[node->pre_ops_len] = op;
340 ec_node_expr_build(node);
349 /* add a unary post-operator */
350 int ec_node_expr_add_post_op(struct ec_node *gen_node, struct ec_node *op)
352 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
353 struct ec_node **post_ops;
356 ret = ec_node_check_type(gen_node, &ec_node_expr_type);
361 if (node == NULL || op == NULL)
365 post_ops = ec_realloc(node->post_ops,
366 (node->post_ops_len + 1) * sizeof(*node->post_ops));
367 if (post_ops == NULL)
370 node->post_ops = post_ops;
371 post_ops[node->post_ops_len] = op;
372 node->post_ops_len++;
373 ec_node_expr_build(node);
382 /* add parenthesis symbols */
383 int ec_node_expr_add_parenthesis(struct ec_node *gen_node,
384 struct ec_node *open, struct ec_node *close)
386 struct ec_node_expr *node = (struct ec_node_expr *)gen_node;
387 struct ec_node **open_ops, **close_ops;
390 ret = ec_node_check_type(gen_node, &ec_node_expr_type);
395 if (node == NULL || open == NULL || close == NULL)
399 open_ops = ec_realloc(node->open_ops,
400 (node->paren_len + 1) * sizeof(*node->open_ops));
401 if (open_ops == NULL)
403 close_ops = ec_realloc(node->close_ops,
404 (node->paren_len + 1) * sizeof(*node->close_ops));
405 if (close_ops == NULL)
408 node->open_ops = open_ops;
409 node->close_ops = close_ops;
410 open_ops[node->paren_len] = open;
411 close_ops[node->paren_len] = close;
413 ec_node_expr_build(node);
423 enum expr_node_type {
433 static enum expr_node_type get_node_type(const struct ec_node *expr_gen_node,
434 const struct ec_node *check)
436 struct ec_node_expr *expr_node = (struct ec_node_expr *)expr_gen_node;
439 if (check == expr_node->val_node)
442 for (i = 0; i < expr_node->bin_ops_len; i++) {
443 if (check == expr_node->bin_ops[i])
446 for (i = 0; i < expr_node->pre_ops_len; i++) {
447 if (check == expr_node->pre_ops[i])
450 for (i = 0; i < expr_node->post_ops_len; i++) {
451 if (check == expr_node->post_ops[i])
455 for (i = 0; i < expr_node->paren_len; i++) {
456 if (check == expr_node->open_ops[i])
459 for (i = 0; i < expr_node->paren_len; i++) {
460 if (check == expr_node->close_ops[i])
470 const struct ec_parsed *op;
471 enum expr_node_type op_type;
474 /* merge x and y results in x */
475 static int merge_results(void *userctx,
476 const struct ec_node_expr_eval_ops *ops,
477 struct result *x, const struct result *y)
481 if (y->has_val == 0 && y->op == NULL)
483 if (x->has_val == 0 && x->op == NULL) {
488 if (x->has_val && y->has_val && y->op != NULL) {
489 if (y->op_type == BIN_OP) {
490 ret = ops->eval_bin_op(&x->val, userctx, x->val,
499 if (x->has_val == 0 && x->op != NULL && y->has_val && y->op == NULL) {
500 if (x->op_type == PRE_OP) {
501 ret = ops->eval_pre_op(&x->val, userctx, y->val, x->op);
508 } else if (x->op_type == BIN_OP) {
515 if (x->has_val && x->op == NULL && y->has_val == 0 && y->op != NULL) {
516 ret = ops->eval_post_op(&x->val, userctx, x->val, y->op);
523 assert(false); /* we should not get here */
527 static int eval_expression(struct result *result,
529 const struct ec_node_expr_eval_ops *ops,
530 const struct ec_node *expr_gen_node,
531 const struct ec_parsed *parsed)
534 struct ec_parsed *open = NULL, *close = NULL;
535 struct result child_result;
536 struct ec_parsed *child;
537 enum expr_node_type type;
540 memset(result, 0, sizeof(*result));
541 memset(&child_result, 0, sizeof(child_result));
543 type = get_node_type(expr_gen_node, ec_parsed_get_node(parsed));
545 ret = ops->eval_var(&result->val, userctx, parsed);
549 } else if (type == PRE_OP || type == POST_OP || type == BIN_OP) {
551 result->op_type = type;
554 EC_PARSED_FOREACH_CHILD(child, parsed) {
556 type = get_node_type(expr_gen_node, ec_parsed_get_node(child));
557 if (type == PAREN_OPEN) {
560 } else if (type == PAREN_CLOSE) {
565 ret = eval_expression(&child_result, userctx, ops,
566 expr_gen_node, child);
570 ret = merge_results(userctx, ops, result, &child_result);
574 memset(&child_result, 0, sizeof(child_result));
577 if (open != NULL && close != NULL) {
578 ret = ops->eval_parenthesis(&result->val, userctx, open, close,
588 ops->eval_free(result->val, userctx);
589 if (child_result.has_val)
590 ops->eval_free(child_result.val, userctx);
591 memset(result, 0, sizeof(*result));
596 int ec_node_expr_eval(void **user_result, const struct ec_node *node,
597 struct ec_parsed *parsed, const struct ec_node_expr_eval_ops *ops,
600 struct result result;
603 if (ops == NULL || ops->eval_var == NULL || ops->eval_pre_op == NULL ||
604 ops->eval_post_op == NULL || ops->eval_bin_op == NULL ||
605 ops->eval_parenthesis == NULL || ops->eval_free == NULL)
608 ret = ec_node_check_type(node, &ec_node_expr_type);
612 if (!ec_parsed_matches(parsed))
615 ret = eval_expression(&result, userctx, ops, node, parsed);
619 assert(result.has_val);
620 assert(result.op == NULL);
621 *user_result = result.val;
626 /* the test case is in a separate file ecoli_node_expr_test.c */