glib/gnode.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_NODE_H__
  32 #define __G_NODE_H__
  33
  34 #include <glib/gmem.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GNode           GNode;
  39
  40 /* Tree traverse flags */
  41 typedef enum
  42 {
  43   G_TRAVERSE_LEAVES     = 1 << 0,
  44   G_TRAVERSE_NON_LEAVES = 1 << 1,
  45   G_TRAVERSE_ALL        = G_TRAVERSE_LEAVES | G_TRAVERSE_NON_LEAVES,
  46   G_TRAVERSE_MASK       = 0x03,
  47   G_TRAVERSE_LEAFS      = G_TRAVERSE_LEAVES,
  48   G_TRAVERSE_NON_LEAFS  = G_TRAVERSE_NON_LEAVES
  49 } GTraverseFlags;
  50
  51 /* Tree traverse orders */
  52 typedef enum
  53 {
  54   G_IN_ORDER,
  55   G_PRE_ORDER,
  56   G_POST_ORDER,
  57   G_LEVEL_ORDER
  58 } GTraverseType;
  59
  60 typedef gboolean        (*GNodeTraverseFunc)    (GNode         *node,
  61                                                  gpointer       data);
  62 typedef void            (*GNodeForeachFunc)     (GNode         *node,
  63                                                  gpointer       data);
  64
  65 /**
  66  * GCopyFunc:
  67  * @src: A pointer to the data which should be copied
  68  * @data: Additional data
  69  *
  70  * A function of this signature is used to copy the node data
  71  * when doing a deep-copy of a tree.
  72  *
  73  * Returns: A pointer to the copy
  74  *
  75  * Since: 2.4
  76  */
  77 typedef gpointer        (*GCopyFunc)            (gconstpointer  src,
  78                                                  gpointer       data);
  79
  80 /* N-way tree implementation
  81  */
  82 struct _GNode
  83 {
  84   gpointer data;
  85   GNode   *next;
  86   GNode   *prev;
  87   GNode   *parent;
  88   GNode   *children;
  89 };
  90
  91 /**
  92  * G_NODE_IS_ROOT:
  93  * @node: a #GNode
  94  *
  95  * Returns %TRUE if a #GNode is the root of a tree.
  96  *
  97  * Returns: %TRUE if the #GNode is the root of a tree
  98  *     (i.e. it has no parent or siblings)
  99  */
 100 #define  G_NODE_IS_ROOT(node)   (((GNode*) (node))->parent == NULL && \
 101                                  ((GNode*) (node))->prev == NULL && \
 102                                  ((GNode*) (node))->next == NULL)
 103
 104 /**
 105  * G_NODE_IS_LEAF:
 106  * @node: a #GNode
 107  *
 108  * Returns %TRUE if a #GNode is a leaf node.
 109  *
 110  * Returns: %TRUE if the #GNode is a leaf node
 111  *     (i.e. it has no children)
 112  */
 113 #define  G_NODE_IS_LEAF(node)   (((GNode*) (node))->children == NULL)
 114
 115 GNode*   g_node_new             (gpointer          data);
 116 void     g_node_destroy         (GNode            *root);
 117 void     g_node_unlink          (GNode            *node);
 118 GNode*   g_node_copy_deep       (GNode            *node,
 119                                  GCopyFunc         copy_func,
 120                                  gpointer          data);
 121 GNode*   g_node_copy            (GNode            *node);
 122 GNode*   g_node_insert          (GNode            *parent,
 123                                  gint              position,
 124                                  GNode            *node);
 125 GNode*   g_node_insert_before   (GNode            *parent,
 126                                  GNode            *sibling,
 127                                  GNode            *node);
 128 GNode*   g_node_insert_after    (GNode            *parent,
 129                                  GNode            *sibling,
 130                                  GNode            *node);
 131 GNode*   g_node_prepend         (GNode            *parent,
 132                                  GNode            *node);
 133 guint    g_node_n_nodes         (GNode            *root,
 134                                  GTraverseFlags    flags);
 135 GNode*   g_node_get_root        (GNode            *node);
 136 gboolean g_node_is_ancestor     (GNode            *node,
 137                                  GNode            *descendant);
 138 guint    g_node_depth           (GNode            *node);
 139 GNode*   g_node_find            (GNode            *root,
 140                                  GTraverseType     order,
 141                                  GTraverseFlags    flags,
 142                                  gpointer          data);
 143
 144 /* convenience macros */
 145 /**
 146  * g_node_append:
 147  * @parent: the #GNode to place the new #GNode under
 148  * @node: the #GNode to insert
 149  *
 150  * Inserts a #GNode as the last child of the given parent.
 151  *
 152  * Returns: the inserted #GNode
 153  */
 154 #define g_node_append(parent, node)                             \
 155      g_node_insert_before ((parent), NULL, (node))
 156
 157 /**
 158  * g_node_insert_data:
 159  * @parent: the #GNode to place the new #GNode under
 160  * @position: the position to place the new #GNode at. If position is -1,
 161  *     the new #GNode is inserted as the last child of @parent
 162  * @data: the data for the new #GNode
 163  *
 164  * Inserts a new #GNode at the given position.
 165  *
 166  * Returns: the new #GNode
 167  */
 168 #define g_node_insert_data(parent, position, data)              \
 169      g_node_insert ((parent), (position), g_node_new (data))
 170
 171 /**
 172  * g_node_insert_data_after:
 173  * @parent: the #GNode to place the new #GNode under
 174  * @sibling: the sibling #GNode to place the new #GNode after
 175  * @data: the data for the new #GNode
 176  *
 177  * Inserts a new #GNode after the given sibling.
 178  *
 179  * Returns: the new #GNode
 180  */
 181
 182 #define g_node_insert_data_after(parent, sibling, data) \
 183      g_node_insert_after ((parent), (sibling), g_node_new (data))
 184 /**
 185  * g_node_insert_data_before:
 186  * @parent: the #GNode to place the new #GNode under
 187  * @sibling: the sibling #GNode to place the new #GNode before
 188  * @data: the data for the new #GNode
 189  *
 190  * Inserts a new #GNode before the given sibling.
 191  *
 192  * Returns: the new #GNode
 193  */
 194 #define g_node_insert_data_before(parent, sibling, data)        \
 195      g_node_insert_before ((parent), (sibling), g_node_new (data))
 196
 197 /**
 198  * g_node_prepend_data:
 199  * @parent: the #GNode to place the new #GNode under
 200  * @data: the data for the new #GNode
 201  *
 202  * Inserts a new #GNode as the first child of the given parent.
 203  *
 204  * Returns: the new #GNode
 205  */
 206 #define g_node_prepend_data(parent, data)                       \
 207      g_node_prepend ((parent), g_node_new (data))
 208
 209 /**
 210  * g_node_append_data:
 211  * @parent: the #GNode to place the new #GNode under
 212  * @data: the data for the new #GNode
 213  *
 214  * Inserts a new #GNode as the last child of the given parent.
 215  *
 216  * Returns: the new #GNode
 217  */
 218 #define g_node_append_data(parent, data)                        \
 219      g_node_insert_before ((parent), NULL, g_node_new (data))
 220
 221 /* traversal function, assumes that `node' is root
 222  * (only traverses `node' and its subtree).
 223  * this function is just a high level interface to
 224  * low level traversal functions, optimized for speed.
 225  */
 226 void     g_node_traverse        (GNode            *root,
 227                                  GTraverseType     order,
 228                                  GTraverseFlags    flags,
 229                                  gint              max_depth,
 230                                  GNodeTraverseFunc func,
 231                                  gpointer          data);
 232
 233 /* return the maximum tree height starting with `node', this is an expensive
 234  * operation, since we need to visit all nodes. this could be shortened by
 235  * adding `guint height' to struct _GNode, but then again, this is not very
 236  * often needed, and would make g_node_insert() more time consuming.
 237  */
 238 guint    g_node_max_height       (GNode *root);
 239
 240 void     g_node_children_foreach (GNode           *node,
 241                                   GTraverseFlags   flags,
 242                                   GNodeForeachFunc func,
 243                                   gpointer         data);
 244 void     g_node_reverse_children (GNode           *node);
 245 guint    g_node_n_children       (GNode           *node);
 246 GNode*   g_node_nth_child        (GNode           *node,
 247                                   guint            n);
 248 GNode*   g_node_last_child       (GNode           *node);
 249 GNode*   g_node_find_child       (GNode           *node,
 250                                   GTraverseFlags   flags,
 251                                   gpointer         data);
 252 gint     g_node_child_position   (GNode           *node,
 253                                   GNode           *child);
 254 gint     g_node_child_index      (GNode           *node,
 255                                   gpointer         data);
 256
 257 GNode*   g_node_first_sibling    (GNode           *node);
 258 GNode*   g_node_last_sibling     (GNode           *node);
 259
 260 /**
 261  * g_node_prev_sibling:
 262  * @node: a #GNode
 263  *
 264  * Gets the previous sibling of a #GNode.
 265  *
 266  * Returns: the previous sibling of @node, or %NULL if @node is the first
 267  *     node or %NULL
 268  */
 269 #define  g_node_prev_sibling(node)      ((node) ? \
 270                                          ((GNode*) (node))->prev : NULL)
 271
 272 /**
 273  * g_node_next_sibling:
 274  * @node: a #GNode
 275  *
 276  * Gets the next sibling of a #GNode.
 277  *
 278  * Returns: the next sibling of @node, or %NULL if @node is the last node
 279  *     or %NULL
 280  */
 281 #define  g_node_next_sibling(node)      ((node) ? \
 282                                          ((GNode*) (node))->next : NULL)
 283
 284 /**
 285  * g_node_first_child:
 286  * @node: a #GNode
 287  *
 288  * Gets the first child of a #GNode.
 289  *
 290  * Returns: the first child of @node, or %NULL if @node is %NULL
 291  *     or has no children
 292  */
 293 #define  g_node_first_child(node)       ((node) ? \
 294                                          ((GNode*) (node))->children : NULL)
 295
 296 G_END_DECLS
 297
 298 #endif /* __G_NODE_H__ */