]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/log.cpp
fopen -> wxFopen and such
[wxWidgets.git] / src / common / log.cpp
index 243df81ac1adef7941ba056b3af6e25cd59da7c1..c512ffc3f2a54eb8c91061cf78e9fe990b3a1250 100644 (file)
@@ -16,6 +16,7 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
+
 #ifdef __GNUG__
   #pragma implementation "log.h"
 #endif
 
 // wxWindows
 #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/string.h"
+    #include "wx/intl.h"
+    #include "wx/app.h"
+
+    #if wxUSE_GUI
+        #include "wx/window.h"
+        #ifdef __WXMSW__
+            #include "wx/msw/private.h"
+        #endif
+        #include "wx/msgdlg.h"
+    #endif
 #endif //WX_PRECOMP
 
-#include  <wx/file.h>
-#include  <wx/textfile.h>
-#include  <wx/utils.h>
-#include  <wx/log.h>
+#include  "wx/file.h"
+#include  "wx/textfile.h"
+#include  "wx/utils.h"
+#include  "wx/wxchar.h"
+#include  "wx/log.h"
 
 // other standard headers
 #include  <errno.h>
   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
 // ============================================================================
@@ -128,24 +124,6 @@ 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 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, ...)
 {
@@ -271,15 +249,11 @@ wxLog *wxLog::GetActiveTarget()
         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
 
             s_bInGetActiveTarget = FALSE;
 
@@ -311,6 +285,20 @@ void wxLog::RemoveTraceMask(const wxString& str)
         ms_aTraceMasks.Remove((size_t)index);
 }
 
+void wxLog::TimeStamp(wxString *str)
+{
+    if ( ms_timestamp )
+    {
+        wxChar buf[256];
+        time_t timeNow;
+        (void)time(&timeNow);
+        wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
+
+        str->Empty();
+        *str << buf << wxT(": ");
+    }
+}
+
 void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 {
     switch ( level ) {
@@ -332,12 +320,9 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
         case wxLOG_Info:
             if ( GetVerbose() )
         case wxLOG_Message:
+        case wxLOG_Status:
         default:    // log unknown log levels too
                 DoLogString(szString, t);
-            // fall through
-
-        case wxLOG_Status:
-            // nothing to do
             break;
 
         case wxLOG_Trace:
@@ -349,9 +334,9 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
     }
 }
 
-void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t t)
+void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
 {
-    wxFAIL_MSG(_T("DoLogString must be overriden if it's called."));
+    wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
 }
 
 void wxLog::Flush()
@@ -371,10 +356,11 @@ wxLogStderr::wxLogStderr(FILE *fp)
         m_fp = fp;
 }
 
-void wxLogStderr::DoLogString(const wxChar *szString, time_t t)
+void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {
-    wxString str(szString);
-    str << _T('\n');
+    wxString str;
+    TimeStamp(&str);
+    str << szString << wxT('\n');
 
     fputs(str.mb_str(), m_fp);
     fflush(m_fp);
@@ -382,7 +368,7 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t t)
     // under Windows, programs usually don't have stderr at all, so make show the
     // messages also under debugger
 #ifdef __WXMSW__
-    OutputDebugString(str + _T('\r'));
+    OutputDebugString(str + wxT('\r'));
 #endif // MSW
 }
 
@@ -399,453 +385,12 @@ wxLogStream::wxLogStream(ostream *ostr)
         m_ostr = ostr;
 }
 
-void wxLogStream::DoLogString(const wxChar *szString, time_t t)
-{
-    (*m_ostr) << wxConv_libc.cWX2MB(szString) << endl << flush;
-}
-#endif // wxUSE_STD_IOSTREAM
-
-#ifndef wxUSE_NOGUI
-
-// ----------------------------------------------------------------------------
-// wxLogTextCtrl implementation
-// ----------------------------------------------------------------------------
-
-#if wxUSE_STD_IOSTREAM
-wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
-#if !defined(NO_TEXT_WINDOW_STREAM)
-: wxLogStream(new ostream(pTextCtrl))
-#endif
-{
-}
-
-wxLogTextCtrl::~wxLogTextCtrl()
+void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {
-    delete m_ostr;
+    (*m_ostr) << wxConvertWX2MB(szString) << endl;
 }
 #endif // wxUSE_STD_IOSTREAM
 
