CDebug.h

[詳解]

//=============================================================================
/// @file
/// デバッグクラスヘッダファイル
///
/// デバッグクラスヘッダファイルです。
///
/// $Id: CDebug.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <CStreamOut.h>

//=============================================================================
// マクロ定義
#define DebugInstance()        LibCommon::CDebug::GetInstance()                            ///< インスタンス取得マクロ
#define DebugChar(...)         DebugInstance().OutputChar(__VA_ARGS__)                     ///< １文字出力マクロ
#define DebugString(...)       DebugInstance().OutputString(__VA_ARGS__)                   ///< 文字列出力マクロ
#define DebugFormat(...)       DebugInstance().OutputFormat(__VA_ARGS__)                   ///< 書式設定文字列出力マクロ
#define DebugNewLine()         DebugInstance().OutputNewLine()                             ///< 改行出力マクロ
#define DebugLineString(...)   DebugInstance().OutputLineString(__VA_ARGS__)               ///< 文字列行出力マクロ
#define DebugLineFormat(...)   DebugInstance().OutputLineFormat(__VA_ARGS__)               ///< 書式設定文字列行出力マクロ
#define DebugExLineFormat(...) DebugInstance().ExOutputLineFormat(__VA_ARGS__)             ///< 拡張書式設定文字列行出力マクロ
#define DebugNoIndent(...)     DebugInstance().ExOutputLineFormat(true,false,__VA_ARGS__)  ///< インデントなし書式設定文字列行出力マクロ
#define DebugLine(...)         DebugInstance().ExOutputLineFormat(false,false,__VA_ARGS__) ///< ヘッダインデントなし書式設定文字列行出力マクロ
#define DebugFunction()        DebugLineFormat(L"%s()",__FUNCTIONW__)                      ///< 関数マクロ
#define DebugIndent()          DebugInstance().Indent()                                    ///< インデントマクロ
#define DebugUnindent()        DebugInstance().Unindent()                                  ///< アンインデントマクロ
#define DebugBlockIn(...)      DebugLineFormat(__VA_ARGS__);DebugIndent()                  ///< ブロック開始マクロ
#define DebugBlockOut(...)     DebugUnindent();DebugLineFormat(__VA_ARGS__)                ///< ブロック終了マクロ
#define DebugHeader()          DebugBlockIn (L"%s() {",   __FUNCTIONW__)                   ///< 関数ヘッダマクロ
#define DebugFooter()          DebugBlockOut(L"} // %s()",__FUNCTIONW__)                   ///< 関数フッタマクロ

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// デバッグクラス
    ///
    /// デバッグクラスです。
    ///
    /// @attention シングルトンクラスです。
    ///
    class LIB_COMMON_API CDebug final: public CStreamOut {
        //=====================================================================
        // 構築子と解体子
    protected:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CDebug() noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CDebug() noexcept;

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 文字列出力関数
        ///
        /// 文字列出力関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバーライド関数です。
        ///
        virtual bool OutputString( wchar_t const* pszString ) noexcept override;

        //=====================================================================
        // インライン静的公開関数
    public:
        //---------------------------------------------------------------------
        /// インスタンス取得関数
        ///
        /// インスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    インスタンス参照
        /// @attention なし
        ///
        inline static CDebug& GetInstance() noexcept { return s_cInstance; }

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int const BUFFER_SIZE = ( 2048 - 1 ); ///< 文字列バッファサイズ

        //=====================================================================
        // 限定公開変数
    protected:
        wchar_t m_szString[ BUFFER_SIZE + 1 ]; ///< 文字列バッファ

        //=====================================================================
        // 静的限定公開変数
    protected:
        static CDebug s_cInstance; ///< 静的インスタンス

        //=====================================================================
        // 削除関数
    private:
        CDebug( CDebug const& ) = delete;
        CDebug& operator=( CDebug const& ) = delete;
    };
}

#pragma managed( pop )