2 // Utility subroutines for the C++ library testsuite.
4 // Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
5 // Free Software Foundation, Inc.
7 // This file is part of the GNU ISO C++ Library. This library is free
8 // software; you can redistribute it and/or modify it under the
9 // terms of the GNU General Public License as published by the
10 // Free Software Foundation; either version 2, or (at your option)
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License along
19 // with this library; see the file COPYING. If not, write to the Free
20 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
23 // As a special exception, you may use this file as part of a free software
24 // library without restriction. Specifically, if other files instantiate
25 // templates or use macros or inline functions from this file, or you compile
26 // this file and link it with other files to produce an executable, this
27 // file does not by itself cause the resulting executable to be covered by
28 // the GNU General Public License. This exception does not however
29 // invalidate any other reasons why the executable file might be covered by
30 // the GNU General Public License.
32 // This file provides the following:
34 // 1) VERIFY(), via _GLIBCXX_ASSERT, from Brent Verner <brent@rcfile.org>.
35 // This file is included in the various testsuite programs to provide
36 // #define(able) assert() behavior for debugging/testing. It may be
37 // a suitable location for other furry woodland creatures as well.
39 // 2) set_memory_limits()
40 // set_memory_limits() uses setrlimit() to restrict dynamic memory
41 // allocation. We provide a default memory limit if none is passed by the
42 // calling application. The argument to set_memory_limits() is the
43 // limit in megabytes (a floating-point number). If _GLIBCXX_RES_LIMITS is
44 // not #defined before including this header, then no limiting is attempted.
47 // This is a POD with a static data member, gnu_counting_struct::count,
48 // which starts at zero, increments on instance construction, and decrements
49 // on instance destruction. "assert_count(n)" can be called to VERIFY()
50 // that the count equals N.
52 // 4) copy_tracker, from Stephen M. Webb <stephen@bregmasoft.com>.
53 // A class with nontrivial ctor/dtor that provides the ability to track the
54 // number of copy ctors and dtors, and will throw on demand during copy.
56 #ifndef _GLIBCXX_TESTSUITE_HOOKS_H
57 #define _GLIBCXX_TESTSUITE_HOOKS_H
59 #include <bits/c++config.h>
60 #include <bits/functexcept.h>
63 #ifdef _GLIBCXX_HAVE_SYS_STAT_H
67 #ifdef _GLIBCXX_ASSERT
69 # define VERIFY(fn) assert(fn)
71 # define VERIFY(fn) test &= (fn)
74 #ifdef _GLIBCXX_HAVE_UNISTD_H
82 // All macros are defined in GLIBCXX_CONFIGURE_TESTSUITE and imported
85 // Set memory limits if possible, if not set to 0.
86 #ifndef _GLIBCXX_RES_LIMITS
87 # define MEMLIMIT_MB 0
90 # define MEMLIMIT_MB 16.0
94 set_memory_limits(float __size
= MEMLIMIT_MB
);
97 set_file_limit(unsigned long __size
);
99 // Check mangled name demangles (using __cxa_demangle) as expected.
101 verify_demangle(const char* mangled
, const char* wanted
);
103 // 17.3.2.1.2 - Bitmask types [lib.bitmask.types]
105 template<typename bitmask_type
>
107 bitmask_operators(bitmask_type a
= bitmask_type(),
108 bitmask_type b
= bitmask_type())
119 // Simple callback structure for variable numbers of tests (all with
120 // same signature). Assume all unit tests are of the signature
125 typedef void (*test_type
) (void);
129 test_type _M_tests
[15];
132 operator=(const func_callback
&);
134 func_callback(const func_callback
&);
137 func_callback(): _M_size(0) { }
140 size() const { return _M_size
; }
143 tests() const { return _M_tests
; }
146 push_back(test_type test
)
148 _M_tests
[_M_size
] = test
;
154 // Run select unit tests after setting global locale.
156 run_tests_wrapped_locale(const char*, const func_callback
&);
158 // Run select unit tests after setting environment variables.
160 run_tests_wrapped_env(const char*, const char*, const func_callback
&);
165 // Specifically and glaringly-obviously marked 'signed' so that when
166 // COUNT mistakenly goes negative, we can track the patterns of
167 // deletions more easily.
168 typedef signed int size_type
;
169 static size_type count
;
170 counter() { ++count
; }
171 counter (const counter
&) { ++count
; }
172 ~counter() { --count
; }
175 #define assert_count(n) VERIFY(__gnu_test::counter::count == n)
177 // A (static) class for counting copy constructors and possibly throwing an
178 // exception on a desired count.
179 class copy_constructor
183 count() { return count_
; }
189 if (count_
== throw_on_
)
190 std::__throw_runtime_error("copy_constructor::mark_call");
201 throw_on(unsigned int count
) { throw_on_
= count
; }
204 static unsigned int count_
;
205 static unsigned int throw_on_
;
208 // A (static) class for counting assignment operator calls and
209 // possibly throwing an exception on a desired count.
210 class assignment_operator
214 count() { return count_
; }
220 if (count_
== throw_on_
)
221 std::__throw_runtime_error("assignment_operator::mark_call");
232 throw_on(unsigned int count
) { throw_on_
= count
; }
235 static unsigned int count_
;
236 static unsigned int throw_on_
;
239 // A (static) class for tracking calls to an object's destructor.
244 count() { return _M_count
; }
247 mark_call() { _M_count
++; }
250 reset() { _M_count
= 0; }
253 static unsigned int _M_count
;
256 // An class of objects that can be used for validating various
257 // behaviours and guarantees of containers and algorithms defined in
258 // the standard library.
262 // Creates a copy-tracking object with the given ID number. If
263 // "throw_on_copy" is set, an exception will be thrown if an
264 // attempt is made to copy this object.
265 copy_tracker(int id
= next_id_
--, bool throw_on_copy
= false)
266 : id_(id
) , throw_on_copy_(throw_on_copy
) { }
268 // Copy-constructs the object, marking a call to the copy
269 // constructor and forcing an exception if indicated.
270 copy_tracker(const copy_tracker
& rhs
)
271 : id_(rhs
.id()), throw_on_copy_(rhs
.throw_on_copy_
)
274 copy_constructor::throw_on(copy_constructor::count() + 1);
275 copy_constructor::mark_call();
278 // Assigns the value of another object to this one, tracking the
279 // number of times this member function has been called and if the
280 // other object is supposed to throw an exception when it is
281 // copied, well, make it so.
283 operator=(const copy_tracker
& rhs
)
286 if (rhs
.throw_on_copy_
)
287 assignment_operator::throw_on(assignment_operator::count() + 1);
288 assignment_operator::mark_call();
293 { destructor::mark_call(); }
296 id() const { return id_
; }
300 const bool throw_on_copy_
;
306 copy_constructor::reset();
307 assignment_operator::reset();
311 // for backwards-compatibility
314 { return copy_constructor::count(); }
316 // for backwards-compatibility
319 { return destructor::count(); }
326 operator==(const copy_tracker
& lhs
, const copy_tracker
& rhs
)
327 { return lhs
.id() == rhs
.id(); }
329 // Class for checking required type conversions, implicit and
330 // explicit for given library data structures.
331 template<typename _Container
>
334 typedef typename
_Container::const_iterator const_iterator
;
336 // Implicit conversion iterator to const_iterator.
337 static const_iterator
338 iterator_to_const_iterator()
341 const_iterator it
= v
.begin();
342 const_iterator end
= v
.end();
343 return it
== end
? v
.end() : it
;
347 // A binary semaphore for use across multiple processes.
351 // Creates a binary semaphore. The semaphore is initially in the
355 // Destroy the semaphore.
358 // Signal the semaphore. If there are processes blocked in
359 // "wait", exactly one will be permitted to proceed.
362 // Wait until the semaphore is signaled.
371 // For use in 22_locale/time_get and time_put.
372 std::tm
test_tm(int sec
, int min
, int hour
, int mday
, int mon
,
373 int year
, int wday
, int yday
, int isdst
);
375 } // namespace __gnu_test
377 #endif // _GLIBCXX_TESTSUITE_HOOKS_H