-// ----------------------------------------------------------------------------
-// wxLogGui implementation (FIXME MT-unsafe)
-// ----------------------------------------------------------------------------
-
-wxLogGui::wxLogGui()
-{
-    Clear();
-}
-
-void wxLogGui::Clear()
-{
-    m_bErrors = m_bWarnings = FALSE;
-    m_aMessages.Empty();
-    m_aTimes.Empty();
-}
-
-void wxLogGui::Flush()
-{
-    if ( !m_bHasMessages )
-        return;
-
-    // do it right now to block any new calls to Flush() while we're here
-    m_bHasMessages = FALSE;
-
-    // concatenate all strings (but not too many to not overfill the msg box)
-    wxString str;
-    size_t nLines = 0,
-    nMsgCount = m_aMessages.Count();
-
-    // 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;
-
-        nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
-
-        if ( nLines > 25 )  // don't put too many lines in message box
-            break;
-
-        str << m_aMessages[n - 1] << _T("\n");
-    }
-
-    const wxChar *title;
-    long style;
-
-    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(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:
-                {
-                    // 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;
-
-        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);
-    void OnSave (wxCommandEvent& event);
-    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)
-    EVT_MENU(Menu_Save,  wxLogFrame::OnSave)
-    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;
-    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);
-}
-
-void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
-{
-    DoClose();
-}
-
-void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
-{
-    DoClose();
-}
-
-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"));
-        }
-
-        if ( bAppend ) {
-            bOk = file.Open(szFileName, wxFile::write_append);
-        }
-        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);
-    }
-}
-
-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);
-}
-
-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 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
 // ============================================================================
@@ -857,6 +402,9 @@ wxLogWindow::~wxLogWindow()
 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 bool            wxLog::ms_doLog        = TRUE;
 bool            wxLog::ms_bAutoCreate  = TRUE;
+
+const wxChar   *wxLog::ms_timestamp    = wxT("%X");  // time only, no date
+
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 wxArrayString   wxLog::ms_aTraceMasks;
 
@@ -936,7 +484,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 
     // 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');
+    s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
     LocalFree(lpMsgBuf);
 
     // returned string is capitalized and ended with '\r\n' - bad
@@ -944,8 +492,8 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
     size_t len = wxStrlen(s_szBuf);
     if ( len > 0 ) {
         // truncate string
-        if ( s_szBuf[len - 2] == _T('\r') )
-            s_szBuf[len - 2] = _T('\0');
+        if ( s_szBuf[len - 2] == wxT('\r') )
+            s_szBuf[len - 2] = wxT('\0');
     }
 
     return s_szBuf;
@@ -956,7 +504,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 #else   // Unix
 #if wxUSE_UNICODE
     static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
-    wxConv_libc.MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
+    wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
     return s_szBuf;
 #else
     return strerror(nErrCode);
@@ -1011,30 +559,28 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
     // 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);
+    wxSprintf(szBuf, wxT("%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);
+    wxSprintf(szBuf, wxT("Assert failed in file %s at line %d"), szFile, nLine);
 #endif // VC/!VC
 
     if ( szMsg != NULL ) {
-        wxStrcat(szBuf, _T(": "));
+        wxStrcat(szBuf, wxT(": "));
         wxStrcat(szBuf, szMsg);
     }
     else {
-        wxStrcat(szBuf, _T("."));
+        wxStrcat(szBuf, wxT("."));
     }
 
     if ( !s_bNoAsserts ) {
         // send it to the normal log destination
         wxLogDebug(szBuf);
 
-#if wxUSE_NOGUI
-        Trap();
-#else
+#if wxUSE_GUI
         // this message is intentionally not translated - it is for
         // developpers only
-        wxStrcat(szBuf, _T("\nDo you want to stop the program?"
+        wxStrcat(szBuf, wxT("\nDo you want to stop the program?"
                 "\nYou can also choose [Cancel] to suppress "
                 "further warnings."));
 
@@ -1050,7 +596,9 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
 
                 //case wxNO: nothing to do
         }
-#endif // USE_NOGUI
+#else // !GUI
+        Trap();
+#endif // GUI/!GUI
     }
 
     s_bInAssert = FALSE;