Removes all keys and values from the GLib.Tree and decreases its
reference count by one. If keys and/or values are dynamically
allocated, you should either free them first or create the GLib.Tree
using g_tree_new_full(). In the latter case the destroy functions
you supplied will be called on all keys and values before destroying
the GLib.Tree.
Calls the given function for each of the key/value pairs in the GLib.Tree.
The function is passed the key and value of each pair, and the given
data parameter. The tree is traversed in sorted order.
The tree may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, you need to add each item to a list in your GLib.TraverseFunc as you walk over the tree, then walk the list and remove each item.
the function to call for each node visited. If this function returns true, the traversal is stopped.
Calls the given function for each of the nodes in the GLib.Tree.
The function is passed the pointer to the particular node, and the given
data parameter. The tree traversal happens in-order.
The tree may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, you need to add each item to a list in your GLib.TraverseFunc as you walk over the tree, then walk the list and remove each item.
the function to call for each node visited. If this function returns true, the traversal is stopped.
Inserts a key/value pair into a GLib.Tree.
If the given key already exists in the GLib.Tree its corresponding value
is set to the new value. If you supplied a value_destroy_func when
creating the GLib.Tree, the old value is freed using that function. If
you supplied a key_destroy_func when creating the GLib.Tree, the passed
key is freed using that function.
The tree is automatically 'balanced' as new key/value pairs are added, so that the distance from the root to every leaf is as small as possible. The cost of maintaining a balanced tree while inserting new key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)).
Optionalkey: anythe key to insert
Optionalvalue: anythe value corresponding to the key
the inserted (or set) node or null if insertion would overflow the tree node counter.
Gets the value corresponding to the given key. Since a GLib.Tree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).
Optionalkey: anythe key to look up
the value corresponding to the key, or null if the key was not found
Looks up a key in the GLib.Tree, returning the original key and the
associated value. This is useful if you need to free the memory
allocated for the original key, for example before calling
g_tree_remove().
the key to look up
true if the key was found in the GLib.Tree
Gets the tree node corresponding to the given key. Since a GLib.Tree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).
Optionalkey: anythe key to look up
the tree node corresponding to the key, or null if the key was not found
Gets the lower bound node corresponding to the given key,
or null if the tree is empty or all the nodes in the tree
have keys that are strictly lower than the searched key.
The lower bound is the first node that has its key greater than or equal to the searched key.
Optionalkey: anythe key to calculate the lower bound for
the tree node corresponding to the lower bound, or null if the tree is empty or has only keys strictly lower than the searched key.
Gets the number of nodes in a GLib.Tree.
the number of nodes in tree The node counter value type is really a guint, but it is returned as a gint due to backward compatibility issues (can be cast back to guint to support its full range of values).
Returns the first in-order node of the tree, or null
for an empty tree.
the first node in the tree
Returns the last in-order node of the tree, or null
for an empty tree.
the last node in the tree
Removes a key/value pair from a GLib.Tree.
If the GLib.Tree was created using g_tree_new_full(), the key and value
are freed using the supplied destroy functions, otherwise you have to
make sure that any dynamically allocated values are freed yourself.
If the key does not exist in the GLib.Tree, the function does nothing.
The cost of maintaining a balanced tree while removing a key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)).
Optionalkey: anythe key to remove
true if the key was found (prior to 2.8, this function returned nothing)
Inserts a new key and value into a GLib.Tree as g_tree_replace_node() does,
only this function does not return the inserted or set node.
Optionalkey: anythe key to insert
Optionalvalue: anythe value corresponding to the key
Inserts a new key and value into a GLib.Tree similar to g_tree_insert_node().
The difference is that if the key already exists in the GLib.Tree, it gets
replaced by the new key. If you supplied a value_destroy_func when
creating the GLib.Tree, the old value is freed using that function. If you
supplied a key_destroy_func when creating the GLib.Tree, the old key is
freed using that function.
The tree is automatically 'balanced' as new key/value pairs are added, so that the distance from the root to every leaf is as small as possible.
Optionalkey: anythe key to insert
Optionalvalue: anythe value corresponding to the key
the inserted (or set) node or null if insertion would overflow the tree node counter.
Searches a GLib.Tree using search_func.
The search_func is called with a pointer to the key of a key/value
pair in the tree, and the passed in user_data. If search_func returns
0 for a key/value pair, then the corresponding value is returned as
the result of g_tree_search(). If search_func returns -1, searching
will proceed among the key/value pairs that have a smaller key; if
search_func returns 1, searching will proceed among the key/value
pairs that have a larger key.
a function used to search the GLib.Tree
the value corresponding to the found key, or null if the key was not found
Searches a GLib.Tree using search_func.
The search_func is called with a pointer to the key of a key/value
pair in the tree, and the passed in user_data. If search_func returns
0 for a key/value pair, then the corresponding node is returned as
the result of g_tree_search(). If search_func returns -1, searching
will proceed among the key/value pairs that have a smaller key; if
search_func returns 1, searching will proceed among the key/value
pairs that have a larger key.
a function used to search the GLib.Tree
the node corresponding to the found key, or null if the key was not found
Removes a key and its associated value from a GLib.Tree without calling the key and value destroy functions.
If the key does not exist in the GLib.Tree, the function does nothing.
Optionalkey: anythe key to remove
true if the key was found (prior to 2.8, this function returned nothing)
Calls the given function for each node in the GLib.Tree.
the function to call for each node visited. If this function returns true, the traversal is stopped.
the order in which nodes are visited, one of GLib.TraverseType.IN_ORDER, GLib.TraverseType.PRE_ORDER and GLib.TraverseType.POST_ORDER
Decrements the reference count of tree by one.
If the reference count drops to 0, all keys and values will
be destroyed (if destroy functions were specified) and all
memory allocated by tree will be released.
It is safe to call this function from any thread.
Gets the upper bound node corresponding to the given key,
or null if the tree is empty or all the nodes in the tree
have keys that are lower than or equal to the searched key.
The upper bound is the first node that has its key strictly greater than the searched key.
Optionalkey: anythe key to calculate the upper bound for
the tree node corresponding to the upper bound, or null if the tree is empty or has only keys lower than or equal to the searched key.
Staticnew_
The GTree struct is an opaque data structure representing a balanced binary tree. It should be accessed only by using the following functions.