2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
61 * @brief This file contains the implementation of an iterator class.
62 * This class will allow for iterating across the elements of a
66 #if !defined(DISABLE_SCI_ITERATORS)
68 //******************************************************************************
72 //******************************************************************************
74 #include <dev/isci/scil/sci_base_iterator.h>
76 //******************************************************************************
78 //* P R I V A T E M E M B E R S
80 //******************************************************************************
82 //******************************************************************************
84 //* P R O T E C T E D M E T H O D S
86 //******************************************************************************
89 * @brief Return the size of an iterator object.
91 * @return U32 : size of iterator object in bytes.
94 U32 sci_iterator_get_object_size(
98 return sizeof(SCI_BASE_ITERATOR_T);
102 * @brief Initialize the interator.
104 * @param[in] iterator This parameter specifies the iterator to be
106 * @param[in] list This parameter specifies the abstract list that will be
107 * iterated on by this iterator. The iterator will by initialized
108 * to point to the first element in this abstract list.
112 void sci_base_iterator_construct(
113 SCI_ITERATOR_HANDLE_T iterator_handle,
114 SCI_ABSTRACT_LIST_T * list
117 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *) iterator_handle;
119 memset(iterator, 0, sizeof(SCI_BASE_ITERATOR_T));
120 iterator->list = list;
121 sci_iterator_first(iterator);
125 * @brief Get the object currently pointed to by this iterator.
127 * @param[in] iterator_handle Handle to an iterator.
129 * @return void * : Object pointed to by this iterator.
130 * @retval NULL If iterator is not currently pointing to a valid element.
132 void * sci_iterator_get_current(
133 SCI_ITERATOR_HANDLE_T iterator_handle
136 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
138 void *current_object = NULL;
140 if (iterator->current != NULL)
142 current_object = sci_abstract_list_get_object(iterator->current);
145 return current_object;
149 * @brief Modify the iterator to point to the first element in the list.
151 * @param[in] iterator
155 void sci_iterator_first(
156 SCI_ITERATOR_HANDLE_T iterator_handle
159 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
161 iterator->current = sci_abstract_list_get_front(iterator->list);
165 * @brief Modify the iterator to point to the next element in the list.
167 * @param[in] iterator
171 void sci_iterator_next(
172 SCI_ITERATOR_HANDLE_T iterator_handle
175 SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
177 if (iterator->current != NULL)
179 iterator->current = sci_abstract_list_get_next(iterator->current);
183 #endif // !defined(DISABLE_SCI_ITERATORS)