completed -> comp

[protos/libecoli.git] / lib / ecoli_parsed.h

diff --git a/lib/ecoli_parsed.h b/lib/ecoli_parsed.h
index afb765e..9f7a698 100644 (file)
--- a/lib/ecoli_parsed.h
+++ b/lib/ecoli_parsed.h
@@ -1,28 +1,5 @@
-/*
- * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the University of California, Berkeley nor the
- *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
  */
 
 /**
@@ -50,7 +27,7 @@ struct ec_parsed;
  * @return
  *   The empty parse tree.
  */
-struct ec_parsed *ec_parsed(void);
+struct ec_parsed *ec_parsed(const struct ec_node *node);
 
 /**
  *
@@ -80,10 +57,6 @@ struct ec_parsed *ec_parsed_dup(const struct ec_parsed *parsed);
  */
 const struct ec_strvec *ec_parsed_strvec(const struct ec_parsed *parsed);
 
-/* XXX we could use a cache to store possible completions or match: the
- * cache would be per-node, and would be reset for each call to parse()
- * or complete() ? ... not sure, since parse result can depend on state
- */
 /* a NULL return value is an error, with errno set
   ENOTSUP: no ->parse() operation
 */
@@ -92,14 +65,14 @@ const struct ec_strvec *ec_parsed_strvec(const struct ec_parsed *parsed);
  *
  *
  */
-struct ec_parsed *ec_node_parse(struct ec_node *node, const char *str);
+struct ec_parsed *ec_node_parse(const struct ec_node *node, const char *str);
 
 /**
  *
  *
  *
  */
-struct ec_parsed *ec_node_parse_strvec(struct ec_node *node,
+struct ec_parsed *ec_node_parse_strvec(const struct ec_node *node,
                                const struct ec_strvec *strvec);
 
 /**
@@ -122,9 +95,8 @@ struct ec_parsed *ec_node_parse_strvec(struct ec_node *node,
  * EC_PARSED_NOMATCH (positive) if it does not match
  * any other negative value (-errno) for other errors
  * the number of matched strings in strvec
- * XXX state is not freed on error ?
  */
-int ec_node_parse_child(struct ec_node *node,
+int ec_node_parse_child(const struct ec_node *node,
                        struct ec_parsed *state,
                        const struct ec_strvec *strvec);
 
@@ -133,29 +105,39 @@ int ec_node_parse_child(struct ec_node *node,
  *
  *
  */
-void ec_parsed_add_child(struct ec_parsed *parsed,
+void ec_parsed_link_child(struct ec_parsed *parsed,
                        struct ec_parsed *child);
 /**
  *
  *
  *
  */
-void ec_parsed_del_child(struct ec_parsed *parsed,
+void ec_parsed_unlink_child(struct ec_parsed *parsed,
                        struct ec_parsed *child);
 
+/* keep the const */
+#define ec_parsed_get_root(parsed) ({                          \
+       const struct ec_parsed *p_ = parsed; /* check type */   \
+       struct ec_parsed *parsed_ = (struct ec_parsed *)parsed; \
+       typeof(parsed) res_;                                    \
+       (void)p_;                                               \
+       res_ = __ec_parsed_get_root(parsed_);                   \
+       res_;                                                   \
+})
+
 /**
  *
  *
  *
  */
-struct ec_parsed *ec_parsed_get_root(struct ec_parsed *parsed);
+struct ec_parsed *__ec_parsed_get_root(struct ec_parsed *parsed);
 
 /**
  *
  *
  *
  */
-struct ec_parsed *ec_parsed_get_parent(struct ec_parsed *parsed);
+struct ec_parsed *ec_parsed_get_parent(const struct ec_parsed *parsed);
 
 /**
  * Get the first child of a tree.
@@ -201,13 +183,6 @@ bool ec_parsed_has_child(const struct ec_parsed *parsed);
  */
 const struct ec_node *ec_parsed_get_node(const struct ec_parsed *parsed);
 
-/**
- *
- *
- *
- */
-void ec_parsed_set_node(struct ec_parsed *parsed, const struct ec_node *node);
-
 /**
  *
  *
@@ -220,7 +195,7 @@ void ec_parsed_del_last_child(struct ec_parsed *parsed);
  *
  *
  */
-int ec_parsed_get_path(struct ec_parsed *parsed, struct ec_node **path);
+struct ec_keyval *ec_parsed_get_attrs(struct ec_parsed *parsed);
 
 /**
  *
@@ -237,6 +212,14 @@ void ec_parsed_dump(FILE *out, const struct ec_parsed *parsed);
 struct ec_parsed *ec_parsed_find_first(struct ec_parsed *parsed,
        const char *id);
 
+/**
+ * Iterate among parsed tree
+ *
+ * Use it with:
+ * for (iter = state; iter != NULL; iter = ec_parsed_iter_next(iter))
+ */
+struct ec_parsed *ec_parsed_iter_next(struct ec_parsed *parsed);
+
 /**
  *
  *