调试时打印日志信息

调试时打印日志信息

//使用说明

/************************

一、

工程名.h

#include "CxLog.h"

extern CxLog *gCxLog;

二、

工程名.CPP

CxLog *gCxLog;

...InitInstance()

{

bool alive = true;

gCxLog = NULL;

gCxLog = new CxLog(alive);

..

}

...ExitInstance()

{

if(gCxLog != NULL)

{

delete gCxLog;

}

gCxLog = NULL;

..

}

三、

找个全局的地方

#define OUTPUT_LOG_EN //启用日志输出

四、

在任何要打印日志的地方

#ifdef OUTPUT_LOG_EN

CString strTemp;

strTemp.Format(_T("想要添加的工作日志！")); gCxLog->Log(_T("类.cpp"), _T("函数名"),

哪一行比如50, CxLog::CX_LOG_MESSAGE, strTemp); #endif

*************************/

#ifndef _CX_LOG_H_

#define _CX_LOG_H_

#if defined(_MSC_VER)

#pragma warning(disable: 4530)

#endif

#include <stdio.h>

#include <time.h>

#include <assert.h>

#include <list>

#include <iterator>

#include <stdexcept>

#include <exception>

#if defined(_MSC_VER) || defined(__INTEL_COMPILER) #include <comdef.h>

#endif

#include <tchar.h>

#include <process.h>

#include <windows.h>

//////////////////////////////////////////////////////////////////////////

///文件型多线程日志类class for log file

//定义格式化输出

#ifndef CX_LOG_DEFAULT_FORMAT

#if (defined(_MSC_VER) &&

_MSC_VER<=1310) || defined(__BORLANDC__) || (defined(__GNUC__) && defined(_UNICODE)) #define CX_LOG_DEFAULT_FORMAT

_T("%s %s %s(%d): %s\r\n")

#else

#define CX_LOG_DEFAULT_FORMAT

_T("%s %s %s(%s, %d): %s\r\n")

#endif

#endif

//定义格式化输出的缓冲区大小

#ifndef CX_LOG_DEFAULT_FORMAT_SIZE

#define CX_LOG_DEFAULT_FORMAT_SIZE 1024 #endif

//定义是否替换控制用ASCII

#ifndef CX_LOG_REPLACE_CONTROL

#define CX_LOG_REPLACE_CONTROL true

#endif

//定义控制用ASCII的默认替换字符

#ifndef CX_LOG_REPLACE_ASCII

#define CX_LOG_REPLACE_ASCII _T(' ')

#endif

//定义窗口通知消息

#ifndef WM_CX_LOG

#define WM_CX_LOG WM_USER + 2200

#endif

class CxLog

