sys/dev/isci/scil/sci_base_iterator.h

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51  *
  52  * $FreeBSD$
  53  */
  54 /**
  55  * @file
  56  *
  57  * @brief This file contains the protected interface to the iterator class.
  58  *        Methods Provided:
  59  *        - sci_base_iterator_construct()
  60  */
  61
  62 #ifndef _SCI_BASE_ITERATOR_H_
  63 #define _SCI_BASE_ITERATOR_H_
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif // __cplusplus
  68
  69 //******************************************************************************
  70 //*
  71 //*     I N C L U D E S
  72 //*
  73 //******************************************************************************
  74
  75 #include <dev/isci/scil/sci_iterator.h>
  76 #include <dev/isci/scil/sci_abstract_list.h>
  77
  78 //******************************************************************************
  79 //*
  80 //*     C O N S T A N T S
  81 //*
  82 //******************************************************************************
  83
  84 //******************************************************************************
  85 //*
  86 //*     T Y P E S
  87 //*
  88 //******************************************************************************
  89
  90 /**
  91  * @struct SCI_BASE_ITERATOR
  92  *
  93  * @brief This object represents an iterator of an abstract list.
  94  *
  95  */
  96 typedef struct SCI_BASE_ITERATOR
  97 {
  98    /**
  99     * This field points to the list iterated by this iterator.
 100     */
 101    SCI_ABSTRACT_LIST_T * list;
 102
 103    /**
 104     * This field points to the list element currently referenced by this
 105     *  iterator.
 106     */
 107    SCI_ABSTRACT_ELEMENT_T * current;
 108
 109 } SCI_BASE_ITERATOR_T;
 110
 111 //******************************************************************************
 112 //*
 113 //*     P U B L I C       M E T H O D S
 114 //*
 115 //******************************************************************************
 116
 117 #if !defined(DISABLE_SCI_ITERATORS)
 118
 119 void sci_base_iterator_construct(
 120    SCI_ITERATOR_HANDLE_T   iterator,
 121    SCI_ABSTRACT_LIST_T   * list
 122 );
 123
 124 #else // !defined(DISABLE_SCI_ITERATORS)
 125
 126 #define sci_base_iterator_construct(the_iterator, the_list)
 127
 128 #endif // !defined(DISABLE_SCI_ITERATORS)
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif // __cplusplus
 133
 134 #endif // _BASE_ITERATOR_H_