rbtree.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  Copyright (c) 2010 Gedare Bloom.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _RTEMS_RBTREE_H
#define _RTEMS_RBTREE_H
 
#include <rtems/score/rbtree.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef RBTree_Node rtems_rbtree_node;
 
typedef RBTree_Control rtems_rbtree_control;
 
typedef long rtems_rbtree_compare_result;
 
typedef rtems_rbtree_compare_result ( *rtems_rbtree_compare )(
  const RBTree_Node *first,
  const RBTree_Node *second
);
 
#define RTEMS_RBTREE_INITIALIZER_EMPTY(name) \
  RBTREE_INITIALIZER_EMPTY(name)
 
#define RTEMS_RBTREE_DEFINE_EMPTY(name) \
  RBTREE_DEFINE_EMPTY(name)
 
void rtems_rbtree_initialize(
  rtems_rbtree_control *the_rbtree,
  rtems_rbtree_compare  compare,
  void                 *starting_address,
  size_t                number_nodes,
  size_t                node_size,
  bool                  is_unique
);
 
static inline void rtems_rbtree_initialize_empty(
  rtems_rbtree_control *the_rbtree
)
{
  _RBTree_Initialize_empty( the_rbtree );
}
 
static inline void rtems_rbtree_set_off_tree(
  rtems_rbtree_node *node
)
{
  _RBTree_Set_off_tree( node );
}
 
static inline bool rtems_rbtree_is_node_off_tree(
  const rtems_rbtree_node *node
)
{
  return _RBTree_Is_node_off_tree( node );
}
 
static inline rtems_rbtree_node *rtems_rbtree_root(
  const rtems_rbtree_control *the_rbtree
)
{
  return _RBTree_Root( the_rbtree );
}
 
static inline rtems_rbtree_node *rtems_rbtree_min(
  const rtems_rbtree_control *the_rbtree
)
{
  return _RBTree_Minimum( the_rbtree );
}
 
static inline rtems_rbtree_node *rtems_rbtree_max(
  const rtems_rbtree_control *the_rbtree
)
{
  return _RBTree_Maximum( the_rbtree );
}
 
static inline rtems_rbtree_node *rtems_rbtree_left(
  const rtems_rbtree_node *the_node
)
{
  return _RBTree_Left( the_node );
}
 
static inline rtems_rbtree_node *rtems_rbtree_right(
  const rtems_rbtree_node *the_node
)
{
  return _RBTree_Right( the_node );
}
 
static inline rtems_rbtree_node *rtems_rbtree_parent(
  const rtems_rbtree_node *the_node
)
{
  return _RBTree_Parent( the_node );
}
 
static inline bool rtems_rbtree_is_empty(
  const rtems_rbtree_control *the_rbtree
)
{
  return _RBTree_Is_empty( the_rbtree );
}
 
static inline bool rtems_rbtree_is_min(
  const rtems_rbtree_control *the_rbtree,
  const rtems_rbtree_node *the_node
)
{
  return rtems_rbtree_min( the_rbtree ) == the_node;
}
 
static inline bool rtems_rbtree_is_max(
  const rtems_rbtree_control *the_rbtree,
  const rtems_rbtree_node *the_node
)
{
  return rtems_rbtree_max( the_rbtree ) == the_node;
}
 
static inline bool rtems_rbtree_is_root(
  const rtems_rbtree_node *the_node
)
{
  return _RBTree_Is_root( the_node );
}
 
static inline bool rtems_rbtree_is_equal(
  rtems_rbtree_compare_result compare_result
)
{
  return compare_result == 0;
}
 
static inline bool rtems_rbtree_is_greater(
  rtems_rbtree_compare_result compare_result
)
{
  return compare_result > 0;
}
 
static inline bool rtems_rbtree_is_lesser(
  rtems_rbtree_compare_result compare_result
)
{
  return compare_result < 0;
}
 
rtems_rbtree_node* rtems_rbtree_find(
  const rtems_rbtree_control *the_rbtree,
  const rtems_rbtree_node    *the_node,
  rtems_rbtree_compare              compare,
  bool                        is_unique
);
 
static inline rtems_rbtree_node* rtems_rbtree_predecessor(
  const rtems_rbtree_node *node
)
{
  return _RBTree_Predecessor( node );
}
 
static inline rtems_rbtree_node* rtems_rbtree_successor(
  const rtems_rbtree_node *node
)
{
  return _RBTree_Successor( node );
}
 
static inline void rtems_rbtree_extract(
  rtems_rbtree_control *the_rbtree,
  rtems_rbtree_node *the_node
)
{
  _RBTree_Extract( the_rbtree, the_node );
}
 
static inline rtems_rbtree_node *rtems_rbtree_get_min(
  rtems_rbtree_control *the_rbtree
)
{
  rtems_rbtree_node *the_node = rtems_rbtree_min( the_rbtree );
 
  if ( the_node != NULL ) {
    rtems_rbtree_extract( the_rbtree, the_node );
  }
 
  return the_node;
}
 
static inline rtems_rbtree_node *rtems_rbtree_get_max(
  rtems_rbtree_control *the_rbtree
)
{
  rtems_rbtree_node *the_node = rtems_rbtree_max( the_rbtree );
 
  if ( the_node != NULL ) {
    rtems_rbtree_extract( the_rbtree, the_node );
  }
 
  return the_node;
}
 
static inline rtems_rbtree_node *rtems_rbtree_peek_min(
  const rtems_rbtree_control *the_rbtree
)
{
  return rtems_rbtree_min( the_rbtree );
}
 
static inline rtems_rbtree_node *rtems_rbtree_peek_max(
  const rtems_rbtree_control *the_rbtree
)
{
  return rtems_rbtree_max( the_rbtree );
}
 
rtems_rbtree_node *rtems_rbtree_insert(
  RBTree_Control *the_rbtree,
  RBTree_Node    *the_node,
  rtems_rbtree_compare  compare,
  bool            is_unique
);
 
#ifdef __cplusplus
}
#endif
 
#endif
/* end of include file */