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
  34 #include <stdio.h>
  35
  36 #define EC_TK_ENDLIST ((void *)1)
  37
  38 struct ec_tk;
  39 struct ec_parsed_tk;
  40
  41 typedef struct ec_parsed_tk *(*ec_tk_parse_t)(const struct ec_tk *tk,
  42         const char *str);
  43 typedef struct ec_completed_tk *(*ec_tk_complete_t)(const struct ec_tk *tk,
  44         const char *str);
  45 typedef void (*ec_tk_free_priv_t)(struct ec_tk *);
  46
  47 struct ec_tk_ops {
  48         ec_tk_parse_t parse;
  49         ec_tk_complete_t complete;
  50         ec_tk_free_priv_t free_priv;
  51 };
  52
  53 struct ec_tk {
  54         const struct ec_tk_ops *ops;
  55         char *id;
  56 };
  57
  58 struct ec_tk *ec_tk_new(const char *id, const struct ec_tk_ops *ops,
  59         size_t priv_size);
  60 void ec_tk_free(struct ec_tk *tk);
  61
  62
  63 TAILQ_HEAD(ec_parsed_tk_list, ec_parsed_tk);
  64
  65 struct ec_parsed_tk {
  66         struct ec_parsed_tk_list children;
  67         TAILQ_ENTRY(ec_parsed_tk) next;
  68         const struct ec_tk *tk;
  69         char *str;
  70 };
  71
  72 /* XXX we could use a cache to store possible completions or match: the
  73  * cache would be per-node, and would be reset for each call to parse()
  74  * or complete() ? */
  75
  76 struct ec_parsed_tk *ec_parsed_tk_new(const struct ec_tk *tk);
  77 struct ec_parsed_tk *ec_tk_parse(const struct ec_tk *token, const char *str);
  78 void ec_parsed_tk_add_child(struct ec_parsed_tk *parsed_tk,
  79         struct ec_parsed_tk *child);
  80 void ec_parsed_tk_dump(FILE *out, const struct ec_parsed_tk *parsed_tk);
  81 void ec_parsed_tk_free(struct ec_parsed_tk *parsed_tk);
  82
  83 struct ec_parsed_tk *ec_parsed_tk_find_first(struct ec_parsed_tk *parsed_tk,
  84         const char *id);
  85
  86 const char *ec_parsed_tk_to_string(const struct ec_parsed_tk *parsed_tk);
  87
  88 struct ec_completed_tk_elt {
  89         TAILQ_ENTRY(ec_completed_tk_elt) next;
  90         const struct ec_tk *tk;
  91         char *add;
  92         char *full;
  93 };
  94
  95 TAILQ_HEAD(ec_completed_tk_elt_list, ec_completed_tk_elt);
  96
  97
  98 struct ec_completed_tk {
  99         struct ec_completed_tk_elt_list elts;
 100         const struct ec_completed_tk_elt *cur;
 101         unsigned count;
 102         char *smallest_start;
 103 };
 104
 105 /*
 106  * return a completed_tk object filled with elts
 107  * return NULL on error (nomem?)
 108  */
 109 struct ec_completed_tk *ec_tk_complete(const struct ec_tk *token,
 110         const char *str);
 111 struct ec_completed_tk *ec_completed_tk_new(void);
 112 struct ec_completed_tk_elt *ec_completed_tk_elt_new(const struct ec_tk *tk,
 113         const char *add, const char *full);
 114 void ec_completed_tk_add_elt(struct ec_completed_tk *completed_tk,
 115         struct ec_completed_tk_elt *elt);
 116 void ec_completed_tk_elt_free(struct ec_completed_tk_elt *elt);
 117 void ec_completed_tk_merge(struct ec_completed_tk *completed_tk1,
 118         struct ec_completed_tk *completed_tk2);
 119 void ec_completed_tk_free(struct ec_completed_tk *completed_tk);
 120 void ec_completed_tk_dump(FILE *out,
 121         const struct ec_completed_tk *completed_tk);
 122
 123 /* cannot return NULL */
 124 const char *ec_completed_tk_smallest_start(
 125         const struct ec_completed_tk *completed_tk);
 126
 127 unsigned int ec_completed_tk_count(const struct ec_completed_tk *completed_tk);
 128
 129 void ec_completed_tk_iter_start(struct ec_completed_tk *completed_tk);
 130 const struct ec_completed_tk_elt *ec_completed_tk_iter_next(
 131         struct ec_completed_tk *completed_tk);
 132
 133 #endif