sys/dev/isci/scil/sci_base_iterator.c

   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
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /**
  57  * @file
  58  *
  59  * @brief This file contains the implementation of an iterator class.
  60  *        This class will allow for iterating across the elements of a
  61  *        container.
  62  */
  63
  64 #if !defined(DISABLE_SCI_ITERATORS)
  65
  66 //******************************************************************************
  67 //*
  68 //*     I N C L U D E S
  69 //*
  70 //******************************************************************************
  71
  72 #include <dev/isci/scil/sci_base_iterator.h>
  73
  74 //******************************************************************************
  75 //*
  76 //*     P R I V A T E   M E M B E R S
  77 //*
  78 //******************************************************************************
  79
  80 //******************************************************************************
  81 //*
  82 //*     P R O T E C T E D   M E T H O D S
  83 //*
  84 //******************************************************************************
  85
  86 /**
  87  * @brief Return the size of an iterator object.
  88  *
  89  * @return U32 : size of iterator object in bytes.
  90  *
  91  */
  92 U32 sci_iterator_get_object_size(
  93    void
  94 )
  95 {
  96     return sizeof(SCI_BASE_ITERATOR_T);
  97 }
  98
  99 /**
 100  * @brief Initialize the interator.
 101  *
 102  * @param[in] iterator This parameter specifies the iterator to be
 103  *            constructed.
 104  * @param[in] list This parameter specifies the abstract list that will be
 105  *            iterated on by this iterator.  The iterator will by initialized
 106  *            to point to the first element in this abstract list.
 107  *
 108  * @return none
 109  */
 110 void sci_base_iterator_construct(
 111    SCI_ITERATOR_HANDLE_T   iterator_handle,
 112    SCI_ABSTRACT_LIST_T   * list
 113 )
 114 {
 115     SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *) iterator_handle;
 116
 117     memset(iterator, 0, sizeof(SCI_BASE_ITERATOR_T));
 118     iterator->list = list;
 119     sci_iterator_first(iterator);
 120 }
 121
 122 /**
 123  * @brief Get the object currently pointed to by this iterator.
 124  *
 125  * @param[in] iterator_handle Handle to an iterator.
 126  *
 127  * @return void * : Object pointed to by this iterator.
 128  * @retval NULL If iterator is not currently pointing to a valid element.
 129  */
 130 void * sci_iterator_get_current(
 131    SCI_ITERATOR_HANDLE_T iterator_handle
 132 )
 133 {
 134    SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
 135
 136    void *current_object = NULL;
 137
 138    if (iterator->current != NULL)
 139    {
 140       current_object = sci_abstract_list_get_object(iterator->current);
 141    }
 142
 143    return current_object;
 144 }
 145
 146 /**
 147  * @brief Modify the iterator to point to the first element in the list.
 148  *
 149  * @param[in] iterator
 150  *
 151  * @return none
 152  */
 153 void sci_iterator_first(
 154    SCI_ITERATOR_HANDLE_T iterator_handle
 155 )
 156 {
 157    SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
 158
 159    iterator->current = sci_abstract_list_get_front(iterator->list);
 160 }
 161
 162 /**
 163  * @brief Modify the iterator to point to the next element in the list.
 164  *
 165  * @param[in] iterator
 166  *
 167  * @return none
 168  */
 169 void sci_iterator_next(
 170    SCI_ITERATOR_HANDLE_T iterator_handle
 171 )
 172 {
 173    SCI_BASE_ITERATOR_T * iterator = (SCI_BASE_ITERATOR_T *)iterator_handle;
 174
 175    if (iterator->current != NULL)
 176    {
 177       iterator->current = sci_abstract_list_get_next(iterator->current);
 178    }
 179 }
 180
 181 #endif // !defined(DISABLE_SCI_ITERATORS)
 182