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 struct ec_completed_elt {
38 TAILQ_ENTRY(ec_completed_elt) next;
39 const struct ec_node *node;
42 /* reverse order: [0] = last parsed, [len-1] = root */
43 const struct ec_node **path;
47 TAILQ_HEAD(ec_completed_elt_list, ec_completed_elt);
50 struct ec_completed_elt_list elts;
57 * return a completed object filled with elts
58 * return NULL on error (nomem?)
60 struct ec_completed *ec_node_complete(struct ec_node *node,
62 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
63 const struct ec_strvec *strvec);
65 /* internal: used by nodes */
66 struct ec_completed *ec_node_complete_child(struct ec_node *node,
67 struct ec_parsed *state,
68 const struct ec_strvec *strvec);
70 struct ec_completed *ec_completed(void);
72 /* XXX add completion type: full, partial, none */
73 int ec_completed_add_elt(struct ec_completed *completed,
74 struct ec_parsed *parsed,
75 const struct ec_node *node, const char *add);
76 void ec_completed_elt_free(struct ec_completed_elt *elt);
77 void ec_completed_merge(struct ec_completed *completed1,
78 struct ec_completed *completed2);
79 void ec_completed_free(struct ec_completed *completed);
80 void ec_completed_dump(FILE *out,
81 const struct ec_completed *completed);
82 struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
83 struct ec_parsed *state,
84 const struct ec_strvec *strvec);
86 /* cannot return NULL */
87 const char *ec_completed_smallest_start(
88 const struct ec_completed *completed);
90 enum ec_completed_filter_flags {
95 unsigned int ec_completed_count(
96 const struct ec_completed *completed,
97 enum ec_completed_filter_flags flags);
99 struct ec_completed_iter {
100 enum ec_completed_filter_flags flags;
101 const struct ec_completed *completed;
102 const struct ec_completed_elt *cur;
105 struct ec_completed_iter *
106 ec_completed_iter(struct ec_completed *completed,
107 enum ec_completed_filter_flags flags);
109 const struct ec_completed_elt *ec_completed_iter_next(
110 struct ec_completed_iter *iter);
112 void ec_completed_iter_free(struct ec_completed_iter *iter);