LibCommon::CStreamOut クラス

ストリーム出力クラス [詳解]

#include "CStreamOut.h"

LibCommon::CStreamOut の継承関係図

LibCommon::CStreamOut 連携図

公開メンバ関数
virtual bool	OutputString (wchar_t const *pszString) noexcept=0
	文字列出力関数 [詳解]
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
	拡張引数リスト文字列行出力関数 [詳解]

限定公開メンバ関数
	CStreamOut () noexcept
	コンストラクタ [詳解]
virtual	~CStreamOut () noexcept
	デストラクタ [詳解]

限定公開変数類
int	m_nLine
	行番号 [詳解]
int	m_nIndent
	インデントカウント [詳解]

静的限定公開変数類
static int const	FORMAT_BUFFER_SIZE = ( 2048 - 1 )
	書式設定文字列バッファサイズ [詳解]

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

詳解

ストリーム出力クラス

ストリーム出力クラスです。

注意

抽象クラスです。

CStreamOut.h の 30 行目に定義があります。

構築子と解体子

LibCommon::CStreamOut::CStreamOut ( )

explicitprotectednoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

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

        : m_nLine( 0 )
        , m_nIndent( 0 )
    {}

LibCommon::CStreamOut::~CStreamOut ( )

protectedvirtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CStreamOut.cpp の 38 行目に定義があります。

                                     {
    }

LibCommon::CStreamOut::CStreamOut ( CStreamOut const &  )

privatedelete

関数詳解

virtual bool LibCommon::CStreamOut::OutputString ( wchar_t const *  pszString )

pure virtualnoexcept

文字列出力関数

文字列出力関数です。

引数

[in]

pszString

文字列ポインタ

戻り値

実行結果

• true 成功
• false 失敗

注意

純粋仮想関数です。

LibCommon::CConsole, LibLogOut::CLibLogOut, LibCommon::CStringStream, LibCommon::CDebug, LibCommon::CFileStreamで実装されています。

参照元 OutputArgs(), OutputChar(), OutputIndent(), OutputLineString(), OutputNewLine().

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputChar ( wchar_t  ch )

virtualnoexcept

１文字出力関数

１文字出力関数です。

引数

[in]

ch

文字コード

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibCommon::CStringStreamで再実装されています。

CStreamOut.cpp の 45 行目に定義があります。

参照先 OutputString().

