rtems/score/rbtreeimpl.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreRBTree
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreRBTree which are only used by the implementation.
0010  */
0011
0012 /*
0013  *  Copyright (c) 2010-2012 Gedare Bloom.
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_SCORE_RBTREEIMPL_H
0038 #define _RTEMS_SCORE_RBTREEIMPL_H
0039
0040 #include <rtems/score/rbtree.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif
0045
0046 /**
0047  * @addtogroup RTEMSScoreRBTree
0048  *
0049  * @{
0050  */
0051
0052 /**
0053  * @brief Appends the node to the red-black tree.
0054  *
0055  * The appended node is the new maximum node of the tree.  The caller shall
0056  * ensure that the appended node is indeed the maximum node with respect to the
0057  * tree order.
0058  *
0059  * @param[in, out] the_rbtree is the red-black tree control.
0060  *
0061  * @param the_node[out] is the node to append.
0062  */
0063 void _RBTree_Append( RBTree_Control *the_rbtree, RBTree_Node *the_node );
0064
0065 /**
0066  * @brief Prepends the node to the red-black tree.
0067  *
0068  * The prepended node is the new minimum node of the tree.  The caller shall
0069  * ensure that the prepended node is indeed the minimum node with respect to the
0070  * tree order.
0071  *
0072  * @param[in, out] the_rbtree is the red-black tree control.
0073  *
0074  * @param the_node[out] is the node to prepend.
0075  */
0076 void _RBTree_Prepend( RBTree_Control *the_rbtree, RBTree_Node *the_node );
0077
0078 /**
0079  * @brief Red-black tree visitor.
0080  *
0081  * @param[in] node The node.
0082  * @param[in] visitor_arg The visitor argument.
0083  *
0084  * @retval true Stop the iteration.
0085  * @retval false Continue the iteration.
0086  *
0087  * @see _RBTree_Iterate().
0088  */
0089 typedef bool (*RBTree_Visitor)(
0090   const RBTree_Node *node,
0091   void *visitor_arg
0092 );
0093
0094 /**
0095  * @brief Red-black tree iteration.
0096  *
0097  * @param rbtree The red-black tree.
0098  * @param visitor The visitor.
0099  * @param visitor_arg The visitor argument.
0100  */
0101 void _RBTree_Iterate(
0102   const RBTree_Control *rbtree,
0103   RBTree_Visitor visitor,
0104   void *visitor_arg
0105 );
0106
0107 /** @} */
0108
0109 #ifdef __cplusplus
0110 }
0111 #endif
0112
0113 #endif
0114 /* end of include file */