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
  20 #ifdef __GNUG__
  21   #pragma implementation "log.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28   #pragma hdrstop
  29 #endif
  30
  31 // wxWindows
  32 #ifndef WX_PRECOMP
  33     #include "wx/string.h"
  34     #include "wx/intl.h"
  35     #include "wx/app.h"
  36
  37     #if wxUSE_GUI
  38         #include "wx/window.h"
  39         #ifdef __WXMSW__
  40             #include "wx/msw/private.h"
  41         #endif
  42         #include "wx/msgdlg.h"
  43     #endif
  44 #endif //WX_PRECOMP
  45
  46 #include  "wx/file.h"
  47 #include  "wx/textfile.h"
  48 #include  "wx/utils.h"
  49 #include  "wx/wxchar.h"
  50 #include  "wx/log.h"
  51 #include  "wx/thread.h"
  52
  53 // other standard headers
  54 #include  <errno.h>
  55 #include  <stdlib.h>
  56 #include  <time.h>
  57
  58 #ifdef  __WXMSW__
  59   #include  "wx/msw/private.h"      // includes windows.h for OutputDebugString
  60 #else   //Unix
  61   #include  <signal.h>
  62 #endif  //Win/Unix
  63
  64 // ----------------------------------------------------------------------------
  65 // non member functions
  66 // ----------------------------------------------------------------------------
  67
  68 // define this to enable wrapping of log messages
  69 //#define LOG_PRETTY_WRAP
  70
  71 #ifdef  LOG_PRETTY_WRAP
  72   static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
  73 #endif
  74
  75 // ============================================================================
  76 // implementation
  77 // ============================================================================
  78
  79 // ----------------------------------------------------------------------------
  80 // globals
  81 // ----------------------------------------------------------------------------
  82
  83 // log functions can't allocate memory (LogError("out of memory...") should
  84 // work!), so we use a static buffer for all log messages
  85 #define LOG_BUFFER_SIZE   (4096)
  86
  87 // static buffer for error messages
  88 static wxChar s_szBuf[LOG_BUFFER_SIZE];
  89
  90 #if wxUSE_THREADS
  91
  92 // the critical section protecting the static buffer
  93 static wxCriticalSection gs_csLogBuf;
  94
  95 #endif // wxUSE_THREADS
  96
  97 // ----------------------------------------------------------------------------
  98 // implementation of Log functions
  99 //
 100 // NB: unfortunately we need all these distinct functions, we can't make them
 101 //     macros and not all compilers inline vararg functions.
 102 // ----------------------------------------------------------------------------
 103
 104 // generic log function
 105 void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
 106 {
 107   if ( wxLog::GetActiveTarget() != NULL ) {
 108     wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 109
 110     va_list argptr;
 111     va_start(argptr, szFormat);
 112     wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
 113     va_end(argptr);
 114
 115     wxLog::OnLog(level, s_szBuf, time(NULL));
 116   }
 117 }
 118
 119 #define IMPLEMENT_LOG_FUNCTION(level)                             \
 120   void wxLog##level(const wxChar *szFormat, ...)                  \
 121   {                                                               \
 122     if ( wxLog::GetActiveTarget() != NULL ) {                     \
 123       wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                    \
 124                                                                   \
 125       va_list argptr;                                             \
 126       va_start(argptr, szFormat);                                 \
 127       wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);  \
 128       va_end(argptr);                                             \
 129                                                                   \
 130       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \
 131     }                                                             \
 132   }
 133
 134 IMPLEMENT_LOG_FUNCTION(FatalError)
 135 IMPLEMENT_LOG_FUNCTION(Error)
 136 IMPLEMENT_LOG_FUNCTION(Warning)
 137 IMPLEMENT_LOG_FUNCTION(Message)
 138 IMPLEMENT_LOG_FUNCTION(Info)
 139 IMPLEMENT_LOG_FUNCTION(Status)
 140
 141 // same as info, but only if 'verbose' mode is on
 142 void wxLogVerbose(const wxChar *szFormat, ...)
 143 {
 144   wxLog *pLog = wxLog::GetActiveTarget();
 145   if ( pLog != NULL && pLog->GetVerbose() ) {
 146     wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 147
 148     va_list argptr;
 149     va_start(argptr, szFormat);
 150     wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
 151     va_end(argptr);
 152
 153     wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
 154   }
 155 }
 156
 157 // debug functions
 158 #ifdef __WXDEBUG__
 159 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                       \
 160   void wxLog##level(const wxChar *szFormat, ...)                  \
 161   {                                                               \
 162     if ( wxLog::GetActiveTarget() != NULL ) {                     \
 163       wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                    \
 164                                                                   \
 165       va_list argptr;                                             \
 166       va_start(argptr, szFormat);                                 \
 167       wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);  \
 168       va_end(argptr);                                             \
 169                                                                   \
 170       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \
 171     }                                                             \
 172   }
 173
 174   void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
 175   {
 176     wxLog *pLog = wxLog::GetActiveTarget();
 177
 178     if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) {
 179       wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 180
 181       wxChar *p = s_szBuf;
 182       size_t len = WXSIZEOF(s_szBuf);
 183       strncpy(s_szBuf, _T("Trace ("), len);
 184       len -= 7; // strlen("Trace (")
 185       p += 7;
 186       strncat(p, mask, len);
 187       size_t lenMask = wxStrlen(mask);
 188       len -= lenMask;
 189       p += lenMask;
 190
 191       strncat(p, _T("): "), len);
 192       len -= 3;
 193       p += 3;
 194
 195       va_list argptr;
 196       va_start(argptr, szFormat);
 197       wxVsnprintf(p, len, szFormat, argptr);
 198       va_end(argptr);
 199
 200       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
 201     }
 202   }
 203
 204   void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
 205   {
 206     wxLog *pLog = wxLog::GetActiveTarget();
 207
 208     // we check that all of mask bits are set in the current mask, so
 209     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
 210     // if both bits are set.
 211     if ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {
 212       wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 213
 214       va_list argptr;
 215       va_start(argptr, szFormat);
 216       wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
 217       va_end(argptr);
 218
 219       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
 220     }
 221   }
 222
 223 #else // release
 224   #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
 225 #endif
 226
 227 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
 228 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 229
 230 // wxLogSysError: one uses the last error code, for other  you must give it
 231 // explicitly
 232
 233 // common part of both wxLogSysError
 234 void wxLogSysErrorHelper(long lErrCode)
 235 {
 236     wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
 237     wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
 238                _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
 239     wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf));
 240
 241     wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
 242 }
 243
 244 void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
 245 {
 246     wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 247
 248     va_list argptr;
 249     va_start(argptr, szFormat);
 250     wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
 251     va_end(argptr);
 252
 253     wxLogSysErrorHelper(wxSysErrorCode());
 254 }
 255
 256 void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
 257 {
 258     wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
 259
 260     va_list argptr;
 261     va_start(argptr, szFormat);
 262     wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
 263     va_end(argptr);
 264
 265     wxLogSysErrorHelper(lErrCode);
 266 }
 267
 268 // ----------------------------------------------------------------------------
 269 // wxLog class implementation
 270 // ----------------------------------------------------------------------------
 271
 272 wxLog::wxLog()
 273 {
 274     m_bHasMessages = FALSE;
 275
 276     // enable verbose messages by default in the debug builds
 277 #ifdef __WXDEBUG__
 278     m_bVerbose = TRUE;
 279 #else // release
 280     m_bVerbose = FALSE;
 281 #endif // debug/release
 282 }
 283
 284 wxLog *wxLog::GetActiveTarget()
 285 {
 286     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
 287         // prevent infinite recursion if someone calls wxLogXXX() from
 288         // wxApp::CreateLogTarget()
 289         static bool s_bInGetActiveTarget = FALSE;
 290         if ( !s_bInGetActiveTarget ) {
 291             s_bInGetActiveTarget = TRUE;
 292
 293             // ask the application to create a log target for us
 294             if ( wxTheApp != NULL )
 295                 ms_pLogger = wxTheApp->CreateLogTarget();
 296             else
 297                 ms_pLogger = new wxLogStderr;
 298
 299             s_bInGetActiveTarget = FALSE;
 300
 301             // do nothing if it fails - what can we do?
 302         }
 303     }
 304
 305     return ms_pLogger;
 306 }
 307
 308 wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
 309 {
 310     if ( ms_pLogger != NULL ) {
 311         // flush the old messages before changing because otherwise they might
 312         // get lost later if this target is not restored
 313         ms_pLogger->Flush();
 314     }
 315
 316     wxLog *pOldLogger = ms_pLogger;
 317     ms_pLogger = pLogger;
 318
 319     return pOldLogger;
 320 }
 321
 322 void wxLog::RemoveTraceMask(const wxString& str)
 323 {
 324     int index = ms_aTraceMasks.Index(str);
 325     if ( index != wxNOT_FOUND )
 326         ms_aTraceMasks.Remove((size_t)index);
 327 }
 328
 329 void wxLog::TimeStamp(wxString *str)
 330 {
 331     if ( ms_timestamp )
 332     {
 333         wxChar buf[256];
 334         time_t timeNow;
 335         (void)time(&timeNow);
 336         wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
 337
 338         str->Empty();
 339         *str << buf << wxT(": ");
 340     }
 341 }
 342
 343 void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 344 {
 345     switch ( level ) {
 346         case wxLOG_FatalError:
 347             DoLogString(wxString(_("Fatal error: ")) + szString, t);
 348             DoLogString(_("Program aborted."), t);
 349             Flush();
 350             abort();
 351             break;
 352
 353         case wxLOG_Error:
 354             DoLogString(wxString(_("Error: ")) + szString, t);
 355             break;
 356
 357         case wxLOG_Warning:
 358             DoLogString(wxString(_("Warning: ")) + szString, t);
 359             break;
 360
 361         case wxLOG_Info:
 362             if ( GetVerbose() )
 363         case wxLOG_Message:
 364         case wxLOG_Status:
 365         default:    // log unknown log levels too
 366                 DoLogString(szString, t);
 367             break;
 368
 369         case wxLOG_Trace:
 370         case wxLOG_Debug:
 371 #ifdef __WXDEBUG__
 372             DoLogString(szString, t);
 373 #endif
 374             break;
 375     }
 376 }
 377
 378 void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
 379 {
 380     wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
 381 }
 382
 383 void wxLog::Flush()
 384 {
 385     // do nothing
 386 }
 387
 388 // ----------------------------------------------------------------------------
 389 // wxLogStderr class implementation
 390 // ----------------------------------------------------------------------------
 391
 392 wxLogStderr::wxLogStderr(FILE *fp)
 393 {
 394     if ( fp == NULL )
 395         m_fp = stderr;
 396     else
 397         m_fp = fp;
 398 }
 399
 400 void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 401 {
 402     wxString str;
 403     TimeStamp(&str);
 404     str << szString;
 405
 406     fputs(str.mb_str(), m_fp);
 407     fputc(_T('\n'), m_fp);
 408     fflush(m_fp);
 409
 410     // under Windows, programs usually don't have stderr at all, so show the
 411     // messages also under debugger - unless it's a console program
 412 #if defined(__WXMSW__) && wxUSE_GUI
 413     OutputDebugString(str + wxT("\r\n"));
 414 #endif // MSW
 415 #if defined(__WXMAC__) && wxUSE_GUI
 416     debugstr(str + wxT("\r\n"));
 417 #endif // MSW
 418 }
 419
 420 // ----------------------------------------------------------------------------
 421 // wxLogStream implementation
 422 // ----------------------------------------------------------------------------
 423
 424 #if wxUSE_STD_IOSTREAM
 425 wxLogStream::wxLogStream(ostream *ostr)
 426 {
 427     if ( ostr == NULL )
 428         m_ostr = &cerr;
 429     else
 430         m_ostr = ostr;
 431 }
 432
 433 void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 434 {
 435     (*m_ostr) << wxConvertWX2MB(szString) << endl;
 436 }
 437 #endif // wxUSE_STD_IOSTREAM
 438
 439 // ============================================================================
 440 // Global functions/variables
 441 // ============================================================================
 442
 443 // ----------------------------------------------------------------------------
 444 // static variables
 445 // ----------------------------------------------------------------------------
 446
 447 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 448 bool            wxLog::ms_doLog        = TRUE;
 449 bool            wxLog::ms_bAutoCreate  = TRUE;
 450
 451 size_t          wxLog::ms_suspendCount = 0;
 452
 453 #if wxUSE_GUI
 454     const wxChar *wxLog::ms_timestamp  = wxT("%X");  // time only, no date
 455 #else
 456     const wxChar *wxLog::ms_timestamp  = NULL;       // save space
 457 #endif
 458
 459 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 460 wxArrayString   wxLog::ms_aTraceMasks;
 461
 462 // ----------------------------------------------------------------------------
 463 // stdout error logging helper
 464 // ----------------------------------------------------------------------------
 465
 466 // helper function: wraps the message and justifies it under given position
 467 // (looks more pretty on the terminal). Also adds newline at the end.
 468 //
 469 // TODO this is now disabled until I find a portable way of determining the
 470 //      terminal window size (ok, I found it but does anybody really cares?)
 471 #ifdef LOG_PRETTY_WRAP
 472 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
 473 {
 474     size_t nMax = 80; // FIXME
 475     size_t nStart = strlen(pszPrefix);
 476     fputs(pszPrefix, f);
 477
 478     size_t n;
 479     while ( *psz != '\0' ) {
 480         for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
 481             putc(*psz++, f);
 482
 483         // wrapped?
 484         if ( *psz != '\0' ) {
 485             /*putc('\n', f);*/
 486             for ( n = 0; n < nStart; n++ )
 487                 putc(' ', f);
 488
 489             // as we wrapped, squeeze all white space
 490             while ( isspace(*psz) )
 491                 psz++;
 492         }
 493     }
 494
 495     putc('\n', f);
 496 }
 497 #endif  //LOG_PRETTY_WRAP
 498
 499 // ----------------------------------------------------------------------------
 500 // error code/error message retrieval functions
 501 // ----------------------------------------------------------------------------
 502
 503 // get error code from syste
 504 unsigned long wxSysErrorCode()
 505 {
 506 #ifdef  __WXMSW__
 507 #ifdef  __WIN32__
 508     return ::GetLastError();
 509 #else   //WIN16
 510     // TODO what to do on Windows 3.1?
 511     return 0;
 512 #endif  //WIN16/32
 513 #else   //Unix
 514     return errno;
 515 #endif  //Win/Unix
 516 }
 517
 518 // get error message from system
 519 const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 520 {
 521     if ( nErrCode == 0 )
 522         nErrCode = wxSysErrorCode();
 523
 524 #ifdef  __WXMSW__
 525 #ifdef  __WIN32__
 526     static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
 527
 528     // get error message from system
 529     LPVOID lpMsgBuf;
 530     FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
 531             NULL, nErrCode,
 532             MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
 533             (LPTSTR)&lpMsgBuf,
 534             0, NULL);
 535
 536     // copy it to our buffer and free memory
 537     wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
 538     s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
 539     LocalFree(lpMsgBuf);
 540
 541     // returned string is capitalized and ended with '\r\n' - bad
 542     s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
 543     size_t len = wxStrlen(s_szBuf);
 544     if ( len > 0 ) {
 545         // truncate string
 546         if ( s_szBuf[len - 2] == wxT('\r') )
 547             s_szBuf[len - 2] = wxT('\0');
 548     }
 549
 550     return s_szBuf;
 551 #else   //Win16
 552     // TODO
 553     return NULL;
 554 #endif // Win16/32
 555 #else   // Unix
 556 #if wxUSE_UNICODE
 557     static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
 558     wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
 559     return s_szBuf;
 560 #else
 561     return strerror((int)nErrCode);
 562 #endif
 563 #endif  // Win/Unix
 564 }
 565
 566 // ----------------------------------------------------------------------------
 567 // debug helper
 568 // ----------------------------------------------------------------------------
 569
 570 #ifdef  __WXDEBUG__
 571
 572 // break into the debugger
 573 void Trap()
 574 {
 575 #ifdef __WXMSW__
 576     DebugBreak();
 577 #elif defined(__WXMAC__)
 578 #if __powerc
 579     Debugger();
 580 #else
 581     SysBreak();
 582 #endif
 583 #elif defined(__UNIX__)
 584     raise(SIGTRAP);
 585 #else
 586     // TODO
 587 #endif // Win/Unix
 588 }
 589
 590 // this function is called when an assert fails
 591 void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
 592 {
 593     // this variable can be set to true to suppress "assert failure" messages
 594     static bool s_bNoAsserts = FALSE;
 595     static bool s_bInAssert = FALSE;        // FIXME MT-unsafe
 596
 597     if ( s_bInAssert ) {
 598         // He-e-e-e-elp!! we're trapped in endless loop
 599         Trap();
 600
 601         s_bInAssert = FALSE;
 602
 603         return;
 604     }
 605
 606     s_bInAssert = TRUE;
 607
 608     wxChar szBuf[LOG_BUFFER_SIZE];
 609
 610     // make life easier for people using VC++ IDE: clicking on the message
 611     // will take us immediately to the place of the failed assert
 612     wxSnprintf(szBuf, WXSIZEOF(szBuf),
 613 #ifdef __VISUALC__
 614                wxT("%s(%d): assert failed"),
 615 #else  // !VC++
 616     // make the error message more clear for all the others
 617                wxT("Assert failed in file %s at line %d"),
 618 #endif // VC/!VC
 619                szFile, nLine);
 620
 621     if ( szMsg != NULL ) {
 622         wxStrcat(szBuf, wxT(": "));
 623         wxStrcat(szBuf, szMsg);
 624     }
 625     else {
 626         wxStrcat(szBuf, wxT("."));
 627     }
 628
 629     if ( !s_bNoAsserts ) {
 630         // send it to the normal log destination
 631         wxLogDebug(szBuf);
 632
 633 #if wxUSE_GUI || defined(__WXMSW__)
 634         // this message is intentionally not translated - it is for
 635         // developpers only
 636         wxStrcat(szBuf, wxT("\nDo you want to stop the program?"
 637                             "\nYou can also choose [Cancel] to suppress "
 638                             "further warnings."));
 639
 640 #if wxUSE_GUI
 641         switch ( wxMessageBox(szBuf, "Debug",
 642                               wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
 643             case wxYES:
 644                 Trap();
 645                 break;
 646
 647             case wxCANCEL:
 648                 s_bNoAsserts = TRUE;
 649                 break;
 650
 651             //case wxNO: nothing to do
 652         }
 653 #else // !GUI, but MSW
 654         switch ( ::MessageBox(NULL, szBuf, "Debug",
 655                               MB_YESNOCANCEL | MB_ICONSTOP ) ) {
 656             case IDYES:
 657                 Trap();
 658                 break;
 659
 660             case IDCANCEL:
 661                 s_bNoAsserts = TRUE;
 662                 break;
 663
 664             //case IDNO: nothing to do
 665         }
 666 #endif // GUI or MSW
 667
 668 #else // !GUI
 669         Trap();
 670 #endif // GUI/!GUI
 671     }
 672
 673     s_bInAssert = FALSE;
 674 }
 675
 676 #endif  //WXDEBUG
 677