X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/184b5d99a5382cd7a19888c85aff11f8a21af2f6..8472511246c9160d4ff40ab86f635fc67c10b54a:/src/common/log.cpp diff --git a/src/common/log.cpp b/src/common/log.cpp index fb2b01148f..376a93365b 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -16,45 +16,103 @@ // ---------------------------------------------------------------------------- // 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 - #include - #include - #include - #include - - #include - #include - #include + #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 -#include -#include -#include +#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 -#include -#include +#ifndef __WXWINCE__ +#include +#endif -#ifdef __WXMSW__ - #include -#else //Unix - #include -#endif //Win/Unix +#include + +#ifndef __WXWINCE__ +#include +#else +#include "wx/msw/wince/time.h" +#endif + +#if defined(__WINDOWS__) + #include "wx/msw/private.h" // includes windows.h +#endif + +#undef wxLOG_COMPONENT +const char *wxLOG_COMPONENT = ""; + +// this macro allows to define an object which will be initialized before any +// other function in this file is called: this is necessary to allow log +// functions to be used during static initialization (this is not advisable +// anyhow but we should at least try to not crash) and to also ensure that they +// are initialized by the time static initialization is done, i.e. before any +// threads are created hopefully +// +// the net effect of all this is that you can use Get##name() function to +// access the object without worrying about it being not initialized +// +// see also WX_DEFINE_GLOBAL_CONV2() in src/common/strconv.cpp +#define WX_DEFINE_GLOBAL_VAR(type, name) \ + inline type& Get##name() \ + { \ + static type s_##name; \ + return s_##name; \ + } \ + \ + type *gs_##name##Ptr = &Get##name() + +#if wxUSE_THREADS + +wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar; + +namespace +{ + +// contains messages logged by the other threads and waiting to be shown until +// Flush() is called in the main one +typedef wxVector wxLogRecords; +wxLogRecords gs_bufferedLogRecords; + +#define WX_DEFINE_LOG_CS(name) WX_DEFINE_GLOBAL_VAR(wxCriticalSection, name##CS) + +// this critical section is used for buffering the messages from threads other +// than main, i.e. it protects all accesses to gs_bufferedLogRecords above +WX_DEFINE_LOG_CS(BackgroundLog); + +// this one is used for protecting TraceMasks() from concurrent access +WX_DEFINE_LOG_CS(TraceMask); + +// and this one is used for GetComponentLevels() +WX_DEFINE_LOG_CS(Levels); + +} // anonymous namespace + +#endif // wxUSE_THREADS // ---------------------------------------------------------------------------- // non member functions @@ -68,751 +126,867 @@ #endif // ---------------------------------------------------------------------------- -// global variables +// module globals +// ---------------------------------------------------------------------------- + +namespace +{ + +// 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; + } + + + // previous message itself + wxString msg; + + // its level + wxLogLevel level; + + // other information about it + wxLogRecordInfo info; + + // 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 // ---------------------------------------------------------------------------- -// we use a global variable to store the frame pointer for wxLogStatus - bad, -// but it's he easiest way -static wxFrame *gs_pFrame; +class wxLogOutputBest : public wxLog +{ +public: + wxLogOutputBest() { } + +protected: + virtual void DoLogText(const wxString& msg) + { + wxMessageOutputBest().Output(msg); + } + +private: + wxDECLARE_NO_COPY_CLASS(wxLogOutputBest); +}; + +} // anonymous namespace // ============================================================================ // implementation // ============================================================================ // ---------------------------------------------------------------------------- -// implementation of Log functions -// -// NB: unfortunately we need all these distinct functions, we can't make them -// macros and not all compilers inline vararg functions. -// ---------------------------------------------------------------------------- - -// 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) - -// static buffer for error messages (@@@ MT-unsafe) -static char s_szBuf[LOG_BUFFER_SIZE]; - -// 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); - } -} - -#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; - } -} - -// same as info, but only if 'verbose' mode is on -void wxLogVerbose(const char *szFormat, ...) -{ - 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); - } -} - -// 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); - } - } - -#else // release - #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) -#endif +// helper global functions +// ---------------------------------------------------------------------------- -IMPLEMENT_LOG_DEBUG_FUNCTION(Debug) -IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) +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 +} -// wxLogSysError: one uses the last error code, for other you must give it -// explicitly +// ---------------------------------------------------------------------------- +// wxLogFormatter class implementation +// ---------------------------------------------------------------------------- -// common part of both wxLogSysError -void wxLogSysErrorHelper(long lErrCode) +wxString +wxLogFormatter::Format(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) const { - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); + wxString prefix; - wxLog::OnLog(wxLOG_Error, s_szBuf); -} + // don't time stamp debug messages under MSW as debug viewers usually + // already have an option to do it +#ifdef __WINDOWS__ + if ( level != wxLOG_Debug && level != wxLOG_Trace ) +#endif // __WINDOWS__ + prefix = FormatTime(info.timestamp); -void WXDLLEXPORT wxLogSysError(const char *szFormat, ...) -{ - va_list argptr; - va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + switch ( level ) + { + case wxLOG_Error: + prefix += _("Error: "); + break; - wxLogSysErrorHelper(wxSysErrorCode()); + case wxLOG_Warning: + prefix += _("Warning: "); + break; + + // don't prepend "debug/trace" prefix under MSW as it goes to the debug + // window anyhow and so can't be confused with something else +#ifndef __WINDOWS__ + case wxLOG_Debug: + // this prefix (as well as the one below) is intentionally not + // translated as nobody translates debug messages anyhow + prefix += "Debug: "; + break; + + case wxLOG_Trace: + prefix += "Trace: "; + break; +#endif // !__WINDOWS__ + } + + return prefix + msg; } -void WXDLLEXPORT wxLogSysError(long lErrCode, const char *szFormat, ...) +wxString +wxLogFormatter::FormatTime(time_t t) const { - va_list argptr; - va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + wxString str; + wxLog::TimeStamp(&str, t); - wxLogSysErrorHelper(lErrCode); + return str; } + // ---------------------------------------------------------------------------- // wxLog class implementation // ---------------------------------------------------------------------------- -wxLog::wxLog() +unsigned wxLog::LogLastRepeatIfNeeded() { - m_bHasMessages = FALSE; - m_bVerbose = FALSE; - m_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; + const unsigned count = gs_prevLog.numRepeated; + + if ( gs_prevLog.numRepeated ) + { + wxString msg; +#if wxUSE_INTL + if ( gs_prevLog.numRepeated == 1 ) + { + // We use a separate message for this case as "repeated 1 time" + // looks somewhat strange. + msg = _("The previous message repeated once."); + } + else + { + // Notice that we still use wxPLURAL() to ensure that multiple + // numbers of times are correctly formatted, even though we never + // actually use the singular string. + msg.Printf(wxPLURAL("The previous message repeated %lu time.", + "The previous message repeated %lu times.", + gs_prevLog.numRepeated), + gs_prevLog.numRepeated); + } +#else + msg.Printf(wxS("The previous message was repeated %lu time(s)."), + gs_prevLog.numRepeated); +#endif + gs_prevLog.numRepeated = 0; + gs_prevLog.msg.clear(); + DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info); + } + + return count; } -wxLog *wxLog::GetActiveTarget() +wxLog::~wxLog() { - 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; + // Flush() must be called before destroying the object as otherwise some + // messages could be lost + if ( gs_prevLog.numRepeated ) + { + wxMessageOutputDebug().Printf + ( +#if wxUSE_INTL + wxPLURAL + ( + "Last repeated message (\"%s\", %lu time) wasn't output", + "Last repeated message (\"%s\", %lu times) wasn't output", + gs_prevLog.numRepeated + ), +#else + wxS("Last repeated message (\"%s\", %lu time(s)) wasn't output"), +#endif + gs_prevLog.msg, + gs_prevLog.numRepeated + ); + } - #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(); - #endif + delete m_formatter; +} - s_bInGetActiveTarget = FALSE; +// ---------------------------------------------------------------------------- +// wxLog logging functions +// ---------------------------------------------------------------------------- - // do nothing if it fails - what can we do? - } - } +/* static */ +void +wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t) +{ + wxLogRecordInfo info; + info.timestamp = t; +#if wxUSE_THREADS + info.threadId = wxThread::GetCurrentId(); +#endif // wxUSE_THREADS - return ms_pLogger; + OnLog(level, msg, info); } -wxLog *wxLog::SetActiveTarget(wxLog *pLogger) +/* static */ +void +wxLog::OnLog(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(); - } + // fatal errors can't be suppressed nor handled by the custom log target + // and always terminate the program + if ( level == wxLOG_FatalError ) + { + wxSafeShowMessage(wxS("Fatal Error"), msg); - wxLog *pOldLogger = ms_pLogger; - ms_pLogger = pLogger; + wxAbort(); + } - return pOldLogger; -} + wxLog *logger; -wxString wxLog::TimeStamp() const -{ - wxString str; +#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()); -/* 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; + gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info)); - time(&timeNow); - ptmNow = localtime(&timeNow); + // 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 - strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow); - str = szBuf; - } -*/ + 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 str; + logger->CallDoLogNow(level, msg, info); } -void wxLog::DoLog(wxLogLevel level, const char *szString) +void +wxLog::CallDoLogNow(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - // prepend a timestamp if not disabled - wxString str = TimeStamp(); + if ( GetRepetitionCounting() ) + { + if ( msg == gs_prevLog.msg ) + { + gs_prevLog.numRepeated++; - switch ( level ) { - case wxLOG_FatalError: - DoLogString(str << _("Fatal error: ") << szString); - DoLogString(_("Program aborted.")); - Flush(); - abort(); - break; + // nothing else to do, in particular, don't log the + // repeated message + return; + } - case wxLOG_Error: - DoLogString(str << _("Error: ") << szString); - break; + LogLastRepeatIfNeeded(); - case wxLOG_Warning: - DoLogString(str << _("Warning: ") << szString); - break; + // reset repetition counter for a new message + gs_prevLog.msg = msg; + gs_prevLog.level = level; + gs_prevLog.info = info; + } - case wxLOG_Info: - if ( GetVerbose() ) - case wxLOG_Message: - DoLogString(str + szString); - // fall through + // handle extra data which may be passed to us by wxLogXXX() + wxString prefix, suffix; + wxUIntPtr num = 0; + if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) ) + { + const long err = static_cast(num); - case wxLOG_Status: - // nothing to do - break; + suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err)); + } - case wxLOG_Trace: - case wxLOG_Debug: - #ifdef __WXDEBUG__ - DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug")) - << ": " << szString); - #endif +#if wxUSE_LOG_TRACE + wxString str; + if ( level == wxLOG_Trace && info.GetStrValue(wxLOG_KEY_TRACE_MASK, &str) ) + { + prefix = "(" + str + ") "; + } +#endif // wxUSE_LOG_TRACE - break; + DoLogRecord(level, prefix + msg + suffix, info); +} - default: - wxFAIL_MSG(_("unknown log level in wxLog::DoLog")); - } +void wxLog::DoLogRecord(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) +{ +#if WXWIN_COMPATIBILITY_2_8 + // call the old DoLog() to ensure that existing custom log classes still + // work + // + // as the user code could have defined it as either taking "const char *" + // (in ANSI build) or "const wxChar *" (in ANSI/Unicode), we have no choice + // but to call both of them + DoLog(level, (const char*)msg.mb_str(), info.timestamp); + DoLog(level, (const wchar_t*)msg.wc_str(), info.timestamp); +#else // !WXWIN_COMPATIBILITY_2_8 + wxUnusedVar(info); +#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8 + + // Use wxLogFormatter to format the message + DoLogTextAtLevel(level, m_formatter->Format (level, msg, info)); } -void 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) { - fputs(szString, m_fp); - fputc('\n', m_fp); - fflush(m_fp); + DoLogString(wzString, t); } +#endif // WXWIN_COMPATIBILITY_2_8 + // ---------------------------------------------------------------------------- -// wxLogStream implementation +// wxLog active target management // ---------------------------------------------------------------------------- -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(); } -#ifndef wxUSE_NOGUI -// ---------------------------------------------------------------------------- -// wxLogTextCtrl implementation -// ---------------------------------------------------------------------------- -wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl) -// @@@ TODO: in wxGTK wxTextCtrl doesn't derive from streambuf - -// Also, in 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; -} + 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; - } - } - - if ( pFrame != NULL ) - pFrame->SetStatusText(szString); - } - break; + wxCRIT_SECT_LOCKER(lock, GetLevelsCS()); - case wxLOG_Trace: - case wxLOG_Debug: - #ifdef __WXDEBUG__ - { - wxString strTime = TimeStamp(); - - #if (defined(__WIN32__) || defined(__WIN16__)) && !defined(__WXSTUBS__) - // don't prepend debug/trace here: it goes to the debug window - // anyhow, but do put a timestamp - OutputDebugString(strTime + szString + "\n\r"); - #else //!WIN32 - // send them to stderr - fprintf(stderr, "%s %s: %s\n", - strTime.c_str(), - level == wxLOG_Trace ? _("Trace") : _("Debug"), - szString); - fflush(stderr); - #endif // WIN32 - } - #endif - break; - - case wxLOG_FatalError: - // show this one immediately - wxMessageBox(szString, _("Fatal error"), wxICON_HAND); - break; + const wxStringToNumHashMap& componentLevels = GetComponentLevels(); + while ( !component.empty() ) + { + wxStringToNumHashMap::const_iterator + it = componentLevels.find(component); + if ( it != componentLevels.end() ) + return static_cast(it->second); - 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; + component = component.BeforeLast('/'); + } - default: - wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog")); - } + 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; + wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS()); - // @@ 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); + TraceMasks().Clear(); +} - // 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); +/*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; + } - // status bar for menu prompts - CreateStatusBar(); + return false; +} - m_log->OnFrameCreate(this); +// ---------------------------------------------------------------------------- +// wxLog miscellaneous other methods +// ---------------------------------------------------------------------------- + +#if wxUSE_DATETIME + +void wxLog::TimeStamp(wxString *str) +{ + if ( !ms_timestamp.empty() ) + { + *str = wxDateTime::UNow().Format(ms_timestamp); + *str += wxS(": "); + } } -void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event)) +void wxLog::TimeStamp(wxString *str, time_t t) { - DoClose(); + if ( !ms_timestamp.empty() ) + { + *str = wxDateTime(t).Format(ms_timestamp); + *str += wxS(": "); + } } -void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) +#else // !wxUSE_DATETIME + +void wxLog::TimeStamp(wxString*) { - DoClose(); } -void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event)) +void wxLog::TimeStamp(wxString*, time_t) { - // 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; +#endif // wxUSE_DATETIME/!wxUSE_DATETIME - case wxNO: - bAppend = FALSE; - break; +#if wxUSE_THREADS - case wxCANCEL: - return; +void wxLog::FlushThreadMessages() +{ + // 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 */); - } - } - else { - bOk = file.Create(szFileName); - } - // retrieve text and save it - // ------------------------- -#ifdef __WXGTK__ - // @@@@ TODO: no GetNumberOfLines and GetLineText in wxGTK yet - wxLogError(_("Sorry, this function is not implemented under GTK")); -#else - int nLines = m_pTextCtrl->GetNumberOfLines(); - for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) { - bOk = file.Write(m_pTextCtrl->GetLineText(nLine) + wxTextFile::GetEOL()); - } -#endif //GTK + if ( !bufferedLogRecords.empty() ) + { + for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin(); + it != bufferedLogRecords.end(); + ++it ) + { + CallDoLogNow(it->level, it->msg, it->info); + } + } +} - if ( bOk ) - bOk = file.Close(); +/* static */ +bool wxLog::IsThreadLoggingEnabled() +{ + return !wxThreadInfo.loggingDisabled; +} - if ( !bOk ) { - wxLogError(_("Can't save log contents to file.")); - return; - } +/* static */ +bool wxLog::EnableThreadLogging(bool enable) +{ + const bool wasEnabled = !wxThreadInfo.loggingDisabled; + wxThreadInfo.loggingDisabled = !enable; + return wasEnabled; } -void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event)) +#endif // wxUSE_THREADS + +wxLogFormatter *wxLog::SetFormatter(wxLogFormatter* formatter) { - m_pTextCtrl->Clear(); + wxLogFormatter* formatterOld = m_formatter; + m_formatter = formatter ? formatter : new wxLogFormatter; + + return formatterOld; } -wxLogFrame::~wxLogFrame() +void wxLog::Flush() { - m_log->OnFrameDelete(this); + LogLastRepeatIfNeeded(); } -// wxLogWindow -// ----------- -wxLogWindow::wxLogWindow(wxFrame *pParent, - const char *szTitle, - bool bShow, - bool bDoPass) +/* 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(); - - m_bHasMessages = FALSE; + // 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"); + } } -void wxLogWindow::DoLog(wxLogLevel level, const char *szString) +// ---------------------------------------------------------------------------- +// wxLogStderr class implementation +// ---------------------------------------------------------------------------- + +wxLogStderr::wxLogStderr(FILE *fp) { - // 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 ( fp == NULL ) + m_fp = stderr; + else + m_fp = fp; +} - if ( m_pLogFrame ) { - switch ( level ) { - case wxLOG_Status: - // by default, these messages are ignored by wxLog, so process - // them ourselves +void wxLogStderr::DoLogText(const wxString& msg) +{ + // First send it to stderr, even if we don't have it (e.g. in a Windows GUI + // application under) it's not a problem to try to use it and it's easier + // than determining whether we do have it or not. + wxMessageOutputStderr(m_fp).Output(msg); + + // 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; +// ---------------------------------------------------------------------------- +// wxLogStream implementation +// ---------------------------------------------------------------------------- - default: - // and this will format it nicely and call our DoLogString() - wxLog::DoLog(level, szString); - } - } +#if wxUSE_STD_IOSTREAM +#include "wx/ioswrap.h" +wxLogStream::wxLogStream(wxSTD ostream *ostr) +{ + if ( ostr == NULL ) + m_ostr = &wxSTD cerr; + else + m_ostr = ostr; +} - m_bHasMessages = TRUE; +void wxLogStream::DoLogText(const wxString& msg) +{ + (*m_ostr) << msg << wxSTD endl; } +#endif // wxUSE_STD_IOSTREAM + +// ---------------------------------------------------------------------------- +// wxLogChain +// ---------------------------------------------------------------------------- -void wxLogWindow::DoLogString(const char *szString) +wxLogChain::wxLogChain(wxLog *logger) { - // put the text into our window - wxTextCtrl *pText = m_pLogFrame->TextCtrl(); + m_bPassMessages = true; - // remove selection (WriteText is in fact ReplaceSelection) - #ifdef __WXMSW__ - long nLen = pText->GetLastPosition(); - pText->SetSelection(nLen, nLen); - #endif // Windows + m_logNew = logger; - pText->WriteText(szString); - pText->WriteText("\n"); // "\n" ok here (_not_ "\r\n") + // Notice that we use GetActiveTarget() here instead of directly calling + // SetActiveTarget() to trigger wxLog auto-creation: if we're created as + // the first logger, we should still chain with the standard, implicit and + // possibly still not created standard logger instead of disabling normal + // logging entirely. + m_logOld = wxLog::GetActiveTarget(); + wxLog::SetActiveTarget(this); +} - // TODO ensure that the line can be seen +wxLogChain::~wxLogChain() +{ + wxLog::SetActiveTarget(m_logOld); + + if ( m_logNew != this ) + delete m_logNew; } -wxFrame *wxLogWindow::GetFrame() const +void wxLogChain::SetLog(wxLog *logger) { - return m_pLogFrame; + if ( m_logNew != this ) + delete m_logNew; + + m_logNew = logger; } -void wxLogWindow::OnFrameCreate(wxFrame *WXUNUSED(frame)) +void wxLogChain::Flush() { + if ( m_logOld ) + m_logOld->Flush(); + + // be careful to avoid infinite recursion + if ( m_logNew && m_logNew != this ) + m_logNew->Flush(); } -void wxLogWindow::OnFrameDelete(wxFrame *WXUNUSED(frame)) +void wxLogChain::DoLogRecord(wxLogLevel level, + const wxString& msg, + const wxLogRecordInfo& info) { - m_pLogFrame = (wxLogFrame *)NULL; + // 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); + } } -wxLogWindow::~wxLogWindow() +#ifdef __VISUALC__ + // "'this' : used in base member initializer list" - so what? + #pragma warning(disable:4355) +#endif // VC++ + +// ---------------------------------------------------------------------------- +// wxLogInterposer +// ---------------------------------------------------------------------------- + +wxLogInterposer::wxLogInterposer() + : wxLogChain(this) { - delete m_pOldLog; +} - // may be NULL if log frame already auto destroyed itself - delete m_pLogFrame; +// ---------------------------------------------------------------------------- +// wxLogInterposerTemp +// ---------------------------------------------------------------------------- + +wxLogInterposerTemp::wxLogInterposerTemp() + : wxLogChain(this) +{ + DetachOldLog(); } -#endif //wxUSE_NOGUI +#ifdef __VISUALC__ + #pragma warning(default:4355) +#endif // VC++ // ============================================================================ // Global functions/variables @@ -821,10 +995,23 @@ wxLogWindow::~wxLogWindow() // ---------------------------------------------------------------------------- // 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 @@ -833,33 +1020,33 @@ wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; // 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 @@ -870,131 +1057,77 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) // 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(__WINDOWS__) && !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) +const wxChar *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 - #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) -{ - // 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(__WINDOWS__) && !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; + } - return; - } - s_bInAssert = TRUE; + // 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)); - char szBuf[LOG_BUFFER_SIZE]; - sprintf(szBuf, _("Assert failed in file %s at line %d"), szFile, nLine); - if ( szMsg != NULL ) { - strcat(szBuf, ": "); - strcat(szBuf, szMsg); - } - else { - strcat(szBuf, "."); - } + LocalFree(lpMsgBuf); - if ( !s_bNoAsserts ) { - // send it to the normal log destination - wxLogDebug(szBuf); + // 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'); + } - #ifdef wxUSE_NOGUI - Trap(); + return s_szBuf; +#else // !__WINDOWS__ + #if wxUSE_UNICODE + static wchar_t s_wzBuf[1024]; + wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode), + WXSIZEOF(s_wzBuf) - 1); + return s_wzBuf; #else - 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 // __WINDOWS__/!__WINDOWS__ } -#endif //WXDEBUG - +#endif // wxUSE_LOG