store full token and completion in completed_item
[protos/libecoli.git] / lib / ecoli_completed.c
index 88a8413..25ae6cb 100644 (file)
@@ -32,6 +32,7 @@
 #include <errno.h>
 
 #include <ecoli_malloc.h>
+#include <ecoli_string.h>
 #include <ecoli_strvec.h>
 #include <ecoli_keyval.h>
 #include <ecoli_log.h>
 #include <ecoli_parsed.h>
 #include <ecoli_completed.h>
 
-struct ec_completed *ec_completed(void)
+struct ec_completed_item {
+       TAILQ_ENTRY(ec_completed_item) next;
+       enum ec_completed_type type;
+       const struct ec_node *node;
+       struct ec_completed_group *grp;
+       char *start;      /* the initial token */
+       char *full;       /* the full token after completion */
+       char *completion; /* chars that are added, NULL if not applicable */
+       char *display;    /* what should be displayed by help/completers */
+       struct ec_keyval *attrs;
+};
+
+struct ec_completed *ec_completed(struct ec_parsed *state)
 {
        struct ec_completed *completed = NULL;
 
        completed = ec_calloc(1, sizeof(*completed));
        if (completed == NULL)
-               return NULL;
+               goto fail;
+
+       TAILQ_INIT(&completed->groups);
 
-       TAILQ_INIT(&completed->match_items);
-       TAILQ_INIT(&completed->no_match_items);
+       completed->cur_state = state;
 
        return completed;
+
+ fail:
+       ec_free(completed);
+
+       return NULL;
 }
 
