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