2 * Copyright (c) 2016, 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.
29 * Interface to manage the ecoli nodes.
31 * A node is a main structure of the ecoli library, used to define how
32 * to match and complete the input tokens. A node is a generic object
34 * - a parse(node, input) method: check if an input matches
35 * - a complete(node, input) method: return possible completions for
37 * - some other methods to initialize, free, ...
39 * One basic example is the string node (ec_node_str). A node
40 * ec_node_str("foo") will match any token list starting with "foo",
43 * - ["foo", "bar", ...]
48 * A node ec_node_str("foo") will complete with "foo" if the input
49 * contains one token, with the same beginning than "foo":
54 * But it will not complete:
60 * A node can have child nodes. For instance, a sequence node
61 * ec_node_seq(ec_node_str("foo"), ec_node_str("bar")) will match
68 #include <sys/queue.h>
69 #include <sys/types.h>
72 #define EC_NO_ID "no-id"
74 #define EC_NODE_ENDLIST ((void *)1)
82 #define EC_NODE_TYPE_REGISTER(t) \
83 static void ec_node_init_##t(void); \
84 static void __attribute__((constructor, used)) \
85 ec_node_init_##t(void) \
87 if (ec_node_type_register(&t) < 0) \
88 fprintf(stderr, "cannot register %s\n", t.name); \
91 TAILQ_HEAD(ec_node_type_list, ec_node_type);
93 /* return 0 on success, else -errno. */
94 typedef int (*ec_node_build_t)(struct ec_node *node);
96 typedef int (*ec_node_parse_t)(const struct ec_node *node,
97 struct ec_parsed *state,
98 const struct ec_strvec *strvec);
99 typedef int (*ec_node_complete_t)(const struct ec_node *node,
100 struct ec_completed *completed_state,
101 const struct ec_strvec *strvec);
102 typedef size_t (*ec_node_get_max_parse_len_t)(const struct ec_node *node);
103 typedef const char * (*ec_node_desc_t)(const struct ec_node *);
104 typedef int (*ec_node_init_priv_t)(struct ec_node *);
105 typedef void (*ec_node_free_priv_t)(struct ec_node *);
108 * A structure describing a node type.
110 struct ec_node_type {
111 TAILQ_ENTRY(ec_node_type) next; /**< Next in list. */
112 const char *name; /**< Node type name. */
113 ec_node_build_t build; /**< (Re)build the node */
114 ec_node_parse_t parse;
115 ec_node_complete_t complete;
116 ec_node_get_max_parse_len_t get_max_parse_len;
119 ec_node_init_priv_t init_priv;
120 ec_node_free_priv_t free_priv;
124 * Register a node type.
127 * A pointer to a ec_test structure describing the test
130 * 0 on success, negative value on error.
132 int ec_node_type_register(struct ec_node_type *type);
135 * Lookup node type by name
138 * The name of the node type to search.
140 * The node type if found, or NULL on error.
142 struct ec_node_type *ec_node_type_lookup(const char *name);
145 * Dump registered log types
147 void ec_node_type_dump(FILE *out);
149 TAILQ_HEAD(ec_node_list, ec_node);
152 const struct ec_node_type *type;
155 struct ec_keyval *attrs;
156 /* XXX ensure parent and child are properly set in all nodes */
157 struct ec_node *parent;
160 TAILQ_ENTRY(ec_node) next;
161 struct ec_node_list children;
164 /* create a new node when the type is known, typically called from the node
166 struct ec_node *__ec_node(const struct ec_node_type *type, const char *id);
168 /* create a_new node node */
169 struct ec_node *ec_node(const char *typename, const char *id);
171 struct ec_node *ec_node_clone(struct ec_node *node);
172 void ec_node_free(struct ec_node *node);
175 * Get the max len of strvec that can be parsed by this node
177 * If there is no maximum, return SIZE_MAX.
179 size_t ec_node_get_max_parse_len(const struct ec_node *node);
181 /* XXX add more accessors */
182 struct ec_keyval *ec_node_attrs(const struct ec_node *node);
183 struct ec_node *ec_node_parent(const struct ec_node *node);
184 const char *ec_node_id(const struct ec_node *node);
185 const char *ec_node_desc(const struct ec_node *node);
187 void ec_node_dump(FILE *out, const struct ec_node *node);
188 struct ec_node *ec_node_find(struct ec_node *node, const char *id);
190 /* check the type of a node */
191 int ec_node_check_type(const struct ec_node *node,
192 const struct ec_node_type *type);