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::LogLastRepetitionCountIfNeeded()
 462 {
 463     wxCRIT_SECT_LOCKER(lock, ms_prevCS);
 464
 465     const unsigned count = ms_prevCounter;
 466
 467     wxLog *pLogger = GetActiveTarget();
 468     if ( pLogger && ms_prevCounter )
 469     {
 470         wxString msg;
 471 #if wxUSE_INTL
 472         msg.Printf(wxPLURAL("The previous message repeated once.",
 473                             "The previous message repeated %lu times.",
 474                             ms_prevCounter),
 475                    ms_prevCounter);
 476 #else
 477         msg.Printf(wxT("The previous message was repeated %lu times."),
 478                    ms_prevCounter);
 479 #endif
 480         ms_prevCounter = 0;
 481         ms_prevString.clear();
 482         pLogger->DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
 483     }
 484
 485     return count;
 486 }
 487
 488 wxLog::~wxLog()
 489 {
 490     LogLastRepetitionCountIfNeeded();
 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() )
 502             {
 503                 wxCRIT_SECT_LOCKER(lock, ms_prevCS);
 504
 505                 if ( szString == ms_prevString )
 506                 {
 507                     ms_prevCounter++;
 508
 509                     // nothing else to do, in particular, don't log the
 510                     // repeated message
 511                     return;
 512                 }
 513
 514                 LogLastRepetitionCountIfNeeded();
 515
 516                 // reset repetition counter for a new message
 517                 ms_prevString = szString;
 518                 ms_prevLevel = level;
 519                 ms_prevTimeStamp = t;
 520             }
 521
 522             pLogger->DoLog(level, szString, t);
 523         }
 524     }
 525 }
 526
 527 // deprecated function
 528 #if WXWIN_COMPATIBILITY_2_6
 529
 530 wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
 531 {
 532     return NULL;
 533 }
 534
 535 #endif // WXWIN_COMPATIBILITY_2_6
 536
 537 #if WXWIN_COMPATIBILITY_2_8
 538
 539 void wxLog::DoLog(wxLogLevel WXUNUSED(level),
 540                   const char *WXUNUSED(szString),
 541                   time_t WXUNUSED(t))
 542 {
 543 }
 544
 545 void wxLog::DoLog(wxLogLevel WXUNUSED(level),
 546                   const wchar_t *WXUNUSED(wzString),
 547                   time_t WXUNUSED(t))
 548 {
 549 }
 550
 551 #endif // WXWIN_COMPATIBILITY_2_8
 552
 553 wxLog *wxLog::GetActiveTarget()
 554 {
 555     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
 556         // prevent infinite recursion if someone calls wxLogXXX() from
 557         // wxApp::CreateLogTarget()
 558         static bool s_bInGetActiveTarget = false;
 559         if ( !s_bInGetActiveTarget ) {
 560             s_bInGetActiveTarget = true;
 561
 562             // ask the application to create a log target for us
 563             if ( wxTheApp != NULL )
 564                 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
 565             else
 566                 ms_pLogger = new wxLogStderr;
 567
 568             s_bInGetActiveTarget = false;
 569
 570             // do nothing if it fails - what can we do?
 571         }
 572     }
 573
 574     return ms_pLogger;
 575 }
 576
 577 wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
 578 {
 579     if ( ms_pLogger != NULL ) {
 580         // flush the old messages before changing because otherwise they might
 581         // get lost later if this target is not restored
 582         ms_pLogger->Flush();
 583     }
 584
 585     wxLog *pOldLogger = ms_pLogger;
 586     ms_pLogger = pLogger;
 587
 588     return pOldLogger;
 589 }
 590
 591 void wxLog::DontCreateOnDemand()
 592 {
 593     ms_bAutoCreate = false;
 594
 595     // this is usually called at the end of the program and we assume that it
 596     // is *always* called at the end - so we free memory here to avoid false
 597     // memory leak reports from wxWin  memory tracking code
 598     ClearTraceMasks();
 599 }
 600
 601 void wxLog::DoCreateOnDemand()
 602 {
 603     ms_bAutoCreate = true;
 604 }
 605
 606 void wxLog::RemoveTraceMask(const wxString& str)
 607 {
 608     int index = ms_aTraceMasks.Index(str);
 609     if ( index != wxNOT_FOUND )
 610         ms_aTraceMasks.RemoveAt((size_t)index);
 611 }
 612
 613 void wxLog::ClearTraceMasks()
 614 {
 615     ms_aTraceMasks.Clear();
 616 }
 617
 618 void wxLog::TimeStamp(wxString *str)
 619 {
 620 #if wxUSE_DATETIME
 621     if ( !ms_timestamp.empty() )
 622     {
 623         wxChar buf[256];
 624         time_t timeNow;
 625         (void)time(&timeNow);
 626
 627         struct tm tm;
 628         wxStrftime(buf, WXSIZEOF(buf),
 629                     ms_timestamp, wxLocaltime_r(&timeNow, &tm));
 630
 631         str->Empty();
 632         *str << buf << wxT(": ");
 633     }
 634 #endif // wxUSE_DATETIME
 635 }
 636
 637 void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 638 {
 639 #if WXWIN_COMPATIBILITY_2_8
 640     // DoLog() signature changed since 2.8, so we call the old versions here
 641     // so that existing custom log classes still work:
 642     DoLog(level, (const char*)szString.mb_str(), t);
 643     DoLog(level, (const wchar_t*)szString.wc_str(), t);
 644 #endif
 645
 646     switch ( level ) {
 647         case wxLOG_FatalError:
 648             LogString(_("Fatal error: ") + szString, t);
 649             LogString(_("Program aborted."), t);
 650             Flush();
 651 #ifdef __WXWINCE__
 652             ExitThread(3);
 653 #else
 654             abort();
 655 #endif
 656             break;
 657
 658         case wxLOG_Error:
 659             LogString(_("Error: ") + szString, t);
 660             break;
 661
 662         case wxLOG_Warning:
 663             LogString(_("Warning: ") + szString, t);
 664             break;
 665
 666         case wxLOG_Info:
 667             if ( GetVerbose() )
 668         case wxLOG_Message:
 669         case wxLOG_Status:
 670         default:    // log unknown log levels too
 671                 LogString(szString, t);
 672             break;
 673
 674         case wxLOG_Trace:
 675         case wxLOG_Debug:
 676 #ifdef __WXDEBUG__
 677             {
 678                 wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
 679                                                     : wxT("Debug: ");
 680                 msg << szString;
 681                 LogString(msg, t);
 682             }
 683 #endif // Debug
 684             break;
 685     }
 686 }
 687
 688 void wxLog::DoLogString(const wxString& szString, time_t t)
 689 {
 690 #if WXWIN_COMPATIBILITY_2_8
 691     // DoLogString() signature changed since 2.8, so we call the old versions
 692     // here so that existing custom log classes still work; unfortunately this
 693     // also means that we can't have the wxFAIL_MSG below in compat mode
 694     DoLogString((const char*)szString.mb_str(), t);
 695     DoLogString((const wchar_t*)szString.wc_str(), t);
 696 #else
 697     wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
 698     wxUnusedVar(szString);
 699     wxUnusedVar(t);
 700 #endif
 701 }
 702
 703 void wxLog::Flush()
 704 {
 705     // nothing to do here
 706 }
 707
 708 /*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
 709 {
 710     for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
 711                                   en = ms_aTraceMasks.end();
 712          it != en; ++it )
 713         if ( *it == mask)
 714             return true;
 715     return false;
 716 }
 717
 718 // ----------------------------------------------------------------------------
 719 // wxLogBuffer implementation
 720 // ----------------------------------------------------------------------------
 721
 722 void wxLogBuffer::Flush()
 723 {
 724     if ( !m_str.empty() )
 725     {
 726         wxMessageOutputBest out;
 727         out.Printf(_T("%s"), m_str.c_str());
 728         m_str.clear();
 729     }
 730 }
 731
 732 void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 733 {
 734     switch ( level )
 735     {
 736         case wxLOG_Trace:
 737         case wxLOG_Debug:
 738 #ifdef __WXDEBUG__
 739             // don't put debug messages in the buffer, we don't want to show
 740             // them to the user in a msg box, log them immediately
 741             {
 742                 wxString str;
 743                 TimeStamp(&str);
 744                 str += szString;
 745
 746                 wxMessageOutputDebug dbgout;
 747                 dbgout.Printf(_T("%s\n"), str.c_str());
 748             }
 749 #endif // __WXDEBUG__
 750             break;
 751
 752         default:
 753             wxLog::DoLog(level, szString, t);
 754     }
 755 }
 756
 757 void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 758 {
 759     m_str << szString << _T("\n");
 760 }
 761
 762 // ----------------------------------------------------------------------------
 763 // wxLogStderr class implementation
 764 // ----------------------------------------------------------------------------
 765
 766 wxLogStderr::wxLogStderr(FILE *fp)
 767 {
 768     if ( fp == NULL )
 769         m_fp = stderr;
 770     else
 771         m_fp = fp;
 772 }
 773
 774 void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 775 {
 776     wxString str;
 777     TimeStamp(&str);
 778     str << szString;
 779
 780     wxFputs(str, m_fp);
 781     wxFputc(_T('\n'), m_fp);
 782     fflush(m_fp);
 783
 784     // under GUI systems such as Windows or Mac, programs usually don't have
 785     // stderr at all, so show the messages also somewhere else, typically in
 786     // the debugger window so that they go at least somewhere instead of being
 787     // simply lost
 788     if ( m_fp == stderr )
 789     {
 790         wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
 791         if ( traits && !traits->HasStderr() )
 792         {
 793             wxMessageOutputDebug dbgout;
 794             dbgout.Printf(_T("%s\n"), str.c_str());
 795         }
 796     }
 797 }
 798
 799 // ----------------------------------------------------------------------------
 800 // wxLogStream implementation
 801 // ----------------------------------------------------------------------------
 802
 803 #if wxUSE_STD_IOSTREAM
 804 #include "wx/ioswrap.h"
 805 wxLogStream::wxLogStream(wxSTD ostream *ostr)
 806 {
 807     if ( ostr == NULL )
 808         m_ostr = &wxSTD cerr;
 809     else
 810         m_ostr = ostr;
 811 }
 812
 813 void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 814 {
 815     wxString stamp;
 816     TimeStamp(&stamp);
 817     (*m_ostr) << stamp << szString << wxSTD endl;
 818 }
 819 #endif // wxUSE_STD_IOSTREAM
 820
 821 // ----------------------------------------------------------------------------
 822 // wxLogChain
 823 // ----------------------------------------------------------------------------
 824
 825 wxLogChain::wxLogChain(wxLog *logger)
 826 {
 827     m_bPassMessages = true;
 828
 829     m_logNew = logger;
 830     m_logOld = wxLog::SetActiveTarget(this);
 831 }
 832
 833 wxLogChain::~wxLogChain()
 834 {
 835     delete m_logOld;
 836
 837     if ( m_logNew != this )
 838         delete m_logNew;
 839 }
 840
 841 void wxLogChain::SetLog(wxLog *logger)
 842 {
 843     if ( m_logNew != this )
 844         delete m_logNew;
 845
 846     m_logNew = logger;
 847 }
 848
 849 void wxLogChain::Flush()
 850 {
 851     if ( m_logOld )
 852         m_logOld->Flush();
 853
 854     // be careful to avoid infinite recursion
 855     if ( m_logNew && m_logNew != this )
 856         m_logNew->Flush();
 857 }
 858
 859 void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 860 {
 861     // let the previous logger show it
 862     if ( m_logOld && IsPassingMessages() )
 863     {
 864         // bogus cast just to access protected DoLog
 865         ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
 866     }
 867
 868     if ( m_logNew && m_logNew != this )
 869     {
 870         // as above...
 871         ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
 872     }
 873 }
 874
 875 #ifdef __VISUALC__
 876     // "'this' : used in base member initializer list" - so what?
 877     #pragma warning(disable:4355)
 878 #endif // VC++
 879
 880 // ----------------------------------------------------------------------------
 881 // wxLogInterposer
 882 // ----------------------------------------------------------------------------
 883
 884 wxLogInterposer::wxLogInterposer()
 885                 : wxLogChain(this)
 886 {
 887 }
 888
 889 // ----------------------------------------------------------------------------
 890 // wxLogInterposerTemp
 891 // ----------------------------------------------------------------------------
 892
 893 wxLogInterposerTemp::wxLogInterposerTemp()
 894                 : wxLogChain(this)
 895 {
 896         DetachOldLog();
 897 }
 898
 899 #ifdef __VISUALC__
 900     #pragma warning(default:4355)
 901 #endif // VC++
 902
 903 // ============================================================================
 904 // Global functions/variables
 905 // ============================================================================
 906
 907 // ----------------------------------------------------------------------------
 908 // static variables
 909 // ----------------------------------------------------------------------------
 910
 911 #if wxUSE_THREADS
 912 wxCriticalSection wxLog::ms_prevCS;
 913 #endif // wxUSE_THREADS
 914 bool            wxLog::ms_bRepetCounting = false;
 915 wxString        wxLog::ms_prevString;
 916 unsigned int    wxLog::ms_prevCounter = 0;
 917 time_t          wxLog::ms_prevTimeStamp= 0;
 918 wxLogLevel      wxLog::ms_prevLevel;
 919
 920 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 921 bool            wxLog::ms_doLog        = true;
 922 bool            wxLog::ms_bAutoCreate  = true;
 923 bool            wxLog::ms_bVerbose     = false;
 924
 925 wxLogLevel      wxLog::ms_logLevel     = wxLOG_Max;  // log everything by default
 926
 927 size_t          wxLog::ms_suspendCount = 0;
 928
 929 wxString        wxLog::ms_timestamp(wxT("%X"));  // time only, no date
 930
 931 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 932 wxArrayString   wxLog::ms_aTraceMasks;
 933
 934 // ----------------------------------------------------------------------------
 935 // stdout error logging helper
 936 // ----------------------------------------------------------------------------
 937
 938 // helper function: wraps the message and justifies it under given position
 939 // (looks more pretty on the terminal). Also adds newline at the end.
 940 //
 941 // TODO this is now disabled until I find a portable way of determining the
 942 //      terminal window size (ok, I found it but does anybody really cares?)
 943 #ifdef LOG_PRETTY_WRAP
 944 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
 945 {
 946     size_t nMax = 80; // FIXME
 947     size_t nStart = strlen(pszPrefix);
 948     fputs(pszPrefix, f);
 949
 950     size_t n;
 951     while ( *psz != '\0' ) {
 952         for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
 953             putc(*psz++, f);
 954
 955         // wrapped?
 956         if ( *psz != '\0' ) {
 957             /*putc('\n', f);*/
 958             for ( n = 0; n < nStart; n++ )
 959                 putc(' ', f);
 960
 961             // as we wrapped, squeeze all white space
 962             while ( isspace(*psz) )
 963                 psz++;
 964         }
 965     }
 966
 967     putc('\n', f);
 968 }
 969 #endif  //LOG_PRETTY_WRAP
 970
 971 // ----------------------------------------------------------------------------
 972 // error code/error message retrieval functions
 973 // ----------------------------------------------------------------------------
 974
 975 // get error code from syste
 976 unsigned long wxSysErrorCode()
 977 {
 978 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 979     return ::GetLastError();
 980 #else   //Unix
 981     return errno;
 982 #endif  //Win/Unix
 983 }
 984
 985 // get error message from system
 986 const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 987 {
 988     if ( nErrCode == 0 )
 989         nErrCode = wxSysErrorCode();
 990
 991 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 992     static wxChar s_szBuf[1024];
 993
 994     // get error message from system
 995     LPVOID lpMsgBuf;
 996     if ( ::FormatMessage
 997          (
 998             FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
 999             NULL,
1000             nErrCode,
1001             MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1002             (LPTSTR)&lpMsgBuf,
1003             0,
1004             NULL
1005          ) == 0 )
1006     {
1007         // if this happens, something is seriously wrong, so don't use _() here
1008         // for safety
1009         wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
1010         return s_szBuf;
1011     }
1012
1013
1014     // copy it to our buffer and free memory
1015     // Crashes on SmartPhone (FIXME)
1016 #if !defined(__SMARTPHONE__) /* of WinCE */
1017     if( lpMsgBuf != 0 )
1018     {
1019         wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
1020         s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
1021
1022         LocalFree(lpMsgBuf);
1023
1024         // returned string is capitalized and ended with '\r\n' - bad
1025         s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
1026         size_t len = wxStrlen(s_szBuf);
1027         if ( len > 0 ) {
1028             // truncate string
1029             if ( s_szBuf[len - 2] == wxT('\r') )
1030                 s_szBuf[len - 2] = wxT('\0');
1031         }
1032     }
1033     else
1034 #endif // !__SMARTPHONE__
1035     {
1036         s_szBuf[0] = wxT('\0');
1037     }
1038
1039     return s_szBuf;
1040 #else // !__WXMSW__
1041     #if wxUSE_UNICODE
1042         static wchar_t s_wzBuf[1024];
1043         wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
1044                              WXSIZEOF(s_wzBuf) - 1);
1045         return s_wzBuf;
1046     #else
1047         return strerror((int)nErrCode);
1048     #endif
1049 #endif  // __WXMSW__/!__WXMSW__
1050 }
1051
1052 #endif // wxUSE_LOG