GNode

typedef struct {
  gpointer data;
  GNode	  *next;
  GNode	  *prev;
  GNode	  *parent;
  GNode	  *children;
} GNode;

The GNode struct represents one node in a N-ary Tree. The data field contains the actual data of the node. The next and prev fields point to the node's siblings (a sibling is another GNode with the same parent). The parent field points to the parent of the GNode, or is NULL if the GNode is the root of the tree. The children field points to the first child of the GNode. The other children are accessed by using the next pointer of each child.

g_node_new ()

GNode*      g_node_new                      (gpointer data);

Creates a new GNode containing the given data. Used to create the first node in a tree.

g_node_copy ()

GNode*      g_node_copy                     (GNode *node);

Recursively copies a GNode (but does not deep-copy the data inside the nodes, see g_node_copy_deep() if you need that).

GCopyFunc ()

gpointer    (*GCopyFunc)                    (gconstpointer src,
                                             gpointer data);

A function of this signature is used to copy the node data when doing a deep-copy of a tree.

Since 2.4

g_node_copy_deep ()

GNode*      g_node_copy_deep                (GNode *node,
                                             GCopyFunc copy_func,
                                             gpointer data);

Recursively copies a GNode and its data.

Since 2.4

g_node_insert ()

GNode*      g_node_insert                   (GNode *parent,
                                             gint position,
                                             GNode *node);

Inserts a GNode beneath the parent at the given position.

g_node_insert_before ()

GNode*      g_node_insert_before            (GNode *parent,
                                             GNode *sibling,
                                             GNode *node);

Inserts a GNode beneath the parent before the given sibling.

g_node_insert_after ()

GNode*      g_node_insert_after             (GNode *parent,
                                             GNode *sibling,
                                             GNode *node);

Inserts a GNode beneath the parent after the given sibling.

g_node_append()

#define     g_node_append(parent, node)

Inserts a GNode as the last child of the given parent.

g_node_prepend ()

GNode*      g_node_prepend                  (GNode *parent,
                                             GNode *node);

Inserts a GNode as the first child of the given parent.

g_node_insert_data()

#define     g_node_insert_data(parent, position, data)

Inserts a new GNode at the given position.

g_node_insert_data_before()

#define     g_node_insert_data_before(parent, sibling, data)

Inserts a new GNode before the given sibling.

g_node_append_data()

#define     g_node_append_data(parent, data)

Inserts a new GNode as the last child of the given parent.

g_node_prepend_data()

#define     g_node_prepend_data(parent, data)

Inserts a new GNode as the first child of the given parent.

g_node_reverse_children ()

void        g_node_reverse_children         (GNode *node);

