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 * $FreeBSD$ 55 */ 56 /** 57 * @file 58 * 59 * @brief This file contains the protected interface to the iterator class. 60 * Methods Provided: 61 * - sci_base_iterator_construct() 62 */ 63 64 #ifndef _SCI_BASE_ITERATOR_H_ 65 #define _SCI_BASE_ITERATOR_H_ 66 67 #ifdef __cplusplus 68 extern "C" { 69 #endif // __cplusplus 70 71 //****************************************************************************** 72 //* 73 //* I N C L U D E S 74 //* 75 //****************************************************************************** 76 77 #include <dev/isci/scil/sci_iterator.h> 78 #include <dev/isci/scil/sci_abstract_list.h> 79 80 //****************************************************************************** 81 //* 82 //* C O N S T A N T S 83 //* 84 //****************************************************************************** 85 86 //****************************************************************************** 87 //* 88 //* T Y P E S 89 //* 90 //****************************************************************************** 91 92 /** 93 * @struct SCI_BASE_ITERATOR 94 * 95 * @brief This object represents an iterator of an abstract list. 96 * 97 */ 98 typedef struct SCI_BASE_ITERATOR 99 { 100 /** 101 * This field points to the list iterated by this iterator. 102 */ 103 SCI_ABSTRACT_LIST_T * list; 104 105 /** 106 * This field points to the list element currently referenced by this 107 * iterator. 108 */ 109 SCI_ABSTRACT_ELEMENT_T * current; 110 111 } SCI_BASE_ITERATOR_T; 112 113 //****************************************************************************** 114 //* 115 //* P U B L I C M E T H O D S 116 //* 117 //****************************************************************************** 118 119 #if !defined(DISABLE_SCI_ITERATORS) 120 121 void sci_base_iterator_construct( 122 SCI_ITERATOR_HANDLE_T iterator, 123 SCI_ABSTRACT_LIST_T * list 124 ); 125 126 #else // !defined(DISABLE_SCI_ITERATORS) 127 128 #define sci_base_iterator_construct(the_iterator, the_list) 129 130 #endif // !defined(DISABLE_SCI_ITERATORS) 131 132 #ifdef __cplusplus 133 } 134 #endif // __cplusplus 135 136 #endif // _BASE_ITERATOR_H_ 137