libstdc++-v3/testsuite/testsuite_hooks.h

   1 // Utility subroutines for the C++ library testsuite.
   2 //
   3 // Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20 //
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 // This file provides the following:
  31 //
  32 // 1)  VERIFY(), via DEBUG_ASSERT, from Brent Verner <brent@rcfile.org>.
  33 //   This file is included in the various testsuite programs to provide
  34 //   #define(able) assert() behavior for debugging/testing. It may be
  35 //   a suitable location for other furry woodland creatures as well.
  36 //
  37 // 2)  __set_testsuite_memlimit()
  38 //   __set_testsuite_memlimit() uses setrlimit() to restrict dynamic memory
  39 //   allocation.  We provide a default memory limit if none is passed by the
  40 //   calling application.  The argument to __set_testsuite_memlimit() is the
  41 //   limit in megabytes (a floating-point number).  If _GLIBCPP_MEM_LIMITS is
  42 //   not #defined before including this header, then no limiting is attempted.
  43 //
  44 // 3)  gnu_counting_struct
  45 //   This is a POD with a static data member, gnu_counting_struct::count,
  46 //   which starts at zero, increments on instance construction, and decrements
  47 //   on instance destruction.  "assert_count(n)" can be called to VERIFY()
  48 //   that the count equals N.
  49 //
  50 // 4)  gnu_copy_tracker, from Stephen M. Webb <stephen@bregmasoft.com>.
  51 //   A class with nontrivial ctor/dtor that provides the ability to track the
  52 //   number of copy ctors and dtors, and will throw on demand during copy.
  53 //
  54 // 5) gnu_char, gnu_char_traits, abstract character classes and
  55 // char_traits specializations for testing instantiations.
  56
  57 #ifndef _GLIBCPP_TESTSUITE_HOOKS_H
  58 #define _GLIBCPP_TESTSUITE_HOOKS_H
  59
  60 #include <bits/c++config.h>
  61 #include <bits/functexcept.h>
  62 #include <cstddef>
  63
  64 #ifdef DEBUG_ASSERT
  65 # include <cassert>
  66 # define VERIFY(fn) assert(fn)
  67 #else
  68 # define VERIFY(fn) test &= (fn)
  69 #endif
  70
  71 // Defined in GLIBCPP_CONFIGURE_TESTSUITE.
  72 #ifndef _GLIBCPP_MEM_LIMITS
  73 // Don't do memory limits.
  74 extern void
  75 __set_testsuite_memlimit(float x = 0);
  76
  77 #else
  78
  79 // Do memory limits.
  80 #ifndef MEMLIMIT_MB
  81 #define MEMLIMIT_MB 16.0
  82 #endif
  83
  84 extern void
  85 __set_testsuite_memlimit(float __size = MEMLIMIT_MB);
  86 #endif
  87
  88
  89 struct gnu_counting_struct
  90 {
  91     // Specifically and glaringly-obviously marked 'signed' so that when
  92     // COUNT mistakenly goes negative, we can track the patterns of
  93     // deletions more easily.
  94     typedef  signed int     size_type;
  95     static size_type   count;
  96     gnu_counting_struct() { ++count; }
  97     gnu_counting_struct (const gnu_counting_struct&) { ++count; }
  98     ~gnu_counting_struct() { --count; }
  99 };
 100
 101 #define assert_count(n)   VERIFY(gnu_counting_struct::count == n)
 102
 103
 104 class gnu_copy_tracker
 105 {
 106   public:
 107     // Cannot be explicit.  Conversion ctor used by list_modifiers.cc's
 108     // test03(), "range fill at beginning".
 109     gnu_copy_tracker (int anId, bool throwOnDemand = false)
 110     : itsId(anId), willThrow(throwOnDemand)
 111     {}
 112
 113     gnu_copy_tracker (const gnu_copy_tracker& rhs)
 114     : itsId(rhs.id()), willThrow(rhs.willThrow)
 115     {
 116       ++itsCopyCount;
 117       if (willThrow)
 118         __throw_exception_again "copy tracker exception";
 119     }
 120
 121     gnu_copy_tracker& operator=(const gnu_copy_tracker& rhs)
 122     {
 123       itsId = rhs.id();
 124       // willThrow must obviously already be false to get this far
 125     }
 126
 127     ~gnu_copy_tracker() { ++itsDtorCount; }
 128
 129     int
 130     id() const
 131     { return itsId; }
 132
 133   private:
 134           int   itsId;
 135     const bool  willThrow;
 136
 137   public:
 138     static void
 139     reset()
 140     { itsCopyCount = 0; itsDtorCount = 0; }
 141
 142     static int
 143     copyCount()
 144     { return itsCopyCount; }
 145
 146     static int
 147     dtorCount()
 148     { return itsDtorCount; }
 149
 150   private:
 151     static int itsCopyCount;
 152     static int itsDtorCount;
 153 };
 154
 155 struct gnu_char
 156 {
 157   unsigned long c;
 158 };
 159
 160 struct gnu_int
 161 {
 162   unsigned long i;
 163 };
 164
 165 struct gnu_state
 166 {
 167   unsigned long l;
 168   unsigned long l2;
 169 };
 170
 171 // char_traits specialization
 172 namespace std
 173 {
 174   template<class _CharT>
 175     struct char_traits;
 176
 177   template<>
 178     struct char_traits<gnu_char>
 179     {
 180       typedef gnu_char          char_type;
 181       typedef gnu_int           int_type;
 182       typedef long              pos_type;
 183       typedef unsigned long     off_type;
 184       typedef gnu_state         state_type;
 185
 186       static void
 187       assign(char_type& __c1, const char_type& __c2);
 188
 189       static bool
 190       eq(const char_type& __c1, const char_type& __c2);
 191
 192       static bool
 193       lt(const char_type& __c1, const char_type& __c2);
 194
 195       static int
 196       compare(const char_type* __s1, const char_type* __s2, size_t __n);
 197
 198       static size_t
 199       length(const char_type* __s);
 200
 201       static const char_type*
 202       find(const char_type* __s, size_t __n, const char_type& __a);
 203
 204       static char_type*
 205       move(char_type* __s1, const char_type* __s2, size_t __n);
 206
 207       static char_type*
 208       copy(char_type* __s1, const char_type* __s2, size_t __n);
 209
 210       static char_type*
 211       assign(char_type* __s, size_t __n, char_type __a);
 212
 213       static char_type
 214       to_char_type(const int_type& __c);
 215
 216       static int_type
 217       to_int_type(const char_type& __c);
 218
 219       static bool
 220       eq_int_type(const int_type& __c1, const int_type& __c2);
 221
 222       static int_type
 223       eof();
 224
 225       static int_type
 226       not_eof(const int_type& __c);
 227     };
 228 } // namespace std
 229
 230 #endif // _GLIBCPP_TESTSUITE_HOOKS_H
 231