ScopeGuard.h

Go to the documentation of this file.

//
// Copyright 2012 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: MPL-2.0
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#include <functional>
#include <type_traits>
#include <utility>
 
namespace comms
{
 
namespace util
{
 
template <typename TFunc>
class ScopeGuard
{
public:
    explicit ScopeGuard(TFunc&& func)
        : m_func(std::forward<TFunc>(func)),
          m_engaged(true)
    {
    }
 
    ScopeGuard(const ScopeGuard& guard) = delete;
 
    ScopeGuard(ScopeGuard&& guard)
        : m_func(std::move(guard.m_func)),
          m_engaged(std::move(guard.m_engaged))
    {
        guard.release();
    }
 
    ~ScopeGuard() noexcept
    {
        if (!isReleased()) {
            m_func();
        }
    }
 
    ScopeGuard& operator=(const ScopeGuard& guard) = delete;
 
    void release()
    {
        m_engaged = false;
    }
 
    bool isReleased() const
    {
        return !m_engaged;
    }
 
private:
    typename std::remove_reference<TFunc>::type m_func;
    bool m_engaged;
};
 
template <typename TFunctor>
ScopeGuard<TFunctor> makeScopeGuard(TFunctor&& func)
{
    return ScopeGuard<TFunctor>(std::forward<TFunctor>(func));
}
 
template <typename TFunc,
          typename... TParams>
auto makeScopeGuard(TFunc&& func, TParams... args) ->
ScopeGuard<decltype(std::bind(std::forward<TFunc>(func),
                    std::forward<TParams>(args)...))>
{
    auto bindObj = std::bind(std::forward<TFunc>(func), std::forward<TParams>(args)...);
    return ScopeGuard<decltype(bindObj)>(std::move(bindObj));
}
 
}  // namespace util
 
}  // namespace comms