]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/log.cpp
fixed linkage problem
[wxWidgets.git] / src / common / log.cpp
index 72e1b385d126e45adb714398de18c325a4279462..03267bf2d3a17ab15de7720779189f6d3872e3f7 100644 (file)
 
 // 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/generic/msgdlgg.h>
+  #include  <wx/frame.h>
+  #include  <wx/msgdlg.h>
   #include  <wx/filedlg.h>
   #include  <wx/textctrl.h>
 #endif //WX_PRECOMP
@@ -51,6 +52,8 @@
 
 #ifdef  __WXMSW__
   #include  <windows.h>
+  // Redefines OutputDebugString if necessary
+  #include  "wx/msw/private.h"
 #else   //Unix
   #include  <signal.h>
 #endif  //Win/Unix
   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
 // ============================================================================
@@ -117,6 +128,24 @@ 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, ...)
 {
@@ -223,14 +252,18 @@ wxLog *wxLog::GetActiveTarget()
     if ( !s_bInGetActiveTarget ) {
       s_bInGetActiveTarget = TRUE;
 
-      #ifdef  WX_TEST_MINIMAL
+      #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;
+
       // do nothing if it fails - what can we do?
     }
   }
@@ -240,12 +273,15 @@ wxLog *wxLog::GetActiveTarget()
 
 wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
 {
-  // flush the old messages before changing
-  if ( ms_pLogger != NULL )
+  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;
 }
 
@@ -253,6 +289,9 @@ wxString wxLog::TimeStamp() const
 {
   wxString str;
 
+/* 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;
@@ -264,6 +303,7 @@ wxString wxLog::TimeStamp() const
     strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow);
     str = szBuf;
   }
+*/
 
   return str;
 }
@@ -290,8 +330,8 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
       break;
 
     case wxLOG_Info:
-      if ( GetVerbose() )
     case wxLOG_Message:
+      if ( GetVerbose() )
         DoLogString(str + szString);
       // fall through
 
@@ -302,8 +342,11 @@ void wxLog::DoLog(wxLogLevel level, const char *szString)
     case wxLOG_Trace:
     case wxLOG_Debug:
       #ifdef __WXDEBUG__
-        DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug"))
-                        << ": " << szString);
+      //        DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug"))
+      //                        << ": " << szString);
+      // JACS: we don't really want to prefix with 'Debug'. It's just extra
+      // verbiage.
+              DoLogString(szString);
       #endif
 
       break;
@@ -346,6 +389,7 @@ void wxLogStderr::DoLogString(const char *szString)
 // wxLogStream implementation
 // ----------------------------------------------------------------------------
 
+#if wxUSE_STD_IOSTREAM
 wxLogStream::wxLogStream(ostream *ostr)
 {
   if ( ostr == NULL )
@@ -358,14 +402,17 @@ void wxLogStream::DoLogString(const char *szString)
 {
   (*m_ostr) << szString << endl << flush;
 }
+#endif
+
+#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 wxUSE_STD_IOSTREAM
+wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
+// DLL mode in wxMSW, can't use it.
 #if defined(NO_TEXT_WINDOW_STREAM)
 #else
              : wxLogStream(new ostream(pTextCtrl))
@@ -377,13 +424,12 @@ wxLogTextCtrl::~wxLogTextCtrl()
 {
   delete m_ostr;
 }
+#endif
 
 // ----------------------------------------------------------------------------
 // wxLogGui implementation
 // ----------------------------------------------------------------------------
 
-#ifndef   WX_TEST_MINIMAL
-
 wxLogGui::wxLogGui()
 {
   m_bErrors = FALSE;
@@ -394,17 +440,20 @@ 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;
+
   // @@@ 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
-  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)
-    const uint nMsgLineWidth = 156;
+    const size_t nMsgLineWidth = 156;
 
     nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
 
@@ -422,7 +471,6 @@ void wxLogGui::Flush()
   }
 
   // no undisplayed messages whatsoever
-  m_bHasMessages =
   m_bErrors      = FALSE;
   m_aMessages.Empty();
 }
