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 = 1,
  39         EC_MATCH = 2,
  40         EC_PARTIAL = 4,
  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 *add;
  48
  49         /* reverse order: [0] = last parsed, [len-1] = root */
  50         const struct ec_node **path;
  51         size_t pathlen;
  52 };
  53
  54 TAILQ_HEAD(ec_completed_item_list, ec_completed_item);
  55
  56 struct ec_completed {
  57         struct ec_completed_item_list items;
  58         unsigned count;
  59         unsigned count_match;
  60         char *smallest_start;
  61 };
  62
  63 /*
  64  * return a completed object filled with items
  65  * return NULL on error (nomem?)
  66  */
  67 struct ec_completed *ec_node_complete(struct ec_node *node,
  68         const char *str);
  69 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
  70         const struct ec_strvec *strvec);
  71
  72 /* internal: used by nodes */
  73 struct ec_completed *ec_node_complete_child(struct ec_node *node,
  74                                         struct ec_parsed *state,
  75                                         const struct ec_strvec *strvec);
  76
  77 struct ec_completed *ec_completed(void);
  78
  79 int ec_completed_add_match(struct ec_completed *completed,
  80                         struct ec_parsed *state,
  81                         const struct ec_node *node, const char *add);
  82 int ec_completed_add_no_match(struct ec_completed *completed,
  83                         struct ec_parsed *state, const struct ec_node *node);
  84
  85 void ec_completed_item_free(struct ec_completed_item *item);
  86 void ec_completed_merge(struct ec_completed *completed1,
  87         struct ec_completed *completed2);
  88 void ec_completed_free(struct ec_completed *completed);
  89 void ec_completed_dump(FILE *out,
  90         const struct ec_completed *completed);
  91 struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
  92                                         struct ec_parsed *state,
  93                                         const struct ec_strvec *strvec);
  94
  95 /* cannot return NULL */
  96 const char *ec_completed_smallest_start(
  97         const struct ec_completed *completed);
  98
  99 unsigned int ec_completed_count(
 100         const struct ec_completed *completed,
 101         enum ec_completed_type flags);
 102
 103 struct ec_completed_iter {
 104         enum ec_completed_type type;
 105         const struct ec_completed *completed;
 106         const struct ec_completed_item *cur;
 107 };
 108
 109 struct ec_completed_iter *
 110 ec_completed_iter(struct ec_completed *completed,
 111         enum ec_completed_type type);
 112
 113 const struct ec_completed_item *ec_completed_iter_next(
 114         struct ec_completed_iter *iter);
 115
 116 void ec_completed_iter_free(struct ec_completed_iter *iter);
 117
 118
 119 #endif