MGE General C Library - Full Internal Documentation  v1.7.4
Library of general C functions.
internal.h
Go to the documentation of this file.
1 
15 /* **********************************************************************
16  * *
17  * Changelog *
18  * *
19  * Date Author Version Description *
20  * *
21  * 04/11/2017 MG 1.0.1 Started ChangeLog. *
22  * 09/11/2017 MG 1.0.2 Add SPDX license tag. *
23  * 02/01/2018 MG 1.0.3 Move to new source directory structure. *
24  * 19/05/2018 MG 1.0.4 Include dllist and sllist prototypes. *
25  * 20/05/2018 MG 1.0.5 Add re-inclusion prevention #defines. *
26  * 20/05/2018 MG 1.0.6 Standardise on define name format. *
27  * 02/06/2018 MG 1.0.7 Add support for counter and node totals *
28  * for a tree. *
29  * 09/06/2019 MG 1.0.8 clang-format coding style changes. *
30  * 12/07/2019 MG 1.0.9 Separate combined header file into *
31  * specific individual files. *
32  * 03/12/2021 MG 1.0.10 Tighten SPDX tag. *
33  * 16/09/2022 MG 1.0.11 Rename of portability.h *
34  * Rename of bstree.h *
35  * Add stddef.h for size_t. *
36  * Move static function declarations to .c *
37  * file. *
38  * Test tracing elements moved here as *
39  * they are not part of the API. *
40  * Rename internal.h *
41  * *
42  ************************************************************************
43  */
44 
45 #ifndef INTERNAL_H
46 #define INTERNAL_H
47 
48 #include <libmgec/mge-bstree.h>
50 
51 #include <stddef.h>
52 
54 
56 struct bstobjcoord {
57  void *object;
58  int count;
59  int xdir;
60  int ydir;
61 };
62 
63 struct bstobjcoord *find_next_bst_node_trace(const struct bstree *tree,
64  struct bstobjcoord *searchobj);
65 
67 
68 #endif /* ndef INTERNAL_H */
struct bstobjcoord * find_next_bst_node_trace(const struct bstree *tree, struct bstobjcoord *searchobj)
Find and return the next object and it's coordinates in the bst 'tree'.
Definition: bstree.c:832
Binary search tree header file.
Header file to ease portability.
#define BEGIN_C_DECLS
BEGIN_C_DECLS should be used at the beginning of declarations so that C++ compilers don't mangle thei...
Definition: mge-portability.h:48
#define END_C_DECLS
Use END_C_DECLS at the end of C declarations.
Definition: mge-portability.h:52
Node coordinates for test tracing.
Definition: internal.h:56
void * object
The object.
Definition: internal.h:57
int xdir
The x coordinate.
Definition: internal.h:59
int ydir
The y coordinate.
Definition: internal.h:60
int count
The node counter.
Definition: internal.h:58
Binary search tree.
Definition: mge-bstree.h:74