lib/ecoli_parsed.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_PARSED_
  29 #define ECOLI_PARSED_
  30
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <limits.h>
  34 #include <stdio.h>
  35
  36 struct ec_node;
  37
  38 TAILQ_HEAD(ec_parsed_list, ec_parsed);
  39
  40 /*
  41   node == NULL + empty children list means "no match"
  42 */
  43 struct ec_parsed {
  44         TAILQ_ENTRY(ec_parsed) next;
  45         struct ec_parsed_list children;
  46         struct ec_parsed *parent;
  47         const struct ec_node *node;
  48         struct ec_strvec *strvec;
  49 };
  50
  51 struct ec_parsed *ec_parsed(void);
  52 void ec_parsed_free(struct ec_parsed *parsed);
  53 void ec_parsed_free_children(struct ec_parsed *parsed);
  54
  55 const struct ec_strvec *ec_parsed_strvec(const struct ec_parsed *parsed);
  56
  57 /* XXX we could use a cache to store possible completions or match: the
  58  * cache would be per-node, and would be reset for each call to parse()
  59  * or complete() ? */
  60 /* a NULL return value is an error, with errno set
  61   ENOTSUP: no ->parse() operation
  62 */
  63 struct ec_parsed *ec_node_parse(struct ec_node *node, const char *str);
  64
  65 struct ec_parsed *ec_node_parse_strvec(struct ec_node *node,
  66                                 const struct ec_strvec *strvec);
  67
  68 #define EC_PARSED_NOMATCH INT_MIN
  69 /* internal: used by nodes
  70  *
  71  * state is the current parse tree, which is built bit by bit while
  72  *   parsing the node tree: ec_node_parse_child() creates a new child in
  73  *   this state parse tree, and calls the parse() method for the child
  74  *   node, with state pointing to this new child. If it does not match,
  75  *   the child is removed in the state, else it is kept, with its
  76  *   possible descendants.
  77  *
  78  * return:
  79  * XXX change EC_PARSED_NOMATCH to INT_MAX?
  80  * EC_PARSED_NOMATCH (negative) if it does not match
  81  * any other negative value (-errno) for other errors
  82  * the number of matched strings in strvec
  83  * XXX state is not freed on error ?
  84  */
  85 int ec_node_parse_child(struct ec_node *node,
  86                         struct ec_parsed *state,
  87                         const struct ec_strvec *strvec);
  88
  89 void ec_parsed_add_child(struct ec_parsed *parsed,
  90                         struct ec_parsed *child);
  91 void ec_parsed_del_child(struct ec_parsed *parsed,
  92                         struct ec_parsed *child);
  93
  94 struct ec_parsed *ec_parsed_get_root(struct ec_parsed *parsed);
  95 struct ec_parsed *ec_parsed_get_parent(struct ec_parsed *parsed);
  96 struct ec_parsed *ec_parsed_get_last_child(struct ec_parsed *parsed);
  97 void ec_parsed_del_last_child(struct ec_parsed *parsed);
  98 int ec_parsed_get_path(struct ec_parsed *parsed, struct ec_node **path);
  99
 100 void ec_parsed_dump(FILE *out, const struct ec_parsed *parsed);
 101
 102 struct ec_parsed *ec_parsed_find_first(struct ec_parsed *parsed,
 103         const char *id);
 104
 105 size_t ec_parsed_len(const struct ec_parsed *parsed);
 106 size_t ec_parsed_matches(const struct ec_parsed *parsed);
 107
 108 #endif