2 // Open Service Platform
3 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FBaseColIteratorT.h
20 * @brief This is the header file for the %IteratorT class.
22 * This header file contains the declarations of the %IteratorT class.
25 #ifndef _FBASE_COL_ITERATOR_T_H_
26 #define _FBASE_COL_ITERATOR_T_H_
28 #include <algorithm> // std::swap (Before C++11)
30 #include <unique_ptr.h>
32 #include <FBaseColIList.h>
33 #include <FBaseColIBidirectionalEnumerator.h>
35 namespace Tizen { namespace Base { namespace Collection
39 * @brief This class provides an iterator that is used to convert IList to STL containers.
40 * StlConverter provides static methods to get this iterator from IList.
44 * @remarks This class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
45 * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
48 template < typename T >
50 : public std::iterator< std::input_iterator_tag, T >
54 * Initializes this instance of %IteratorT class.
58 * @param[in] list A reference to the IList instance to convert
59 * @param[in] isPostEnd A boolean value to check the end
61 explicit IteratorT(const IList& list, bool isPostEnd = false)
63 , __isPostEnd(isPostEnd)
65 , __pEnum(__pList->GetBidirectionalEnumeratorN())
68 if (__pList->GetCount() != 0)
73 __currentObj = static_cast< T >(__pEnum->GetCurrent());
77 __index = __pList->GetCount();
78 __pEnum->MovePrevious();
83 // Control reaches here intentionally because begin() should be equal to end()
89 * This is copy constructor of %IteratorT class.
93 * @param[in] rhs A reference to the %IteratorT instance
95 IteratorT(const IteratorT< T >& rhs)
96 : __pList(rhs.__pList)
97 , __isPostEnd(rhs.__isPostEnd)
98 , __index(rhs.__index)
99 , __pEnum(__pList->GetBidirectionalEnumeratorN())
100 , __currentObj(rhs.__currentObj)
104 for (int i = 0; i <= __index; ++i)
111 __pEnum->MovePrevious();
116 * This is assignment operator of %IteratorT class.
120 * @return A reference to the %IteratorT instance
121 * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator
123 IteratorT< T >& operator=(const IteratorT< T >& rhs)
125 IteratorT< T > tmp(rhs);
131 * This is the indirection operator for %IteratorT class.
135 * @return A T type reference
137 T& operator*(void) const
139 AppAssertf(!__isPostEnd && __index >= 0, "It is out of range.");
140 return const_cast< T& >(__currentObj);
144 * This is the structure dereference operator for %IteratorT class.
148 * @return A T type pointer equivalent to the pointer address
150 T* operator->(void) const
152 return &(operator*());
156 * Moves to the next element of the collection.
160 * @return A reference to the %IteratorT type instance
161 * @exception E_SUCCESS The method is successful.
162 * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
163 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
164 * the collection is modified after the enumerator is created.
165 * @remarks The specific error code can be accessed using GetLastResult() method.
167 IteratorT< T >& operator++(void)
169 const int PRE_BEGIN_IDX = -1;
170 TryCatchResult(__index >= PRE_BEGIN_IDX, , E_OUT_OF_RANGE, "[%s] It is out of range.", GetErrorMessage(E_OUT_OF_RANGE));
172 if (__index != PRE_BEGIN_IDX)
174 result r = __pEnum->MoveNext();
175 TryCatchResult(r == E_SUCCESS, __isPostEnd = true; __currentObj = null, r, "[%s] It already reached the end.", GetErrorMessage(r));
178 __currentObj = static_cast< T >(__pEnum->GetCurrent());
186 * Moves to the next element of the collection and returns the previous state.
190 * @return An IteratorT instance
191 * @exception E_SUCCESS The method is successful.
192 * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
193 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
194 * the collection is modified after the enumerator is created.
195 * @remarks It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
196 * @remarks The specific error code can be accessed using GetLastResult() method.
198 IteratorT< T > operator++(int)
200 IteratorT< T > tempIter = *this;
206 * Moves to the previous element of the collection.
210 * @return A reference to the %IteratorT type instance
211 * @exception E_SUCCESS The method is successful.
212 * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
213 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
214 * the collection is modified after the enumerator is created.
215 * @remarks The specific error code can be accessed using GetLastResult() method.
217 IteratorT< T >& operator--(void)
219 TryCatchResult(__index <= __pList->GetCount(), , E_OUT_OF_RANGE, "[%s] It is out of range.", GetErrorMessage(E_OUT_OF_RANGE));
223 result r = __pEnum->MovePrevious();
224 TryCatchResult(r == E_SUCCESS, __currentObj = null, r, "[%s] It already reached the front.", GetErrorMessage(r));
231 __currentObj = static_cast< T >(__pEnum->GetCurrent());
239 * Moves to the previous element of the collection and returns the previous state.
243 * @return An IteratorT instance
244 * @exception E_SUCCESS The method is successful.
245 * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
246 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation or
247 * the collection is modified after the enumerator is created.
248 * @remarks It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
249 * @remarks The specific error code can be accessed using GetLastResult() method.
251 IteratorT< T > operator--(int)
253 IteratorT< T > tempIter = *this;
259 * Checks the two %IteratorT instances for equality
263 * @return @c true if every member of the specified %IteratorT instance equals the calling instance's members, @n
265 * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator
267 bool operator==(const IteratorT< T >& rhs) const
269 if (__pList != rhs.__pList)
274 if (__index != rhs.__index)
279 if (__isPostEnd != rhs.__isPostEnd)
283 else if (__isPostEnd && rhs.__isPostEnd)
285 // In this case, __currentObj state is invalid
289 // If both this->__isPostEnd and rhs.__isPostEnd are false, then reach here. This means both iterators are in the middle of the list.
290 return __currentObj == rhs.__currentObj;
294 * Checks the two %IteratorT instances for inequality.
298 * @return @c true if every member of the specified %IteratorT instance is not equal to the calling instance's members, @n
300 * @param[in] rhs A reference to the %IteratorT instance on the right-hand side of the operator
302 bool operator!=(const IteratorT< T >& rhs) const
304 return !operator==(rhs);
308 * Exchanges values of the two %IteratorT instances
312 * @param[in] rhs A reference to the %IteratorT instance to swap
314 void swap(IteratorT< T >& rhs)
316 std::swap(__pList, rhs.__pList);
317 std::swap(__isPostEnd, rhs.__isPostEnd);
318 std::swap(__index, rhs.__index);
319 std::swap(__pEnum, rhs.__pEnum);
320 std::swap(__currentObj, rhs.__currentObj);
324 const IList* __pList;
327 std::unique_ptr< IBidirectionalEnumerator > __pEnum;
331 }}} // Tizen::Base::Collection
333 #endif //_FBASE_COL_ITERATOR_T_H_