/////////////////////////////////////////////////////////////////////////////
-// Name: log.cpp
+// Name: src/common/log.cpp
// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
// Author: Vadim Zeitlin
// Modified by:
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "log.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-// wxWindows
+#if wxUSE_LOG
+
+// wxWidgets
#ifndef WX_PRECOMP
- #include "wx/string.h"
- #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/app.h"
-
- #if wxUSE_GUI
- #include "wx/window.h"
- #ifdef __WXMSW__
- #include "wx/msw/private.h"
- #endif
- #include "wx/msgdlg.h"
- #endif
+ #include "wx/arrstr.h"
+ #include "wx/intl.h"
+ #include "wx/string.h"
+ #include "wx/utils.h"
#endif //WX_PRECOMP
-#include "wx/file.h"
-#include "wx/textfile.h"
-#include "wx/utils.h"
-#include "wx/wxchar.h"
-#include "wx/log.h"
-#include "wx/thread.h"
+#include "wx/apptrait.h"
+#include "wx/datetime.h"
+#include "wx/file.h"
+#include "wx/msgout.h"
+#include "wx/textfile.h"
+#include "wx/thread.h"
+#include "wx/crt.h"
// other standard headers
-#include <errno.h>
-#include <stdlib.h>
-#include <time.h>
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
-#ifdef __WXMSW__
- #include "wx/msw/private.h" // includes windows.h for OutputDebugString
-#else //Unix
- #include <signal.h>
-#endif //Win/Unix
+#include <stdlib.h>
+
+#ifndef __WXPALMOS5__
+#ifndef __WXWINCE__
+#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
+#endif
+#endif /* ! __WXPALMOS5__ */
+
+#if defined(__WINDOWS__)
+ #include "wx/msw/private.h" // includes windows.h
+#endif
+
+#if wxUSE_THREADS
+
+// define static functions providing access to the critical sections we use
+// instead of just using static critical section variables as log functions may
+// be used during static initialization and while this is certainly not
+// advisable it's still better to not crash (as we'd do if we used a yet
+// uninitialized critical section) if it happens
+
+static inline wxCriticalSection& GetTraceMaskCS()
+{
+ static wxCriticalSection s_csTrace;
+
+ return s_csTrace;
+}
+
+static inline wxCriticalSection& GetPreviousLogCS()
+{
+ static wxCriticalSection s_csPrev;
+
+ return s_csPrev;
+}
+
+#endif // wxUSE_THREADS
// ----------------------------------------------------------------------------
// non member functions
// 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_szBuf[LOG_BUFFER_SIZE];
-
-#if wxUSE_THREADS
-
-// the critical section protecting the static buffer
-static wxCriticalSection gs_csLogBuf;
-
-#endif // wxUSE_THREADS
-
// ----------------------------------------------------------------------------
// implementation of Log functions
//
// ----------------------------------------------------------------------------
// generic log function
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
{
- if ( wxLog::GetActiveTarget() != NULL ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ if ( wxLog::IsEnabled() ) {
+ wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
+ }
+}
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...)
+{
va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
+ va_start(argptr, format);
+ wxVLogGeneric(level, format, argptr);
va_end(argptr);
+}
+#endif // wxUSE_UTF8_LOCALE_ONLY
- wxLog::OnLog(level, s_szBuf, time(NULL));
- }
+#if wxUSE_UNICODE_UTF8
+void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...)
+{
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogGeneric(level, format, argptr);
+ va_end(argptr);
}
+#endif // wxUSE_UNICODE_UTF8
+
+#if !wxUSE_UTF8_LOCALE_ONLY
+ #define IMPLEMENT_LOG_FUNCTION_WCHAR(level) \
+ void wxDoLog##level##Wchar(const wxChar *format, ...) \
+ { \
+ va_list argptr; \
+ va_start(argptr, format); \
+ wxVLog##level(format, argptr); \
+ va_end(argptr); \
+ }
+#else
+ #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)
+#endif
-#define IMPLEMENT_LOG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
- { \
- if ( wxLog::GetActiveTarget() != NULL ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- va_list argptr; \
- va_start(argptr, szFormat); \
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
- } \
- }
+#if wxUSE_UNICODE_UTF8
+ #define IMPLEMENT_LOG_FUNCTION_UTF8(level) \
+ void wxDoLog##level##Utf8(const char *format, ...) \
+ { \
+ va_list argptr; \
+ va_start(argptr, format); \
+ wxVLog##level(format, argptr); \
+ va_end(argptr); \
+ }
+#else
+ #define IMPLEMENT_LOG_FUNCTION_UTF8(level)
+#endif
+
+#define IMPLEMENT_LOG_FUNCTION(level) \
+ void wxVLog##level(const wxString& format, va_list argptr) \
+ { \
+ if ( wxLog::IsEnabled() ) { \
+ wxLog::OnLog(wxLOG_##level, \
+ wxString::FormatV(format, argptr), time(NULL)); \
+ } \
+ } \
+ IMPLEMENT_LOG_FUNCTION_WCHAR(level) \
+ IMPLEMENT_LOG_FUNCTION_UTF8(level)
-IMPLEMENT_LOG_FUNCTION(FatalError)
IMPLEMENT_LOG_FUNCTION(Error)
IMPLEMENT_LOG_FUNCTION(Warning)
IMPLEMENT_LOG_FUNCTION(Message)
IMPLEMENT_LOG_FUNCTION(Info)
IMPLEMENT_LOG_FUNCTION(Status)
+void wxSafeShowMessage(const wxString& title, const wxString& text)
+{
+#ifdef __WINDOWS__
+ ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
+#else
+ wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
+ fflush(stderr);
+#endif
+}
+
+// fatal errors can't be suppressed nor handled by the custom log target and
+// always terminate the program
+void wxVLogFatalError(const wxString& format, va_list argptr)
+{
+ wxSafeShowMessage(wxS("Fatal Error"), wxString::FormatV(format, argptr));
+
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
+ abort();
+#endif
+}
+
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogFatalErrorWchar(const wxChar *format, ...)
+{
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogFatalError(format, argptr);
+
+ // some compilers warn about unreachable code and it shouldn't matter
+ // for the others anyhow...
+ //va_end(argptr);
+}
+#endif // wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void wxDoLogFatalErrorUtf8(const char *format, ...)
+{
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogFatalError(format, argptr);
+
+ // some compilers warn about unreachable code and it shouldn't matter
+ // for the others anyhow...
+ //va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
+
// same as info, but only if 'verbose' mode is on
-void wxLogVerbose(const wxChar *szFormat, ...)
+void wxVLogVerbose(const wxString& format, va_list argptr)
{
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL && pLog->GetVerbose() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ if ( wxLog::IsEnabled() ) {
+ if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
+ wxLog::OnLog(wxLOG_Info,
+ wxString::FormatV(format, argptr), time(NULL));
+ }
+ }
+}
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogVerboseWchar(const wxChar *format, ...)
+{
va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
+ va_start(argptr, format);
+ wxVLogVerbose(format, argptr);
va_end(argptr);
+}
+#endif // !wxUSE_UTF8_LOCALE_ONLY
- wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
- }
+#if wxUSE_UNICODE_UTF8
+void wxDoLogVerboseUtf8(const char *format, ...)
+{
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogVerbose(format, argptr);
+ va_end(argptr);
}
+#endif // wxUSE_UNICODE_UTF8
// debug functions
#ifdef __WXDEBUG__
-#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
- { \
- if ( wxLog::GetActiveTarget() != NULL ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- va_list argptr; \
- va_start(argptr, szFormat); \
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
- } \
- }
- void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+ #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level) \
+ void wxDoLog##level##Wchar(const wxChar *format, ...) \
+ { \
+ va_list argptr; \
+ va_start(argptr, format); \
+ wxVLog##level(format, argptr); \
+ va_end(argptr); \
+ }
+#else
+ #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)
+#endif
+
+#if wxUSE_UNICODE_UTF8
+ #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level) \
+ void wxDoLog##level##Utf8(const char *format, ...) \
+ { \
+ va_list argptr; \
+ va_start(argptr, format); \
+ wxVLog##level(format, argptr); \
+ va_end(argptr); \
+ }
+#else
+ #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
+#endif
+
+#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
+ void wxVLog##level(const wxString& format, va_list argptr) \
+ { \
+ if ( wxLog::IsEnabled() ) { \
+ wxLog::OnLog(wxLOG_##level, \
+ wxString::FormatV(format, argptr), time(NULL)); \
+ } \
+ } \
+ IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level) \
+ IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
+
+
+ void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
{
- wxLog *pLog = wxLog::GetActiveTarget();
-
- if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxChar *p = s_szBuf;
- size_t len = WXSIZEOF(s_szBuf);
- strncpy(s_szBuf, _T("Trace ("), len);
- len -= 7; // strlen("Trace (")
- p += 7;
- strncat(p, mask, len);
- size_t lenMask = wxStrlen(mask);
- len -= lenMask;
- p += lenMask;
-
- strncat(p, _T("): "), len);
- len -= 3;
- p += 3;
-
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(p, len, szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
+ if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
+ wxString msg;
+ msg << wxS("(") << mask << wxS(") ") << wxString::FormatV(format, argptr);
+
+ wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
}
}
- void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+ void wxDoLogTraceWchar(const wxString& mask, const wxChar *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+ void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...)
{
- wxLog *pLog = wxLog::GetActiveTarget();
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+#endif // wxUSE_UNICODE_UTF8
+ void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
+ {
// 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 ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
+ wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
+ }
+ }
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+#if !wxUSE_UTF8_LOCALE_ONLY
+ void wxDoLogTraceWchar(wxTraceMask mask, const wxChar *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
- }
+#if wxUSE_UNICODE_UTF8
+ void wxDoLogTraceUtf8(wxTraceMask mask, const char *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+#endif // wxUSE_UNICODE_UTF8
+
+#ifdef __WATCOMC__
+ // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+ void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+
+ void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
}
+ void wxDoLogTraceWchar(const wchar_t *mask, const wxChar *format, ...)
+ {
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogTrace(mask, format, argptr);
+ va_end(argptr);
+ }
+
+ void wxVLogTrace(int mask, const wxString& format, va_list argptr)
+ { wxVLogTrace((wxTraceMask)mask, format, argptr); }
+ void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
+ { wxVLogTrace(wxString(mask), format, argptr); }
+ void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
+ { wxVLogTrace(wxString(mask), format, argptr); }
+#endif // __WATCOMC__
+
#else // release
#define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
#endif
// 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, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf));
+ return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
+}
- wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
+void WXDLLIMPEXP_BASE wxVLogSysError(const wxString& format, va_list argptr)
+{
+ wxVLogSysError(wxSysErrorCode(), format, argptr);
}
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(const wxChar *format, ...)
{
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogSysError(format, argptr);
+ va_end(argptr);
+}
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+#if wxUSE_UNICODE_UTF8
+void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(const char *format, ...)
+{
va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
+ va_start(argptr, format);
+ wxVLogSysError(format, argptr);
va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
- wxLogSysErrorHelper(wxSysErrorCode());
+void WXDLLIMPEXP_BASE wxVLogSysError(long err, const wxString& format, va_list argptr)
+{
+ if ( wxLog::IsEnabled() ) {
+ wxLog::OnLog(wxLOG_Error,
+ wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
+ time(NULL));
+ }
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
{
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogSysError(lErrCode, format, argptr);
+ va_end(argptr);
+}
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+#if wxUSE_UNICODE_UTF8
+void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
+{
va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
+ va_start(argptr, format);
+ wxVLogSysError(lErrCode, format, argptr);
va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
- wxLogSysErrorHelper(lErrCode);
+#ifdef __WATCOMC__
+// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
+{
+ va_list argptr;
+ va_start(argptr, format);
+ wxVLogSysError(lErrCode, format, argptr);
+ va_end(argptr);
}
+void WXDLLIMPEXP_BASE wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
+ { wxVLogSysError((long)err, format, argptr); }
+#endif // __WATCOMC__
+
// ----------------------------------------------------------------------------
// wxLog class implementation
// ----------------------------------------------------------------------------
-wxLog::wxLog()
+unsigned wxLog::LogLastRepeatIfNeeded()
{
- m_bHasMessages = FALSE;
+ wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());
- // enable verbose messages by default in the debug builds
-#ifdef __WXDEBUG__
- m_bVerbose = TRUE;
-#else // release
- m_bVerbose = FALSE;
-#endif // debug/release
+ return LogLastRepeatIfNeededUnlocked();
+}
+
+unsigned wxLog::LogLastRepeatIfNeededUnlocked()
+{
+ const unsigned count = ms_prevCounter;
+
+ if ( ms_prevCounter )
+ {
+ 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(wxS("The previous message was repeated %lu times."),
+ ms_prevCounter);
+#endif
+ ms_prevCounter = 0;
+ ms_prevString.clear();
+ DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
+ }
+
+ return count;
+}
+
+wxLog::~wxLog()
+{
+ // Flush() must be called before destroying the object as otherwise some
+ // messages could be lost
+ if ( ms_prevCounter )
+ {
+ wxMessageOutputDebug().Printf
+ (
+ wxS("Last repeated message (\"%s\", %lu times) wasn't output"),
+ ms_prevString,
+ ms_prevCounter
+ );
+ }
}
+/* static */
+void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
+{
+ if ( IsEnabled() && ms_logLevel >= level )
+ {
+ wxLog *pLogger = GetActiveTarget();
+ if ( pLogger )
+ {
+ if ( GetRepetitionCounting() )
+ {
+ wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());
+
+ if ( szString == ms_prevString )
+ {
+ ms_prevCounter++;
+
+ // nothing else to do, in particular, don't log the
+ // repeated message
+ return;
+ }
+
+ pLogger->LogLastRepeatIfNeededUnlocked();
+
+ // reset repetition counter for a new message
+ ms_prevString = szString;
+ ms_prevLevel = level;
+ ms_prevTimeStamp = t;
+ }
+
+ pLogger->DoLog(level, szString, t);
+ }
+ }
+}
+
+// deprecated function
+#if WXWIN_COMPATIBILITY_2_6
+
+wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
+{
+ return NULL;
+}
+
+#endif // WXWIN_COMPATIBILITY_2_6
+
+#if WXWIN_COMPATIBILITY_2_8
+
+void wxLog::DoLog(wxLogLevel WXUNUSED(level),
+ const char *WXUNUSED(szString),
+ time_t WXUNUSED(t))
+{
+}
+
+void wxLog::DoLog(wxLogLevel WXUNUSED(level),
+ const wchar_t *WXUNUSED(wzString),
+ time_t WXUNUSED(t))
+{
+}
+
+#endif // WXWIN_COMPATIBILITY_2_8
+
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 )
- ms_pLogger = wxTheApp->CreateLogTarget();
+ ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
else
ms_pLogger = new wxLogStderr;
- s_bInGetActiveTarget = FALSE;
+ s_bInGetActiveTarget = false;
// do nothing if it fails - what can we do?
}
return pOldLogger;
}
+void wxLog::DontCreateOnDemand()
+{
+ 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
+ // memory leak reports from wxWin memory tracking code
+ ClearTraceMasks();
+}
+
+void wxLog::DoCreateOnDemand()
+{
+ ms_bAutoCreate = true;
+}
+
+void wxLog::AddTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ ms_aTraceMasks.push_back(str);
+}
+
void wxLog::RemoveTraceMask(const wxString& str)
{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
int index = ms_aTraceMasks.Index(str);
if ( index != wxNOT_FOUND )
- ms_aTraceMasks.Remove((size_t)index);
+ ms_aTraceMasks.RemoveAt((size_t)index);
+}
+
+void wxLog::ClearTraceMasks()
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ ms_aTraceMasks.Clear();
}
void wxLog::TimeStamp(wxString *str)
{
- if ( ms_timestamp )
+#if wxUSE_DATETIME
+ if ( !ms_timestamp.empty() )
{
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(": ");
+ *str << buf << wxS(": ");
}
+#endif // wxUSE_DATETIME
}
-void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
{
+#if WXWIN_COMPATIBILITY_2_8
+ // DoLog() signature changed since 2.8, so we call the old versions here
+ // so that existing custom log classes still work:
+ DoLog(level, (const char*)szString.mb_str(), t);
+ DoLog(level, (const wchar_t*)szString.wc_str(), t);
+#endif
+
switch ( level ) {
case wxLOG_FatalError:
- DoLogString(wxString(_("Fatal error: ")) + szString, t);
- DoLogString(_("Program aborted."), t);
+ LogString(_("Fatal error: ") + szString, t);
+ LogString(_("Program aborted."), t);
Flush();
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
abort();
+#endif
break;
case wxLOG_Error:
- DoLogString(wxString(_("Error: ")) + szString, t);
+ LogString(_("Error: ") + szString, t);
break;
case wxLOG_Warning:
- DoLogString(wxString(_("Warning: ")) + szString, t);
+ LogString(_("Warning: ") + szString, t);
break;
case wxLOG_Info:
case wxLOG_Message:
case wxLOG_Status:
default: // log unknown log levels too
- DoLogString(szString, t);
+ LogString(szString, t);
break;
case wxLOG_Trace:
case wxLOG_Debug:
#ifdef __WXDEBUG__
- DoLogString(szString, t);
-#endif
+ {
+ wxString msg = level == wxLOG_Trace ? wxS("Trace: ")
+ : wxS("Debug: ");
+ msg << szString;
+ LogString(msg, t);
+ }
+#endif // Debug
break;
}
}
-void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
+void wxLog::DoLogString(const wxString& szString, time_t t)
{
- wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
+#if WXWIN_COMPATIBILITY_2_8
+ // DoLogString() signature changed since 2.8, so we call the old versions
+ // here so that existing custom log classes still work; unfortunately this
+ // also means that we can't have the wxFAIL_MSG below in compat mode
+ DoLogString((const char*)szString.mb_str(), t);
+ DoLogString((const wchar_t*)szString.wc_str(), t);
+#else
+ wxFAIL_MSG(wxS("DoLogString must be overriden if it's called."));
+ wxUnusedVar(szString);
+ wxUnusedVar(t);
+#endif
}
void wxLog::Flush()
{
- // do nothing
+ LogLastRepeatIfNeeded();
+}
+
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
+ en = ms_aTraceMasks.end();
+ it != en; ++it )
+ {
+ if ( *it == mask)
+ return true;
+ }
+
+ return false;
+}
+
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
+
+void wxLogBuffer::Flush()
+{
+ if ( !m_str.empty() )
+ {
+ wxMessageOutputBest out;
+ out.Printf(wxS("%s"), m_str.c_str());
+ m_str.clear();
+ }
+}
+
+void wxLogBuffer::DoLog(wxLogLevel level, const wxString& 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(wxS("%s\n"), str.c_str());
+ }
+#endif // __WXDEBUG__
+ break;
+
+ default:
+ wxLog::DoLog(level, szString, t);
+ }
+}
+
+void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
+{
+ m_str << szString << wxS("\n");
}
// ----------------------------------------------------------------------------
m_fp = fp;
}
-void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
{
wxString str;
TimeStamp(&str);
str << szString;
- fputs(str.mb_str(), m_fp);
- fputc(_T('\n'), m_fp);
+ wxFputs(str, m_fp);
+ wxFputc(wxS('\n'), m_fp);
fflush(m_fp);
- // under Windows, programs usually don't have stderr at all, so show the
- // messages also under debugger - unless it's a console program
-#if defined(__WXMSW__) && wxUSE_GUI
- OutputDebugString(str + wxT("\r\n"));
-#endif // MSW
-#if defined(__WXMAC__) && wxUSE_GUI
- debugstr(str + wxT("\r\n"));
-#endif // MSW
+ // under GUI systems such as Windows or Mac, programs usually don't have
+ // stderr at all, so show the messages also somewhere else, typically in
+ // the debugger window so that they go at least somewhere instead of being
+ // simply lost
+ if ( m_fp == stderr )
+ {
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
+ {
+ wxMessageOutputDebug dbgout;
+ dbgout.Printf(wxS("%s\n"), str.c_str());
+ }
+ }
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
#if wxUSE_STD_IOSTREAM
-wxLogStream::wxLogStream(ostream *ostr)
+#include "wx/ioswrap.h"
+wxLogStream::wxLogStream(wxSTD ostream *ostr)
{
if ( ostr == NULL )
- m_ostr = &cerr;
+ m_ostr = &wxSTD cerr;
else
m_ostr = ostr;
}
-void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
{
- (*m_ostr) << wxConvertWX2MB(szString) << endl;
+ wxString stamp;
+ TimeStamp(&stamp);
+ (*m_ostr) << stamp << szString << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
+// ----------------------------------------------------------------------------
+// wxLogChain
+// ----------------------------------------------------------------------------
+
+wxLogChain::wxLogChain(wxLog *logger)
+{
+ m_bPassMessages = true;
+
+ m_logNew = logger;
+ m_logOld = wxLog::SetActiveTarget(this);
+}
+
+wxLogChain::~wxLogChain()
+{
+ delete m_logOld;
+
+ if ( m_logNew != this )
+ delete m_logNew;
+}
+
+void wxLogChain::SetLog(wxLog *logger)
+{
+ if ( m_logNew != this )
+ delete m_logNew;
+
+ m_logNew = logger;
+}
+
+void wxLogChain::Flush()
+{
+ if ( m_logOld )
+ m_logOld->Flush();
+
+ // be careful to avoid infinite recursion
+ if ( m_logNew && m_logNew != this )
+ m_logNew->Flush();
+}
+
+void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
+{
+ // let the previous logger show it
+ if ( m_logOld && IsPassingMessages() )
+ {
+ // bogus cast just to access protected DoLog
+ ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
+ }
+
+ if ( m_logNew && m_logNew != this )
+ {
+ // as above...
+ ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
+ }
+}
+
+#ifdef __VISUALC__
+ // "'this' : used in base member initializer list" - so what?
+ #pragma warning(disable:4355)
+#endif // VC++
+
+// ----------------------------------------------------------------------------
+// wxLogInterposer
+// ----------------------------------------------------------------------------
+
+wxLogInterposer::wxLogInterposer()
+ : wxLogChain(this)
+{
+}
+
+// ----------------------------------------------------------------------------
+// wxLogInterposerTemp
+// ----------------------------------------------------------------------------
+
+wxLogInterposerTemp::wxLogInterposerTemp()
+ : wxLogChain(this)
+{
+ DetachOldLog();
+}
+
+#ifdef __VISUALC__
+ #pragma warning(default:4355)
+#endif // VC++
+
// ============================================================================
// Global functions/variables
// ============================================================================
// 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_doLog = true;
+bool wxLog::ms_bAutoCreate = true;
+bool wxLog::ms_bVerbose = false;
-#if wxUSE_GUI
- const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date
-#else
- const wxChar *wxLog::ms_timestamp = NULL; // save space
-#endif
+wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
+
+size_t wxLog::ms_suspendCount = 0;
+
+wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date
wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
wxArrayString wxLog::ms_aTraceMasks;
// get error code from syste
unsigned long wxSysErrorCode()
{
-#ifdef __WXMSW__
-#ifdef __WIN32__
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
return ::GetLastError();
-#else //WIN16
- // TODO what to do on Windows 3.1?
- return 0;
-#endif //WIN16/32
#else //Unix
return errno;
#endif //Win/Unix
if ( nErrCode == 0 )
nErrCode = wxSysErrorCode();
-#ifdef __WXMSW__
-#ifdef __WIN32__
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
+ 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);
-
- // copy it to our buffer and free memory
- wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
- s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
- LocalFree(lpMsgBuf);
-
- // returned string is capitalized and ended with '\r\n' - bad
- s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
- size_t len = wxStrlen(s_szBuf);
- if ( len > 0 ) {
- // truncate string
- if ( s_szBuf[len - 2] == wxT('\r') )
- s_szBuf[len - 2] = wxT('\0');
- }
-
- return s_szBuf;
-#else //Win16
- // TODO
- return NULL;
-#endif // Win16/32
-#else // Unix
-#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
-}
-
-// ----------------------------------------------------------------------------
-// debug helper
-// ----------------------------------------------------------------------------
-
-#ifdef __WXDEBUG__
-
-// break into the debugger
-void Trap()
-{
-#ifdef __WXMSW__
- DebugBreak();
-#elif defined(__WXMAC__)
-#if __powerc
- Debugger();
-#else
- SysBreak();
-#endif
-#elif defined(__UNIX__)
- raise(SIGTRAP);
-#else
- // TODO
-#endif // Win/Unix
-}
-
-// this function is called when an assert fails
-void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
-{
- // this variable can be set to true to suppress "assert failure" messages
- static bool s_bNoAsserts = FALSE;
- static bool s_bInAssert = FALSE; // FIXME MT-unsafe
-
- if ( s_bInAssert ) {
- // He-e-e-e-elp!! we're trapped in endless loop
- Trap();
-
- s_bInAssert = FALSE;
-
- return;
+ 0,
+ NULL
+ ) == 0 )
+ {
+ // if this happens, something is seriously wrong, so don't use _() here
+ // for safety
+ wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode);
+ return s_szBuf;
}
- s_bInAssert = TRUE;
-
- wxChar szBuf[LOG_BUFFER_SIZE];
-
- // make life easier for people using VC++ IDE: clicking on the message
- // will take us immediately to the place of the failed assert
- wxSnprintf(szBuf, WXSIZEOF(szBuf),
-#ifdef __VISUALC__
- wxT("%s(%d): assert failed"),
-#else // !VC++
- // make the error message more clear for all the others
- wxT("Assert failed in file %s at line %d"),
-#endif // VC/!VC
- szFile, nLine);
-
- if ( szMsg != NULL ) {
- wxStrcat(szBuf, wxT(": "));
- wxStrcat(szBuf, szMsg);
- }
- else {
- wxStrcat(szBuf, wxT("."));
- }
- if ( !s_bNoAsserts ) {
- // send it to the normal log destination
- wxLogDebug(szBuf);
-
-#if wxUSE_GUI || defined(__WXMSW__)
- // this message is intentionally not translated - it is for
- // developpers only
- wxStrcat(szBuf, wxT("\nDo you want to stop the program?"
- "\nYou can also choose [Cancel] to suppress "
- "further warnings."));
-
-#if wxUSE_GUI
- switch ( wxMessageBox(szBuf, "Debug",
- wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
- case wxYES:
- Trap();
- break;
-
- case wxCANCEL:
- s_bNoAsserts = TRUE;
- break;
-
- //case wxNO: nothing to do
- }
-#else // !GUI, but MSW
- switch ( ::MessageBox(NULL, szBuf, "Debug",
- MB_YESNOCANCEL | MB_ICONSTOP ) ) {
- case IDYES:
- Trap();
- break;
-
- case IDCANCEL:
- s_bNoAsserts = TRUE;
- break;
-
- //case IDNO: nothing to do
+ // copy it to our buffer and free memory
+ // 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] = wxS('\0');
+
+ LocalFree(lpMsgBuf);
+
+ // returned string is capitalized and ended with '\r\n' - bad
+ s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
+ size_t len = wxStrlen(s_szBuf);
+ if ( len > 0 ) {
+ // truncate string
+ if ( s_szBuf[len - 2] == wxS('\r') )
+ s_szBuf[len - 2] = wxS('\0');
}
-#endif // GUI or MSW
-
-#else // !GUI
- Trap();
-#endif // GUI/!GUI
+ }
+ else
+#endif // !__SMARTPHONE__
+ {
+ s_szBuf[0] = wxS('\0');
}
- s_bInAssert = FALSE;
+ return s_szBuf;
+#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 //WXDEBUG
-
+#endif // wxUSE_LOG
projects / wxWidgets.git / blobdiff