/////////////////////////////////////////////////////////////////////////////
-// Name: log.cpp
+// Name: src/common/log.cpp
// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
// Author: Vadim Zeitlin
// Modified by:
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "log.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-// wxWindows
+#if wxUSE_LOG
+
+// wxWidgets
#ifndef WX_PRECOMP
- #include "wx/string.h"
- #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/app.h"
-
- #if wxUSE_GUI
- #include "wx/window.h"
- #include "wx/msgdlg.h"
- #ifdef __WXMSW__
- #include "wx/msw/private.h"
- #endif
- #endif
+ #include "wx/arrstr.h"
+ #include "wx/intl.h"
+ #include "wx/string.h"
+ #include "wx/utils.h"
#endif //WX_PRECOMP
-#include "wx/file.h"
-#include "wx/textfile.h"
-#include "wx/utils.h"
-#include "wx/wxchar.h"
-#include "wx/log.h"
-#include "wx/thread.h"
-
-#if wxUSE_LOG
+#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/private/threadinfo.h"
+#include "wx/crt.h"
+#include "wx/vector.h"
// other standard headers
-#include <errno.h>
-#include <stdlib.h>
-#include <time.h>
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
+
+#include <stdlib.h>
-#if defined(__WXMSW__)
- #include "wx/msw/private.h" // includes windows.h for OutputDebugString
+#ifndef __WXPALMOS5__
+#ifndef __WXWINCE__
+#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
#endif
+#endif /* ! __WXPALMOS5__ */
-#if defined(__WXMAC__)
- #include "wx/mac/private.h" // includes mac headers
+#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<wxLogRecord> 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
// ----------------------------------------------------------------------------
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
// ----------------------------------------------------------------------------
-// generic log function
-void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
+class wxLogOutputBest : public wxLog
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+public:
+ wxLogOutputBest() { }
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
- wxLog::OnLog(level, s_szBuf, time(NULL));
+protected:
+ virtual void DoLogText(const wxString& msg)
+ {
+ wxMessageOutputBest().Output(msg);
}
-}
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
-{
- va_list argptr;
- va_start(argptr, szFormat);
- wxVLogGeneric(level, szFormat, argptr);
- va_end(argptr);
-}
+private:
+ wxDECLARE_NO_COPY_CLASS(wxLogOutputBest);
+};
-#define IMPLEMENT_LOG_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); \
- }
+} // anonymous namespace
+
+// ============================================================================
+// implementation
+// ============================================================================
-IMPLEMENT_LOG_FUNCTION(Error)
-IMPLEMENT_LOG_FUNCTION(Warning)
-IMPLEMENT_LOG_FUNCTION(Message)
-IMPLEMENT_LOG_FUNCTION(Info)
-IMPLEMENT_LOG_FUNCTION(Status)
+// ----------------------------------------------------------------------------
+// helper global functions
+// ----------------------------------------------------------------------------
void wxSafeShowMessage(const wxString& title, const wxString& text)
{
#ifdef __WINDOWS__
- ::MessageBox(NULL, text, title, 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 wxChar *szFormat, va_list argptr)
+// ----------------------------------------------------------------------------
+// wxLog class implementation
+// ----------------------------------------------------------------------------
+
+unsigned wxLog::LogLastRepeatIfNeeded()
{
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
+ const unsigned count = gs_prevLog.numRepeated;
+
+ 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
+ msg.Printf(wxS("The previous message was repeated %lu times."),
+ gs_prevLog.numRepeated);
+#endif
+ gs_prevLog.numRepeated = 0;
+ gs_prevLog.msg.clear();
+ DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info);
+ }
- wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
+ return count;
+}
- abort();
+wxLog::~wxLog()
+{
+ // 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
+ );
+ }
}
-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);
- va_end(argptr);
+ wxLogRecordInfo info;
+ info.timestamp = t;
+#if wxUSE_THREADS
+ info.threadId = wxThread::GetCurrentId();
+#endif // wxUSE_THREADS
+
+ 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);
+ // 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);
+
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
+ abort();
+#endif
+ }
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
+ wxLog *logger;
+
+#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
- wxLog::OnLog(wxLOG_Info, 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 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
+void
+wxLog::CallDoLogNow(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
+{
+ if ( GetRepetitionCounting() )
+ {
+ if ( msg == gs_prevLog.msg )
+ {
+ gs_prevLog.numRepeated++;
-IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
-IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
+ // nothing else to do, in particular, don't log the
+ // repeated message
+ return;
+ }
-// wxLogSysError: one uses the last error code, for other you must give it
-// explicitly
+ LogLastRepeatIfNeeded();
-// 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));
+ // 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<long>(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
- wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
+ DoLogRecord(level, prefix + msg + suffix, info);
}
-void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
+void wxLog::DoLogRecord(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+#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 )
+ {
+ case wxLOG_Error:
+ prefix += _("Error: ");
+ break;
+
+ case wxLOG_Warning:
+ prefix += _("Warning: ");
+ break;
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
+ // 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;
- wxLogSysErrorHelper(wxSysErrorCode());
+ case wxLOG_Trace:
+ prefix += "Trace: ";
+ break;
+#endif // !__WXMSW__
}
+
+ DoLogTextAtLevel(level, prefix + msg);
}
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
{
- va_list argptr;
- va_start(argptr, szFormat);
- wxVLogSysError(szFormat, argptr);
- va_end(argptr);
+ // 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 wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
+void wxLog::DoLogText(const wxString& WXUNUSED(msg))
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ // 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
+}
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
+#if WXWIN_COMPATIBILITY_2_8
- wxLogSysErrorHelper(lErrCode);
- }
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const char *szString, time_t t)
+{
+ DoLogString(szString, t);
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t)
{
- va_list argptr;
- va_start(argptr, szFormat);
- wxVLogSysError(lErrCode, szFormat, argptr);
- va_end(argptr);
+ DoLogString(wzString, t);
}
+#endif // WXWIN_COMPATIBILITY_2_8
+
// ----------------------------------------------------------------------------
-// wxLog class implementation
+// wxLog active target management
// ----------------------------------------------------------------------------
-wxLog::wxLog()
-{
-}
-
-wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
+wxLog *wxLog::GetActiveTarget()
{
- wxChar *oldbuf = s_szBuf;
-
- if( buf == 0 )
- {
- s_szBuf = s_szBufStatic;
- s_szBufSize = WXSIZEOF( s_szBufStatic );
- }
- else
+#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->CreateLogTarget();
+ 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?
}
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
ClearTraceMasks();
}
-void wxLog::RemoveTraceMask(const wxString& str)
+void wxLog::DoCreateOnDemand()
{
- int index = ms_aTraceMasks.Index(str);
- if ( index != wxNOT_FOUND )
- ms_aTraceMasks.Remove((size_t)index);
+ ms_bAutoCreate = true;
}
-void wxLog::ClearTraceMasks()
-{
- ms_aTraceMasks.Clear();
-}
+// ----------------------------------------------------------------------------
+// wxLog components levels
+// ----------------------------------------------------------------------------
-void wxLog::TimeStamp(wxString *str)
+/* static */
+void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
{
- if ( ms_timestamp )
+ if ( component.empty() )
{
- wxChar buf[256];
- time_t timeNow;
- (void)time(&timeNow);
- wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
+ SetLogLevel(level);
+ }
+ else
+ {
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
- str->Empty();
- *str << buf << wxT(": ");
+ GetComponentLevels()[component] = level;
}
}
-void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+/* static */
+wxLogLevel wxLog::GetComponentLevel(wxString component)
{
- switch ( level ) {
- case wxLOG_FatalError:
- DoLogString(wxString(_("Fatal error: ")) + szString, t);
- DoLogString(_("Program aborted."), t);
- Flush();
- abort();
- break;
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
- case wxLOG_Error:
- DoLogString(wxString(_("Error: ")) + szString, t);
- break;
-
- case wxLOG_Warning:
- DoLogString(wxString(_("Warning: ")) + szString, t);
- break;
-
- case wxLOG_Info:
- if ( GetVerbose() )
- case wxLOG_Message:
- case wxLOG_Status:
- default: // log unknown log levels too
- DoLogString(szString, t);
- break;
+ const wxStringToNumHashMap& componentLevels = GetComponentLevels();
+ while ( !component.empty() )
+ {
+ wxStringToNumHashMap::const_iterator
+ it = componentLevels.find(component);
+ if ( it != componentLevels.end() )
+ return static_cast<wxLogLevel>(it->second);
- 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;
+ component = component.BeforeLast('/');
}
-}
-void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
-{
- wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
-}
-
-void wxLog::Flush()
-{
- // nothing to do here
+ return GetLogLevel();
}
// ----------------------------------------------------------------------------
-// wxLogStderr class implementation
+// wxLog trace masks
// ----------------------------------------------------------------------------
-wxLogStderr::wxLogStderr(FILE *fp)
+namespace
{
- if ( fp == NULL )
- m_fp = stderr;
- else
- m_fp = fp;
-}
-
-#if defined(__WXMAC__) && !defined(__DARWIN__) && defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
-// MetroNub stuff doesn't seem to work in CodeWarrior 5.3 Carbon builds...
+// 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;
-#ifndef __MetroNubUtils__
-#include "MetroNubUtils.h"
-#endif
+ return s_traceMasks;
+}
-#ifdef __cplusplus
- extern "C" {
-#endif
+} // anonymous namespace
-#ifndef __GESTALT__
-#include <Gestalt.h>
-#endif
+/* 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
-#ifndef true
-#define true 1
-#endif
+ return TraceMasks();
+}
-#ifndef false
-#define false 0
-#endif
+void wxLog::AddTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
-#if TARGET_API_MAC_CARBON
+ TraceMasks().push_back(str);
+}
- #include <CodeFragments.h>
+void wxLog::RemoveTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
- EXTERN_API_C( long )
- CallUniversalProc(UniversalProcPtr theProcPtr, ProcInfoType procInfo, ...);
+ int index = TraceMasks().Index(str);
+ if ( index != wxNOT_FOUND )
+ TraceMasks().RemoveAt((size_t)index);
+}
- ProcPtr gCallUniversalProc_Proc = NULL;
+void wxLog::ClearTraceMasks()
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
-#endif
+ TraceMasks().Clear();
+}
-static MetroNubUserEntryBlock* gMetroNubEntry = NULL;
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
-static long fRunOnce = false;
+ const wxArrayString& masks = GetTraceMasks();
+ for ( wxArrayString::const_iterator it = masks.begin(),
+ en = masks.end();
+ it != en;
+ ++it )
+ {
+ if ( *it == mask)
+ return true;
+ }
-Boolean IsCompatibleVersion(short inVersion);
+ return false;
+}
-/* ---------------------------------------------------------------------------
- IsCompatibleVersion
- --------------------------------------------------------------------------- */
+// ----------------------------------------------------------------------------
+// wxLog miscellaneous other methods
+// ----------------------------------------------------------------------------
-Boolean IsCompatibleVersion(short inVersion)
+void wxLog::TimeStamp(wxString *str)
{
- Boolean result = false;
-
- if (fRunOnce)
+#if wxUSE_DATETIME
+ if ( !ms_timestamp.empty() )
{
- MetroNubUserEntryBlock* block = (MetroNubUserEntryBlock *)result;
+ wxChar buf[256];
+ time_t timeNow;
+ (void)time(&timeNow);
- result = (inVersion <= block->apiHiVersion);
- }
+ struct tm tm;
+ wxStrftime(buf, WXSIZEOF(buf),
+ ms_timestamp, wxLocaltime_r(&timeNow, &tm));
- return result;
+ str->Empty();
+ *str << buf << wxS(": ");
+ }
+#endif // wxUSE_DATETIME
}
-/* ---------------------------------------------------------------------------
- IsMetroNubInstalled
- --------------------------------------------------------------------------- */
+#if wxUSE_THREADS
-Boolean IsMetroNubInstalled()
+void wxLog::FlushThreadMessages()
{
- if (!fRunOnce)
+ // check if we have queued messages from other threads
+ wxLogRecords bufferedLogRecords;
+
{
- long result, value;
+ wxCriticalSectionLocker lock(GetBackgroundLogCS());
+ bufferedLogRecords.swap(gs_bufferedLogRecords);
- fRunOnce = true;
- gMetroNubEntry = NULL;
+ // release the lock now to not keep it while we are logging the
+ // messages below, allowing background threads to run
+ }
- if (Gestalt(gestaltSystemVersion, &value) == noErr && value < 0x1000)
+ if ( !bufferedLogRecords.empty() )
+ {
+ for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin();
+ it != bufferedLogRecords.end();
+ ++it )
{
- /* look for MetroNub's Gestalt selector */
- if (Gestalt(kMetroNubUserSignature, &result) == noErr)
- {
-
- #if TARGET_API_MAC_CARBON
- if (gCallUniversalProc_Proc == NULL)
- {
- CFragConnectionID connectionID;
- Ptr mainAddress;
- Str255 errorString;
- ProcPtr symbolAddress;
- OSErr err;
- CFragSymbolClass symbolClass;
-
- symbolAddress = NULL;
- err = GetSharedLibrary("\pInterfaceLib", kPowerPCCFragArch, kFindCFrag,
- &connectionID, &mainAddress, errorString);
-
- if (err != noErr)
- {
- gCallUniversalProc_Proc = NULL;
- goto end;
- }
-
- err = FindSymbol(connectionID, "\pCallUniversalProc",
- (Ptr *) &gCallUniversalProc_Proc, &symbolClass);
-
- if (err != noErr)
- {
- gCallUniversalProc_Proc = NULL;
- goto end;
- }
- }
- #endif
-
- {
- MetroNubUserEntryBlock* block = (MetroNubUserEntryBlock *)result;
-
- /* make sure the version of the API is compatible */
- if (block->apiLowVersion <= kMetroNubUserAPIVersion &&
- kMetroNubUserAPIVersion <= block->apiHiVersion)
- gMetroNubEntry = block; /* success! */
- }
-
- }
+ CallDoLogNow(it->level, it->msg, it->info);
}
}
-
-end:
-
-#if TARGET_API_MAC_CARBON
- return (gMetroNubEntry != NULL && gCallUniversalProc_Proc != NULL);
-#else
- return (gMetroNubEntry != NULL);
-#endif
}
-/* ---------------------------------------------------------------------------
- IsMWDebuggerRunning [v1 API]
- --------------------------------------------------------------------------- */
-
-Boolean IsMWDebuggerRunning()
+/* static */
+bool wxLog::IsThreadLoggingEnabled()
{
- if (IsMetroNubInstalled())
- return CallIsDebuggerRunningProc(gMetroNubEntry->isDebuggerRunning);
- else
- return false;
+ return !wxThreadInfo.loggingDisabled;
}
-/* ---------------------------------------------------------------------------
- AmIBeingMWDebugged [v1 API]
- --------------------------------------------------------------------------- */
-
-Boolean AmIBeingMWDebugged()
+/* static */
+bool wxLog::EnableThreadLogging(bool enable)
{
- if (IsMetroNubInstalled())
- return CallAmIBeingDebuggedProc(gMetroNubEntry->amIBeingDebugged);
- else
- return false;
+ const bool wasEnabled = !wxThreadInfo.loggingDisabled;
+ wxThreadInfo.loggingDisabled = !enable;
+ return wasEnabled;
}
-/* ---------------------------------------------------------------------------
- UserSetWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
+#endif // wxUSE_THREADS
-OSErr UserSetWatchPoint (Ptr address, long length, WatchPointIDT* watchPointID)
+void wxLog::Flush()
{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallUserSetWatchPointProc(gMetroNubEntry->userSetWatchPoint,
- address, length, watchPointID);
- else
- return errProcessIsNotClient;
+ LogLastRepeatIfNeeded();
}
-/* ---------------------------------------------------------------------------
- ClearWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
-
-OSErr ClearWatchPoint (WatchPointIDT watchPointID)
+/* static */
+void wxLog::FlushActive()
{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallClearWatchPointProc(gMetroNubEntry->clearWatchPoint, watchPointID);
- else
- return errProcessIsNotClient;
-}
+ if ( ms_suspendCount )
+ return;
+
+ wxLog * const log = GetActiveTarget();
+ if ( log )
+ {
+#if wxUSE_THREADS
+ if ( wxThread::IsMain() )
+ log->FlushThreadMessages();
+#endif // wxUSE_THREADS
-#ifdef __cplusplus
+ log->Flush();
}
-#endif
+}
-#endif // defined(__WXMAC__) && !defined(__DARWIN__) && (__MWERKS__ >= 0x2400)
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
-void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogBuffer::Flush()
{
- wxString str;
- TimeStamp(&str);
- str << szString;
-
- fputs(str.mb_str(), m_fp);
- fputc(_T('\n'), m_fp);
- fflush(m_fp);
+ wxLog::Flush();
- // under Windows, programs usually don't have stderr at all, so show the
- // messages also under debugger (unless it's a console program which does
- // have stderr or unless this is a file logger which doesn't use stderr at
- // all)
-#if defined(__WXMSW__) && wxUSE_GUI && !defined(__WXMICROWIN__)
- if ( m_fp == stderr )
+ if ( !m_str.empty() )
{
- str += wxT("\r\n") ;
- OutputDebugString(str.c_str());
+ wxMessageOutputBest out;
+ out.Printf(wxS("%s"), m_str.c_str());
+ m_str.clear();
}
-#endif // MSW
+}
-#if defined(__WXMAC__) && !defined(__DARWIN__) && wxUSE_GUI
- Str255 pstr ;
- strcpy( (char*) pstr , str.c_str() ) ;
- strcat( (char*) pstr , ";g" ) ;
- c2pstr( (char*) pstr ) ;
+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;
- Boolean running = false ;
+ default:
+ m_str << msg << wxS("\n");
+ }
+}
-#if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
+// ----------------------------------------------------------------------------
+// wxLogStderr class implementation
+// ----------------------------------------------------------------------------
- if ( IsMWDebuggerRunning() && AmIBeingMWDebugged() )
- {
- running = true ;
- }
+wxLogStderr::wxLogStderr(FILE *fp)
+{
+ if ( fp == NULL )
+ m_fp = stderr;
+ else
+ m_fp = fp;
+}
-#endif
+void wxLogStderr::DoLogText(const wxString& msg)
+{
+ wxFputs(msg + '\n', m_fp);
+ fflush(m_fp);
- if (running)
+ // 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 )
{
-#ifdef __powerc
- DebugStr(pstr);
-#else
- SysBreakStr(pstr);
-#endif
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
+ {
+ wxMessageOutputDebug().Output(msg + wxS('\n'));
+ }
}
-#endif // Mac
}
// ----------------------------------------------------------------------------
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
wxLogChain::wxLogChain(wxLog *logger)
{
- m_bPassMessages = TRUE;
+ m_bPassMessages = true;
m_logNew = logger;
m_logOld = wxLog::SetActiveTarget(this);
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__
// 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;
-#if wxUSE_GUI
- const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date
-#else
- const wxChar *wxLog::ms_timestamp = NULL; // save space
-#endif
+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
unsigned long wxSysErrorCode()
{
#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
-#ifdef __WIN32__
return ::GetLastError();
-#else //WIN16
- // TODO what to do on Windows 3.1?
- return 0;
-#endif //WIN16/32
#else //Unix
return errno;
#endif //Win/Unix
nErrCode = wxSysErrorCode();
#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
-#ifdef __WIN32__
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
+ 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
- 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);
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 {
- s_szBuf[0] = wxT('\0');
+ else
+#endif // !__SMARTPHONE__
+ {
+ s_szBuf[0] = wxS('\0');
}
return s_szBuf;
-#else //Win16
- // TODO
- return NULL;
-#endif // Win16/32
-#else // Unix
-#if wxUSE_UNICODE
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
- wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
- return s_szBuf;
-#else
- return strerror((int)nErrCode);
-#endif
-#endif // Win/Unix
+#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
-
-// vi:sts=4:sw=4:et
+#endif // wxUSE_LOG
projects / wxWidgets.git / blobdiff