/////////////////////////////////////////////////////////////////////////////
-// 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/event.h>
- #include <wx/app.h>
- #include <wx/string.h>
- #include <wx/intl.h>
- #include <wx/menu.h>
- #include <wx/frame.h>
- #include <wx/msgdlg.h>
- #include <wx/filedlg.h>
- #include <wx/textctrl.h>
+ #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/file.h>
-#include <wx/textfile.h>
-#include <wx/utils.h>
-#include <wx/log.h>
+#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>
-
-#ifdef __WXMSW__
- #include <windows.h>
- // Redefines OutputDebugString if necessary
- #include "wx/msw/private.h"
-#else //Unix
- #include <signal.h>
-#endif //Win/Unix
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
+
+#include <stdlib.h>
+
+#ifndef __WXPALMOS5__
+#ifndef __WXWINCE__
+#include <time.h>
+#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<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
#endif
// ----------------------------------------------------------------------------
-// global variables
+// module globals
// ----------------------------------------------------------------------------
-// we use a global variable to store the frame pointer for wxLogStatus - bad,
-// but it's he easiest way
-static wxFrame *gs_pFrame;
+namespace
+{
-// ============================================================================
-// implementation
-// ============================================================================
+// 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;
+ }
-// ----------------------------------------------------------------------------
-// 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.
-// ----------------------------------------------------------------------------
-// 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)
+ // previous message itself
+ wxString msg;
-// static buffer for error messages (@@@ MT-unsafe)
-static char s_szBuf[LOG_BUFFER_SIZE];
+ // its level
+ wxLogLevel level;
-// generic log function
-void wxLogGeneric(wxLogLevel level, const char *szFormat, ...)
-{
- if ( wxLog::GetActiveTarget() != NULL ) {
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(level, s_szBuf);
- }
-}
+ // other information about it
+ wxLogRecordInfo info;
-#define IMPLEMENT_LOG_FUNCTION(level) \
- void wxLog##level(const char *szFormat, ...) \
- { \
- if ( wxLog::GetActiveTarget() != NULL ) { \
- va_list argptr; \
- va_start(argptr, szFormat); \
- vsprintf(s_szBuf, szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf); \
- } \
- }
-
-IMPLEMENT_LOG_FUNCTION(FatalError)
-IMPLEMENT_LOG_FUNCTION(Error)
-IMPLEMENT_LOG_FUNCTION(Warning)
-IMPLEMENT_LOG_FUNCTION(Message)
-IMPLEMENT_LOG_FUNCTION(Info)
-IMPLEMENT_LOG_FUNCTION(Status)
-
-// accepts an additional argument which tells to which frame the output should
-// be directed
-void wxLogStatus(wxFrame *pFrame, const char *szFormat, ...)
-{
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL ) {
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(argptr);
-
- wxASSERT( gs_pFrame == NULL ); // should be reset!
- gs_pFrame = pFrame;
- wxLog::OnLog(wxLOG_Status, s_szBuf);
- gs_pFrame = (wxFrame *) NULL;
- }
-}
+ // 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
+// ----------------------------------------------------------------------------
-// same as info, but only if 'verbose' mode is on
-void wxLogVerbose(const char *szFormat, ...)
+class wxLogOutputBest : public wxLog
{
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL && pLog->GetVerbose() ) {
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(wxLOG_Info, s_szBuf);
- }
-}
+public:
+ wxLogOutputBest() { }
-// debug functions
-#ifdef __WXDEBUG__
-#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
- void wxLog##level(const char *szFormat, ...) \
- { \
- if ( wxLog::GetActiveTarget() != NULL ) { \
- va_list argptr; \
- va_start(argptr, szFormat); \
- vsprintf(s_szBuf, szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf); \
- } \
- }
-
- void wxLogTrace(wxTraceMask mask, const char *szFormat, ...)
- {
- wxLog *pLog = wxLog::GetActiveTarget();
-
- // 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 ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf);
+protected:
+ virtual void DoLogText(const wxString& msg)
+ {
+ wxMessageOutputBest().Output(msg);
}
- }
-#else // release
- #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
-#endif
+private:
+ wxDECLARE_NO_COPY_CLASS(wxLogOutputBest);
+};
-IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
-IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
+} // anonymous namespace
-// wxLogSysError: one uses the last error code, for other you must give it
-// explicitly
+// ============================================================================
+// implementation
+// ============================================================================
-// common part of both wxLogSysError
-void wxLogSysErrorHelper(long lErrCode)
-{
- char szErrMsg[LOG_BUFFER_SIZE / 2];
- sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
- strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf));
+// ----------------------------------------------------------------------------
+// helper global functions
+// ----------------------------------------------------------------------------
- wxLog::OnLog(wxLOG_Error, s_szBuf);
+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
}
-void WXDLLEXPORT wxLogSysError(const char *szFormat, ...)
+// ----------------------------------------------------------------------------
+// wxLog class implementation
+// ----------------------------------------------------------------------------
+
+unsigned wxLog::LogLastRepeatIfNeeded()
{
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(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);
+ }
- wxLogSysErrorHelper(wxSysErrorCode());
+ return count;
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const char *szFormat, ...)
+wxLog::~wxLog()
{
- va_list argptr;
- va_start(argptr, szFormat);
- vsprintf(s_szBuf, szFormat, argptr);
- va_end(argptr);
-
- wxLogSysErrorHelper(lErrCode);
+ // 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
+ );
+ }
}
// ----------------------------------------------------------------------------
-// wxLog class implementation
+// wxLog logging functions
// ----------------------------------------------------------------------------
-wxLog::wxLog()
+/* static */
+void
+wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t)
{
- m_bHasMessages = FALSE;
-
- // enable verbose messages by default in the debug builds
-#ifdef __WXDEBUG__
- m_bVerbose = TRUE;
-#else // release
- m_bVerbose = FALSE;
-#endif // debug/release
+ wxLogRecordInfo info;
+ info.timestamp = t;
+#if wxUSE_THREADS
+ info.threadId = wxThread::GetCurrentId();
+#endif // wxUSE_THREADS
- m_szTimeFormat = "[%d/%b/%y %H:%M:%S] ";
+ OnLog(level, msg, info);
}
-wxLog *wxLog::GetActiveTarget()
+/* static */
+void
+wxLog::OnLog(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( ms_bAutoCreate && ms_pLogger == NULL ) {
- // prevent infinite recursion if someone calls wxLogXXX() from
- // wxApp::CreateLogTarget()
- static bool s_bInGetActiveTarget = FALSE;
- if ( !s_bInGetActiveTarget ) {
- s_bInGetActiveTarget = TRUE;
-
- #ifdef wxUSE_NOGUI
- ms_pLogger = new wxLogStderr;
- #else
- // ask the application to create a log target for us
- if ( wxTheApp != NULL )
- ms_pLogger = wxTheApp->CreateLogTarget();
- else
- ms_pLogger = new wxLogStderr;
- #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);
+
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
+ abort();
+#endif
+ }
- s_bInGetActiveTarget = FALSE;
+ wxLog *logger;
- // do nothing if it fails - what can we do?
+#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
+ {
+ logger = GetMainThreadActiveTarget();
+ if ( !logger )
+ return;
}
- }
- return ms_pLogger;
+ logger->CallDoLogNow(level, msg, info);
}
-wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
+void
+wxLog::CallDoLogNow(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( ms_pLogger != NULL ) {
- // flush the old messages before changing because otherwise they might
- // get lost later if this target is not restored
- ms_pLogger->Flush();
- }
+ if ( GetRepetitionCounting() )
+ {
+ if ( msg == gs_prevLog.msg )
+ {
+ gs_prevLog.numRepeated++;
- wxLog *pOldLogger = ms_pLogger;
- ms_pLogger = pLogger;
+ // nothing else to do, in particular, don't log the
+ // repeated message
+ return;
+ }
- return pOldLogger;
-}
+ LogLastRepeatIfNeeded();
-wxString wxLog::TimeStamp() const
-{
- wxString str;
+ // reset repetition counter for a new message
+ gs_prevLog.msg = msg;
+ gs_prevLog.level = level;
+ gs_prevLog.info = info;
+ }
-/* Let's disable TimeStamp and see if anyone complains.
- * If not, we'll remove it, since it's probably unlikely
- * to ever be used. -- JACS 22/11/98
- if ( !IsEmpty(m_szTimeFormat) ) {
- char szBuf[128];
- time_t timeNow;
- struct tm *ptmNow;
+ // 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);
- time(&timeNow);
- ptmNow = localtime(&timeNow);
+ suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
+ }
- strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow);
- str = szBuf;
- }
-*/
+#if wxUSE_LOG_TRACE
+ wxString str;
+ if ( level == wxLOG_Trace && info.GetStrValue(wxLOG_KEY_TRACE_MASK, &str) )
+ {
+ prefix = "(" + str + ") ";
+ }
+#endif // wxUSE_LOG_TRACE
- return str;
+ DoLogRecord(level, prefix + msg + suffix, info);
}
-void wxLog::DoLog(wxLogLevel level, const char *szString)
+void wxLog::DoLogRecord(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- // prepend a timestamp if not disabled
- wxString str = TimeStamp();
-
- switch ( level ) {
- case wxLOG_FatalError:
- DoLogString(str << _("Fatal error: ") << szString);
- DoLogString(_("Program aborted."));
- Flush();
- abort();
- break;
-
- case wxLOG_Error:
- DoLogString(str << _("Error: ") << szString);
- break;
-
- case wxLOG_Warning:
- DoLogString(str << _("Warning: ") << szString);
- break;
-
- case wxLOG_Info:
- case wxLOG_Message:
- if ( GetVerbose() )
- DoLogString(str + szString);
- // fall through
-
- case wxLOG_Status:
- // nothing to do
- break;
-
- case wxLOG_Trace:
- case wxLOG_Debug:
- #ifdef __WXDEBUG__
- // DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug"))
- // << ": " << szString);
- // JACS: we don't really want to prefix with 'Debug'. It's just extra
- // verbiage.
- DoLogString(szString);
- #endif
-
- break;
-
- default:
- wxFAIL_MSG(_("unknown log level in wxLog::DoLog"));
- }
+#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;
+
+ // 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);
}
-void wxLog::DoLogString(const char *WXUNUSED(szString))
+void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
{
- wxFAIL_MSG(_("DoLogString must be overrided if it's called."));
+ // 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 wxLog::Flush()
+void wxLog::DoLogText(const wxString& WXUNUSED(msg))
{
- // do nothing
+ // 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
}
-// ----------------------------------------------------------------------------
-// wxLogStderr class implementation
-// ----------------------------------------------------------------------------
+#if WXWIN_COMPATIBILITY_2_8
-wxLogStderr::wxLogStderr(FILE *fp)
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const char *szString, time_t t)
{
- if ( fp == NULL )
- m_fp = stderr;
- else
- m_fp = fp;
+ DoLogString(szString, t);
}
-void wxLogStderr::DoLogString(const char *szString)
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t)
{
- wxString str(szString);
- str << '\n';
-
- fputs(str, m_fp);
- fflush(m_fp);
-
- // under Windows, programs usually don't have stderr at all, so make show the
- // messages also under debugger
-#ifdef __WXMSW__
- OutputDebugString(str + '\r');
-#endif // MSW
+ DoLogString(wzString, t);
}
+#endif // WXWIN_COMPATIBILITY_2_8
+
// ----------------------------------------------------------------------------
-// wxLogStream implementation
+// wxLog active target management
// ----------------------------------------------------------------------------
-#if wxUSE_STD_IOSTREAM
-wxLogStream::wxLogStream(ostream *ostr)
+wxLog *wxLog::GetActiveTarget()
{
- if ( ostr == NULL )
- m_ostr = &cerr;
- else
- m_ostr = ostr;
-}
+#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
-void wxLogStream::DoLogString(const char *szString)
-{
- (*m_ostr) << szString << endl << flush;
+ return GetMainThreadActiveTarget();
}
-#endif
-
-#ifndef wxUSE_NOGUI
-
-// ----------------------------------------------------------------------------
-// wxLogTextCtrl implementation
-// ----------------------------------------------------------------------------
-#if wxUSE_STD_IOSTREAM
-wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
-// DLL mode in wxMSW, can't use it.
-#if defined(NO_TEXT_WINDOW_STREAM)
-#else
- : wxLogStream(new ostream(pTextCtrl))
-#endif
+/* 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;
+ if ( !s_bInGetActiveTarget ) {
+ s_bInGetActiveTarget = true;
+
+ // ask the application to create a log target for us
+ if ( wxTheApp != NULL )
+ ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
+ else
+ ms_pLogger = new wxLogOutputBest;
+
+ s_bInGetActiveTarget = false;
+
+ // do nothing if it fails - what can we do?
+ }
+ }
+
+ return ms_pLogger;
}
-wxLogTextCtrl::~wxLogTextCtrl()
+wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
{
- delete m_ostr;
-}
-#endif
+ if ( ms_pLogger != NULL ) {
+ // flush the old messages before changing because otherwise they might
+ // get lost later if this target is not restored
+ ms_pLogger->Flush();
+ }
-// ----------------------------------------------------------------------------
-// wxLogGui implementation
-// ----------------------------------------------------------------------------
+ wxLog *pOldLogger = ms_pLogger;
+ ms_pLogger = pLogger;
-wxLogGui::wxLogGui()
-{
- m_bErrors = FALSE;
+ return pOldLogger;
}
-void wxLogGui::Flush()
+#if wxUSE_THREADS
+/* static */
+wxLog *wxLog::SetThreadActiveTarget(wxLog *logger)
{
- if ( !m_bHasMessages )
- return;
+ wxASSERT_MSG( !wxThread::IsMain(), "use SetActiveTarget() for main thread" );
- // do it right now to block any new calls to Flush() while we're here
- m_bHasMessages = FALSE;
+ wxLog * const oldLogger = wxThreadInfo.logger;
+ if ( oldLogger )
+ oldLogger->Flush();
- // @@@ ugly...
+ wxThreadInfo.logger = logger;
- // concatenate all strings (but not too many to not overfill the msg box)
- wxString str;
- size_t nLines = 0,
- nMsgCount = m_aMessages.Count();
+ return oldLogger;
+}
+#endif // wxUSE_THREADS
- // start from the most recent message
- for ( size_t n = nMsgCount; n > 0; n-- ) {
- // for Windows strings longer than this value are wrapped (NT 4.0)
- const size_t nMsgLineWidth = 156;
+void wxLog::DontCreateOnDemand()
+{
+ ms_bAutoCreate = false;
- nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
+ // this is usually called at the end of the program and we assume that it
+ // is *always* called at the end - so we free memory here to avoid false
+ // memory leak reports from wxWin memory tracking code
+ ClearTraceMasks();
+}
- if ( nLines > 25 ) // don't put too many lines in message box
- break;
+void wxLog::DoCreateOnDemand()
+{
+ ms_bAutoCreate = true;
+}
- str << m_aMessages[n - 1] << "\n";
- }
+// ----------------------------------------------------------------------------
+// wxLog components levels
+// ----------------------------------------------------------------------------
- if ( m_bErrors ) {
- wxMessageBox(str, _("Error"), wxOK | wxICON_EXCLAMATION);
- }
- else {
- wxMessageBox(str, _("Information"), wxOK | wxICON_INFORMATION);
- }
+/* static */
+void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
+{
+ if ( component.empty() )
+ {
+ SetLogLevel(level);
+ }
+ else
+ {
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
- // no undisplayed messages whatsoever
- m_bErrors = FALSE;
- m_aMessages.Empty();
+ GetComponentLevels()[component] = level;
+ }
}
-// the default behaviour is to discard all informational messages if there
-// are any errors/warnings.
-void wxLogGui::DoLog(wxLogLevel level, const char *szString)
+/* static */
+wxLogLevel wxLog::GetComponentLevel(wxString component)
{
- switch ( level ) {
- case wxLOG_Info:
- if ( GetVerbose() )
- case wxLOG_Message:
- if ( !m_bErrors ) {
- m_aMessages.Add(szString);
- m_bHasMessages = TRUE;
- }
- break;
-
- case wxLOG_Status:
- {
- // find the top window and set it's status text if it has any
- wxFrame *pFrame = gs_pFrame;
- if ( pFrame == NULL ) {
- wxWindow *pWin = wxTheApp->GetTopWindow();
- if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) {
- pFrame = (wxFrame *)pWin;
- }
- }
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
- if ( pFrame != NULL )
- pFrame->SetStatusText(szString);
- }
- 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 strTime = TimeStamp();
-
- #ifdef __WXMSW__
- // don't prepend debug/trace here: it goes to the debug window
- // anyhow, but do put a timestamp
- OutputDebugString(strTime + szString + "\n\r");
- #else
- // send them to stderr
- fprintf(stderr, "%s %s: %s\n",
- strTime.c_str(),
- level == wxLOG_Trace ? "Trace" : "Debug",
- szString);
- fflush(stderr);
- #endif
- }
- #endif // __WXDEBUG__
- break;
-
- case wxLOG_FatalError:
- // show this one immediately
- wxMessageBox(szString, _("Fatal error"), wxICON_HAND);
- break;
-
- case wxLOG_Error:
- case wxLOG_Warning:
- // discard earlier informational messages if this is the 1st error
- if ( !m_bErrors ) {
- m_aMessages.Empty();
- m_bHasMessages = TRUE;
- m_bErrors = TRUE;
- }
-
- m_aMessages.Add(szString);
- break;
-
- default:
- wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog"));
- }
+ component = component.BeforeLast('/');
+ }
+
+ return GetLogLevel();
}
// ----------------------------------------------------------------------------
-// wxLogWindow and wxLogFrame implementation
+// wxLog trace masks
// ----------------------------------------------------------------------------
-// log frame class
-// ---------------
-class wxLogFrame : public wxFrame
+namespace
{
-public:
- // ctor & dtor
- wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle);
- virtual ~wxLogFrame();
- // menu callbacks
- void OnClose(wxCommandEvent& event);
- void OnCloseWindow(wxCloseEvent& event);
- void OnSave (wxCommandEvent& event);
- void OnClear(wxCommandEvent& event);
+// 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;
- void OnIdle(wxIdleEvent&);
+ return s_traceMasks;
+}
- // accessors
- wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
+} // anonymous namespace
-private:
- enum
- {
- Menu_Close = 100,
- Menu_Save,
- Menu_Clear
- };
+/* 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
- // instead of closing just hide the window to be able to Show() it later
- void DoClose() { Show(FALSE); }
+ return TraceMasks();
+}
- wxTextCtrl *m_pTextCtrl;
- wxLogWindow *m_log;
+void wxLog::AddTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
- DECLARE_EVENT_TABLE()
-};
+ TraceMasks().push_back(str);
+}
-BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
- // wxLogWindow menu events
- EVT_MENU(Menu_Close, wxLogFrame::OnClose)
- EVT_MENU(Menu_Save, wxLogFrame::OnSave)
- EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
+void wxLog::RemoveTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
- EVT_CLOSE(wxLogFrame::OnCloseWindow)
-END_EVENT_TABLE()
+ int index = TraceMasks().Index(str);
+ if ( index != wxNOT_FOUND )
+ TraceMasks().RemoveAt((size_t)index);
+}
-wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle)
- : wxFrame(pParent, -1, szTitle)
+void wxLog::ClearTraceMasks()
{
- m_log = log;
-
- // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating
- // a rich edit control instead of a normal one we want in wxMSW
- m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition,
- wxDefaultSize,
- //wxSIMPLE_BORDER |
- wxTE_MULTILINE |
- wxHSCROLL |
- wxTE_READONLY);
-
- // create menu
- wxMenuBar *pMenuBar = new wxMenuBar;
- wxMenu *pMenu = new wxMenu;
- pMenu->Append(Menu_Save, _("&Save..."), _("Save log contents to file"));
- pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));
- pMenu->AppendSeparator();
- pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
- pMenuBar->Append(pMenu, _("&Log"));
- SetMenuBar(pMenuBar);
-
- // status bar for menu prompts
- CreateStatusBar();
-
- m_log->OnFrameCreate(this);
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ TraceMasks().Clear();
}
-void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
{
- DoClose();
+ 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;
}
-void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
+// ----------------------------------------------------------------------------
+// wxLog miscellaneous other methods
+// ----------------------------------------------------------------------------
+
+void wxLog::TimeStamp(wxString *str)
{
- DoClose();
+#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 << wxS(": ");
+ }
+#endif // wxUSE_DATETIME
}
-void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
+#if wxUSE_THREADS
+
+void wxLog::FlushThreadMessages()
{
- // get the file name
- // -----------------
- const char *szFileName = wxSaveFileSelector("log", "txt", "log.txt");
- if ( szFileName == NULL ) {
- // cancelled
- return;
- }
-
- // open file
- // ---------
- wxFile file;
- bool bOk = FALSE;
- if ( wxFile::Exists(szFileName) ) {
- bool bAppend = FALSE;
- wxString strMsg;
- strMsg.Printf(_("Append log to file '%s' "
- "(choosing [No] will overwrite it)?"), szFileName);
- switch ( wxMessageBox(strMsg, _("Question"), wxYES_NO | wxCANCEL) ) {
- case wxYES:
- bAppend = TRUE;
- break;
-
- case wxNO:
- bAppend = FALSE;
- break;
-
- case wxCANCEL:
- return;
+ // check if we have queued messages from other threads
+ wxLogRecords bufferedLogRecords;
- default:
- wxFAIL_MSG(_("invalid message box return value"));
- }
+ {
+ wxCriticalSectionLocker lock(GetBackgroundLogCS());
+ bufferedLogRecords.swap(gs_bufferedLogRecords);
- if ( bAppend ) {
- bOk = file.Open(szFileName, wxFile::write_append);
+ // release the lock now to not keep it while we are logging the
+ // messages below, allowing background threads to run
}
- else {
- bOk = file.Create(szFileName, TRUE /* overwrite */);
+
+ if ( !bufferedLogRecords.empty() )
+ {
+ for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin();
+ it != bufferedLogRecords.end();
+ ++it )
+ {
+ CallDoLogNow(it->level, it->msg, it->info);
+ }
}
- }
- else {
- bOk = file.Create(szFileName);
- }
-
- // retrieve text and save it
- // -------------------------
- int nLines = m_pTextCtrl->GetNumberOfLines();
- for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
- bOk = file.Write(m_pTextCtrl->GetLineText(nLine) +
-// we're not going to pull in the whole wxTextFile if all we need is this...
-#if wxUSE_TEXTFILE
- wxTextFile::GetEOL()
-#else // !wxUSE_TEXTFILE
- '\n'
-#endif // wxUSE_TEXTFILE
- );
- }
-
- if ( bOk )
- bOk = file.Close();
-
- if ( !bOk ) {
- wxLogError(_("Can't save log contents to file."));
- }
- else {
- wxLogStatus(this, _("Log saved to the file '%s'."), szFileName);
- }
}
-void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
+/* static */
+bool wxLog::IsThreadLoggingEnabled()
{
- m_pTextCtrl->Clear();
+ return !wxThreadInfo.loggingDisabled;
}
-wxLogFrame::~wxLogFrame()
+/* static */
+bool wxLog::EnableThreadLogging(bool enable)
{
- m_log->OnFrameDelete(this);
+ const bool wasEnabled = !wxThreadInfo.loggingDisabled;
+ wxThreadInfo.loggingDisabled = !enable;
+ return wasEnabled;
}
-// wxLogWindow
-// -----------
-wxLogWindow::wxLogWindow(wxFrame *pParent,
- const char *szTitle,
- bool bShow,
- bool bDoPass)
+#endif // wxUSE_THREADS
+
+void wxLog::Flush()
+{
+ LogLastRepeatIfNeeded();
+}
+
+/* static */
+void wxLog::FlushActive()
{
- m_bPassMessages = bDoPass;
+ if ( ms_suspendCount )
+ return;
- m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
- m_pOldLog = wxLog::SetActiveTarget(this);
+ wxLog * const log = GetActiveTarget();
+ if ( log )
+ {
+#if wxUSE_THREADS
+ if ( wxThread::IsMain() )
+ log->FlushThreadMessages();
+#endif // wxUSE_THREADS
- if ( bShow )
- m_pLogFrame->Show(TRUE);
+ log->Flush();
+ }
}
-void wxLogWindow::Show(bool bShow)
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
+
+void wxLogBuffer::Flush()
{
- m_pLogFrame->Show(bShow);
+ wxLog::Flush();
+
+ if ( !m_str.empty() )
+ {
+ wxMessageOutputBest out;
+ out.Printf(wxS("%s"), m_str.c_str());
+ m_str.clear();
+ }
}
-void wxLogWindow::Flush()
+void wxLogBuffer::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
{
- if ( m_pOldLog != NULL )
- m_pOldLog->Flush();
+ // 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");
+ }
+}
- m_bHasMessages = FALSE;
+// ----------------------------------------------------------------------------
+// wxLogStderr class implementation
+// ----------------------------------------------------------------------------
+
+wxLogStderr::wxLogStderr(FILE *fp)
+{
+ if ( fp == NULL )
+ m_fp = stderr;
+ else
+ m_fp = fp;
}
-void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
+void wxLogStderr::DoLogText(const wxString& msg)
{
- // first let the previous logger show it
- if ( m_pOldLog != NULL && m_bPassMessages ) {
- // @@@ why can't we access protected wxLog method from here (we derive
- // from wxLog)? gcc gives "DoLog is protected in this context", what
- // does this mean? Anyhow, the cast is harmless and let's us do what
- // we want.
- ((wxLogWindow *)m_pOldLog)->DoLog(level, szString);
- }
-
- if ( m_pLogFrame ) {
- switch ( level ) {
- case wxLOG_Status:
- // by default, these messages are ignored by wxLog, so process
- // them ourselves
+ wxFputs(msg + '\n', m_fp);
+ fflush(m_fp);
+
+ // under GUI systems such as Windows or Mac, programs usually don't have
+ // stderr at all, so show the messages also somewhere else, typically in
+ // the debugger window so that they go at least somewhere instead of being
+ // simply lost
+ if ( m_fp == stderr )
+ {
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
{
- wxString str = TimeStamp();
- str << _("Status: ") << szString;
- DoLogString(str);
+ wxMessageOutputDebug().Output(msg + wxS('\n'));
}
- break;
-
- // don't put trace messages in the text window for 2 reasons:
- // 1) there are too many of them
- // 2) they may provoke other trace messages thus sending a program
- // into an infinite loop
- case wxLOG_Trace:
- break;
-
- default:
- // and this will format it nicely and call our DoLogString()
- wxLog::DoLog(level, szString);
}
- }
+}
+
+// ----------------------------------------------------------------------------
+// wxLogStream implementation
+// ----------------------------------------------------------------------------
- m_bHasMessages = TRUE;
+#if wxUSE_STD_IOSTREAM
+#include "wx/ioswrap.h"
+wxLogStream::wxLogStream(wxSTD ostream *ostr)
+{
+ if ( ostr == NULL )
+ m_ostr = &wxSTD cerr;
+ else
+ m_ostr = ostr;
}
-void wxLogWindow::DoLogString(const char *szString)
+void wxLogStream::DoLogText(const wxString& msg)
{
- // put the text into our window
- wxTextCtrl *pText = m_pLogFrame->TextCtrl();
+ (*m_ostr) << msg << wxSTD endl;
+}
+#endif // wxUSE_STD_IOSTREAM
- // remove selection (WriteText is in fact ReplaceSelection)
- #ifdef __WXMSW__
- long nLen = pText->GetLastPosition();
- pText->SetSelection(nLen, nLen);
- #endif // Windows
+// ----------------------------------------------------------------------------
+// wxLogChain
+// ----------------------------------------------------------------------------
- pText->WriteText(szString);
- pText->WriteText("\n"); // "\n" ok here (_not_ "\r\n")
+wxLogChain::wxLogChain(wxLog *logger)
+{
+ m_bPassMessages = true;
- // TODO ensure that the line can be seen
+ m_logNew = logger;
+ m_logOld = wxLog::SetActiveTarget(this);
}
-wxFrame *wxLogWindow::GetFrame() const
+wxLogChain::~wxLogChain()
{
- return m_pLogFrame;
+ delete m_logOld;
+
+ if ( m_logNew != this )
+ delete m_logNew;
}
-void wxLogWindow::OnFrameCreate(wxFrame * WXUNUSED(frame))
+void wxLogChain::SetLog(wxLog *logger)
{
+ if ( m_logNew != this )
+ delete m_logNew;
+
+ m_logNew = logger;
}
-void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
+void wxLogChain::Flush()
{
- m_pLogFrame = (wxLogFrame *)NULL;
+ if ( m_logOld )
+ m_logOld->Flush();
+
+ // be careful to avoid infinite recursion
+ if ( m_logNew && m_logNew != this )
+ m_logNew->Flush();
}
-wxLogWindow::~wxLogWindow()
+void wxLogChain::DoLogRecord(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- delete m_pOldLog;
+ // let the previous logger show it
+ if ( m_logOld && IsPassingMessages() )
+ m_logOld->LogRecord(level, msg, info);
+
+ // and also send it to the new one
+ 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__
+ // "'this' : used in base member initializer list" - so what?
+ #pragma warning(disable:4355)
+#endif // VC++
- // may be NULL if log frame already auto destroyed itself
- delete m_pLogFrame;
+// ----------------------------------------------------------------------------
+// wxLogInterposer
+// ----------------------------------------------------------------------------
+
+wxLogInterposer::wxLogInterposer()
+ : wxLogChain(this)
+{
}
-#endif //wxUSE_NOGUI
+// ----------------------------------------------------------------------------
+// wxLogInterposerTemp
+// ----------------------------------------------------------------------------
+
+wxLogInterposerTemp::wxLogInterposerTemp()
+ : wxLogChain(this)
+{
+ DetachOldLog();
+}
+
+#ifdef __VISUALC__
+ #pragma warning(default:4355)
+#endif // VC++
// ============================================================================
// Global functions/variables
// ----------------------------------------------------------------------------
// static variables
// ----------------------------------------------------------------------------
-wxLog *wxLog::ms_pLogger = (wxLog *) NULL;
-bool wxLog::ms_doLog = TRUE;
-bool wxLog::ms_bAutoCreate = TRUE;
-wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
+
+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;
+
+wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date
+
+#if WXWIN_COMPATIBILITY_2_8
+wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
+#endif // wxDEBUG_LEVEL
// ----------------------------------------------------------------------------
// stdout error logging helper
// helper function: wraps the message and justifies it under given position
// (looks more pretty on the terminal). Also adds newline at the end.
//
-// @@ this is now disabled until I find a portable way of determining the
-// terminal window size (ok, I found it but does anybody really cares?)
-#ifdef LOG_PRETTY_WRAP
+// TODO this is now disabled until I find a portable way of determining the
+// terminal window size (ok, I found it but does anybody really cares?)
+#ifdef LOG_PRETTY_WRAP
static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
{
- size_t nMax = 80; // @@@@
- size_t nStart = strlen(pszPrefix);
- fputs(pszPrefix, f);
-
- size_t n;
- while ( *psz != '\0' ) {
- for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
- putc(*psz++, f);
-
- // wrapped?
- if ( *psz != '\0' ) {
- /*putc('\n', f);*/
- for ( n = 0; n < nStart; n++ )
- putc(' ', f);
-
- // as we wrapped, squeeze all white space
- while ( isspace(*psz) )
- psz++;
+ size_t nMax = 80; // FIXME
+ size_t nStart = strlen(pszPrefix);
+ fputs(pszPrefix, f);
+
+ size_t n;
+ while ( *psz != '\0' ) {
+ for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
+ putc(*psz++, f);
+
+ // wrapped?
+ if ( *psz != '\0' ) {
+ /*putc('\n', f);*/
+ for ( n = 0; n < nStart; n++ )
+ putc(' ', f);
+
+ // as we wrapped, squeeze all white space
+ while ( isspace(*psz) )
+ psz++;
+ }
}
- }
- putc('\n', f);
+ putc('\n', f);
}
#endif //LOG_PRETTY_WRAP
// get error code from syste
unsigned long wxSysErrorCode()
{
- #ifdef __WXMSW__
- #ifdef __WIN32__
- return ::GetLastError();
- #else //WIN16
- // @@@@ what to do on Windows 3.1?
- return 0;
- #endif //WIN16/32
- #else //Unix
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
+ return ::GetLastError();
+#else //Unix
return errno;
- #endif //Win/Unix
+#endif //Win/Unix
}
// get error message from system
-const char *wxSysErrorMsg(unsigned long nErrCode)
-{
- if ( nErrCode == 0 )
- nErrCode = wxSysErrorCode();
-
- #ifdef __WXMSW__
- #ifdef __WIN32__
- static char s_szBuf[LOG_BUFFER_SIZE / 2];
-
- // get error message from system
- LPVOID lpMsgBuf;
- FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
- NULL, nErrCode,
- MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
- (LPTSTR)&lpMsgBuf,
- 0, NULL);
-
- // copy it to our buffer and free memory
- strncpy(s_szBuf, (const char *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
- s_szBuf[WXSIZEOF(s_szBuf) - 1] = '\0';
- LocalFree(lpMsgBuf);
-
- // returned string is capitalized and ended with '\r\n' - bad
- s_szBuf[0] = (char)wxToLower(s_szBuf[0]);
- size_t len = strlen(s_szBuf);
- if ( len > 0 ) {
- // truncate string
- if ( s_szBuf[len - 2] == '\r' )
- s_szBuf[len - 2] = '\0';
- }
-
- return s_szBuf;
- #else //Win16
- // TODO @@@@
- return NULL;
- #endif // Win16/32
- #else // Unix
- return strerror(nErrCode);
- #endif // Win/Unix
-}
-
-// ----------------------------------------------------------------------------
-// debug helper
-// ----------------------------------------------------------------------------
-
-#ifdef __WXDEBUG__
-
-void Trap()
-{
- #ifdef __WXMSW__
- DebugBreak();
- #elif defined(__WXSTUBS__)
- // TODO
- #elif defined(__WXMAC__)
- #if __powerc
- Debugger();
- #else
- SysBreak();
- #endif
- #else // Unix
- raise(SIGTRAP);
- #endif // Win/Unix
-}
-
-// this function is called when an assert fails
-void wxOnAssert(const char *szFile, int nLine, const char *szMsg)
+const wxChar *wxSysErrorMsg(unsigned long nErrCode)
{
- // this variable can be set to true to suppress "assert failure" messages
- static bool s_bNoAsserts = FALSE;
- static bool s_bInAssert = FALSE;
-
- if ( s_bInAssert ) {
- // He-e-e-e-elp!! we're trapped in endless loop
- Trap();
+ if ( nErrCode == 0 )
+ nErrCode = wxSysErrorCode();
+
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
+ static wxChar s_szBuf[1024];
+
+ // get error message from system
+ LPVOID lpMsgBuf;
+ if ( ::FormatMessage
+ (
+ FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
+ NULL,
+ nErrCode,
+ MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
+ (LPTSTR)&lpMsgBuf,
+ 0,
+ NULL
+ ) == 0 )
+ {
+ // if this happens, something is seriously wrong, so don't use _() here
+ // for safety
+ wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode);
+ return s_szBuf;
+ }
- s_bInAssert = FALSE;
- return;
- }
+ // copy it to our buffer and free memory
+ // Crashes on SmartPhone (FIXME)
+#if !defined(__SMARTPHONE__) /* of WinCE */
+ if( lpMsgBuf != 0 )
+ {
+ wxStrlcpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf));
- s_bInAssert = TRUE;
+ LocalFree(lpMsgBuf);
- char szBuf[LOG_BUFFER_SIZE];
+ // returned string is capitalized and ended with '\r\n' - bad
+ s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
+ size_t len = wxStrlen(s_szBuf);
+ if ( len > 0 ) {
+ // truncate string
+ if ( s_szBuf[len - 2] == wxS('\r') )
+ s_szBuf[len - 2] = wxS('\0');
+ }
+ }
+ else
+#endif // !__SMARTPHONE__
+ {
+ s_szBuf[0] = wxS('\0');
+ }
- // make life easier for people using VC++ IDE: clicking on the message will
- // take us immediately to the place of the failed assert
-#ifdef __VISUALC__
- sprintf(szBuf, "%s(%d): assert failed", szFile, nLine);
-#else // !VC++
- // make the error message more clear for all the others
- sprintf(szBuf, "Assert failed in file %s at line %d", szFile, nLine);
-#endif // VC/!VC
-
- if ( szMsg != NULL ) {
- strcat(szBuf, ": ");
- strcat(szBuf, szMsg);
- }
- else {
- strcat(szBuf, ".");
- }
-
- if ( !s_bNoAsserts ) {
- // send it to the normal log destination
- wxLogDebug(szBuf);
-
- #if wxUSE_NOGUI
- Trap();
+ return s_szBuf;
+#else // !__WXMSW__
+ #if wxUSE_UNICODE
+ static wchar_t s_wzBuf[1024];
+ wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
+ WXSIZEOF(s_wzBuf) - 1);
+ return s_wzBuf;
#else
- strcat(szBuf, "\nDo you want to stop the program?"
- "\nYou can also choose [Cancel] to suppress "
- "further warnings.");
-
- switch ( wxMessageBox(szBuf, _("Debug"),
- wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
- case wxYES:
- Trap();
- break;
-
- case wxCANCEL:
- s_bNoAsserts = TRUE;
- break;
-
- //case wxNO: nothing to do
- }
- #endif // USE_NOGUI
- }
-
- s_bInAssert = FALSE;
+ return strerror((int)nErrCode);
+ #endif
+#endif // __WXMSW__/!__WXMSW__
}
-#endif //WXDEBUG
-
+#endif // wxUSE_LOG
projects / wxWidgets.git / blobdiff