* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/**
+ * API for generating completions item on a node.
+ *
+ * This file provide helpers to list and manipulate the possible
+ * completions for a given input.
+ *
+ * XXX completed vs item
+ */
+
#ifndef ECOLI_COMPLETED_
#define ECOLI_COMPLETED_
struct ec_node;
-struct ec_completed_elt {
- TAILQ_ENTRY(ec_completed_elt) next;
- const struct ec_node *node;
- char *add;
+enum ec_completed_type {
+ EC_COMP_UNKNOWN,
+ EC_COMP_FULL,
+ EC_PARTIAL_MATCH,
+};
- /* reverse order: [0] = last parsed, [len-1] = root */
- const struct ec_node **path;
- size_t pathlen;
+struct ec_completed_item;
+
+TAILQ_HEAD(ec_completed_item_list, ec_completed_item);
+
+struct ec_completed_group {
+ TAILQ_ENTRY(ec_completed_group) next;
+ const struct ec_node *node;
+ struct ec_completed_item_list items;
+ struct ec_parsed *state;
};
-TAILQ_HEAD(ec_completed_elt_list, ec_completed_elt);
+TAILQ_HEAD(ec_completed_group_list, ec_completed_group);
struct ec_completed {
- struct ec_completed_elt_list elts;
unsigned count;
unsigned count_match;
- char *smallest_start;
+ struct ec_parsed *cur_state;
+ struct ec_completed_group *cur_group;
+ struct ec_completed_group_list groups;
+ struct ec_keyval *attrs; // XXX per node instead?
};
/*
- * return a completed object filled with elts
+ * return a completed object filled with items
* return NULL on error (nomem?)
*/
struct ec_completed *ec_node_complete(struct ec_node *node,
const struct ec_strvec *strvec);
/* internal: used by nodes */
-struct ec_completed *ec_node_complete_child(struct ec_node *node,
- struct ec_parsed *state,
- const struct ec_strvec *strvec);
+int ec_node_complete_child(struct ec_node *node,
+ struct ec_completed *completed,
+ const struct ec_strvec *strvec);
+/**
+ * Create a completion object (list of completion items).
+ *
+ *
+ */
struct ec_completed *ec_completed(void);
-/* XXX add completion type: full, partial, none */
-int ec_completed_add_elt(struct ec_completed *completed,
- struct ec_parsed *parsed,
- const struct ec_node *node, const char *add);
-void ec_completed_elt_free(struct ec_completed_elt *elt);
-void ec_completed_merge(struct ec_completed *completed1,
- struct ec_completed *completed2);
+/**
+ * Free a completion object and all its items.
+ *
+ *
+ */
void ec_completed_free(struct ec_completed *completed);
+
+/**
+ *
+ *
+ *
+ */
void ec_completed_dump(FILE *out,
const struct ec_completed *completed);
-struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
- struct ec_parsed *state,
- const struct ec_strvec *strvec);
-/* cannot return NULL */
-const char *ec_completed_smallest_start(
- const struct ec_completed *completed);
-enum ec_completed_filter_flags {
- EC_MATCH = 1,
- EC_NO_MATCH = 2,
-};
+struct ec_parsed *ec_completed_cur_parse_state(struct ec_completed *completed);
+
+/**
+ * Create a completion item.
+ *
+ *
+ */
+struct ec_completed_item *
+ec_completed_item(const struct ec_node *node);
+
+/**
+ * Set type and value of a completion item.
+ *
+ *
+ */
+int ec_completed_item_set(struct ec_completed_item *item,
+ enum ec_completed_type type, const char *str);
+
+/**
+ * Add a completion item to a completion list.
+ *
+ *
+ */
+int ec_completed_item_add(struct ec_completed *completed,
+ struct ec_completed_item *item);
+
+/**
+ * Get the string value of a completion item.
+ *
+ *
+ */
+const char *
+ec_completed_item_get_str(const struct ec_completed_item *item);
+
+/**
+ * Get the display string value of a completion item.
+ *
+ *
+ */
+const char *
+ec_completed_item_get_display(const struct ec_completed_item *item);
+
+/**
+ * Get the group of a completion item.
+ *
+ *
+ */
+const struct ec_completed_group *
+ec_completed_item_get_grp(const struct ec_completed_item *item);
+
+/**
+ * Get the type of a completion item.
+ *
+ *
+ */
+enum ec_completed_type
+ec_completed_item_get_type(const struct ec_completed_item *item);
+
+/**
+ * Get the node associated to a completion item.
+ *
+ *
+ */
+const struct ec_node *
+ec_completed_item_get_node(const struct ec_completed_item *item);
+
+/**
+ *
+ *
+ *
+ */
+void ec_completed_item_free(struct ec_completed_item *item);
+
+/**
+ * Set the display value of an item.
+ *
+ *
+ */
+int ec_completed_item_set_display(struct ec_completed_item *item,
+ const char *display);
+
+/**
+ *
+ *
+ *
+ */
+int
+ec_node_default_complete(const struct ec_node *gen_node,
+ struct ec_completed *completed,
+ const struct ec_strvec *strvec);
+/**
+ *
+ *
+ *
+ */
unsigned int ec_completed_count(
const struct ec_completed *completed,
- enum ec_completed_filter_flags flags);
+ enum ec_completed_type flags);
+/**
+ *
+ *
+ *
+ */
struct ec_completed_iter {
- enum ec_completed_filter_flags flags;
+ enum ec_completed_type type;
const struct ec_completed *completed;
- const struct ec_completed_elt *cur;
+ const struct ec_completed_group *cur_node;
+ const struct ec_completed_item *cur_match;
};
+/**
+ *
+ *
+ *
+ */
struct ec_completed_iter *
ec_completed_iter(struct ec_completed *completed,
- enum ec_completed_filter_flags flags);
+ enum ec_completed_type type);
-const struct ec_completed_elt *ec_completed_iter_next(
+/**
+ *
+ *
+ *
+ */
+const struct ec_completed_item *ec_completed_iter_next(
struct ec_completed_iter *iter);
+/**
+ *
+ *
+ *
+ */
void ec_completed_iter_free(struct ec_completed_iter *iter);
git.droids-corp.org / protos / libecoli.git / blobdiff