{

public:

enum EnumType{

CX_LOG_MESSAGE = 0,

CX_LOG_WARNING,

CX_LOG_EXCEPTION,

CX_LOG_ERROR

};

static CxLog& Instance()

{

static bool alive = false;

static CxLog log(alive);

if(!alive)

{

OutputDebugString(_T("CxLog has destroy!"));

throw std::runtime_error("CxLog has destroy!"); }

return log;

}

struct Item

{

SYSTEMTIME _Time;//>time stamp

TCHAR _szTime[24];

LPTSTR _szSrc;//>source file name

LPTSTR _szFunc;//>founction name

ULONG _uLine;//>line number

EnumType _eType;//

LPTSTR _szDesc;//>content

LPBYTE _pBin;//>binary data szBuffer

ULONG _uBinSize;//>the size of binary data szBuffer

//BOOL _bLog;//>complete the log

Item()

{

InitItem(NULL, NULL, 0, CX_LOG_MESSAGE, NULL, NULL, 0);

}

Item(LPCTSTR szSrc, LPCTSTR szFunc, const ULONG uLine, const EnumType eType,

LPCTSTR szDesc, LPVOID pBin = NULL, ULONG uSize = 0)

{

InitItem(szSrc, szFunc, uLine, eType, szDesc, pBin, uSize); }

~Item()

{

ReleaseStringBuffer(_szSrc);

ReleaseStringBuffer(_szFunc);

ReleaseStringBuffer(_szDesc);

if(_pBin)

{

delete []_pBin;

_pBin = NULL;

}

}

VOID InitItem(LPCTSTR szSrc, LPCTSTR szFunc, const ULONG uLine, const EnumType eType,

LPCTSTR szDesc, LPVOID pBin, ULONG uSize)

{

GetLocalTime(&_Time);

wsprintf(_szTime,

_T("%04d-%02d-%02d %02d:%02d:%02d.%03d"), _Time.wYear,

_Time.wMonth,

_Time.wDay,

_Time.wHour,

_Time.wMinute,

_Time.wSecond,

_Time.wMilliseconds

);

_eType = eType;

_uBinSize = _uLine = 0;

_szSrc = _szFunc = _szDesc = NULL;

_pBin = NULL;

if(szSrc)

{

LPCTSTR p = szSrc;

#ifndef CX_LOG_FULL_SOURCE_NAME p = szSrc + _tcslen(szSrc);

while(p>szSrc && *p!=_T('\\')) p--;

if(*p == _T('\\'))

p++;

#endif

AllocStringBuffer(_szSrc, p);

_uLine = uLine;

AllocStringBuffer(_szFunc, szFunc);

AllocStringBuffer(_szDesc, szDesc);

if(pBin && uSize)

{

_pBin = new BYTE[uSize];

assert(_pBin);

memcpy(_pBin, pBin, uSize);

_uBinSize = uSize;

}

}

VOID AllocStringBuffer(LPTSTR& szDest, LPCTSTR& szSrc)

{

if(szSrc)

{

ULONG uSize = _tcslen(szSrc) + 1;

szDest = new TCHAR[uSize];

assert(szDest);

memcpy(szDest, szSrc, uSize*sizeof(TCHAR));

}

VOID ReleaseStringBuffer(LPTSTR& lpDest) {

if(lpDest)

{

delete []lpDest;

lpDest = NULL;

}

}

LPTSTR Format(LPTSTR szBuffer, ULONG uSize, ULONG* pSize = NULL)

{

static LPCTSTR szType[] = {_T("Message"),

_T("Warning"), _T("Exception"), _T("Error")};

if(!szBuffer)

return szBuffer;

int iLen;

#if (defined(_MSC_VER) &&

_MSC_VER<=1310) || defined(__BORLANDC__) || (defined(__GNUC__) && defined(_UNICODE)) iLen = _sntprintf(szBuffer, uSize,

CX_LOG_DEFAULT_FORMAT,

_szTime, szType[_eType],

_szSrc?_szSrc:_T(""), _uLine,

_szDesc?_szDesc:_T(""));

#else

iLen = _sntprintf(szBuffer, uSize,

CX_LOG_DEFAULT_FORMAT,

_szTime, szType[_eType],

_szSrc?_szSrc:_T(""), _szFunc?_szFunc:_T(""), _uLine, _szDesc?_szDesc:_T(""));

#endif

if(iLen>4 && !_tcsncmp(szBuffer+iLen-4, _T("\r\n"), 2))

*(szBuffer+iLen-2) = TCHAR(NULL), iLen -= 2;

if(pSize)

*pSize = iLen;

return szBuffer;

}

LPTSTR FormatBinary(LPTSTR szBuffer, ULONG uSize, ULONG* pSize = NULL,

bool bReplace = CX_LOG_REPLACE_CONTROL,

TCHAR chReplaceAscii = CX_LOG_REPLACE_ASCII) {

return FormatBinary(_pBin, _uBinSize, szBuffer, uSize, pSize,

bReplace, chReplaceAscii);

}

LPTSTR FormatBinary(LPVOID lpBin, ULONG uBinSize, LPTSTR szBuffer, ULONG uSize, ULONG* pSize = NULL,

bool bReplace = CX_LOG_REPLACE_CONTROL,

TCHAR chReplaceAscii = CX_LOG_REPLACE_ASCII) {

static TCHAR chHex[] = {

_T('0'), _T('1'), _T('2'), _T('3'), _T('4'), _T('5'), _T('6'),

_T('7'),

_T('8'), _T('9'), _T('A'), _T('B'), _T('C'), _T('D'), _T('E'), _T('F')};

TCHAR temp[8+2+3*16+16+2+1];

ULONG uActualSize = 0;

if(!_pBin)

{

if(pSize)

*pSize = uActualSize;

return szBuffer;

}

if(!szBuffer)

{

uSize = ((_uBinSize>>4)+1)*(8+2+3*16+16+2)+1;

szBuffer = new TCHAR[uSize];

assert(szBuffer);

}

for(ULONG p = 0; p<_uBinSize && uActualSize<uSize-1; p += 16)

{

wsprintf(temp, _T("%08X: "), p);

int i;

for(i = 0; i < 16; i++)

{

if(p+i<_uBinSize)

{

*(temp+8+2+3*i) = chHex[*(_pBin+p+i)>>4];

*(temp+8+2+3*i+1) =

chHex[*(_pBin+p+i)&0x0F];

*(temp+8+2+3*i+2) = _T(' ');

}

else

_tcscpy(temp+8+2+3*i, _T(" "));

}

for(i = 0; i < 16; i++)

{

if(p+i<_uBinSize)

*(temp+8+2+3*16+i) =

(bReplace&&_istcntrl(TCHAR(*(_pBin+p+i)))) ? chReplaceAscii : *(_pBin+p+i);

else

*(temp+8+2+3*16+i) = _T(' ');

}

_tcscpy(temp+8+2+3*16+16, _T("\r\n"));

ULONG uLen = uSize-uActualSize-1>8+2+3*16+16+2? 8+2+3*16+16+2 : uSize-uActualSize-1;

memcpy(szBuffer+uActualSize, temp,

uLen*sizeof(TCHAR));

uActualSize += uLen;

}

if(pSize)

*pSize = uActualSize;

szBuffer[uActualSize] = TCHAR(NULL);

return szBuffer;

}

};

LPTSTR GetLogFileName()

{

#if defined(CX_LOG_BY_DAY) ||

defined(CX_LOG_BY_WEEK) ||

defined(CX_LOG_BY_MONTH) ||

defined(CX_LOG_BY_YEAR)

time_t now = time(NULL);

TCHAR szName[64];

#if defined(CX_LOG_BY_DAY)

_tcsftime(szName, 64, _T("%Y%m%d.log"), localtime(&now));

#elif defined(CX_LOG_BY_WEEK)

_tcsftime(szName, 64, _T("%Y%W.log"), localtime(&now));

#elif defined(CX_LOG_BY_MONTH)

_tcsftime(szName, 64, _T("%Y%m.log"),

localtime(&now));

#elif defined(CX_LOG_BY_YEAR)

_tcsftime(szName, 64, _T("%Y.log"),

localtime(&now));

#endif

_tcscat(_tcscpy(_szFileName, GetFilePath()), szName); #endif

return _szFileName;

}

TCHAR* GetFilePath()

{

static TCHAR szFilePath[MAX_PATH];

static BOOL bFlag = FALSE;

//std::string str;

if(!bFlag)

{

DWORD dwLen = ::GetModuleFileName(NULL, szFilePath, MAX_PATH);

//str = szFilePath;

if(dwLen)

{

LPTSTR p = szFilePath + dwLen;

while(p>szFilePath && *p!=_T('\\'))

p--;

if(*p == _T('\\'))

_tcscpy(p, _T("\\Log\\"));

}

else

_tcscpy(szFilePath, _T(".\\Log\\"));

bFlag = TRUE;

}

return szFilePath;

}

public:

CxLog(bool &alive) : _bAlive(alive)

{

_bAlive = true;

_hWnd = NULL;

#ifdef CX_LOG_FILE_NAME

ULONG uSize = _tcslen(CX_LOG_FILE_NAME) + 1; uSize = uSize>MAX_PATH ? MAX_PATH : uSize;

memcpy(_szFileName, CX_LOG_FILE_NAME,

uSize*sizeof(TCHAR));

#else

CreateDirectory(GetFilePath(), NULL); //>create log sub dir

#if !defined(CX_LOG_BY_DAY)

&& !defined(CX_LOG_BY_WEEK)

&& !defined(CX_LOG_BY_MONTH)

&& !defined(CX_LOG_BY_YEAR)

time_t now = time(NULL);

TCHAR szName[64];

_tcsftime(szName, 64, _T("%Y%m%d.log"),

localtime(&now));

_tcscat(_tcscpy(_szFileName, GetFilePath()), szName);

#endif

#endif

_TerminateEvent = CreateEvent(0, TRUE, FALSE, NULL); _LogHandle = CreateEvent(0, FALSE, FALSE, NULL);

::InitializeCriticalSection(&_LogMutex);

#ifdef _MT

unsigned int id;

_hThreadHandle = (HANDLE)::_beginthreadex(NULL, 0,

StaticThreadProc, this, 0, &id);

#else

DWORD id;

_hThreadHandle = ::CreateThread(NULL, 0, StaticThreadProc, this, 0, &id);

#endif

}

~CxLog()

{

Destroy();

}

VOID Destroy()

{

_bAlive = false;

if(_hThreadHandle)

{

SetEvent(_TerminateEvent);

if(::WaitForSingleObject(_hThreadHandle, 500) != WAIT_OBJECT_0)

::TerminateThread(_hThreadHandle, 0);

CloseHandle(_hThreadHandle);

}

::DeleteCriticalSection(&_LogMutex);

}

VOID Lock()

{

::EnterCriticalSection(&_LogMutex);

}

VOID Unlock()

{

::LeaveCriticalSection(&_LogMutex);

}

VOID Log(LPCTSTR szSrc, LPCTSTR szFunc, const ULONG uLine, const EnumType eType,

LPCTSTR szDesc, LPVOID pBin = NULL, ULONG uSize = 0)

{

// return;

Item* p = new Item(szSrc, szFunc, uLine, eType, szDesc, pBin, uSize);

#if defined(_CONSOLE) || defined(_DEBUG)

TCHAR szBuffer[CX_LOG_DEFAULT_FORMAT_SIZE]; p->Format(szBuffer,

CX_LOG_DEFAULT_FORMAT_SIZE);