X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..d78b3d64143f165857922e1e695ba4164d61869f:/src/common/log.cpp diff --git a/src/common/log.cpp b/src/common/log.cpp index 27f5f20ce1..f9729d48d2 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -29,27 +29,38 @@ // wxWindows #ifndef WX_PRECOMP - #include - #include - #include + #include "wx/window.h" +#ifdef __WXMSW__ + #include "wx/msw/private.h" #endif - -#include -#include + #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" +#endif //WX_PRECOMP + +#include "wx/file.h" +#include "wx/textfile.h" +#include "wx/utils.h" +#include "wx/log.h" // other standard headers #include #include #include -// C++ headers -#include - -// _WINDOWS_ is defined when windows.h is included, -// __WINDOWS__ is defined for MS Windows compilation -#if defined(__WINDOWS__) && !defined(_WINDOWS_) -#include -#endif //windows.h +#ifdef __WXMSW__ + #include + // Redefines OutputDebugString if necessary + #include "wx/msw/private.h" +#else //Unix + #include +#endif //Win/Unix // ---------------------------------------------------------------------------- // non member functions @@ -58,10 +69,18 @@ // define this to enable wrapping of log messages //#define LOG_PRETTY_WRAP -#ifdef LOG_PRETTY_WRAP +#ifdef LOG_PRETTY_WRAP static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz); #endif +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// we use a global variable to store the frame pointer for wxLogStatus - bad, +// but it's he easiest way +static wxFrame *gs_pFrame; // FIXME MT-unsafe + // ============================================================================ // implementation // ============================================================================ @@ -77,32 +96,32 @@ // 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]; +// static buffer for error messages (FIXME MT-unsafe) +static wxChar s_szBuf[LOG_BUFFER_SIZE]; // generic log function -void wxLogGeneric(wxLog::Level level, wxTString strFormat, ...) +void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { - va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); - va_end(argptr); - - wxLog::OnLog(level, s_szBuf); - } + if ( wxLog::GetActiveTarget() != NULL ) { + va_list argptr; + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); + va_end(argptr); + + wxLog::OnLog(level, s_szBuf, time(NULL)); + } } #define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(wxTString strFormat, ...) \ + void wxLog##level(const wxChar *szFormat, ...) \ { \ if ( wxLog::GetActiveTarget() != NULL ) { \ va_list argptr; \ - va_start(argptr, strFormat); \ - vsprintf(s_szBuf, strFormat, argptr); \ + va_start(argptr, szFormat); \ + wxVsprintf(s_szBuf, szFormat, argptr); \ va_end(argptr); \ \ - wxLog::OnLog(wxLog::level, s_szBuf); \ + wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ } \ } @@ -113,66 +132,122 @@ IMPLEMENT_LOG_FUNCTION(Message) IMPLEMENT_LOG_FUNCTION(Info) IMPLEMENT_LOG_FUNCTION(Status) -// debug functions don't use wxTString -#undef IMPLEMENT_LOG_FUNCTION -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(const char *szFormat, ...) \ +// accepts an additional argument which tells to which frame the output should +// be directed +void wxLogStatus(wxFrame *pFrame, const wxChar *szFormat, ...) +{ + wxLog *pLog = wxLog::GetActiveTarget(); + if ( pLog != NULL ) { + va_list argptr; + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); + va_end(argptr); + + wxASSERT( gs_pFrame == NULL ); // should be reset! + gs_pFrame = pFrame; + wxLog::OnLog(wxLOG_Status, s_szBuf, time(NULL)); + gs_pFrame = (wxFrame *) NULL; + } +} + +// same as info, but only if 'verbose' mode is on +void wxLogVerbose(const wxChar *szFormat, ...) +{ + wxLog *pLog = wxLog::GetActiveTarget(); + if ( pLog != NULL && pLog->GetVerbose() ) { + va_list argptr; + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); + va_end(argptr); + + wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL)); + } +} + +// debug functions +#ifdef __WXDEBUG__ +#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \ + void wxLog##level(const wxChar *szFormat, ...) \ { \ if ( wxLog::GetActiveTarget() != NULL ) { \ va_list argptr; \ va_start(argptr, szFormat); \ - vsprintf(s_szBuf, szFormat, argptr); \ + wxVsprintf(s_szBuf, szFormat, argptr); \ va_end(argptr); \ \ - wxLog::OnLog(wxLog::level, s_szBuf); \ + wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ } \ } -IMPLEMENT_LOG_FUNCTION(Debug) -IMPLEMENT_LOG_FUNCTION(Trace) + void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...) + { + wxLog *pLog = wxLog::GetActiveTarget(); + + if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) { + va_list argptr; + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); + va_end(argptr); + + wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); + } + } -void wxLogVerbose(wxTString strFormat, ...) -{ - if ( wxLog::GetVerbose() && wxLog::GetActiveTarget() != NULL ) { - va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); - va_end(argptr); - - wxLog::OnLog(wxLog::Info, s_szBuf); - } + void wxLogTrace(wxTraceMask mask, const wxChar *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); + wxVsprintf(s_szBuf, szFormat, argptr); + va_end(argptr); + + wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); + } + } + +#else // release + #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) +#endif + +IMPLEMENT_LOG_DEBUG_FUNCTION(Debug) +IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) + +// wxLogSysError: one uses the last error code, for other you must give it +// explicitly + +// common part of both wxLogSysError +void wxLogSysErrorHelper(long lErrCode) +{ + wxChar szErrMsg[LOG_BUFFER_SIZE / 2]; + wxSprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); + wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf)); + + wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL)); } - -void wxLogSysError(wxTString str, ...) + +void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { va_list argptr; - va_start(argptr, str); - vsprintf(s_szBuf, str, argptr); + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); va_end(argptr); - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), wxSysErrorCode(), wxSysErrorMsg()); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); - - wxLog::OnLog(wxLog::Error, s_szBuf); - } + wxLogSysErrorHelper(wxSysErrorCode()); } -void WXDLLEXPORT wxLogSysError(long lErrCode, wxTString strFormat, ...) +void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { va_list argptr; - va_start(argptr, strFormat); - vsprintf(s_szBuf, strFormat, argptr); + va_start(argptr, szFormat); + wxVsprintf(s_szBuf, szFormat, argptr); va_end(argptr); - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); - - wxLog::OnLog(wxLog::Error, s_szBuf); - } + wxLogSysErrorHelper(lErrCode); } // ---------------------------------------------------------------------------- @@ -181,105 +256,111 @@ void WXDLLEXPORT wxLogSysError(long lErrCode, wxTString strFormat, ...) wxLog::wxLog() { - m_bHasMessages = FALSE; + 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 } -wxLog *wxLog::GetActiveTarget() -{ - if ( !ms_bInitialized ) { - // prevent infinite recursion if someone calls wxLogXXX() from wxApp - ms_bInitialized = TRUE; +wxLog *wxLog::GetActiveTarget() +{ + 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 - // ask the application to create a log target for us if it exists - if ( wxTheApp != NULL ) - ms_pLogger = wxTheApp->CreateLogTarget(); - else - ms_pLogger = new wxLogStderr; + s_bInGetActiveTarget = FALSE; - // do nothing if it fails - what can we do? - } + // do nothing if it fails - what can we do? + } + } - return ms_pLogger; + return ms_pLogger; } wxLog *wxLog::SetActiveTarget(wxLog *pLogger) -{ - // flush the old messages before changing - if ( ms_pLogger != NULL ) - ms_pLogger->Flush(); - - ms_bInitialized = TRUE; - - wxLog *pOldLogger = ms_pLogger; - ms_pLogger = pLogger; - return pOldLogger; -} - -void wxLog::DoLog(Level level, const char *szString) -{ - char szBuf[128]; - time_t timeNow; - struct tm *ptmNow; - - time(&timeNow); - ptmNow = localtime(&timeNow); - - strftime(szBuf, WXSIZEOF(szBuf), ms_szTimeFormat, ptmNow); - wxString str = szBuf; - - switch ( level ) { - case FatalError: - DoLogString(str << _("Fatal error: ") << szString); - DoLogString(_("Program aborted.")); - Flush(); - abort(); - break; - - case Error: - DoLogString(str << _("Error: ") << szString); - break; - - case Warning: - DoLogString(str << _("Warning: ") << szString); - break; - - case Info: - if ( GetVerbose() ) - case Message: - DoLogString(str + szString); - // fall through - - case Status: - // nothing to do - break; - - case Trace: - case Debug: - #ifdef __DEBUG__ - #ifdef __WIN32__ - // in addition to normal logging, also send the string to debugger - // (don't prepend "Debug" here: it will go to debug window anyhow) - ::OutputDebugString(str + szString + "\n\r"); - #endif //Win32 - DoLogString(str << (level == Trace ? _("Trace") : _("Debug")) - << ": " << szString); - #endif - - break; - - default: - wxFAIL_MSG("unknown log level in wxLog::DoLog"); - } +{ + 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(); + } + + wxLog *pOldLogger = ms_pLogger; + ms_pLogger = pLogger; + + return pOldLogger; } -void wxLog::DoLogString(const char *WXUNUSED(szString)) +void wxLog::RemoveTraceMask(const wxString& str) { - wxFAIL_MSG("DoLogString must be overrided if it's called."); + int index = ms_aTraceMasks.Index(str); + if ( index != wxNOT_FOUND ) + ms_aTraceMasks.Remove((size_t)index); +} + +void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t) +{ + switch ( level ) { + case wxLOG_FatalError: + DoLogString(wxString(_("Fatal error: ")) + szString, t); + DoLogString(_("Program aborted."), t); + Flush(); + abort(); + break; + + case wxLOG_Error: + DoLogString(wxString(_("Error: ")) + szString, t); + break; + + case wxLOG_Warning: + DoLogString(wxString(_("Warning: ")) + szString, t); + break; + + case wxLOG_Info: + if ( GetVerbose() ) + case wxLOG_Message: + default: // log unknown log levels too + DoLogString(szString, t); + // fall through + + case wxLOG_Status: + // nothing to do + break; + + case wxLOG_Trace: + case wxLOG_Debug: +#ifdef __WXDEBUG__ + DoLogString(szString, t); +#endif + break; + } +} + +void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t)) +{ + wxFAIL_MSG(_T("DoLogString must be overriden if it's called.")); } void wxLog::Flush() { - // do nothing + // do nothing } // ---------------------------------------------------------------------------- @@ -288,164 +369,498 @@ void wxLog::Flush() wxLogStderr::wxLogStderr(FILE *fp) { - if ( fp == NULL ) - m_fp = stderr; - else - m_fp = fp; + if ( fp == NULL ) + m_fp = stderr; + else + m_fp = fp; } -void wxLogStderr::DoLogString(const char *szString) +void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { - fputs(szString, m_fp); - fputc('\n', m_fp); - fflush(m_fp); + wxString str(szString); + str << _T('\n'); + + fputs(str.mb_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 + _T('\r')); +#endif // MSW } // ---------------------------------------------------------------------------- // wxLogStream implementation // ---------------------------------------------------------------------------- +#if wxUSE_STD_IOSTREAM wxLogStream::wxLogStream(ostream *ostr) { - if ( ostr == NULL ) - m_ostr = &cerr; - else - m_ostr = ostr; + if ( ostr == NULL ) + m_ostr = &cerr; + else + m_ostr = ostr; } -void wxLogStream::DoLogString(const char *szString) +void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { - (*m_ostr) << szString << endl << flush; + (*m_ostr) << wxConvCurrent->cWX2MB(szString) << endl << flush; } +#endif // wxUSE_STD_IOSTREAM + +#ifndef wxUSE_NOGUI // ---------------------------------------------------------------------------- // wxLogTextCtrl implementation // ---------------------------------------------------------------------------- -/* +#if wxUSE_STD_IOSTREAM wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl) - : wxLogStream(new ostream(pTextCtrl)) +#if !defined(NO_TEXT_WINDOW_STREAM) +: wxLogStream(new ostream(pTextCtrl)) +#endif { } wxLogTextCtrl::~wxLogTextCtrl() { - delete m_ostr; + delete m_ostr; } -*/ +#endif // wxUSE_STD_IOSTREAM // ---------------------------------------------------------------------------- -// wxLogGui implementation +// wxLogGui implementation (FIXME MT-unsafe) // ---------------------------------------------------------------------------- -#ifndef WX_TEST_MINIMAL - wxLogGui::wxLogGui() { - m_bErrors = FALSE; + Clear(); +} + +void wxLogGui::Clear() +{ + m_bErrors = m_bWarnings = FALSE; + m_aMessages.Empty(); + m_aTimes.Empty(); } void wxLogGui::Flush() { - if ( !m_bHasMessages ) - return; + if ( !m_bHasMessages ) + return; - // @@@ ugly... - - // concatenate all strings (but not too many to not overfill the msg box) - wxString str; - uint nLines = 0, - nMsgCount = m_aMessages.Count(); + // do it right now to block any new calls to Flush() while we're here + m_bHasMessages = FALSE; - // start from the most recent message - for ( uint n = nMsgCount; n > 0; n-- ) { - // for Windows strings longer than this value are wrapped (NT 4.0) - const uint nMsgLineWidth = 156; + // concatenate all strings (but not too many to not overfill the msg box) + wxString str; + size_t nLines = 0, + nMsgCount = m_aMessages.Count(); - nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth; + // 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; - if ( nLines > 25 ) // don't put too many lines in message box - break; + nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth; - str << m_aMessages[n - 1] << "\n"; - } + if ( nLines > 25 ) // don't put too many lines in message box + break; - if ( m_bErrors ) { - wxMessageBox(str, _("Error"), wxOK | wxICON_EXCLAMATION); - } - else { - wxMessageBox(str, _("Information"), wxOK | wxICON_INFORMATION); - } + str << m_aMessages[n - 1] << _T("\n"); + } + + const wxChar *title; + long style; - // no undisplayed messages whatsoever - m_bHasMessages = - m_bErrors = FALSE; - m_aMessages.Empty(); + if ( m_bErrors ) { + title = _("Error"); + style = wxICON_STOP; + } + else if ( m_bWarnings ) { + title = _("Warning"); + style = wxICON_EXCLAMATION; + } + else { + title = _("Information"); + style = wxICON_INFORMATION; + } + + wxMessageBox(str, title, wxOK | style); + + // no undisplayed messages whatsoever + Clear(); } // the default behaviour is to discard all informational messages if there // are any errors/warnings. -void wxLogGui::DoLog(Level level, const char *szString) -{ - switch ( level ) { - case Info: - if ( GetVerbose() ) - case Message: - if ( !m_bErrors ) { - m_aMessages.Add(szString); - m_bHasMessages = TRUE; +void wxLogGui::DoLog(wxLogLevel level, const wxChar *szString, time_t t) +{ + switch ( level ) { + case wxLOG_Info: + if ( GetVerbose() ) + case wxLOG_Message: + if ( !m_bErrors ) { + m_aMessages.Add(szString); + m_aTimes.Add((long)t); + m_bHasMessages = TRUE; + } + break; + + case wxLOG_Status: +#if wxUSE_STATUSBAR + { + // 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); + } +#endif // wxUSE_STATUSBAR + break; + + case wxLOG_Trace: + case wxLOG_Debug: + #ifdef __WXDEBUG__ + { + #ifdef __WXMSW__ + // don't prepend debug/trace here: it goes to the + // debug window anyhow, but do put a timestamp + OutputDebugString(wxString(szString) + _T("\n\r")); + #else + // send them to stderr + wxFprintf(stderr, _T("%s: %s\n"), + level == wxLOG_Trace ? _T("Trace") : _T("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: + // discard earlier informational messages if this is the 1st + // error because they might not make sense any more + if ( !m_bErrors ) { + m_aMessages.Empty(); + m_aTimes.Empty(); + m_bHasMessages = TRUE; + m_bErrors = TRUE; + } + // fall through + + case wxLOG_Warning: + if ( !m_bErrors ) { + // for the warning we don't discard the info messages + m_bWarnings = TRUE; + } + + m_aMessages.Add(szString); + m_aTimes.Add((long)t); + break; + } +} + +// ---------------------------------------------------------------------------- +// wxLogWindow and wxLogFrame implementation +// ---------------------------------------------------------------------------- + +// log frame class +// --------------- +class wxLogFrame : public wxFrame +{ +public: + // ctor & dtor + wxLogFrame(wxFrame *pParent, wxLogWindow *log, const wxChar *szTitle); + virtual ~wxLogFrame(); + + // menu callbacks + void OnClose(wxCommandEvent& event); + void OnCloseWindow(wxCloseEvent& event); +#if wxUSE_FILE + void OnSave (wxCommandEvent& event); +#endif // wxUSE_FILE + void OnClear(wxCommandEvent& event); + + void OnIdle(wxIdleEvent&); + + // accessors + wxTextCtrl *TextCtrl() const { return m_pTextCtrl; } + +private: + enum + { + Menu_Close = 100, + Menu_Save, + Menu_Clear + }; + + // instead of closing just hide the window to be able to Show() it later + void DoClose() { Show(FALSE); } + + wxTextCtrl *m_pTextCtrl; + wxLogWindow *m_log; + + DECLARE_EVENT_TABLE() +}; + +BEGIN_EVENT_TABLE(wxLogFrame, wxFrame) + // wxLogWindow menu events + EVT_MENU(Menu_Close, wxLogFrame::OnClose) +#if wxUSE_FILE + EVT_MENU(Menu_Save, wxLogFrame::OnSave) +#endif // wxUSE_FILE + EVT_MENU(Menu_Clear, wxLogFrame::OnClear) + + EVT_CLOSE(wxLogFrame::OnCloseWindow) +END_EVENT_TABLE() + +wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const wxChar *szTitle) + : wxFrame(pParent, -1, szTitle) +{ + m_log = log; + + m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition, + wxDefaultSize, + wxTE_MULTILINE | + wxHSCROLL | + wxTE_READONLY); + + // create menu + wxMenuBar *pMenuBar = new wxMenuBar; + wxMenu *pMenu = new wxMenu; +#if wxUSE_FILE + pMenu->Append(Menu_Save, _("&Save..."), _("Save log contents to file")); +#endif // wxUSE_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); + +#if wxUSE_STATUSBAR + // status bar for menu prompts + CreateStatusBar(); +#endif // wxUSE_STATUSBAR + + m_log->OnFrameCreate(this); +} + +void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event)) +{ + DoClose(); +} + +void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) +{ + DoClose(); +} + +#if wxUSE_FILE +void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event)) +{ + // get the file name + // ----------------- + const wxChar *szFileName = wxSaveFileSelector(_T("log"), _T("txt"), _T("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; + + default: + wxFAIL_MSG(_("invalid message box return value")); } - break; - - case Status: - { - // find the top window and set it's status text if it has any - wxWindow *pWin = wxTheApp->GetTopWindow(); - if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) { - wxFrame *pFrame = (wxFrame *)pWin; - pFrame->SetStatusText(szString); + + if ( bAppend ) { + bOk = file.Open(szFileName, wxFile::write_append); } - } - break; - - case Trace: - case Debug: - #ifdef __DEBUG__ - #ifdef __WIN32__ - OutputDebugString(szString); - OutputDebugString("\n\r"); - #else //!WIN32 - // send them to stderr - printf(stderr, level == Trace ? "Trace: %s\n" - : "Debug: %s\n", szString); - fflush(stderr); - #endif // WIN32 - #endif - break; - - case FatalError: - // show this one immediately - wxMessageBox(szString, "Fatal error", wxICON_HAND); - break; - - case Error: - case 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"); - } + else { + bOk = file.Create(szFileName, TRUE /* overwrite */); + } + } + 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); + } +} +#endif // wxUSE_FILE + +void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event)) +{ + m_pTextCtrl->Clear(); +} + +wxLogFrame::~wxLogFrame() +{ + m_log->OnFrameDelete(this); +} + +// wxLogWindow +// ----------- +wxLogWindow::wxLogWindow(wxFrame *pParent, + const wxChar *szTitle, + bool bShow, + bool bDoPass) +{ + m_bPassMessages = bDoPass; + + m_pLogFrame = new wxLogFrame(pParent, this, szTitle); + m_pOldLog = wxLog::SetActiveTarget(this); + + if ( bShow ) + m_pLogFrame->Show(TRUE); } -#endif //WX_TEST_MINIMAL +void wxLogWindow::Show(bool bShow) +{ + m_pLogFrame->Show(bShow); +} + +void wxLogWindow::Flush() +{ + if ( m_pOldLog != NULL ) + m_pOldLog->Flush(); + + m_bHasMessages = FALSE; +} + +void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t) +{ + // first let the previous logger show it + if ( m_pOldLog != NULL && m_bPassMessages ) { + // FIXME 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, t); + } + + if ( m_pLogFrame ) { + switch ( level ) { + case wxLOG_Status: + // by default, these messages are ignored by wxLog, so process + // them ourselves + if ( !wxIsEmpty(szString) ) + { + wxString str; + str << _("Status: ") << szString; + DoLogString(str, t); + } + 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, t); + } + } + + m_bHasMessages = TRUE; +} + +void wxLogWindow::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) +{ + // put the text into our window + wxTextCtrl *pText = m_pLogFrame->TextCtrl(); + + // remove selection (WriteText is in fact ReplaceSelection) +#ifdef __WXMSW__ + long nLen = pText->GetLastPosition(); + pText->SetSelection(nLen, nLen); +#endif // Windows + + pText->WriteText(szString); + pText->WriteText(_T("\n")); // "\n" ok here (_not_ "\r\n") + + // TODO ensure that the line can be seen +} + +wxFrame *wxLogWindow::GetFrame() const +{ + return m_pLogFrame; +} + +void wxLogWindow::OnFrameCreate(wxFrame * WXUNUSED(frame)) +{ +} + +void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame)) +{ + m_pLogFrame = (wxLogFrame *)NULL; +} + +wxLogWindow::~wxLogWindow() +{ + delete m_pOldLog; + + // may be NULL if log frame already auto destroyed itself + delete m_pLogFrame; +} + +#endif //wxUSE_NOGUI // ============================================================================ // Global functions/variables @@ -454,10 +869,12 @@ void wxLogGui::DoLog(Level level, const char *szString) // ---------------------------------------------------------------------------- // static variables // ---------------------------------------------------------------------------- -wxLog *wxLog::ms_pLogger = NULL; -bool wxLog::ms_bInitialized = FALSE; -bool wxLog::ms_bVerbose = FALSE; -const char *wxLog::ms_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; + +wxLog *wxLog::ms_pLogger = (wxLog *)NULL; +bool wxLog::ms_doLog = TRUE; +bool wxLog::ms_bAutoCreate = TRUE; +wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; +wxArrayString wxLog::ms_aTraceMasks; // ---------------------------------------------------------------------------- // stdout error logging helper @@ -466,34 +883,33 @@ const char *wxLog::ms_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; // 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 - -#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 @@ -504,108 +920,157 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) // get error code from syste unsigned long wxSysErrorCode() { - #ifdef __WINDOWS__ - #ifdef __WIN32__ - return ::GetLastError(); - #else //WIN16 - // @@@@ what to do on Windows 3.1? - return 0; - #endif //WIN16/32 - #else //Unix +#ifdef __WXMSW__ +#ifdef __WIN32__ + return ::GetLastError(); +#else //WIN16 + // TODO what to do on Windows 3.1? + return 0; +#endif //WIN16/32 +#else //Unix return errno; - #endif //Win/Unix +#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(); + if ( nErrCode == 0 ) + nErrCode = wxSysErrorCode(); -#ifdef __WINDOWS__ +#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, SIZEOF(s_szBuf) - 1); - s_szBuf[SIZEOF(s_szBuf) - 1] = '\0'; - LocalFree(lpMsgBuf); - - // returned string is capitalized and ended with '\r\n' - bad - s_szBuf[0] = (char)tolower(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'; - } + static wxChar 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 + wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1); + s_szBuf[WXSIZEOF(s_szBuf) - 1] = _T('\0'); + LocalFree(lpMsgBuf); + + // 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] == _T('\r') ) + s_szBuf[len - 2] = _T('\0'); + } - return s_szBuf; -#else - // TODO: Windows 3.1 - return NULL; -#endif + return s_szBuf; +#else //Win16 + // TODO + return NULL; +#endif // Win16/32 +#else // Unix +#if wxUSE_UNICODE + static wxChar s_szBuf[LOG_BUFFER_SIZE / 2]; + wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1); + return s_szBuf; #else - return strerror(nErrCode); + return strerror(nErrCode); #endif +#endif // Win/Unix } // ---------------------------------------------------------------------------- // debug helper // ---------------------------------------------------------------------------- -#ifdef __DEBUG__ +#ifdef __WXDEBUG__ + +// break into the debugger +void Trap() +{ +#ifdef __WXMSW__ + DebugBreak(); +#elif defined(__WXMAC__) +#if __powerc + Debugger(); +#else + SysBreak(); +#endif +#elif defined(__UNIX__) + raise(SIGTRAP); +#else + // TODO +#endif // Win/Unix +} // this function is called when an assert fails -void wxOnAssert(const char *szFile, int nLine, const char *szMsg) +void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg) { - // this variable can be set to true to suppress "assert failure" messages - static s_bNoAsserts = FALSE; + // this variable can be set to true to suppress "assert failure" messages + static bool s_bNoAsserts = FALSE; + static bool s_bInAssert = FALSE; // FIXME MT-unsafe - 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, "."); - } + if ( s_bInAssert ) { + // He-e-e-e-elp!! we're trapped in endless loop + Trap(); - // send it to the normal log destination - wxLogDebug(szBuf); + s_bInAssert = FALSE; + + return; + } + + s_bInAssert = TRUE; + + wxChar szBuf[LOG_BUFFER_SIZE]; + + // 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__ + wxSprintf(szBuf, _T("%s(%d): assert failed"), szFile, nLine); +#else // !VC++ + // make the error message more clear for all the others + wxSprintf(szBuf, _T("Assert failed in file %s at line %d"), szFile, nLine); +#endif // VC/!VC + + if ( szMsg != NULL ) { + wxStrcat(szBuf, _T(": ")); + wxStrcat(szBuf, szMsg); + } + else { + wxStrcat(szBuf, _T(".")); + } - #ifdef __WINDOWS__ if ( !s_bNoAsserts ) { - strcat(szBuf, _("\nDo you want to stop the program?" - "\nYou can also choose [Cancel] to suppress " - "further warnings.")); - - switch ( ::MessageBox(NULL, szBuf, _("Debug"), - MB_YESNOCANCEL | MB_ICONINFORMATION) ) { - case IDYES: - DebugBreak(); - break; - - case IDCANCEL: - s_bNoAsserts = TRUE; - break; - } + // send it to the normal log destination + wxLogDebug(szBuf); + +#if wxUSE_NOGUI + Trap(); +#else + // this message is intentionally not translated - it is for + // developpers only + wxStrcat(szBuf, _T("\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 } - #else - // @@@@ don't know how to start the debugger under generic Unix - s_bNoAsserts = TRUE; // suppress 'unused var' warning - abort(); - #endif + + s_bInAssert = FALSE; } -#endif //DEBUG +#endif //WXDEBUG