X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b765da9f5090ef076302eb0d12cfc11b61296430..538a2cfaf2be9f864e58c9a9fe232966af6bf2a0:/src/common/log.cpp diff --git a/src/common/log.cpp b/src/common/log.cpp index d9a6c7eb30..53ce213b50 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: log.cpp +// Name: src/common/log.cpp // Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs) // Author: Vadim Zeitlin // Modified by: @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "log.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -32,20 +28,23 @@ // wxWidgets #ifndef WX_PRECOMP + #include "wx/log.h" #include "wx/app.h" #include "wx/arrstr.h" #include "wx/intl.h" #include "wx/string.h" + #include "wx/utils.h" #endif //WX_PRECOMP #include "wx/apptrait.h" +#include "wx/datetime.h" #include "wx/file.h" -#include "wx/log.h" #include "wx/msgout.h" #include "wx/textfile.h" #include "wx/thread.h" -#include "wx/utils.h" -#include "wx/wxchar.h" +#include "wx/private/threadinfo.h" +#include "wx/crt.h" +#include "wx/vector.h" // other standard headers #ifndef __WXWINCE__ @@ -64,6 +63,57 @@ #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 // ---------------------------------------------------------------------------- @@ -75,336 +125,418 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz); #endif -// ============================================================================ -// implementation -// ============================================================================ - // ---------------------------------------------------------------------------- -// globals +// module 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) +namespace +{ -// static buffer for error messages -static wxChar s_szBufStatic[LOG_BUFFER_SIZE]; +// 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 +{ + PreviousLogInfo() + { + numRepeated = 0; + } -static wxChar *s_szBuf = s_szBufStatic; -static size_t s_szBufSize = WXSIZEOF( s_szBufStatic ); -#if wxUSE_THREADS + // previous message itself + wxString msg; -// the critical section protecting the static buffer -static wxCriticalSection gs_csLogBuf; + // its level + wxLogLevel level; -#endif // wxUSE_THREADS + // other information about it + wxLogRecordInfo info; -// return true if we have a non NULL non disabled log target -static inline bool IsLoggingEnabled() -{ - return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL); -} + // the number of times it was already repeated + unsigned numRepeated; +}; -// ---------------------------------------------------------------------------- -// implementation of Log functions +PreviousLogInfo gs_prevLog; + + +// map containing all components for which log level was explicitly set // -// NB: unfortunately we need all these distinct functions, we can't make them -// macros and not all compilers inline vararg functions. +// NB: all accesses to it must be protected by GetLevelsCS() critical section +WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels); + +// ---------------------------------------------------------------------------- +// wxLogOutputBest: wxLog wrapper around wxMessageOutputBest // ---------------------------------------------------------------------------- -// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it -static inline void PrintfInLogBug(const wxChar *szFormat, va_list argptr) +class wxLogOutputBest : public wxLog { - if ( wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr) < 0 ) +public: + wxLogOutputBest() { } + +protected: + virtual void DoLogText(const wxString& msg) { - // must NUL-terminate it manually - s_szBuf[s_szBufSize - 1] = _T('\0'); + wxMessageOutputBest().Output(msg); } - //else: NUL-terminated by vsnprintf() + +private: + wxDECLARE_NO_COPY_CLASS(wxLogOutputBest); +}; + +} // anonymous namespace + +// ============================================================================ +// implementation +// ============================================================================ + +// ---------------------------------------------------------------------------- +// helper global functions +// ---------------------------------------------------------------------------- + +void wxSafeShowMessage(const wxString& title, const wxString& text) +{ +#ifdef __WINDOWS__ + ::MessageBox(NULL, text.t_str(), title.t_str(), MB_OK | MB_ICONSTOP); +#else + wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str()); + fflush(stderr); +#endif } -// generic log function -void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr) +// ---------------------------------------------------------------------------- +// wxLogFormatter class implementation +// ---------------------------------------------------------------------------- + +wxString +wxLogFormatter::Format(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) const { - if ( IsLoggingEnabled() ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + wxString prefix; - PrintfInLogBug(szFormat, argptr); + // don't time stamp debug messages under MSW as debug viewers usually + // already have an option to do it +#ifdef __WINDOWS__ + if ( level != wxLOG_Debug && level != wxLOG_Trace ) +#endif // __WINDOWS__ + prefix = FormatTime(info.timestamp); - wxLog::OnLog(level, s_szBuf, time(NULL)); + switch ( level ) + { + 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 __WINDOWS__ + 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 // !__WINDOWS__ } + + return prefix + msg; } -void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...) +wxString +wxLogFormatter::FormatTime(time_t t) const { - va_list argptr; - va_start(argptr, szFormat); - wxVLogGeneric(level, szFormat, argptr); - va_end(argptr); + wxString str; + wxLog::TimeStamp(&str, t); + + return str; } -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxVLog##level(const wxChar *szFormat, va_list argptr) \ - { \ - if ( IsLoggingEnabled() ) { \ - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \ - \ - PrintfInLogBug(szFormat, argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ - } \ - } \ - \ - void wxLog##level(const wxChar *szFormat, ...) \ - { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - wxVLog##level(szFormat, argptr); \ - va_end(argptr); \ - } -IMPLEMENT_LOG_FUNCTION(Error) -IMPLEMENT_LOG_FUNCTION(Warning) -IMPLEMENT_LOG_FUNCTION(Message) -IMPLEMENT_LOG_FUNCTION(Info) -IMPLEMENT_LOG_FUNCTION(Status) +// ---------------------------------------------------------------------------- +// wxLog class implementation +// ---------------------------------------------------------------------------- -void wxSafeShowMessage(const wxString& title, const wxString& text) +unsigned wxLog::LogLastRepeatIfNeeded() { -#ifdef __WINDOWS__ - ::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP); + const unsigned count = gs_prevLog.numRepeated; + + if ( gs_prevLog.numRepeated ) + { + wxString msg; +#if wxUSE_INTL + if ( gs_prevLog.numRepeated == 1 ) + { + // We use a separate message for this case as "repeated 1 time" + // looks somewhat strange. + msg = _("The previous message repeated once."); + } + else + { + // Notice that we still use wxPLURAL() to ensure that multiple + // numbers of times are correctly formatted, even though we never + // actually use the singular string. + msg.Printf(wxPLURAL("The previous message repeated %lu time.", + "The previous message repeated %lu times.", + gs_prevLog.numRepeated), + gs_prevLog.numRepeated); + } #else - wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str()); + msg.Printf(wxS("The previous message was repeated %lu time(s)."), + gs_prevLog.numRepeated); #endif + gs_prevLog.numRepeated = 0; + gs_prevLog.msg.clear(); + DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info); + } + + return count; } -// fatal errors can't be suppressed nor handled by the custom log target and -// always terminate the program -void wxVLogFatalError(const wxChar *szFormat, va_list argptr) +wxLog::~wxLog() { - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - - wxSafeShowMessage(_T("Fatal Error"), s_szBuf); - -#ifdef __WXWINCE__ - ExitThread(3); + // Flush() must be called before destroying the object as otherwise some + // messages could be lost + if ( gs_prevLog.numRepeated ) + { + wxMessageOutputDebug().Printf + ( +#if wxUSE_INTL + wxPLURAL + ( + "Last repeated message (\"%s\", %lu time) wasn't output", + "Last repeated message (\"%s\", %lu times) wasn't output", + gs_prevLog.numRepeated + ), #else - abort(); + wxS("Last repeated message (\"%s\", %lu time(s)) wasn't output"), #endif + gs_prevLog.msg, + gs_prevLog.numRepeated + ); + } + + delete m_formatter; } -void wxLogFatalError(const wxChar *szFormat, ...) +// ---------------------------------------------------------------------------- +// wxLog logging functions +// ---------------------------------------------------------------------------- + +/* static */ +void +wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t) { - va_list argptr; - va_start(argptr, szFormat); - wxVLogFatalError(szFormat, argptr); + wxLogRecordInfo info; + info.timestamp = t; +#if wxUSE_THREADS + info.threadId = wxThread::GetCurrentId(); +#endif // wxUSE_THREADS - // some compilers warn about unreachable code and it shouldn't matter - // for the others anyhow... - //va_end(argptr); + OnLog(level, msg, info); } -// same as info, but only if 'verbose' mode is on -void wxVLogVerbose(const wxChar *szFormat, va_list argptr) +/* static */ +void +wxLog::OnLog(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - if ( IsLoggingEnabled() ) { - wxLog *pLog = wxLog::GetActiveTarget(); - if ( pLog != NULL && pLog->GetVerbose() ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); + // 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); - wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL)); - } + wxAbort(); } -} -void wxLogVerbose(const wxChar *szFormat, ...) -{ - va_list argptr; - va_start(argptr, szFormat); - wxVLogVerbose(szFormat, argptr); - va_end(argptr); -} - -// debug functions -#ifdef __WXDEBUG__ -#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \ - void wxVLog##level(const wxChar *szFormat, va_list argptr) \ - { \ - if ( IsLoggingEnabled() ) { \ - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \ - \ - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ - } \ - } \ - void wxLog##level(const wxChar *szFormat, ...) \ - { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - wxVLog##level(szFormat, argptr); \ - va_end(argptr); \ - } - - void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr) - { - if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - - wxChar *p = s_szBuf; - size_t len = s_szBufSize; - wxStrncpy(s_szBuf, _T("("), len); - len -= 1; // strlen("(") - p += 1; - wxStrncat(p, mask, len); - size_t lenMask = wxStrlen(mask); - len -= lenMask; - p += lenMask; - - wxStrncat(p, _T(") "), len); - len -= 2; - p += 2; - - wxVsnprintf(p, len, szFormat, argptr); - - wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); - } - } - - void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...) - { - va_list argptr; - va_start(argptr, szFormat); - wxVLogTrace(mask, szFormat, argptr); - va_end(argptr); - } - - void wxVLogTrace(wxTraceMask mask, const wxChar *szFormat, 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 ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - - wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); - } - } - - void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...) - { - va_list argptr; - va_start(argptr, szFormat); - wxVLogTrace(mask, szFormat, argptr); - va_end(argptr); - } - -#else // release - #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) -#endif + wxLog *logger; -IMPLEMENT_LOG_DEBUG_FUNCTION(Debug) -IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) +#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()); -// wxLogSysError: one uses the last error code, for other you must give it -// explicitly + gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info)); -// common part of both wxLogSysError -void wxLogSysErrorHelper(long lErrCode) -{ - wxChar szErrMsg[LOG_BUFFER_SIZE / 2]; - wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg), - _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); - wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf)); + // 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 - wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL)); + return; + } + //else: we have a thread-specific logger, we can send messages to it + // directly + } + else +#endif // wxUSE_THREADS + { + logger = GetMainThreadActiveTarget(); + if ( !logger ) + return; + } + + logger->CallDoLogNow(level, msg, info); } -void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr) +void +wxLog::CallDoLogNow(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - if ( IsLoggingEnabled() ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + if ( GetRepetitionCounting() ) + { + if ( msg == gs_prevLog.msg ) + { + gs_prevLog.numRepeated++; - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); + // nothing else to do, in particular, don't log the + // repeated message + return; + } + + LogLastRepeatIfNeeded(); - wxLogSysErrorHelper(wxSysErrorCode()); + // reset repetition counter for a new message + gs_prevLog.msg = msg; + gs_prevLog.level = level; + gs_prevLog.info = info; + } + + // 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); + + suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); + } + +#if wxUSE_LOG_TRACE + wxString str; + if ( level == wxLOG_Trace && info.GetStrValue(wxLOG_KEY_TRACE_MASK, &str) ) + { + prefix = "(" + str + ") "; } +#endif // wxUSE_LOG_TRACE + + DoLogRecord(level, prefix + msg + suffix, info); } -void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...) +void wxLog::DoLogRecord(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - va_list argptr; - va_start(argptr, szFormat); - wxVLogSysError(szFormat, argptr); - va_end(argptr); +#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 + + // Use wxLogFormatter to format the message + DoLogTextAtLevel(level, m_formatter->Format (level, msg, info)); } -void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr) +void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg) { - if ( IsLoggingEnabled() ) { - wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - - wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - - wxLogSysErrorHelper(lErrCode); + // 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 ) + { + wxMessageOutputDebug().Output(msg + wxS('\n')); + } + else + { + DoLogText(msg); } } -void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...) +void wxLog::DoLogText(const wxString& WXUNUSED(msg)) { - va_list argptr; - va_start(argptr, szFormat); - wxVLogSysError(lErrCode, szFormat, argptr); - va_end(argptr); + // 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 } -// ---------------------------------------------------------------------------- -// wxLog class implementation -// ---------------------------------------------------------------------------- +#if WXWIN_COMPATIBILITY_2_8 -wxLog::wxLog() +void wxLog::DoLog(wxLogLevel WXUNUSED(level), const char *szString, time_t t) { + DoLogString(szString, t); } -wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size) +void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t) { - wxChar *oldbuf = s_szBuf; + DoLogString(wzString, t); +} - if( buf == 0 ) - { - s_szBuf = s_szBufStatic; - s_szBufSize = WXSIZEOF( s_szBufStatic ); - } - else +#endif // WXWIN_COMPATIBILITY_2_8 + +// ---------------------------------------------------------------------------- +// wxLog active target management +// ---------------------------------------------------------------------------- + +wxLog *wxLog::GetActiveTarget() +{ +#if wxUSE_THREADS + if ( !wxThread::IsMain() ) { - s_szBuf = buf; - s_szBufSize = size; + // 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 (oldbuf == s_szBufStatic ) ? 0 : oldbuf; + return GetMainThreadActiveTarget(); } -wxLog *wxLog::GetActiveTarget() +/* static */ +wxLog *wxLog::GetMainThreadActiveTarget() { 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->GetTraits()->CreateLogTarget(); else - ms_pLogger = new wxLogStderr; + ms_pLogger = new wxLogOutputBest; - s_bInGetActiveTarget = FALSE; + s_bInGetActiveTarget = false; // do nothing if it fails - what can we do? } @@ -427,9 +559,25 @@ 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; + 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 @@ -437,94 +585,261 @@ void wxLog::DontCreateOnDemand() ClearTraceMasks(); } +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 +// ---------------------------------------------------------------------------- + +#if wxUSE_DATETIME + void wxLog::TimeStamp(wxString *str) { - if ( ms_timestamp ) + if ( !ms_timestamp.empty() ) { - wxChar buf[256]; - time_t timeNow; - (void)time(&timeNow); - wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow)); + *str = wxDateTime::UNow().Format(ms_timestamp); + *str += wxS(": "); + } +} - str->Empty(); - *str << buf << wxT(": "); +void wxLog::TimeStamp(wxString *str, time_t t) +{ + if ( !ms_timestamp.empty() ) + { + *str = wxDateTime(t).Format(ms_timestamp); + *str += wxS(": "); } } -void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t) +#else // !wxUSE_DATETIME + +void wxLog::TimeStamp(wxString*) { - switch ( level ) { - case wxLOG_FatalError: - DoLogString(wxString(_("Fatal error: ")) + szString, t); - DoLogString(_("Program aborted."), t); - Flush(); -#ifdef __WXWINCE__ - ExitThread(3); -#else - abort(); -#endif - break; +} - case wxLOG_Error: - DoLogString(wxString(_("Error: ")) + szString, t); - break; +void wxLog::TimeStamp(wxString*, time_t) +{ +} - case wxLOG_Warning: - DoLogString(wxString(_("Warning: ")) + szString, t); - break; +#endif // wxUSE_DATETIME/!wxUSE_DATETIME - case wxLOG_Info: - if ( GetVerbose() ) - case wxLOG_Message: - case wxLOG_Status: - default: // log unknown log levels too - DoLogString(szString, t); - break; +#if wxUSE_THREADS - case wxLOG_Trace: - case wxLOG_Debug: -#ifdef __WXDEBUG__ - { - wxString msg = level == wxLOG_Trace ? wxT("Trace: ") - : wxT("Debug: "); - msg << szString; - DoLogString(msg, t); - } -#endif // Debug - break; +void wxLog::FlushThreadMessages() +{ + // check if we have queued messages from other threads + wxLogRecords bufferedLogRecords; + + { + wxCriticalSectionLocker lock(GetBackgroundLogCS()); + bufferedLogRecords.swap(gs_bufferedLogRecords); + + // release the lock now to not keep it while we are logging the + // messages below, allowing background threads to run + } + + 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 wxChar *WXUNUSED(szString), time_t WXUNUSED(t)) +/* static */ +bool wxLog::IsThreadLoggingEnabled() { - wxFAIL_MSG(wxT("DoLogString must be overriden if it's called.")); + return !wxThreadInfo.loggingDisabled; +} + +/* static */ +bool wxLog::EnableThreadLogging(bool enable) +{ + const bool wasEnabled = !wxThreadInfo.loggingDisabled; + wxThreadInfo.loggingDisabled = !enable; + return wasEnabled; +} + +#endif // wxUSE_THREADS + +wxLogFormatter *wxLog::SetFormatter(wxLogFormatter* formatter) +{ + wxLogFormatter* formatterOld = m_formatter; + m_formatter = formatter ? formatter : new wxLogFormatter; + + return formatterOld; } void wxLog::Flush() { - // nothing to do here + LogLastRepeatIfNeeded(); } -/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *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(); + } +} + +// ---------------------------------------------------------------------------- +// wxLogBuffer implementation +// ---------------------------------------------------------------------------- + +void wxLogBuffer::Flush() +{ + wxLog::Flush(); + + if ( !m_str.empty() ) + { + wxMessageOutputBest out; + out.Printf(wxS("%s"), m_str.c_str()); + m_str.clear(); + } +} + +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_Debug: + case wxLOG_Trace: + wxLog::DoLogTextAtLevel(level, msg); + break; + + default: + m_str << msg << wxS("\n"); + } } // ---------------------------------------------------------------------------- @@ -539,14 +854,9 @@ wxLogStderr::wxLogStderr(FILE *fp) m_fp = fp; } -void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) +void wxLogStderr::DoLogText(const wxString& msg) { - wxString str; - TimeStamp(&str); - str << szString; - - fputs(str.mb_str(), m_fp); - fputc(_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 @@ -558,7 +868,7 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; if ( traits && !traits->HasStderr() ) { - wxMessageOutputDebug().Printf(_T("%s"), str.c_str()); + wxMessageOutputDebug().Output(msg + wxS('\n')); } } } @@ -577,11 +887,9 @@ wxLogStream::wxLogStream(wxSTD ostream *ostr) m_ostr = ostr; } -void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) +void wxLogStream::DoLogText(const wxString& msg) { - wxString str; - TimeStamp(&str); - (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl; + (*m_ostr) << msg << wxSTD endl; } #endif // wxUSE_STD_IOSTREAM @@ -591,15 +899,22 @@ void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) wxLogChain::wxLogChain(wxLog *logger) { - m_bPassMessages = TRUE; + m_bPassMessages = true; m_logNew = logger; - m_logOld = wxLog::SetActiveTarget(this); + + // Notice that we use GetActiveTarget() here instead of directly calling + // SetActiveTarget() to trigger wxLog auto-creation: if we're created as + // the first logger, we should still chain with the standard, implicit and + // possibly still not created standard logger instead of disabling normal + // logging entirely. + m_logOld = wxLog::GetActiveTarget(); + wxLog::SetActiveTarget(this); } wxLogChain::~wxLogChain() { - delete m_logOld; + wxLog::SetActiveTarget(m_logOld); if ( m_logNew != this ) delete m_logNew; @@ -623,36 +938,50 @@ void wxLogChain::Flush() m_logNew->Flush(); } -void wxLogChain::DoLog(wxLogLevel level, const wxChar *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); } } -// ---------------------------------------------------------------------------- -// wxLogPassThrough -// ---------------------------------------------------------------------------- - #ifdef __VISUALC__ // "'this' : used in base member initializer list" - so what? #pragma warning(disable:4355) #endif // VC++ -wxLogPassThrough::wxLogPassThrough() +// ---------------------------------------------------------------------------- +// wxLogInterposer +// ---------------------------------------------------------------------------- + +wxLogInterposer::wxLogInterposer() : wxLogChain(this) { } +// ---------------------------------------------------------------------------- +// wxLogInterposerTemp +// ---------------------------------------------------------------------------- + +wxLogInterposerTemp::wxLogInterposerTemp() + : wxLogChain(this) +{ + DetachOldLog(); +} + #ifdef __VISUALC__ #pragma warning(default:4355) #endif // VC++ @@ -665,19 +994,22 @@ wxLogPassThrough::wxLogPassThrough() // static variables // ---------------------------------------------------------------------------- -wxLog *wxLog::ms_pLogger = (wxLog *)NULL; -bool wxLog::ms_doLog = TRUE; -bool wxLog::ms_bAutoCreate = TRUE; -bool wxLog::ms_bVerbose = FALSE; +bool wxLog::ms_bRepetCounting = false; + +wxLog *wxLog::ms_pLogger = 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; -const wxChar *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 @@ -723,7 +1055,7 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) // get error code from syste unsigned long wxSysErrorCode() { -#if defined(__WXMSW__) && !defined(__WXMICROWIN__) +#if defined(__WINDOWS__) && !defined(__WXMICROWIN__) return ::GetLastError(); #else //Unix return errno; @@ -736,23 +1068,35 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) if ( nErrCode == 0 ) nErrCode = wxSysErrorCode(); -#if defined(__WXMSW__) && !defined(__WXMICROWIN__) - static wxChar s_szBuf[LOG_BUFFER_SIZE / 2]; +#if defined(__WINDOWS__) && !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); + 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; + } + // copy it to our buffer and free memory - // Crashes on SmartPhone -#if !defined(__SMARTPHONE__) - if( lpMsgBuf != 0 ) { - wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1); - s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0'); + // Crashes on SmartPhone (FIXME) +#if !defined(__SMARTPHONE__) /* of WinCE */ + if( lpMsgBuf != 0 ) + { + wxStrlcpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf)); LocalFree(lpMsgBuf); @@ -761,27 +1105,27 @@ 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 +#endif // !__SMARTPHONE__ { - s_szBuf[0] = wxT('\0'); + s_szBuf[0] = wxS('\0'); } return s_szBuf; -#else // Unix-WXMICROWIN -#if wxUSE_UNICODE - static wxChar s_szBuf[LOG_BUFFER_SIZE / 2]; - wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1); - return s_szBuf; -#else - return strerror((int)nErrCode); -#endif -#endif // Win/Unix-WXMICROWIN +#else // !__WINDOWS__ + #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 // __WINDOWS__/!__WINDOWS__ } #endif // wxUSE_LOG -