X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..850df2d78866c3edcf848103b5dbc7e7fa1ee5fa:/src/common/log.cpp?ds=inline diff --git a/src/common/log.cpp b/src/common/log.cpp index 27f5f20ce1..c2a69b6714 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -16,40 +16,50 @@ // ---------------------------------------------------------------------------- // 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 -#ifndef WX_PRECOMP - #include - #include - #include -#endif +#if wxUSE_LOG -#include -#include +// 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/msgout.h" +#include "wx/textfile.h" +#include "wx/thread.h" +#include "wx/crt.h" // other standard headers -#include -#include -#include +#ifndef __WXWINCE__ +#include +#endif -// C++ headers -#include +#include -// _WINDOWS_ is defined when windows.h is included, -// __WINDOWS__ is defined for MS Windows compilation -#if defined(__WINDOWS__) && !defined(_WINDOWS_) -#include -#endif //windows.h +#ifndef __WXWINCE__ +#include +#else +#include "wx/msw/wince/time.h" +#endif + +#if defined(__WINDOWS__) + #include "wx/msw/private.h" // includes windows.h +#endif // ---------------------------------------------------------------------------- // non member functions @@ -58,7 +68,7 @@ // define this to enable wrapping of log messages //#define LOG_PRETTY_WRAP -#ifdef LOG_PRETTY_WRAP +#ifdef LOG_PRETTY_WRAP static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz); #endif @@ -73,379 +83,820 @@ // macros and not all compilers inline vararg functions. // ---------------------------------------------------------------------------- -// 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) +// generic log function +void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr) +{ + if ( wxLog::IsEnabled() ) { + wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL)); + } +} -// static buffer for error messages (@@@ MT-unsafe) -static char s_szBuf[LOG_BUFFER_SIZE]; +#if !wxUSE_UTF8_LOCALE_ONLY +void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...) +{ + va_list argptr; + va_start(argptr, format); + wxVLogGeneric(level, format, argptr); + va_end(argptr); +} +#endif // wxUSE_UTF8_LOCALE_ONLY -// generic log function -void wxLogGeneric(wxLog::Level level, wxTString strFormat, ...) -{ - if ( wxLog::GetActiveTarget() != NULL ) { - va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); - va_end(argptr); - - wxLog::OnLog(level, s_szBuf); - } -} - -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(wxTString strFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, strFormat); \ - vsprintf(s_szBuf, strFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLog::level, s_szBuf); \ - } \ - } +#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 + +#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) -// debug functions don't use wxTString -#undef IMPLEMENT_LOG_FUNCTION -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(const char *szFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - vsprintf(s_szBuf, szFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLog::level, s_szBuf); \ - } \ - } +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, _T("%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(_T("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); -IMPLEMENT_LOG_FUNCTION(Debug) -IMPLEMENT_LOG_FUNCTION(Trace) + // some compilers warn about unreachable code and it shouldn't matter + // for the others anyhow... + //va_end(argptr); +} +#endif // wxUSE_UNICODE_UTF8 -void wxLogVerbose(wxTString strFormat, ...) -{ - if ( wxLog::GetVerbose() && wxLog::GetActiveTarget() != NULL ) { - va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); - va_end(argptr); - - wxLog::OnLog(wxLog::Info, s_szBuf); - } +// same as info, but only if 'verbose' mode is on +void wxVLogVerbose(const wxString& format, va_list argptr) +{ + if ( wxLog::IsEnabled() ) { + if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) { + wxLog::OnLog(wxLOG_Info, + wxString::FormatV(format, argptr), time(NULL)); + } + } } - -void wxLogSysError(wxTString str, ...) + +#if !wxUSE_UTF8_LOCALE_ONLY +void wxDoLogVerboseWchar(const wxChar *format, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { va_list argptr; - va_start(argptr, str); - vsprintf(s_szBuf, str, argptr); + va_start(argptr, format); + wxVLogVerbose(format, argptr); + va_end(argptr); +} +#endif // !wxUSE_UTF8_LOCALE_ONLY + +#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__ + +#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) + { + if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) { + wxString msg; + msg << _T("(") << mask << _T(") ") << wxString::FormatV(format, argptr); + + wxLog::OnLog(wxLOG_Trace, msg, time(NULL)); + } + } + +#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 - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), wxSysErrorCode(), wxSysErrorMsg()); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); +#if wxUSE_UNICODE_UTF8 + void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...) + { + 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 ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) { + wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL)); + } + } - wxLog::OnLog(wxLog::Error, s_szBuf); +#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 + +#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 + +IMPLEMENT_LOG_DEBUG_FUNCTION(Debug) +IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) + +// wxLogSysError: one uses the last error code, for other you must give it +// explicitly + +// return the system error message description +static inline wxString wxLogSysErrorHelper(long err) +{ + return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); } -void WXDLLEXPORT wxLogSysError(long lErrCode, wxTString strFormat, ...) +void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr) +{ + wxVLogSysError(wxSysErrorCode(), format, argptr); +} + +#if !wxUSE_UTF8_LOCALE_ONLY +void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); + va_start(argptr, format); + wxVLogSysError(format, argptr); va_end(argptr); +} +#endif // !wxUSE_UTF8_LOCALE_ONLY - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); +#if wxUSE_UNICODE_UTF8 +void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...) +{ + va_list argptr; + va_start(argptr, format); + wxVLogSysError(format, argptr); + va_end(argptr); +} +#endif // wxUSE_UNICODE_UTF8 - wxLog::OnLog(wxLog::Error, s_szBuf); - } +void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr) +{ + if ( wxLog::IsEnabled() ) { + wxLog::OnLog(wxLOG_Error, + wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err), + time(NULL)); + } +} + +#if !wxUSE_UTF8_LOCALE_ONLY +void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...) +{ + va_list argptr; + va_start(argptr, format); + wxVLogSysError(lErrCode, format, argptr); + va_end(argptr); } +#endif // !wxUSE_UTF8_LOCALE_ONLY + +#if wxUSE_UNICODE_UTF8 +void WXDLLEXPORT wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...) +{ + va_list argptr; + va_start(argptr, format); + wxVLogSysError(lErrCode, format, argptr); + va_end(argptr); +} +#endif // wxUSE_UNICODE_UTF8 + +#ifdef __WATCOMC__ +// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351 +void WXDLLEXPORT wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...) +{ + va_list argptr; + va_start(argptr, format); + wxVLogSysError(lErrCode, format, argptr); + va_end(argptr); +} + +void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_list argptr) + { wxVLogSysError((long)err, format, argptr); } +#endif // __WATCOMC__ // ---------------------------------------------------------------------------- // wxLog class implementation // ---------------------------------------------------------------------------- -wxLog::wxLog() +unsigned wxLog::LogLastRepetitionCountIfNeeded() { - m_bHasMessages = FALSE; + wxCRIT_SECT_LOCKER(lock, ms_prevCS); + + 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(wxT("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::GetActiveTarget() -{ - if ( !ms_bInitialized ) { - // prevent infinite recursion if someone calls wxLogXXX() from wxApp - ms_bInitialized = TRUE; +wxLog::~wxLog() +{ + LogLastRepetitionCountIfNeeded(); +} - // ask the application to create a log target for us if it exists - if ( wxTheApp != NULL ) - ms_pLogger = wxTheApp->CreateLogTarget(); - else - ms_pLogger = new wxLogStderr; +/* 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, ms_prevCS); + + if ( szString == ms_prevString ) + { + ms_prevCounter++; + + // nothing else to do, in particular, don't log the + // repeated message + return; + } + + pLogger->LogLastRepetitionCountIfNeeded(); + + // reset repetition counter for a new message + ms_prevString = szString; + ms_prevLevel = level; + ms_prevTimeStamp = t; + } + + pLogger->DoLog(level, szString, t); + } + } +} - // do nothing if it fails - what can we do? - } +// deprecated function +#if WXWIN_COMPATIBILITY_2_6 + +wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size)) +{ + return NULL; +} + +#endif // WXWIN_COMPATIBILITY_2_6 - return ms_pLogger; +#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; + if ( !s_bInGetActiveTarget ) { + s_bInGetActiveTarget = true; + + // ask the application to create a log target for us + if ( wxTheApp != NULL ) + ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget(); + else + ms_pLogger = new wxLogStderr; + + s_bInGetActiveTarget = false; + + // do nothing if it fails - what can we do? + } + } + + return ms_pLogger; } wxLog *wxLog::SetActiveTarget(wxLog *pLogger) -{ - // flush the old messages before changing - if ( ms_pLogger != NULL ) - ms_pLogger->Flush(); - - ms_bInitialized = TRUE; - - wxLog *pOldLogger = ms_pLogger; - ms_pLogger = pLogger; - return pOldLogger; -} - -void wxLog::DoLog(Level level, const char *szString) -{ - char szBuf[128]; - time_t timeNow; - struct tm *ptmNow; - - time(&timeNow); - ptmNow = localtime(&timeNow); - - strftime(szBuf, WXSIZEOF(szBuf), ms_szTimeFormat, ptmNow); - wxString str = szBuf; - - switch ( level ) { - case FatalError: - DoLogString(str << _("Fatal error: ") << szString); - DoLogString(_("Program aborted.")); - Flush(); - abort(); - break; - - case Error: - DoLogString(str << _("Error: ") << szString); - break; - - case Warning: - DoLogString(str << _("Warning: ") << szString); - break; - - case Info: - if ( GetVerbose() ) - case Message: - DoLogString(str + szString); - // fall through - - case Status: - // nothing to do - break; - - case Trace: - case Debug: - #ifdef __DEBUG__ - #ifdef __WIN32__ - // in addition to normal logging, also send the string to debugger - // (don't prepend "Debug" here: it will go to debug window anyhow) - ::OutputDebugString(str + szString + "\n\r"); - #endif //Win32 - DoLogString(str << (level == Trace ? _("Trace") : _("Debug")) - << ": " << szString); - #endif - - break; - - default: - wxFAIL_MSG("unknown log level in wxLog::DoLog"); - } +{ + if ( ms_pLogger != NULL ) { + // flush the old messages before changing because otherwise they might + // get lost later if this target is not restored + ms_pLogger->Flush(); + } + + wxLog *pOldLogger = ms_pLogger; + ms_pLogger = pLogger; + + 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::DoLogString(const char *WXUNUSED(szString)) +void wxLog::DoCreateOnDemand() { - wxFAIL_MSG("DoLogString must be overrided if it's called."); + ms_bAutoCreate = true; +} + +void wxLog::RemoveTraceMask(const wxString& str) +{ + int index = ms_aTraceMasks.Index(str); + if ( index != wxNOT_FOUND ) + ms_aTraceMasks.RemoveAt((size_t)index); +} + +void wxLog::ClearTraceMasks() +{ + ms_aTraceMasks.Clear(); +} + +void wxLog::TimeStamp(wxString *str) +{ +#if wxUSE_DATETIME + if ( !ms_timestamp.empty() ) + { + wxChar buf[256]; + time_t timeNow; + (void)time(&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 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: + LogString(_("Fatal error: ") + szString, t); + LogString(_("Program aborted."), t); + Flush(); +#ifdef __WXWINCE__ + ExitThread(3); +#else + abort(); +#endif + break; + + case wxLOG_Error: + LogString(_("Error: ") + szString, t); + break; + + case wxLOG_Warning: + LogString(_("Warning: ") + szString, t); + break; + + case wxLOG_Info: + if ( GetVerbose() ) + case wxLOG_Message: + case wxLOG_Status: + default: // log unknown log levels too + LogString(szString, t); + break; + + case wxLOG_Trace: + case wxLOG_Debug: +#ifdef __WXDEBUG__ + { + wxString msg = level == wxLOG_Trace ? wxT("Trace: ") + : wxT("Debug: "); + msg << szString; + LogString(msg, t); + } +#endif // Debug + break; + } +} + +void wxLog::DoLogString(const wxString& szString, time_t t) +{ +#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(wxT("DoLogString must be overriden if it's called.")); + wxUnusedVar(szString); + wxUnusedVar(t); +#endif } void wxLog::Flush() { - // do nothing + // nothing to do here +} + +/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask) +{ + for ( wxArrayString::iterator it = ms_aTraceMasks.begin(), + en = ms_aTraceMasks.end(); + it != en; ++it ) + if ( *it == mask) + return true; + return false; } // ---------------------------------------------------------------------------- -// wxLogStderr class implementation +// wxLogBuffer implementation // ---------------------------------------------------------------------------- -wxLogStderr::wxLogStderr(FILE *fp) +void wxLogBuffer::Flush() { - if ( fp == NULL ) - m_fp = stderr; - else - m_fp = fp; + if ( !m_str.empty() ) + { + wxMessageOutputBest out; + out.Printf(_T("%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(_T("%s\n"), str.c_str()); + } +#endif // __WXDEBUG__ + break; + + default: + wxLog::DoLog(level, szString, t); + } } -void wxLogStderr::DoLogString(const char *szString) +void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t)) { - fputs(szString, m_fp); - fputc('\n', m_fp); - fflush(m_fp); + m_str << szString << _T("\n"); } // ---------------------------------------------------------------------------- -// wxLogStream implementation +// wxLogStderr class implementation // ---------------------------------------------------------------------------- -wxLogStream::wxLogStream(ostream *ostr) +wxLogStderr::wxLogStderr(FILE *fp) { - if ( ostr == NULL ) - m_ostr = &cerr; - else - m_ostr = ostr; + if ( fp == NULL ) + m_fp = stderr; + else + m_fp = fp; } -void wxLogStream::DoLogString(const char *szString) +void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t)) { - (*m_ostr) << szString << endl << flush; + wxString str; + TimeStamp(&str); + str << szString; + + 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 + // 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(_T("%s\n"), str.c_str()); + } + } } // ---------------------------------------------------------------------------- -// wxLogTextCtrl implementation +// wxLogStream implementation // ---------------------------------------------------------------------------- -/* -wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl) - : wxLogStream(new ostream(pTextCtrl)) +#if wxUSE_STD_IOSTREAM +#include "wx/ioswrap.h" +wxLogStream::wxLogStream(wxSTD ostream *ostr) { + if ( ostr == NULL ) + m_ostr = &wxSTD cerr; + else + m_ostr = ostr; } -wxLogTextCtrl::~wxLogTextCtrl() +void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t)) { - delete m_ostr; + wxString stamp; + TimeStamp(&stamp); + (*m_ostr) << stamp << szString << wxSTD endl; } -*/ +#endif // wxUSE_STD_IOSTREAM // ---------------------------------------------------------------------------- -// wxLogGui implementation +// wxLogChain // ---------------------------------------------------------------------------- -#ifndef WX_TEST_MINIMAL - -wxLogGui::wxLogGui() +wxLogChain::wxLogChain(wxLog *logger) { - m_bErrors = FALSE; + m_bPassMessages = true; + + m_logNew = logger; + m_logOld = wxLog::SetActiveTarget(this); } -void wxLogGui::Flush() +wxLogChain::~wxLogChain() { - if ( !m_bHasMessages ) - return; + delete m_logOld; - // @@@ ugly... - - // concatenate all strings (but not too many to not overfill the msg box) - wxString str; - uint nLines = 0, - nMsgCount = m_aMessages.Count(); + if ( m_logNew != this ) + delete m_logNew; +} - // start from the most recent message - for ( uint n = nMsgCount; n > 0; n-- ) { - // for Windows strings longer than this value are wrapped (NT 4.0) - const uint nMsgLineWidth = 156; +void wxLogChain::SetLog(wxLog *logger) +{ + if ( m_logNew != this ) + delete m_logNew; - nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth; + m_logNew = logger; +} - if ( nLines > 25 ) // don't put too many lines in message box - break; +void wxLogChain::Flush() +{ + if ( m_logOld ) + m_logOld->Flush(); - str << m_aMessages[n - 1] << "\n"; - } + // be careful to avoid infinite recursion + if ( m_logNew && m_logNew != this ) + m_logNew->Flush(); +} - if ( m_bErrors ) { - wxMessageBox(str, _("Error"), wxOK | wxICON_EXCLAMATION); - } - else { - wxMessageBox(str, _("Information"), wxOK | wxICON_INFORMATION); - } +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); + } - // no undisplayed messages whatsoever - m_bHasMessages = - m_bErrors = FALSE; - m_aMessages.Empty(); + if ( m_logNew && m_logNew != this ) + { + // as above... + ((wxLogChain *)m_logNew)->DoLog(level, szString, t); + } } -// the default behaviour is to discard all informational messages if there -// are any errors/warnings. -void wxLogGui::DoLog(Level level, const char *szString) +#ifdef __VISUALC__ + // "'this' : used in base member initializer list" - so what? + #pragma warning(disable:4355) +#endif // VC++ + +// ---------------------------------------------------------------------------- +// wxLogInterposer +// ---------------------------------------------------------------------------- + +wxLogInterposer::wxLogInterposer() + : wxLogChain(this) { - switch ( level ) { - case Info: - if ( GetVerbose() ) - case Message: - if ( !m_bErrors ) { - m_aMessages.Add(szString); - m_bHasMessages = TRUE; - } - break; - - case Status: - { - // find the top window and set it's status text if it has any - wxWindow *pWin = wxTheApp->GetTopWindow(); - if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) { - wxFrame *pFrame = (wxFrame *)pWin; - pFrame->SetStatusText(szString); - } - } - break; - - case Trace: - case Debug: - #ifdef __DEBUG__ - #ifdef __WIN32__ - OutputDebugString(szString); - OutputDebugString("\n\r"); - #else //!WIN32 - // send them to stderr - printf(stderr, level == Trace ? "Trace: %s\n" - : "Debug: %s\n", szString); - fflush(stderr); - #endif // WIN32 - #endif - break; - - case FatalError: - // show this one immediately - wxMessageBox(szString, "Fatal error", wxICON_HAND); - break; - - case Error: - case Warning: - // discard earlier informational messages if this is the 1st error - if ( !m_bErrors ) { - m_aMessages.Empty(); - m_bHasMessages = TRUE; - m_bErrors = TRUE; - } +} - m_aMessages.Add(szString); - break; - - default: - wxFAIL_MSG("unknown log level in wxLogGui::DoLog"); - } +// ---------------------------------------------------------------------------- +// wxLogInterposerTemp +// ---------------------------------------------------------------------------- + +wxLogInterposerTemp::wxLogInterposerTemp() + : wxLogChain(this) +{ + DetachOldLog(); } -#endif //WX_TEST_MINIMAL +#ifdef __VISUALC__ + #pragma warning(default:4355) +#endif // VC++ // ============================================================================ // Global functions/variables @@ -454,10 +905,29 @@ void wxLogGui::DoLog(Level level, const char *szString) // ---------------------------------------------------------------------------- // static variables // ---------------------------------------------------------------------------- -wxLog *wxLog::ms_pLogger = NULL; -bool wxLog::ms_bInitialized = FALSE; -bool wxLog::ms_bVerbose = FALSE; -const char *wxLog::ms_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; + +#if wxUSE_THREADS +wxCriticalSection wxLog::ms_prevCS; +#endif // wxUSE_THREADS +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; + +wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default + +size_t wxLog::ms_suspendCount = 0; + +wxString wxLog::ms_timestamp(wxT("%X")); // time only, no date + +wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; +wxArrayString wxLog::ms_aTraceMasks; // ---------------------------------------------------------------------------- // stdout error logging helper @@ -466,34 +936,33 @@ const char *wxLog::ms_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; // helper function: wraps the message and justifies it under given position // (looks more pretty on the terminal). Also adds newline at the end. // -// @@ this is now disabled until I find a portable way of determining the -// terminal window size - -#ifdef LOG_PRETTY_WRAP +// TODO this is now disabled until I find a portable way of determining the +// terminal window size (ok, I found it but does anybody really cares?) +#ifdef LOG_PRETTY_WRAP static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) { - size_t nMax = 80; // @@@@ - size_t nStart = strlen(pszPrefix); - fputs(pszPrefix, f); - - size_t n; - while ( *psz != '\0' ) { - for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ ) - putc(*psz++, f); - - // wrapped? - if ( *psz != '\0' ) { - /*putc('\n', f);*/ - for ( n = 0; n < nStart; n++ ) - putc(' ', f); - - // as we wrapped, squeeze all white space - while ( isspace(*psz) ) - psz++; + size_t nMax = 80; // FIXME + size_t nStart = strlen(pszPrefix); + fputs(pszPrefix, f); + + size_t n; + while ( *psz != '\0' ) { + for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ ) + putc(*psz++, f); + + // wrapped? + if ( *psz != '\0' ) { + /*putc('\n', f);*/ + for ( n = 0; n < nStart; n++ ) + putc(' ', f); + + // as we wrapped, squeeze all white space + while ( isspace(*psz) ) + psz++; + } } - } - putc('\n', f); + putc('\n', f); } #endif //LOG_PRETTY_WRAP @@ -504,108 +973,78 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) // get error code from syste unsigned long wxSysErrorCode() { - #ifdef __WINDOWS__ - #ifdef __WIN32__ - return ::GetLastError(); - #else //WIN16 - // @@@@ what to do on Windows 3.1? - return 0; - #endif //WIN16/32 - #else //Unix +#if defined(__WXMSW__) && !defined(__WXMICROWIN__) + return ::GetLastError(); +#else //Unix return errno; - #endif //Win/Unix +#endif //Win/Unix } // get error message from system -const char *wxSysErrorMsg(unsigned long nErrCode) -{ - if ( nErrCode == 0 ) - nErrCode = wxSysErrorCode(); - -#ifdef __WINDOWS__ -#ifdef __WIN32__ - static char s_szBuf[LOG_BUFFER_SIZE / 2]; - - // get error message from system - LPVOID lpMsgBuf; - 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 - strncpy(s_szBuf, (const char *)lpMsgBuf, SIZEOF(s_szBuf) - 1); - s_szBuf[SIZEOF(s_szBuf) - 1] = '\0'; - LocalFree(lpMsgBuf); - - // returned string is capitalized and ended with '\r\n' - bad - s_szBuf[0] = (char)tolower(s_szBuf[0]); - size_t len = strlen(s_szBuf); - if ( len > 0 ) { - // truncate string - if ( s_szBuf[len - 2] == '\r' ) - s_szBuf[len - 2] = '\0'; - } - - return s_szBuf; -#else - // TODO: Windows 3.1 - return NULL; -#endif -#else - return strerror(nErrCode); -#endif -} - -// ---------------------------------------------------------------------------- -// debug helper -// ---------------------------------------------------------------------------- - -#ifdef __DEBUG__ - -// this function is called when an assert fails -void wxOnAssert(const char *szFile, int nLine, const char *szMsg) +const wxChar *wxSysErrorMsg(unsigned long nErrCode) { - // this variable can be set to true to suppress "assert failure" messages - static s_bNoAsserts = FALSE; - - char szBuf[LOG_BUFFER_SIZE]; - sprintf(szBuf, _("Assert failed in file %s at line %d"), szFile, nLine); - if ( szMsg != NULL ) { - strcat(szBuf, ": "); - strcat(szBuf, szMsg); - } - else { - strcat(szBuf, "."); - } + if ( nErrCode == 0 ) + nErrCode = wxSysErrorCode(); + +#if defined(__WXMSW__) && !defined(__WXMICROWIN__) + static wxChar s_szBuf[1024]; + + // get error message from system + LPVOID lpMsgBuf; + if ( ::FormatMessage + ( + FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, + NULL, + nErrCode, + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPTSTR)&lpMsgBuf, + 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; + } - // send it to the normal log destination - wxLogDebug(szBuf); - #ifdef __WINDOWS__ - if ( !s_bNoAsserts ) { - strcat(szBuf, _("\nDo you want to stop the program?" - "\nYou can also choose [Cancel] to suppress " - "further warnings.")); + // 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] = wxT('\0'); - switch ( ::MessageBox(NULL, szBuf, _("Debug"), - MB_YESNOCANCEL | MB_ICONINFORMATION) ) { - case IDYES: - DebugBreak(); - break; + LocalFree(lpMsgBuf); - case IDCANCEL: - s_bNoAsserts = TRUE; - break; - } + // 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'); + } + } + else +#endif // !__SMARTPHONE__ + { + s_szBuf[0] = wxT('\0'); } - #else - // @@@@ don't know how to start the debugger under generic Unix - s_bNoAsserts = TRUE; // suppress 'unused var' warning - abort(); - #endif -} -#endif //DEBUG + 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 // wxUSE_LOG