ecoli_node_seq - Man Page

Name

ecoli_node_seq — Sequence node

— A node that matches a sequence of child nodes in order.  

Synopsis

Macros

#define EC_NODE_SEQ(args...)

Functions

struct ec_node * ec_node_seq (const char *id)
int ec_node_seq_add (struct ec_node *node, struct ec_node *child)

Detailed Description

A node that matches a sequence of child nodes in order.

Configuration Schema

schema seq {
    list children  {
        description "The list of children nodes, to be parsed in sequence.";

        node  {
            description "A child node which is part of the sequence.";
        }
    }
}

Macro Definition Documentation

#define EC_NODE_SEQ( args...)

Value:

__ec_node_seq(args, EC_VA_END)

Create a sequence node from a list of child nodes.

All child nodes passed as arguments are consumed and will be freed when the sequence node is freed, or immediately on error.

Example:

EC_NODE_SEQ("myseq", child1, child2, child3)

Definition at line 29 of file node_seq.h.

Function Documentation

struct ec_node * ec_node_seq (const char * id)

Create an empty sequence node.

Use ec_node_seq_add() to add children.

Parameters

id The node identifier.

Returns

The node, or NULL on error (errno is set).

int ec_node_seq_add (struct ec_node * node, struct ec_node * child)

Add a child to a sequence node.

Parameters

node The sequence node.
child The child node to add. It is consumed and will be freed when the parent is freed, or immediately on error.

Returns

0 on success, -1 on error (errno is set).

Author

Generated automatically by Doxygen for Libecoli from the source code.

Referenced By

The man pages ec_node_seq(3), EC_NODE_SEQ(3) and ec_node_seq_add(3) are aliases of ecoli_node_seq(3).

Version 0.11.3 Libecoli