@@ -444,11 +492,16 @@ 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
-        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;
 
@@ -458,18 +511,22 @@ void wxLogGui::DoLog(wxLogLevel level, const char *szString)
         {
           wxString strTime = TimeStamp();
 
-          #ifdef  __WIN32__
+          #ifdef __WXMSW__
               // 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
+          #else  
             // send them to stderr
+    /*
             fprintf(stderr, "%s %s: %s\n",
                     strTime.c_str(),
                     level == wxLOG_Trace ? _("Trace") : _("Debug"),
                     szString);
+     */
+            fprintf(stderr, "%s\n",
+                    szString);
             fflush(stderr);
-          #endif  // WIN32
+          #endif
         }
       #endif
       break;
@@ -506,7 +563,7 @@ class wxLogFrame : public wxFrame
 {
 public:
   // ctor & dtor
-  wxLogFrame(wxLogWindow *log, const char *szTitle);
+  wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle);
   virtual ~wxLogFrame();
 
   // menu callbacks
@@ -544,12 +601,10 @@ BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
   EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
 
   EVT_CLOSE(wxLogFrame::OnCloseWindow)
-
-  EVT_IDLE(wxLogFrame::OnIdle)
 END_EVENT_TABLE()
 
-wxLogFrame::wxLogFrame(wxLogWindow *log, const char *szTitle)
-          : wxFrame(NULL, -1, szTitle)
+wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle)
+          : wxFrame(pParent, -1, szTitle)
 {
   m_log = log;
 
@@ -557,14 +612,10 @@ wxLogFrame::wxLogFrame(wxLogWindow *log, const char *szTitle)
   //    a rich edit control instead of a normal one we want in wxMSW
   m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition,
                                wxDefaultSize,
-                               wxSIMPLE_BORDER |
+                             //wxSIMPLE_BORDER |
                                wxTE_MULTILINE  |
                                wxHSCROLL       |
                                wxTE_READONLY);
-  /*
-  m_pTextCtrl->SetEditable(FALSE);
-  m_pTextCtrl->SetRichEdit(FALSE);
-  */
 
   // create menu
   wxMenuBar *pMenuBar = new wxMenuBar;
@@ -592,14 +643,6 @@ void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
   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))
 {
   // get the file name
@@ -613,7 +656,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
   // open file
   // ---------
   wxFile file;
-  bool bOk = FALSE; 
+  bool bOk = FALSE;
   if ( wxFile::Exists(szFileName) ) {
     bool bAppend = FALSE;
     wxString strMsg;
@@ -648,22 +691,26 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 
   // 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());
+    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
+                    );
   }
-#endif //GTK
 
   if ( bOk )
     bOk = file.Close();
 
   if ( !bOk ) {
     wxLogError(_("Can't save log contents to file."));
-    return;
+  }
+  else {
+    wxLogStatus(this, _("Log saved to the file '%s'."), szFileName);
   }
 }
 
@@ -679,11 +726,14 @@ wxLogFrame::~wxLogFrame()
 
 // wxLogWindow
 // -----------
-wxLogWindow::wxLogWindow(const char *szTitle, bool bShow, bool bDoPass)
+wxLogWindow::wxLogWindow(wxFrame *pParent,
+                         const char *szTitle,
+                         bool bShow,
+                         bool bDoPass)
 {
   m_bPassMessages = bDoPass;
 
-  m_pLogFrame = new wxLogFrame(this, szTitle);
+  m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
   m_pOldLog = wxLog::SetActiveTarget(this);
 
   if ( bShow )
@@ -700,7 +750,7 @@ void wxLogWindow::Flush()
   if ( m_pOldLog != NULL )
     m_pOldLog->Flush();
 
-  m_bHasMessages = FALSE; 
+  m_bHasMessages = FALSE;
 }
 
 void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
@@ -715,8 +765,28 @@ void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
   }
 
   if ( m_pLogFrame ) {
-    // and this will format it nicely and call our DoLogString()
-    wxLog::DoLog(level, szString);
+    switch ( level ) {
+      case wxLOG_Status:
+        // by default, these messages are ignored by wxLog, so process
+        // them ourselves
+        {
+          wxString str = TimeStamp();
+          str << _("Status: ") << szString;
+          DoLogString(str);
+        }
+        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);
+    }
   }
 
   m_bHasMessages = TRUE;
