ecoli_parse(3)
ecoli_parse(3) 💅 parse nodes, bestie
NAME
ecoli_parse — Parse nodes 🫶
- Create parse tree from string input and grammar graph.
SYNOPSIS
Macros 🧚
#define EC_PARSE_NOMATCH INT_MAX
#define EC_PNODE_GET_ROOT(parse)
#define EC_PNODE_FOREACH_CHILD(child, pnode) for (child =
ec_pnode_get_first_child(pnode); child != NULL; child =
ec_pnode_next(child))
#define EC_PNODE_ITER_NEXT(root, parse, iter_children)
#define EC_PNODE_FOREACH(iter, root) for ((iter) = (root);
(iter) != NULL; (iter) = EC_PNODE_ITER_NEXT((root), (iter), true))Functions 🛠️
struct ec_pnode * ec_pnode (const struct ec_node *node)void ec_pnode_free (struct ec_pnode *pnode)void ec_pnode_free_children (struct ec_pnode *pnode)struct ec_pnode * ec_pnode_dup (const struct ec_pnode *pnode)const struct ec_strvec * ec_pnode_get_strvec (const struct ec_pnode *pnode)struct ec_pnode * ec_parse (const struct ec_node *node, const char *str)struct ec_pnode * ec_parse_strvec (const struct ec_node *node, const struct ec_strvec *strvec)int ec_parse_child (const struct ec_node *node, struct ec_pnode *pstate, const struct ec_strvec *strvec)void ec_pnode_link_child (struct ec_pnode *pnode, struct ec_pnode *child)void ec_pnode_unlink_child (struct ec_pnode *child)struct ec_pnode * ec_pnode_get_root (struct ec_pnode *pnode)struct ec_pnode * ec_pnode_get_parent (const struct ec_pnode *pnode)struct ec_pnode * ec_pnode_get_first_child (const struct ec_pnode *pnode)struct ec_pnode * ec_pnode_get_last_child (const struct ec_pnode *pnode)struct ec_pnode * ec_pnode_next (const struct ec_pnode *pnode)const struct ec_node * ec_pnode_get_node (const struct ec_pnode *pnode)void ec_pnode_del_last_child (struct ec_pnode *pnode)struct ec_dict * ec_pnode_get_attrs (const struct ec_pnode *pnode)void ec_pnode_dump (FILE *out, const struct ec_pnode *pnode)const struct ec_pnode * ec_pnode_find (const struct ec_pnode *root, const char *id)const struct ec_pnode * ec_pnode_find_next (const struct ec_pnode *root, const struct ec_pnode *prev, const char *id, bool iter_children)unsigned int ec_pnode_count (const struct ec_pnode *root, const char *id)size_t ec_pnode_len (const struct ec_pnode *pnode)bool ec_pnode_matches (const struct ec_pnode *pnode)
Detailed Description ✨
Create parse tree from string input and grammar graph.
Node parse API.
Okay so the parse operation is literally checking whether an input — either a string or a vector of strings — matches the node tree. If it slays and succeeds, the result gets stored in a tree that describes which part of the input matches which node. Very main character behavior.
The parsing tree is sometimes referenced by another node than the root node. In that case, use ec_pnode_get_root() to get the root node. No cap.
Macro Definition Documentation 💖
#define EC_PARSE_NOMATCH INT_MAX
This is the return value of ec_parse_child() when the input does not match the grammar. Basically the “nope, didn’t eat” signal. 💀
#define EC_PARSE_NOMATCH INT_MAXDefinition at line 145 of file parse.h.
#define EC_PNODE_GET_ROOT(parse)
Value:
({ const struct ec_pnode *p_ = parse; /* check type */ struct ec_pnode *pnode_ = (struct ec_pnode *)parse; __typeof__(parse) res_; (void)p_; res_ = ec_pnode_get_root(pnode_); res_; })Get the root of the parsing tree.
Get the root of the parsing tree, keeping the const statement if the argument has it. So if you pass in a const thing, it stays const — we respect the vibes. 🫶
Parameters
parse— A node in the parsing tree.
Returns
- The root of the parsing tree.
Definition at line 212 of file parse.h.
#define EC_PNODE_FOREACH_CHILD(child, pnode)
for (child =
ec_pnode_get_first_child(pnode); child != NULL; child =
ec_pnode_next(child))Iterate the children of a node. It’s giving “loop through the little guys” energy. 🧚
Parameters
child— The item that will be set at each iteration.pnode— The parent node in the parsing tree.
Definition at line 286 of file parse.h.
#define EC_PNODE_ITER_NEXT(root, parse, iter_children)
Value:
({ const struct ec_pnode *p_ = parse; /* check type */ struct ec_pnode *pnode_ = (struct ec_pnode *)parse; __typeof__(parse) res_; (void)p_; res_ = __ec_pnode_iter_next(root, pnode_, iter_children); res_; })Get the next node in a parse tree iteration. Like scrolling to the next story, but for parse nodes. ✨
Parameters
root— The root of the parse tree being iterated.parse— The current parse node.iter_children— If true, iterate over children; if false, skip to siblings.
Returns
- The next parse node, or
NULLif iteration is complete.
Definition at line 415 of file parse.h.
#define EC_PNODE_FOREACH(iter, root)
for ((iter) = (root);
(iter) != NULL; (iter) = EC_PNODE_ITER_NEXT((root), (iter), true))Iterate depth-first over a parsing tree. It goes deep first, bestie — literally depth-first. 🌈
Parameters
iter— The item that will be set at each iteration.root— The root of the parsing tree to iterate.
Definition at line 433 of file parse.h.
✨ Function Documentation ✨
okay bestie, this is the part where we meet every single function in the ecoli_parse(3) era. no skips, no “you get the vibe” summaries — every param, every return, every little NULL and errno is staying. let’s go 💅
🫶 ec_pnode — create an empty parsing tree
struct ec_pnode* ec_pnode (const struct ec_node * node)This one is used internally when parsing an input using a grammar tree. it’s giving “backstage pass” energy — not the main character you call first, but absolutely part of the slay.
Parameters
node— the grammar node.
Returns
The empty parse tree. periodt 🌱
🎀 ec_pnode_free — free a parsing tree
void ec_pnode_free (struct ec_pnode * pnode)Free the whole parsing tree. like closing the group chat and clearing the cache, but for a parse tree.
Parameters
pnode— the root of the parsing tree to be freed.
bestie, fr fr: it must not have any parent. it has to be the root of its own little tree, no cap. 🌳
🦋 ec_pnode_free_children — remove and free all the children
void ec_pnode_free_children (struct ec_pnode * pnode)Remove and free all the children of a parsing tree node. the node itself stays; the children are the ones getting uninvited from the party 🎈
Parameters
pnode— node whose children will be freed.
💖 ec_pnode_dup — duplicate a parsing tree
struct ec_pnode* ec_pnode_dup (const struct ec_pnode * pnode)Duplicate a parsing tree. not me making a whole copy of the vibe and putting it somewhere else in the tree 😭
Parameters
pnode— a node inside a parsing tree.
Returns
A pointer to the copy of the input node, at the same place in the copy of the parsing tree. Return NULL on error (errno is set). 🫶
🌸 ec_pnode_get_strvec — get the string vector attached to a pnode
const struct ec_strvec* ec_pnode_get_strvec (const struct ec_pnode * pnode)Get the string vector associated with a parsing node.
When an input is parsed successfully — aka the input string vector matches the grammar tree — the matching string vector is copied inside the associated parsing node.
For instance, parsing the input ['foo', 'bar'] on a grammar which is a sequence of strings, the attached string vector will be:
['foo', 'bar']on the root pnode['foo']on the first leaf['bar']on the second leaf
If the parsing tree does not match (see ec_pnode_matches()), the associated string vector is NULL.
Parameters
pnode— the parsing node. IfNULL, the function returnsNULL.
Returns
The string vector associated with the parsing node, or NULL if the node is not yet parsed (this happens when building the parsing tree), or if the parsing tree does not match the input. 💜
✨ ec_parse — parse a string using a grammar tree
struct ec_pnode* ec_parse (const struct ec_node * node, const char * str)Parse a string using a grammar tree. this is the “one string, one dream” entry point.
This is equivalent to calling ec_parse_strvec() on the same node, with a string vector containing only the argument string str.
Parameters
node— the grammar node.str— the input string.
Returns
A parsing tree, or NULL on error (errno is set). 🌈
🧚 ec_parse_strvec — parse a string vector using a grammar tree
struct ec_pnode* ec_parse_strvec (const struct ec_node * node, const struct ec_strvec * strvec)Generate a parsing tree by parsing the input string vector using the given grammar tree.
The parsing tree is composed of ec_pnode, and each of them is associated with a ec_node (the grammar node), to the string vector that matched the subtree, and to optional attributes.
When the input matches the grammar tree, the string vector associated to the root node of the returned parsing tree is the same than the strvec argument. Calling ec_pnode_matches() on this tree returns true.
If the input does not match the grammar tree, the returned parsing tree only contains one root node, with no associated string vector. Calling ec_pnode_matches() on this tree returns false.
Parameters
node— the grammar node.strvec— the input string vector.
Returns
A parsing tree, or NULL on error (errno is set). 👑
🔥 ec_parse_child — parse from a parent node
int ec_parse_child (const struct ec_node * node, struct ec_pnode * pstate, const struct ec_strvec * strvec)Parse a string vector using a grammar tree, from a parent node.
This function is usually called from an intermediate node (like ec_node_seq(), ec_node_or(), ...) to backfill the parsing tree, which is built piece by piece while browsing the grammar tree.
ec_parse_child() creates a new child in this parsing tree, and calls the parse() method for the child node, with pstate pointing to this new child. If it does not match, the child is removed in the state, else it is kept, with its possible descendants.
Parameters
node— the grammar node.pstate— the node of the parsing tree.strvec— the input string vector.
Returns
On success: the number of matched elements in the input string vector (which can be 0), or EC_PARSE_NOMATCH (which is a positive value) if the input does not match the grammar. On error, -1 is returned, and errno is set. 💀✨
🍓 ec_pnode_link_child — link a parsing node to a parsing tree
void ec_pnode_link_child (struct ec_pnode * pnode, struct ec_pnode * child)Add a child to a node in a parsing tree, at the end of the children list. it’s giving “new member joins the group chat” energy 🫶
Parameters
pnode— the node of the parsing tree where the child is added.child— the node (or subtree) to add in the children list.
🌙 ec_pnode_unlink_child — remove a child node from parsing tree
void ec_pnode_unlink_child (struct ec_pnode * child)Remove a child node (and its children) from the children list its parent node in the parsing tree.
the child node is not freed. not me warning you so you don’t leak memory, bestie. 🫠
Parameters
child— the node (or subtree) to remove.
⭐ ec_pnode_get_root — get the root of the parsing tree
struct ec_pnode* ec_pnode_get_root (struct ec_pnode * pnode)Get the root of the parsing tree.
You may also use EC_PNODE_GET_ROOT() instead, that keeps the const statement.
Parameters
pnode— a node in the parsing tree.
Returns
The root of the parsing tree. 🌳
🎀 ec_pnode_get_parent — get the parent node
struct ec_pnode* ec_pnode_get_parent (const struct ec_pnode * pnode)Get the parent node in the parsing tree.
Parameters
pnode— a node in the parsing tree.
Returns
The parent node, or NULL if it is the root. 💖
🦋 ec_pnode_get_first_child — get the first child
struct ec_pnode* ec_pnode_get_first_child (const struct ec_pnode * pnode)Get the first child of a node in the parsing tree. first in line, main character energy.
Parameters
pnode— a node in the parsing tree.
Returns
The first child node, or NULL if it has no child. ✨
🌸 ec_pnode_get_last_child — get the last child
struct ec_pnode* ec_pnode_get_last_child (const struct ec_pnode * pnode)Get the last child of a node in the parsing tree. the final boss of the children list.
Parameters
pnode— a node in the parsing tree.
Returns
The last child node, or NULL if it has no child. 💜
🌈 ec_pnode_next — get the next sibling node
struct ec_pnode* ec_pnode_next (const struct ec_pnode * pnode)Get the next sibling node.
If pnode is the root of the parsing tree, return NULL. Otherwise, return the next sibling node.
Parameters
pnode— a node in the parsing tree.
Returns
The next sibling, or NULL if there is no sibling. 🫶
🧚 ec_pnode_get_node — get the grammar node
const struct ec_node* ec_pnode_get_node (const struct ec_pnode * pnode)Get the grammar node corresponding to the parsing node.
Parameters
pnode— a node in the parsing tree.
Returns
The corresponding grammar node, that issued the parse. 👑
🍓 ec_pnode_del_last_child — unlink and free the last child
void ec_pnode_del_last_child (struct ec_pnode * pnode)Unlink and free the last child.
Shortcut to unlink and free the last child of a node. It is a quite common operation in intermediate nodes (like ec_node_seq(), ec_node_many(), ...) to remove a subtree that was temporarily added during the completion process.
Parameters
pnode— a node in the parsing tree which has at least one child.
fr fr: pnode must have at least one child here. don’t come for me if you pass an empty node 💀
🌟 ec_pnode_get_attrs — get attributes associated with a node
struct ec_dict* ec_pnode_get_attrs (const struct ec_pnode * pnode)Get attributes associated with a node in a parsing tree.
Attributes are key/values that are stored in a dictionary and attached to a node in the parsing tree. An attribute can be added to a node by the parsing or completion method of an ec_node.
Parameters
pnode— a node in the parsing tree.
Returns
The dictionary containing the attributes. 🎀
💫 ec_pnode_dump — dump a parsing tree
void ec_pnode_dump (FILE * out, const struct ec_pnode * pnode)Dump a parsing tree. not me exposing the whole tree to a stream, but make it iconic 💅
Parameters
out— the stream where the dump is done.pnode— the parsing tree to dump.
🔍 ec_pnode_find — find a node from its identifier
const struct ec_pnode* ec_pnode_find (const struct ec_pnode * root, const char * id)Find a node from its identifier.
Find the first node in the parsing tree which has the given node identifier. The search is a depth-first search.
Parameters
root— the node of the parsing tree where the search starts.id— the node identifier string to match.
Returns
The first node matching the identifier, or NULL if not found. 🕵️♀️
🔎 ec_pnode_find_next — find the next node matching an identifier
const struct ec_pnode* ec_pnode_find_next (const struct ec_pnode * root, const struct ec_pnode * prev, const char * id, bool iter_children)Find the next node matching an identifier.
After a successful call to ec_pnode_find() or ec_pnode_find_next(), it is possible to get the next node that has the specified id. There are 2 options:
- continue the depth-first search where it was interrupted.
- skip the children of the current node, and continue the depth-first search.
Parameters
root— the root of the search, as passed toec_pnode_find().prev— the node returned by the previous search.id— the node identifier string to match.iter_children—trueto iterate the children ofprev,falseto skip them.
Returns
The next node matching the identifier, or NULL if not found. 🌈
🧮 ec_pnode_count — count node occurrences in a parse subtree
unsigned int ec_pnode_count (const struct ec_pnode * root, const char * id)Count node occurrences in a parse subtree.
Parameters
root— the node of the parsing tree where the search starts.id— the node identifier string to match.
Returns
The number of nodes matching the identifier. 🔢
📏 ec_pnode_len — get the number of strings in the parsed string vector
size_t ec_pnode_len (const struct ec_pnode * pnode)Get the number of strings in the parsed string vector.
Parameters
pnode— a node in the parsing tree.
Returns
The number of strings in the parsed string vector, or 0 if the node is NULL or has no string vector. 💖
✅ ec_pnode_matches — check if the parsing tree matches the input
bool ec_pnode_matches (const struct ec_pnode * pnode)Check if the parsing tree matches the input.
Parameters
pnode— a node in the parsing tree.
Returns
true if the parsing tree matches (has a string vector), false otherwise. 🫶✨
mwah 💋 this page was generated automatically by Doxygen for Libecoli from the source code — version 0.11.3, dated Thu Apr 9 2026, and it’s the ecoli_parse(3) girlies’ era. bye bestie, go parse something iconic 🎀🦋
📦 where this page comes from
- epel 9: libecoli-devel 0.11.3-1.el9 · BSD-3-Clause AND LicenseRef-Fedora-Public-Domain
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms