Libecoli 0.11.1
Extensible COmmand LIne library
Loading...
Searching...
No Matches
node.h
1/* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
3 */
4
53
54#pragma once
55
56#include <stdbool.h>
57#include <stdio.h>
58#include <sys/queue.h>
59#include <sys/types.h>
60
64#define EC_NO_ID ""
65
67struct ec_node;
68
70struct ec_node_iter;
71
72struct ec_pnode;
73struct ec_comp;
74struct ec_strvec;
75struct ec_dict;
76struct ec_config;
77struct ec_config_schema;
78
88#define EC_NODE_TYPE_REGISTER(t) \
89 static void ec_node_init_##t(void); \
90 static void __attribute__((constructor, used)) ec_node_init_##t(void) \
91 { \
92 if (ec_node_type_register(&t, 0) < 0) \
93 fprintf(stderr, "cannot register node type %s\n", t.name); \
94 }
95
109#define EC_NODE_TYPE_REGISTER_OVERRIDE(t) \
110 static void ec_node_init_##t(void); \
111 static void __attribute__((constructor, used)) ec_node_init_##t(void) \
112 { \
113 if (ec_node_type_register(&t, 1) < 0) \
114 fprintf(stderr, "cannot register node type %s\n", t.name); \
115 }
116
138typedef int (*ec_node_set_config_t)(struct ec_node *node, const struct ec_config *config);
139
163typedef int (*ec_parse_t)(
164 const struct ec_node *node,
165 struct ec_pnode *pstate,
166 const struct ec_strvec *strvec
167);
168
210typedef int (*ec_complete_t)(
211 const struct ec_node *node,
212 struct ec_comp *comp,
213 const struct ec_strvec *strvec
214);
215
241typedef char *(*ec_node_desc_t)(const struct ec_node *);
242
257typedef int (*ec_node_init_priv_t)(struct ec_node *);
258
268typedef void (*ec_node_free_priv_t)(struct ec_node *);
269
280typedef size_t (*ec_node_get_children_count_t)(const struct ec_node *);
281
298typedef int (*ec_node_get_child_t)(
299 const struct ec_node *,
300 size_t i,
301 struct ec_node **child,
302 unsigned int *refs
303);
304
313 TAILQ_ENTRY(ec_node_type) next;
314 const char *name;
317 const struct ec_config_schema *schema;
318 size_t size;
319 ec_node_set_config_t set_config;
320 ec_parse_t parse;
321 ec_complete_t complete;
322 ec_node_desc_t desc;
323 ec_node_init_priv_t init_priv;
324 ec_node_free_priv_t free_priv;
326 ec_node_get_children_count_t get_children_count;
327 ec_node_get_child_t get_child;
328};
329
333TAILQ_HEAD(ec_node_type_list, ec_node_type);
334
340extern struct ec_node_type_list node_type_list;
341
358int ec_node_type_register(struct ec_node_type *type, bool override);
359
368const struct ec_node_type *ec_node_type_lookup(const char *name);
369
376void ec_node_type_dump(FILE *out);
377
387const struct ec_config_schema *ec_node_type_schema(const struct ec_node_type *type);
388
397const char *ec_node_type_name(const struct ec_node_type *type);
398
411struct ec_node *ec_node_from_type(const struct ec_node_type *type, const char *id);
412
426struct ec_node *ec_node(const char *typename, const char *id);
427
442struct ec_node *ec_node_clone(struct ec_node *node);
443
451void ec_node_free(struct ec_node *node);
452
469int ec_node_set_config(struct ec_node *node, struct ec_config *config);
470
481const struct ec_config *ec_node_get_config(const struct ec_node *node);
482
491size_t ec_node_get_children_count(const struct ec_node *node);
492
505int ec_node_get_child(const struct ec_node *node, size_t i, struct ec_node **child);
506
515const struct ec_node_type *ec_node_type(const struct ec_node *node);
516
528struct ec_dict *ec_node_attrs(const struct ec_node *node);
529
538const char *ec_node_id(const struct ec_node *node);
539
549char *ec_node_desc(const struct ec_node *node);
550
559void ec_node_dump(FILE *out, const struct ec_node *node);
560
574struct ec_node *ec_node_find(struct ec_node *node, const char *id);
575
614struct ec_node_iter *ec_node_iter(struct ec_node *node);
615
630struct ec_node_iter *
631ec_node_iter_next(struct ec_node_iter *root, struct ec_node_iter *iter, bool iter_children);
632
640
650
661
672int ec_node_check_type(const struct ec_node *node, const struct ec_node_type *type);
673
682const char *ec_node_get_type_name(const struct ec_node *node);
683
692void *ec_node_priv(const struct ec_node *node);
693
702void ec_node_schema_dump(FILE *out, const struct ec_node *node);
703
struct ec_comp * ec_comp(void)
struct ec_dict * ec_dict(void)
struct ec_node * ec_node_clone(struct ec_node *node)
const char * ec_node_id(const struct ec_node *node)
struct ec_node * ec_node_iter_get_node(struct ec_node_iter *iter)
int ec_node_get_child(const struct ec_node *node, size_t i, struct ec_node **child)
void ec_node_iter_free(struct ec_node_iter *iter)
const char * ec_node_get_type_name(const struct ec_node *node)
struct ec_node * ec_node_from_type(const struct ec_node_type *type, const char *id)
void ec_node_dump(FILE *out, const struct ec_node *node)
void(* ec_node_free_priv_t)(struct ec_node *)
Definition node.h:268
struct ec_node * ec_node(const char *typename, const char *id)
struct ec_dict * ec_node_attrs(const struct ec_node *node)
struct ec_node * ec_node_find(struct ec_node *node, const char *id)
void ec_node_type_dump(FILE *out)
int ec_node_check_type(const struct ec_node *node, const struct ec_node_type *type)
int ec_node_set_config(struct ec_node *node, struct ec_config *config)
struct ec_node_iter * ec_node_iter(struct ec_node *node)
struct ec_node_type_list node_type_list
int(* ec_node_get_child_t)(const struct ec_node *, size_t i, struct ec_node **child, unsigned int *refs)
Definition node.h:298
size_t ec_node_get_children_count(const struct ec_node *node)
struct ec_node_iter * ec_node_iter_get_parent(struct ec_node_iter *iter)
char *(* ec_node_desc_t)(const struct ec_node *)
Definition node.h:241
struct ec_node_iter * ec_node_iter_next(struct ec_node_iter *root, struct ec_node_iter *iter, bool iter_children)
const struct ec_config * ec_node_get_config(const struct ec_node *node)
int(* ec_node_set_config_t)(struct ec_node *node, const struct ec_config *config)
Definition node.h:138
const struct ec_node_type * ec_node_type(const struct ec_node *node)
int ec_node_type_register(struct ec_node_type *type, bool override)
int(* ec_node_init_priv_t)(struct ec_node *)
Definition node.h:257
int(* ec_complete_t)(const struct ec_node *node, struct ec_comp *comp, const struct ec_strvec *strvec)
Definition node.h:210
size_t(* ec_node_get_children_count_t)(const struct ec_node *)
Definition node.h:280
const struct ec_config_schema * ec_node_type_schema(const struct ec_node_type *type)
char * ec_node_desc(const struct ec_node *node)
int(* ec_parse_t)(const struct ec_node *node, struct ec_pnode *pstate, const struct ec_strvec *strvec)
Definition node.h:163
void ec_node_schema_dump(FILE *out, const struct ec_node *node)
const struct ec_node_type * ec_node_type_lookup(const char *name)
const char * ec_node_type_name(const struct ec_node_type *type)
void * ec_node_priv(const struct ec_node *node)
void ec_node_free(struct ec_node *node)
struct ec_pnode * ec_pnode(const struct ec_node *node)
struct ec_strvec * ec_strvec(void)