hoard-sys 0.1.2

Rust FFI bindings to Hoard.
Documentation 
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

// -*- C++ -*-

/*

  The Hoard Multiprocessor Memory Allocator
  www.hoard.org

  Author: Emery Berger, http://www.emeryberger.com
  Copyright (c) 1998-2020 Emery Berger

  See the LICENSE file at the top-level directory of this
  distribution and at http://github.com/emeryberger/Hoard.

*/

#ifndef HOARD_CHECK_H
#define HOARD_CHECK_H

/**
 * @class Check
 * @brief Checks preconditions and postconditions on construction and destruction.
 *
 * Example usage:
 * 
 * in a method of ThisClass:
 * 
 * void foo() {
 *   Check<ThisClass, ThisClassChecker> t (this);
 *   ....
 * }
 *
 * and defined in ThisClass:
 *
 * class ThisClassChecker {
 * public:
 *   static void precondition (ThisClass * obj) { ... }
 *   static void postcondition (ThisClass * obj) { ... }
 *
 **/

namespace Hoard {

  template <class TYPE, class CHECK>
  class Check {
  public:
#ifndef NDEBUG
    Check (TYPE * t)
      : _object (t)
#else
    Check (TYPE *)
#endif
    {
#ifndef NDEBUG
      CHECK::precondition (_object);
#endif
    }
    
    ~Check() {
#ifndef NDEBUG
      CHECK::postcondition (_object);
#endif
    }
    
  private:
    Check (const Check&);
    Check& operator=(const Check&);
    
#ifndef NDEBUG
    TYPE * _object;
#endif
    
  };

}
#endif