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.
28 #ifndef ECOLI_COMPLETED_
29 #define ECOLI_COMPLETED_
31 #include <sys/queue.h>
32 #include <sys/types.h>
37 enum ec_completed_type {
43 struct ec_completed_match {
44 TAILQ_ENTRY(ec_completed_match) next;
45 enum ec_completed_type type;
46 const struct ec_node *node;
49 /* reverse order: [0] = last, [len-1] = root */
50 const struct ec_node **path;
54 TAILQ_HEAD(ec_completed_match_list, ec_completed_match);
56 struct ec_completed_node {
57 TAILQ_ENTRY(ec_completed_node) next;
58 const struct ec_node *node;
59 struct ec_completed_match_list matches;
62 TAILQ_HEAD(ec_completed_node_list, ec_completed_node);
68 struct ec_completed_node_list nodes;
72 * return a completed object filled with items
73 * return NULL on error (nomem?)
75 struct ec_completed *ec_node_complete(struct ec_node *node,
77 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
78 const struct ec_strvec *strvec);
80 /* internal: used by nodes */
81 int ec_node_complete_child(struct ec_node *node,
82 struct ec_completed *completed,
83 struct ec_parsed *parsed_state,
84 const struct ec_strvec *strvec);
86 struct ec_completed *ec_completed(void);
88 int ec_completed_add_match(struct ec_completed *completed,
89 struct ec_parsed *state,
90 const struct ec_node *node, const char *add);
91 int ec_completed_add_no_match(struct ec_completed *completed,
92 struct ec_parsed *parsed_state,
93 const struct ec_node *node);
94 int ec_completed_add_partial_match(struct ec_completed *completed,
95 struct ec_parsed *state, const struct ec_node *node,
98 int ec_completed_add_node(struct ec_completed *completed,
99 const struct ec_node *node);
101 void ec_completed_match_free(struct ec_completed_match *item);
102 void ec_completed_free(struct ec_completed *completed);
103 void ec_completed_dump(FILE *out,
104 const struct ec_completed *completed);
106 ec_node_default_complete(const struct ec_node *gen_node,
107 struct ec_completed *completed,
108 struct ec_parsed *state,
109 const struct ec_strvec *strvec);
111 /* cannot return NULL */
112 const char *ec_completed_smallest_start(
113 const struct ec_completed *completed);
115 unsigned int ec_completed_count(
116 const struct ec_completed *completed,
117 enum ec_completed_type flags);
119 struct ec_completed_iter {
120 enum ec_completed_type type;
121 const struct ec_completed *completed;
122 const struct ec_completed_node *cur_node;
123 const struct ec_completed_match *cur_match;
126 struct ec_completed_iter *
127 ec_completed_iter(struct ec_completed *completed,
128 enum ec_completed_type type);
130 const struct ec_completed_match *ec_completed_iter_next(
131 struct ec_completed_iter *iter);
133 void ec_completed_iter_free(struct ec_completed_iter *iter);