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/.
30 #include <glib/gmem.h>
34 typedef struct _GNode GNode;
36 /* Tree traverse flags */
39 G_TRAVERSE_LEAVES = 1 << 0,
40 G_TRAVERSE_NON_LEAVES = 1 << 1,
41 G_TRAVERSE_ALL = G_TRAVERSE_LEAVES | G_TRAVERSE_NON_LEAVES,
42 G_TRAVERSE_MASK = 0x03,
43 G_TRAVERSE_LEAFS = G_TRAVERSE_LEAVES,
44 G_TRAVERSE_NON_LEAFS = G_TRAVERSE_NON_LEAVES
47 /* Tree traverse orders */
56 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
58 typedef void (*GNodeForeachFunc) (GNode *node,
63 * @src: A pointer to the data which should be copied
64 * @data: Additional data
66 * A function of this signature is used to copy the node data
67 * when doing a deep-copy of a tree.
69 * Returns: A pointer to the copy
73 typedef gpointer (*GCopyFunc) (gconstpointer src,
76 /* N-way tree implementation
91 * Returns %TRUE if a #GNode is the root of a tree.
93 * Returns: %TRUE if the #GNode is the root of a tree
94 * (i.e. it has no parent or siblings)
96 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
97 ((GNode*) (node))->prev == NULL && \
98 ((GNode*) (node))->next == NULL)
104 * Returns %TRUE if a #GNode is a leaf node.
106 * Returns: %TRUE if the #GNode is a leaf node
107 * (i.e. it has no children)
109 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
111 GNode* g_node_new (gpointer data);
112 void g_node_destroy (GNode *root);
113 void g_node_unlink (GNode *node);
114 GNode* g_node_copy_deep (GNode *node,
117 GNode* g_node_copy (GNode *node);
118 GNode* g_node_insert (GNode *parent,
121 GNode* g_node_insert_before (GNode *parent,
124 GNode* g_node_insert_after (GNode *parent,
127 GNode* g_node_prepend (GNode *parent,
129 guint g_node_n_nodes (GNode *root,
130 GTraverseFlags flags);
131 GNode* g_node_get_root (GNode *node);
132 gboolean g_node_is_ancestor (GNode *node,
134 guint g_node_depth (GNode *node);
135 GNode* g_node_find (GNode *root,
137 GTraverseFlags flags,
140 /* convenience macros */
143 * @parent: the #GNode to place the new #GNode under
144 * @node: the #GNode to insert
146 * Inserts a #GNode as the last child of the given parent.
148 * Returns: the inserted #GNode
150 #define g_node_append(parent, node) \
151 g_node_insert_before ((parent), NULL, (node))
154 * g_node_insert_data:
155 * @parent: the #GNode to place the new #GNode under
156 * @position: the position to place the new #GNode at. If position is -1,
157 * the new #GNode is inserted as the last child of @parent
158 * @data: the data for the new #GNode
160 * Inserts a new #GNode at the given position.
162 * Returns: the new #GNode
164 #define g_node_insert_data(parent, position, data) \
165 g_node_insert ((parent), (position), g_node_new (data))
168 * g_node_insert_data_before:
169 * @parent: the #GNode to place the new #GNode under
170 * @sibling: the sibling #GNode to place the new #GNode before
171 * @data: the data for the new #GNode
173 * Inserts a new #GNode before the given sibling.
175 * Returns: the new #GNode
177 #define g_node_insert_data_before(parent, sibling, data) \
178 g_node_insert_before ((parent), (sibling), g_node_new (data))
181 * g_node_prepend_data:
182 * @parent: the #GNode to place the new #GNode under
183 * @data: the data for the new #GNode
185 * Inserts a new #GNode as the first child of the given parent.
187 * Returns: the new #GNode
189 #define g_node_prepend_data(parent, data) \
190 g_node_prepend ((parent), g_node_new (data))
193 * g_node_append_data:
194 * @parent: the #GNode to place the new #GNode under
195 * @data: the data for the new #GNode
197 * Inserts a new #GNode as the last child of the given parent.
199 * Returns: the new #GNode
201 #define g_node_append_data(parent, data) \
202 g_node_insert_before ((parent), NULL, g_node_new (data))
204 /* traversal function, assumes that `node' is root
205 * (only traverses `node' and its subtree).
206 * this function is just a high level interface to
207 * low level traversal functions, optimized for speed.
209 void g_node_traverse (GNode *root,
211 GTraverseFlags flags,
213 GNodeTraverseFunc func,
216 /* return the maximum tree height starting with `node', this is an expensive
217 * operation, since we need to visit all nodes. this could be shortened by
218 * adding `guint height' to struct _GNode, but then again, this is not very
219 * often needed, and would make g_node_insert() more time consuming.
221 guint g_node_max_height (GNode *root);
223 void g_node_children_foreach (GNode *node,
224 GTraverseFlags flags,
225 GNodeForeachFunc func,
227 void g_node_reverse_children (GNode *node);
228 guint g_node_n_children (GNode *node);
229 GNode* g_node_nth_child (GNode *node,
231 GNode* g_node_last_child (GNode *node);
232 GNode* g_node_find_child (GNode *node,
233 GTraverseFlags flags,
235 gint g_node_child_position (GNode *node,
237 gint g_node_child_index (GNode *node,
240 GNode* g_node_first_sibling (GNode *node);
241 GNode* g_node_last_sibling (GNode *node);
244 * g_node_prev_sibling:
247 * Gets the previous sibling of a #GNode.
249 * Returns: the previous sibling of @node, or %NULL if @node is %NULL
251 #define g_node_prev_sibling(node) ((node) ? \
252 ((GNode*) (node))->prev : NULL)
255 * g_node_next_sibling:
258 * Gets the next sibling of a #GNode.
260 * Returns: the next sibling of @node, or %NULL if @node is %NULL
262 #define g_node_next_sibling(node) ((node) ? \
263 ((GNode*) (node))->next : NULL)
266 * g_node_first_child:
269 * Gets the first child of a #GNode.
271 * Returns: the first child of @node, or %NULL if @node is %NULL
274 #define g_node_first_child(node) ((node) ? \
275 ((GNode*) (node))->children : NULL)
277 #ifndef G_DISABLE_DEPRECATED
278 void g_node_push_allocator (gpointer dummy);
279 void g_node_pop_allocator (void);
283 #endif /* __G_NODE_H__ */