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 /**
  29  * API for generating completions item on a node.
  30  *
  31  * This file provide helpers to list and manipulate the possible
  32  * completions for a given input.
  33  *
  34  * XXX completed vs item
  35  */
  36
  37 #ifndef ECOLI_COMPLETED_
  38 #define ECOLI_COMPLETED_
  39
  40 #include <sys/queue.h>
  41 #include <sys/types.h>
  42 #include <stdio.h>
  43
  44 struct ec_node;
  45
  46 enum ec_completed_type {
  47         EC_NO_MATCH,
  48         EC_MATCH,
  49         EC_PARTIAL_MATCH,
  50 };
  51
  52 struct ec_completed_item;
  53
  54 TAILQ_HEAD(ec_completed_item_list, ec_completed_item);
  55
  56 struct ec_completed_node {
  57         TAILQ_ENTRY(ec_completed_node) next;
  58         const struct ec_node *node;
  59         struct ec_completed_item_list items;
  60 };
  61
  62 TAILQ_HEAD(ec_completed_node_list, ec_completed_node);
  63
  64 struct ec_completed {
  65         unsigned count;
  66         unsigned count_match;
  67         struct ec_completed_node_list nodes;
  68         struct ec_keyval *attrs; // XXX per node instead?
  69 };
  70
  71 /*
  72  * return a completed object filled with items
  73  * return NULL on error (nomem?)
  74  */
  75 struct ec_completed *ec_node_complete(struct ec_node *node,
  76         const char *str);
  77 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
  78         const struct ec_strvec *strvec);
  79
  80 /* internal: used by nodes */
  81 int ec_node_complete_child(struct ec_node *node,
  82                         struct ec_completed *completed,
  83                         struct ec_parsed *parsed_state,
  84                         const struct ec_strvec *strvec);
  85
  86 /**
  87  * Create a completion object (list of completion items).
  88  *
  89  *
  90  */
  91 struct ec_completed *ec_completed(void);
  92
  93 /**
  94  * Free a completion object and all its items.
  95  *
  96  *
  97  */
  98 void ec_completed_free(struct ec_completed *completed);
  99
 100 /**
 101  *
 102  *
 103  *
 104  */
 105 void ec_completed_dump(FILE *out,
 106         const struct ec_completed *completed);
 107
 108
 109 /**
 110  * Create a completion item.
 111  *
 112  *
 113  */
 114 struct ec_completed_item *
 115 ec_completed_item(struct ec_parsed *state, const struct ec_node *node);
 116
 117 /**
 118  * Set type and value of a completion item.
 119  *
 120  *
 121  */
 122 int ec_completed_item_set(struct ec_completed_item *item,
 123                         enum ec_completed_type type, const char *str);
 124
 125 /**
 126  * Add a completion item to a completion list.
 127  *
 128  *
 129  */
 130 int ec_completed_item_add(struct ec_completed *completed,
 131                         struct ec_completed_item *item);
 132
 133 /**
 134  * Get the string value of a completion item.
 135  *
 136  *
 137  */
 138 const char *
 139 ec_completed_item_get_str(const struct ec_completed_item *item);
 140
 141 /**
 142  * Get the display string value of a completion item.
 143  *
 144  *
 145  */
 146 const char *
 147 ec_completed_item_get_display(const struct ec_completed_item *item);
 148
 149 /**
 150  * Get the type of a completion item.
 151  *
 152  *
 153  */
 154 enum ec_completed_type
 155 ec_completed_item_get_type(const struct ec_completed_item *item);
 156
 157 /**
 158  *
 159  *
 160  *
 161  */
 162 void ec_completed_item_free(struct ec_completed_item *item);
 163
 164 /**
 165  * Set the display value of an item.
 166  *
 167  *
 168  */
 169 int ec_completed_item_set_display(struct ec_completed_item *item,
 170                                 const char *display);
 171
 172 /**
 173  *
 174  *
 175  *
 176  */
 177 int
 178 ec_node_default_complete(const struct ec_node *gen_node,
 179                         struct ec_completed *completed,
 180                         struct ec_parsed *state,
 181                         const struct ec_strvec *strvec);
 182
 183 /**
 184  *
 185  *
 186  *
 187  */
 188 unsigned int ec_completed_count(
 189         const struct ec_completed *completed,
 190         enum ec_completed_type flags);
 191
 192 /**
 193  *
 194  *
 195  *
 196  */
 197 struct ec_completed_iter {
 198         enum ec_completed_type type;
 199         const struct ec_completed *completed;
 200         const struct ec_completed_node *cur_node;
 201         const struct ec_completed_item *cur_match;
 202 };
 203
 204 /**
 205  *
 206  *
 207  *
 208  */
 209 struct ec_completed_iter *
 210 ec_completed_iter(struct ec_completed *completed,
 211         enum ec_completed_type type);
 212
 213 /**
 214  *
 215  *
 216  *
 217  */
 218 const struct ec_completed_item *ec_completed_iter_next(
 219         struct ec_completed_iter *iter);
 220
 221 /**
 222  *
 223  *
 224  *
 225  */
 226 void ec_completed_iter_free(struct ec_completed_iter *iter);
 227
 228
 229 #endif