blob: 9a09b27650247367ae49f13622c47b3b0524712a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/**
* @file rtems/rbtree.h
*
* This include file contains all the constants and structures associated
* with the RBTree API in RTEMS. The rbtree is a Red Black Tree that
* is part of the Super Core. This is the published interface to that
* code.
*
*/
/*
* Copyright (c) 2010 Gedare Bloom.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
#ifndef _RTEMS_RBTREE_H
#define _RTEMS_RBTREE_H
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/system.h>
#include <rtems/score/rbtree.h>
/**
* @typedef rtems_rbtree_node
*
* A node that can be manipulated in the rbtree.
*/
typedef RBTree_Node rtems_rbtree_node;
/**
* @typedef rtems_rbtree_control
*
* The rbtree's control anchors the rbtree.
*/
typedef RBTree_Control rtems_rbtree_control;
/**
* @typedef rtems_rbtree_compare_function
*
* This type defines function pointers for user-provided comparison
* function. The function compares two nodes in order to determine
* the order in a red-black tree.
*/
typedef RBTree_Compare_function rtems_rbtree_compare_function;
/**
* @typedef rtems_rbtree_unique
*
* This enum type defines whether the tree can contain nodes with
* duplicate keys.
*/
typedef enum {
/** The tree is not unique, insertion of duplicate keys is performed
* in a FIFO manner. */
RTEMS_RBTREE_DUPLICATE = false,
/** The tree is unique, insertion of duplicate key is refused. */
RTEMS_RBTREE_UNIQUE = true
} rtems_rbtree_unique;
/**
* @brief RBTree initializer for an empty rbtree with designator @a name.
*/
#define RTEMS_RBTREE_INITIALIZER_EMPTY(name) \
RBTREE_INITIALIZER_EMPTY(name)
/**
* @brief RBTree definition for an empty rbtree with designator @a name.
*/
#define RTEMS_RBTREE_DEFINE_EMPTY(name) \
RBTREE_DEFINE_EMPTY(name)
/**
* @brief macro to return the structure containing the @a node.
*
* This macro returns a pointer of type @a object_type that points
* to the structure containing @a node, where @a object_member is the
* field name of the rtems_rbtree_node structure in objects of @a object_type.
*/
#define rtems_rbtree_container_of(node,object_type, object_member) \
_RBTree_Container_of(node,object_type,object_member)
#include <rtems/rbtree.inl>
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
