X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0758c46ee65053bc70bd0ef5a73fb30aeec7986c..abd474ea63667f727940a009cc3e0b23ba9f418f:/src/common/log.cpp?ds=sidebyside diff --git a/src/common/log.cpp b/src/common/log.cpp index e0686ce3d8..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__ @@ -63,27 +65,54 @@ #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 -// define static functions providing access to the critical sections we use -// instead of just using static critical section variables as log functions may -// be used during static initialization and while this is certainly not -// advisable it's still better to not crash (as we'd do if we used a yet -// uninitialized critical section) if it happens +wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar; -static inline wxCriticalSection& GetTraceMaskCS() +namespace { - static wxCriticalSection s_csTrace; - return s_csTrace; -} +// 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; -static inline wxCriticalSection& GetPreviousLogCS() -{ - static wxCriticalSection s_csPrev; +#define WX_DEFINE_LOG_CS(name) WX_DEFINE_GLOBAL_VAR(wxCriticalSection, name##CS) - return s_csPrev; -} +// 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 @@ -130,6 +159,31 @@ struct PreviousLogInfo 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 +{ +public: + wxLogOutputBest() { } + +protected: + virtual void DoLogText(const wxString& msg) + { + wxMessageOutputBest().Output(msg); + } + +private: + wxDECLARE_NO_COPY_CLASS(wxLogOutputBest); +}; + } // anonymous namespace // ============================================================================ @@ -155,13 +209,6 @@ void wxSafeShowMessage(const wxString& title, const wxString& text) // ---------------------------------------------------------------------------- unsigned wxLog::LogLastRepeatIfNeeded() -{ - wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS()); - - return LogLastRepeatIfNeededUnlocked(); -} - -unsigned wxLog::LogLastRepeatIfNeededUnlocked() { const unsigned count = gs_prevLog.numRepeated; @@ -236,14 +283,51 @@ wxLog::OnLog(wxLogLevel level, #endif } - wxLog *pLogger = GetActiveTarget(); - if ( !pLogger ) - return; + wxLog *logger; - if ( GetRepetitionCounting() ) +#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()); + + gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info)); + + // 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 + + return; + } + //else: we have a thread-specific logger, we can send messages to it + // directly + } + else +#endif // wxUSE_THREADS { - wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS()); + logger = GetMainThreadActiveTarget(); + if ( !logger ) + return; + } + logger->CallDoLogNow(level, msg, info); +} + +void +wxLog::CallDoLogNow(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) +{ + if ( GetRepetitionCounting() ) + { if ( msg == gs_prevLog.msg ) { gs_prevLog.numRepeated++; @@ -253,7 +337,7 @@ wxLog::OnLog(wxLogLevel level, return; } - pLogger->LogLastRepeatIfNeededUnlocked(); + LogLastRepeatIfNeeded(); // reset repetition counter for a new message gs_prevLog.msg = msg; @@ -266,9 +350,7 @@ wxLog::OnLog(wxLogLevel level, wxUIntPtr num = 0; if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) ) { - long err = static_cast(num); - if ( !err ) - err = wxSysErrorCode(); + const long err = static_cast(num); suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); } @@ -281,7 +363,7 @@ wxLog::OnLog(wxLogLevel level, } #endif // wxUSE_LOG_TRACE - pLogger->DoLogRecord(level, prefix + msg + suffix, info); + DoLogRecord(level, prefix + msg + suffix, info); } void wxLog::DoLogRecord(wxLogLevel level, @@ -297,7 +379,9 @@ void wxLog::DoLogRecord(wxLogLevel level, // 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); -#endif // WXWIN_COMPATIBILITY_2_8 +#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 @@ -385,6 +469,25 @@ void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t) // ---------------------------------------------------------------------------- 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 @@ -397,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; @@ -422,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; @@ -437,66 +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()); - ms_aTraceMasks.push_back(str); + TraceMasks().push_back(str); } void wxLog::RemoveTraceMask(const wxString& str) { wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); - int index = ms_aTraceMasks.Index(str); + int index = TraceMasks().Index(str); if ( index != wxNOT_FOUND ) - ms_aTraceMasks.RemoveAt((size_t)index); + TraceMasks().RemoveAt((size_t)index); } void wxLog::ClearTraceMasks() { wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); - ms_aTraceMasks.Clear(); + 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); + *str = wxDateTime::UNow().Format(ms_timestamp); + *str += wxS(": "); + } +#endif // wxUSE_DATETIME +} - struct tm tm; - wxStrftime(buf, WXSIZEOF(buf), - ms_timestamp, wxLocaltime_r(&timeNow, &tm)); +#if wxUSE_THREADS - str->Empty(); - *str << buf << wxS(": "); +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 } -#endif // wxUSE_DATETIME + + if ( !bufferedLogRecords.empty() ) + { + for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin(); + it != bufferedLogRecords.end(); + ++it ) + { + CallDoLogNow(it->level, it->msg, it->info); + } + } +} + +/* static */ +bool wxLog::IsThreadLoggingEnabled() +{ + 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() { LogLastRepeatIfNeeded(); } -/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask) +/* static */ +void wxLog::FlushActive() { - wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); + if ( ms_suspendCount ) + return; - for ( wxArrayString::iterator it = ms_aTraceMasks.begin(), - en = ms_aTraceMasks.end(); - it != en; ++it ) + wxLog * const log = GetActiveTarget(); + if ( log ) { - if ( *it == mask) - return true; - } +#if wxUSE_THREADS + if ( wxThread::IsMain() ) + log->FlushThreadMessages(); +#endif // wxUSE_THREADS - return false; + log->Flush(); + } } // ---------------------------------------------------------------------------- @@ -505,6 +753,8 @@ void wxLog::Flush() void wxLogBuffer::Flush() { + wxLog::Flush(); + if ( !m_str.empty() ) { wxMessageOutputBest out; @@ -594,7 +844,7 @@ wxLogChain::wxLogChain(wxLog *logger) wxLogChain::~wxLogChain() { - delete m_logOld; + wxLog::SetActiveTarget(m_logOld); if ( m_logNew != this ) delete m_logNew; @@ -627,8 +877,15 @@ void wxLogChain::DoLogRecord(wxLogLevel level, m_logOld->LogRecord(level, msg, info); // and also send it to the new one - if ( m_logNew && m_logNew != this ) - m_logNew->LogRecord(level, msg, info); + if ( m_logNew ) + { + // 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); + } } #ifdef __VISUALC__ @@ -684,8 +941,6 @@ wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; #endif // wxDEBUG_LEVEL -wxArrayString wxLog::ms_aTraceMasks; - // ---------------------------------------------------------------------------- // stdout error logging helper // ----------------------------------------------------------------------------