mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-07 13:16:18 +01:00
2e7931c760
The basic API that this commit adds allows in-order iterating over a GTree. For this the following API were implemented or exported: 1) Returning the first or the last node in the tree, 2) Taking a pointer to a node in the tree and returning the previous or the next in-order node, 3) Allowing to do a binary search for a particular key value and returning the pointer to its node, 4) Returning the newly inserted or set node from both insert and replace functions, so this node is immediately available and does not have to be looked up, 5) Traversing the tree in-order providing a node pointer to the caller-provided traversal function. Most of the above functions were already present in the code, but they returned the value that is stored at a particular node instead of the pointer to the node itself. So most of the code for these new API calls is shared with these existing ones, just adapted to return the pointer to the node. Additionally, the so called "lower bound" and "upper bound" operations were implemented. The first one returns the first element that is greater than or equal to the searched key, while the second returns the first element that is strictly greater than the searched key. Signed-off-by: Maciej S. Szmigiero <maciej.szmigiero@oracle.com>
176 lines
6.3 KiB
C
176 lines
6.3 KiB
C
/* GLIB - Library of useful routines for C programming
|
|
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
* Modified by the GLib Team and others 1997-2000. See the AUTHORS
|
|
* file for a list of people on the GLib Team. See the ChangeLog
|
|
* files for a list of changes. These files are distributed with
|
|
* GLib at ftp://ftp.gtk.org/pub/gtk/.
|
|
*/
|
|
|
|
#ifndef __G_TREE_H__
|
|
#define __G_TREE_H__
|
|
|
|
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
|
|
#error "Only <glib.h> can be included directly."
|
|
#endif
|
|
|
|
#include <glib/gnode.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#undef G_TREE_DEBUG
|
|
|
|
typedef struct _GTree GTree;
|
|
|
|
/**
|
|
* GTreeNode:
|
|
*
|
|
* An opaque type which identifies a specific node in a #GTree.
|
|
*
|
|
* Since: 2.68
|
|
*/
|
|
typedef struct _GTreeNode GTreeNode;
|
|
|
|
typedef gboolean (*GTraverseFunc) (gpointer key,
|
|
gpointer value,
|
|
gpointer data);
|
|
|
|
/**
|
|
* GTraverseNodeFunc:
|
|
* @node: a #GTreeNode
|
|
* @data: user data passed to g_tree_foreach_node()
|
|
*
|
|
* Specifies the type of function passed to g_tree_foreach_node(). It is
|
|
* passed each node, together with the @user_data parameter passed to
|
|
* g_tree_foreach_node(). If the function returns %TRUE, the traversal is
|
|
* stopped.
|
|
*
|
|
* Returns: %TRUE to stop the traversal
|
|
* Since: 2.68
|
|
*/
|
|
typedef gboolean (*GTraverseNodeFunc) (GTreeNode *node,
|
|
gpointer data);
|
|
|
|
/* Balanced binary trees
|
|
*/
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GTree* g_tree_new (GCompareFunc key_compare_func);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GTree* g_tree_new_with_data (GCompareDataFunc key_compare_func,
|
|
gpointer key_compare_data);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GTree* g_tree_new_full (GCompareDataFunc key_compare_func,
|
|
gpointer key_compare_data,
|
|
GDestroyNotify key_destroy_func,
|
|
GDestroyNotify value_destroy_func);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_node_first (GTree *tree);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_node_last (GTree *tree);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_node_previous (GTreeNode *node);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_node_next (GTreeNode *node);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GTree* g_tree_ref (GTree *tree);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_tree_unref (GTree *tree);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_tree_destroy (GTree *tree);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_insert_node (GTree *tree,
|
|
gpointer key,
|
|
gpointer value);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_tree_insert (GTree *tree,
|
|
gpointer key,
|
|
gpointer value);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_replace_node (GTree *tree,
|
|
gpointer key,
|
|
gpointer value);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_tree_replace (GTree *tree,
|
|
gpointer key,
|
|
gpointer value);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_tree_remove (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_tree_steal (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
gpointer g_tree_node_key (GTreeNode *node);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
gpointer g_tree_node_value (GTreeNode *node);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_lookup_node (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gpointer g_tree_lookup (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_tree_lookup_extended (GTree *tree,
|
|
gconstpointer lookup_key,
|
|
gpointer *orig_key,
|
|
gpointer *value);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_tree_foreach (GTree *tree,
|
|
GTraverseFunc func,
|
|
gpointer user_data);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
void g_tree_foreach_node (GTree *tree,
|
|
GTraverseNodeFunc func,
|
|
gpointer user_data);
|
|
|
|
GLIB_DEPRECATED
|
|
void g_tree_traverse (GTree *tree,
|
|
GTraverseFunc traverse_func,
|
|
GTraverseType traverse_type,
|
|
gpointer user_data);
|
|
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_search_node (GTree *tree,
|
|
GCompareFunc search_func,
|
|
gconstpointer user_data);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gpointer g_tree_search (GTree *tree,
|
|
GCompareFunc search_func,
|
|
gconstpointer user_data);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_lower_bound (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_2_68
|
|
GTreeNode *g_tree_upper_bound (GTree *tree,
|
|
gconstpointer key);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gint g_tree_height (GTree *tree);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gint g_tree_nnodes (GTree *tree);
|
|
|
|
#ifdef G_TREE_DEBUG
|
|
/*< private >*/
|
|
#ifndef __GTK_DOC_IGNORE__
|
|
void g_tree_dump (GTree *tree);
|
|
#endif /* !__GTK_DOC_IGNORE__ */
|
|
#endif /* G_TREE_DEBUG */
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_TREE_H__ */
|