Reverses the order of the children of a GNode. (It doesn't change the order of the grandchildren.)

g_node_traverse ()

void        g_node_traverse                 (GNode *root,
                                             GTraverseType order,
                                             GTraverseFlags flags,
                                             gint max_depth,
                                             GNodeTraverseFunc func,
                                             gpointer data);

Traverses a tree starting at the given root GNode. It calls the given function for each node visited. The traversal can be halted at any point by returning TRUE from func.

enum GTraverseFlags

typedef enum
{
  G_TRAVERSE_LEAVES     = 1 << 0,
  G_TRAVERSE_NON_LEAVES = 1 << 1,
  G_TRAVERSE_ALL        = G_TRAVERSE_LEAVES | G_TRAVERSE_NON_LEAVES,
  G_TRAVERSE_MASK       = 0x03,
  G_TRAVERSE_LEAFS      = G_TRAVERSE_LEAVES,
  G_TRAVERSE_NON_LEAFS  = G_TRAVERSE_NON_LEAVES
} GTraverseFlags;

Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find().

GNodeTraverseFunc ()

gboolean    (*GNodeTraverseFunc)            (GNode *node,
                                             gpointer data);

Specifies the type of function passed to g_node_traverse(). The function is called with each of the nodes visited, together with the user data passed to g_node_traverse(). If the function returns TRUE, then the traversal is stopped.

g_node_children_foreach ()

void        g_node_children_foreach         (GNode *node,
                                             GTraverseFlags flags,
                                             GNodeForeachFunc func,
                                             gpointer data);

Calls a function for each of the children of a GNode. Note that it doesn't descend beneath the child nodes.

GNodeForeachFunc ()

void        (*GNodeForeachFunc)             (GNode *node,
                                             gpointer data);

Specifies the type of function passed to g_node_children_foreach(). The function is called with each child node, together with the user data passed to g_node_children_foreach().

g_node_get_root ()

GNode*      g_node_get_root                 (GNode *node);

Gets the root of a tree.

g_node_find ()

GNode*      g_node_find                     (GNode *root,
                                             GTraverseType order,
                                             GTraverseFlags flags,
                                             gpointer data);

Finds a GNode in a tree.

g_node_find_child ()

GNode*      g_node_find_child               (GNode *node,
                                             GTraverseFlags flags,
                                             gpointer data);

Finds the first child of a GNode with the given data.

g_node_child_index ()

gint        g_node_child_index              (GNode *node,
                                             gpointer data);

Gets the position of the first child of a GNode which contains the given data.

g_node_child_position ()

gint        g_node_child_position           (GNode *node,
                                             GNode *child);

Gets the position of a GNode with respect to its siblings. child must be a child of node. The first child is numbered 0, the second 1, and so on.

g_node_first_child()

#define     g_node_first_child(node)

Gets the first child of a GNode.

g_node_last_child ()

GNode*      g_node_last_child               (GNode *node);

Gets the last child of a GNode.

g_node_nth_child ()

GNode*      g_node_nth_child                (GNode *node,
                                             guint n);

Gets a child of a GNode, using the given index. The first child is at index 0. If the index is too big, NULL is returned.

g_node_first_sibling ()

GNode*      g_node_first_sibling            (GNode *node);

Gets the first sibling of a GNode. This could possibly be the node itself.

g_node_next_sibling()

#define     g_node_next_sibling(node)

Gets the next sibling of a GNode.

g_node_prev_sibling()

#define     g_node_prev_sibling(node)

Gets the previous sibling of a GNode.

g_node_last_sibling ()

GNode*      g_node_last_sibling             (GNode *node);

Gets the last sibling of a GNode. This could possibly be the node itself.

G_NODE_IS_LEAF()

#define	 G_NODE_IS_LEAF(node)	(((GNode*) (node))->children == NULL)

Returns TRUE if a GNode is a leaf node.

G_NODE_IS_ROOT()

#define     G_NODE_IS_ROOT(node)

Returns TRUE if a GNode is the root of a tree.

g_node_depth ()

guint       g_node_depth                    (GNode *node);

Gets the depth of a GNode.

If node is NULL the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on.

g_node_n_nodes ()

guint       g_node_n_nodes                  (GNode *root,
                                             GTraverseFlags flags);

Gets the number of nodes in a tree.

g_node_n_children ()

guint       g_node_n_children               (GNode *node);

Gets the number of children of a GNode.

g_node_is_ancestor ()

gboolean    g_node_is_ancestor              (GNode *node,
                                             GNode *descendant);

Returns TRUE if node is an ancestor of descendant. This is true if node is the parent of descendant, or if node is the grandparent of descendant etc.

g_node_max_height ()

guint       g_node_max_height               (GNode *root);

Gets the maximum height of all branches beneath a GNode. This is the maximum distance from the GNode to all leaf nodes.

If root is NULL, 0 is returned. If root has no children, 1 is returned. If root has children, 2 is returned. And so on.

g_node_unlink ()

void        g_node_unlink                   (GNode *node);

Unlinks a GNode from a tree, resulting in two separate trees.

g_node_destroy ()

void        g_node_destroy                  (GNode *root);

Removes the GNode and its children from the tree, freeing any memory allocated.

g_node_push_allocator ()

void        g_node_push_allocator           (gpointer dummy);

Sets the allocator to use to allocate GNode elements. Use g_node_pop_allocator() to restore the previous allocator.

Note that this function is not available if GLib has been compiled with --disable-mem-pools

g_node_pop_allocator ()

void        g_node_pop_allocator            (void);

Restores the previous GAllocator, used when allocating GNode elements.

Note that this function is not available if GLib has been compiled with --disable-mem-pools