1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
6 *
7 * GPL LICENSE SUMMARY
8 *
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23 * The full GNU General Public License is included in this distribution
24 * in the file called LICENSE.GPL.
25 *
26 * BSD LICENSE
27 *
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
30 *
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
33 * are met:
34 *
35 * * Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * * Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in
39 * the documentation and/or other materials provided with the
40 * distribution.
41 *
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53 */
54
55 #include <sys/cdefs.h>
56 /**
57 * @file
58 *
59 * @brief This file contains the implementation of an iterator class.
60 * This class will allow for iterating across the elements of a
61 * container.
62 */
63
64 #if !defined(DISABLE_SCI_ITERATORS)
65
66 //******************************************************************************
67 //*
68 //* I N C L U D E S
69 //*
70 //******************************************************************************
71
72 #include <dev/isci/scil/sci_base_iterator.h>
73
74 //******************************************************************************
75 //*
76 //* P R I V A T E M E M B E R S
77 //*
78 //******************************************************************************
79
80 //******************************************************************************
81 //*
82 //* P R O T E C T E D M E T H O D S
83 //*
84 //******************************************************************************
85
86 /**
87 * @brief Return the size of an iterator object.
88 *
89 * @return U32 : size of iterator object in bytes.
90 *
91 */
sci_iterator_get_object_size(void)92 U32 sci_iterator_get_object_size(
93 void
94 )
95 {
96 return sizeof(SCI_BASE_ITERATOR_T);
97 }
98
99 /**
100 * @brief Initialize the interator.
101 *
102 * @param[in] iterator This parameter specifies the iterator to be
103 * constructed.
104 * @param[in] list This parameter specifies the abstract list that will be
105 * iterated on by this iterator. The iterator will by initialized
106 * to point to the first element in this abstract list.
107 *
108 * @return none
109 */
sci_base_iterator_construct(SCI_ITERATOR_HANDLE_T iterator_handle,SCI_ABSTRACT_LIST_T * list)110 void sci_base_iterator_construct(
111 SCI_ITERATOR_HANDLE_T iterator_handle,
112 SCI_ABSTRACT_LIST_T * list
113 )
114 {
115 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *) iterator_handle;
116
117 memset(iterator, 0, sizeof(SCI_BASE_ITERATOR_T));
118 iterator->list = list;
119 sci_iterator_first(iterator);
120 }
121
122 /**
123 * @brief Get the object currently pointed to by this iterator.
124 *
125 * @param[in] iterator_handle Handle to an iterator.
126 *
127 * @return void * : Object pointed to by this iterator.
128 * @retval NULL If iterator is not currently pointing to a valid element.
129 */
sci_iterator_get_current(SCI_ITERATOR_HANDLE_T iterator_handle)130 void * sci_iterator_get_current(
131 SCI_ITERATOR_HANDLE_T iterator_handle
132 )
133 {
134 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
135
136 void *current_object = NULL;
137
138 if (iterator->current != NULL)
139 {
140 current_object = sci_abstract_list_get_object(iterator->current);
141 }
142
143 return current_object;
144 }
145
146 /**
147 * @brief Modify the iterator to point to the first element in the list.
148 *
149 * @param[in] iterator
150 *
151 * @return none
152 */
sci_iterator_first(SCI_ITERATOR_HANDLE_T iterator_handle)153 void sci_iterator_first(
154 SCI_ITERATOR_HANDLE_T iterator_handle
155 )
156 {
157 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
158
159 iterator->current = sci_abstract_list_get_front(iterator->list);
160 }
161
162 /**
163 * @brief Modify the iterator to point to the next element in the list.
164 *
165 * @param[in] iterator
166 *
167 * @return none
168 */
sci_iterator_next(SCI_ITERATOR_HANDLE_T iterator_handle)169 void sci_iterator_next(
170 SCI_ITERATOR_HANDLE_T iterator_handle
171 )
172 {
173 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
174
175 if (iterator->current != NULL)
176 {
177 iterator->current = sci_abstract_list_get_next(iterator->current);
178 }
179 }
180
181 #endif // !defined(DISABLE_SCI_ITERATORS)
182
183