2022-12-04 11:03:45 +00:00
|
|
|
// SPDX-FileCopyrightText: 2019-2022 Connor McLaughlin <stenzek@gmail.com>
|
|
|
|
// SPDX-License-Identifier: (GPL-3.0 OR CC-BY-NC-ND-4.0)
|
|
|
|
|
2022-07-26 08:37:16 +00:00
|
|
|
#pragma once
|
|
|
|
#include "types.h"
|
|
|
|
#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; }
|
2022-10-23 04:09:54 +00:00
|
|
|
|
|
|
|
ALWAYS_INLINE ~ScopedGuard() { Run(); }
|
2022-07-26 08:37:16 +00:00
|
|
|
|
|
|
|
ScopedGuard(const ScopedGuard&) = delete;
|
|
|
|
void operator=(const ScopedGuard&) = delete;
|
|
|
|
|
2022-10-23 04:09:54 +00:00
|
|
|
/// Runs the destructor function now instead of when we go out of scope.
|
|
|
|
ALWAYS_INLINE void Run()
|
2022-07-26 08:37:16 +00:00
|
|
|
{
|
|
|
|
if (!m_func.has_value())
|
|
|
|
return;
|
|
|
|
|
|
|
|
m_func.value()();
|
|
|
|
m_func.reset();
|
|
|
|
}
|
|
|
|
|
2022-10-23 04:09:54 +00:00
|
|
|
/// Prevents the function from being invoked when we go out of scope.
|
|
|
|
ALWAYS_INLINE void Cancel() { m_func.reset(); }
|
|
|
|
|
2022-07-26 08:37:16 +00:00
|
|
|
private:
|
|
|
|
std::optional<T> m_func;
|
|
|
|
};
|