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 wxChar *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 wxChar *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 wxChar *szString, time_t t);
 259
 260     // default DoLogString does nothing but is not pure virtual because if
 261     // you override DoLog() you might not need it at all
 262     virtual void DoLogString(const wxChar *szString, time_t t);
 263
 264     // log a line containing the number of times the previous message was
 265     // repeated
 266     // returns: the number
 267     static unsigned DoLogNumberOfRepeats();
 268
 269 private:
 270     // static variables
 271     // ----------------
 272
 273     // traditional behaviour or counting repetitions
 274     static bool        ms_bRepetCounting;
 275     static wxString    ms_prevString;   // previous message that was logged
 276     // how many times the previous message was logged
 277     static unsigned    ms_prevCounter;
 278     static time_t      ms_prevTimeStamp;// timestamp of the previous message
 279     static wxLogLevel  ms_prevLevel;    // level of the previous message
 280
 281     static wxLog      *ms_pLogger;      // currently active log sink
 282     static bool        ms_doLog;        // false => all logging disabled
 283     static bool        ms_bAutoCreate;  // create new log targets on demand?
 284     static bool        ms_bVerbose;     // false => ignore LogInfo messages
 285
 286     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 287
 288     static size_t      ms_suspendCount; // if positive, logs are not flushed
 289
 290     // format string for strftime(), if NULL, time stamping log messages is
 291     // disabled
 292     static const wxChar *ms_timestamp;
 293
 294     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
 295     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
 296 };
 297
 298 // ----------------------------------------------------------------------------
 299 // "trivial" derivations of wxLog
 300 // ----------------------------------------------------------------------------
 301
 302 // log everything to a buffer
 303 class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
 304 {
 305 public:
 306     wxLogBuffer() { }
 307
 308     // get the string contents with all messages logged
 309     const wxString& GetBuffer() const { return m_str; }
 310
 311     // show the buffer contents to the user in the best possible way (this uses
 312     // wxMessageOutputMessageBox) and clear it
 313     virtual void Flush();
 314
 315 protected:
 316     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 317     virtual void DoLogString(const wxChar *szString, time_t t);
 318
 319 private:
 320     wxString m_str;
 321
 322     DECLARE_NO_COPY_CLASS(wxLogBuffer)
 323 };
 324
 325
 326 // log everything to a "FILE *", stderr by default
 327 class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
 328 {
 329 public:
 330     // redirect log output to a FILE
 331     wxLogStderr(FILE *fp = (FILE *) NULL);
 332
 333 protected:
 334     // implement sink function
 335     virtual void DoLogString(const wxChar *szString, time_t t);
 336
 337     FILE *m_fp;
 338
 339     DECLARE_NO_COPY_CLASS(wxLogStderr)
 340 };
 341
 342 #if wxUSE_STD_IOSTREAM
 343
 344 // log everything to an "ostream", cerr by default
 345 class WXDLLIMPEXP_BASE wxLogStream : public wxLog
 346 {
 347 public:
 348     // redirect log output to an ostream
 349     wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);
 350
 351 protected:
 352     // implement sink function
 353     virtual void DoLogString(const wxChar *szString, time_t t);
 354
 355     // using ptr here to avoid including <iostream.h> from this file
 356     wxSTD ostream *m_ostr;
 357 };
 358
 359 #endif // wxUSE_STD_IOSTREAM
 360
 361 // ----------------------------------------------------------------------------
 362 // /dev/null log target: suppress logging until this object goes out of scope
 363 // ----------------------------------------------------------------------------
 364
 365 // example of usage:
 366 /*
 367     void Foo()
 368     {
 369         wxFile file;
 370
 371         // wxFile.Open() normally complains if file can't be opened, we don't
 372         // want it
 373         wxLogNull logNo;
 374
 375         if ( !file.Open("bar") )
 376             ... process error ourselves ...
 377
 378         // ~wxLogNull called, old log sink restored
 379     }
 380  */
 381 class WXDLLIMPEXP_BASE wxLogNull
 382 {
 383 public:
 384     wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
 385     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 386
 387 private:
 388     bool m_flagOld; // the previous value of the wxLog::ms_doLog
 389 };
 390
 391 // ----------------------------------------------------------------------------
 392 // chaining log target: installs itself as a log target and passes all
 393 // messages to the real log target given to it in the ctor but also forwards
 394 // them to the previously active one
 395 //
 396 // note that you don't have to call SetActiveTarget() with this class, it
 397 // does it itself in its ctor
 398 // ----------------------------------------------------------------------------
 399
 400 class WXDLLIMPEXP_BASE wxLogChain : public wxLog
 401 {
 402 public:
 403     wxLogChain(wxLog *logger);
 404     virtual ~wxLogChain();
 405
 406     // change the new log target
 407     void SetLog(wxLog *logger);
 408
 409     // this can be used to temporarily disable (and then reenable) passing
 410     // messages to the old logger (by default we do pass them)
 411     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 412
 413     // are we passing the messages to the previous log target?
 414     bool IsPassingMessages() const { return m_bPassMessages; }
 415
 416     // return the previous log target (may be NULL)
 417     wxLog *GetOldLog() const { return m_logOld; }
 418
 419     // override base class version to flush the old logger as well
 420     virtual void Flush();
 421
 422 protected:
 423     // pass the chain to the old logger if needed
 424     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 425
 426 private:
 427     // the current log target
 428     wxLog *m_logNew;
 429
 430     // the previous log target
 431     wxLog *m_logOld;
 432
 433     // do we pass the messages to the old logger?
 434     bool m_bPassMessages;
 435
 436     DECLARE_NO_COPY_CLASS(wxLogChain)
 437 };
 438
 439 // a chain log target which uses itself as the new logger
 440 class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain
 441 {
 442 public:
 443     wxLogPassThrough();
 444
 445 private:
 446     DECLARE_NO_COPY_CLASS(wxLogPassThrough)
 447 };
 448
 449 #if wxUSE_GUI
 450     // include GUI log targets:
 451     #include "wx/generic/logg.h"
 452 #endif // wxUSE_GUI
 453
 454 // ============================================================================
 455 // global functions
 456 // ============================================================================
 457
 458 // ----------------------------------------------------------------------------
 459 // Log functions should be used by application instead of stdio, iostream &c
 460 // for log messages for easy redirection
 461 // ----------------------------------------------------------------------------
 462
 463 // ----------------------------------------------------------------------------
 464 // get error code/error message from system in a portable way
 465 // ----------------------------------------------------------------------------
 466
 467 // return the last system error code
 468 WXDLLIMPEXP_BASE unsigned long wxSysErrorCode();
 469
 470 // return the error message for given (or last if 0) error code
 471 WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 472
 473 // ----------------------------------------------------------------------------
 474 // define wxLog<level>
 475 // ----------------------------------------------------------------------------
 476
 477 #define DECLARE_LOG_FUNCTION(level)                                         \
 478     extern void WXDLLIMPEXP_BASE                                            \
 479     wxDoLog##level##Wchar(const wxChar *format, ...);                       \
 480     extern void WXDLLIMPEXP_BASE                                            \
 481     wxDoLog##level##Utf8(const char *format, ...);                          \
 482     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
 483                                1, (const wxFormatString&),                  \
 484                                wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
 485     DECLARE_LOG_FUNCTION_WATCOM(level)                                      \
 486     extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format,      \
 487                                                va_list argptr)
 488
 489 #ifdef __WATCOMC__
 490     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
 491     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
 492     // something too big for Borland C++ to handle
 493     #define DECLARE_LOG_FUNCTION_WATCOM(level)                              \
 494         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 495                                    1, (const wxString&),                    \
 496                                    (wxFormatString(f1)))                    \
 497         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 498                                    1, (const wxCStrData&),                  \
 499                                    (wxFormatString(f1)))                    \
 500         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 501                                    1, (const char*),                        \
 502                                    (wxFormatString(f1)))                    \
 503         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 504                                    1, (const wchar_t*),                     \
 505                                    (wxFormatString(f1)))
 506 #else
 507     #define DECLARE_LOG_FUNCTION_WATCOM(level)
 508 #endif
 509
 510
 511 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
 512     extern void expdecl wxDoLog##level##Wchar(argclass arg,                 \
 513                                               const wxChar *format, ...);   \
 514     extern void expdecl wxDoLog##level##Utf8(argclass arg,                  \
 515                                              const char *format, ...);      \
 516     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
 517                                2, (argclass, const wxFormatString&),        \
 518                                wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
 519     DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)         \
 520     extern void expdecl wxVLog##level(argclass arg,                         \
 521                                       const wxString& format,               \
 522                                       va_list argptr)
 523
 524 #ifdef __WATCOMC__
 525     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
 526     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
 527     // something too big for Borland C++ to handle
 528     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
 529         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 530                                    2, (argclass, const wxString&),          \
 531                                    (f1, wxFormatString(f2)))                \
 532         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 533                                    2, (argclass, const wxCStrData&),        \
 534                                    (f1, wxFormatString(f2)))                \
 535         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 536                                    2, (argclass, const char*),              \
 537                                    (f1, wxFormatString(f2)))                \
 538         WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
 539                                    2, (argclass, const wchar_t*),           \
 540                                    (f1, wxFormatString(f2)))
 541 #else
 542     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
 543 #endif
 544
 545
 546 #else // !wxUSE_LOG
 547
 548 #ifdef __WATCOMC__
 549     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 550     #define WX_WATCOM_ONLY_CODE( x )  x
 551 #else
 552     #define WX_WATCOM_ONLY_CODE( x )
 553 #endif
 554
 555 // log functions do nothing at all
 556 #define DECLARE_LOG_FUNCTION(level)                                         \
 557     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxString&))           \
 558     WX_WATCOM_ONLY_CODE(                                                    \
 559         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const char*))           \
 560         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wchar_t*))        \
 561         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&))     \
 562     )                                                                       \
 563     inline void wxVLog##level(const wxString& WXUNUSED(format),             \
 564                               va_list WXUNUSED(argptr)) { }                 \
 565
 566 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
 567     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
 568     WX_WATCOM_ONLY_CODE(                                                    \
 569         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const char*)) \
 570         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wchar_t*)) \
 571         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
 572     )                                                                       \
 573     inline void wxVLog##level(argclass WXUNUSED(arg),                       \
 574                               const wxString& WXUNUSED(format),             \
 575                               va_list WXUNUSED(argptr)) {}
 576
 577 // Empty Class to fake wxLogNull
 578 class WXDLLIMPEXP_BASE wxLogNull
 579 {
 580 public:
 581     wxLogNull() { }
 582 };
 583
 584 // Dummy macros to replace some functions.
 585 #define wxSysErrorCode() (unsigned long)0
 586 #define wxSysErrorMsg( X ) (const wxChar*)NULL
 587
 588 // Fake symbolic trace masks... for those that are used frequently
 589 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 590
 591 #endif // wxUSE_LOG/!wxUSE_LOG
 592
 593 #define DECLARE_LOG_FUNCTION2(level, argclass, arg)                         \
 594     DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
 595
 596 // VC6 produces a warning if we a macro expanding to nothing to
 597 // DECLARE_LOG_FUNCTION2:
 598 #if defined(__VISUALC__) && __VISUALC__ < 1300
 599     // "not enough actual parameters for macro 'DECLARE_LOG_FUNCTION2_EXP'"
 600     #pragma warning(disable:4003)
 601 #endif
 602
 603 // a generic function for all levels (level is passes as parameter)
 604 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
 605
 606 // one function per each level
 607 DECLARE_LOG_FUNCTION(FatalError);
 608 DECLARE_LOG_FUNCTION(Error);
 609 DECLARE_LOG_FUNCTION(Warning);
 610 DECLARE_LOG_FUNCTION(Message);
 611 DECLARE_LOG_FUNCTION(Info);
 612 DECLARE_LOG_FUNCTION(Verbose);
 613
 614 // this function sends the log message to the status line of the top level
 615 // application frame, if any
 616 DECLARE_LOG_FUNCTION(Status);
 617
 618 #if wxUSE_GUI
 619     // this one is the same as previous except that it allows to explicitly
 620     class WXDLLEXPORT wxFrame;
 621     // specify the frame to which the output should go
 622     DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
 623 #endif // wxUSE_GUI
 624
 625 // additional one: as wxLogError, but also logs last system call error code
 626 // and the corresponding error message if available
 627 DECLARE_LOG_FUNCTION(SysError);
 628
 629 // and another one which also takes the error code (for those broken APIs
 630 // that don't set the errno (like registry APIs in Win32))
 631 DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
 632 #ifdef __WATCOMC__
 633 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 634 DECLARE_LOG_FUNCTION2(SysError, unsigned long, lErrCode);
 635 #endif
 636
 637 // debug functions do nothing in release mode
 638 #if wxUSE_LOG && wxUSE_LOG_DEBUG
 639     DECLARE_LOG_FUNCTION(Debug);
 640
 641     // there is no more unconditional LogTrace: it is not different from
 642     // LogDebug and it creates overload ambiguities
 643     //DECLARE_LOG_FUNCTION(Trace);
 644
 645     // this version only logs the message if the mask had been added to the
 646     // list of masks with AddTraceMask()
 647     DECLARE_LOG_FUNCTION2(Trace, const wxString&, mask);
 648 #ifdef __WATCOMC__
 649     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 650     DECLARE_LOG_FUNCTION2(Trace, const char*, mask);
 651     DECLARE_LOG_FUNCTION2(Trace, const wchar_t*, mask);
 652 #endif
 653
 654     // and this one does nothing if all of level bits are not set in
 655     // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of
 656     // string identifiers
 657     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);
 658 #ifdef __WATCOMC__
 659     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 660     DECLARE_LOG_FUNCTION2(Trace, int, mask);
 661 #endif
 662 #else   //!debug || !wxUSE_LOG
 663     // these functions do nothing in release builds, but don't define them as
 664     // nothing as it could result in different code structure in debug and
 665     // release and this could result in trouble when these macros are used
 666     // inside if/else
 667     //
 668     // note that making wxVLogDebug/Trace() themselves (empty inline) functions
 669     // is a bad idea as some compilers are stupid enough to not inline even
 670     // empty functions if their parameters are complicated enough, but by
 671     // defining them as an empty inline function we ensure that even dumbest
 672     // compilers optimise them away
 673     inline void wxLogNop() { }
 674
 675     #define wxVLogDebug(fmt, valist) wxLogNop()
 676     #define wxVLogTrace(mask, fmt, valist) wxLogNop()
 677
 678     #ifdef HAVE_VARIADIC_MACROS
 679         // unlike the inline functions below, this completely removes the
 680         // wxLogXXX calls from the object file:
 681         #define wxLogDebug(fmt, ...) wxLogNop()
 682         #define wxLogTrace(mask, fmt, ...) wxLogNop()
 683     #else // !HAVE_VARIADIC_MACROS
 684         //inline void wxLogDebug(const wxString& fmt, ...) {}
 685         WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug, 1, (const wxString&))
 686         //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
 687         //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
 688         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (wxTraceMask, const wxString&))
 689         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wxString&, const wxString&))
 690         #ifdef __WATCOMC__
 691         // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 692         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const char*, const char*))
 693         WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wchar_t*, const wchar_t*))
 694         #endif
 695     #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
 696 #endif // debug/!debug
 697
 698 #if defined(__VISUALC__) && __VISUALC__ < 1300
 699     #pragma warning(default:4003)
 700 #endif
 701
 702 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 703 // i.e. without using wxMessageBox() for example because it could crash
 704 void WXDLLIMPEXP_BASE
 705 wxSafeShowMessage(const wxString& title, const wxString& text);
 706
 707 // ----------------------------------------------------------------------------
 708 // debug only logging functions: use them with API name and error code
 709 // ----------------------------------------------------------------------------
 710
 711 #ifdef __WXDEBUG__
 712     // make life easier for people using VC++ IDE: clicking on the message
 713     // will take us immediately to the place of the failed API
 714 #ifdef __VISUALC__
 715     #define wxLogApiError(api, rc)                                            \
 716         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
 717                    __FILE__, __LINE__, api,                                   \
 718                    (long)rc, wxSysErrorMsg(rc))
 719 #else // !VC++
 720     #define wxLogApiError(api, rc)                                            \
 721         wxLogDebug(wxT("In file %s at line %d: '%s' failed with ")            \
 722                    wxT("error 0x%08lx (%s)."),                                \
 723                    __FILE__, __LINE__, api,                                   \
 724                    (long)rc, wxSysErrorMsg(rc))
 725 #endif // VC++/!VC++
 726
 727     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 728
 729 #else   //!debug
 730     #define wxLogApiError(api, err) wxLogNop()
 731     #define wxLogLastError(api) wxLogNop()
 732 #endif  //debug/!debug
 733
 734 // wxCocoa has additiional trace masks
 735 #if defined(__WXCOCOA__)
 736 #include "wx/cocoa/log.h"
 737 #endif
 738
 739 #ifdef WX_WATCOM_ONLY_CODE
 740     #undef WX_WATCOM_ONLY_CODE
 741 #endif
 742
 743 #endif  // _WX_LOG_H_
 744