summaryrefslogtreecommitdiffstats
path: root/src/include/usr/targeting/iterators/targetiterator.H
blob: 6819de498907fe634a642cd26f568827977ffadd (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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/include/usr/targeting/iterators/targetiterator.H $
//
//  IBM CONFIDENTIAL
//
//  COPYRIGHT International Business Machines Corp. 2011
//
//  p1
//
//  Object Code Only (OCO) source materials
//  Licensed Internal Code Source Materials
//  IBM HostBoot Licensed Internal Code
//
//  The source code for this program is not published or other-
//  wise divested of its trade secrets, irrespective of what has
//  been deposited with the U.S. Copyright Office.
//
//  Origin: 30
//
//  IBM_PROLOG_END

#ifndef TARG_TARGETITERATOR_H
#define TARG_TARGETITERATOR_H

/**
 *  @file targetiterator.H
 *
 *  @brief Interface describing iterator/const iterator used to iterate through
 *      target service targets 
 */

//******************************************************************************
// Includes
//******************************************************************************

// STD
#include <stddef.h>

// Other Host Boot Components
#include <builtins.h>

// Targeting Component

//******************************************************************************
// Macros
//******************************************************************************

#undef TARG_NAMESPACE
#undef TARG_CLASS
#undef TARG_FUNC

//******************************************************************************
// Interface
//******************************************************************************

namespace TARGETING
{

#define TARG_NAMESPACE "TARGETING::"

#define TARG_CLASS "_TargetIterator<T>::"

class Target;
 
/**
 *  @brief Class which iterates through targets managed by the target service.
 *      Provides "Target*" and "const Target*" versions via templates
 */        
template<typename T>       
class _TargetIterator
{
    public:

        /**
         *  @brief Maps type of iterated element to common alias (Target* or
         *      const Target*)
         */
        typedef T iterator;
        typedef T value_type;

        /**
         *  @brief Create an iterator to a (const/non-const) target handle.  
         *      Defaults to end()
         */
        ALWAYS_INLINE
        _TargetIterator()
            : iv_pCurrent(NULL)
        {
        }

        /**
         *  @brief Create an iterator to a (const/non-const) target handle
         *
         *  @param[in] i_pTarget Target handle (pointer or const pointer 
         *      depending on flavor) the iterator should reference
         */
        ALWAYS_INLINE
        explicit _TargetIterator(T i_pTarget) 
            : iv_pCurrent(i_pTarget)
        {
        }   

        /**
         *  @brief Destroy an iterator to a (const/non-const) target handle 
         *
         *  @note Iterator does not own any resources to destroy
         */
        ALWAYS_INLINE
        ~_TargetIterator()
        {
        }

        /**  
         *  @brief Dereference the iterator (return what it points to)
         *
         *  @return Target handle in form of Target* or const Target*
         *
         *  @note Returns NULL if it points to end(), should not be 
         *      dereferenced in this case.
         */  
        ALWAYS_INLINE
        T operator* () const
        {
            // Only return copy of the target pointer (instead of a reference)
            // because a reference will go out of scope when the iterator 
            // advances
            return iv_pCurrent;
        }

        /**  
         *  @brief Dereference the iterator (return what it points to) 
         *      and (outside this function) call a function/member of 
         *      the referenced target
         *
         *  @return Target handle in form of Target* or const Target*
         *
         *  @note Returns NULL if it points to end(), causing an 
         *      assert when automatically dereferenced.
         */          
        ALWAYS_INLINE
        T operator->() const
        {
            // Only return copy of the target pointer (instead of a reference)
            // because a reference will go out of scope when the iterator 
            // advances
            return iv_pCurrent;
        }

        /**  
         *  @brief Pre-increment the iterator
         *
         *  @return The reference to the same iterator after advancing it
         */    
        ALWAYS_INLINE
        _TargetIterator& operator++();

        /**  
         *  @brief Post-increment the iterator
         *
         *  @param[in] UNNAMED Dummy parameter used to distinguish
         *      this interface from pre-increment
         *
         *  @return Copy of the original iterator before it advanced
         */         
        ALWAYS_INLINE
        _TargetIterator operator++(int);
        
        /**  
         *  @brief Determine if two iterators of same type are logically equal
         *
         *  @param[in] i_rhs The other iterator to compare
         * 
         *  @return bool indicating whether the iterators point to the same
         *      entity
         *  
         *  @retval true Iterators point to same entity
         *  @retval false Iterators do not point to same entity
         */   
        ALWAYS_INLINE
        bool operator==(const _TargetIterator& i_rhs) const
        {
            return (iv_pCurrent == i_rhs.iv_pCurrent);
        }

        /**  
         *  @brief Determine if two iterators of same type are logically not 
         *      equal
         *
         *  @param[in] i_rhs The other iterator to compare
         * 
         *  @return bool indicating whether the iterators point to a different
         *      logical entity
         *  
         *  @retval true Iterators point to different entity
         *  @retval false Iterators point to same entity
         */   
        ALWAYS_INLINE
        bool operator!=(const _TargetIterator& i_rhs) const
        {
            return (iv_pCurrent != i_rhs.iv_pCurrent);
        }

        /**  
         *  @brief Assignment operator; assign iterator to another (such that
         *      they logically point to same entity)
         *
         *  @param[in] i_rhs The iterator to assign
         * 
         *  @return Reference to the iterator, now updated to point to the same
         *      entity as the input iterator points to
         */ 
        ALWAYS_INLINE
        _TargetIterator& operator=(const _TargetIterator& i_rhs)
        {
            iv_pCurrent = i_rhs.iv_pCurrent;
            return *this;
        }

        /**  
         *  @brief Copy constructor; assign iterator to a new iterator (such 
         *      that they logically point to same entity)
         *
         *  @param[in] i_rhs The iterator to assign
         */ 
        ALWAYS_INLINE
        _TargetIterator(const _TargetIterator& i_rhs) 
         :   iv_pCurrent(i_rhs.iv_pCurrent)
        {
        }

    private:
    
        /**
         *  @brief Advance the iterator to point to the next item maintained by
         *      the target service (or end() if end of list)
         */
        void advance();

        T iv_pCurrent; // Pointer to current target
};

/**
 *  @brief Type aliases to simplify user code
 */
typedef _TargetIterator<Target*> TargetIterator;
typedef _TargetIterator<const Target*> ConstTargetIterator;
        
//******************************************************************************
// _TargetIterator::operator++ (postincrement)
//******************************************************************************

template<typename T>
_TargetIterator<T> _TargetIterator<T>::operator++(int) 
{
    _TargetIterator l_originalIterator(*this);
    advance();
    return l_originalIterator;
}
        
//******************************************************************************
// _TargetIterator::operator++ (preincrement)
//******************************************************************************

template<typename T>
_TargetIterator<T>& _TargetIterator<T>::operator++()
{
    advance();
    return *this;
}

#undef TARG_CLASS
#undef TARG_NAMESPACE

} // End namespace TARGETING

#endif // TARG_TARGETITERATOR_H

OpenPOWER on IntegriCloud