1 | /* SPDX-License-Identifier: BSD-2-Clause */ |
---|
2 | |
---|
3 | /** |
---|
4 | * @file |
---|
5 | * |
---|
6 | * @ingroup rtems_rtl |
---|
7 | * |
---|
8 | * @brief RTEMS Run-Time Linker Chain Iterator. |
---|
9 | */ |
---|
10 | |
---|
11 | /* |
---|
12 | * COPYRIGHT (c) 2012 Chris Johns <chrisj@rtems.org> |
---|
13 | * |
---|
14 | * Redistribution and use in source and binary forms, with or without |
---|
15 | * modification, are permitted provided that the following conditions |
---|
16 | * are met: |
---|
17 | * 1. Redistributions of source code must retain the above copyright |
---|
18 | * notice, this list of conditions and the following disclaimer. |
---|
19 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
20 | * notice, this list of conditions and the following disclaimer in the |
---|
21 | * documentation and/or other materials provided with the distribution. |
---|
22 | * |
---|
23 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
24 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
25 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
26 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
27 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
28 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
29 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
30 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
31 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
32 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
33 | * POSSIBILITY OF SUCH DAMAGE. |
---|
34 | */ |
---|
35 | |
---|
36 | #if !defined (_RTEMS_RTL_CHAIN_ITERATOR_H_) |
---|
37 | #define _RTEMS_RTL_CHAIN_ITERATOR_H_ |
---|
38 | |
---|
39 | #ifdef __cplusplus |
---|
40 | extern "C" { |
---|
41 | #endif /* __cplusplus */ |
---|
42 | |
---|
43 | #include <rtems/chain.h> |
---|
44 | |
---|
45 | /** |
---|
46 | * Chain iterator handler. |
---|
47 | */ |
---|
48 | typedef bool (*rtems_chain_iterator) (rtems_chain_node* node, void* data); |
---|
49 | |
---|
50 | /** |
---|
51 | * Iterate a chain of nodes invoking the iterator handler. Supply a data |
---|
52 | * pointer the iterator moves data between the invoker and the iterator. |
---|
53 | * |
---|
54 | * The iterator allows removal of the node from the chain. |
---|
55 | * |
---|
56 | * @param chain The chain of nodes to iterator over. |
---|
57 | * @param iterator The iterator handler called once for each node. |
---|
58 | * @param data Pointer to the data used by the iterator. |
---|
59 | * @retval true The whole chain was iterated over. |
---|
60 | * @retval false The iterator returned false. |
---|
61 | */ |
---|
62 | bool |
---|
63 | rtems_rtl_chain_iterate (rtems_chain_control* chain, |
---|
64 | rtems_chain_iterator iterator, |
---|
65 | void* data); |
---|
66 | |
---|
67 | /** |
---|
68 | * Count the number of nodes on the chain. |
---|
69 | * |
---|
70 | * @param chain The chain to count the nodes of. |
---|
71 | * @return int The number of nodes. |
---|
72 | */ |
---|
73 | int rtems_rtl_chain_count (rtems_chain_control* chain); |
---|
74 | |
---|
75 | #ifdef __cplusplus |
---|
76 | } |
---|
77 | #endif /* __cplusplus */ |
---|
78 | |
---|
79 | #endif |
---|