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.
31 #include <sys/queue.h>
32 #include <sys/types.h>
38 TAILQ_HEAD(ec_parsed_list, ec_parsed);
41 node == NULL + empty children list means "no match"
44 TAILQ_ENTRY(ec_parsed) next;
45 struct ec_parsed_list children;
46 struct ec_parsed *parent;
47 const struct ec_node *node;
48 struct ec_strvec *strvec;
51 struct ec_parsed *ec_parsed(void);
52 void ec_parsed_free(struct ec_parsed *parsed);
53 void ec_parsed_free_children(struct ec_parsed *parsed);
55 const struct ec_strvec *ec_parsed_strvec(const struct ec_parsed *parsed);
57 /* XXX we could use a cache to store possible completions or match: the
58 * cache would be per-node, and would be reset for each call to parse()
60 /* a NULL return value is an error, with errno set
61 ENOTSUP: no ->parse() operation
63 struct ec_parsed *ec_node_parse(struct ec_node *node, const char *str);
65 struct ec_parsed *ec_node_parse_strvec(struct ec_node *node,
66 const struct ec_strvec *strvec);
68 #define EC_PARSED_NOMATCH INT_MIN
69 /* internal: used by nodes
71 * state is the current parse tree, which is built bit by bit while
72 * parsing the node tree: ec_node_parse_child() creates a new child in
73 * this state parse tree, and calls the parse() method for the child
74 * node, with state pointing to this new child. If it does not match,
75 * the child is removed in the state, else it is kept, with its
76 * possible descendants.
79 * XXX change EC_PARSED_NOMATCH to INT_MAX?
80 * EC_PARSED_NOMATCH (negative) if it does not match
81 * any other negative value (-errno) for other errors
82 * the number of matched strings in strvec
83 * XXX state is not freed on error ?
85 int ec_node_parse_child(struct ec_node *node,
86 struct ec_parsed *state,
87 const struct ec_strvec *strvec);
89 void ec_parsed_add_child(struct ec_parsed *parsed,
90 struct ec_parsed *child);
91 void ec_parsed_del_child(struct ec_parsed *parsed,
92 struct ec_parsed *child);
94 struct ec_parsed *ec_parsed_get_root(struct ec_parsed *parsed);
95 struct ec_parsed *ec_parsed_get_parent(struct ec_parsed *parsed);
96 struct ec_parsed *ec_parsed_get_last_child(struct ec_parsed *parsed);
97 void ec_parsed_del_last_child(struct ec_parsed *parsed);
98 int ec_parsed_get_path(struct ec_parsed *parsed, struct ec_node **path);
100 void ec_parsed_dump(FILE *out, const struct ec_parsed *parsed);
102 struct ec_parsed *ec_parsed_find_first(struct ec_parsed *parsed,
105 size_t ec_parsed_len(const struct ec_parsed *parsed);
106 size_t ec_parsed_matches(const struct ec_parsed *parsed);