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