luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-08 13:36:22 +01:00
Code Issues Packages Projects Releases Wiki Activity
93dd614562
glib/glib/gtree.h

176 lines
6.3 KiB
C
Raw Normal View History

Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
/* 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
glib/: LGPLv2+ -> LGPLv2.1+ All glib/*.{c,h} files have been processed, as well as gtester-report. 12 of those files are not licensed under LGPL: gbsearcharray.h gconstructor.h glibintl.h gmirroringtable.h gscripttable.h gtranslit-data.h gunibreak.h gunichartables.h gunicomp.h gunidecomp.h valgrind.h win_iconv.c Some of them are generated files, some are licensed under a BSD-style license and win_iconv.c is in the public domain. Sub-directories inside glib/: deprecated/: processed in a previous commit glib-mirroring-tab/: already LGPLv2.1+ gnulib/: not modified, the code is copied from gnulib libcharset/: a copy pcre/: a copy tests/: processed in a previous commit https://bugzilla.gnome.org/show_bug.cgi?id=776504
2017-01-05 12:47:07 +01:00
* version 2.1 of the License, or (at your option) any later version.
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
*
* 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
Updated FSF's address
2014-01-23 12:58:29 +01:00
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
*/
/*
* 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
make it possible to disable single-file includes by defining 2008-03-14 Michael Natterer <mitch@imendio.com> * glib/*.h: make it possible to disable single-file includes by defining G_DISABLE_SINGLE_INCLUDES when building against GLib. Approved by Tim Janik. * glib/glib.h: include <glib/gslice.h>. * glib/gi18n.h * glib/gi18n-lib.h * glib/gprintf.h: include <glib.h> so the above works when these files are included without including <glib.h> first. svn path=/trunk/; revision=6713
2008-03-14 20:30:38 +01:00
* GLib at ftp://ftp.gtk.org/pub/gtk/.
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
*/
Move single-include guards inside include guards gcc has optimizations for include guards that only work if they are outermost in the the header. https://bugzilla.gnome.org/show_bug.cgi?id=689810
2012-12-28 05:43:14 +01:00
#ifndef __G_TREE_H__
#define __G_TREE_H__
Make single includes mandatory This has been the official line since 2.17, which seems plenty long enough for a transition phase.
2011-10-12 06:24:46 +02:00
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
make it possible to disable single-file includes by defining 2008-03-14 Michael Natterer <mitch@imendio.com> * glib/*.h: make it possible to disable single-file includes by defining G_DISABLE_SINGLE_INCLUDES when building against GLib. Approved by Tim Janik. * glib/glib.h: include <glib/gslice.h>. * glib/gi18n.h * glib/gi18n-lib.h * glib/gprintf.h: include <glib.h> so the above works when these files are included without including <glib.h> first. svn path=/trunk/; revision=6713
2008-03-14 20:30:38 +01:00
#error "Only <glib.h> can be included directly."
#endif
Move glib library into a subdirectory, make all GLib include files include Tue Jun 26 11:43:46 2001 Owen Taylor <otaylor@redhat.com> * configure.in Makefile.am *.[ch] glib/*.[ch] glib/Makefile.am: Move glib library into a subdirectory, make all GLib include files include as <glib/glist.h> * tests/testglib.c tests/testgdate.c tests/testgdateparser.c tests/timeloop.c tests/timeloop-basic.c: Move all tests into the tests/ subdirectory.
2001-06-26 18:01:21 +02:00
#include <glib/gnode.h>
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
G_BEGIN_DECLS
GTree: debugging improvements * Add a debug assert checking whether we have really removed all nodes in g_tree_remove_all(), * Print a "LEFT" and "RIGHT" headers before printing a particular tree branch in g_tree_node_dump(), * Make the whole thing actually buildable again in the debug mode by conditionally providing g_tree_dump() declaration in glib/gtree.h. Signed-off-by: Maciej S. Szmigiero <maciej.szmigiero@oracle.com>
2020-08-04 21:23:54 +02:00
#undef G_TREE_DEBUG
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
typedef struct _GTree GTree;
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
/**
* GTreeNode:
*
* An opaque type which identifies a specific node in a #GTree.
*
* Since: 2.68
*/
typedef struct _GTreeNode GTreeNode;
Use gboolean for return value of GTraverseFunc. * glib/gtree.h: Use gboolean for return value of GTraverseFunc.
2001-09-26 01:15:53 +02:00
typedef gboolean (*GTraverseFunc) (gpointer key,
gpointer value,
gpointer data);
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
/**
* 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);
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
/* Balanced binary trees
*/
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
GTree* g_tree_new (GCompareFunc key_compare_func);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
GTree* g_tree_new_with_data (GCompareDataFunc key_compare_func,
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
gpointer key_compare_data);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
GTree* g_tree_new_full (GCompareDataFunc key_compare_func,
gpointer key_compare_data,
GDestroyNotify key_destroy_func,
GDestroyNotify value_destroy_func);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
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);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
GTree: switch to GSlice, add refcounts (#587773)
2009-07-05 13:30:54 +02:00
GTree* g_tree_ref (GTree *tree);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
GTree: switch to GSlice, add refcounts (#587773)
2009-07-05 13:30:54 +02:00
void g_tree_unref (GTree *tree);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
void g_tree_destroy (GTree *tree);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
GLIB_AVAILABLE_IN_2_68
GTreeNode *g_tree_insert_node (GTree *tree,
gpointer key,
gpointer value);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
void g_tree_insert (GTree *tree,
gpointer key,
gpointer value);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
GLIB_AVAILABLE_IN_2_68
GTreeNode *g_tree_replace_node (GTree *tree,
gpointer key,
gpointer value);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
void g_tree_replace (GTree *tree,
gpointer key,
gpointer value);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
Check the return values of g_tree_remove(). 2005-05-17 Matthias Clasen <mclasen@redhat.com> * tests/tree-test.c (main): Check the return values of g_tree_remove(). * glib/gtree.c (g_tree_remove, g_tree_steal): Return a boolean indicating wether the key was found. (#302545, Matthew F. Barnes)
2005-05-17 17:33:36 +02:00
gboolean g_tree_remove (GTree *tree,
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gconstpointer key);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
Check the return values of g_tree_remove(). 2005-05-17 Matthias Clasen <mclasen@redhat.com> * tests/tree-test.c (main): Check the return values of g_tree_remove(). * glib/gtree.c (g_tree_remove, g_tree_steal): Return a boolean indicating wether the key was found. (#302545, Matthew F. Barnes)
2005-05-17 17:33:36 +02:00
gboolean g_tree_steal (GTree *tree,
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
gconstpointer key);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
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);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gpointer g_tree_lookup (GTree *tree,
gconstpointer key);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gboolean g_tree_lookup_extended (GTree *tree,
gconstpointer lookup_key,
gpointer *orig_key,
gpointer *value);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
void g_tree_foreach (GTree *tree,
GTraverseFunc func,
gpointer user_data);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
GLIB_AVAILABLE_IN_2_68
void g_tree_foreach_node (GTree *tree,
GTraverseNodeFunc func,
gpointer user_data);
Mark g_tree_traverse() as deprecated. (#65343) * glib/gtree.h: Mark g_tree_traverse() as deprecated. (#65343) * glib/gtree.c (g_tree_traverse): Explain the deprecation in some detail.
2001-11-26 20:01:08 +01:00
Use GLIB_DEPRECATED instead of G_GNUC_DEPRECATED in our headers This will let others opt out of seeing GLib deprecation warnings by defining GLIB_DISABLE_DEPRECATION_WARNINGS. https://bugzilla.gnome.org/show_bug.cgi?id=661438
2011-10-11 08:34:59 +02:00
GLIB_DEPRECATED
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
void g_tree_traverse (GTree *tree,
GTraverseFunc traverse_func,
GTraverseType traverse_type,
Use GLIB_DEPRECATED instead of G_GNUC_DEPRECATED in our headers This will let others opt out of seeing GLib deprecation warnings by defining GLIB_DISABLE_DEPRECATION_WARNINGS. https://bugzilla.gnome.org/show_bug.cgi?id=661438
2011-10-11 08:34:59 +02:00
gpointer user_data);
Mark g_tree_traverse() as deprecated. (#65343) * glib/gtree.h: Mark g_tree_traverse() as deprecated. (#65343) * glib/gtree.c (g_tree_traverse): Explain the deprecation in some detail.
2001-11-26 20:01:08 +01:00
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
GLIB_AVAILABLE_IN_2_68
GTreeNode *g_tree_search_node (GTree *tree,
GCompareFunc search_func,
gconstpointer user_data);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gpointer g_tree_search (GTree *tree,
GCompareFunc search_func,
fixed a typo in a comment. 2001-05-04 Sven Neumann <sven@convergence.de> * ghash.c: fixed a typo in a comment. * gtree.[ch]: added new functions g_tree_new_full(), g_tree_replace(), g_tree_steal() and g_tree_foreach() to adapt GTree to the GHashTable API. Moved comments into the C file. * docs/reference/glib/glib-sections.txt * docs/reference/glib/tmpl/glib-unused.sgml * docs/reference/glib/tmpl/hash_tables.sgml * docs/reference/glib/tmpl/linked_lists_double.sgml * docs/reference/glib/tmpl/linked_lists_single.sgml * docs/reference/glib/tmpl/macros_misc.sgml * docs/reference/glib/tmpl/trees-binary.sgml: updated documentation
2001-05-04 19:01:56 +02:00
gconstpointer user_data);
GTree: add an ability to iterate over a tree and a node-based API 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>
2020-08-04 21:31:36 +02:00
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);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gint g_tree_height (GTree *tree);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
added new function g_tree_lookup_extended(). 2001-03-08 Sven Neumann <sven@gimp.org> * gtree.[ch]: * docs/reference/glib/tmpl/trees-binary.sgml: added new function g_tree_lookup_extended().
2001-03-08 18:51:39 +01:00
gint g_tree_nnodes (GTree *tree);
Patch from David Benson <daveb@idealab.com> to add user_data support to Mon Nov 20 18:55:17 2000 Jonathan Blandford <jrb@redhat.com> * gtree.[hc]: Patch from David Benson <daveb@idealab.com> to add user_data support to gtree functions. Mon Nov 13 18:35:52 2000 Jonathan Blandford <jrb@redhat.com> * gtypes.h (GCompareFuncData): new func type to let you use user data when comparing nodes. * gslist.c (g_list_sort_with_data): new function to sort with user_data. * glist.c (g_list_sort_with_data): new function to sort with user_data. * garray.[ch]: Added convenience functions to sort arrays.
2000-11-21 00:59:32 +01:00
GTree: debugging improvements * Add a debug assert checking whether we have really removed all nodes in g_tree_remove_all(), * Print a "LEFT" and "RIGHT" headers before printing a particular tree branch in g_tree_node_dump(), * Make the whole thing actually buildable again in the debug mode by conditionally providing g_tree_dump() declaration in glib/gtree.h. Signed-off-by: Maciej S. Szmigiero <maciej.szmigiero@oracle.com>
2020-08-04 21:23:54 +02:00
#ifdef G_TREE_DEBUG
/*< private >*/
#ifndef __GTK_DOC_IGNORE__
void g_tree_dump (GTree *tree);
#endif /* !__GTK_DOC_IGNORE__ */
#endif /* G_TREE_DEBUG */
Split glib.h into many header files mostly according to the resp. 2000-10-12 Sebastian Wilhelmi <wilhelmi@ira.uka.de> * glib.h, galloca.h, garray.h, gasyncqueue.h, gbacktrace.h, gcache.h, gcompletion.h, gconvert.h, gdataset.h, gdate.h, ghash.h, ghook.h, giochannel.h, glist.h , gmacros.h, gmain.h, gmem.h, gmessages.h, gnode.h, gprimes.h, gquark.h, gqueue.h, grand.h, grel.h, gscanner.h, gslist.h, gstrfuncs.h, gstring.h, gthread.h, gthreadpool.h, gtimer.h, gtree.h, gtypes.h, gutils.h: Split glib.h into many header files mostly according to the resp. *.c-files. * gmacros.h: Added G_BEGIN_DECLS and G_END_DECLS to mean: 'in case of C++: extern "C" { ... }' analogous to glibc __BEGIN_DECLS and __END_DECLS. * configure.in, gerror.h, gfileutils.h, gshell.h, gspawn.h, gunicode.h, : Changed guard-macro names to something more consistent. * configure.in, *.h: Use G_BEGIN_DECLS and G_END_DECLS.
2000-10-12 13:52:07 +02:00
G_END_DECLS
#endif /* __G_TREE_H__ */
Reference in New Issue Copy Permalink