some minor changes in wxLogWindow

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@478 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/log.h b/include/wx/log.h
index c4550d25fd2b8a6f6188d610b4fe3a28e285a738..22acfb9e512d0f95cea6474fcf38670f923b72f8 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -16,8 +16,6 @@
 #pragma interface "log.h"
 #endif
 
-#include "wx/intl.h"
-
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -122,6 +120,10 @@ protected:
     // you override DoLog() you might not need it at all
   virtual void DoLogString(const char *szString);
 
+  // helpers
+    // put the time stamp in the current format into the string
+  wxString TimeStamp() const;
+
 private:
   // static variables
   // ----------------
@@ -211,7 +213,7 @@ public:
   // window operations
     // show/hide the log window
   void Show(bool bShow = TRUE);
-    // get the frame pointer (you shouldn't close it!)
+    // retrieve the pointer to the frame
   wxFrame *GetFrame() const;
 
   // accessors
@@ -225,6 +227,17 @@ public:
   // processing take place)
   void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
+  // base class virtuals
+    // we don't need it ourselves, but we pass it to the previous logger
+  virtual void Flush();
+
+  // overridables
+    // called immediately after the log frame creation allowing for
+    // any extra initializations
+  virtual void OnFrameCreate(wxFrame *frame);
+    // called right before the log frame is going to be deleted
+  virtual void OnFrameDelete(wxFrame *frame);
+
 protected:
   virtual void DoLog(wxLogLevel level, const char *szString);
   virtual void DoLogString(const char *szString);

diff --git a/src/common/log.cpp b/src/common/log.cpp
index d319ce666b4312731c7a79ac13020ab9833b86c0..d1e30401d462b7ae3952d809987e6440e3deeb55 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -249,11 +249,10 @@ wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
   return pOldLogger;
 }
 
-void wxLog::DoLog(wxLogLevel level, const char *szString)
+wxString wxLog::TimeStamp() const
 {
   wxString str;
 
-  // prepend a timestamp if not disabled
   if ( !IsEmpty(m_szTimeFormat) ) {
     char szBuf[128];
     time_t timeNow;
@@ -266,6 +265,14 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
     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);
@@ -295,11 +302,6 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
     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
@@ -453,15 +455,22 @@ void wxLogGui::DoLog(wxLogLevel level, const char *szString)
     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();
+
+          #ifdef  __WIN32__
+              // 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;
 
@@ -488,15 +497,17 @@ void wxLogGui::DoLog(wxLogLevel level, const char *szString)
 }
 
 // ----------------------------------------------------------------------------
-// wxLogWindow implementation
+// wxLogWindow and wxLogFrame implementation
 // ----------------------------------------------------------------------------
 
 // log frame class
+// ---------------
 class wxLogFrame : public wxFrame
 {
 public:
-  // ctor
-  wxLogFrame(const char *szTitle);
+  // ctor & dtor
+  wxLogFrame(wxLogWindow *log, const char *szTitle);
+  virtual ~wxLogFrame();
 
   // menu callbacks
   void OnClose(wxCommandEvent& event);
@@ -504,6 +515,8 @@ public:
   void OnSave (wxCommandEvent& event);
   void OnClear(wxCommandEvent& event);
 
+  void OnIdle(wxIdleEvent&);
+
   // accessors
   wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
 
@@ -515,7 +528,11 @@ private:
     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()
 };
@@ -527,17 +544,17 @@ BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
   EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
 
   EVT_CLOSE(wxLogFrame::OnCloseWindow)
+
+  EVT_IDLE(wxLogFrame::OnIdle)
 END_EVENT_TABLE()
 
-wxLogFrame::wxLogFrame(const char *szTitle)
+wxLogFrame::wxLogFrame(wxLogWindow *log, const char *szTitle)
           : wxFrame(NULL, -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
-  //    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,
                                wxSIMPLE_BORDER |
@@ -552,26 +569,35 @@ wxLogFrame::wxLogFrame(const char *szTitle)
   // 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->Append(Menu_Close, _("&Close"));
+  pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
   pMenuBar->Append(pMenu, _("&Log"));
   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))
 {
-  // just hide the window
-  Show(FALSE);
+  DoClose();
 }
 
 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 {
-  // just hide the window
-  Show(FALSE);
+  DoClose();
+}
+
+void wxLogFrame::OnIdle(wxIdleEvent& WXUNUSED(event))
+{
+  // if we're the last frame to stay, delete log frame letting the 
+  // application to close
+  if ( wxTopLevelWindows.Number() == 1 )
+    Destroy();
 }
 
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
@@ -646,11 +672,18 @@ void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
   m_pTextCtrl->Clear();
 }
 
+wxLogFrame::~wxLogFrame()
+{
+  m_log->OnFrameDelete(this);
+}
+
+// wxLogWindow
+// -----------
 wxLogWindow::wxLogWindow(const char *szTitle, bool bShow, bool bDoPass)
 {
   m_bPassMessages = bDoPass;
 
-  m_pLogFrame = new wxLogFrame(szTitle);
+  m_pLogFrame = new wxLogFrame(this, szTitle);
   m_pOldLog = wxLog::SetActiveTarget(this);
 
   if ( bShow )
@@ -662,9 +695,12 @@ void wxLogWindow::Show(bool 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)
@@ -680,6 +716,8 @@ void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
 
   // and this will format it nicely and call our DoLogString()
   wxLog::DoLog(level, szString);
+
+  m_bHasMessages = TRUE;
 }
 
 void wxLogWindow::DoLogString(const char *szString)
@@ -700,9 +738,27 @@ void wxLogWindow::DoLogString(const char *szString)
   // @@@ TODO
 }
 
+wxFrame *wxLogWindow::GetFrame() const
+{
+  return m_pLogFrame;
+}
+
+void wxLogWindow::OnFrameCreate(wxFrame *frame)
+{
+}
+
+void wxLogWindow::OnFrameDelete(wxFrame *frame)
+{
+  m_pLogFrame = NULL;
+}
+
 wxLogWindow::~wxLogWindow()
 {
-  m_pLogFrame->Close(TRUE);
+  // may be NULL if log frame already auto destroyed itself
+  delete m_pLogFrame;
+
+  // delete the old log
+  delete m_pOldLog;
 }
 
 #endif  //WX_TEST_MINIMAL