1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
8 * The parse operation is to check if an input (a string or vector of
9 * strings) matches the node tree. On success, the result is stored in a
10 * tree that describes which part of the input matches which node.
16 #include <sys/queue.h>
17 #include <sys/types.h>
26 * Create an empty parse tree.
29 * The empty parse tree.
31 struct ec_parse *ec_parse(const struct ec_node *node);
38 void ec_parse_free(struct ec_parse *parse);
45 void ec_parse_free_children(struct ec_parse *parse);
52 struct ec_parse *ec_parse_dup(const struct ec_parse *parse);
60 const struct ec_strvec *ec_parse_strvec(const struct ec_parse *parse);
62 /* a NULL return value is an error, with errno set
63 ENOTSUP: no ->parse() operation
70 struct ec_parse *ec_node_parse(const struct ec_node *node, const char *str);
77 struct ec_parse *ec_node_parse_strvec(const struct ec_node *node,
78 const struct ec_strvec *strvec);
85 #define EC_PARSE_NOMATCH INT_MAX
87 /* internal: used by nodes
89 * state is the current parse tree, which is built piece by piece while
90 * parsing the node tree: ec_node_parse_child() creates a new child in
91 * this state parse tree, and calls the parse() method for the child
92 * node, with state pointing to this new child. If it does not match,
93 * the child is removed in the state, else it is kept, with its
94 * possible descendants.
97 * the number of matched strings in strvec on success
98 * EC_PARSE_NOMATCH (positive) if it does not match
99 * -1 on error, and errno is set
101 int ec_node_parse_child(const struct ec_node *node,
102 struct ec_parse *state,
103 const struct ec_strvec *strvec);
110 void ec_parse_link_child(struct ec_parse *parse,
111 struct ec_parse *child);
117 void ec_parse_unlink_child(struct ec_parse *parse,
118 struct ec_parse *child);
121 #define ec_parse_get_root(parse) ({ \
122 const struct ec_parse *p_ = parse; /* check type */ \
123 struct ec_parse *parse_ = (struct ec_parse *)parse; \
124 typeof(parse) res_; \
126 res_ = __ec_parse_get_root(parse_); \
135 struct ec_parse *__ec_parse_get_root(struct ec_parse *parse);
142 struct ec_parse *ec_parse_get_parent(const struct ec_parse *parse);
145 * Get the first child of a tree.
148 struct ec_parse *ec_parse_get_first_child(const struct ec_parse *parse);
155 struct ec_parse *ec_parse_get_last_child(const struct ec_parse *parse);
162 struct ec_parse *ec_parse_get_next(const struct ec_parse *parse);
169 #define EC_PARSE_FOREACH_CHILD(child, parse) \
170 for (child = ec_parse_get_first_child(parse); \
172 child = ec_parse_get_next(child)) \
179 bool ec_parse_has_child(const struct ec_parse *parse);
186 const struct ec_node *ec_parse_get_node(const struct ec_parse *parse);
193 void ec_parse_del_last_child(struct ec_parse *parse);
200 struct ec_keyval *ec_parse_get_attrs(struct ec_parse *parse);
207 void ec_parse_dump(FILE *out, const struct ec_parse *parse);
214 struct ec_parse *ec_parse_find_first(struct ec_parse *parse,
218 * Iterate among parse tree
221 * for (iter = state; iter != NULL; iter = ec_parse_iter_next(iter))
223 struct ec_parse *ec_parse_iter_next(struct ec_parse *parse);
230 size_t ec_parse_len(const struct ec_parse *parse);
237 size_t ec_parse_matches(const struct ec_parse *parse);