Fileをベースとしたログに関する機能を集約したクラス [詳解]

#include <Log.h>

alt::Log の継承関係図

公開メンバ関数
APIENTRY	Log ()
	コンストラクタ

APIENTRY	Log (LogLevel logLevel, LPCTSTR fileName, SHORT sRotation, DWORD dwFileSize)
	コンストラクタ

APIENTRY	~Log ()
	デストラクタ

VOID APIENTRY	Debug (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	デバッグログの出力

VOID APIENTRY	Error (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	エラーログの出力

VOID APIENTRY	Fatal (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	致命的エラーログの出力

VOID APIENTRY	Info (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	情報ログの出力

BOOL APIENTRY	Init (LogLevel logLevel, LPCTSTR fileName, SHORT sRotation, DWORD dwFileSize)
	初期化

VOID APIENTRY	Trace (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	トレースログの出力

VOID APIENTRY	Warn (LPCTSTR message, DWORD dwThreadID=GetCurrentThreadId())
	警告ログの出力

基底クラス alt::WindowsLibrary に属する継承公開メンバ関数
APIENTRY	WindowsLibrary ()
	コンストラクタ

virtual APIENTRY	~WindowsLibrary ()
	デストラクタ

virtual DWORD APIENTRY	GetErrNo () const
	WindowsAPIのエラー値を取得します。

virtual VOID APIENTRY	SetErrNo ()
	WINAPIエラーの情報を設定します。

限定公開メンバ関数
BOOL APIENTRY	AppendLog ()

BOOL APIENTRY	CreateLog ()

VOID APIENTRY	FindHistory ()

LPCTSTR APIENTRY	GetLogLevelString (LogLevel logLevel)

BOOL APIENTRY	OpenLog ()

VOID APIENTRY	RotateLogFile ()

非公開メンバ関数
VOID APIENTRY	LogWrite (LogLevel logLevel, LPCTSTR pctszMessage, DWORD dwThreadID)

非公開変数類
TString	_baseFileName
	出力ログレベル

DWORD	_dwCurrentWriteSize
	ログに出力するシステム時刻

DWORD	_dwFileSize
	ログローテーション数

File	_file

LPCTSTR	_format = _T ("%04d/%02d/%02d %02d:%02d:%02d.%03d %5d %5s %s\r\n")
	書き込み時ロック

LogLevel	_level
	現在出力中のログファイル

SYSTEMTIME	_localTime
	ログファイル完全名

CriticalSection	_lock
	ログファイルサイズ

TString	_logFileName
	ログファイルユーザー設定名

LPCTSTR	_lpctszExtension = _T (".log")

LPCTSTR	_lpctszLogFileName = _T ("%s.log")

LPCTSTR	_lpctszLoglevelDebug = _T ("Debug")

LPCTSTR	_lpctszLogLevelError = _T ("Error")

LPCTSTR	_lpctszLogLevelFatal = _T ("Fatal")

LPCTSTR	_lpctszLogLevelInfo = _T ("Info ")

LPCTSTR	_lpctszLogLevelTrace = _T ("Trace")

LPCTSTR	_lpctszLogLevelWarn = _T ("Warn ")

LPCTSTR	_lpctszRotationFileName = _T ("%s%02d.log")

LPCTSTR	_lpctszSearchKeyword = _T ("??.log")

SHORT	_sFileCount
	現在までに書き込んでいるログファイルサイズ

SHORT	_sRotation
	現在までに確認できる履歴ファイル数

その他の継承メンバ
基底クラス alt::WindowsLibrary に属する継承限定公開変数類
DWORD	_dwErrorNo

詳解

Fileをベースとしたログに関する機能を集約したクラス

Log.h の 36 行目に定義があります。

構築子と解体子

◆ Log() [1/2]

Log::Log ( )

コンストラクタ

Log.cpp の 12 行目に定義があります。

参照先 _dwCurrentWriteSize, _dwFileSize, _level, _localTime, _sRotation, alt::Trace.

◆ Log() [2/2]

Log::Log	(	LogLevel	logLevel,
		LPCTSTR	fileName,
		SHORT	sRotation,
		DWORD	dwFileSize
	)

コンストラクタ

引数

logLevel	出力対象レベル（これ以上を出力）
fileName	出力ファイル名
sRotation	ローテーションファイル数
dwFileSize	出力ファイルサイズ

Log.cpp の 21 行目に定義があります。

参照先 Init().

◆ ~Log()

Log::~Log ( )

デストラクタ

Log.cpp の 27 行目に定義があります。

参照先 _file, alt::HandleLibrary::Close().

関数詳解

◆ AppendLog()

BOOL Log::AppendLog ( )

protected

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

参照先 _baseFileName, _dwCurrentWriteSize, _file, _logFileName, _lpctszExtension, CreateLog(), alt::TString::Ctr(), alt::File::GetSize(), alt::FileUtility::IsExist(), OpenLog(), alt::File::SetPointer().

参照元 Init().

◆ CreateLog()

BOOL Log::CreateLog ( )

protected

Log.cpp の 68 行目に定義があります。

参照先 _file, _logFileName, alt::File::Create(), alt::TString::Ctr().

参照元 AppendLog(), LogWrite().

◆ Debug()

VOID Log::Debug	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

デバッグログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

Log.cpp の 215 行目に定義があります。

参照先 _level, alt::Debug, LogWrite().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Error()

VOID Log::Error	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

エラーログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

Log.cpp の 197 行目に定義があります。

参照先 _level, alt::Error, LogWrite().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Fatal()

VOID Log::Fatal	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

致命的エラーログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

Log.cpp の 191 行目に定義があります。

参照先 _level, alt::Fatal, LogWrite().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ FindHistory()

VOID Log::FindHistory ( )

protected

Log.cpp の 155 行目に定義があります。

参照先 _baseFileName, _lpctszSearchKeyword, _sFileCount, alt::TString::Ctr(), alt::FileUtility::Find().

参照元 Init(), LogWrite().

◆ GetLogLevelString()

LPCTSTR Log::GetLogLevelString ( LogLevel logLevel )

protected

Log.cpp の 88 行目に定義があります。

参照先 _lpctszLoglevelDebug, _lpctszLogLevelError, _lpctszLogLevelFatal, _lpctszLogLevelInfo, _lpctszLogLevelTrace, _lpctszLogLevelWarn, alt::Debug, alt::Error, alt::Fatal, alt::Info, alt::Trace, alt::Warn.

◆ Info()

VOID Log::Info	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

情報ログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

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

参照先 _level, alt::Info, LogWrite().

参照元 alt::FactoryMethod::ClockElement::Init(), alt::FactoryMethod::ClockElement::Invoke(), alt::FactoryMethod::ClockElement::Start(), alt::FactoryMethod::ClockElement::Stop(), WindowsLibraryTest::TEST_CLASS(), alt::FactoryMethod::TerminateElement::Update().

◆ Init()

BOOL Log::Init	(	LogLevel	logLevel,
		LPCTSTR	fileName,
		SHORT	sRotation,
		DWORD	dwFileSize
	)

初期化

引数

logLevel	出力対象レベル（これ以上を出力）
fileName	出力ファイル名
sRotation	ローテーションファイル数
dwFileSize	出力ファイルサイズ

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

Log.cpp の 32 行目に定義があります。

参照先 _baseFileName, _dwCurrentWriteSize, _dwFileSize, _level, _sRotation, AppendLog(), FindHistory().

参照元 alt::FactoryMethod::ClockElement::ClockElement(), alt::FactoryMethod::TerminateElement::TerminateElement(), WindowsLibraryTest::TEST_CLASS().

◆ LogWrite()

VOID Log::LogWrite	(	LogLevel	logLevel,
		LPCTSTR	pctszMessage,
		DWORD	dwThreadID
	)

private

Log.cpp の 125 行目に定義があります。

参照先 _dwCurrentWriteSize, _dwFileSize, _file, _format, _localTime, _lock, alt::HandleLibrary::Close(), CreateLog(), alt::CriticalSection::Enter(), FindHistory(), alt::CriticalSection::Leave(), RotateLogFile(), alt::ReadWriteHandleLibrary::Write().

参照元 Debug(), Error(), Fatal(), Info(), Trace(), Warn().

◆ OpenLog()

BOOL Log::OpenLog ( )

protected

Log.cpp の 78 行目に定義があります。

参照先 _file, _logFileName, alt::File::Create(), alt::TString::Ctr().

参照元 AppendLog().

◆ RotateLogFile()

VOID Log::RotateLogFile ( )

protected

Log.cpp の 162 行目に定義があります。

参照先 _baseFileName, _lpctszLogFileName, _lpctszRotationFileName, _sFileCount, _sRotation, alt::TString::Ctr(), alt::FileUtility::Delete(), alt::FileUtility::Move(), alt::TString::Ptr().

参照元 LogWrite().

◆ Trace()

VOID Log::Trace	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

トレースログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

Log.cpp の 221 行目に定義があります。

参照先 _level, LogWrite(), alt::Trace.

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Warn()

VOID Log::Warn	(	LPCTSTR	message,
		DWORD	dwThreadID = `GetCurrentThreadId ()`
	)

警告ログの出力

引数

message	出力メッセージ
dwThreadID	出力対象スレッドID

Log.cpp の 203 行目に定義があります。

参照先 _level, LogWrite(), alt::Warn.

参照元 WindowsLibraryTest::TEST_CLASS().

メンバ詳解

◆ _baseFileName

TString alt::Log::_baseFileName

private

出力ログレベル

Log.h の 110 行目に定義があります。

参照元 AppendLog(), FindHistory(), Init(), RotateLogFile().

◆ _dwCurrentWriteSize

DWORD alt::Log::_dwCurrentWriteSize

private

ログに出力するシステム時刻

Log.h の 113 行目に定義があります。

参照元 Log(), AppendLog(), Init(), LogWrite().

◆ _dwFileSize

DWORD alt::Log::_dwFileSize

private

ログローテーション数

Log.h の 116 行目に定義があります。

参照元 Log(), Init(), LogWrite().

◆ _file

File alt::Log::_file

private

Log.h の 108 行目に定義があります。

参照元 ~Log(), AppendLog(), CreateLog(), LogWrite(), OpenLog().

◆ _format

LPCTSTR alt::Log::_format = _T ("%04d/%02d/%02d %02d:%02d:%02d.%03d %5d %5s %s\r\n")

private

書き込み時ロック

Log.h の 118 行目に定義があります。

参照元 LogWrite().

◆ _level

LogLevel alt::Log::_level

private

現在出力中のログファイル

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

参照元 Log(), Debug(), Error(), Fatal(), Info(), Init(), Trace(), Warn().

◆ _localTime

SYSTEMTIME alt::Log::_localTime

private

ログファイル完全名

Log.h の 112 行目に定義があります。

参照元 Log(), LogWrite().

◆ _lock

CriticalSection alt::Log::_lock

private

ログファイルサイズ

Log.h の 117 行目に定義があります。

参照元 LogWrite().

◆ _logFileName

TString alt::Log::_logFileName

private

ログファイルユーザー設定名

Log.h の 111 行目に定義があります。

参照元 AppendLog(), CreateLog(), OpenLog().

◆ _lpctszExtension

LPCTSTR alt::Log::_lpctszExtension = _T (".log")

private

Log.h の 120 行目に定義があります。

参照元 AppendLog().

◆ _lpctszLogFileName

LPCTSTR alt::Log::_lpctszLogFileName = _T ("%s.log")

private

Log.h の 121 行目に定義があります。

参照元 RotateLogFile().

◆ _lpctszLoglevelDebug

LPCTSTR alt::Log::_lpctszLoglevelDebug = _T ("Debug")

private

Log.h の 129 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszLogLevelError

LPCTSTR alt::Log::_lpctszLogLevelError = _T ("Error")

private

Log.h の 126 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszLogLevelFatal

LPCTSTR alt::Log::_lpctszLogLevelFatal = _T ("Fatal")

private

Log.h の 125 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszLogLevelInfo

LPCTSTR alt::Log::_lpctszLogLevelInfo = _T ("Info ")

private

Log.h の 128 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszLogLevelTrace

LPCTSTR alt::Log::_lpctszLogLevelTrace = _T ("Trace")

private

Log.h の 130 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszLogLevelWarn

LPCTSTR alt::Log::_lpctszLogLevelWarn = _T ("Warn ")

private

Log.h の 127 行目に定義があります。

参照元 GetLogLevelString().

◆ _lpctszRotationFileName

LPCTSTR alt::Log::_lpctszRotationFileName = _T ("%s%02d.log")

private

Log.h の 123 行目に定義があります。

参照元 RotateLogFile().

◆ _lpctszSearchKeyword

LPCTSTR alt::Log::_lpctszSearchKeyword = _T ("??.log")

private

Log.h の 122 行目に定義があります。

参照元 FindHistory().

◆ _sFileCount

SHORT alt::Log::_sFileCount

private

現在までに書き込んでいるログファイルサイズ

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

参照元 FindHistory(), RotateLogFile().

◆ _sRotation

SHORT alt::Log::_sRotation

private

現在までに確認できる履歴ファイル数

Log.h の 115 行目に定義があります。

参照元 Log(), Init(), RotateLogFile().

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

C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/Log.h
C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/Log.cpp

公開メンバ関数

限定公開メンバ関数

非公開メンバ関数

非公開変数類

その他の継承メンバ

詳解

構築子と解体子

◆ Log() [1/2]

◆ Log() [2/2]

◆ ~Log()

関数詳解

◆ AppendLog()

◆ CreateLog()

◆ Debug()

◆ Error()

◆ Fatal()

◆ FindHistory()

◆ GetLogLevelString()

◆ Info()

◆ Init()

◆ LogWrite()

◆ OpenLog()

◆ RotateLogFile()

◆ Trace()

◆ Warn()

メンバ詳解

◆ _baseFileName

◆ _dwCurrentWriteSize

◆ _dwFileSize

◆ _file

◆ _format

◆ _level

◆ _localTime

◆ _lock

◆ _logFileName

◆ _lpctszExtension

◆ _lpctszLogFileName

◆ _lpctszLoglevelDebug

◆ _lpctszLogLevelError

◆ _lpctszLogLevelFatal

◆ _lpctszLogLevelInfo

◆ _lpctszLogLevelTrace

◆ _lpctszLogLevelWarn

◆ _lpctszRotationFileName

◆ _lpctszSearchKeyword

◆ _sFileCount

◆ _sRotation