include/wx/log.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/log.h
   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 #ifndef _WX_LOG_H_
  13 #define _WX_LOG_H_
  14
  15 #include "wx/defs.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // common constants for use in wxUSE_LOG/!wxUSE_LOG
  19 // ----------------------------------------------------------------------------
  20
  21 // the trace masks have been superceded by symbolic trace constants, they're
  22 // for compatibility only andwill be removed soon - do NOT use them
  23
  24 // meaning of different bits of the trace mask (which allows selectively
  25 // enable/disable some trace messages)
  26 #define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
  27 #define wxTraceMessages 0x0002  // trace window messages/X callbacks
  28 #define wxTraceResAlloc 0x0004  // trace GDI resource allocation
  29 #define wxTraceRefCount 0x0008  // trace various ref counting operations
  30
  31 #ifdef  __WXMSW__
  32     #define wxTraceOleCalls 0x0100  // OLE interface calls
  33 #endif
  34
  35 // ----------------------------------------------------------------------------
  36 // types
  37 // ----------------------------------------------------------------------------
  38
  39 // NB: these types are needed even if wxUSE_LOG == 0
  40 typedef unsigned long wxTraceMask;
  41 typedef unsigned long wxLogLevel;
  42
  43 // ----------------------------------------------------------------------------
  44 // headers
  45 // ----------------------------------------------------------------------------
  46
  47 #include "wx/string.h"
  48 #include "wx/strvararg.h"
  49
  50 #if wxUSE_LOG
  51
  52 #include "wx/arrstr.h"
  53
  54 #ifndef __WXWINCE__
  55     #include <time.h>   // for time_t
  56 #endif
  57
  58 #include "wx/dynarray.h"
  59
  60 #ifndef wxUSE_LOG_DEBUG
  61 #  ifdef __WXDEBUG__
  62 #    define wxUSE_LOG_DEBUG 1
  63 #  else // !__WXDEBUG__
  64 #    define wxUSE_LOG_DEBUG 0
  65 #  endif
  66 #endif
  67
  68 // ----------------------------------------------------------------------------
  69 // forward declarations
  70 // ----------------------------------------------------------------------------
  71
  72 #if wxUSE_GUI
  73     class WXDLLIMPEXP_CORE wxTextCtrl;
  74     class WXDLLIMPEXP_CORE wxLogFrame;
  75     class WXDLLIMPEXP_CORE wxFrame;
  76     class WXDLLIMPEXP_CORE wxWindow;
  77 #endif // wxUSE_GUI
  78
  79 // ----------------------------------------------------------------------------
  80 // constants
  81 // ----------------------------------------------------------------------------
  82
  83 // different standard log levels (you may also define your own)
  84 enum wxLogLevelValues
  85 {
  86     wxLOG_FatalError, // program can't continue, abort immediately
  87     wxLOG_Error,      // a serious error, user must be informed about it
  88     wxLOG_Warning,    // user is normally informed about it but may be ignored
  89     wxLOG_Message,    // normal message (i.e. normal output of a non GUI app)
  90     wxLOG_Status,     // informational: might go to the status line of GUI app
  91     wxLOG_Info,       // informational message (a.k.a. 'Verbose')
  92     wxLOG_Debug,      // never shown to the user, disabled in release mode
  93     wxLOG_Trace,      // trace messages are also only enabled in debug mode
  94     wxLOG_Progress,   // used for progress indicator (not yet)
  95     wxLOG_User = 100, // user defined levels start here
  96     wxLOG_Max = 10000
  97 };
  98
  99 // symbolic trace masks - wxLogTrace("foo", "some trace message...") will be
 100 // discarded unless the string "foo" has been added to the list of allowed
 101 // ones with AddTraceMask()
 102
 103 #define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
 104 #define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
 105 #define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
 106 #define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
 107
 108 #ifdef  __WXMSW__
 109     #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
 110 #endif
 111
 112 #include "wx/iosfwrap.h"
 113
 114 // ----------------------------------------------------------------------------
 115 // derive from this class to redirect (or suppress, or ...) log messages
 116 // normally, only a single instance of this class exists but it's not enforced
 117 // ----------------------------------------------------------------------------
 118
 119 class WXDLLIMPEXP_BASE wxLog
 120 {
 121 public:
 122     // ctor
 123     wxLog(){}
 124
 125     // these functions allow to completely disable all log messages
 126
 127     // is logging disabled now?
 128     static bool IsEnabled() { return ms_doLog; }
 129
 130     // change the flag state, return the previous one
 131     static bool EnableLogging(bool doIt = true)
 132         { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
 133
 134     // static sink function - see DoLog() for function to overload in the
 135     // derived classes
 136     static void OnLog(wxLogLevel level, const wxString& szString, time_t t);
 137
 138     // message buffering
 139
 140     // flush shows all messages if they're not logged immediately (FILE
 141     // and iostream logs don't need it, but wxGuiLog does to avoid showing
 142     // 17 modal dialogs one after another)
 143     virtual void Flush();
 144
 145     // flush the active target if any
 146     static void FlushActive()
 147     {
 148         if ( !ms_suspendCount )
 149         {
 150             wxLog *log = GetActiveTarget();
 151             if ( log )
 152                 log->Flush();
 153         }
 154     }
 155
 156     // only one sink is active at each moment
 157     // get current log target, will call wxApp::CreateLogTarget() to
 158     // create one if none exists
 159     static wxLog *GetActiveTarget();
 160
 161     // change log target, pLogger may be NULL
 162     static wxLog *SetActiveTarget(wxLog *pLogger);
 163
 164     // suspend the message flushing of the main target until the next call
 165     // to Resume() - this is mainly for internal use (to prevent wxYield()
 166     // from flashing the messages)
 167     static void Suspend() { ms_suspendCount++; }
 168
 169     // must be called for each Suspend()!
 170     static void Resume() { ms_suspendCount--; }
 171
 172     // functions controlling the default wxLog behaviour
 173     // verbose mode is activated by standard command-line '-verbose'
 174     // option
 175     static void SetVerbose(bool bVerbose = true) { ms_bVerbose = bVerbose; }
 176
 177     // Set log level.  Log messages with level > logLevel will not be logged.
 178     static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
 179
 180     // should GetActiveTarget() try to create a new log object if the
 181     // current is NULL?
 182     static void DontCreateOnDemand();
 183
 184     // Make GetActiveTarget() create a new log object again.
 185     static void DoCreateOnDemand();
 186
 187     // log the count of repeating messages instead of logging the messages
 188     // multiple times
 189     static void SetRepetitionCounting(bool bRepetCounting = true)
 190         { ms_bRepetCounting = bRepetCounting; }
 191
 192     // gets duplicate counting status
 193     static bool GetRepetitionCounting() { return ms_bRepetCounting; }
 194
 195     // trace mask (see wxTraceXXX constants for details)
 196     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
 197
 198     // add string trace mask
 199     static void AddTraceMask(const wxString& str)
 200         { ms_aTraceMasks.push_back(str); }
 201
 202     // add string trace mask
 203     static void RemoveTraceMask(const wxString& str);
 204
 205     // remove all string trace masks
 206     static void ClearTraceMasks();
 207
 208     // get string trace masks
 209     static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 210
 211     // sets the timestamp string: this is used as strftime() format string
 212     // for the log targets which add time stamps to the messages - set it
 213     // to NULL to disable time stamping completely.
 214     static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
 215
 216
 217     // accessors
 218
 219     // gets the verbose status
 220     static bool GetVerbose() { return ms_bVerbose; }
 221
 222     // get trace mask
 223     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
 224
 225     // is this trace mask in the list?
 226     static bool IsAllowedTraceMask(const wxString& mask);
 227
 228     // return the current loglevel limit
 229     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 230
 231     // get the current timestamp format string (may be NULL)
 232     static const wxChar *GetTimestamp() { return ms_timestamp; }
 233
 234
 235     // helpers
 236
 237     // put the time stamp into the string if ms_timestamp != NULL (don't
 238     // change it otherwise)
 239     static void TimeStamp(wxString *str);
 240
 241     // make dtor virtual for all derived classes
 242     virtual ~wxLog();
 243
 244
 245     // this method exists for backwards compatibility only, don't use
 246     bool HasPendingMessages() const { return true; }
 247
 248 #if WXWIN_COMPATIBILITY_2_6
 249     // this function doesn't do anything any more, don't call it
 250     wxDEPRECATED( static wxChar *SetLogBuffer(wxChar *buf, size_t size = 0) );
 251 #endif
 252
 253 protected:
 254     // the logging functions that can be overriden
 255
 256     // default DoLog() prepends the time stamp and a prefix corresponding
 257     // to the message to szString and then passes it to DoLogString()
 258     virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
 259 #if WXWIN_COMPATIBILITY_2_8
 260     // these shouldn't be used by new code
 261     wxDEPRECATED_BUT_USED_INTERNALLY(
 262         virtual void DoLog(wxLogLevel level, const char *szString, time_t t)
 263     );
 264
 265     wxDEPRECATED_BUT_USED_INTERNALLY(
 266         virtual void DoLog(wxLogLevel level, const wchar_t *wzString, time_t t)
 267     );
 268 #endif // WXWIN_COMPATIBILITY_2_8
 269
 270     void LogString(const wxString& szString, time_t t)
 271         { DoLogString(szString, t); }
 272
 273     // default DoLogString does nothing but is not pure virtual because if
 274     // you override DoLog() you might not need it at all
 275     virtual void DoLogString(const wxString& szString, time_t t);
 276 #if WXWIN_COMPATIBILITY_2_8
 277     // these shouldn't be used by new code
 278     virtual void DoLogString(const char *WXUNUSED(szString),
 279                              time_t WXUNUSED(t)) {}
 280     virtual void DoLogString(const wchar_t *WXUNUSED(szString),
 281                              time_t WXUNUSED(t)) {}
 282 #endif
 283
 284     // log a line containing the number of times the previous message was
 285     // repeated
 286     // returns: the number
 287     static unsigned DoLogNumberOfRepeats();
 288
 289 private:
 290     // static variables
 291     // ----------------
 292
 293     // traditional behaviour or counting repetitions
 294     static bool        ms_bRepetCounting;
 295     static wxString    ms_prevString;   // previous message that was logged
 296     // how many times the previous message was logged
 297     static unsigned    ms_prevCounter;
 298     static time_t      ms_prevTimeStamp;// timestamp of the previous message
 299     static wxLogLevel  ms_prevLevel;    // level of the previous message
 300
 301     static wxLog      *ms_pLogger;      // currently active log sink
 302     static bool        ms_doLog;        // false => all logging disabled
 303     static bool        ms_bAutoCreate;  // create new log targets on demand?
 304     static bool        ms_bVerbose;     // false => ignore LogInfo messages
 305
 306     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 307
 308     static size_t      ms_suspendCount; // if positive, logs are not flushed
 309
 310     // format string for strftime(), if NULL, time stamping log messages is
 311     // disabled
 312     static const wxChar *ms_timestamp;
 313
 314     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
 315     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
 316 };
 317
 318 // ----------------------------------------------------------------------------
 319 // "trivial" derivations of wxLog
 320 // ----------------------------------------------------------------------------
 321
 322 // log everything to a buffer
 323 class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
 324 {
 325 public:
 326     wxLogBuffer() { }
 327
 328     // get the string contents with all messages logged
 329     const wxString& GetBuffer() const { return m_str; }
 330
 331     // show the buffer contents to the user in the best possible way (this uses
 332     // wxMessageOutputMessageBox) and clear it
 333     virtual void Flush();
 334
 335 protected:
 336     virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
 337     virtual void DoLogString(const wxString& szString, time_t t);
 338
 339 private:
 340     wxString m_str;
 341
 342     DECLARE_NO_COPY_CLASS(wxLogBuffer)
 343 };
 344
 345
 346 // log everything to a "FILE *", stderr by default
 347 class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
 348 {
 349 public:
 350     // redirect log output to a FILE
 351     wxLogStderr(FILE *fp = (FILE *) NULL);
 352
 353 protected:
 354     // implement sink function
 355     virtual void DoLogString(const wxString& szString, time_t t);
 356
 357     FILE *m_fp;
 358
 359     DECLARE_NO_COPY_CLASS(wxLogStderr)
 360 };
 361
 362 #if wxUSE_STD_IOSTREAM
 363
 364 // log everything to an "ostream", cerr by default
 365 class WXDLLIMPEXP_BASE wxLogStream : public wxLog
 366 {
 367 public:
 368     // redirect log output to an ostream
 369     wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);
 370
 371 protected:
 372     // implement sink function
 373     virtual void DoLogString(const wxString& szString, time_t t);
 374
 375     // using ptr here to avoid including <iostream.h> from this file
 376     wxSTD ostream *m_ostr;
 377 };
 378
 379 #endif // wxUSE_STD_IOSTREAM
 380
 381 // ----------------------------------------------------------------------------
 382 // /dev/null log target: suppress logging until this object goes out of scope
 383 // ----------------------------------------------------------------------------
 384
 385 // example of usage:
 386 /*
 387     void Foo()
 388     {
 389         wxFile file;
 390
 391         // wxFile.Open() normally complains if file can't be opened, we don't
 392         // want it
 393         wxLogNull logNo;
 394
 395         if ( !file.Open("bar") )
 396             ... process error ourselves ...
 397
 398         // ~wxLogNull called, old log sink restored
 399     }
 400  */
 401 class WXDLLIMPEXP_BASE wxLogNull
 402 {
 403 public:
 404     wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
 405     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 406
 407 private:
 408     bool m_flagOld; // the previous value of the wxLog::ms_doLog
 409 };
 410
 411 // ----------------------------------------------------------------------------
 412 // chaining log target: installs itself as a log target and passes all
 413 // messages to the real log target given to it in the ctor but also forwards
 414 // them to the previously active one
 415 //
 416 // note that you don't have to call SetActiveTarget() with this class, it
 417 // does it itself in its ctor
 418 // ----------------------------------------------------------------------------
 419
 420 class WXDLLIMPEXP_BASE wxLogChain : public wxLog
 421 {
 422 public:
 423     wxLogChain(wxLog *logger);
 424     virtual ~wxLogChain();
 425
 426     // change the new log target
 427     void SetLog(wxLog *logger);
 428
 429     // this can be used to temporarily disable (and then reenable) passing
 430     // messages to the old logger (by default we do pass them)
 431     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 432
 433     // are we passing the messages to the previous log target?
 434     bool IsPassingMessages() const { return m_bPassMessages; }
 435
 436     // return the previous log target (may be NULL)
 437     wxLog *GetOldLog() const { return m_logOld; }
 438
 439     // override base class version to flush the old logger as well
 440     virtual void Flush();
 441
 442 protected:
 443     // pass the chain to the old logger if needed
 444     virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
 445
 446 private:
 447     // the current log target
 448     wxLog *m_logNew;
 449
 450     // the previous log target
 451     wxLog *m_logOld;
 452
 453     // do we pass the messages to the old logger?
 454     bool m_bPassMessages;
 455
 456     DECLARE_NO_COPY_CLASS(wxLogChain)
 457 };
 458
 459 // a chain log target which uses itself as the new logger
 460 class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain
 461 {
 462 public:
 463     wxLogPassThrough();
 464
 465 private:
 466     DECLARE_NO_COPY_CLASS(wxLogPassThrough)
 467 };
 468
 469 #if wxUSE_GUI
 470     // include GUI log targets:
 471     #include "wx/generic/logg.h"
 472 #endif // wxUSE_GUI
 473
 474 // ============================================================================
 475 // global functions
 476 // ============================================================================
 477
 478 // ----------------------------------------------------------------------------
 479 // Log functions should be used by application instead of stdio, iostream &c
 480 // for log messages for easy redirection
 481 // ----------------------------------------------------------------------------
 482
 483 // ----------------------------------------------------------------------------
 484 // get error code/error message from system in a portable way
 485 // ----------------------------------------------------------------------------
 486
 487 // return the last system error code
 488 WXDLLIMPEXP_BASE unsigned long wxSysErrorCode();
 489
 490 // return the error message for given (or last if 0) error code
 491 WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 492
 493 // ----------------------------------------------------------------------------
 494 // define wxLog<level>
 495 // ----------------------------------------------------------------------------
 496
 497 #define DECLARE_LOG_FUNCTION(level)                                         \
 498     extern void WXDLLIMPEXP_BASE                                            \
 499     wxDoLog##level##Wchar(const wxChar *format, ...);                       \
 500     extern void WXDLLIMPEXP_BASE                                            \
 501     wxDoLog##level##Utf8(const char *format, ...);                          \
 502     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
 503                                1, (const wxFormatString&),                  \
 504                                wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
 505     DECLARE_LOG_FUNCTION_WATCOM(level)                                      \
 506     extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format,      \
 507                                                va_list argptr)
 508
 509 #ifdef __WATCOMC__
 510     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
 511     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
 512     // something too big for Borland C++ to handle
 513     #define DECLARE_LOG_FUNCTION_WATCOM(level)                              \
 514         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 515                                    1, (const wxString&),                    \
 516                                    (wxFormatString(f1)))                    \
 517         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 518                                    1, (const wxCStrData&),                  \
 519                                    (wxFormatString(f1)))                    \
 520         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 521                                    1, (const char*),                        \
 522                                    (wxFormatString(f1)))                    \
 523         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 524                                    1, (const wchar_t*),                     \
 525                                    (wxFormatString(f1)))
 526 #else
 527     #define DECLARE_LOG_FUNCTION_WATCOM(level)
 528 #endif
 529
 530
 531 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
 532     extern void expdecl wxDoLog##level##Wchar(argclass arg,                 \
 533                                               const wxChar *format, ...);   \
 534     extern void expdecl wxDoLog##level##Utf8(argclass arg,                  \
 535                                              const char *format, ...);      \
 536     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
 537                                2, (argclass, const wxFormatString&),        \
 538                                wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
 539     DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)         \
 540     extern void expdecl wxVLog##level(argclass arg,                         \
 541                                       const wxString& format,               \
 542                                       va_list argptr)
 543
 544 #ifdef __WATCOMC__
 545     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
 546     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
 547     // something too big for Borland C++ to handle
 548     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
 549         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 550                                    2, (argclass, const wxString&),          \
 551                                    (f1, wxFormatString(f2)))                \
 552         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 553                                    2, (argclass, const wxCStrData&),        \
 554                                    (f1, wxFormatString(f2)))                \
 555         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 556                                    2, (argclass, const char*),              \
 557                                    (f1, wxFormatString(f2)))                \
 558         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 559                                    2, (argclass, const wchar_t*),           \
 560                                    (f1, wxFormatString(f2)))
 561 #else
 562     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
 563 #endif
 564
 565
 566 #else // !wxUSE_LOG
 567
 568 #ifdef __WATCOMC__
 569     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 570     #define WX_WATCOM_ONLY_CODE( x )  x
 571 #else
 572     #define WX_WATCOM_ONLY_CODE( x )
 573 #endif
 574
 575 // log functions do nothing at all
 576 #define DECLARE_LOG_FUNCTION(level)                                         \
 577     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxString&))           \
 578     WX_WATCOM_ONLY_CODE(                                                    \
 579         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const char*))           \
 580         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wchar_t*))        \
 581         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&))     \
 582     )                                                                       \
 583     inline void wxVLog##level(const wxString& WXUNUSED(format),             \
 584                               va_list WXUNUSED(argptr)) { }                 \
 585
 586 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
 587     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
 588     WX_WATCOM_ONLY_CODE(                                                    \
 589         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const char*)) \
 590         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wchar_t*)) \
 591         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
 592     )                                                                       \
 593     inline void wxVLog##level(argclass WXUNUSED(arg),                       \
 594                               const wxString& WXUNUSED(format),             \
 595                               va_list WXUNUSED(argptr)) {}
 596
 597 // Empty Class to fake wxLogNull
 598 class WXDLLIMPEXP_BASE wxLogNull
 599 {
 600 public:
 601     wxLogNull() { }
 602 };
 603
 604 // Dummy macros to replace some functions.
 605 #define wxSysErrorCode() (unsigned long)0
 606 #define wxSysErrorMsg( X ) (const wxChar*)NULL
 607
 608 // Fake symbolic trace masks... for those that are used frequently
 609 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 610
 611 #endif // wxUSE_LOG/!wxUSE_LOG
 612
 613 #define DECLARE_LOG_FUNCTION2(level, argclass, arg)                         \
 614     DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
 615
 616 // VC6 produces a warning if we a macro expanding to nothing to
 617 // DECLARE_LOG_FUNCTION2:
 618 #if defined(__VISUALC__) && __VISUALC__ < 1300
 619     // "not enough actual parameters for macro 'DECLARE_LOG_FUNCTION2_EXP'"
 620     #pragma warning(disable:4003)
 621 #endif
 622
 623 // a generic function for all levels (level is passes as parameter)
 624 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
 625
 626 // one function per each level
 627 DECLARE_LOG_FUNCTION(FatalError);
 628 DECLARE_LOG_FUNCTION(Error);
 629 DECLARE_LOG_FUNCTION(Warning);
 630 DECLARE_LOG_FUNCTION(Message);
 631 DECLARE_LOG_FUNCTION(Info);
 632 DECLARE_LOG_FUNCTION(Verbose);
 633
 634 // this function sends the log message to the status line of the top level
 635 // application frame, if any
 636 DECLARE_LOG_FUNCTION(Status);
 637
 638 #if wxUSE_GUI
 639     // this one is the same as previous except that it allows to explicitly
 640     class WXDLLEXPORT wxFrame;
 641     // specify the frame to which the output should go
 642     DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
 643 #endif // wxUSE_GUI
 644
 645 // additional one: as wxLogError, but also logs last system call error code
 646 // and the corresponding error message if available
 647 DECLARE_LOG_FUNCTION(SysError);
 648
 649 // and another one which also takes the error code (for those broken APIs
 650 // that don't set the errno (like registry APIs in Win32))
 651 DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
 652 #ifdef __WATCOMC__
 653 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 654 DECLARE_LOG_FUNCTION2(SysError, unsigned long, lErrCode);
 655 #endif
 656
 657 // debug functions do nothing in release mode
 658 #if wxUSE_LOG && wxUSE_LOG_DEBUG
 659     DECLARE_LOG_FUNCTION(Debug);
 660
 661     // there is no more unconditional LogTrace: it is not different from
 662     // LogDebug and it creates overload ambiguities
 663     //DECLARE_LOG_FUNCTION(Trace);
 664
 665     // this version only logs the message if the mask had been added to the
 666     // list of masks with AddTraceMask()
 667     DECLARE_LOG_FUNCTION2(Trace, const wxString&, mask);
 668 #ifdef __WATCOMC__
 669     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 670     DECLARE_LOG_FUNCTION2(Trace, const char*, mask);
 671     DECLARE_LOG_FUNCTION2(Trace, const wchar_t*, mask);
 672 #endif
 673
 674     // and this one does nothing if all of level bits are not set in
 675     // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of
 676     // string identifiers
 677     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);
 678 #ifdef __WATCOMC__
 679     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 680     DECLARE_LOG_FUNCTION2(Trace, int, mask);
 681 #endif
 682 #else   //!debug || !wxUSE_LOG
 683     // these functions do nothing in release builds, but don't define them as
 684     // nothing as it could result in different code structure in debug and
 685     // release and this could result in trouble when these macros are used
 686     // inside if/else
 687     //
 688     // note that making wxVLogDebug/Trace() themselves (empty inline) functions
 689     // is a bad idea as some compilers are stupid enough to not inline even
 690     // empty functions if their parameters are complicated enough, but by
 691     // defining them as an empty inline function we ensure that even dumbest
 692     // compilers optimise them away
 693     inline void wxLogNop() { }
 694
 695     #define wxVLogDebug(fmt, valist) wxLogNop()
 696     #define wxVLogTrace(mask, fmt, valist) wxLogNop()
 697
 698     #ifdef HAVE_VARIADIC_MACROS
 699         // unlike the inline functions below, this completely removes the
 700         // wxLogXXX calls from the object file:
 701         #define wxLogDebug(fmt, ...) wxLogNop()
 702         #define wxLogTrace(mask, fmt, ...) wxLogNop()
 703     #else // !HAVE_VARIADIC_MACROS
 704         //inline void wxLogDebug(const wxString& fmt, ...) {}
 705         WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug, 1, (const wxString&))
 706         //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
 707         //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
 708         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (wxTraceMask, const wxString&))
 709         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wxString&, const wxString&))
 710         #ifdef __WATCOMC__
 711         // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 712         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const char*, const char*))
 713         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wchar_t*, const wchar_t*))
 714         #endif
 715     #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
 716 #endif // debug/!debug
 717
 718 #if defined(__VISUALC__) && __VISUALC__ < 1300
 719     #pragma warning(default:4003)
 720 #endif
 721
 722 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 723 // i.e. without using wxMessageBox() for example because it could crash
 724 void WXDLLIMPEXP_BASE
 725 wxSafeShowMessage(const wxString& title, const wxString& text);
 726
 727 // ----------------------------------------------------------------------------
 728 // debug only logging functions: use them with API name and error code
 729 // ----------------------------------------------------------------------------
 730
 731 #ifdef __WXDEBUG__
 732     // make life easier for people using VC++ IDE: clicking on the message
 733     // will take us immediately to the place of the failed API
 734 #ifdef __VISUALC__
 735     #define wxLogApiError(api, rc)                                            \
 736         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
 737                    __FILE__, __LINE__, api,                                   \
 738                    (long)rc, wxSysErrorMsg(rc))
 739 #else // !VC++
 740     #define wxLogApiError(api, rc)                                            \
 741         wxLogDebug(wxT("In file %s at line %d: '%s' failed with ")            \
 742                    wxT("error 0x%08lx (%s)."),                                \
 743                    __FILE__, __LINE__, api,                                   \
 744                    (long)rc, wxSysErrorMsg(rc))
 745 #endif // VC++/!VC++
 746
 747     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 748
 749 #else   //!debug
 750     #define wxLogApiError(api, err) wxLogNop()
 751     #define wxLogLastError(api) wxLogNop()
 752 #endif  //debug/!debug
 753
 754 // wxCocoa has additiional trace masks
 755 #if defined(__WXCOCOA__)
 756 #include "wx/cocoa/log.h"
 757 #endif
 758
 759 #ifdef WX_WATCOM_ONLY_CODE
 760     #undef WX_WATCOM_ONLY_CODE
 761 #endif
 762
 763 #endif  // _WX_LOG_H_
 764