File: smartptr.h

package info (click to toggle)
wsclean 3.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,296 kB
  • sloc: cpp: 129,246; python: 22,066; sh: 360; ansic: 230; makefile: 185
file content (47 lines) | stat: -rw-r--r-- 1,327 bytes parent folder | download | duplicates (2)
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
#include <boost/test/unit_test.hpp>

namespace wsclean::test {

/**
 * Helper class for using using unique pointers in tests.
 *
 * Use case: When using unique pointers, tests often also store raw pointers
 * for accessing objects after std::moving their unique pointer.
 *
 * This class supports this common pattern: Instead of storing both a unique
 * pointer and a raw pointer, tests can use a single test::UniquePtr variable.
 *
 * The perfect forwarding constructor also simplifies initialization:
 * "std::unique_ptr<X> x(new X(...));" becomes: "test::UniquePtr<X> x(...);"
 *
 * @tparam T Object type for the unique pointer.
 */
template <class T>
class UniquePtr {
 public:
  /**
   * Constructor. It uses perfect forwarding for calling T's constructor.
   */
  template <typename... Args>
  UniquePtr(Args&&... args)
      : _unique(new T(std::forward<Args>(args)...)), _raw(_unique.get()) {}

  /**
   * Extract the unique_ptr from the helper class.
   * The test code may only call this function once.
   */
  std::unique_ptr<T> take() {
    BOOST_TEST_REQUIRE(static_cast<bool>(_unique));
    return std::move(_unique);
  }

  T& operator*() { return *_raw; }
  T* operator->() { return _raw; }
  T* get() { return _raw; }

 private:
  std::unique_ptr<T> _unique;
  T* const _raw;
};

}  // namespace wsclean::test