2 // Iterator Wrappers for the C++ library testsuite.
4 // Copyright (C) 2004 Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
31 // This file provides the following:
33 // input_iterator_wrapper, output_iterator_wrapper
34 // forward_iterator_wrapper, bidirectional_iterator_wrapper and
35 // random_access_wrapper, which attempt to exactly perform the requirements
36 // of these types of iterators. These are constructed from the class
37 // test_container, which is given two pointers to T and an iterator type.
39 #include <testsuite_hooks.h>
42 #ifndef _TESTSUITE_ITERATORS
43 #define _TESTSUITE_ITERATORS
45 #ifdef DISABLE_ITERATOR_DEBUG
46 #define ITERATOR_VERIFY(x)
48 #define ITERATOR_VERIFY(x) VERIFY(x)
54 * @brief Simple container for holding two pointers.
56 * Note that input_iterator_wrapper changes first to denote
57 * how the valid range of == , ++, etc. change as the iterators are used.
60 struct BoundsContainer
64 BoundsContainer(T* _first, T* _last)
65 : first(_first), last(_last)
69 // Simple container for holding state of a set of output iterators.
71 struct OutputContainer : public BoundsContainer<T>
75 OutputContainer(T* _first, T* _last)
76 : BoundsContainer<T>(_first, _last), incrementedto(_first)
78 writtento = new bool[this->last - this->first];
79 for(int i = 0; i < this->last - this->first; i++)
84 { delete[] writtento; }
87 // Produced by output_iterator to allow limited writing to pointer
94 OutputContainer<T>* SharedInfo;
95 WritableObject(T* ptr_in,OutputContainer<T>* SharedInfo_in):
96 ptr(ptr_in), SharedInfo(SharedInfo_in)
100 operator=(T& new_val)
102 ITERATOR_VERIFY(SharedInfo->writtento[ptr - SharedInfo->first] == 0);
103 SharedInfo->writtento[ptr - SharedInfo->first] = 1;
109 * @brief output_iterator wrapper for pointer
111 * This class takes a pointer and wraps it to provide exactly
112 * the requirements of a output_iterator. It should not be
113 * instansiated directly, but generated from a test_container
116 struct output_iterator_wrapper: public std::iterator
117 <std::output_iterator_tag, T, ptrdiff_t, T*, T&>
119 typedef OutputContainer<T> ContainerType;
121 ContainerType* SharedInfo;
123 output_iterator_wrapper(T* _ptr, ContainerType* SharedInfo_in)
124 :ptr(_ptr), SharedInfo(SharedInfo_in)
126 ITERATOR_VERIFY(ptr >= SharedInfo->first && ptr <= SharedInfo->last);
129 output_iterator_wrapper(const output_iterator_wrapper& in)
130 :ptr(in.ptr), SharedInfo(in.SharedInfo)
136 ITERATOR_VERIFY(ptr < SharedInfo->last);
137 ITERATOR_VERIFY(SharedInfo->writtento[ptr - SharedInfo->first] == false);
138 return WritableObject<T>(ptr, SharedInfo);
141 output_iterator_wrapper&
142 operator=(const output_iterator_wrapper& in)
145 SharedInfo = in.SharedInfo;
148 output_iterator_wrapper&
151 ITERATOR_VERIFY(SharedInfo && ptr < SharedInfo->last);
152 ITERATOR_VERIFY(ptr>=SharedInfo->first);
154 SharedInfo->first=ptr;
158 output_iterator_wrapper
161 output_iterator_wrapper<T> tmp = *this;
169 * @brief input_iterator wrapper for pointer
171 * This class takes a pointer and wraps it to provide exactly
172 * the requirements of a input_iterator. It should not be
173 * instansiated directly, but generated from a test_container
176 class input_iterator_wrapper:public std::iterator
177 <std::input_iterator_tag, T, ptrdiff_t, T*, T&>
180 input_iterator_wrapper()
184 typedef BoundsContainer<T> ContainerType;
186 ContainerType* SharedInfo;
188 input_iterator_wrapper(T* _ptr, ContainerType* SharedInfo_in)
189 : ptr(_ptr), SharedInfo(SharedInfo_in)
190 { ITERATOR_VERIFY(ptr >= SharedInfo->first && ptr <= SharedInfo->last); }
192 input_iterator_wrapper(const input_iterator_wrapper& in)
193 : ptr(in.ptr), SharedInfo(in.SharedInfo)
197 operator==(const input_iterator_wrapper& in) const
199 ITERATOR_VERIFY(SharedInfo != NULL && SharedInfo == in.SharedInfo);
200 ITERATOR_VERIFY(ptr>=SharedInfo->first && in.ptr>=SharedInfo->first);
201 return ptr == in.ptr;
205 operator!=(const input_iterator_wrapper& in) const
207 return !(*this == in);
213 ITERATOR_VERIFY(SharedInfo && ptr < SharedInfo->last);
214 ITERATOR_VERIFY(ptr >= SharedInfo->first);
224 input_iterator_wrapper&
225 operator=(const input_iterator_wrapper& in)
228 SharedInfo = in.SharedInfo;
232 input_iterator_wrapper&
235 ITERATOR_VERIFY(SharedInfo && ptr < SharedInfo->last);
236 ITERATOR_VERIFY(ptr>=SharedInfo->first);
238 SharedInfo->first=ptr;
251 * @brief forward_iterator wrapper for pointer
253 * This class takes a pointer and wraps it to provide exactly
254 * the requirements of a forward_iterator. It should not be
255 * instansiated directly, but generated from a test_container
258 struct forward_iterator_wrapper:public input_iterator_wrapper<T>
260 typedef BoundsContainer<T> ContainerType;
261 typedef std::forward_iterator_tag iterator_category;
262 forward_iterator_wrapper(T* _ptr, ContainerType* SharedInfo_in)
263 :input_iterator_wrapper<T>(_ptr, SharedInfo_in)
266 forward_iterator_wrapper(const forward_iterator_wrapper& in)
267 :input_iterator_wrapper<T>(in)
270 forward_iterator_wrapper()
273 this->SharedInfo = NULL;
279 ITERATOR_VERIFY(this->SharedInfo && this->ptr < this->SharedInfo->last);
287 forward_iterator_wrapper&
290 ITERATOR_VERIFY(this->SharedInfo && this->ptr < this->SharedInfo->last);
295 forward_iterator_wrapper
298 forward_iterator_wrapper<T> tmp = *this;
305 * @brief bidirectional_iterator wrapper for pointer
307 * This class takes a pointer and wraps it to provide exactly
308 * the requirements of a forward_iterator. It should not be
309 * instansiated directly, but generated from a test_container
312 struct bidirectional_iterator_wrapper:public forward_iterator_wrapper<T>
314 typedef BoundsContainer<T> ContainerType;
315 typedef std::bidirectional_iterator_tag iterator_category;
316 bidirectional_iterator_wrapper(T* _ptr, ContainerType* SharedInfo_in)
317 :forward_iterator_wrapper<T>(_ptr, SharedInfo_in)
320 bidirectional_iterator_wrapper(const bidirectional_iterator_wrapper& in)
321 :forward_iterator_wrapper<T>(in)
324 bidirectional_iterator_wrapper(): forward_iterator_wrapper<T>()
327 bidirectional_iterator_wrapper&
328 operator=(const bidirectional_iterator_wrapper& in)
331 this->SharedInfo = in.SharedInfo;
335 bidirectional_iterator_wrapper&
338 ITERATOR_VERIFY(this->SharedInfo && this->ptr < this->SharedInfo->last);
343 bidirectional_iterator_wrapper
346 bidirectional_iterator_wrapper<T> tmp = *this;
351 bidirectional_iterator_wrapper&
354 ITERATOR_VERIFY(this->SharedInfo && this->ptr > this->SharedInfo->first);
359 bidirectional_iterator_wrapper
362 bidirectional_iterator_wrapper<T> tmp = *this;
369 * @brief random_access_iterator wrapper for pointer
371 * This class takes a pointer and wraps it to provide exactly
372 * the requirements of a forward_iterator. It should not be
373 * instansiated directly, but generated from a test_container
376 struct random_access_iterator_wrapper:public bidirectional_iterator_wrapper<T>
378 typedef BoundsContainer<T> ContainerType;
379 typedef std::random_access_iterator_tag iterator_category;
380 random_access_iterator_wrapper(T* _ptr, ContainerType* SharedInfo_in)
381 : bidirectional_iterator_wrapper<T>(_ptr, SharedInfo_in)
384 random_access_iterator_wrapper(const random_access_iterator_wrapper<T>& in)
385 : bidirectional_iterator_wrapper<T>(in)
388 random_access_iterator_wrapper():bidirectional_iterator_wrapper<T>()
391 random_access_iterator_wrapper&
392 operator=(const random_access_iterator_wrapper& in)
395 this->SharedInfo = in.SharedInfo;
398 random_access_iterator_wrapper&
401 ITERATOR_VERIFY(this->SharedInfo && this->ptr < this->SharedInfo->last);
406 random_access_iterator_wrapper
409 random_access_iterator_wrapper<T> tmp = *this;
414 random_access_iterator_wrapper&
417 ITERATOR_VERIFY(this->SharedInfo && this->ptr > this->SharedInfo->first);
422 random_access_iterator_wrapper
425 random_access_iterator_wrapper<T> tmp = *this;
430 random_access_iterator_wrapper&
431 operator+=(ptrdiff_t n)
435 ITERATOR_VERIFY(n <= this->SharedInfo->last - this->ptr);
440 ITERATOR_VERIFY(n <= this->ptr - this->SharedInfo->first);
446 random_access_iterator_wrapper
447 operator+(ptrdiff_t n)
449 random_access_iterator_wrapper<T> tmp = *this;
453 random_access_iterator_wrapper&
454 operator-=(ptrdiff_t n)
455 { return *this += -n; }
457 random_access_iterator_wrapper
458 operator-(ptrdiff_t n)
460 random_access_iterator_wrapper<T> tmp = *this;
465 operator-(const random_access_iterator_wrapper<T>& in)
467 ITERATOR_VERIFY(this->SharedInfo == in.SharedInfo);
468 return this->ptr - in.ptr;
472 operator[](ptrdiff_t n)
473 { return *(this + n); }
476 operator<(const random_access_iterator_wrapper<T>& in) const
478 ITERATOR_VERIFY(this->SharedInfo == in.SharedInfo);
479 return this->ptr < in.ptr;
483 operator>(const random_access_iterator_wrapper<T>& in) const
489 operator>=(const random_access_iterator_wrapper<T>& in) const
491 return !(*this < in);
495 operator<=(const random_access_iterator_wrapper<T>& in) const
497 return !(*this > in);
503 * @brief A container-type class for holding iterator wrappers
504 * test_container takes two parameters, a class T and an iterator
505 * wrapper templated by T (for example forward_iterator_wrapper<T>.
506 * It takes two pointers representing a range and presents them as
507 * a container of iterators.
509 template <class T, template<class T> class ItType>
510 struct test_container
512 typename ItType<T>::ContainerType bounds;
513 test_container(T* _first, T* _last):bounds(_first, _last)
519 ITERATOR_VERIFY(pos >= 0 && pos <= (bounds.last - bounds.first));
520 return ItType<T>(bounds.first + pos, &bounds);
526 ITERATOR_VERIFY(pos >= bounds.first && pos <= bounds.last);
527 return ItType<T>(pos, &bounds);
532 { return it(bounds.first); }
536 { return it(bounds.last); }