#include "tree_p.h"
#include <gwenhywfar/misc.h>
#include <gwenhywfar/debug.h>

Include dependency graph for tree.c:

Macros
#define	DISABLE_DEBUGLOG

Functions
void	GWEN_Tree_Add (GWEN_TREE l, GWEN_TREE_ELEMENT el)
void	GWEN_Tree_AddChild (GWEN_TREE_ELEMENT where, GWEN_TREE_ELEMENT el)
void	GWEN_Tree_AddList (GWEN_TREE dest, GWEN_TREE l)
void	GWEN_Tree_Del (GWEN_TREE_ELEMENT *el)
void	GWEN_Tree_free (GWEN_TREE *l)
int	GWEN_Tree_GetCount (const GWEN_TREE *l)
void *	GWEN_Tree_GetFirst (const GWEN_TREE *l)
void *	GWEN_Tree_GetLast (const GWEN_TREE *l)
void	GWEN_Tree_Insert (GWEN_TREE l, GWEN_TREE_ELEMENT el)
void	GWEN_Tree_InsertChild (GWEN_TREE_ELEMENT where, GWEN_TREE_ELEMENT el)
GWEN_TREE *	GWEN_Tree_new (void)
void	GWEN_Tree_Replace (GWEN_TREE_ELEMENT elToReplace, GWEN_TREE_ELEMENT elReplacement)
void	GWEN_TreeElement_free (GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetBelow (const GWEN_TREE_ELEMENT *el)
uint32_t	GWEN_TreeElement_GetChildrenCount (const GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetFirstChild (const GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetLastChild (const GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetNext (const GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetParent (const GWEN_TREE_ELEMENT *el)
void *	GWEN_TreeElement_GetPrevious (const GWEN_TREE_ELEMENT *el)
GWEN_TREE_ELEMENT *	GWEN_TreeElement_new (void *d)

Macro Definition Documentation

◆ DISABLE_DEBUGLOG

#define DISABLE_DEBUGLOG

Definition at line 30 of file tree.c.

Function Documentation

◆ GWEN_Tree_Add()

void GWEN_Tree_Add	(	GWEN_TREE *	l,
		GWEN_TREE_ELEMENT *	el )

Adds (appends) a toplevel tree element. (This operation is also called "append" or "push_back" elsewhere.)

Definition at line 65 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, GWEN_TREE_ELEMENT, and NULL.

Referenced by GWEN_Tree_AddList().

Here is the caller graph for this function:

◆ GWEN_Tree_AddChild()

void GWEN_Tree_AddChild	(	GWEN_TREE_ELEMENT *	where,
		GWEN_TREE_ELEMENT *	el )

Add a child below the given element.

Definition at line 234 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, and GWEN_TREE_ELEMENT.

◆ GWEN_Tree_AddList()

void GWEN_Tree_AddList	(	GWEN_TREE *	dest,
		GWEN_TREE *	l )

Adds (appends) the second list to the end of the first list. (This operation is also called "append" or "concatenate" elsewhere.) The second list will be empty upon return.

Definition at line 91 of file tree.c.

References GWEN_Tree_Add(), GWEN_Tree_Del(), and GWEN_TREE_ELEMENT.

Here is the call graph for this function:

◆ GWEN_Tree_Del()

void GWEN_Tree_Del ( GWEN_TREE_ELEMENT * el )

Deletes (removes) a tree element from the tree it used to belong to. The tree element is not free'd or anything, it is only removed from the list it used to belong to. (This operation is also called "remove" or "unlink" elsewhere.)

Definition at line 129 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, GWEN_TREE_ELEMENT, and NULL.

Referenced by GWEN_Tree_AddList(), and GWEN_TreeElement_free().

Here is the caller graph for this function:

◆ GWEN_Tree_free()

void GWEN_Tree_free ( GWEN_TREE * l )

Free (delete) an existing list. The list elements are untouched by this function; they need to be freed beforehand.

Definition at line 48 of file tree.c.

References GWEN_FREE_OBJECT.

◆ GWEN_Tree_GetCount()

int GWEN_Tree_GetCount ( const GWEN_TREE * l )

Returns the number of elements in this list. This value is cached in the list structure, so this function is a cheap function.

Definition at line 57 of file tree.c.

◆ GWEN_Tree_GetFirst()

void * GWEN_Tree_GetFirst ( const GWEN_TREE * l )

Returns the data pointer of the first list element.

Definition at line 284 of file tree.c.

◆ GWEN_Tree_GetLast()

void * GWEN_Tree_GetLast ( const GWEN_TREE * l )

Returns the data pointer of the last list element.

Definition at line 293 of file tree.c.

◆ GWEN_Tree_Insert()

void GWEN_Tree_Insert	(	GWEN_TREE *	l,
		GWEN_TREE_ELEMENT *	el )

Inserts (prepends) a toplevel tree element at the beginning of the list. (This operation is also called "prepend" or "push_front" elsewhere.)

Definition at line 106 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_Tree_InsertChild()

void GWEN_Tree_InsertChild	(	GWEN_TREE_ELEMENT *	where,
		GWEN_TREE_ELEMENT *	el )

Insert a child below the given element.

Definition at line 260 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_Tree_new()

GWEN_TREE * GWEN_Tree_new ( void )

Allocate (create) a new empty list.

Definition at line 39 of file tree.c.

References GWEN_NEW_OBJECT.

◆ GWEN_Tree_Replace()

void GWEN_Tree_Replace	(	GWEN_TREE_ELEMENT *	elToReplace,
		GWEN_TREE_ELEMENT *	elReplacement )

Replaces a tree element with another one, so the replacement takes the place of the given element. The given element to replace is unlinked in the process and can be free'd. The replacement MUST NOT be part of any tree.

Definition at line 173 of file tree.c.

References DBG_ERROR, GWEN_LOGDOMAIN, GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_TreeElement_free()

void GWEN_TreeElement_free ( GWEN_TREE_ELEMENT * el )

Free (delete) a list element structure.

Definition at line 316 of file tree.c.

References DBG_ERROR, GWEN_FREE_OBJECT, GWEN_LOGDOMAIN, GWEN_Tree_Del(), and GWEN_TREE_ELEMENT.

Here is the call graph for this function:

◆ GWEN_TreeElement_GetBelow()

void * GWEN_TreeElement_GetBelow ( const GWEN_TREE_ELEMENT * el )

Returns the element which is logically below the given one. The order of search is this:

first child of the given element
next neighbour of the given element
loop for every parent: check next neighbour of the given element's parent (if any)

Definition at line 349 of file tree.c.

References GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_TreeElement_GetChildrenCount()

uint32_t GWEN_TreeElement_GetChildrenCount ( const GWEN_TREE_ELEMENT * el )

Returns the number of children of the given element

Definition at line 397 of file tree.c.

References GWEN_TREE_ELEMENT.

◆ GWEN_TreeElement_GetFirstChild()

void * GWEN_TreeElement_GetFirstChild ( const GWEN_TREE_ELEMENT * el )

Returns the first child of the given element.

Definition at line 370 of file tree.c.

References GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_TreeElement_GetLastChild()

void * GWEN_TreeElement_GetLastChild ( const GWEN_TREE_ELEMENT * el )

Returns the last child of the given element.

Definition at line 379 of file tree.c.

References GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_TreeElement_GetNext()

void * GWEN_TreeElement_GetNext ( const GWEN_TREE_ELEMENT * el )

Returns the data pointer of the list element that is the next one (successor) to the given one in its list. If there is no such prepending list element, returns NULL.

Definition at line 340 of file tree.c.

References GWEN_TREE_ELEMENT.

◆ GWEN_TreeElement_GetParent()

void * GWEN_TreeElement_GetParent ( const GWEN_TREE_ELEMENT * el )

Definition at line 388 of file tree.c.

References GWEN_TREE_ELEMENT, and NULL.

◆ GWEN_TreeElement_GetPrevious()

void * GWEN_TreeElement_GetPrevious ( const GWEN_TREE_ELEMENT * el )

Returns the data pointer of the list element that is the previous (predecessor) to the given one in its list. If there is no such prepending list element, returns NULL.

Definition at line 331 of file tree.c.

References GWEN_TREE_ELEMENT.

◆ GWEN_TreeElement_new()

GWEN_TREE_ELEMENT * GWEN_TreeElement_new ( void * d )

Allocate (create) a new list element structure.

Definition at line 304 of file tree.c.

References GWEN_NEW_OBJECT, and GWEN_TREE_ELEMENT.

Macros

Functions

Macro Definition Documentation

◆ DISABLE_DEBUGLOG

Function Documentation

◆ GWEN_Tree_Add()

◆ GWEN_Tree_AddChild()

◆ GWEN_Tree_AddList()

◆ GWEN_Tree_Del()

◆ GWEN_Tree_free()

◆ GWEN_Tree_GetCount()

◆ GWEN_Tree_GetFirst()

◆ GWEN_Tree_GetLast()

◆ GWEN_Tree_Insert()

◆ GWEN_Tree_InsertChild()

◆ GWEN_Tree_new()

◆ GWEN_Tree_Replace()

◆ GWEN_TreeElement_free()

◆ GWEN_TreeElement_GetBelow()

◆ GWEN_TreeElement_GetChildrenCount()

◆ GWEN_TreeElement_GetFirstChild()

◆ GWEN_TreeElement_GetLastChild()

◆ GWEN_TreeElement_GetNext()

◆ GWEN_TreeElement_GetParent()

◆ GWEN_TreeElement_GetPrevious()

◆ GWEN_TreeElement_new()