/////////////////////////////////////////////////////////////////////////////
-// Name: log.cpp
+// Name: src/common/log.cpp
// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
// Author: Vadim Zeitlin
// Modified by:
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "log.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#if wxUSE_LOG
-// wxWindows
+// wxWidgets
#ifndef WX_PRECOMP
+ #include "wx/log.h"
#include "wx/app.h"
#include "wx/arrstr.h"
#include "wx/intl.h"
#include "wx/string.h"
+ #include "wx/utils.h"
#endif //WX_PRECOMP
#include "wx/apptrait.h"
+#include "wx/datetime.h"
#include "wx/file.h"
-#include "wx/log.h"
#include "wx/msgout.h"
#include "wx/textfile.h"
#include "wx/thread.h"
-#include "wx/utils.h"
#include "wx/wxchar.h"
// other standard headers
// implementation
// ============================================================================
-// ----------------------------------------------------------------------------
-// globals
-// ----------------------------------------------------------------------------
-
-// log functions can't allocate memory (LogError("out of memory...") should
-// work!), so we use a static buffer for all log messages
-#define LOG_BUFFER_SIZE (4096)
-
-// static buffer for error messages
-static wxChar s_szBufStatic[LOG_BUFFER_SIZE];
-
-static wxChar *s_szBuf = s_szBufStatic;
-static size_t s_szBufSize = WXSIZEOF( s_szBufStatic );
-
-#if wxUSE_THREADS
-
-// the critical section protecting the static buffer
-static wxCriticalSection gs_csLogBuf;
-
-#endif // wxUSE_THREADS
-
-// return true if we have a non NULL non disabled log target
-static inline bool IsLoggingEnabled()
-{
- return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL);
-}
-
// ----------------------------------------------------------------------------
// implementation of Log functions
//
// macros and not all compilers inline vararg functions.
// ----------------------------------------------------------------------------
-// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
-static inline void PrintfInLogBug(const wxChar *szFormat, va_list argptr)
-{
- if ( wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr) < 0 )
- {
- // must NUL-terminate it manually
- s_szBuf[s_szBufSize - 1] = _T('\0');
- }
- //else: NUL-terminated by vsnprintf()
-}
-
// generic log function
void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- PrintfInLogBug(szFormat, argptr);
-
- wxLog::OnLog(level, s_szBuf, time(NULL));
+ if ( wxLog::IsEnabled() ) {
+ wxLog::OnLog(level, wxString::FormatV(szFormat, argptr), time(NULL));
}
}
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+void wxDoLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
#define IMPLEMENT_LOG_FUNCTION(level) \
void wxVLog##level(const wxChar *szFormat, va_list argptr) \
{ \
- if ( IsLoggingEnabled() ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- PrintfInLogBug(szFormat, argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
+ if ( wxLog::IsEnabled() ) { \
+ wxLog::OnLog(wxLOG_##level, \
+ wxString::FormatV(szFormat, argptr), time(NULL));\
} \
} \
\
- void wxLog##level(const wxChar *szFormat, ...) \
+ void wxDoLog##level(const wxChar *szFormat, ...) \
{ \
va_list argptr; \
va_start(argptr, szFormat); \
::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP);
#else
wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str());
+ fflush(stderr);
#endif
}
// always terminate the program
void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
{
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
+ wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(szFormat, argptr));
#ifdef __WXWINCE__
ExitThread(3);
#endif
}
-void wxLogFatalError(const wxChar *szFormat, ...)
+void wxDoLogFatalError(const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
wxVLogFatalError(szFormat, argptr);
- va_end(argptr);
+
+ // some compilers warn about unreachable code and it shouldn't matter
+ // for the others anyhow...
+ //va_end(argptr);
}
// same as info, but only if 'verbose' mode is on
void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL && pLog->GetVerbose() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
+ if ( wxLog::IsEnabled() ) {
+ if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
+ wxLog::OnLog(wxLOG_Info,
+ wxString::FormatV(szFormat, argptr), time(NULL));
}
}
}
-void wxLogVerbose(const wxChar *szFormat, ...)
+void wxDoLogVerbose(const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
void wxVLog##level(const wxChar *szFormat, va_list argptr) \
{ \
- if ( IsLoggingEnabled() ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
+ if ( wxLog::IsEnabled() ) { \
+ wxLog::OnLog(wxLOG_##level, \
+ wxString::FormatV(szFormat, argptr), time(NULL));\
} \
} \
- void wxLog##level(const wxChar *szFormat, ...) \
+ \
+ void wxDoLog##level(const wxChar *szFormat, ...) \
{ \
va_list argptr; \
va_start(argptr, szFormat); \
void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxChar *p = s_szBuf;
- size_t len = s_szBufSize;
- wxStrncpy(s_szBuf, _T("("), len);
- len -= 1; // strlen("(")
- p += 1;
- wxStrncat(p, mask, len);
- size_t lenMask = wxStrlen(mask);
- len -= lenMask;
- p += lenMask;
-
- wxStrncat(p, _T(") "), len);
- len -= 2;
- p += 2;
-
- wxVsnprintf(p, len, szFormat, argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
+ if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
+ wxString msg;
+ msg << _T("(") << mask << _T(") ") << wxString::FormatV(szFormat, argptr);
+
+ wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
}
}
- void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+ void wxDoLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
// we check that all of mask bits are set in the current mask, so
// that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
// if both bits are set.
- if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
+ if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
+ wxLog::OnLog(wxLOG_Trace, wxString::FormatV(szFormat, argptr), time(NULL));
}
}
- void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
+ void wxDoLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
// wxLogSysError: one uses the last error code, for other you must give it
// explicitly
-// common part of both wxLogSysError
-void wxLogSysErrorHelper(long lErrCode)
+// return the system error message description
+static inline wxString wxLogSysErrorHelper(long err)
{
- wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
- wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
- _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
- wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf));
-
- wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
+ return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
}
void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxLogSysErrorHelper(wxSysErrorCode());
- }
+ wxVLogSysError(wxSysErrorCode(), szFormat, argptr);
}
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+void WXDLLEXPORT wxDoLogSysError(const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
va_end(argptr);
}
-void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
+void WXDLLEXPORT wxVLogSysError(long err, const wxChar *fmt, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxLogSysErrorHelper(lErrCode);
+ if ( wxLog::IsEnabled() ) {
+ wxLog::OnLog(wxLOG_Error,
+ wxString::FormatV(fmt, argptr) + wxLogSysErrorHelper(err),
+ time(NULL));
}
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+void WXDLLEXPORT wxDoLogSysError(long lErrCode, const wxChar *szFormat, ...)
{
va_list argptr;
va_start(argptr, szFormat);
// wxLog class implementation
// ----------------------------------------------------------------------------
-wxLog::wxLog()
+/* static */
+unsigned wxLog::DoLogNumberOfRepeats()
{
+ long retval = ms_prevCounter;
+ wxLog *pLogger = GetActiveTarget();
+ if ( pLogger && ms_prevCounter > 0 )
+ {
+ wxString msg;
+#if wxUSE_INTL
+ msg.Printf(wxPLURAL("The previous message repeated once.",
+ "The previous message repeated %lu times.",
+ ms_prevCounter),
+ ms_prevCounter);
+#else
+ msg.Printf(wxT("The previous message was repeated."));
+#endif
+ ms_prevCounter = 0;
+ ms_prevString.clear();
+ pLogger->DoLog(ms_prevLevel, msg.c_str(), ms_prevTimeStamp);
+ }
+ return retval;
}
-wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
+wxLog::~wxLog()
{
- wxChar *oldbuf = s_szBuf;
-
- if( buf == 0 )
+ if ( ms_prevCounter > 0 )
{
- s_szBuf = s_szBufStatic;
- s_szBufSize = WXSIZEOF( s_szBufStatic );
+ // looks like the repeat count has not been logged yet,
+ // so let's do it now
+ wxLog::DoLogNumberOfRepeats();
}
- else
+}
+
+/* static */
+void wxLog::OnLog(wxLogLevel level, const wxChar *szString, time_t t)
+{
+ if ( IsEnabled() && ms_logLevel >= level )
{
- s_szBuf = buf;
- s_szBufSize = size;
+ wxLog *pLogger = GetActiveTarget();
+ if ( pLogger )
+ {
+ if ( GetRepetitionCounting() && ms_prevString == szString )
+ {
+ ms_prevCounter++;
+ }
+ else
+ {
+ if ( GetRepetitionCounting() )
+ {
+ DoLogNumberOfRepeats();
+ }
+ ms_prevString = szString;
+ ms_prevLevel = level;
+ ms_prevTimeStamp = t;
+ pLogger->DoLog(level, szString, t);
+ }
+ }
}
+}
- return (oldbuf == s_szBufStatic ) ? 0 : oldbuf;
+// deprecated function
+#if WXWIN_COMPATIBILITY_2_6
+
+wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
+{
+ return NULL;
}
+#endif // WXWIN_COMPATIBILITY_2_6
+
wxLog *wxLog::GetActiveTarget()
{
if ( ms_bAutoCreate && ms_pLogger == NULL ) {
// prevent infinite recursion if someone calls wxLogXXX() from
// wxApp::CreateLogTarget()
- static bool s_bInGetActiveTarget = FALSE;
+ static bool s_bInGetActiveTarget = false;
if ( !s_bInGetActiveTarget ) {
- s_bInGetActiveTarget = TRUE;
+ s_bInGetActiveTarget = true;
// ask the application to create a log target for us
if ( wxTheApp != NULL )
else
ms_pLogger = new wxLogStderr;
- s_bInGetActiveTarget = FALSE;
+ s_bInGetActiveTarget = false;
// do nothing if it fails - what can we do?
}
void wxLog::DontCreateOnDemand()
{
- ms_bAutoCreate = FALSE;
+ ms_bAutoCreate = false;
// this is usually called at the end of the program and we assume that it
// is *always* called at the end - so we free memory here to avoid false
void wxLog::TimeStamp(wxString *str)
{
+#if wxUSE_DATETIME
if ( ms_timestamp )
{
wxChar buf[256];
time_t timeNow;
(void)time(&timeNow);
- wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
+
+ struct tm tm;
+ wxStrftime(buf, WXSIZEOF(buf),
+ ms_timestamp, wxLocaltime_r(&timeNow, &tm));
str->Empty();
*str << buf << wxT(": ");
}
+#endif // wxUSE_DATETIME
}
void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
return false;
}
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
+
+void wxLogBuffer::Flush()
+{
+ if ( !m_str.empty() )
+ {
+ wxMessageOutputBest out;
+ out.Printf(_T("%s"), m_str.c_str());
+ m_str.clear();
+ }
+}
+
+void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+{
+ switch ( level )
+ {
+ case wxLOG_Trace:
+ case wxLOG_Debug:
+#ifdef __WXDEBUG__
+ // don't put debug messages in the buffer, we don't want to show
+ // them to the user in a msg box, log them immediately
+ {
+ wxString str;
+ TimeStamp(&str);
+ str += szString;
+
+ wxMessageOutputDebug dbgout;
+ dbgout.Printf(_T("%s\n"), str.c_str());
+ }
+#endif // __WXDEBUG__
+ break;
+
+ default:
+ wxLog::DoLog(level, szString, t);
+ }
+}
+
+void wxLogBuffer::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+{
+ m_str << szString << _T("\n");
+}
+
// ----------------------------------------------------------------------------
// wxLogStderr class implementation
// ----------------------------------------------------------------------------
TimeStamp(&str);
str << szString;
- fputs(str.mb_str(), m_fp);
- fputc(_T('\n'), m_fp);
+ wxFputs(str, m_fp);
+ wxFputc(_T('\n'), m_fp);
fflush(m_fp);
// under GUI systems such as Windows or Mac, programs usually don't have
wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
if ( traits && !traits->HasStderr() )
{
- wxMessageOutputDebug().Printf(_T("%s"), str.c_str());
+ wxMessageOutputDebug dbgout;
+ dbgout.Printf(_T("%s\n"), str.c_str());
}
}
}
{
wxString str;
TimeStamp(&str);
- (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl;
+ (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
wxLogChain::wxLogChain(wxLog *logger)
{
- m_bPassMessages = TRUE;
+ m_bPassMessages = true;
m_logNew = logger;
m_logOld = wxLog::SetActiveTarget(this);
// static variables
// ----------------------------------------------------------------------------
+bool wxLog::ms_bRepetCounting = false;
+wxString wxLog::ms_prevString;
+unsigned int wxLog::ms_prevCounter = 0;
+time_t wxLog::ms_prevTimeStamp= 0;
+wxLogLevel wxLog::ms_prevLevel;
+
wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
-bool wxLog::ms_doLog = TRUE;
-bool wxLog::ms_bAutoCreate = TRUE;
-bool wxLog::ms_bVerbose = FALSE;
+bool wxLog::ms_doLog = true;
+bool wxLog::ms_bAutoCreate = true;
+bool wxLog::ms_bVerbose = false;
wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
nErrCode = wxSysErrorCode();
#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
+ static wxChar s_szBuf[1024];
// get error message from system
LPVOID lpMsgBuf;
- FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
- NULL, nErrCode,
+ if ( ::FormatMessage
+ (
+ FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
+ NULL,
+ nErrCode,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
(LPTSTR)&lpMsgBuf,
- 0, NULL);
+ 0,
+ NULL
+ ) == 0 )
+ {
+ // if this happens, something is seriously wrong, so don't use _() here
+ // for safety
+ wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
+ return s_szBuf;
+ }
+
// copy it to our buffer and free memory
- if( lpMsgBuf != 0 ) {
+ // Crashes on SmartPhone (FIXME)
+#if !defined(__SMARTPHONE__) /* of WinCE */
+ if( lpMsgBuf != 0 )
+ {
wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
s_szBuf[len - 2] = wxT('\0');
}
}
- else {
+ else
+#endif // !__SMARTPHONE__
+ {
s_szBuf[0] = wxT('\0');
}
return s_szBuf;
-#else // Unix-WXMICROWIN
-#if wxUSE_UNICODE
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
- wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
- return s_szBuf;
-#else
- return strerror((int)nErrCode);
-#endif
-#endif // Win/Unix-WXMICROWIN
+#else // !__WXMSW__
+ #if wxUSE_UNICODE
+ static wchar_t s_wzBuf[1024];
+ wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
+ WXSIZEOF(s_wzBuf) - 1);
+ return s_wzBuf;
+ #else
+ return strerror((int)nErrCode);
+ #endif
+#endif // __WXMSW__/!__WXMSW__
}
#endif // wxUSE_LOG
-
projects / wxWidgets.git / blobdiff