* Fixed two memory leaks.

[wxWidgets.git] / src / common / log.cpp

diff --git a/src/common/log.cpp b/src/common/log.cpp
index b3bc58fbdbe3b31de1347ff873311070c910b250..bf1994214fc12528ab0d24501e432fab98238f6e 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -33,6 +33,7 @@
   #include  <wx/string.h>
   #include  <wx/intl.h>
   #include  <wx/menu.h>
   #include  <wx/string.h>
   #include  <wx/intl.h>
   #include  <wx/menu.h>

+  #include  <wx/frame.h>

 
   #include  <wx/generic/msgdlgg.h>
   #include  <wx/filedlg.h>
 
   #include  <wx/generic/msgdlgg.h>
   #include  <wx/filedlg.h>


@@ -66,6 +67,14 @@
   static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
 #endif
 
   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;
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -117,6 +126,24 @@ IMPLEMENT_LOG_FUNCTION(Message)
 IMPLEMENT_LOG_FUNCTION(Info)
 IMPLEMENT_LOG_FUNCTION(Status)
 
 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, ...)
 {
 // same as info, but only if 'verbose' mode is on
 void wxLogVerbose(const char *szFormat, ...)
 {


@@ -153,7 +180,7 @@ void wxLogVerbose(const char *szFormat, ...)
     // 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.
     // 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) ) {
+    if ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {

       va_list argptr;
       va_start(argptr, szFormat);
       vsprintf(s_szBuf, szFormat, argptr);
       va_list argptr;
       va_start(argptr, szFormat);
       vsprintf(s_szBuf, szFormat, argptr);


@@ -249,11 +276,10 @@ wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
   return pOldLogger;
 }
 
   return pOldLogger;
 }
 

-void wxLog::DoLog(wxLogLevel level, const char *szString)
+wxString wxLog::TimeStamp() const

 {
   wxString str;
 
 {
   wxString str;
 

-  // prepend a timestamp if not disabled

   if ( !IsEmpty(m_szTimeFormat) ) {
     char szBuf[128];
     time_t timeNow;
   if ( !IsEmpty(m_szTimeFormat) ) {
     char szBuf[128];
     time_t timeNow;


@@ -266,6 +292,14 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
     str = szBuf;
   }
 
     str = szBuf;
   }
 

+  return str;
+}
+
+void wxLog::DoLog(wxLogLevel level, const char *szString)
+{
+  // prepend a timestamp if not disabled
+  wxString str = TimeStamp();
+

   switch ( level ) {
     case wxLOG_FatalError:
       DoLogString(str << _("Fatal error: ") << szString);
   switch ( level ) {
     case wxLOG_FatalError:
       DoLogString(str << _("Fatal error: ") << szString);


@@ -295,11 +329,6 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
     case wxLOG_Trace:
     case wxLOG_Debug:
       #ifdef __WXDEBUG__
     case wxLOG_Trace:
     case wxLOG_Debug:
       #ifdef __WXDEBUG__

-        #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 == wxLOG_Trace ? _("Trace") : _("Debug"))
                         << ": " << szString);
       #endif
         DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug"))
                         << ": " << szString);
       #endif


@@ -307,13 +336,13 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
       break;
 
     default:
       break;
 
     default:

-      wxFAIL_MSG("unknown log level in wxLog::DoLog");
+      wxFAIL_MSG(_("unknown log level in wxLog::DoLog"));

   }
 }
 
 void wxLog::DoLogString(const char *WXUNUSED(szString))
 {
   }
 }
 
 void wxLog::DoLogString(const char *WXUNUSED(szString))
 {

-  wxFAIL_MSG("DoLogString must be overrided if it's called.");
+  wxFAIL_MSG(_("DoLogString must be overrided if it's called."));

 }
 
 void wxLog::Flush()
 }
 
 void wxLog::Flush()


@@ -392,17 +421,20 @@ void wxLogGui::Flush()
   if ( !m_bHasMessages )
     return;
 
   if ( !m_bHasMessages )
     return;
 

