X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/47fe7ff3821c632b490b16da6b5113f127905a23..26d863e2b2f30612d0512a786fc01fe63c6b7bdf:/src/common/log.cpp diff --git a/src/common/log.cpp b/src/common/log.cpp index 89ed1264fc..c30b582075 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -42,7 +42,9 @@ #include "wx/msgout.h" #include "wx/textfile.h" #include "wx/thread.h" +#include "wx/private/threadinfo.h" #include "wx/crt.h" +#include "wx/vector.h" // other standard headers #ifndef __WXWINCE__ @@ -51,16 +53,69 @@ #include +#ifndef __WXPALMOS5__ #ifndef __WXWINCE__ #include #else #include "wx/msw/wince/time.h" #endif +#endif /* ! __WXPALMOS5__ */ #if defined(__WINDOWS__) #include "wx/msw/private.h" // includes windows.h #endif +#undef wxLOG_COMPONENT +const char *wxLOG_COMPONENT = ""; + +// this macro allows to define an object which will be initialized before any +// other function in this file is called: this is necessary to allow log +// functions to be used during static initialization (this is not advisable +// anyhow but we should at least try to not crash) and to also ensure that they +// are initialized by the time static initialization is done, i.e. before any +// threads are created hopefully +// +// the net effect of all this is that you can use Get##name() function to +// access the object without worrying about it being not initialized +// +// see also WX_DEFINE_GLOBAL_CONV2() in src/common/strconv.cpp +#define WX_DEFINE_GLOBAL_VAR(type, name) \ + inline type& Get##name() \ + { \ + static type s_##name; \ + return s_##name; \ + } \ + \ + type *gs_##name##Ptr = &Get##name() + +#if wxUSE_THREADS + +wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar; + +namespace +{ + +// contains messages logged by the other threads and waiting to be shown until +// Flush() is called in the main one +typedef wxVector wxLogRecords; +wxLogRecords gs_bufferedLogRecords; + +#define WX_DEFINE_LOG_CS(name) WX_DEFINE_GLOBAL_VAR(wxCriticalSection, name##CS) + +// this critical section is used for buffering the messages from threads other +// than main, i.e. it protects all accesses to gs_bufferedLogRecords above +WX_DEFINE_LOG_CS(BackgroundLog); + +// this one is used for protecting TraceMasks() from concurrent access +WX_DEFINE_LOG_CS(TraceMask); + +// and this one is used for GetComponentLevels() +WX_DEFINE_LOG_CS(Levels); + +} // anonymous namespace + +#endif // wxUSE_THREADS + // ---------------------------------------------------------------------------- // non member functions // ---------------------------------------------------------------------------- @@ -72,478 +127,367 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz); #endif -// ============================================================================ -// implementation -// ============================================================================ - // ---------------------------------------------------------------------------- -// implementation of Log functions -// -// NB: unfortunately we need all these distinct functions, we can't make them -// macros and not all compilers inline vararg functions. +// module globals // ---------------------------------------------------------------------------- -// generic log function -void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr) +namespace { - if ( wxLog::IsEnabled() ) { - wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL)); - } -} -#if !wxUSE_UTF8_LOCALE_ONLY -void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...) +// this struct is used to store information about the previous log message used +// by OnLog() to (optionally) avoid logging multiple copies of the same message +struct PreviousLogInfo { - va_list argptr; - va_start(argptr, format); - wxVLogGeneric(level, format, argptr); - va_end(argptr); -} -#endif // wxUSE_UTF8_LOCALE_ONLY + PreviousLogInfo() + { + numRepeated = 0; + } + + + // previous message itself + wxString msg; + + // its level + wxLogLevel level; + + // other information about it + wxLogRecordInfo info; -#if wxUSE_UNICODE_UTF8 -void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...) + // the number of times it was already repeated + unsigned numRepeated; +}; + +PreviousLogInfo gs_prevLog; + + +// map containing all components for which log level was explicitly set +// +// NB: all accesses to it must be protected by GetLevelsCS() critical section +WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels); + +// ---------------------------------------------------------------------------- +// wxLogOutputBest: wxLog wrapper around wxMessageOutputBest +// ---------------------------------------------------------------------------- + +class wxLogOutputBest : public wxLog { - 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 +public: + wxLogOutputBest() { } -#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 +protected: + virtual void DoLogText(const wxString& msg) + { + wxMessageOutputBest().Output(msg); + } + +private: + wxDECLARE_NO_COPY_CLASS(wxLogOutputBest); +}; -#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(Error) -IMPLEMENT_LOG_FUNCTION(Warning) -IMPLEMENT_LOG_FUNCTION(Message) -IMPLEMENT_LOG_FUNCTION(Info) -IMPLEMENT_LOG_FUNCTION(Status) +} // anonymous namespace + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// helper global functions +// ---------------------------------------------------------------------------- void wxSafeShowMessage(const wxString& title, const wxString& text) { #ifdef __WINDOWS__ - ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP); + ::MessageBox(NULL, text.t_str(), title.t_str(), MB_OK | MB_ICONSTOP); #else - wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str()); + 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) +// ---------------------------------------------------------------------------- +// wxLog class implementation +// ---------------------------------------------------------------------------- + +unsigned wxLog::LogLastRepeatIfNeeded() { - wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(format, argptr)); + const unsigned count = gs_prevLog.numRepeated; -#ifdef __WXWINCE__ - ExitThread(3); + if ( gs_prevLog.numRepeated ) + { + wxString msg; +#if wxUSE_INTL + msg.Printf(wxPLURAL("The previous message repeated once.", + "The previous message repeated %lu times.", + gs_prevLog.numRepeated), + gs_prevLog.numRepeated); #else - abort(); + msg.Printf(wxS("The previous message was repeated %lu times."), + gs_prevLog.numRepeated); #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); + gs_prevLog.numRepeated = 0; + gs_prevLog.msg.clear(); + DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info); + } - // some compilers warn about unreachable code and it shouldn't matter - // for the others anyhow... - //va_end(argptr); + return count; } -#endif // wxUSE_UNICODE_UTF8 -// same as info, but only if 'verbose' mode is on -void wxVLogVerbose(const wxString& format, va_list argptr) +wxLog::~wxLog() { - if ( wxLog::IsEnabled() ) { - if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) { - wxLog::OnLog(wxLOG_Info, - wxString::FormatV(format, argptr), time(NULL)); - } + // Flush() must be called before destroying the object as otherwise some + // messages could be lost + if ( gs_prevLog.numRepeated ) + { + wxMessageOutputDebug().Printf + ( + wxS("Last repeated message (\"%s\", %lu times) wasn't output"), + gs_prevLog.msg, + gs_prevLog.numRepeated + ); } } -#if !wxUSE_UTF8_LOCALE_ONLY -void wxDoLogVerboseWchar(const wxChar *format, ...) +// ---------------------------------------------------------------------------- +// wxLog logging functions +// ---------------------------------------------------------------------------- + +/* static */ +void +wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t) { - va_list argptr; - va_start(argptr, format); - wxVLogVerbose(format, argptr); - va_end(argptr); + wxLogRecordInfo info; + info.timestamp = t; +#if wxUSE_THREADS + info.threadId = wxThread::GetCurrentId(); +#endif // wxUSE_THREADS + + OnLog(level, msg, info); } -#endif // !wxUSE_UTF8_LOCALE_ONLY -#if wxUSE_UNICODE_UTF8 -void wxDoLogVerboseUtf8(const char *format, ...) +/* static */ +void +wxLog::OnLog(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - 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 + // fatal errors can't be suppressed nor handled by the custom log target + // and always terminate the program + if ( level == wxLOG_FatalError ) + { + wxSafeShowMessage(wxS("Fatal Error"), msg); -#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); \ - } +#ifdef __WXWINCE__ + ExitThread(3); #else - #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level) + abort(); #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 - -#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)); - } - } - -#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) + wxLog *logger; -// wxLogSysError: one uses the last error code, for other you must give it -// explicitly +#if wxUSE_THREADS + if ( !wxThread::IsMain() ) + { + logger = wxThreadInfo.logger; + if ( !logger ) + { + if ( ms_pLogger ) + { + // buffer the messages until they can be shown from the main + // thread + wxCriticalSectionLocker lock(GetBackgroundLogCS()); -// return the system error message description -static inline wxString wxLogSysErrorHelper(long err) -{ - return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); -} + gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info)); -void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr) -{ - wxVLogSysError(wxSysErrorCode(), format, argptr); -} + // ensure that our Flush() will be called soon + wxWakeUpIdle(); + } + //else: we don't have any logger at all, there is no need to log + // anything -#if !wxUSE_UTF8_LOCALE_ONLY -void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...) -{ - va_list argptr; - va_start(argptr, format); - wxVLogSysError(format, argptr); - va_end(argptr); -} -#endif // !wxUSE_UTF8_LOCALE_ONLY + return; + } + //else: we have a thread-specific logger, we can send messages to it + // directly + } + else +#endif // wxUSE_THREADS + { + logger = GetMainThreadActiveTarget(); + if ( !logger ) + return; + } -#if wxUSE_UNICODE_UTF8 -void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...) -{ - va_list argptr; - va_start(argptr, format); - wxVLogSysError(format, argptr); - va_end(argptr); + logger->CallDoLogNow(level, msg, info); } -#endif // wxUSE_UNICODE_UTF8 -void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr) +void +wxLog::CallDoLogNow(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - if ( wxLog::IsEnabled() ) { - wxLog::OnLog(wxLOG_Error, - wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err), - time(NULL)); - } -} + if ( GetRepetitionCounting() ) + { + if ( msg == gs_prevLog.msg ) + { + gs_prevLog.numRepeated++; -#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 + // nothing else to do, in particular, don't log the + // repeated message + return; + } -#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 + LogLastRepeatIfNeeded(); -#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); -} + // reset repetition counter for a new message + gs_prevLog.msg = msg; + gs_prevLog.level = level; + gs_prevLog.info = info; + } -void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_list argptr) - { wxVLogSysError((long)err, format, argptr); } -#endif // __WATCOMC__ + // handle extra data which may be passed to us by wxLogXXX() + wxString prefix, suffix; + wxUIntPtr num = 0; + if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) ) + { + const long err = static_cast(num); -// ---------------------------------------------------------------------------- -// wxLog class implementation -// ---------------------------------------------------------------------------- + suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); + } -/* static */ -unsigned wxLog::DoLogNumberOfRepeats() -{ - long retval = ms_prevCounter; - wxLog *pLogger = GetActiveTarget(); - if ( pLogger && ms_prevCounter > 0 ) +#if wxUSE_LOG_TRACE + wxString str; + if ( level == wxLOG_Trace && info.GetStrValue(wxLOG_KEY_TRACE_MASK, &str) ) { - 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, ms_prevTimeStamp); + prefix = "(" + str + ") "; } - return retval; +#endif // wxUSE_LOG_TRACE + + DoLogRecord(level, prefix + msg + suffix, info); } -wxLog::~wxLog() +void wxLog::DoLogRecord(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - if ( ms_prevCounter > 0 ) +#if WXWIN_COMPATIBILITY_2_8 + // call the old DoLog() to ensure that existing custom log classes still + // work + // + // as the user code could have defined it as either taking "const char *" + // (in ANSI build) or "const wxChar *" (in ANSI/Unicode), we have no choice + // but to call both of them + DoLog(level, (const char*)msg.mb_str(), info.timestamp); + DoLog(level, (const wchar_t*)msg.wc_str(), info.timestamp); +#else // !WXWIN_COMPATIBILITY_2_8 + wxUnusedVar(info); +#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8 + + + // TODO: it would be better to extract message formatting in a separate + // wxLogFormatter class but for now we hard code formatting here + + wxString prefix; + + // don't time stamp debug messages under MSW as debug viewers usually + // already have an option to do it +#ifdef __WXMSW__ + if ( level != wxLOG_Debug && level != wxLOG_Trace ) +#endif // __WXMSW__ + TimeStamp(&prefix); + + // TODO: use the other wxLogRecordInfo fields + + switch ( level ) { - // looks like the repeat count has not been logged yet, - // so let's do it now - wxLog::DoLogNumberOfRepeats(); + case wxLOG_Error: + prefix += _("Error: "); + break; + + case wxLOG_Warning: + prefix += _("Warning: "); + break; + + // don't prepend "debug/trace" prefix under MSW as it goes to the debug + // window anyhow and so can't be confused with something else +#ifndef __WXMSW__ + case wxLOG_Debug: + // this prefix (as well as the one below) is intentionally not + // translated as nobody translates debug messages anyhow + prefix += "Debug: "; + break; + + case wxLOG_Trace: + prefix += "Trace: "; + break; +#endif // !__WXMSW__ } + + DoLogTextAtLevel(level, prefix + msg); } -/* static */ -void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t) +void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg) { - if ( IsEnabled() && ms_logLevel >= level ) + // we know about debug messages (because using wxMessageOutputDebug is the + // right thing to do in 99% of all cases and also for compatibility) but + // anything else needs to be handled in the derived class + if ( level == wxLOG_Debug || level == wxLOG_Trace ) { - 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); - } - } + wxMessageOutputDebug().Output(msg + wxS('\n')); + } + else + { + DoLogText(msg); } } -// deprecated function -#if WXWIN_COMPATIBILITY_2_6 - -wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size)) +void wxLog::DoLogText(const wxString& WXUNUSED(msg)) { - return NULL; + // in 2.8-compatible build the derived class might override DoLog() or + // DoLogString() instead so we can't have this assert there +#if !WXWIN_COMPATIBILITY_2_8 + wxFAIL_MSG( "must be overridden if it is called" ); +#endif // WXWIN_COMPATIBILITY_2_8 } -#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 char *szString, time_t t) { + DoLogString(szString, t); } -void wxLog::DoLog(wxLogLevel WXUNUSED(level), - const wchar_t *WXUNUSED(wzString), - time_t WXUNUSED(t)) +void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t) { + DoLogString(wzString, t); } #endif // WXWIN_COMPATIBILITY_2_8 +// ---------------------------------------------------------------------------- +// wxLog active target management +// ---------------------------------------------------------------------------- + wxLog *wxLog::GetActiveTarget() +{ +#if wxUSE_THREADS + if ( !wxThread::IsMain() ) + { + // check if we have a thread-specific log target + wxLog * const logger = wxThreadInfo.logger; + + // the code below should be only executed for the main thread as + // CreateLogTarget() is not meant for auto-creating log targets for + // worker threads so skip it in any case + return logger ? logger : ms_pLogger; + } +#endif // wxUSE_THREADS + + return GetMainThreadActiveTarget(); +} + +/* static */ +wxLog *wxLog::GetMainThreadActiveTarget() { if ( ms_bAutoCreate && ms_pLogger == NULL ) { // prevent infinite recursion if someone calls wxLogXXX() from @@ -556,7 +500,7 @@ wxLog *wxLog::GetActiveTarget() if ( wxTheApp != NULL ) ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget(); else - ms_pLogger = new wxLogStderr; + ms_pLogger = new wxLogOutputBest; s_bInGetActiveTarget = false; @@ -581,6 +525,22 @@ wxLog *wxLog::SetActiveTarget(wxLog *pLogger) return pOldLogger; } +#if wxUSE_THREADS +/* static */ +wxLog *wxLog::SetThreadActiveTarget(wxLog *logger) +{ + wxASSERT_MSG( !wxThread::IsMain(), "use SetActiveTarget() for main thread" ); + + wxLog * const oldLogger = wxThreadInfo.logger; + if ( oldLogger ) + oldLogger->Flush(); + + wxThreadInfo.logger = logger; + + return oldLogger; +} +#endif // wxUSE_THREADS + void wxLog::DontCreateOnDemand() { ms_bAutoCreate = false; @@ -596,116 +556,195 @@ void wxLog::DoCreateOnDemand() ms_bAutoCreate = true; } +// ---------------------------------------------------------------------------- +// wxLog components levels +// ---------------------------------------------------------------------------- + +/* static */ +void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level) +{ + if ( component.empty() ) + { + SetLogLevel(level); + } + else + { + wxCRIT_SECT_LOCKER(lock, GetLevelsCS()); + + GetComponentLevels()[component] = level; + } +} + +/* static */ +wxLogLevel wxLog::GetComponentLevel(wxString component) +{ + wxCRIT_SECT_LOCKER(lock, GetLevelsCS()); + + const wxStringToNumHashMap& componentLevels = GetComponentLevels(); + while ( !component.empty() ) + { + wxStringToNumHashMap::const_iterator + it = componentLevels.find(component); + if ( it != componentLevels.end() ) + return static_cast(it->second); + + component = component.BeforeLast('/'); + } + + return GetLogLevel(); +} + +// ---------------------------------------------------------------------------- +// wxLog trace masks +// ---------------------------------------------------------------------------- + +namespace +{ + +// because IsAllowedTraceMask() may be called during static initialization +// (this is not recommended but it may still happen, see #11592) we can't use a +// simple static variable which might be not initialized itself just yet to +// store the trace masks, but need this accessor function which will ensure +// that the variable is always correctly initialized before being accessed +// +// notice that this doesn't make accessing it MT-safe, of course, you need to +// serialize accesses to it using GetTraceMaskCS() for this +wxArrayString& TraceMasks() +{ + static wxArrayString s_traceMasks; + + return s_traceMasks; +} + +} // anonymous namespace + +/* static */ const wxArrayString& wxLog::GetTraceMasks() +{ + // because of this function signature (it returns a reference, not the + // object), it is inherently MT-unsafe so there is no need to acquire the + // lock here anyhow + + return TraceMasks(); +} + +void wxLog::AddTraceMask(const wxString& str) +{ + wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); + + TraceMasks().push_back(str); +} + void wxLog::RemoveTraceMask(const wxString& str) { - int index = ms_aTraceMasks.Index(str); + wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); + + int index = TraceMasks().Index(str); if ( index != wxNOT_FOUND ) - ms_aTraceMasks.RemoveAt((size_t)index); + TraceMasks().RemoveAt((size_t)index); } void wxLog::ClearTraceMasks() { - ms_aTraceMasks.Clear(); + wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); + + TraceMasks().Clear(); } +/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask) +{ + wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); + + const wxArrayString& masks = GetTraceMasks(); + for ( wxArrayString::const_iterator it = masks.begin(), + en = masks.end(); + it != en; + ++it ) + { + if ( *it == mask) + return true; + } + + return false; +} + +// ---------------------------------------------------------------------------- +// wxLog miscellaneous other methods +// ---------------------------------------------------------------------------- + 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(": "); + *str = wxDateTime::UNow().Format(ms_timestamp); + *str += wxS(": "); } #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 +#if wxUSE_THREADS - 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; +void wxLog::FlushThreadMessages() +{ + // check if we have queued messages from other threads + wxLogRecords bufferedLogRecords; - case wxLOG_Warning: - LogString(_("Warning: ") + szString, t); - break; + { + wxCriticalSectionLocker lock(GetBackgroundLogCS()); + bufferedLogRecords.swap(gs_bufferedLogRecords); - case wxLOG_Info: - if ( GetVerbose() ) - case wxLOG_Message: - case wxLOG_Status: - default: // log unknown log levels too - LogString(szString, t); - break; + // release the lock now to not keep it while we are logging the + // messages below, allowing background threads to run + } - 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; + if ( !bufferedLogRecords.empty() ) + { + for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin(); + it != bufferedLogRecords.end(); + ++it ) + { + CallDoLogNow(it->level, it->msg, it->info); + } } } -void wxLog::DoLogString(const wxString& szString, time_t t) +/* static */ +bool wxLog::IsThreadLoggingEnabled() { -#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 + return !wxThreadInfo.loggingDisabled; } +/* static */ +bool wxLog::EnableThreadLogging(bool enable) +{ + const bool wasEnabled = !wxThreadInfo.loggingDisabled; + wxThreadInfo.loggingDisabled = !enable; + return wasEnabled; +} + +#endif // wxUSE_THREADS + void wxLog::Flush() { - // nothing to do here + LogLastRepeatIfNeeded(); } -/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask) +/* static */ +void wxLog::FlushActive() { - for ( wxArrayString::iterator it = ms_aTraceMasks.begin(), - en = ms_aTraceMasks.end(); - it != en; ++it ) - if ( *it == mask) - return true; - return false; + if ( ms_suspendCount ) + return; + + wxLog * const log = GetActiveTarget(); + if ( log ) + { +#if wxUSE_THREADS + if ( wxThread::IsMain() ) + log->FlushThreadMessages(); +#endif // wxUSE_THREADS + + log->Flush(); + } } // ---------------------------------------------------------------------------- @@ -714,44 +753,32 @@ void wxLog::Flush() void wxLogBuffer::Flush() { + wxLog::Flush(); + if ( !m_str.empty() ) { wxMessageOutputBest out; - out.Printf(_T("%s"), m_str.c_str()); + out.Printf(wxS("%s"), m_str.c_str()); m_str.clear(); } } -void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t) +void wxLogBuffer::DoLogTextAtLevel(wxLogLevel level, const wxString& msg) { + // 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 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__ + case wxLOG_Trace: + wxLog::DoLogTextAtLevel(level, msg); break; default: - wxLog::DoLog(level, szString, t); + m_str << msg << wxS("\n"); } } -void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t)) -{ - m_str << szString << _T("\n"); -} - // ---------------------------------------------------------------------------- // wxLogStderr class implementation // ---------------------------------------------------------------------------- @@ -764,14 +791,9 @@ wxLogStderr::wxLogStderr(FILE *fp) m_fp = fp; } -void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t)) +void wxLogStderr::DoLogText(const wxString& msg) { - wxString str; - TimeStamp(&str); - str << szString; - - wxFputs(str, m_fp); - wxFputc(_T('\n'), m_fp); + wxFputs(msg + '\n', m_fp); fflush(m_fp); // under GUI systems such as Windows or Mac, programs usually don't have @@ -783,8 +805,7 @@ void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t)) wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; if ( traits && !traits->HasStderr() ) { - wxMessageOutputDebug dbgout; - dbgout.Printf(_T("%s\n"), str.c_str()); + wxMessageOutputDebug().Output(msg + wxS('\n')); } } } @@ -803,11 +824,9 @@ wxLogStream::wxLogStream(wxSTD ostream *ostr) m_ostr = ostr; } -void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t)) +void wxLogStream::DoLogText(const wxString& msg) { - wxString stamp; - TimeStamp(&stamp); - (*m_ostr) << stamp << szString << wxSTD endl; + (*m_ostr) << msg << wxSTD endl; } #endif // wxUSE_STD_IOSTREAM @@ -825,7 +844,7 @@ wxLogChain::wxLogChain(wxLog *logger) wxLogChain::~wxLogChain() { - delete m_logOld; + wxLog::SetActiveTarget(m_logOld); if ( m_logNew != this ) delete m_logNew; @@ -849,19 +868,23 @@ void wxLogChain::Flush() m_logNew->Flush(); } -void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t) +void wxLogChain::DoLogRecord(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { // let the previous logger show it if ( m_logOld && IsPassingMessages() ) - { - // bogus cast just to access protected DoLog - ((wxLogChain *)m_logOld)->DoLog(level, szString, t); - } + m_logOld->LogRecord(level, msg, info); - if ( m_logNew && m_logNew != this ) + // and also send it to the new one + if ( m_logNew ) { - // as above... - ((wxLogChain *)m_logNew)->DoLog(level, szString, t); + // don't call m_logNew->LogRecord() to avoid infinite recursion when + // m_logNew is this object itself + if ( m_logNew != this ) + m_logNew->LogRecord(level, msg, info); + else + wxLog::DoLogRecord(level, msg, info); } } @@ -886,7 +909,7 @@ wxLogInterposer::wxLogInterposer() wxLogInterposerTemp::wxLogInterposerTemp() : wxLogChain(this) { - DetachOldLog(); + DetachOldLog(); } #ifdef __VISUALC__ @@ -902,12 +925,8 @@ wxLogInterposerTemp::wxLogInterposerTemp() // ---------------------------------------------------------------------------- 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; +wxLog *wxLog::ms_pLogger = NULL; bool wxLog::ms_doLog = true; bool wxLog::ms_bAutoCreate = true; bool wxLog::ms_bVerbose = false; @@ -916,10 +935,11 @@ wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by defaul size_t wxLog::ms_suspendCount = 0; -wxString wxLog::ms_timestamp(wxT("%X")); // time only, no date +wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date +#if WXWIN_COMPATIBILITY_2_8 wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; -wxArrayString wxLog::ms_aTraceMasks; +#endif // wxDEBUG_LEVEL // ---------------------------------------------------------------------------- // stdout error logging helper @@ -996,7 +1016,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) { // if this happens, something is seriously wrong, so don't use _() here // for safety - wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode); + wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode); return s_szBuf; } @@ -1006,8 +1026,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) #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'); + wxStrlcpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf)); LocalFree(lpMsgBuf); @@ -1016,14 +1035,14 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) size_t len = wxStrlen(s_szBuf); if ( len > 0 ) { // truncate string - if ( s_szBuf[len - 2] == wxT('\r') ) - s_szBuf[len - 2] = wxT('\0'); + if ( s_szBuf[len - 2] == wxS('\r') ) + s_szBuf[len - 2] = wxS('\0'); } } else #endif // !__SMARTPHONE__ { - s_szBuf[0] = wxT('\0'); + s_szBuf[0] = wxS('\0'); } return s_szBuf;