aboutsummaryrefslogtreecommitdiff
path: root/src/frontend/duckstation/scoped_guard.h
blob: 89f35d92f9e1f660b6e097d9723b05b1951344e5 (plain)
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
#pragma once
#include <optional>
#include <utility>

/// ScopedGuard provides an object which runs a function (usually a lambda) when
/// it goes out of scope. This can be useful for releasing resources or handles
/// which do not normally have C++ types to automatically release.
template<typename T>
class ScopedGuard final
{
public:
  ALWAYS_INLINE ScopedGuard(T&& func) : m_func(std::forward<T>(func)) {}
  ALWAYS_INLINE ScopedGuard(ScopedGuard&& other) : m_func(std::move(other.m_func)) { other.m_func = nullptr; }
  ALWAYS_INLINE ~ScopedGuard() { Invoke(); }

  ScopedGuard(const ScopedGuard&) = delete;
  void operator=(const ScopedGuard&) = delete;

  /// Prevents the function from being invoked when we go out of scope.
  ALWAYS_INLINE void Cancel() { m_func.reset(); }

  /// Explicitly fires the function.
  ALWAYS_INLINE void Invoke()
  {
    if (!m_func.has_value())
      return;

    m_func.value()();
    m_func.reset();
  }

private:
  std::optional<T> m_func;
};