sapi/src/rbtreefind.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSAPIClassicRBTrees
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_rbtree_find().
0010  */
0011
0012 /*
0013  *  Copyright (c) 2010 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 #ifdef HAVE_CONFIG_H
0038 #include "config.h"
0039 #endif
0040
0041 #include <rtems/rbtree.h>
0042
0043 rtems_rbtree_node *rtems_rbtree_find(
0044   const rtems_rbtree_control *the_rbtree,
0045   const rtems_rbtree_node    *the_node,
0046   rtems_rbtree_compare        compare,
0047   bool                  is_unique
0048 )
0049 {
0050   rtems_rbtree_node *iter_node = rtems_rbtree_root( the_rbtree );
0051   rtems_rbtree_node *found = NULL;
0052
0053   while ( iter_node != NULL ) {
0054     rtems_rbtree_compare_result compare_result =
0055       ( *compare )( the_node, iter_node );
0056
0057     if ( rtems_rbtree_is_equal( compare_result ) ) {
0058       found = iter_node;
0059
0060       if ( is_unique )
0061         break;
0062     }
0063
0064     if ( rtems_rbtree_is_greater( compare_result ) ) {
0065       iter_node = rtems_rbtree_right( iter_node );
0066     } else {
0067       iter_node = rtems_rbtree_left( iter_node );
0068     }
0069   }
0070
0071   return found;
0072 }