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 struct ec_completed_elt {
  38         TAILQ_ENTRY(ec_completed_elt) next;
  39         const struct ec_node *node;
  40         char *add;
  41 };
  42
  43 TAILQ_HEAD(ec_completed_elt_list, ec_completed_elt);
  44
  45
  46 struct ec_completed {
  47         struct ec_completed_elt_list elts;
  48         unsigned count;
  49         unsigned count_match;
  50         char *smallest_start;
  51 };
  52
  53 /*
  54  * return a completed object filled with elts
  55  * return NULL on error (nomem?)
  56  */
  57 struct ec_completed *ec_node_complete(struct ec_node *node,
  58         const char *str);
  59 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
  60         const struct ec_strvec *strvec);
  61
  62 struct ec_completed *ec_completed(void);
  63 struct ec_completed_elt *ec_completed_elt(const struct ec_node *node,
  64         const char *add);
  65 void ec_completed_add_elt(struct ec_completed *completed,
  66         struct ec_completed_elt *elt);
  67 void ec_completed_elt_free(struct ec_completed_elt *elt);
  68 void ec_completed_merge(struct ec_completed *completed1,
  69         struct ec_completed *completed2);
  70 void ec_completed_free(struct ec_completed *completed);
  71 void ec_completed_dump(FILE *out,
  72         const struct ec_completed *completed);
  73 struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
  74         const struct ec_strvec *strvec);
  75
  76 /* cannot return NULL */
  77 const char *ec_completed_smallest_start(
  78         const struct ec_completed *completed);
  79
  80 enum ec_completed_filter_flags {
  81         EC_MATCH = 1,
  82         EC_NO_MATCH = 2,
  83 };
  84
  85 unsigned int ec_completed_count(
  86         const struct ec_completed *completed,
  87         enum ec_completed_filter_flags flags);
  88
  89 struct ec_completed_iter {
  90         enum ec_completed_filter_flags flags;
  91         const struct ec_completed *completed;
  92         const struct ec_completed_elt *cur;
  93 };
  94
  95 struct ec_completed_iter *
  96 ec_completed_iter(struct ec_completed *completed,
  97         enum ec_completed_filter_flags flags);
  98
  99 const struct ec_completed_elt *ec_completed_iter_next(
 100         struct ec_completed_iter *iter);
 101
 102 void ec_completed_iter_free(struct ec_completed_iter *iter);
 103
 104
 105 #endif