summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Common/Code/ListIterator.h
blob: 92faa34088181d78ea92fb6c3ba086b32ccbf529 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/****************************************************************************
**
** Copyright (C) 1999-2002 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
//==============================================================================
//	Prefix
//==============================================================================
#ifndef __LISTITERATOR_H__
#define __LISTITERATOR_H__

//==============================================================================
//	Class
//==============================================================================
/**
 *	@class CListIterator
 */
template <class Obj, class List>
class CListIterator
{
    // Typedefs
    // Field members
protected:
    typename List::iterator m_Begin;
    typename List::iterator m_Pos;
    typename List::iterator m_End;

    // Construction/Destruction
public:
    CListIterator(typename List::iterator inBegin, typename List::iterator inEnd);
    ~CListIterator();

    // Access
public:
    bool HasNext();
    Obj GetCurrent();
    CListIterator<Obj, List> operator++();
    CListIterator<Obj, List> operator--();
    CListIterator<Obj, List> operator+=(const long &inNum);
    CListIterator<Obj, List> operator-=(const long &inNum);
    operator typename List::iterator();
    CListIterator<Obj, List> &operator=(const typename List::iterator &inIterator);
};

/**
 *	Constructs a list iterator based given the begin and end iterators for the List.
 */
template <class Obj, class List>
CListIterator<Obj, List>::CListIterator(typename List::iterator inBegin,
                                        typename List::iterator inEnd)
    : m_Begin(inBegin)
    , m_Pos(inBegin)
    , m_End(inEnd)
{
}

/**
 *	Destructor
 */
template <class Obj, class List>
CListIterator<Obj, List>::~CListIterator()
{
}

/**
 *	Returns true if there is another item in the list.
 */
template <class Obj, class List>
bool CListIterator<Obj, List>::HasNext()
{
    return m_Pos != m_End;
}

/**
 *	Obtains the current object in the list.
 */
template <class Obj, class List>
Obj CListIterator<Obj, List>::GetCurrent()
{
    if (m_Pos != m_End)
        return *m_Pos;
    return NULL;
}

/**
 *	Increments the iterator to point to the next object in the list.
 */
template <class Obj, class List>
CListIterator<Obj, List> CListIterator<Obj, List>::operator++()
{
    if (m_Pos != m_End)
        ++m_Pos;
    return *this;
}

/**
 *	Decrements the iterator to point to the previous object in the list.
 */
template <class Obj, class List>
CListIterator<Obj, List> CListIterator<Obj, List>::operator--()
{
    if (m_Pos != m_Begin)
        --m_Pos;
    return *this;
}

/**
 *	Increments the iterator to point to the an object later in the list.
 */
template <class Obj, class List>
CListIterator<Obj, List> CListIterator<Obj, List>::operator+=(const long &inNum)
{
    if ((m_Pos + inNum) >= m_Begin && (m_Pos + inNum) < m_End)
        m_Pos += inNum;
    return *this;
}

/**
 *	Decrements the iterator to point to the an object earlier in the list.
 */
template <class Obj, class List>
CListIterator<Obj, List> CListIterator<Obj, List>::operator-=(const long &inNum)
{
    if ((m_Pos - inNum) >= m_Begin && (m_Pos - inNum) < m_End)
        m_Pos -= inNum;
    return *this;
}

/**
 *	Implicit cast operator to obtain the actual iterator from the container.
 */
template <class Obj, class List>
CListIterator<Obj, List>::operator typename List::iterator()
{
    return m_Pos;
}

/**
 *	Assignment operator for taking in an iterator of the container type.
 */
template <class Obj, class List>
CListIterator<Obj, List> &CListIterator<Obj, List>::
operator=(const typename List::iterator &inIterator)
{
    if (m_Pos != inIterator)
        m_Pos = inIterator;

    return *this;
}

#endif // __LISTITERATOR_H__