+  // do it right now to block any new calls to Flush() while we're here
+  m_bHasMessages = FALSE;
+  

   // @@@ ugly...
 
   // concatenate all strings (but not too many to not overfill the msg box)
   wxString str;
   // @@@ ugly...
 
   // concatenate all strings (but not too many to not overfill the msg box)
   wxString str;

-  uint nLines    = 0,
+  size_t nLines    = 0,

        nMsgCount = m_aMessages.Count();
 
   // start from the most recent message
        nMsgCount = m_aMessages.Count();
 
   // start from the most recent message

-  for ( uint n = nMsgCount; n > 0; n-- ) {
+  for ( size_t n = nMsgCount; n > 0; n-- ) {

     // for Windows strings longer than this value are wrapped (NT 4.0)
     // for Windows strings longer than this value are wrapped (NT 4.0)

-    const uint nMsgLineWidth = 156;
+    const size_t nMsgLineWidth = 156;

 
     nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
 
 
     nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
 


@@ -420,7 +452,6 @@ void wxLogGui::Flush()
   }
 
   // no undisplayed messages whatsoever
   }
 
   // no undisplayed messages whatsoever

-  m_bHasMessages =

   m_bErrors      = FALSE;
   m_aMessages.Empty();
 }
   m_bErrors      = FALSE;
   m_aMessages.Empty();
 }


@@ -442,26 +473,38 @@ void wxLogGui::DoLog(wxLogLevel level, const char *szString)
     case wxLOG_Status:
       {
         // find the top window and set it's status text if it has any
     case wxLOG_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);
+        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__
       }
       break;
 
     case wxLOG_Trace:
     case wxLOG_Debug:
       #ifdef __WXDEBUG__

-        #ifdef  __WIN32__
-          OutputDebugString(szString);
-          OutputDebugString("\n\r");
-        #else   //!WIN32
-          // send them to stderr
-          fprintf(stderr, "%s: %s\n",
-                  level == wxLOG_Trace ? _("Trace") : _("Debug"), szString);
-          fflush(stderr);
-        #endif  // WIN32
+        {
+          wxString strTime = TimeStamp();
+
+          #if defined(__WIN32__) && !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;
 
       #endif
       break;
 


@@ -483,20 +526,22 @@ void wxLogGui::DoLog(wxLogLevel level, const char *szString)
       break;
 
     default:
       break;
 
     default:

-      wxFAIL_MSG("unknown log level in wxLogGui::DoLog");
+      wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog"));

   }
 }
 
 // ----------------------------------------------------------------------------
   }
 }
 
 // ----------------------------------------------------------------------------

-// wxLogWindow implementation
+// wxLogWindow and wxLogFrame implementation

 // ----------------------------------------------------------------------------
 
 // log frame class
 // ----------------------------------------------------------------------------
 
 // log frame class

+// ---------------

 class wxLogFrame : public wxFrame
 {
 public:
 class wxLogFrame : public wxFrame
 {
 public:

-  // ctor
-  wxLogFrame(const char *szTitle);
+  // ctor & dtor
+  wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle);
+  virtual ~wxLogFrame();

 
   // menu callbacks
   void OnClose(wxCommandEvent& event);
 
   // menu callbacks
   void OnClose(wxCommandEvent& event);


@@ -504,6 +549,8 @@ public:
   void OnSave (wxCommandEvent& event);
   void OnClear(wxCommandEvent& event);
 
   void OnSave (wxCommandEvent& event);
   void OnClear(wxCommandEvent& event);
 

+  void OnIdle(wxIdleEvent&);
+

   // accessors
   wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
 
   // accessors
   wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
 


@@ -515,7 +562,11 @@ private:
     Menu_Clear
   };
 
     Menu_Clear
   };
 

-  wxTextCtrl *m_pTextCtrl;
+  // 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()
 };
 
   DECLARE_EVENT_TABLE()
 };


@@ -529,49 +580,44 @@ BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
   EVT_CLOSE(wxLogFrame::OnCloseWindow)
 END_EVENT_TABLE()
 
   EVT_CLOSE(wxLogFrame::OnCloseWindow)
 END_EVENT_TABLE()
 

