src/common/log.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/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 licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_LOG
  28
  29 // wxWidgets
  30 #ifndef WX_PRECOMP
  31     #include "wx/log.h"
  32     #include "wx/app.h"
  33     #include "wx/arrstr.h"
  34     #include "wx/intl.h"
  35     #include "wx/string.h"
  36     #include "wx/utils.h"
  37 #endif //WX_PRECOMP
  38
  39 #include "wx/apptrait.h"
  40 #include "wx/datetime.h"
  41 #include "wx/file.h"
  42 #include "wx/msgout.h"
  43 #include "wx/textfile.h"
  44 #include "wx/thread.h"
  45 #include "wx/crt.h"
  46
  47 // other standard headers
  48 #ifndef __WXWINCE__
  49 #include <errno.h>
  50 #endif
  51
  52 #include <stdlib.h>
  53
  54 #ifndef __WXWINCE__
  55 #include <time.h>
  56 #else
  57 #include "wx/msw/wince/time.h"
  58 #endif
  59
  60 #if defined(__WINDOWS__)
  61     #include "wx/msw/private.h" // includes windows.h
  62 #endif
  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 // implementation of Log functions
  81 //
  82 // NB: unfortunately we need all these distinct functions, we can't make them
  83 //     macros and not all compilers inline vararg functions.
  84 // ----------------------------------------------------------------------------
  85
  86 // generic log function
  87 void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
  88 {
  89     if ( wxLog::IsEnabled() ) {
  90         wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
  91     }
  92 }
  93
  94 #if !wxUSE_UTF8_LOCALE_ONLY
  95 void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...)
  96 {
  97     va_list argptr;
  98     va_start(argptr, format);
  99     wxVLogGeneric(level, format, argptr);
 100     va_end(argptr);
 101 }
 102 #endif // wxUSE_UTF8_LOCALE_ONLY
 103
 104 #if wxUSE_UNICODE_UTF8
 105 void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...)
 106 {
 107     va_list argptr;
 108     va_start(argptr, format);
 109     wxVLogGeneric(level, format, argptr);
 110     va_end(argptr);
 111 }
 112 #endif // wxUSE_UNICODE_UTF8
 113
 114 #if !wxUSE_UTF8_LOCALE_ONLY
 115     #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)                         \
 116       void wxDoLog##level##Wchar(const wxChar *format, ...)             \
 117       {                                                                 \
 118         va_list argptr;                                                 \
 119         va_start(argptr, format);                                       \
 120         wxVLog##level(format, argptr);                                  \
 121         va_end(argptr);                                                 \
 122       }
 123 #else
 124     #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)
 125 #endif
 126
 127 #if wxUSE_UNICODE_UTF8
 128     #define IMPLEMENT_LOG_FUNCTION_UTF8(level)                          \
 129       void wxDoLog##level##Utf8(const char *format, ...)                \
 130       {                                                                 \
 131         va_list argptr;                                                 \
 132         va_start(argptr, format);                                       \
 133         wxVLog##level(format, argptr);                                  \
 134         va_end(argptr);                                                 \
 135       }
 136 #else
 137     #define IMPLEMENT_LOG_FUNCTION_UTF8(level)
 138 #endif
 139
 140 #define IMPLEMENT_LOG_FUNCTION(level)                               \
 141   void wxVLog##level(const wxString& format, va_list argptr)        \
 142   {                                                                 \
 143     if ( wxLog::IsEnabled() ) {                                     \
 144       wxLog::OnLog(wxLOG_##level,                                   \
 145                    wxString::FormatV(format, argptr), time(NULL));  \
 146     }                                                               \
 147   }                                                                 \
 148   IMPLEMENT_LOG_FUNCTION_WCHAR(level)                               \
 149   IMPLEMENT_LOG_FUNCTION_UTF8(level)
 150
 151 IMPLEMENT_LOG_FUNCTION(Error)
 152 IMPLEMENT_LOG_FUNCTION(Warning)
 153 IMPLEMENT_LOG_FUNCTION(Message)
 154 IMPLEMENT_LOG_FUNCTION(Info)
 155 IMPLEMENT_LOG_FUNCTION(Status)
 156
 157 void wxSafeShowMessage(const wxString& title, const wxString& text)
 158 {
 159 #ifdef __WINDOWS__
 160     ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
 161 #else
 162     wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str());
 163     fflush(stderr);
 164 #endif
 165 }
 166
 167 // fatal errors can't be suppressed nor handled by the custom log target and
 168 // always terminate the program
 169 void wxVLogFatalError(const wxString& format, va_list argptr)
 170 {
 171     wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(format, argptr));
 172
 173 #ifdef __WXWINCE__
 174     ExitThread(3);
 175 #else
 176     abort();
 177 #endif
 178 }
 179
 180 #if !wxUSE_UTF8_LOCALE_ONLY
 181 void wxDoLogFatalErrorWchar(const wxChar *format, ...)
 182 {
 183     va_list argptr;
 184     va_start(argptr, format);
 185     wxVLogFatalError(format, argptr);
 186
 187     // some compilers warn about unreachable code and it shouldn't matter
 188     // for the others anyhow...
 189     //va_end(argptr);
 190 }
 191 #endif // wxUSE_UTF8_LOCALE_ONLY
 192
 193 #if wxUSE_UNICODE_UTF8
 194 void wxDoLogFatalErrorUtf8(const char *format, ...)
 195 {
 196     va_list argptr;
 197     va_start(argptr, format);
 198     wxVLogFatalError(format, argptr);
 199
 200     // some compilers warn about unreachable code and it shouldn't matter
 201     // for the others anyhow...
 202     //va_end(argptr);
 203 }
 204 #endif // wxUSE_UNICODE_UTF8
 205
 206 // same as info, but only if 'verbose' mode is on
 207 void wxVLogVerbose(const wxString& format, va_list argptr)
 208 {
 209     if ( wxLog::IsEnabled() ) {
 210         if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
 211             wxLog::OnLog(wxLOG_Info,
 212                          wxString::FormatV(format, argptr), time(NULL));
 213         }
 214     }
 215 }
 216
 217 #if !wxUSE_UTF8_LOCALE_ONLY
 218 void wxDoLogVerboseWchar(const wxChar *format, ...)
 219 {
 220     va_list argptr;
 221     va_start(argptr, format);
 222     wxVLogVerbose(format, argptr);
 223     va_end(argptr);
 224 }
 225 #endif // !wxUSE_UTF8_LOCALE_ONLY
 226
 227 #if wxUSE_UNICODE_UTF8
 228 void wxDoLogVerboseUtf8(const char *format, ...)
 229 {
 230     va_list argptr;
 231     va_start(argptr, format);
 232     wxVLogVerbose(format, argptr);
 233     va_end(argptr);
 234 }
 235 #endif // wxUSE_UNICODE_UTF8
 236
 237 // debug functions
 238 #ifdef __WXDEBUG__
 239
 240 #if !wxUSE_UTF8_LOCALE_ONLY
 241     #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                   \
 242       void wxDoLog##level##Wchar(const wxChar *format, ...)             \
 243       {                                                                 \
 244         va_list argptr;                                                 \
 245         va_start(argptr, format);                                       \
 246         wxVLog##level(format, argptr);                                  \
 247         va_end(argptr);                                                 \
 248       }
 249 #else
 250     #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)
 251 #endif
 252
 253 #if wxUSE_UNICODE_UTF8
 254     #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)                    \
 255       void wxDoLog##level##Utf8(const char *format, ...)                \
 256       {                                                                 \
 257         va_list argptr;                                                 \
 258         va_start(argptr, format);                                       \
 259         wxVLog##level(format, argptr);                                  \
 260         va_end(argptr);                                                 \
 261       }
 262 #else
 263     #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
 264 #endif
 265
 266 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                         \
 267   void wxVLog##level(const wxString& format, va_list argptr)        \
 268   {                                                                 \
 269     if ( wxLog::IsEnabled() ) {                                     \
 270       wxLog::OnLog(wxLOG_##level,                                   \
 271                    wxString::FormatV(format, argptr), time(NULL));  \
 272     }                                                               \
 273   }                                                                 \
 274   IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                         \
 275   IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
 276
 277
 278   void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
 279   {
 280     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
 281       wxString msg;
 282       msg << _T("(") << mask << _T(") ") << wxString::FormatV(format, argptr);
 283
 284       wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
 285     }
 286   }
 287
 288 #if !wxUSE_UTF8_LOCALE_ONLY
 289   void wxDoLogTraceWchar(const wxString& mask, const wxChar *format, ...)
 290   {
 291     va_list argptr;
 292     va_start(argptr, format);
 293     wxVLogTrace(mask, format, argptr);
 294     va_end(argptr);
 295   }
 296 #endif // !wxUSE_UTF8_LOCALE_ONLY
 297
 298 #if wxUSE_UNICODE_UTF8
 299   void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...)
 300   {
 301     va_list argptr;
 302     va_start(argptr, format);
 303     wxVLogTrace(mask, format, argptr);
 304     va_end(argptr);
 305   }
 306 #endif // wxUSE_UNICODE_UTF8
 307
 308   void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
 309   {
 310     // we check that all of mask bits are set in the current mask, so
 311     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
 312     // if both bits are set.
 313     if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
 314       wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
 315     }
 316   }
 317
 318 #if !wxUSE_UTF8_LOCALE_ONLY
 319   void wxDoLogTraceWchar(wxTraceMask mask, const wxChar *format, ...)
 320   {
 321     va_list argptr;
 322     va_start(argptr, format);
 323     wxVLogTrace(mask, format, argptr);
 324     va_end(argptr);
 325   }
 326 #endif // !wxUSE_UTF8_LOCALE_ONLY
 327
 328 #if wxUSE_UNICODE_UTF8
 329   void wxDoLogTraceUtf8(wxTraceMask mask, const char *format, ...)
 330   {
 331     va_list argptr;
 332     va_start(argptr, format);
 333     wxVLogTrace(mask, format, argptr);
 334     va_end(argptr);
 335   }
 336 #endif // wxUSE_UNICODE_UTF8
 337
 338 #ifdef __WATCOMC__
 339   // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 340   void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
 341   {
 342     va_list argptr;
 343     va_start(argptr, format);
 344     wxVLogTrace(mask, format, argptr);
 345     va_end(argptr);
 346   }
 347
 348   void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
 349   {
 350     va_list argptr;
 351     va_start(argptr, format);
 352     wxVLogTrace(mask, format, argptr);
 353     va_end(argptr);
 354   }
 355
 356   void wxDoLogTraceWchar(const wchar_t *mask, const wxChar *format, ...)
 357   {
 358     va_list argptr;
 359     va_start(argptr, format);
 360     wxVLogTrace(mask, format, argptr);
 361     va_end(argptr);
 362   }
 363
 364   void wxVLogTrace(int mask, const wxString& format, va_list argptr)
 365     { wxVLogTrace((wxTraceMask)mask, format, argptr); }
 366   void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
 367     { wxVLogTrace(wxString(mask), format, argptr); }
 368   void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
 369     { wxVLogTrace(wxString(mask), format, argptr); }
 370 #endif // __WATCOMC__
 371
 372 #else // release
 373   #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
 374 #endif
 375
 376 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
 377 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 378
 379 // wxLogSysError: one uses the last error code, for other  you must give it
 380 // explicitly
 381
 382 // return the system error message description
 383 static inline wxString wxLogSysErrorHelper(long err)
 384 {
 385     return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
 386 }
 387
 388 void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr)
 389 {
 390     wxVLogSysError(wxSysErrorCode(), format, argptr);
 391 }
 392
 393 #if !wxUSE_UTF8_LOCALE_ONLY
 394 void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...)
 395 {
 396     va_list argptr;
 397     va_start(argptr, format);
 398     wxVLogSysError(format, argptr);
 399     va_end(argptr);
 400 }
 401 #endif // !wxUSE_UTF8_LOCALE_ONLY
 402
 403 #if wxUSE_UNICODE_UTF8
 404 void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...)
 405 {
 406     va_list argptr;
 407     va_start(argptr, format);
 408     wxVLogSysError(format, argptr);
 409     va_end(argptr);
 410 }
 411 #endif // wxUSE_UNICODE_UTF8
 412
 413 void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr)
 414 {
 415     if ( wxLog::IsEnabled() ) {
 416         wxLog::OnLog(wxLOG_Error,
 417                      wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
 418                      time(NULL));
 419     }
 420 }
 421
 422 #if !wxUSE_UTF8_LOCALE_ONLY
 423 void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
 424 {
 425     va_list argptr;
 426     va_start(argptr, format);
 427     wxVLogSysError(lErrCode, format, argptr);
 428     va_end(argptr);
 429 }
 430 #endif // !wxUSE_UTF8_LOCALE_ONLY
 431
 432 #if wxUSE_UNICODE_UTF8
 433 void WXDLLEXPORT wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
 434 {
 435     va_list argptr;
 436     va_start(argptr, format);
 437     wxVLogSysError(lErrCode, format, argptr);
 438     va_end(argptr);
 439 }
 440 #endif // wxUSE_UNICODE_UTF8
 441
 442 #ifdef __WATCOMC__
 443 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 444 void WXDLLEXPORT wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
 445 {
 446     va_list argptr;
 447     va_start(argptr, format);
 448     wxVLogSysError(lErrCode, format, argptr);
 449     va_end(argptr);
 450 }
 451
 452 void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
 453     { wxVLogSysError((long)err, format, argptr); }
 454 #endif // __WATCOMC__
 455
 456 // ----------------------------------------------------------------------------
 457 // wxLog class implementation
 458 // ----------------------------------------------------------------------------
 459
 460 /* static */
 461 unsigned wxLog::DoLogNumberOfRepeats()
 462 {
 463     long retval = ms_prevCounter;
 464     wxLog *pLogger = GetActiveTarget();
 465     if ( pLogger && ms_prevCounter > 0 )
 466     {
 467         wxString msg;
 468 #if wxUSE_INTL
 469         msg.Printf(wxPLURAL("The previous message repeated once.",
 470                             "The previous message repeated %lu times.",
 471                             ms_prevCounter),
 472                    ms_prevCounter);
 473 #else
 474         msg.Printf(wxT("The previous message was repeated."));
 475 #endif
 476         ms_prevCounter = 0;
 477         ms_prevString.clear();
 478         pLogger->DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
 479     }
 480     return retval;
 481 }
 482
 483 wxLog::~wxLog()
 484 {
 485     if ( ms_prevCounter > 0 )
 486     {
 487         // looks like the repeat count has not been logged yet,
 488         // so let's do it now
 489         wxLog::DoLogNumberOfRepeats();
 490     }
 491 }
 492
 493 /* static */
 494 void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
 495 {
 496     if ( IsEnabled() && ms_logLevel >= level )
 497     {
 498         wxLog *pLogger = GetActiveTarget();
 499         if ( pLogger )
 500         {
 501             if ( GetRepetitionCounting() && ms_prevString == szString )
 502             {
 503                 ms_prevCounter++;
 504             }
 505             else
 506             {
 507                 if ( GetRepetitionCounting() )
 508                 {
 509                     DoLogNumberOfRepeats();
 510                 }
 511                 ms_prevString = szString;
 512                 ms_prevLevel = level;
 513                 ms_prevTimeStamp = t;
 514                 pLogger->DoLog(level, szString, t);
 515             }
 516         }
 517     }
 518 }
 519
 520 // deprecated function
 521 #if WXWIN_COMPATIBILITY_2_6
 522
 523 wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
 524 {
 525     return NULL;
 526 }
 527
 528 #endif // WXWIN_COMPATIBILITY_2_6
 529
 530 #if WXWIN_COMPATIBILITY_2_8
 531
 532 void wxLog::DoLog(wxLogLevel WXUNUSED(level),
 533                   const char *WXUNUSED(szString),
 534                   time_t WXUNUSED(t))
 535 {
 536 }
 537
 538 void wxLog::DoLog(wxLogLevel WXUNUSED(level),
 539                   const wchar_t *WXUNUSED(wzString),
 540                   time_t WXUNUSED(t))
 541 {
 542 }
 543
 544 #endif // WXWIN_COMPATIBILITY_2_8
 545
 546 wxLog *wxLog::GetActiveTarget()
 547 {
 548     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
 549         // prevent infinite recursion if someone calls wxLogXXX() from
 550         // wxApp::CreateLogTarget()
 551         static bool s_bInGetActiveTarget = false;
 552         if ( !s_bInGetActiveTarget ) {
 553             s_bInGetActiveTarget = true;
 554
 555             // ask the application to create a log target for us
 556             if ( wxTheApp != NULL )
 557                 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
 558             else
 559                 ms_pLogger = new wxLogStderr;
 560
 561             s_bInGetActiveTarget = false;
 562
 563             // do nothing if it fails - what can we do?
 564         }
 565     }
 566
 567     return ms_pLogger;
 568 }
 569
 570 wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
 571 {
 572     if ( ms_pLogger != NULL ) {
 573         // flush the old messages before changing because otherwise they might
 574         // get lost later if this target is not restored
 575         ms_pLogger->Flush();
 576     }
 577
 578     wxLog *pOldLogger = ms_pLogger;
 579     ms_pLogger = pLogger;
 580
 581     return pOldLogger;
 582 }
 583
 584 void wxLog::DontCreateOnDemand()
 585 {
 586     ms_bAutoCreate = false;
 587
 588     // this is usually called at the end of the program and we assume that it
 589     // is *always* called at the end - so we free memory here to avoid false
 590     // memory leak reports from wxWin  memory tracking code
 591     ClearTraceMasks();
 592 }
 593
 594 void wxLog::DoCreateOnDemand()
 595 {
 596     ms_bAutoCreate = true;
 597 }
 598
 599 void wxLog::RemoveTraceMask(const wxString& str)
 600 {
 601     int index = ms_aTraceMasks.Index(str);
 602     if ( index != wxNOT_FOUND )
 603         ms_aTraceMasks.RemoveAt((size_t)index);
 604 }
 605
 606 void wxLog::ClearTraceMasks()
 607 {
 608     ms_aTraceMasks.Clear();
 609 }
 610
 611 void wxLog::TimeStamp(wxString *str)
 612 {
 613 #if wxUSE_DATETIME
 614     if ( !ms_timestamp.empty() )
 615     {
 616         wxChar buf[256];
 617         time_t timeNow;
 618         (void)time(&timeNow);
 619
 620         struct tm tm;
 621         wxStrftime(buf, WXSIZEOF(buf),
 622                     ms_timestamp, wxLocaltime_r(&timeNow, &tm));
 623
 624         str->Empty();
 625         *str << buf << wxT(": ");
 626     }
 627 #endif // wxUSE_DATETIME
 628 }
 629
 630 void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 631 {
 632 #if WXWIN_COMPATIBILITY_2_8
 633     // DoLog() signature changed since 2.8, so we call the old versions here
 634     // so that existing custom log classes still work:
 635     DoLog(level, (const char*)szString.mb_str(), t);
 636     DoLog(level, (const wchar_t*)szString.wc_str(), t);
 637 #endif
 638
 639     switch ( level ) {
 640         case wxLOG_FatalError:
 641             LogString(_("Fatal error: ") + szString, t);
 642             LogString(_("Program aborted."), t);
 643             Flush();
 644 #ifdef __WXWINCE__
 645             ExitThread(3);
 646 #else
 647             abort();
 648 #endif
 649             break;
 650
 651         case wxLOG_Error:
 652             LogString(_("Error: ") + szString, t);
 653             break;
 654
 655         case wxLOG_Warning:
 656             LogString(_("Warning: ") + szString, t);
 657             break;
 658
 659         case wxLOG_Info:
 660             if ( GetVerbose() )
 661         case wxLOG_Message:
 662         case wxLOG_Status:
 663         default:    // log unknown log levels too
 664                 LogString(szString, t);
 665             break;
 666
 667         case wxLOG_Trace:
 668         case wxLOG_Debug:
 669 #ifdef __WXDEBUG__
 670             {
 671                 wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
 672                                                     : wxT("Debug: ");
 673                 msg << szString;
 674                 LogString(msg, t);
 675             }
 676 #endif // Debug
 677             break;
 678     }
 679 }
 680
 681 void wxLog::DoLogString(const wxString& szString, time_t t)
 682 {
 683 #if WXWIN_COMPATIBILITY_2_8
 684     // DoLogString() signature changed since 2.8, so we call the old versions
 685     // here so that existing custom log classes still work; unfortunately this
 686     // also means that we can't have the wxFAIL_MSG below in compat mode
 687     DoLogString((const char*)szString.mb_str(), t);
 688     DoLogString((const wchar_t*)szString.wc_str(), t);
 689 #else
 690     wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
 691     wxUnusedVar(szString);
 692     wxUnusedVar(t);
 693 #endif
 694 }
 695
 696 void wxLog::Flush()
 697 {
 698     // nothing to do here
 699 }
 700
 701 /*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
 702 {
 703     for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
 704                                   en = ms_aTraceMasks.end();
 705          it != en; ++it )
 706         if ( *it == mask)
 707             return true;
 708     return false;
 709 }
 710
 711 // ----------------------------------------------------------------------------
 712 // wxLogBuffer implementation
 713 // ----------------------------------------------------------------------------
 714
 715 void wxLogBuffer::Flush()
 716 {
 717     if ( !m_str.empty() )
 718     {
 719         wxMessageOutputBest out;
 720         out.Printf(_T("%s"), m_str.c_str());
 721         m_str.clear();
 722     }
 723 }
 724
 725 void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 726 {
 727     switch ( level )
 728     {
 729         case wxLOG_Trace:
 730         case wxLOG_Debug:
 731 #ifdef __WXDEBUG__
 732             // don't put debug messages in the buffer, we don't want to show
 733             // them to the user in a msg box, log them immediately
 734             {
 735                 wxString str;
 736                 TimeStamp(&str);
 737                 str += szString;
 738
 739                 wxMessageOutputDebug dbgout;
 740                 dbgout.Printf(_T("%s\n"), str.c_str());
 741             }
 742 #endif // __WXDEBUG__
 743             break;
 744
 745         default:
 746             wxLog::DoLog(level, szString, t);
 747     }
 748 }
 749
 750 void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 751 {
 752     m_str << szString << _T("\n");
 753 }
 754
 755 // ----------------------------------------------------------------------------
 756 // wxLogStderr class implementation
 757 // ----------------------------------------------------------------------------
 758
 759 wxLogStderr::wxLogStderr(FILE *fp)
 760 {
 761     if ( fp == NULL )
 762         m_fp = stderr;
 763     else
 764         m_fp = fp;
 765 }
 766
 767 void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 768 {
 769     wxString str;
 770     TimeStamp(&str);
 771     str << szString;
 772
 773     wxFputs(str, m_fp);
 774     wxFputc(_T('\n'), m_fp);
 775     fflush(m_fp);
 776
 777     // under GUI systems such as Windows or Mac, programs usually don't have
 778     // stderr at all, so show the messages also somewhere else, typically in
 779     // the debugger window so that they go at least somewhere instead of being
 780     // simply lost
 781     if ( m_fp == stderr )
 782     {
 783         wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
 784         if ( traits && !traits->HasStderr() )
 785         {
 786             wxMessageOutputDebug dbgout;
 787             dbgout.Printf(_T("%s\n"), str.c_str());
 788         }
 789     }
 790 }
 791
 792 // ----------------------------------------------------------------------------
 793 // wxLogStream implementation
 794 // ----------------------------------------------------------------------------
 795
 796 #if wxUSE_STD_IOSTREAM
 797 #include "wx/ioswrap.h"
 798 wxLogStream::wxLogStream(wxSTD ostream *ostr)
 799 {
 800     if ( ostr == NULL )
 801         m_ostr = &wxSTD cerr;
 802     else
 803         m_ostr = ostr;
 804 }
 805
 806 void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 807 {
 808     wxString stamp;
 809     TimeStamp(&stamp);
 810     (*m_ostr) << stamp << szString << wxSTD endl;
 811 }
 812 #endif // wxUSE_STD_IOSTREAM
 813
 814 // ----------------------------------------------------------------------------
 815 // wxLogChain
 816 // ----------------------------------------------------------------------------
 817
 818 wxLogChain::wxLogChain(wxLog *logger)
 819 {
 820     m_bPassMessages = true;
 821
 822     m_logNew = logger;
 823     m_logOld = wxLog::SetActiveTarget(this);
 824 }
 825
 826 wxLogChain::~wxLogChain()
 827 {
 828     delete m_logOld;
 829
 830     if ( m_logNew != this )
 831         delete m_logNew;
 832 }
 833
 834 void wxLogChain::SetLog(wxLog *logger)
 835 {
 836     if ( m_logNew != this )
 837         delete m_logNew;
 838
 839     m_logNew = logger;
 840 }
 841
 842 void wxLogChain::Flush()
 843 {
 844     if ( m_logOld )
 845         m_logOld->Flush();
 846
 847     // be careful to avoid infinite recursion
 848     if ( m_logNew && m_logNew != this )
 849         m_logNew->Flush();
 850 }
 851
 852 void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 853 {
 854     // let the previous logger show it
 855     if ( m_logOld && IsPassingMessages() )
 856     {
 857         // bogus cast just to access protected DoLog
 858         ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
 859     }
 860
 861     if ( m_logNew && m_logNew != this )
 862     {
 863         // as above...
 864         ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
 865     }
 866 }
 867
 868 #ifdef __VISUALC__
 869     // "'this' : used in base member initializer list" - so what?
 870     #pragma warning(disable:4355)
 871 #endif // VC++
 872
 873 // ----------------------------------------------------------------------------
 874 // wxLogInterposer
 875 // ----------------------------------------------------------------------------
 876
 877 wxLogInterposer::wxLogInterposer()
 878                 : wxLogChain(this)
 879 {
 880 }
 881
 882 // ----------------------------------------------------------------------------
 883 // wxLogInterposerTemp
 884 // ----------------------------------------------------------------------------
 885
 886 wxLogInterposerTemp::wxLogInterposerTemp()
 887                 : wxLogChain(this)
 888 {
 889         DetachOldLog();
 890 }
 891
 892 #ifdef __VISUALC__
 893     #pragma warning(default:4355)
 894 #endif // VC++
 895
 896 // ============================================================================
 897 // Global functions/variables
 898 // ============================================================================
 899
 900 // ----------------------------------------------------------------------------
 901 // static variables
 902 // ----------------------------------------------------------------------------
 903
 904 bool            wxLog::ms_bRepetCounting = false;
 905 wxString        wxLog::ms_prevString;
 906 unsigned int    wxLog::ms_prevCounter = 0;
 907 time_t          wxLog::ms_prevTimeStamp= 0;
 908 wxLogLevel      wxLog::ms_prevLevel;
 909
 910 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 911 bool            wxLog::ms_doLog        = true;
 912 bool            wxLog::ms_bAutoCreate  = true;
 913 bool            wxLog::ms_bVerbose     = false;
 914
 915 wxLogLevel      wxLog::ms_logLevel     = wxLOG_Max;  // log everything by default
 916
 917 size_t          wxLog::ms_suspendCount = 0;
 918
 919 wxString        wxLog::ms_timestamp(wxT("%X"));  // time only, no date
 920
 921 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 922 wxArrayString   wxLog::ms_aTraceMasks;
 923
 924 // ----------------------------------------------------------------------------
 925 // stdout error logging helper
 926 // ----------------------------------------------------------------------------
 927
 928 // helper function: wraps the message and justifies it under given position
 929 // (looks more pretty on the terminal). Also adds newline at the end.
 930 //
 931 // TODO this is now disabled until I find a portable way of determining the
 932 //      terminal window size (ok, I found it but does anybody really cares?)
 933 #ifdef LOG_PRETTY_WRAP
 934 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
 935 {
 936     size_t nMax = 80; // FIXME
 937     size_t nStart = strlen(pszPrefix);
 938     fputs(pszPrefix, f);
 939
 940     size_t n;
 941     while ( *psz != '\0' ) {
 942         for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
 943             putc(*psz++, f);
 944
 945         // wrapped?
 946         if ( *psz != '\0' ) {
 947             /*putc('\n', f);*/
 948             for ( n = 0; n < nStart; n++ )
 949                 putc(' ', f);
 950
 951             // as we wrapped, squeeze all white space
 952             while ( isspace(*psz) )
 953                 psz++;
 954         }
 955     }
 956
 957     putc('\n', f);
 958 }
 959 #endif  //LOG_PRETTY_WRAP
 960
 961 // ----------------------------------------------------------------------------
 962 // error code/error message retrieval functions
 963 // ----------------------------------------------------------------------------
 964
 965 // get error code from syste
 966 unsigned long wxSysErrorCode()
 967 {
 968 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 969     return ::GetLastError();
 970 #else   //Unix
 971     return errno;
 972 #endif  //Win/Unix
 973 }
 974
 975 // get error message from system
 976 const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 977 {
 978     if ( nErrCode == 0 )
 979         nErrCode = wxSysErrorCode();
 980
 981 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 982     static wxChar s_szBuf[1024];
 983
 984     // get error message from system
 985     LPVOID lpMsgBuf;
 986     if ( ::FormatMessage
 987          (
 988             FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
 989             NULL,
 990             nErrCode,
 991             MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
 992             (LPTSTR)&lpMsgBuf,
 993             0,
 994             NULL
 995          ) == 0 )
 996     {
 997         // if this happens, something is seriously wrong, so don't use _() here
 998         // for safety
 999         wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
1000         return s_szBuf;
1001     }
1002
1003
1004     // copy it to our buffer and free memory
1005     // Crashes on SmartPhone (FIXME)
1006 #if !defined(__SMARTPHONE__) /* of WinCE */
1007     if( lpMsgBuf != 0 )
1008     {
1009         wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
1010         s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
1011
1012         LocalFree(lpMsgBuf);
1013
1014         // returned string is capitalized and ended with '\r\n' - bad
1015         s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
1016         size_t len = wxStrlen(s_szBuf);
1017         if ( len > 0 ) {
1018             // truncate string
1019             if ( s_szBuf[len - 2] == wxT('\r') )
1020                 s_szBuf[len - 2] = wxT('\0');
1021         }
1022     }
1023     else
1024 #endif // !__SMARTPHONE__
1025     {
1026         s_szBuf[0] = wxT('\0');
1027     }
1028
1029     return s_szBuf;
1030 #else // !__WXMSW__
1031     #if wxUSE_UNICODE
1032         static wchar_t s_wzBuf[1024];
1033         wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
1034                              WXSIZEOF(s_wzBuf) - 1);
1035         return s_wzBuf;
1036     #else
1037         return strerror((int)nErrCode);
1038     #endif
1039 #endif  // __WXMSW__/!__WXMSW__
1040 }
1041
1042 #endif // wxUSE_LOG