lib/ecoli_completed.h

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   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.
  15  *
  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.
  26  */
  27
  28 #ifndef ECOLI_COMPLETED_
  29 #define ECOLI_COMPLETED_
  30
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <stdio.h>
  34
  35 struct ec_node;
  36
  37 enum ec_completed_type {
  38         EC_NO_MATCH,
  39         EC_MATCH,
  40         EC_PARTIAL_MATCH,
  41 };
  42
  43 struct ec_completed_item {
  44         TAILQ_ENTRY(ec_completed_item) next;
  45         enum ec_completed_type type;
  46         const struct ec_node *node;
  47         char *str;
  48         char *display;
  49         struct ec_keyval *attrs;
  50
  51         /* reverse order: [0] = last, [len-1] = root */
  52         const struct ec_node **path;
  53         size_t pathlen;
  54 };
  55
  56 TAILQ_HEAD(ec_completed_item_list, ec_completed_item);
  57
  58 struct ec_completed_node {
  59         TAILQ_ENTRY(ec_completed_node) next;
  60         const struct ec_node *node;
  61         struct ec_completed_item_list items;
  62 };
  63
  64 TAILQ_HEAD(ec_completed_node_list, ec_completed_node);
  65
  66 struct ec_completed {
  67         unsigned count;
  68         unsigned count_match;
  69         struct ec_completed_node_list nodes;
  70         struct ec_keyval *attrs; // XXX per node instead?
  71 };
  72
  73 /*
  74  * return a completed object filled with items
  75  * return NULL on error (nomem?)
  76  */
  77 struct ec_completed *ec_node_complete(struct ec_node *node,
  78         const char *str);
  79 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
  80         const struct ec_strvec *strvec);
  81
  82 /* internal: used by nodes */
  83 int ec_node_complete_child(struct ec_node *node,
  84                         struct ec_completed *completed,
  85                         struct ec_parsed *parsed_state,
  86                         const struct ec_strvec *strvec);
  87
  88 struct ec_completed *ec_completed(void);
  89
  90 struct ec_completed_item *
  91 ec_completed_item(struct ec_parsed *state, const struct ec_node *node);
  92 int ec_completed_item_set(struct ec_completed_item *item,
  93                         enum ec_completed_type type, const char *str);
  94 int ec_completed_item_add(struct ec_completed *completed,
  95                         struct ec_completed_item *item);
  96 void ec_completed_item_free(struct ec_completed_item *item);
  97
  98 int ec_completed_item_set_display(struct ec_completed_item *item,
  99                                 const char *display);
 100
 101 void ec_completed_free(struct ec_completed *completed);
 102 void ec_completed_dump(FILE *out,
 103         const struct ec_completed *completed);
 104 int
 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);
 109
 110 unsigned int ec_completed_count(
 111         const struct ec_completed *completed,
 112         enum ec_completed_type flags);
 113
 114 struct ec_completed_iter {
 115         enum ec_completed_type type;
 116         const struct ec_completed *completed;
 117         const struct ec_completed_node *cur_node;
 118         const struct ec_completed_item *cur_match;
 119 };
 120
 121 struct ec_completed_iter *
 122 ec_completed_iter(struct ec_completed *completed,
 123         enum ec_completed_type type);
 124
 125 const struct ec_completed_item *ec_completed_iter_next(
 126         struct ec_completed_iter *iter);
 127
 128 void ec_completed_iter_free(struct ec_completed_iter *iter);
 129
 130
 131 #endif