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 * $FreeBSD: releng/10.2/sys/dev/isci/scil/sci_base_iterator.h 231136 2012-02-07 17:43:58Z jimharris $ 53230557Sjimharris */ 54230557Sjimharris/** 55230557Sjimharris * @file 56230557Sjimharris * 57230557Sjimharris * @brief This file contains the protected interface to the iterator class. 58230557Sjimharris * Methods Provided: 59230557Sjimharris * - sci_base_iterator_construct() 60230557Sjimharris */ 61230557Sjimharris 62230557Sjimharris#ifndef _SCI_BASE_ITERATOR_H_ 63230557Sjimharris#define _SCI_BASE_ITERATOR_H_ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris//****************************************************************************** 70230557Sjimharris//* 71230557Sjimharris//* I N C L U D E S 72230557Sjimharris//* 73230557Sjimharris//****************************************************************************** 74230557Sjimharris 75230557Sjimharris#include <dev/isci/scil/sci_iterator.h> 76230557Sjimharris#include <dev/isci/scil/sci_abstract_list.h> 77230557Sjimharris 78230557Sjimharris//****************************************************************************** 79230557Sjimharris//* 80230557Sjimharris//* C O N S T A N T S 81230557Sjimharris//* 82230557Sjimharris//****************************************************************************** 83230557Sjimharris 84230557Sjimharris//****************************************************************************** 85230557Sjimharris//* 86230557Sjimharris//* T Y P E S 87230557Sjimharris//* 88230557Sjimharris//****************************************************************************** 89230557Sjimharris 90230557Sjimharris/** 91230557Sjimharris * @struct SCI_BASE_ITERATOR 92230557Sjimharris * 93230557Sjimharris * @brief This object represents an iterator of an abstract list. 94230557Sjimharris * 95230557Sjimharris */ 96230557Sjimharristypedef struct SCI_BASE_ITERATOR 97230557Sjimharris{ 98230557Sjimharris /** 99230557Sjimharris * This field points to the list iterated by this iterator. 100230557Sjimharris */ 101230557Sjimharris SCI_ABSTRACT_LIST_T * list; 102230557Sjimharris 103230557Sjimharris /** 104230557Sjimharris * This field points to the list element currently referenced by this 105230557Sjimharris * iterator. 106230557Sjimharris */ 107230557Sjimharris SCI_ABSTRACT_ELEMENT_T * current; 108230557Sjimharris 109230557Sjimharris} SCI_BASE_ITERATOR_T; 110230557Sjimharris 111230557Sjimharris//****************************************************************************** 112230557Sjimharris//* 113230557Sjimharris//* P U B L I C M E T H O D S 114230557Sjimharris//* 115230557Sjimharris//****************************************************************************** 116230557Sjimharris 117230557Sjimharris#if !defined(DISABLE_SCI_ITERATORS) 118230557Sjimharris 119230557Sjimharrisvoid sci_base_iterator_construct( 120230557Sjimharris SCI_ITERATOR_HANDLE_T iterator, 121230557Sjimharris SCI_ABSTRACT_LIST_T * list 122230557Sjimharris); 123230557Sjimharris 124230557Sjimharris#else // !defined(DISABLE_SCI_ITERATORS) 125230557Sjimharris 126230557Sjimharris#define sci_base_iterator_construct(the_iterator, the_list) 127230557Sjimharris 128230557Sjimharris#endif // !defined(DISABLE_SCI_ITERATORS) 129230557Sjimharris 130230557Sjimharris#ifdef __cplusplus 131230557Sjimharris} 132230557Sjimharris#endif // __cplusplus 133230557Sjimharris 134230557Sjimharris#endif // _BASE_ITERATOR_H_ 135