LibCommon::CDebug クラス

デバッグクラス [詳解]

#include "CDebug.h"

LibCommon::CDebug の継承関係図

LibCommon::CDebug 連携図

公開メンバ関数
virtual bool	OutputString (wchar_t const *pszString) noexcept override
	文字列出力関数 [詳解]
基底クラス LibCommon::CStreamOut に属する継承公開メンバ関数
virtual bool	OutputChar (wchar_t ch) noexcept
	１文字出力関数 [詳解]
virtual bool	OutputFormat (wchar_t const *pszFormat,...) noexcept
	書式設定文字列出力関数 [詳解]
virtual bool	OutputArgs (wchar_t const *pszFormat, va_list vaArgs) noexcept
	引数リスト文字列出力関数 [詳解]
virtual bool	OutputNewLine () noexcept
	改行出力関数 [詳解]
virtual bool	OutputLineHeader () noexcept
	行ヘッダー出力関数 [詳解]
virtual bool	UpdateLineNumber () noexcept
	行番号更新関数 [詳解]
virtual int	GetLineNumber () noexcept
	行番号取得関数 [詳解]
virtual int	GetIndentCount () noexcept
	インデントカウント取得関数 [詳解]
virtual bool	OutputIndent () noexcept
	インデント出力関数 [詳解]
virtual bool	Indent () noexcept
	インデント関数 [詳解]
virtual bool	Unindent () noexcept
	アンインデント関数 [詳解]
virtual bool	OutputLineString (wchar_t const *pszString, bool bHeader=true, bool bIndent=true) noexcept
	文字列行出力関数 [詳解]
virtual bool	OutputLineFormat (wchar_t const *pszFormat,...) noexcept
	書式設定文字列行出力関数 [詳解]
virtual bool	OutputLineArgs (wchar_t const *pszFormat, va_list vaArgs) noexcept
	引数リスト文字列行出力関数 [詳解]
virtual bool	ExOutputLineFormat (bool bHeader, bool bIndent, wchar_t const *pszFormat,...) noexcept
	拡張書式設定文字列行出力関数 [詳解]
virtual bool	ExOutputLineArgs (bool bHeader, bool bIndent, wchar_t const *pszFormat, va_list vaArgs) noexcept
	拡張引数リスト文字列行出力関数 [詳解]

静的公開メンバ関数
static CDebug &	GetInstance () noexcept
	インスタンス取得関数 [詳解]

限定公開メンバ関数
	CDebug () noexcept
	コンストラクタ [詳解]
virtual	~CDebug () noexcept
	デストラクタ [詳解]
基底クラス LibCommon::CStreamOut に属する継承限定公開メンバ関数
	CStreamOut () noexcept
	コンストラクタ [詳解]
virtual	~CStreamOut () noexcept
	デストラクタ [詳解]

限定公開変数類
wchar_t	m_szString [BUFFER_SIZE+1]
	文字列バッファ [詳解]
基底クラス LibCommon::CStreamOut に属する継承限定公開変数類
int	m_nLine
	行番号 [詳解]
int	m_nIndent
	インデントカウント [詳解]

静的限定公開変数類
static int const	BUFFER_SIZE = ( 2048 - 1 )
	文字列バッファサイズ [詳解]
static CDebug	s_cInstance
	静的インスタンス [詳解]
基底クラス LibCommon::CStreamOut に属する継承静的限定公開変数類
static int const	FORMAT_BUFFER_SIZE = ( 2048 - 1 )
	書式設定文字列バッファサイズ [詳解]

非公開メンバ関数
	CDebug (CDebug const &)=delete
CDebug &	operator= (CDebug const &)=delete

詳解

デバッグクラス

デバッグクラスです。

注意

シングルトンクラスです。

CDebug.h の 50 行目に定義があります。

構築子と解体子

LibCommon::CDebug::CDebug ( )

explicitprotectednoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

CDebug.cpp の 30 行目に定義があります。

参照先 NotifyConstructor.

        : CStreamOut()
        // メンバ変数初期化
        , m_szString()
    {
        // コンストラクタ実行通知
        NotifyConstructor();
    }

LibCommon::CDebug::~CDebug ( )

protectedvirtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CDebug.cpp の 42 行目に定義があります。

参照先 NotifyDestructor.

                             {
        // デストラクタ実行通知
        NotifyDestructor();
    }

LibCommon::CDebug::CDebug ( CDebug const &  )

privatedelete

関数詳解

bool LibCommon::CDebug::OutputString ( wchar_t const *  pszString )

overridevirtualnoexcept

文字列出力関数

文字列出力関数です。

引数

[in]

pszString

文字列ポインタ

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバーライド関数です。

LibCommon::CStreamOutを実装しています。

CDebug.cpp の 51 行目に定義があります。

参照先 BUFFER_SIZE, m_szString.

                                                                 {
        // 処理ブロック
        bool result = false;
        do {
            // 文字列ポインタを調べる
            if ( nullptr == pszString ) {
                // 失敗！
                break;
            }

            // 文字列長を取得する
            int nCount = static_cast< int >( ::wcslen( pszString ) );
            if ( BUFFER_SIZE >= nCount ) {
                // デバッグコンソールに文字列出力する
                ::OutputDebugStringW( pszString );
            }
            // 巡回する
            else for ( int nIndex = 0, nSize = 0; nCount > nIndex; nIndex += nSize, nCount -= nSize ) {
                // １回に出力する文字数を取得する
                if ( BUFFER_SIZE > nCount ) {
                    nSize = nCount;
                }
                else {
                    nSize = BUFFER_SIZE;
                }

                // 文字列バッファにコピーする
                ::wcsncpy_s( m_szString, &pszString[ nIndex ], nSize );

                // 終端文字コードを設定する
                m_szString[ nSize ] = L'\0';

                // デバッグコンソールに文字列出力する
                ::OutputDebugStringW( m_szString );
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

static CDebug& LibCommon::CDebug::GetInstance ( )

inlinestaticnoexcept

インスタンス取得関数

インスタンス取得関数です。

引数

なし

戻り値

インスタンス参照

注意

なし

CDebug.h の 104 行目に定義があります。

{ return s_cInstance; }

CDebug& LibCommon::CDebug::operator= ( CDebug const &  )

privatedelete

メンバ詳解

int const LibCommon::CDebug::BUFFER_SIZE = ( 2048 - 1 )

staticprotected

文字列バッファサイズ

CDebug.h の 109 行目に定義があります。

参照元 OutputString().

wchar_t LibCommon::CDebug::m_szString[BUFFER_SIZE+1]

protected

文字列バッファ

CDebug.h の 114 行目に定義があります。

参照元 OutputString().

CDebug LibCommon::CDebug::s_cInstance

staticprotected

静的インスタンス

CDebug.h の 119 行目に定義があります。

参照元 LibCommon::CLibCommon::GetInstanceHandle().

---

このクラス詳解は次のファイルから抽出されました:

• C:/Work/VisualStudio2017/Solution46/Include/Library/LibCommon/CDebug.h
• C:/Work/VisualStudio2017/Solution46/Source/Library/LibCommon/CDebug.cpp
• C:/Work/VisualStudio2017/Solution46/Source/Library/LibCommon/LibCommon.cpp