@@ -736,8 +806,7 @@ void wxLogWindow::DoLogString(const char *szString)
   pText->WriteText(szString);
   pText->WriteText("\n"); // "\n" ok here (_not_ "\r\n")
 
-  // ensure that the line can be seen
-  // @@@ TODO
+  // TODO ensure that the line can be seen
 }
 
 wxFrame *wxLogWindow::GetFrame() const
@@ -745,22 +814,24 @@ wxFrame *wxLogWindow::GetFrame() const
   return m_pLogFrame;
 }
 
-void wxLogWindow::OnFrameCreate(wxFrame *frame)
+void wxLogWindow::OnFrameCreate(wxFrame * WXUNUSED(frame))
 {
 }
 
-void wxLogWindow::OnFrameDelete(wxFrame *frame)
+void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
 {
-  m_pLogFrame = NULL;
+  m_pLogFrame = (wxLogFrame *)NULL;
 }
 
 wxLogWindow::~wxLogWindow()
 {
+  delete m_pOldLog;
+
   // may be NULL if log frame already auto destroyed itself
   delete m_pLogFrame;
 }
 
-#endif  //WX_TEST_MINIMAL
+#endif  //wxUSE_NOGUI
 
 // ============================================================================
 // Global functions/variables
@@ -769,7 +840,8 @@ wxLogWindow::~wxLogWindow()
 // ----------------------------------------------------------------------------
 // static variables
 // ----------------------------------------------------------------------------
-wxLog      *wxLog::ms_pLogger      = NULL;
+wxLog      *wxLog::ms_pLogger      = (wxLog *) NULL;
+bool        wxLog::ms_doLog        = TRUE;
 bool        wxLog::ms_bAutoCreate  = TRUE;
 wxTraceMask wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 
@@ -881,6 +953,14 @@ void Trap()
 {
   #ifdef __WXMSW__
     DebugBreak();
+  #elif defined(__WXSTUBS__)
+    // TODO
+  #elif defined(__WXMAC__)
+  #if __powerc
+    Debugger();
+  #else
+    SysBreak();
+  #endif
   #else // Unix
     raise(SIGTRAP);
   #endif // Win/Unix
@@ -896,12 +976,23 @@ void wxOnAssert(const char *szFile, int nLine, const char *szMsg)
   if ( s_bInAssert ) {
     // He-e-e-e-elp!! we're trapped in endless loop
     Trap();
+
+    return;
   }
 
   s_bInAssert = TRUE;
 
   char 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__
+  sprintf(szBuf, _("%s(%d): assert failed"), szFile, nLine);
+#else  // !VC++
+  // make the error message more clear for all the others
   sprintf(szBuf, _("Assert failed in file %s at line %d"), szFile, nLine);
+#endif // VC/!VC
+
   if ( szMsg != NULL ) {
     strcat(szBuf, ": ");
     strcat(szBuf, szMsg);
@@ -914,22 +1005,26 @@ void wxOnAssert(const char *szFile, int nLine, const char *szMsg)
     // send it to the normal log destination
     wxLogDebug(szBuf);
 
-    strcat(szBuf, _("\nDo you want to stop the program?"
-                    "\nYou can also choose [Cancel] to suppress "
-                    "further warnings."));
+    #if wxUSE_NOGUI
+      Trap();
+    #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;
+      switch ( wxMessageBox(szBuf, _("Debug"),
+                            wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
+        case wxYES:
+          Trap();
+          break;
 
-      case wxCANCEL:
-        s_bNoAsserts = TRUE;
-        break;
+        case wxCANCEL:
+          s_bNoAsserts = TRUE;
+          break;
 
-      //case wxNO: nothing to do
-    }
+        //case wxNO: nothing to do
+      }
+    #endif // USE_NOGUI
   }
 
   s_bInAssert = FALSE;