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