-wxLogFrame::wxLogFrame(const char *szTitle)
-          : wxFrame(NULL, -1, szTitle)
+wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle)
+          : wxFrame(pParent, -1, szTitle)

 {
 {

-  // we don't want to be a top-level frame because it would prevent the
-  // application termination when all other frames are closed
-  wxTopLevelWindows.DeleteObject(this);
+  m_log = log;

 
   // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating
 
   // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating

-  //    a rich edit control instead of a normal one we want
+  //    a rich edit control instead of a normal one we want in wxMSW

   m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition,
                                wxDefaultSize,
   m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition,
                                wxDefaultSize,

-                               wxSIMPLE_BORDER |
+                             //wxSIMPLE_BORDER |

                                wxTE_MULTILINE  |
                                wxHSCROLL       |
                                wxTE_READONLY);
                                wxTE_MULTILINE  |
                                wxHSCROLL       |
                                wxTE_READONLY);

-  /*
-  m_pTextCtrl->SetEditable(FALSE);
-  m_pTextCtrl->SetRichEdit(FALSE);
-  */

 
   // create menu
   wxMenuBar *pMenuBar = new wxMenuBar;
   wxMenu *pMenu = new wxMenu;
 
   // create menu
   wxMenuBar *pMenuBar = new wxMenuBar;
   wxMenu *pMenu = new wxMenu;

-  pMenu->Append(Menu_Save,  "&Save...");
-  pMenu->Append(Menu_Clear, "C&lear");
+  pMenu->Append(Menu_Save,  _("&Save..."), _("Save log contents to file"));
+  pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));

   pMenu->AppendSeparator();
   pMenu->AppendSeparator();

-  pMenu->Append(Menu_Close, "&Close");
-  pMenuBar->Append(pMenu, "&Log");
+  pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
+  pMenuBar->Append(pMenu, _("&Log"));

   SetMenuBar(pMenuBar);
 
   SetMenuBar(pMenuBar);
 

-  // @@ what about status bar? needed (for menu prompts)?
+  // status bar for menu prompts
+  CreateStatusBar();
+
+  m_log->OnFrameCreate(this);

 }
 
 void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 {
 }
 
 void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 {

-  // just hide the window
-  Show(FALSE);
+  DoClose();

 }
 
 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 {
 }
 
 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 {

-  // just hide the window
-  Show(FALSE);
+  DoClose();

 }
 
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 }
 
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))


@@ -593,7 +639,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
     wxString strMsg;
     strMsg.Printf(_("Append log to file '%s' "
                     "(choosing [No] will overwrite it)?"), szFileName);
     wxString strMsg;
     strMsg.Printf(_("Append log to file '%s' "
                     "(choosing [No] will overwrite it)?"), szFileName);

-    switch ( wxMessageBox(strMsg, "Question", wxYES_NO | wxCANCEL) ) {
+    switch ( wxMessageBox(strMsg, _("Question"), wxYES_NO | wxCANCEL) ) {

       case wxYES:
         bAppend = TRUE;
         break;
       case wxYES:
         bAppend = TRUE;
         break;


@@ -606,7 +652,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
         return;
 
       default:
         return;
 
       default:

-        wxFAIL_MSG("invalid message box return value");
+        wxFAIL_MSG(_("invalid message box return value"));

     }
 
     if ( bAppend ) {
     }
 
     if ( bAppend ) {


@@ -624,7 +670,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
   // -------------------------
 #ifdef __WXGTK__
   // @@@@ TODO: no GetNumberOfLines and GetLineText in wxGTK yet
   // -------------------------
 #ifdef __WXGTK__
   // @@@@ TODO: no GetNumberOfLines and GetLineText in wxGTK yet

-  wxLogError("Sorry, this function is not implemented under GTK");
+  wxLogError(_("Sorry, this function is not implemented under GTK"));

 #else
   int nLines = m_pTextCtrl->GetNumberOfLines();
   for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
 #else
   int nLines = m_pTextCtrl->GetNumberOfLines();
   for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {


@@ -646,10 +692,22 @@ void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
   m_pTextCtrl->Clear();
 }
 
   m_pTextCtrl->Clear();
 }
 

-wxLogWindow::wxLogWindow(const char *szTitle, bool bShow)
+wxLogFrame::~wxLogFrame()

 {
 {

-  m_pOldLog = wxLog::GetActiveTarget();
-  m_pLogFrame = new wxLogFrame(szTitle);
+  m_log->OnFrameDelete(this);
+}
+
+// wxLogWindow
+// -----------
+wxLogWindow::wxLogWindow(wxFrame *pParent,
+                         const char *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);
 
   if ( bShow )
     m_pLogFrame->Show(TRUE);


@@ -660,15 +718,18 @@ void wxLogWindow::Show(bool bShow)
   m_pLogFrame->Show(bShow);
 }
 
   m_pLogFrame->Show(bShow);
 }
 

