ScopeExit.h

[詳解]

/// @file
/// @brief スコープが外れた時に任意の処理を行うクラス ScopeExit のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_SCOPEEXIT_H
#define AMDAEMON_UTIL_SCOPEEXIT_H

#include "amdaemon/env.h"

#include <functional>
#include <utility>

namespace amdaemon
{
namespace util
{
/// @addtogroup g_util
/// @{

    /// @brief スコープが外れた時に任意の処理を行うクラス。
    ///
    /// 主に関数から抜ける際に特定の処理を確実に行わせたい場合に用いる。
    ///
    /// @code
    /// bool func()
    /// {
    ///     // 関数を抜ける際に解放処理が必要。
    ///     int* values = new int[100];
    /// 
    ///     // この関数から抜ける際、確実に values を解放する。
    ///     amdaemon::util::ScopeExit valuesDeleter = [values] { delete [] values; };
    /// 
    ///     // …中略…
    /// 
    ///     // ここで呼び出し元に処理を戻す際、 valuesDeleter のデストラクタが呼ばれ、
    ///     // その中で delete [] values; が行われる。
    ///     return true;
    /// }
    /// @endcode
    class ScopeExit
    {
    public:
        /// @brief コンストラクタ。
        /// @param[in] exitFunc デストラクタで呼び出させる終了処理関数。
        ScopeExit(std::function<void ()> exitFunc) : _exitFunc(exitFunc)
        {
        }

        /// @brief ムーブコンストラクタ。
        /// @param[in] src ムーブ元。
        ScopeExit(ScopeExit&& src) : _exitFunc(std::move(src._exitFunc))
        {
            // ムーブ元の関数を無効化する
            src._exitFunc = std::function<void ()>();
        }

        /// @brief デストラクタ。
        ///
        /// コンストラクタで渡した終了処理関数が呼び出される。
        ‾ScopeExit()
        {
            // ムーブによって無効化されている場合がある
            if (_exitFunc)
            {
                _exitFunc();
            }
        }

        /// @brief ムーブ代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        ScopeExit& operator=(ScopeExit&& r)
        {
            _exitFunc = std::move(r._exitFunc);

            // ムーブ元の関数を無効化する
            r._exitFunc = std::function<void ()>();

            return *this;
        }

    private:
        std::function<void ()> _exitFunc;   ///< 終了処理関数。

    private:
        // コピー禁止
        ScopeExit(const ScopeExit&);            // 宣言のみ
        ScopeExit& operator=(const ScopeExit&); // 宣言のみ
    };

/// @}
} // namespace util
} // namespace amdaemon

#endif // AMDAEMON_UTIL_SCOPEEXIT_H