-struct ec_completed *
-ec_node_complete_child(struct ec_node *node,
-               struct ec_parsed *state,
-               const struct ec_strvec *strvec)
+struct ec_parsed *ec_completed_get_state(struct ec_completed *completed)
 {
-       struct ec_completed *completed;
-       struct ec_parsed *child;
+       return completed->cur_state;
+}
+
+int
+ec_node_complete_child(struct ec_node *node, struct ec_completed *completed,
+                       const struct ec_strvec *strvec)
+{
+       struct ec_parsed *child_state, *cur_state;
+       struct ec_completed_group *cur_group;
        int ret;
 
        /* build the node if required */
        if (node->type->build != NULL) {
                if ((node->flags & EC_NODE_F_BUILT) == 0) {
                        ret = node->type->build(node);
-                       if (ret < 0) {
-                               errno = -ret;
-                               return NULL;
-                       }
+                       if (ret < 0)
+                               return ret;
                }
        }
        node->flags |= EC_NODE_F_BUILT;
 
-       if (node->type->complete == NULL) {
-               errno = ENOTSUP;
-               return NULL;
-       }
+       if (node->type->complete == NULL)
+               return -ENOTSUP;
 
-       child = ec_parsed();
-       if (child == NULL)
-               return NULL;
+       /* save previous parse state, prepare child state */
+       cur_state = completed->cur_state;
+       child_state = ec_parsed();
+       if (child_state == NULL)
+               return -ENOMEM;
 
-       child->node = node;
-       ec_parsed_add_child(state, child);
-       completed = node->type->complete(node, child, strvec);
+       if (cur_state != NULL)
+               ec_parsed_add_child(cur_state, child_state);
+       ec_parsed_set_node(child_state, node);
+       completed->cur_state = child_state;
+       cur_group = completed->cur_group;
+       completed->cur_group = NULL;
+
+       /* fill the completed struct with items */
+       ret = node->type->complete(node, completed, strvec);
+
+       /* restore parent parse state */
+       if (cur_state != NULL) {
+               ec_parsed_del_child(cur_state, child_state);
+               assert(!ec_parsed_has_child(child_state));
+       }
+       ec_parsed_free(child_state);
+       completed->cur_state = cur_state;
+       completed->cur_group = cur_group;
+
+       if (ret < 0)
+               return ret;
 
 #if 0 // XXX dump
        printf("----------------------------------------------------------\n");
        ec_node_dump(stdout, node);
        ec_strvec_dump(stdout, strvec);
        ec_completed_dump(stdout, completed);
-       ec_parsed_dump(stdout, state);
 #endif
 
-       ec_parsed_del_child(state, child);
-       assert(TAILQ_EMPTY(&child->children));
-       ec_parsed_free(child);
-
-       return completed;
+       return 0;
 }
 
 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
        const struct ec_strvec *strvec)
 {
-       struct ec_parsed *state = ec_parsed();
-       struct ec_completed *completed;
+       struct ec_completed *completed = NULL;
+       int ret;
 
-       if (state == NULL)
-               return NULL;
+       completed = ec_completed(NULL);
+       if (completed == NULL)
+               goto fail;
 
-       completed = ec_node_complete_child(node, state, strvec);
-       ec_parsed_free(state);
+       ret = ec_node_complete_child(node, completed, strvec);
+       if (ret < 0)
+               goto fail;
 
        return completed;
+
+fail:
+       ec_completed_free(completed);
+       return NULL;
 }
 
 struct ec_completed *ec_node_complete(struct ec_node *node,
@@ -143,199 +183,347 @@ struct ec_completed *ec_node_complete(struct ec_node *node,
        return NULL;
 }
 
-/* count the number of identical chars at the beginning of 2 strings */
-static size_t strcmp_count(const char *s1, const char *s2)
+static struct ec_completed_group *
+ec_completed_group(const struct ec_node *node, struct ec_parsed *parsed)
 {
-       size_t i = 0;
+       struct ec_completed_group *grp = NULL;
+
+       grp = ec_calloc(1, sizeof(*grp));
+       if (grp == NULL)
+               return NULL;
+
+       grp->attrs = ec_keyval();
+       if (grp->attrs == NULL)
+               goto fail;
+
+       grp->state = ec_parsed_dup(parsed);
+       if (grp->state == NULL)
+               goto fail;
 
-       while (s1[i] && s2[i] && s1[i] == s2[i])
-               i++;
+       grp->node = node;
+       TAILQ_INIT(&grp->items);
 
-       return i;
+       return grp;
+
+fail:
+       if (grp != NULL) {
+               ec_parsed_free(grp->state);
+               ec_keyval_free(grp->attrs);
+       }
+       ec_free(grp);
+       return NULL;
 }
 
 static struct ec_completed_item *
-ec_completed_item(enum ec_completed_type type, struct ec_parsed *state,
-               const struct ec_node *node, const char *add)
+ec_completed_item(const struct ec_node *node, enum ec_completed_type type,
+               const char *start, const char *full)
 {
        struct ec_completed_item *item = NULL;
+       struct ec_keyval *attrs = NULL;
+       char *comp_cp = NULL, *start_cp = NULL;
+       char *full_cp = NULL, *display_cp = NULL;
 
-       item = ec_calloc(1, sizeof(*item));
-       if (item == NULL)
+       if (type == EC_COMP_UNKNOWN && full != NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+       if (type != EC_COMP_UNKNOWN && full == NULL) {
+               errno = EINVAL;
                return NULL;
+       }
 
-       /* XXX can state be NULL? */
-       if (state != NULL) {
-               struct ec_parsed *p;
-               size_t len;
+       item = ec_calloc(1, sizeof(*item));
+       if (item == NULL)
+               goto fail;
 
-               /* get path len */
-               for (p = state, len = 0; p != NULL;
-                    p = ec_parsed_get_parent(p), len++)
-                       ;
+       attrs = ec_keyval();
+       if (attrs == NULL)
+               goto fail;
 
-               item->path = ec_calloc(len, sizeof(*item->path));
-               if (item->path == NULL)
+       if (start != NULL) {
+               start_cp = ec_strdup(start);
+               if (start_cp == NULL)
                        goto fail;
 
-               item->pathlen = len;
-
-               /* write path in array */
-               for (p = state, len = 0; p != NULL;
-                    p = ec_parsed_get_parent(p), len++)
-                       item->path[len] = p->node;
+               if (ec_str_startswith(full, start)) {
+                       comp_cp = ec_strdup(&full[strlen(start)]);
+                       if (comp_cp == NULL)
+                               goto fail;
+               }
        }
-
-       item->type = type;
-       item->node = node;
-       if (add != NULL) {
-               item->add = ec_strdup(add);
-               if (item->add == NULL)
+       if (full != NULL) {
+               full_cp = ec_strdup(full);
+               if (full_cp == NULL)
+                       goto fail;
+               display_cp = ec_strdup(full);
+               if (display_cp == NULL)
                        goto fail;
        }
 
+       item->node = node;
+       item->type = type;
+       item->start = start_cp;
+       item->full = full_cp;
+       item->completion = comp_cp;
+       item->display = display_cp;
+       item->attrs = attrs;
+
        return item;
 
 fail:
-       if (item != NULL) {
-               ec_free(item->path);
-               ec_free(item->add);
-       }
-       ec_completed_item_free(item);
+       ec_keyval_free(item->attrs);
+       ec_free(comp_cp);
+       ec_free(start_cp);
+       ec_free(full_cp);
+       ec_free(display_cp);
+       ec_free(item);
 
        return NULL;
 }
 
-static int ec_completed_add_item(struct ec_completed *completed,
-                               struct ec_completed_item *item)
+int ec_completed_item_set_display(struct ec_completed_item *item,
+                               const char *display)
 {
-       size_t n;
-
-       if (item->add != NULL) {
-               if (completed->smallest_start == NULL) {
-                       completed->smallest_start = ec_strdup(item->add);
-                       if (completed->smallest_start == NULL)
-                               return -ENOMEM;
-               } else {
-                       n = strcmp_count(item->add,
-                               completed->smallest_start);
-                       completed->smallest_start[n] = '\0';
-               }
-               completed->count_match++;
-       }
+       char *display_copy = NULL;
+       int ret = 0;
 
-       TAILQ_INSERT_TAIL(&completed->match_items, item, next);
-       completed->count++;
+       if (item == NULL || display == NULL ||
+                       item->type == EC_COMP_UNKNOWN)
+               return -EINVAL;
+
+       display_copy = ec_strdup(display);
+       if (display_copy == NULL)
+               goto fail;
+
+       ec_free(item->display);
+       item->display = display_copy;
 
        return 0;
+
+fail:
+       ec_free(display_copy);
+       return ret;
 }
 
-int ec_completed_add_match(struct ec_completed *completed,
-                       struct ec_parsed *state,
-                       const struct ec_node *node, const char *add)
+int
+ec_completed_item_set_completion(struct ec_completed_item *item,
+                               const char *completion)
 {
-       struct ec_completed_item *item;
-       int ret;
+       char *completion_copy = NULL;
+       int ret = 0;
 
-       item = ec_completed_item(EC_MATCH, state, node, add);
-       if (item == NULL)
-               return -ENOMEM;
+       if (item == NULL || completion == NULL ||
+                       item->type == EC_COMP_UNKNOWN)
+               return -EINVAL;
 
-       ret = ec_completed_add_item(completed, item);
-       if (ret < 0) {
-               ec_completed_item_free(item);
-               return ret;
-       }
+       ret = -ENOMEM;
+       completion_copy = ec_strdup(completion);
+       if (completion_copy == NULL)
+               goto fail;
+
+       ec_free(item->completion);
+       item->completion = completion_copy;
 
        return 0;
+
+fail:
+       ec_free(completion_copy);
+       return ret;
 }
 
-int ec_completed_add_no_match(struct ec_completed *completed,
-                       struct ec_parsed *state, const struct ec_node *node)
+int
+ec_completed_item_set_str(struct ec_completed_item *item,
+                       const char *str)
 {
-       struct ec_completed_item *item;
-       int ret;
+       char *str_copy = NULL;
+       int ret = 0;
 
-       item = ec_completed_item(EC_NO_MATCH, state, node, NULL);
-       if (item == NULL)
-               return -ENOMEM;
+       if (item == NULL || str == NULL ||
+                       item->type == EC_COMP_UNKNOWN)
+               return -EINVAL;
 
-       ret = ec_completed_add_item(completed, item);
-       if (ret < 0) {
-               ec_completed_item_free(item);
-               return ret;
+       ret = -ENOMEM;
+       str_copy = ec_strdup(str);
+       if (str_copy == NULL)
+               goto fail;
+
+       ec_free(item->full);
+       item->full = str_copy;
+
+       return 0;
+
+fail:
+       ec_free(str_copy);
+       return ret;
+}
+
+static int
+ec_completed_item_add(struct ec_completed *completed,
+               struct ec_completed_item *item)
+{
+       if (completed == NULL || item == NULL || item->node == NULL)
+               return -EINVAL;
+
+       switch (item->type) {
+       case EC_COMP_UNKNOWN:
+               break;
+       case EC_COMP_FULL:
+       case EC_COMP_PARTIAL:
+               completed->count_match++; //XXX
+               break;
+       default:
+               return -EINVAL;
+       }
+
+       if (completed->cur_group == NULL) {
+               struct ec_completed_group *grp;
+
+               grp = ec_completed_group(item->node, completed->cur_state);
+               if (grp == NULL)
+                       return -ENOMEM;
+               TAILQ_INSERT_TAIL(&completed->groups, grp, next);
+               completed->cur_group = grp;
        }
 
+       completed->count++;
+       TAILQ_INSERT_TAIL(&completed->cur_group->items, item, next);
+       item->grp = completed->cur_group;
+
        return 0;
 }
 
-void ec_completed_item_free(struct ec_completed_item *item)
+const char *
+ec_completed_item_get_str(const struct ec_completed_item *item)
+{
+       return item->full;
+}
+
+const char *
+ec_completed_item_get_display(const struct ec_completed_item *item)
 {
-       ec_free(item->add);
-       ec_free(item->path);
+       return item->display;
+}
+
+const char *
+ec_completed_item_get_completion(const struct ec_completed_item *item)
+{
+       return item->completion;
+}
+
+enum ec_completed_type
+ec_completed_item_get_type(const struct ec_completed_item *item)
+{
+       return item->type;
+}
+
+const struct ec_node *
+ec_completed_item_get_node(const struct ec_completed_item *item)
+{
+       return item->node;
+}
+
+const struct ec_completed_group *
+ec_completed_item_get_grp(const struct ec_completed_item *item)
+{
+       return item->grp;
+}
+
+static void
+ec_completed_item_free(struct ec_completed_item *item)
+{
+       if (item == NULL)
+               return;
+
+       ec_free(item->full);
+       ec_free(item->start);
+       ec_free(item->completion);
+       ec_free(item->display);
+       ec_keyval_free(item->attrs);
        ec_free(item);
 }
 
-/* default completion function: return a no-match element */
-struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
-                                       struct ec_parsed *state,
-                                       const struct ec_strvec *strvec)
+int ec_completed_add_item(struct ec_completed *completed,
+                       const struct ec_node *node,
+                       struct ec_completed_item **p_item,
+                       enum ec_completed_type type,
+                       const char *start, const char *full)
 {
-       struct ec_completed *completed;
+       struct ec_completed_item *item = NULL;
+       int ret;
 
-       (void)strvec;
-       (void)state;
+       item = ec_completed_item(node, type, start, full);
+       if (item == NULL)
+               return -1;
 
-       completed = ec_completed();
-       if (completed == NULL)
-               return NULL;
+       ret = ec_completed_item_add(completed, item);
+       if (ret < 0)
+               goto fail;
+
+       if (p_item != NULL)
+               *p_item = item;
+
+       return 0;
+
+fail:
+       ec_completed_item_free(item);
+
+       return -1;
+}
+
+/* default completion function: return a no-match element */
+int
+ec_node_default_complete(const struct ec_node *gen_node, // XXX rename in nomatch
+                       struct ec_completed *completed,
+                       const struct ec_strvec *strvec)
+{
+       int ret;
 
        if (ec_strvec_len(strvec) != 1)
-               return completed;
+               return 0;
 
-       if (ec_completed_add_no_match(completed, state, gen_node) < 0) {
-               ec_completed_free(completed);
-               return NULL;
-       }
+       ret = ec_completed_add_item(completed, gen_node, NULL,
+                               EC_COMP_UNKNOWN, NULL, NULL);
+       if (ret < 0)
+               return ret;
 
-       return completed;
+       return 0;
 }
 
-void ec_completed_merge(struct ec_completed *completed1,
-       struct ec_completed *completed2)
+static void ec_completed_group_free(struct ec_completed_group *grp)
 {
        struct ec_completed_item *item;
 
-       assert(completed1 != NULL);
-       assert(completed2 != NULL);
+       if (grp == NULL)
+               return;
 
-       while (!TAILQ_EMPTY(&completed2->match_items)) {
-               item = TAILQ_FIRST(&completed2->match_items);
-               TAILQ_REMOVE(&completed2->match_items, item, next);
-               ec_completed_add_item(completed1, item);
+       while (!TAILQ_EMPTY(&grp->items)) {
+               item = TAILQ_FIRST(&grp->items);
+               TAILQ_REMOVE(&grp->items, item, next);
+               ec_completed_item_free(item);
        }
-
-       ec_completed_free(completed2);
+       ec_parsed_free(ec_parsed_get_root(grp->state));
+       ec_keyval_free(grp->attrs);
+       ec_free(grp);
 }
 
 void ec_completed_free(struct ec_completed *completed)
 {
-       struct ec_completed_item *item;
+       struct ec_completed_group *grp;
 
        if (completed == NULL)
                return;
 
-       while (!TAILQ_EMPTY(&completed->match_items)) {
-               item = TAILQ_FIRST(&completed->match_items);
-               TAILQ_REMOVE(&completed->match_items, item, next);
-               ec_completed_item_free(item);
+       while (!TAILQ_EMPTY(&completed->groups)) {
+               grp = TAILQ_FIRST(&completed->groups);
+               TAILQ_REMOVE(&completed->groups, grp, next);
+               ec_completed_group_free(grp);
        }
-       ec_free(completed->smallest_start);
        ec_free(completed);
 }
 
 void ec_completed_dump(FILE *out, const struct ec_completed *completed)
 {
+       struct ec_completed_group *grp;
        struct ec_completed_item *item;
 
        if (completed == NULL || completed->count == 0) {
@@ -343,23 +531,44 @@ void ec_completed_dump(FILE *out, const struct ec_completed *completed)
                return;
        }
 
-       fprintf(out, "completion: count=%u match=%u smallest_start=<%s>\n",
-               completed->count, completed->count_match,
-               completed->smallest_start);
+       fprintf(out, "completion: count=%u match=%u\n",
+               completed->count, completed->count_match);
 
-       TAILQ_FOREACH(item, &completed->match_items, next) {
-               fprintf(out, "add=<%s>, node=%p, node_type=%s\n",
-                       item->add, item->node, item->node->type->name);
+       TAILQ_FOREACH(grp, &completed->groups, next) {
+               fprintf(out, "node=%p, node_type=%s\n",
+                       grp->node, grp->node->type->name);
+               TAILQ_FOREACH(item, &grp->items, next) {
+                       const char *typestr;
+
+                       switch (item->type) {
+                       case EC_COMP_UNKNOWN: typestr = "unknown"; break;
+                       case EC_COMP_FULL: typestr = "full"; break;
+                       case EC_COMP_PARTIAL: typestr = "partial"; break;
+                       default: typestr = "unknown"; break;
+                       }
+
+                       fprintf(out, "  type=%s str=<%s> comp=<%s> disp=<%s>\n",
+                               typestr, item->full, item->completion,
+                               item->display);
+               }
        }
 }
 
-const char *ec_completed_smallest_start(
-       const struct ec_completed *completed)
+int ec_completed_merge(struct ec_completed *to,
+               struct ec_completed *from)
 {
-       if (completed == NULL || completed->smallest_start == NULL)
-               return "";
+       struct ec_completed_group *grp;
 
-       return completed->smallest_start;
+       while (!TAILQ_EMPTY(&from->groups)) {
+               grp = TAILQ_FIRST(&from->groups);
+               TAILQ_REMOVE(&from->groups, grp, next);
+               TAILQ_INSERT_TAIL(&to->groups, grp, next);
+       }
+       to->count += from->count;
+       to->count_match += from->count_match;
+
+       ec_completed_free(from);
+       return 0;
 }
 
 unsigned int ec_completed_count(
@@ -371,9 +580,9 @@ unsigned int ec_completed_count(
        if (completed == NULL)
                return count;
 
-       if (type & EC_MATCH)
+       if (type & EC_COMP_FULL)
                count += completed->count_match;
-       if (type & EC_NO_MATCH)
+       if (type & EC_COMP_UNKNOWN)
                count += (completed->count - completed->count_match); //XXX
 
        return count;
@@ -391,39 +600,56 @@ ec_completed_iter(struct ec_completed *completed,
 
        iter->completed = completed;
        iter->type = type;
-       iter->cur_item = NULL;
+       iter->cur_node = NULL;
+       iter->cur_match = NULL;
 
        return iter;
 }
 
-const struct ec_completed_item *ec_completed_iter_next(
+struct ec_completed_item *ec_completed_iter_next(
        struct ec_completed_iter *iter)
 {
-       const struct ec_completed *completed = iter->completed;
+       struct ec_completed *completed = iter->completed;
+       struct ec_completed_group *cur_node;
+       struct ec_completed_item *cur_match;
 
        if (completed == NULL)
                return NULL;
 
-       do {
-               if (iter->cur_item == NULL)
-                       iter->cur_item = TAILQ_FIRST(&completed->match_items);
-               else
-                       iter->cur_item = TAILQ_NEXT(iter->cur_item, next);
-
-               if (iter->cur_item == NULL)
-                       break;
+       cur_node = iter->cur_node;
+       cur_match = iter->cur_match;
 
-               if (iter->cur_item->add == NULL &&
-                               (iter->type & EC_NO_MATCH))
-                       break;
-
-               if (iter->cur_item->add != NULL &&
-                               (iter->type & EC_MATCH))
-                       break;
+       /* first call */
+       if (cur_node == NULL) {
+               TAILQ_FOREACH(cur_node, &completed->groups, next) {
+                       TAILQ_FOREACH(cur_match, &cur_node->items, next) {
+                               if (cur_match != NULL &&
+                                               cur_match->type & iter->type)
+                                       goto found;
+                       }
+               }
+               return NULL;
+       } else {
+               cur_match = TAILQ_NEXT(cur_match, next);
+               if (cur_match != NULL &&
+                               cur_match->type & iter->type)
+                       goto found;
+               cur_node = TAILQ_NEXT(cur_node, next);
+               while (cur_node != NULL) {
+                       cur_match = TAILQ_FIRST(&cur_node->items);
+                       if (cur_match != NULL &&
+                                       cur_match->type & iter->type)
+                               goto found;
+                       cur_node = TAILQ_NEXT(cur_node, next);
+               }
+               return NULL;
+       }
 
-       } while (iter->cur_item != NULL);
+found:
+       iter->cur_node = cur_node;
+       iter->cur_match = cur_match;
 
-       return iter->cur_item;
+       return iter->cur_match;
 }
 
 void ec_completed_iter_free(struct ec_completed_iter *iter)