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