参照元 LibCommon::CConsole::InputString().

                                                     {
        // 処理ブロック
        bool result = false;
        do {
            // 文字列を出力する
            wchar_t szBuffer[ 2 ] = { ch, L'\0' };
            if ( !OutputString( szBuffer ) ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputFormat ( wchar_t const *  pszFormat,   ...  )

virtualnoexcept

書式設定文字列出力関数

書式設定文字列出力関数です。

引数

[in]	pszFormat	書式設定文字列
[in]	...	可変長引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 66 行目に定義があります。

参照先 OutputArgs().

参照元 OutputLineHeader().

                                                                          {
        // 処理ブロック
        bool result = false;
        do {
            // 引数リストを作成する
            va_list vaArgs;
            va_start( vaArgs, pszFormat );

            // 処理ブロック
            do {
                // 引数リスト文字列を出力する
                if ( !OutputArgs( pszFormat, vaArgs ) ) {
                    // 失敗！
                    break;
                }

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

            // 引数リストを解放する
            va_end( vaArgs );
        } while ( false );

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputArgs ( wchar_t const *  pszFormat, va_list  vaArgs  )

virtualnoexcept

引数リスト文字列出力関数

引数リスト文字列出力関数です。

引数

[in]	pszFormat	書式設定文字列
[in]	vaArgs	引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 96 行目に定義があります。

参照先 LibCommon::ExpandFormatArgs(), FORMAT_BUFFER_SIZE, OutputString().

参照元 OutputFormat().

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

            // 書式設定文字列を展開する
            wchar_t szBuffer[ FORMAT_BUFFER_SIZE + 1 ];
            if ( !ExpandFormatArgs( szBuffer, ( FORMAT_BUFFER_SIZE + 1 ), pszFormat, vaArgs ) ) {
                // 失敗！
                break;
            }
            // 文字列を出力する
            else if ( !OutputString( szBuffer ) ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputNewLine ( )

virtualnoexcept

改行出力関数

改行出力関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 128 行目に定義があります。

参照先 OutputString().

参照元 OutputLineString().

                                            {
        // 処理ブロック
        bool result = false;
        do {
            // 改行文字列を出力する
            if ( !OutputString( L"\n" ) ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputLineHeader ( )

virtualnoexcept

行ヘッダー出力関数

行ヘッダー出力関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 148 行目に定義があります。

参照先 GetLineNumber(), OutputFormat(), UpdateLineNumber().

参照元 OutputLineString().

                                               {
        // 処理ブロック
        bool result = false;
        do {
            // 行番号を更新する
            UpdateLineNumber();

            // ヘッダ文字列を出力する
            SYSTEMTIME sSysTime;
            ::GetLocalTime( &sSysTime );
            if ( !OutputFormat( L"%06lu:[%04X:%04X]%02u%02u%02u-%02u%02u%02u.%03u ",
                GetLineNumber(),
                ::GetCurrentProcessId(),
                ::GetCurrentThreadId(),
                ( sSysTime.wYear % 100 ),
                sSysTime.wMonth,
                sSysTime.wDay,
                sSysTime.wHour,
                sSysTime.wMinute,
                sSysTime.wSecond,
                sSysTime.wMilliseconds ) ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

virtual bool LibCommon::CStreamOut::UpdateLineNumber ( )

inlinevirtualnoexcept

行番号更新関数

行番号更新関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibLogOut::CLibLogOutで再実装されています。

CStreamOut.h の 150 行目に定義があります。

参照元 OutputLineHeader().

{ ++m_nLine; return true; }

被呼び出し関係図:

virtual int LibCommon::CStreamOut::GetLineNumber ( )

inlinevirtualnoexcept

行番号取得関数

行番号取得関数です。

引数

なし

戻り値

行番号

注意

なし

LibLogOut::CLibLogOutで再実装されています。

CStreamOut.h の 161 行目に定義があります。

参照元 OutputLineHeader().

{ return m_nLine; }

被呼び出し関係図:

virtual int LibCommon::CStreamOut::GetIndentCount ( )

inlinevirtualnoexcept

インデントカウント取得関数

インデントカウント取得関数です。

引数

なし

戻り値

インデントカウント

注意

なし

LibLogOut::CLibLogOutで再実装されています。

CStreamOut.h の 172 行目に定義があります。

参照元 OutputIndent().

{ return m_nIndent; }

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputIndent ( )

virtualnoexcept

インデント出力関数

インデント出力関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 183 行目に定義があります。

参照先 GetIndentCount(), OutputString().

参照元 OutputLineString().

                                           {
        // 処理ブロック
        bool result = false;
        do {
            // 巡回する
            for ( int uCount = GetIndentCount();; --uCount ) {
                // 残りループ回数を調べる
                if ( 0 == uCount ) {
                    // 成功！
                    result = true;
                    break;
                }
                // インデント文字列を出力する
                else if ( !OutputString( L"  " ) ) {
                    // 失敗！
                    break;
                }
            }
        } while ( false );

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::Indent ( )

virtualnoexcept

インデント関数

インデント関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibLogOut::CLibLogOutで再実装されています。

CStreamOut.cpp の 209 行目に定義があります。

参照先 m_nIndent.

                                     {
        // インデントカウントをインクリメントする
        ++m_nIndent;

        // 成功！
        return true;
    }

bool LibCommon::CStreamOut::Unindent ( )

virtualnoexcept

アンインデント関数

アンインデント関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibLogOut::CLibLogOutで再実装されています。

CStreamOut.cpp の 219 行目に定義があります。

参照先 m_nIndent, NotifyFatalError.

                                       {
        // 処理ブロック
        bool result = false;
        do {
            // インデントカウントを調べる
            if ( 0 >= m_nIndent ) {
                // 致命的エラー！
                NotifyFatalError();
                break;
            }

            // インデントカウントをデクリメントする
            --m_nIndent;

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

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

bool LibCommon::CStreamOut::OutputLineString ( wchar_t const *  pszString, bool  bHeader = true, bool  bIndent = true  )

virtualnoexcept

文字列行出力関数

文字列行出力関数です。

引数

[in]	pszString	文字列ポインタ
[in]	bHeader	行ヘッダ出力フラグ
[in]	bIndent	インデント出力フラグ

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 243 行目に定義があります。

参照先 OutputIndent(), OutputLineHeader(), OutputNewLine(), OutputString().

参照元 ExOutputLineArgs().

                                                                                                     {
        // 処理ブロック
        bool result = false;
        do {
            // 行ヘッダを出力する
            if ( bHeader && !OutputLineHeader() ) {
                // 失敗！
                break;
            }
            // インデントを出力する
            else if ( bIndent && !OutputIndent() ) {
                // 失敗！
                break;
            }
            // 文字列を出力する
            else if ( !OutputString( pszString ) ) {
                // 失敗！
                break;
            }
            // 改行を出力する
            else if ( !OutputNewLine() ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::OutputLineFormat ( wchar_t const *  pszFormat,   ...  )

virtualnoexcept

書式設定文字列行出力関数

書式設定文字列行出力関数です。

引数

[in]	pszFormat	書式設定文字列
[in]	...	可変長引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 278 行目に定義があります。

参照先 OutputLineArgs().

                                                                              {
        // 処理ブロック
        bool result = false;
        do {
            // 引数リストを作成する
            va_list vaArgs;
            va_start( vaArgs, pszFormat );

            // 処理ブロック
            do {
                // 引数リスト文字列を行出力する
                if ( !OutputLineArgs( pszFormat, vaArgs ) ) {
                    // 失敗！
                    break;
                }

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

            // 引数リストを解放する
            va_end( vaArgs );
        } while ( false );

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

呼び出し関係図:

bool LibCommon::CStreamOut::OutputLineArgs ( wchar_t const *  pszFormat, va_list  vaArgs  )

virtualnoexcept

引数リスト文字列行出力関数

引数リスト文字列行出力関数です。

引数

[in]	pszFormat	書式設定文字列
[in]	vaArgs	引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 308 行目に定義があります。

参照先 ExOutputLineArgs().

参照元 OutputLineFormat().

                                                                                       {
        // 拡張引数リスト文字列を行出力する
        return ExOutputLineArgs( true, true, pszFormat, vaArgs );
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::ExOutputLineFormat ( bool  bHeader, bool  bIndent, wchar_t const *  pszFormat,   ...  )

virtualnoexcept

拡張書式設定文字列行出力関数

拡張書式設定文字列行出力関数です。

引数

[in]	bHeader	行ヘッダ出力フラグ
[in]	bIndent	インデント出力フラグ
[in]	pszFormat	書式設定文字列
[in]	...	可変長引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 315 行目に定義があります。

参照先 ExOutputLineArgs().

参照元 LibLogOut::CLibLogOut::UpdateProcessInfo().

                                                                                                            {
        // 処理ブロック
        bool result = false;
        do {
            // 引数リストを作成する
            va_list vaArgs;
            va_start( vaArgs, pszFormat );

            // 処理ブロック
            do {
                // 引数リスト文字列を行出力する
                if ( !ExOutputLineArgs( bHeader, bIndent, pszFormat, vaArgs ) ) {
                    // 失敗！
                    break;
                }

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

            // 引数リストを解放する
            va_end( vaArgs );
        } while ( false );

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CStreamOut::ExOutputLineArgs ( bool  bHeader, bool  bIndent, wchar_t const *  pszFormat, va_list  vaArgs  )

virtualnoexcept

拡張引数リスト文字列行出力関数

拡張引数リスト文字列行出力関数です。

引数

[in]	bHeader	行ヘッダ出力フラグ
[in]	bIndent	インデント出力フラグ
[in]	pszFormat	書式設定文字列
[in]	vaArgs	引数リスト

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CStreamOut.cpp の 345 行目に定義があります。

参照先 LibCommon::ExpandFormatArgs(), FORMAT_BUFFER_SIZE, OutputLineString().

参照元 ExOutputLineFormat(), OutputLineArgs().

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

            // 書式設定文字列を展開する
            wchar_t szBuffer[ FORMAT_BUFFER_SIZE + 1 ];
            if ( !ExpandFormatArgs( szBuffer, ( FORMAT_BUFFER_SIZE + 1 ), pszFormat, vaArgs ) ) {
                // 失敗！
                break;
            }
            // 文字列を行出力する
            else if ( !OutputLineString( szBuffer, bHeader, bIndent ) ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

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

privatedelete

メンバ詳解

int const LibCommon::CStreamOut::FORMAT_BUFFER_SIZE = ( 2048 - 1 )

staticprotected

書式設定文字列バッファサイズ

CStreamOut.h の 291 行目に定義があります。

参照元 ExOutputLineArgs(), OutputArgs().

int LibCommon::CStreamOut::m_nLine

protected

行番号

CStreamOut.h の 296 行目に定義があります。

int LibCommon::CStreamOut::m_nIndent

protected

インデントカウント

CStreamOut.h の 297 行目に定義があります。

参照元 Indent(), Unindent().

---

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

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