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 <stdio.h>
  34
  35 struct ec_node;
  36
  37 TAILQ_HEAD(ec_parsed_list, ec_parsed);
  38
  39 /*
  40   node == NULL + empty children list means "no match"
  41 */
  42 struct ec_parsed {
  43         TAILQ_ENTRY(ec_parsed) next;
  44         struct ec_parsed_list children;
  45         const struct ec_node *node;
  46         struct ec_strvec *strvec;
  47 };
  48
  49 struct ec_parsed *ec_parsed(void);
  50 void ec_parsed_free(struct ec_parsed *parsed);
  51 void ec_parsed_free_children(struct ec_parsed *parsed);
  52
  53 const struct ec_strvec *ec_parsed_strvec(
  54         const struct ec_parsed *parsed);
  55
  56 void ec_parsed_set_match(struct ec_parsed *parsed,
  57         const struct ec_node *node, struct ec_strvec *strvec);
  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() ? */
  62 /* a NULL return value is an error, with errno set
  63   ENOTSUP: no ->parse() operation
  64 */
  65 struct ec_parsed *ec_node_parse(struct ec_node *node, const char *str);
  66
  67 /* mostly internal to nodes */
  68 /* XXX it should not reset cache
  69  * ... not sure... it is used by tests */
  70 struct ec_parsed *ec_node_parse_strvec(struct ec_node *node,
  71         const struct ec_strvec *strvec);
  72
  73 void ec_parsed_add_child(struct ec_parsed *parsed,
  74         struct ec_parsed *child);
  75 void ec_parsed_del_child(struct ec_parsed *parsed,
  76         struct ec_parsed *child);
  77 void ec_parsed_dump(FILE *out, const struct ec_parsed *parsed);
  78
  79 struct ec_parsed *ec_parsed_find_first(struct ec_parsed *parsed,
  80         const char *id);
  81
  82 const char *ec_parsed_to_string(const struct ec_parsed *parsed);
  83 size_t ec_parsed_len(const struct ec_parsed *parsed);
  84 size_t ec_parsed_matches(const struct ec_parsed *parsed);
  85
  86 #endif