1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris */ 52230557Sjimharris 53230557Sjimharris#include <sys/cdefs.h> 54230557Sjimharris__FBSDID("$FreeBSD: releng/10.3/sys/dev/isci/scil/sci_base_iterator.c 231136 2012-02-07 17:43:58Z jimharris $"); 55230557Sjimharris 56230557Sjimharris/** 57230557Sjimharris * @file 58230557Sjimharris * 59230557Sjimharris * @brief This file contains the implementation of an iterator class. 60230557Sjimharris * This class will allow for iterating across the elements of a 61230557Sjimharris * container. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#if !defined(DISABLE_SCI_ITERATORS) 65230557Sjimharris 66230557Sjimharris//****************************************************************************** 67230557Sjimharris//* 68230557Sjimharris//* I N C L U D E S 69230557Sjimharris//* 70230557Sjimharris//****************************************************************************** 71230557Sjimharris 72230557Sjimharris#include <dev/isci/scil/sci_base_iterator.h> 73230557Sjimharris 74230557Sjimharris//****************************************************************************** 75230557Sjimharris//* 76230557Sjimharris//* P R I V A T E M E M B E R S 77230557Sjimharris//* 78230557Sjimharris//****************************************************************************** 79230557Sjimharris 80230557Sjimharris//****************************************************************************** 81230557Sjimharris//* 82230557Sjimharris//* P R O T E C T E D M E T H O D S 83230557Sjimharris//* 84230557Sjimharris//****************************************************************************** 85230557Sjimharris 86230557Sjimharris/** 87230557Sjimharris * @brief Return the size of an iterator object. 88230557Sjimharris * 89230557Sjimharris * @return U32 : size of iterator object in bytes. 90230557Sjimharris * 91230557Sjimharris */ 92230557SjimharrisU32 sci_iterator_get_object_size( 93230557Sjimharris void 94230557Sjimharris) 95230557Sjimharris{ 96230557Sjimharris return sizeof(SCI_BASE_ITERATOR_T); 97230557Sjimharris} 98230557Sjimharris 99230557Sjimharris/** 100230557Sjimharris * @brief Initialize the interator. 101230557Sjimharris * 102230557Sjimharris * @param[in] iterator This parameter specifies the iterator to be 103230557Sjimharris * constructed. 104230557Sjimharris * @param[in] list This parameter specifies the abstract list that will be 105230557Sjimharris * iterated on by this iterator. The iterator will by initialized 106230557Sjimharris * to point to the first element in this abstract list. 107230557Sjimharris * 108230557Sjimharris * @return none 109230557Sjimharris */ 110230557Sjimharrisvoid sci_base_iterator_construct( 111230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle, 112230557Sjimharris SCI_ABSTRACT_LIST_T * list 113230557Sjimharris) 114230557Sjimharris{ 115230557Sjimharris SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *) iterator_handle; 116230557Sjimharris 117230557Sjimharris memset(iterator, 0, sizeof(SCI_BASE_ITERATOR_T)); 118230557Sjimharris iterator->list = list; 119230557Sjimharris sci_iterator_first(iterator); 120230557Sjimharris} 121230557Sjimharris 122230557Sjimharris/** 123230557Sjimharris * @brief Get the object currently pointed to by this iterator. 124230557Sjimharris * 125230557Sjimharris * @param[in] iterator_handle Handle to an iterator. 126230557Sjimharris * 127230557Sjimharris * @return void * : Object pointed to by this iterator. 128230557Sjimharris * @retval NULL If iterator is not currently pointing to a valid element. 129230557Sjimharris */ 130230557Sjimharrisvoid * sci_iterator_get_current( 131230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 132230557Sjimharris) 133230557Sjimharris{ 134230557Sjimharris SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle; 135230557Sjimharris 136230557Sjimharris void *current_object = NULL; 137230557Sjimharris 138230557Sjimharris if (iterator->current != NULL) 139230557Sjimharris { 140230557Sjimharris current_object = sci_abstract_list_get_object(iterator->current); 141230557Sjimharris } 142230557Sjimharris 143230557Sjimharris return current_object; 144230557Sjimharris} 145230557Sjimharris 146230557Sjimharris/** 147230557Sjimharris * @brief Modify the iterator to point to the first element in the list. 148230557Sjimharris * 149230557Sjimharris * @param[in] iterator 150230557Sjimharris * 151230557Sjimharris * @return none 152230557Sjimharris */ 153230557Sjimharrisvoid sci_iterator_first( 154230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 155230557Sjimharris) 156230557Sjimharris{ 157230557Sjimharris SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle; 158230557Sjimharris 159230557Sjimharris iterator->current = sci_abstract_list_get_front(iterator->list); 160230557Sjimharris} 161230557Sjimharris 162230557Sjimharris/** 163230557Sjimharris * @brief Modify the iterator to point to the next element in the list. 164230557Sjimharris * 165230557Sjimharris * @param[in] iterator 166230557Sjimharris * 167230557Sjimharris * @return none 168230557Sjimharris */ 169230557Sjimharrisvoid sci_iterator_next( 170230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 171230557Sjimharris) 172230557Sjimharris{ 173230557Sjimharris SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle; 174230557Sjimharris 175230557Sjimharris if (iterator->current != NULL) 176230557Sjimharris { 177230557Sjimharris iterator->current = sci_abstract_list_get_next(iterator->current); 178230557Sjimharris } 179230557Sjimharris} 180230557Sjimharris 181230557Sjimharris#endif // !defined(DISABLE_SCI_ITERATORS) 182230557Sjimharris 183