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);
67 struct ec_completed_node_list nodes;
71 * return a completed object filled with items
72 * return NULL on error (nomem?)
74 struct ec_completed *ec_node_complete(struct ec_node *node,
76 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
77 const struct ec_strvec *strvec);
79 /* internal: used by nodes */
80 int ec_node_complete_child(struct ec_node *node,
81 struct ec_completed *completed,
82 struct ec_parsed *parsed_state,
83 const struct ec_strvec *strvec);
85 struct ec_completed *ec_completed(void);
87 int ec_completed_add_match(struct ec_completed *completed,
88 struct ec_parsed *state,
89 const struct ec_node *node, const char *add);
90 int ec_completed_add_no_match(struct ec_completed *completed,
91 struct ec_parsed *parsed_state,
92 const struct ec_node *node);
93 int ec_completed_add_partial_match(struct ec_completed *completed,
94 struct ec_parsed *state, const struct ec_node *node,
97 int ec_completed_add_node(struct ec_completed *completed,
98 const struct ec_node *node);
100 void ec_completed_match_free(struct ec_completed_match *item);
101 void ec_completed_free(struct ec_completed *completed);
102 void ec_completed_dump(FILE *out,
103 const struct ec_completed *completed);
105 ec_node_default_complete(const struct ec_node *gen_node,
106 struct ec_completed *completed,
107 struct ec_parsed *state,
108 const struct ec_strvec *strvec);
110 /* return the smallest string start, or NULL on error */
111 char *ec_completed_smallest_start(const struct ec_completed *completed);
113 unsigned int ec_completed_count(
114 const struct ec_completed *completed,
115 enum ec_completed_type flags);
117 struct ec_completed_iter {
118 enum ec_completed_type type;
119 const struct ec_completed *completed;
120 const struct ec_completed_node *cur_node;
121 const struct ec_completed_match *cur_match;
124 struct ec_completed_iter *
125 ec_completed_iter(struct ec_completed *completed,
126 enum ec_completed_type type);
128 const struct ec_completed_match *ec_completed_iter_next(
129 struct ec_completed_iter *iter);
131 void ec_completed_iter_free(struct ec_completed_iter *iter);