src/common/log.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        log.cpp
   3 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19 #ifdef __GNUG__
  20   #pragma implementation "log.h"
  21 #endif
  22
  23 // For compilers that support precompilation, includes "wx.h".
  24 #include "wx/wxprec.h"
  25
  26 #ifdef __BORLANDC__
  27   #pragma hdrstop
  28 #endif
  29
  30 // wxWindows
  31 #ifndef WX_PRECOMP
  32   #include  <wx/app.h>
  33   #include  <wx/string.h>
  34   #include  <wx/intl.h>
  35   #include  <wx/menu.h>
  36   #include  <wx/frame.h>
  37
  38   #include  <wx/generic/msgdlgg.h>
  39   #include  <wx/filedlg.h>
  40   #include  <wx/textctrl.h>
  41 #endif //WX_PRECOMP
  42
  43 #include  <wx/file.h>
  44 #include  <wx/textfile.h>
  45 #include  <wx/utils.h>
  46 #include  <wx/log.h>
  47
  48 // other standard headers
  49 #include  <errno.h>
  50 #include  <stdlib.h>
  51 #include  <time.h>
  52
  53 #ifdef  __WXMSW__
  54   #include  <windows.h>
  55 #else   //Unix
  56   #include  <signal.h>
  57 #endif  //Win/Unix
  58
  59 // ----------------------------------------------------------------------------
  60 // non member functions
  61 // ----------------------------------------------------------------------------
  62
  63 // define this to enable wrapping of log messages
  64 //#define LOG_PRETTY_WRAP
  65
  66 #ifdef  LOG_PRETTY_WRAP
  67   static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
  68 #endif
  69
  70 // ----------------------------------------------------------------------------
  71 // global variables
  72 // ----------------------------------------------------------------------------
  73
  74 // we use a global variable to store the frame pointer for wxLogStatus - bad,
  75 // but it's he easiest way
  76 static wxFrame *gs_pFrame;
  77
  78 // ============================================================================
  79 // implementation
  80 // ============================================================================
  81
  82 // ----------------------------------------------------------------------------
  83 // implementation of Log functions
  84 //
  85 // NB: unfortunately we need all these distinct functions, we can't make them
  86 //     macros and not all compilers inline vararg functions.
  87 // ----------------------------------------------------------------------------
  88
  89 // log functions can't allocate memory (LogError("out of memory...") should
  90 // work!), so we use a static buffer for all log messages
  91 #define LOG_BUFFER_SIZE   (4096)
  92
  93 // static buffer for error messages (@@@ MT-unsafe)
  94 static char s_szBuf[LOG_BUFFER_SIZE];
  95
  96 // generic log function
  97 void wxLogGeneric(wxLogLevel level, const char *szFormat, ...)
  98 {
  99   if ( wxLog::GetActiveTarget() != NULL ) {
 100     va_list argptr;
 101     va_start(argptr, szFormat);
 102     vsprintf(s_szBuf, szFormat, argptr);
 103     va_end(argptr);
 104
 105     wxLog::OnLog(level, s_szBuf);
 106   }
 107 }
 108
 109 #define IMPLEMENT_LOG_FUNCTION(level)                             \
 110   void wxLog##level(const char *szFormat, ...)                    \
 111   {                                                               \
 112     if ( wxLog::GetActiveTarget() != NULL ) {                     \
 113       va_list argptr;                                             \
 114       va_start(argptr, szFormat);                                 \
 115       vsprintf(s_szBuf, szFormat, argptr);                        \
 116       va_end(argptr);                                             \
 117                                                                   \
 118       wxLog::OnLog(wxLOG_##level, s_szBuf);                       \
 119     }                                                             \
 120   }
 121
 122 IMPLEMENT_LOG_FUNCTION(FatalError)
 123 IMPLEMENT_LOG_FUNCTION(Error)
 124 IMPLEMENT_LOG_FUNCTION(Warning)
 125 IMPLEMENT_LOG_FUNCTION(Message)
 126 IMPLEMENT_LOG_FUNCTION(Info)
 127 IMPLEMENT_LOG_FUNCTION(Status)
 128
 129 // accepts an additional argument which tells to which frame the output should
 130 // be directed
 131 void wxLogStatus(wxFrame *pFrame, const char *szFormat, ...)
 132 {
 133   wxLog *pLog = wxLog::GetActiveTarget();
 134   if ( pLog != NULL ) {
 135     va_list argptr;
 136     va_start(argptr, szFormat);
 137     vsprintf(s_szBuf, szFormat, argptr);
 138     va_end(argptr);
 139
 140     wxASSERT( gs_pFrame == NULL ); // should be reset!
 141     gs_pFrame = pFrame;
 142     wxLog::OnLog(wxLOG_Status, s_szBuf);
 143     gs_pFrame = (wxFrame *) NULL;
 144   }
 145 }
 146
 147 // same as info, but only if 'verbose' mode is on
 148 void wxLogVerbose(const char *szFormat, ...)
 149 {
 150   wxLog *pLog = wxLog::GetActiveTarget();
 151   if ( pLog != NULL && pLog->GetVerbose() ) {
 152     va_list argptr;
 153     va_start(argptr, szFormat);
 154     vsprintf(s_szBuf, szFormat, argptr);
 155     va_end(argptr);
 156
 157     wxLog::OnLog(wxLOG_Info, s_szBuf);
 158   }
 159 }
 160
 161 // debug functions
 162 #ifdef __WXDEBUG__
 163 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                       \
 164   void wxLog##level(const char *szFormat, ...)                    \
 165   {                                                               \
 166     if ( wxLog::GetActiveTarget() != NULL ) {                     \
 167       va_list argptr;                                             \
 168       va_start(argptr, szFormat);                                 \
 169       vsprintf(s_szBuf, szFormat, argptr);                        \
 170       va_end(argptr);                                             \
 171                                                                   \
 172       wxLog::OnLog(wxLOG_##level, s_szBuf);                       \
 173     }                                                             \
 174   }
 175
 176   void wxLogTrace(wxTraceMask mask, const char *szFormat, ...)
 177   {
 178     wxLog *pLog = wxLog::GetActiveTarget();
 179
 180     // we check that all of mask bits are set in the current mask, so
 181     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
 182     // if both bits are set.
 183     if ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {
 184       va_list argptr;
 185       va_start(argptr, szFormat);
 186       vsprintf(s_szBuf, szFormat, argptr);
 187       va_end(argptr);
 188
 189       wxLog::OnLog(wxLOG_Trace, s_szBuf);
 190     }
 191   }
 192
 193 #else // release
 194   #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
 195 #endif
 196
 197 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
 198 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 199
 200 // wxLogSysError: one uses the last error code, for other  you must give it
 201 // explicitly
 202
 203 // common part of both wxLogSysError
 204 void wxLogSysErrorHelper(long lErrCode)
 205 {
 206   char szErrMsg[LOG_BUFFER_SIZE / 2];
 207   sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
 208   strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf));
 209
 210   wxLog::OnLog(wxLOG_Error, s_szBuf);
 211 }
 212
 213 void WXDLLEXPORT wxLogSysError(const char *szFormat, ...)
 214 {
 215   va_list argptr;
 216   va_start(argptr, szFormat);
 217   vsprintf(s_szBuf, szFormat, argptr);
 218   va_end(argptr);
 219
 220   wxLogSysErrorHelper(wxSysErrorCode());
 221 }
 222
 223 void WXDLLEXPORT wxLogSysError(long lErrCode, const char *szFormat, ...)
 224 {
 225   va_list argptr;
 226   va_start(argptr, szFormat);
 227   vsprintf(s_szBuf, szFormat, argptr);
 228   va_end(argptr);
 229
 230   wxLogSysErrorHelper(lErrCode);
 231 }
 232
 233 // ----------------------------------------------------------------------------
 234 // wxLog class implementation
 235 // ----------------------------------------------------------------------------
 236
 237 wxLog::wxLog()
 238 {
 239   m_bHasMessages = FALSE;
 240   m_bVerbose     = FALSE;
 241   m_szTimeFormat = "[%d/%b/%y %H:%M:%S] ";
 242 }
 243
 244 wxLog *wxLog::GetActiveTarget()
 245 {
 246   if ( ms_bAutoCreate && ms_pLogger == NULL ) {
 247     // prevent infinite recursion if someone calls wxLogXXX() from
 248     // wxApp::CreateLogTarget()
 249     static bool s_bInGetActiveTarget = FALSE;
 250     if ( !s_bInGetActiveTarget ) {
 251       s_bInGetActiveTarget = TRUE;
 252
 253       #ifdef  wxUSE_NOGUI
 254         ms_pLogger = new wxLogStderr;
 255       #else
 256         // ask the application to create a log target for us
 257         if ( wxTheApp != NULL )
 258           ms_pLogger = wxTheApp->CreateLogTarget();
 259       #endif
 260
 261       // do nothing if it fails - what can we do?
 262     }
 263   }
 264
 265   return ms_pLogger;
 266 }
 267
 268 wxLog *wxLog::SetActiveTarget(wxLog *pLogger, bool bNoFlashOld)
 269 {
 270   // flush the old messages before changing
 271   if ( (ms_pLogger != NULL) && !bNoFlashOld ) {
 272     ms_pLogger->Flush();
 273   }
 274
 275   wxLog *pOldLogger = ms_pLogger;
 276   ms_pLogger = pLogger;
 277   return pOldLogger;
 278 }
 279
 280 wxString wxLog::TimeStamp() const
 281 {
 282   wxString str;
 283
 284   if ( !IsEmpty(m_szTimeFormat) ) {
 285     char szBuf[128];
 286     time_t timeNow;
 287     struct tm *ptmNow;
 288
 289     time(&timeNow);
 290     ptmNow = localtime(&timeNow);
 291
 292     strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow);
 293     str = szBuf;
 294   }
 295
 296   return str;
 297 }
 298
 299 void wxLog::DoLog(wxLogLevel level, const char *szString)
 300 {
 301   // prepend a timestamp if not disabled
 302   wxString str = TimeStamp();
 303
 304   switch ( level ) {
 305     case wxLOG_FatalError:
 306       DoLogString(str << _("Fatal error: ") << szString);
 307       DoLogString(_("Program aborted."));
 308       Flush();
 309       abort();
 310       break;
 311
 312     case wxLOG_Error:
 313       DoLogString(str << _("Error: ") << szString);
 314       break;
 315
 316     case wxLOG_Warning:
 317       DoLogString(str << _("Warning: ") << szString);
 318       break;
 319
 320     case wxLOG_Info:
 321       if ( GetVerbose() )
 322     case wxLOG_Message:
 323         DoLogString(str + szString);
 324       // fall through
 325
 326     case wxLOG_Status:
 327       // nothing to do
 328       break;
 329
 330     case wxLOG_Trace:
 331     case wxLOG_Debug:
 332       #ifdef __WXDEBUG__
 333         DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug"))
 334                         << ": " << szString);
 335       #endif
 336
 337       break;
 338
 339     default:
 340       wxFAIL_MSG(_("unknown log level in wxLog::DoLog"));
 341   }
 342 }
 343
 344 void wxLog::DoLogString(const char *WXUNUSED(szString))
 345 {
 346   wxFAIL_MSG(_("DoLogString must be overrided if it's called."));
 347 }
 348
 349 void wxLog::Flush()
 350 {
 351   // do nothing
 352 }
 353
 354 // ----------------------------------------------------------------------------
 355 // wxLogStderr class implementation
 356 // ----------------------------------------------------------------------------
 357
 358 wxLogStderr::wxLogStderr(FILE *fp)
 359 {
 360   if ( fp == NULL )
 361     m_fp = stderr;
 362   else
 363     m_fp = fp;
 364 }
 365
 366 void wxLogStderr::DoLogString(const char *szString)
 367 {
 368   fputs(szString, m_fp);
 369   fputc('\n', m_fp);
 370   fflush(m_fp);
 371 }
 372
 373 // ----------------------------------------------------------------------------
 374 // wxLogStream implementation
 375 // ----------------------------------------------------------------------------
 376
 377 wxLogStream::wxLogStream(ostream *ostr)
 378 {
 379   if ( ostr == NULL )
 380     m_ostr = &cerr;
 381   else
 382     m_ostr = ostr;
 383 }
 384
 385 void wxLogStream::DoLogString(const char *szString)
 386 {
 387   (*m_ostr) << szString << endl << flush;
 388 }
 389
 390 // ----------------------------------------------------------------------------
 391 // wxLogTextCtrl implementation
 392 // ----------------------------------------------------------------------------
 393 wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
 394 // @@@ TODO: in wxGTK wxTextCtrl doesn't derive from streambuf
 395
 396 // Also, in DLL mode in wxMSW, can't use it.
 397 #if defined(NO_TEXT_WINDOW_STREAM)
 398 #else
 399              : wxLogStream(new ostream(pTextCtrl))
 400 #endif
 401 {
 402 }
 403
 404 wxLogTextCtrl::~wxLogTextCtrl()
 405 {
 406   delete m_ostr;
 407 }
 408
 409 // ----------------------------------------------------------------------------
 410 // wxLogGui implementation
 411 // ----------------------------------------------------------------------------
 412
 413 #ifndef   wxUSE_NOGUI
 414
 415 wxLogGui::wxLogGui()
 416 {
 417   m_bErrors = FALSE;
 418 }
 419
 420 void wxLogGui::Flush()
 421 {
 422   if ( !m_bHasMessages )
 423     return;
 424
 425   // do it right now to block any new calls to Flush() while we're here
 426   m_bHasMessages = FALSE;
 427
 428   // @@@ ugly...
 429
 430   // concatenate all strings (but not too many to not overfill the msg box)
 431   wxString str;
 432   size_t nLines    = 0,
 433        nMsgCount = m_aMessages.Count();
 434
 435   // start from the most recent message
 436   for ( size_t n = nMsgCount; n > 0; n-- ) {
 437     // for Windows strings longer than this value are wrapped (NT 4.0)
 438     const size_t nMsgLineWidth = 156;
 439
 440     nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
 441
 442     if ( nLines > 25 )  // don't put too many lines in message box
 443       break;
 444
 445     str << m_aMessages[n - 1] << "\n";
 446   }
 447
 448   if ( m_bErrors ) {
 449     wxMessageBox(str, _("Error"), wxOK | wxICON_EXCLAMATION);
 450   }
 451   else {
 452     wxMessageBox(str, _("Information"), wxOK | wxICON_INFORMATION);
 453   }
 454
 455   // no undisplayed messages whatsoever
 456   m_bErrors      = FALSE;
 457   m_aMessages.Empty();
 458 }
 459
 460 // the default behaviour is to discard all informational messages if there
 461 // are any errors/warnings.
 462 void wxLogGui::DoLog(wxLogLevel level, const char *szString)
 463 {
 464   switch ( level ) {
 465     case wxLOG_Info:
 466       if ( GetVerbose() )
 467     case wxLOG_Message:
 468         if ( !m_bErrors ) {
 469           m_aMessages.Add(szString);
 470           m_bHasMessages = TRUE;
 471         }
 472       break;
 473
 474     case wxLOG_Status:
 475       {
 476         // find the top window and set it's status text if it has any
 477         wxFrame *pFrame = gs_pFrame;
 478         if ( pFrame == NULL ) {
 479           wxWindow *pWin = wxTheApp->GetTopWindow();
 480           if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) {
 481             pFrame = (wxFrame *)pWin;
 482           }
 483         }
 484
 485         if ( pFrame != NULL )
 486           pFrame->SetStatusText(szString);
 487       }
 488       break;
 489
 490     case wxLOG_Trace:
 491     case wxLOG_Debug:
 492       #ifdef __WXDEBUG__
 493         {
 494           wxString strTime = TimeStamp();
 495
 496           #if defined(__WIN32__) && !defined(__WXSTUBS__)
 497               // don't prepend debug/trace here: it goes to the debug window
 498               // anyhow, but do put a timestamp
 499               OutputDebugString(strTime + szString + "\n\r");
 500           #else   //!WIN32
 501             // send them to stderr
 502             fprintf(stderr, "%s %s: %s\n",
 503                     strTime.c_str(),
 504                     level == wxLOG_Trace ? _("Trace") : _("Debug"),
 505                     szString);
 506             fflush(stderr);
 507           #endif  // WIN32
 508         }
 509       #endif
 510       break;
 511
 512     case wxLOG_FatalError:
 513       // show this one immediately
 514       wxMessageBox(szString, _("Fatal error"), wxICON_HAND);
 515       break;
 516
 517     case wxLOG_Error:
 518     case wxLOG_Warning:
 519       // discard earlier informational messages if this is the 1st error
 520       if ( !m_bErrors ) {
 521         m_aMessages.Empty();
 522         m_bHasMessages = TRUE;
 523         m_bErrors = TRUE;
 524       }
 525
 526       m_aMessages.Add(szString);
 527       break;
 528
 529     default:
 530       wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog"));
 531   }
 532 }
 533
 534 // ----------------------------------------------------------------------------
 535 // wxLogWindow and wxLogFrame implementation
 536 // ----------------------------------------------------------------------------
 537
 538 // log frame class
 539 // ---------------
 540 class wxLogFrame : public wxFrame
 541 {
 542 public:
 543   // ctor & dtor
 544   wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle);
 545   virtual ~wxLogFrame();
 546
 547   // menu callbacks
 548   void OnClose(wxCommandEvent& event);
 549   void OnCloseWindow(wxCloseEvent& event);
 550   void OnSave (wxCommandEvent& event);
 551   void OnClear(wxCommandEvent& event);
 552
 553   void OnIdle(wxIdleEvent&);
 554
 555   // accessors
 556   wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
 557
 558 private:
 559   enum
 560   {
 561     Menu_Close = 100,
 562     Menu_Save,
 563     Menu_Clear
 564   };
 565
 566   // instead of closing just hide the window to be able to Show() it later
 567   void DoClose() { Show(FALSE); }
 568
 569   wxTextCtrl  *m_pTextCtrl;
 570   wxLogWindow *m_log;
 571
 572   DECLARE_EVENT_TABLE()
 573 };
 574
 575 BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
 576   // wxLogWindow menu events
 577   EVT_MENU(Menu_Close, wxLogFrame::OnClose)
 578   EVT_MENU(Menu_Save,  wxLogFrame::OnSave)
 579   EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
 580
 581   EVT_CLOSE(wxLogFrame::OnCloseWindow)
 582 END_EVENT_TABLE()
 583
 584 wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle)
 585           : wxFrame(pParent, -1, szTitle)
 586 {
 587   m_log = log;
 588
 589   // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating
 590   //    a rich edit control instead of a normal one we want in wxMSW
 591   m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition,
 592                                wxDefaultSize,
 593                              //wxSIMPLE_BORDER |
 594                                wxTE_MULTILINE  |
 595                                wxHSCROLL       |
 596                                wxTE_READONLY);
 597
 598   // create menu
 599   wxMenuBar *pMenuBar = new wxMenuBar;
 600   wxMenu *pMenu = new wxMenu;
 601   pMenu->Append(Menu_Save,  _("&Save..."), _("Save log contents to file"));
 602   pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));
 603   pMenu->AppendSeparator();
 604   pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
 605   pMenuBar->Append(pMenu, _("&Log"));
 606   SetMenuBar(pMenuBar);
 607
 608   // status bar for menu prompts
 609   CreateStatusBar();
 610
 611   m_log->OnFrameCreate(this);
 612 }
 613
 614 void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 615 {
 616   DoClose();
 617 }
 618
 619 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 620 {
 621   DoClose();
 622 }
 623
 624 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 625 {
 626   // get the file name
 627   // -----------------
 628   const char *szFileName = wxSaveFileSelector("log", "txt", "log.txt");
 629   if ( szFileName == NULL ) {
 630     // cancelled
 631     return;
 632   }
 633
 634   // open file
 635   // ---------
 636   wxFile file;
 637   bool bOk = FALSE;
 638   if ( wxFile::Exists(szFileName) ) {
 639     bool bAppend = FALSE;
 640     wxString strMsg;
 641     strMsg.Printf(_("Append log to file '%s' "
 642                     "(choosing [No] will overwrite it)?"), szFileName);
 643     switch ( wxMessageBox(strMsg, _("Question"), wxYES_NO | wxCANCEL) ) {
 644       case wxYES:
 645         bAppend = TRUE;
 646         break;
 647
 648       case wxNO:
 649         bAppend = FALSE;
 650         break;
 651
 652       case wxCANCEL:
 653         return;
 654
 655       default:
 656         wxFAIL_MSG(_("invalid message box return value"));
 657     }
 658
 659     if ( bAppend ) {
 660       bOk = file.Open(szFileName, wxFile::write_append);
 661     }
 662     else {
 663       bOk = file.Create(szFileName, TRUE /* overwrite */);
 664     }
 665   }
 666   else {
 667     bOk = file.Create(szFileName);
 668   }
 669
 670   // retrieve text and save it
 671   // -------------------------
 672 #ifdef __WXGTK__
 673   // @@@@ TODO: no GetNumberOfLines and GetLineText in wxGTK yet
 674   wxLogError(_("Sorry, this function is not implemented under GTK"));
 675 #else
 676   int nLines = m_pTextCtrl->GetNumberOfLines();
 677   for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
 678     bOk = file.Write(m_pTextCtrl->GetLineText(nLine) + wxTextFile::GetEOL());
 679   }
 680 #endif //GTK
 681
 682   if ( bOk )
 683     bOk = file.Close();
 684
 685   if ( !bOk ) {
 686     wxLogError(_("Can't save log contents to file."));
 687     return;
 688   }
 689 }
 690
 691 void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
 692 {
 693   m_pTextCtrl->Clear();
 694 }
 695
 696 wxLogFrame::~wxLogFrame()
 697 {
 698   m_log->OnFrameDelete(this);
 699 }
 700
 701 // wxLogWindow
 702 // -----------
 703 wxLogWindow::wxLogWindow(wxFrame *pParent,
 704                          const char *szTitle,
 705                          bool bShow,
 706                          bool bDoPass)
 707 {
 708   m_bPassMessages = bDoPass;
 709
 710   m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
 711   m_pOldLog = wxLog::SetActiveTarget(this);
 712
 713   if ( bShow )
 714     m_pLogFrame->Show(TRUE);
 715 }
 716
 717 void wxLogWindow::Show(bool bShow)
 718 {
 719   m_pLogFrame->Show(bShow);
 720 }
 721
 722 void wxLogWindow::Flush()
 723 {
 724   if ( m_pOldLog != NULL )
 725     m_pOldLog->Flush();
 726
 727   m_bHasMessages = FALSE;
 728 }
 729
 730 void wxLogWindow::DoLog(wxLogLevel level, const char *szString)
 731 {
 732   // first let the previous logger show it
 733   if ( m_pOldLog != NULL && m_bPassMessages ) {
 734     // @@@ why can't we access protected wxLog method from here (we derive
 735     // from wxLog)? gcc gives "DoLog is protected in this context", what
 736     // does this mean? Anyhow, the cast is harmless and let's us do what
 737     // we want.
 738     ((wxLogWindow *)m_pOldLog)->DoLog(level, szString);
 739   }
 740
 741   if ( m_pLogFrame ) {
 742     switch ( level ) {
 743       case wxLOG_Status:
 744         // by default, these messages are ignored by wxLog, so process
 745         // them ourselves
 746         {
 747           wxString str = TimeStamp();
 748           str << _("Status: ") << szString;
 749           DoLogString(str);
 750         }
 751         break;
 752
 753       // don't put trace messages in the text window for 2 reasons:
 754       // 1) there are too many of them
 755       // 2) they may provoke other trace messages thus sending a program
 756       //    into an infinite loop
 757       case wxLOG_Trace:
 758         break;
 759
 760       default:
 761         // and this will format it nicely and call our DoLogString()
 762         wxLog::DoLog(level, szString);
 763     }
 764   }
 765
 766   m_bHasMessages = TRUE;
 767 }
 768
 769 void wxLogWindow::DoLogString(const char *szString)
 770 {
 771   // put the text into our window
 772   wxTextCtrl *pText = m_pLogFrame->TextCtrl();
 773
 774   // remove selection (WriteText is in fact ReplaceSelection)
 775   #ifdef __WXMSW__
 776     long nLen = pText->GetLastPosition();
 777     pText->SetSelection(nLen, nLen);
 778   #endif // Windows
 779
 780   pText->WriteText(szString);
 781   pText->WriteText("\n"); // "\n" ok here (_not_ "\r\n")
 782
 783   // ensure that the line can be seen
 784   // @@@ TODO
 785 }
 786
 787 wxFrame *wxLogWindow::GetFrame() const
 788 {
 789   return m_pLogFrame;
 790 }
 791
 792 void wxLogWindow::OnFrameCreate(wxFrame *WXUNUSED(frame))
 793 {
 794 }
 795
 796 void wxLogWindow::OnFrameDelete(wxFrame *WXUNUSED(frame))
 797 {
 798   m_pLogFrame = (wxLogFrame *) NULL;
 799 }
 800
 801 wxLogWindow::~wxLogWindow()
 802 {
 803   // may be NULL if log frame already auto destroyed itself
 804   delete m_pLogFrame;
 805 }
 806
 807 #endif  //wxUSE_NOGUI
 808
 809 // ============================================================================
 810 // Global functions/variables
 811 // ============================================================================
 812
 813 // ----------------------------------------------------------------------------
 814 // static variables
 815 // ----------------------------------------------------------------------------
 816 wxLog      *wxLog::ms_pLogger      = (wxLog *) NULL;
 817 bool        wxLog::ms_bAutoCreate  = TRUE;
 818 wxTraceMask wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 819
 820 // ----------------------------------------------------------------------------
 821 // stdout error logging helper
 822 // ----------------------------------------------------------------------------
 823
 824 // helper function: wraps the message and justifies it under given position
 825 // (looks more pretty on the terminal). Also adds newline at the end.
 826 //
 827 // @@ this is now disabled until I find a portable way of determining the
 828 //    terminal window size (ok, I found it but does anybody really cares?)
 829 #ifdef    LOG_PRETTY_WRAP
 830 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
 831 {
 832   size_t nMax = 80; // @@@@
 833   size_t nStart = strlen(pszPrefix);
 834   fputs(pszPrefix, f);
 835
 836   size_t n;
 837   while ( *psz != '\0' ) {
 838     for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
 839       putc(*psz++, f);
 840
 841     // wrapped?
 842     if ( *psz != '\0' ) {
 843       /*putc('\n', f);*/
 844       for ( n = 0; n < nStart; n++ )
 845         putc(' ', f);
 846
 847       // as we wrapped, squeeze all white space
 848       while ( isspace(*psz) )
 849         psz++;
 850     }
 851   }
 852
 853   putc('\n', f);
 854 }
 855 #endif  //LOG_PRETTY_WRAP
 856
 857 // ----------------------------------------------------------------------------
 858 // error code/error message retrieval functions
 859 // ----------------------------------------------------------------------------
 860
 861 // get error code from syste
 862 unsigned long wxSysErrorCode()
 863 {
 864   #ifdef  __WXMSW__
 865     #ifdef  __WIN32__
 866       return ::GetLastError();
 867     #else   //WIN16
 868       // @@@@ what to do on Windows 3.1?
 869       return 0;
 870     #endif  //WIN16/32
 871   #else   //Unix
 872     return errno;
 873   #endif  //Win/Unix
 874 }
 875
 876 // get error message from system
 877 const char *wxSysErrorMsg(unsigned long nErrCode)
 878 {
 879   if ( nErrCode == 0 )
 880     nErrCode = wxSysErrorCode();
 881
 882   #ifdef  __WXMSW__
 883     #ifdef  __WIN32__
 884       static char s_szBuf[LOG_BUFFER_SIZE / 2];
 885
 886       // get error message from system
 887       LPVOID lpMsgBuf;
 888       FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
 889                     NULL, nErrCode,
 890                     MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
 891                     (LPTSTR)&lpMsgBuf,
 892                     0, NULL);
 893
 894       // copy it to our buffer and free memory
 895       strncpy(s_szBuf, (const char *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
 896       s_szBuf[WXSIZEOF(s_szBuf) - 1] = '\0';
 897       LocalFree(lpMsgBuf);
 898
 899       // returned string is capitalized and ended with '\r\n' - bad
 900       s_szBuf[0] = (char)wxToLower(s_szBuf[0]);
 901       size_t len = strlen(s_szBuf);
 902       if ( len > 0 ) {
 903         // truncate string
 904         if ( s_szBuf[len - 2] == '\r' )
 905           s_szBuf[len - 2] = '\0';
 906       }
 907
 908       return s_szBuf;
 909     #else   //Win16
 910       // TODO @@@@
 911       return NULL;
 912     #endif // Win16/32
 913   #else   // Unix
 914     return strerror(nErrCode);
 915   #endif  // Win/Unix
 916 }
 917
 918 // ----------------------------------------------------------------------------
 919 // debug helper
 920 // ----------------------------------------------------------------------------
 921
 922 #ifdef  __WXDEBUG__
 923
 924 void Trap()
 925 {
 926   #ifdef __WXMSW__
 927     DebugBreak();
 928   #elif defined(__WXSTUBS__)
 929     // TODO
 930   #else // Unix
 931     raise(SIGTRAP);
 932   #endif // Win/Unix
 933 }
 934
 935 // this function is called when an assert fails
 936 void wxOnAssert(const char *szFile, int nLine, const char *szMsg)
 937 {
 938   // this variable can be set to true to suppress "assert failure" messages
 939   static bool s_bNoAsserts = FALSE;
 940   static bool s_bInAssert = FALSE;
 941
 942   if ( s_bInAssert ) {
 943     // He-e-e-e-elp!! we're trapped in endless loop
 944     Trap();
 945   }
 946
 947   s_bInAssert = TRUE;
 948
 949   char szBuf[LOG_BUFFER_SIZE];
 950   sprintf(szBuf, _("Assert failed in file %s at line %d"), szFile, nLine);
 951   if ( szMsg != NULL ) {
 952     strcat(szBuf, ": ");
 953     strcat(szBuf, szMsg);
 954   }
 955   else {
 956     strcat(szBuf, ".");
 957   }
 958
 959   if ( !s_bNoAsserts ) {
 960     // send it to the normal log destination
 961     wxLogDebug(szBuf);
 962
 963     strcat(szBuf, _("\nDo you want to stop the program?"
 964                     "\nYou can also choose [Cancel] to suppress "
 965                     "further warnings."));
 966
 967     switch ( wxMessageBox(szBuf, _("Debug"),
 968                           wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
 969       case wxYES:
 970         Trap();
 971         break;
 972
 973       case wxCANCEL:
 974         s_bNoAsserts = TRUE;
 975         break;
 976
 977       //case wxNO: nothing to do
 978     }
 979   }
 980
 981   s_bInAssert = FALSE;
 982 }
 983
 984 #endif  //WXDEBUG
 985