-wxFrame *wxLogWindow::GetFrame() const
+void wxLogWindow::Flush()

 {
 {

-  return m_pLogFrame;
+  if ( m_pOldLog != NULL )
+    m_pOldLog->Flush();
+
+  m_bHasMessages = FALSE; 

 }
 
 void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
 {
   // first let the previous logger show it
 }
 
 void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
 {
   // first let the previous logger show it

-  if ( m_pOldLog != NULL ) {
+  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
     // @@@ 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


@@ -676,8 +737,16 @@ void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
     ((wxLogWindow *)m_pOldLog)->DoLog(level, szString);
   }
 
     ((wxLogWindow *)m_pOldLog)->DoLog(level, szString);
   }
 

-  // and this will format it nicely and call our DoLogString()
-  wxLog::DoLog(level, szString);
+  // 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
+  if ( m_pLogFrame && level != wxLOG_Trace ) {
+    // and this will format it nicely and call our DoLogString()
+    wxLog::DoLog(level, szString);
+  }
+
+  m_bHasMessages = TRUE;

 }
 
 void wxLogWindow::DoLogString(const char *szString)
 }
 
 void wxLogWindow::DoLogString(const char *szString)


@@ -698,9 +767,24 @@ void wxLogWindow::DoLogString(const char *szString)
   // @@@ TODO
 }
 
   // @@@ TODO
 }
 

+wxFrame *wxLogWindow::GetFrame() const
+{
+  return m_pLogFrame;
+}
+
+void wxLogWindow::OnFrameCreate(wxFrame *frame)
+{
+}
+
+void wxLogWindow::OnFrameDelete(wxFrame *frame)
+{
+  m_pLogFrame = (wxLogFrame *) NULL;
+}
+

 wxLogWindow::~wxLogWindow()
 {
 wxLogWindow::~wxLogWindow()
 {

-  m_pLogFrame->Close(TRUE);
+  // may be NULL if log frame already auto destroyed itself
+  delete m_pLogFrame;

 }
 
 #endif  //WX_TEST_MINIMAL
 }
 
 #endif  //WX_TEST_MINIMAL


@@ -712,7 +796,7 @@ wxLogWindow::~wxLogWindow()
 // ----------------------------------------------------------------------------
 // static variables
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // static variables
 // ----------------------------------------------------------------------------

-wxLog      *wxLog::ms_pLogger      = NULL;
+wxLog      *wxLog::ms_pLogger      = (wxLog *) NULL;

 bool        wxLog::ms_bAutoCreate  = TRUE;
 wxTraceMask wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 
 bool        wxLog::ms_bAutoCreate  = TRUE;
 wxTraceMask wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 


@@ -824,6 +908,8 @@ void Trap()
 {
   #ifdef __WXMSW__
     DebugBreak();
 {
   #ifdef __WXMSW__
     DebugBreak();

+  #elif defined(__WXSTUBS__)
+    // TODO

   #else // Unix
     raise(SIGTRAP);
   #endif // Win/Unix
   #else // Unix
     raise(SIGTRAP);
   #endif // Win/Unix