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