lib/ecoli_tk.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_TK_
  29 #define ECOLI_TK_
  30
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <stdio.h>
  34
  35 #define EC_TK_ENDLIST ((void *)1)
  36
  37 struct ec_tk;
  38 struct ec_parsed_tk;
  39 struct ec_strvec;
  40 struct ec_keyval;
  41
  42 typedef struct ec_parsed_tk *(*ec_tk_parse_t)(const struct ec_tk *tk,
  43         const struct ec_strvec *strvec);
  44 typedef struct ec_completed_tk *(*ec_tk_complete_t)(const struct ec_tk *tk,
  45         const struct ec_strvec *strvec);
  46 typedef const char * (*ec_tk_desc_t)(const struct ec_tk *);
  47 typedef void (*ec_tk_free_priv_t)(struct ec_tk *);
  48
  49 struct ec_tk_ops {
  50         const char *typename;
  51         ec_tk_parse_t parse;
  52         ec_tk_complete_t complete;
  53         ec_tk_desc_t desc;
  54         ec_tk_free_priv_t free_priv;
  55 };
  56
  57 TAILQ_HEAD(ec_tk_list, ec_tk);
  58
  59 struct ec_tk {
  60         const struct ec_tk_ops *ops;
  61         char *id;
  62         char *desc;
  63         struct ec_keyval *attrs;
  64         /* XXX ensure parent and child are properly set in all nodes */
  65         struct ec_tk *parent;
  66
  67         TAILQ_ENTRY(ec_tk) next;
  68         struct ec_tk_list children;
  69 };
  70
  71 struct ec_tk *ec_tk_new(const char *id, const struct ec_tk_ops *ops,
  72         size_t priv_size);
  73 void ec_tk_free(struct ec_tk *tk);
  74
  75 /* XXX add more accessors */
  76 struct ec_keyval *ec_tk_attrs(const struct ec_tk *tk);
  77 struct ec_tk *ec_tk_parent(const struct ec_tk *tk);
  78 const char *ec_tk_id(const struct ec_tk *tk);
  79
  80 struct ec_tk *ec_tk_find(struct ec_tk *tk, const char *id);
  81
  82 /* XXX split this file ? */
  83
  84 TAILQ_HEAD(ec_parsed_tk_list, ec_parsed_tk);
  85
  86 /*
  87   tk == NULL + empty children list means "no match"
  88 */
  89 struct ec_parsed_tk {
  90         TAILQ_ENTRY(ec_parsed_tk) next;
  91         struct ec_parsed_tk_list children;
  92         const struct ec_tk *tk;
  93         struct ec_strvec *strvec;
  94 };
  95
  96 struct ec_parsed_tk *ec_parsed_tk_new(void);
  97
  98 void ec_parsed_tk_set_match(struct ec_parsed_tk *parsed_tk,
  99         const struct ec_tk *tk, struct ec_strvec *strvec);
 100
 101 /* XXX we could use a cache to store possible completions or match: the
 102  * cache would be per-node, and would be reset for each call to parse()
 103  * or complete() ? */
 104 /* a NULL return value is an error, with errno set
 105   ENOTSUP: no ->parse() operation
 106 */
 107 struct ec_parsed_tk *ec_tk_parse(const struct ec_tk *tk, const char *str);
 108
 109 /* mostly internal to tokens */
 110 /* XXX it should not reset cache
 111  * ... not sure... it is used by tests */
 112 struct ec_parsed_tk *ec_tk_parse_tokens(const struct ec_tk *tk,
 113         const struct ec_strvec *strvec);
 114
 115 void ec_parsed_tk_add_child(struct ec_parsed_tk *parsed_tk,
 116         struct ec_parsed_tk *child);
 117 void ec_parsed_tk_free_children(struct ec_parsed_tk *parsed_tk);
 118 void ec_parsed_tk_dump(FILE *out, const struct ec_parsed_tk *parsed_tk);
 119 void ec_parsed_tk_free(struct ec_parsed_tk *parsed_tk);
 120
 121 struct ec_parsed_tk *ec_parsed_tk_find_first(struct ec_parsed_tk *parsed_tk,
 122         const char *id);
 123
 124 const char *ec_parsed_tk_to_string(const struct ec_parsed_tk *parsed_tk);
 125 size_t ec_parsed_tk_len(const struct ec_parsed_tk *parsed_tk);
 126 size_t ec_parsed_tk_matches(const struct ec_parsed_tk *parsed_tk);
 127
 128 struct ec_completed_tk_elt {
 129         TAILQ_ENTRY(ec_completed_tk_elt) next;
 130         const struct ec_tk *tk;
 131         char *add;
 132 };
 133
 134 TAILQ_HEAD(ec_completed_tk_elt_list, ec_completed_tk_elt);
 135
 136
 137 struct ec_completed_tk {
 138         struct ec_completed_tk_elt_list elts;
 139         unsigned count;
 140         unsigned count_match;
 141         char *smallest_start;
 142 };
 143
 144 /*
 145  * return a completed_tk object filled with elts
 146  * return NULL on error (nomem?)
 147  */
 148 struct ec_completed_tk *ec_tk_complete(const struct ec_tk *tk,
 149         const char *str);
 150 struct ec_completed_tk *ec_tk_complete_tokens(const struct ec_tk *tk,
 151         const struct ec_strvec *strvec);
 152 struct ec_completed_tk *ec_completed_tk_new(void);
 153 struct ec_completed_tk_elt *ec_completed_tk_elt_new(const struct ec_tk *tk,
 154         const char *add);
 155 void ec_completed_tk_add_elt(struct ec_completed_tk *completed_tk,
 156         struct ec_completed_tk_elt *elt);
 157 void ec_completed_tk_elt_free(struct ec_completed_tk_elt *elt);
 158 void ec_completed_tk_merge(struct ec_completed_tk *completed_tk1,
 159         struct ec_completed_tk *completed_tk2);
 160 void ec_completed_tk_free(struct ec_completed_tk *completed_tk);
 161 void ec_completed_tk_dump(FILE *out,
 162         const struct ec_completed_tk *completed_tk);
 163 struct ec_completed_tk *ec_tk_default_complete(const struct ec_tk *gen_tk,
 164         const struct ec_strvec *strvec);
 165
 166 /* cannot return NULL */
 167 const char *ec_completed_tk_smallest_start(
 168         const struct ec_completed_tk *completed_tk);
 169
 170 enum ec_completed_tk_filter_flags {
 171         EC_MATCH = 1,
 172         EC_NO_MATCH = 2,
 173 };
 174
 175 unsigned int ec_completed_tk_count(
 176         const struct ec_completed_tk *completed_tk,
 177         enum ec_completed_tk_filter_flags flags);
 178
 179 struct ec_completed_tk_iter {
 180         enum ec_completed_tk_filter_flags flags;
 181         const struct ec_completed_tk *completed_tk;
 182         const struct ec_completed_tk_elt *cur;
 183 };
 184
 185 struct ec_completed_tk_iter *
 186 ec_completed_tk_iter_new(struct ec_completed_tk *completed_tk,
 187         enum ec_completed_tk_filter_flags flags);
 188
 189 const struct ec_completed_tk_elt *ec_completed_tk_iter_next(
 190         struct ec_completed_tk_iter *iter);
 191
 192 void ec_completed_tk_iter_free(struct ec_completed_tk_iter *iter);
 193
 194
 195 const char *ec_tk_desc(const struct ec_tk *tk);
 196
 197 #endif