libstdc++-v3/testsuite/testsuite_hooks.h

   1 // -*- C++ -*-
   2 // Utility subroutines for the C++ library testsuite.
   3 //
   4 // Copyright (C) 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
   5 //
   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)
  10 // any later version.
  11 //
  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.
  16 //
  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,
  20 // USA.
  21 //
  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.
  30
  31 // This file provides the following:
  32 //
  33 // 1)  VERIFY(), via DEBUG_ASSERT, from Brent Verner <brent@rcfile.org>.
  34 //   This file is included in the various testsuite programs to provide
  35 //   #define(able) assert() behavior for debugging/testing. It may be
  36 //   a suitable location for other furry woodland creatures as well.
  37 //
  38 // 2)  set_memory_limits()
  39 //   set_memory_limits() uses setrlimit() to restrict dynamic memory
  40 //   allocation.  We provide a default memory limit if none is passed by the
  41 //   calling application.  The argument to set_memory_limits() is the
  42 //   limit in megabytes (a floating-point number).  If _GLIBCPP_MEM_LIMITS is
  43 //   not #defined before including this header, then no limiting is attempted.
  44 //
  45 // 3)  counter
  46 //   This is a POD with a static data member, gnu_counting_struct::count,
  47 //   which starts at zero, increments on instance construction, and decrements
  48 //   on instance destruction.  "assert_count(n)" can be called to VERIFY()
  49 //   that the count equals N.
  50 //
  51 // 4)  copy_tracker, from Stephen M. Webb <stephen@bregmasoft.com>.
  52 //   A class with nontrivial ctor/dtor that provides the ability to track the
  53 //   number of copy ctors and dtors, and will throw on demand during copy.
  54 //
  55 // 5) pod_char, pod_int, , abstract character classes and
  56 //   char_traits specializations for testing instantiations.
  57
  58 #ifndef _GLIBCPP_TESTSUITE_HOOKS_H
  59 #define _GLIBCPP_TESTSUITE_HOOKS_H
  60
  61 #include <bits/c++config.h>
  62 #include <bits/functexcept.h>
  63 #include <cstddef>
  64 #ifdef DEBUG_ASSERT
  65 # include <cassert>
  66 # define VERIFY(fn) assert(fn)
  67 #else
  68 # define VERIFY(fn) test &= (fn)
  69 #endif
  70 #include <list>
  71
  72 namespace __gnu_cxx_test
  73 {
  74   // All macros are defined in GLIBCPP_CONFIGURE_TESTSUITE and imported
  75   // from c++config.h
  76
  77   // Set memory limits if possible, if not set to 0.
  78 #ifndef _GLIBCPP_MEM_LIMITS
  79 #  define MEMLIMIT_MB 0
  80 #else
  81 # ifndef MEMLIMIT_MB
  82 #  define MEMLIMIT_MB 16.0
  83 # endif
  84 #endif
  85   extern void
  86   set_memory_limits(float __size = MEMLIMIT_MB);
  87
  88
  89   // Check mangled name demangles (using __cxa_demangle) as expected.
  90   void
  91   verify_demangle(const char* mangled, const char* wanted);
  92
  93
  94   // Simple callback structure for variable numbers of tests (all with
  95   // same signature).  Assume all unit tests are of the signature
  96   // void test01();
  97   typedef void (*test_func) (void);
  98   typedef std::list<test_func> func_callback;
  99
 100   // Run select unit tests after setting global locale.
 101   void
 102   run_tests_wrapped_locale(const char*, const func_callback&);
 103
 104   // Run select unit tests after setting environment variables.
 105   void
 106   run_tests_wrapped_env(const char*, const char*, const func_callback&);
 107
 108   // Run select unit test inside exception catcher for non-C named locale
 109   void
 110   run_test_wrapped_generic_locale_exception_catcher(const test_func);
 111
 112   // Test data types.
 113   struct pod_char
 114   {
 115     unsigned char c;
 116   };
 117
 118   struct pod_int
 119   {
 120     int i;
 121   };
 122
 123   struct pod_unsigned_int
 124   {
 125     unsigned int i;
 126   };
 127
 128   struct pod_long
 129   {
 130     unsigned long i;
 131   };
 132
 133   struct state
 134   {
 135     unsigned long l;
 136     unsigned long l2;
 137   };
 138
 139   // Counting.
 140   struct counter
 141   {
 142     // Specifically and glaringly-obviously marked 'signed' so that when
 143     // COUNT mistakenly goes negative, we can track the patterns of
 144     // deletions more easily.
 145     typedef  signed int     size_type;
 146     static size_type   count;
 147     counter() { ++count; }
 148     counter (const counter&) { ++count; }
 149     ~counter() { --count; }
 150   };
 151
 152 #define assert_count(n)   VERIFY(__gnu_cxx_test::counter::count == n)
 153
 154   // A (static) class for counting copy constructors and possibly throwing an
 155   // exception on a desired count.
 156   class copy_constructor
 157   {
 158   public:
 159     static unsigned int
 160     count() { return count_; }
 161
 162     static void
 163     mark_call()
 164     {
 165       count_++;
 166       if (count_ == throw_on_)
 167         __throw_exception_again "copy constructor exception";
 168     }
 169
 170     static void
 171     reset()
 172     {
 173       count_ = 0;
 174       throw_on_ = 0;
 175     }
 176
 177     static void
 178     throw_on(unsigned int count) { throw_on_ = count; }
 179
 180   private:
 181     static unsigned int count_;
 182     static unsigned int throw_on_;
 183   };
 184
 185   // A (static) class for counting assignment operator calls and
 186   // possibly throwing an exception on a desired count.
 187   class assignment_operator
 188   {
 189   public:
 190     static unsigned int
 191     count() { return count_; }
 192
 193     static void
 194     mark_call()
 195     {
 196       count_++;
 197       if (count_ == throw_on_)
 198         __throw_exception_again "assignment operator exception";
 199     }
 200
 201     static void
 202     reset()
 203     {
 204       count_ = 0;
 205       throw_on_ = 0;
 206     }
 207
 208     static void
 209     throw_on(unsigned int count) { throw_on_ = count; }
 210
 211   private:
 212     static unsigned int count_;
 213     static unsigned int throw_on_;
 214   };
 215
 216   // A (static) class for tracking calls to an object's destructor.
 217   class destructor
 218   {
 219   public:
 220     static unsigned int
 221     count() { return _M_count; }
 222
 223     static void
 224     mark_call() { _M_count++; }
 225
 226     static void
 227     reset() { _M_count = 0; }
 228
 229   private:
 230     static unsigned int _M_count;
 231   };
 232
 233   // An class of objects that can be used for validating various
 234   // behaviours and guarantees of containers and algorithms defined in
 235   // the standard library.
 236   class copy_tracker
 237   {
 238   public:
 239     // Creates a copy-tracking object with the given ID number.  If
 240     // "throw_on_copy" is set, an exception will be thrown if an
 241     // attempt is made to copy this object.
 242     copy_tracker(int id = next_id_--, bool throw_on_copy = false)
 243     : id_(id) , throw_on_copy_(throw_on_copy) { }
 244
 245     // Copy-constructs the object, marking a call to the copy
 246     // constructor and forcing an exception if indicated.
 247     copy_tracker(const copy_tracker& rhs)
 248     : id_(rhs.id()), throw_on_copy_(rhs.throw_on_copy_)
 249     {
 250       int kkk = throw_on_copy_;
 251       if (throw_on_copy_)
 252         copy_constructor::throw_on(copy_constructor::count() + 1);
 253       copy_constructor::mark_call();
 254     }
 255
 256     // Assigns the value of another object to this one, tracking the
 257     // number of times this member function has been called and if the
 258     // other object is supposed to throw an exception when it is
 259     // copied, well, make it so.
 260     copy_tracker&
 261     operator=(const copy_tracker& rhs)
 262     {
 263       id_ = rhs.id();
 264       if (rhs.throw_on_copy_)
 265         assignment_operator::throw_on(assignment_operator::count() + 1);
 266       assignment_operator::mark_call();
 267     }
 268
 269     ~copy_tracker()
 270     { destructor::mark_call(); }
 271
 272     int
 273     id() const { return id_; }
 274
 275   private:
 276     int   id_;
 277     const bool  throw_on_copy_;
 278
 279   public:
 280     static void
 281     reset()
 282     {
 283       copy_constructor::reset();
 284       assignment_operator::reset();
 285       destructor::reset();
 286     }
 287
 288     // for backwards-compatibility
 289     static int
 290     copyCount()
 291     { return copy_constructor::count(); }
 292
 293     // for backwards-compatibility
 294     static int
 295     dtorCount()
 296     { return destructor::count(); }
 297
 298   private:
 299     static int next_id_;
 300   };
 301
 302   inline bool
 303   operator==(const copy_tracker& lhs, const copy_tracker& rhs)
 304   { return lhs.id() == rhs.id(); }
 305 }; // namespace __gnu_cxx_test
 306
 307 namespace std
 308 {
 309   template<class _CharT>
 310     struct char_traits;
 311
 312   // char_traits specialization
 313   template<>
 314     struct char_traits<__gnu_cxx_test::pod_char>
 315     {
 316       typedef __gnu_cxx_test::pod_char  char_type;
 317       typedef __gnu_cxx_test::pod_int   int_type;
 318       typedef long                      pos_type;
 319       typedef unsigned long             off_type;
 320       typedef __gnu_cxx_test::state     state_type;
 321
 322       static void
 323       assign(char_type& __c1, const char_type& __c2);
 324
 325       static bool
 326       eq(const char_type& __c1, const char_type& __c2);
 327
 328       static bool
 329       lt(const char_type& __c1, const char_type& __c2);
 330
 331       static int
 332       compare(const char_type* __s1, const char_type* __s2, size_t __n);
 333
 334       static size_t
 335       length(const char_type* __s);
 336
 337       static const char_type*
 338       find(const char_type* __s, size_t __n, const char_type& __a);
 339
 340       static char_type*
 341       move(char_type* __s1, const char_type* __s2, size_t __n);
 342
 343       static char_type*
 344       copy(char_type* __s1, const char_type* __s2, size_t __n);
 345
 346       static char_type*
 347       assign(char_type* __s, size_t __n, char_type __a);
 348
 349       static char_type
 350       to_char_type(const int_type& __c);
 351
 352       static int_type
 353       to_int_type(const char_type& __c);
 354
 355       static bool
 356       eq_int_type(const int_type& __c1, const int_type& __c2);
 357
 358       static int_type
 359       eof();
 360
 361       static int_type
 362       not_eof(const int_type& __c);
 363     };
 364 } // namespace std
 365
 366 #endif // _GLIBCPP_TESTSUITE_HOOKS_H
 367