cpukit/libdl/rtl-chain-iterator.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup rtems_rtl
0007  *
0008  * @brief RTEMS Run-Time Linker Chain Iterator.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 2012 Chris Johns <chrisj@rtems.org>
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #if !defined (_RTEMS_RTL_CHAIN_ITERATOR_H_)
0037 #define _RTEMS_RTL_CHAIN_ITERATOR_H_
0038
0039 #ifdef __cplusplus
0040 extern "C" {
0041 #endif /* __cplusplus */
0042
0043 #include <rtems/chain.h>
0044
0045 /**
0046  * Chain iterator handler.
0047  */
0048 typedef bool (*rtems_chain_iterator) (rtems_chain_node* node, void* data);
0049
0050 /**
0051  * Iterate a chain of nodes invoking the iterator handler. Supply a data
0052  * pointer the iterator moves data between the invoker and the iterator.
0053  *
0054  * The iterator allows removal of the node from the chain.
0055  *
0056  * @param chain The chain of nodes to iterator over.
0057  * @param iterator The iterator handler called once for each node.
0058  * @param data Pointer to the data used by the iterator.
0059  * @retval true The whole chain was iterated over.
0060  * @retval false The iterator returned false.
0061  */
0062 bool
0063 rtems_rtl_chain_iterate (rtems_chain_control* chain,
0064                          rtems_chain_iterator iterator,
0065                          void*                data);
0066
0067 /**
0068  * Count the number of nodes on the chain.
0069  *
0070  * @param chain The chain to count the nodes of.
0071  * @return int The number of nodes.
0072  */
0073 int rtems_rtl_chain_count (rtems_chain_control* chain);
0074
0075 #ifdef __cplusplus
0076 }
0077 #endif /* __cplusplus */
0078
0079 #endif