1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
34 typedef struct _GNode GNode;
36 /* Tree traverse flags */
39 G_TRAVERSE_LEAFS = 1 << 0,
40 G_TRAVERSE_NON_LEAFS = 1 << 1,
41 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
42 G_TRAVERSE_MASK = 0x03
45 /* Tree traverse orders */
54 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
56 typedef void (*GNodeForeachFunc) (GNode *node,
59 /* N-way tree implementation
70 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
71 ((GNode*) (node))->prev == NULL && \
72 ((GNode*) (node))->next == NULL)
73 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
75 void g_node_push_allocator (GAllocator *allocator);
76 void g_node_pop_allocator (void);
77 GNode* g_node_new (gpointer data);
78 void g_node_destroy (GNode *root);
79 void g_node_unlink (GNode *node);
80 GNode* g_node_copy (GNode *node);
81 GNode* g_node_insert (GNode *parent,
84 GNode* g_node_insert_before (GNode *parent,
87 GNode* g_node_prepend (GNode *parent,
89 guint g_node_n_nodes (GNode *root,
90 GTraverseFlags flags);
91 GNode* g_node_get_root (GNode *node);
92 gboolean g_node_is_ancestor (GNode *node,
94 guint g_node_depth (GNode *node);
95 GNode* g_node_find (GNode *root,
100 /* convenience macros */
101 #define g_node_append(parent, node) \
102 g_node_insert_before ((parent), NULL, (node))
103 #define g_node_insert_data(parent, position, data) \
104 g_node_insert ((parent), (position), g_node_new (data))
105 #define g_node_insert_data_before(parent, sibling, data) \
106 g_node_insert_before ((parent), (sibling), g_node_new (data))
107 #define g_node_prepend_data(parent, data) \
108 g_node_prepend ((parent), g_node_new (data))
109 #define g_node_append_data(parent, data) \
110 g_node_insert_before ((parent), NULL, g_node_new (data))
112 /* traversal function, assumes that `node' is root
113 * (only traverses `node' and its subtree).
114 * this function is just a high level interface to
115 * low level traversal functions, optimized for speed.
117 void g_node_traverse (GNode *root,
119 GTraverseFlags flags,
121 GNodeTraverseFunc func,
124 /* return the maximum tree height starting with `node', this is an expensive
125 * operation, since we need to visit all nodes. this could be shortened by
126 * adding `guint height' to struct _GNode, but then again, this is not very
127 * often needed, and would make g_node_insert() more time consuming.
129 guint g_node_max_height (GNode *root);
131 void g_node_children_foreach (GNode *node,
132 GTraverseFlags flags,
133 GNodeForeachFunc func,
135 void g_node_reverse_children (GNode *node);
136 guint g_node_n_children (GNode *node);
137 GNode* g_node_nth_child (GNode *node,
139 GNode* g_node_last_child (GNode *node);
140 GNode* g_node_find_child (GNode *node,
141 GTraverseFlags flags,
143 gint g_node_child_position (GNode *node,
145 gint g_node_child_index (GNode *node,
148 GNode* g_node_first_sibling (GNode *node);
149 GNode* g_node_last_sibling (GNode *node);
151 #define g_node_prev_sibling(node) ((node) ? \
152 ((GNode*) (node))->prev : NULL)
153 #define g_node_next_sibling(node) ((node) ? \
154 ((GNode*) (node))->next : NULL)
155 #define g_node_first_child(node) ((node) ? \
156 ((GNode*) (node))->children : NULL)
160 #endif /* __G_NODE_H__ */