include/wx/log.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _WX_LOG_H_
  13 #define   _WX_LOG_H_
  14
  15 #ifdef  __GNUG__
  16     #pragma interface "log.h"
  17 #endif
  18
  19 #include "wx/setup.h"
  20 #include "wx/string.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // forward declarations
  24 // ----------------------------------------------------------------------------
  25
  26 class WXDLLEXPORT wxTextCtrl;
  27 class WXDLLEXPORT wxLogFrame;
  28 class WXDLLEXPORT wxFrame;
  29
  30 // ----------------------------------------------------------------------------
  31 // types
  32 // ----------------------------------------------------------------------------
  33
  34 typedef unsigned long wxTraceMask;
  35 typedef unsigned long wxLogLevel;
  36
  37 // ----------------------------------------------------------------------------
  38 // headers
  39 // ----------------------------------------------------------------------------
  40
  41 #if wxUSE_LOG
  42
  43 #include <time.h>   // for time_t
  44
  45 #include "wx/dynarray.h"
  46
  47 // ----------------------------------------------------------------------------
  48 // constants
  49 // ----------------------------------------------------------------------------
  50
  51 // different standard log levels (you may also define your own)
  52 enum
  53 {
  54     wxLOG_FatalError, // program can't continue, abort immediately
  55     wxLOG_Error,      // a serious error, user must be informed about it
  56     wxLOG_Warning,    // user is normally informed about it but may be ignored
  57     wxLOG_Message,    // normal message (i.e. normal output of a non GUI app)
  58     wxLOG_Info,       // informational message (a.k.a. 'Verbose')
  59     wxLOG_Status,     // informational: might go to the status line of GUI app
  60     wxLOG_Debug,      // never shown to the user, disabled in release mode
  61     wxLOG_Trace,      // trace messages are also only enabled in debug mode
  62     wxLOG_Progress,   // used for progress indicator (not yet)
  63     wxLOG_User = 100  // user defined levels start here
  64 };
  65
  66 // symbolic trace masks - wxLogTrace("foo", "some trace message...") will be
  67 // discarded unless the string "foo" has been added to the list of allowed
  68 // ones with AddTraceMask()
  69
  70 #define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
  71 #define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
  72 #define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
  73 #define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
  74
  75 #ifdef  __WXMSW__
  76     #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
  77 #endif
  78
  79 // the trace masks have been superceded by symbolic trace constants, they're
  80 // for compatibility only andwill be removed soon - do NOT use them
  81
  82 // meaning of different bits of the trace mask (which allows selectively
  83 // enable/disable some trace messages)
  84 #define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
  85 #define wxTraceMessages 0x0002  // trace window messages/X callbacks
  86 #define wxTraceResAlloc 0x0004  // trace GDI resource allocation
  87 #define wxTraceRefCount 0x0008  // trace various ref counting operations
  88
  89 #ifdef  __WXMSW__
  90     #define wxTraceOleCalls 0x0100  // OLE interface calls
  91 #endif
  92
  93 #include "wx/ioswrap.h"
  94
  95 // ----------------------------------------------------------------------------
  96 // derive from this class to redirect (or suppress, or ...) log messages
  97 // normally, only a single instance of this class exists but it's not enforced
  98 // ----------------------------------------------------------------------------
  99
 100 class WXDLLEXPORT wxLog
 101 {
 102 public:
 103     // ctor
 104     wxLog();
 105
 106     // these functions allow to completely disable all log messages
 107         // is logging disabled now?
 108     static bool IsEnabled() { return ms_doLog; }
 109         // change the flag state, return the previous one
 110     static bool EnableLogging(bool doIt = TRUE)
 111         { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
 112
 113     // static sink function - see DoLog() for function to overload in the
 114     // derived classes
 115     static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
 116     {
 117         if ( IsEnabled() ) {
 118             wxLog *pLogger = GetActiveTarget();
 119             if ( pLogger )
 120                 pLogger->DoLog(level, szString, t);
 121         }
 122     }
 123
 124     // message buffering
 125         // flush shows all messages if they're not logged immediately (FILE
 126         // and iostream logs don't need it, but wxGuiLog does to avoid showing
 127         // 17 modal dialogs one after another)
 128     virtual void Flush();
 129         // call to Flush() may be optimized: call it only if this function
 130         // returns true (although Flush() also returns immediately if there is
 131         // no messages, this functions is more efficient because inline)
 132     bool HasPendingMessages() const { return m_bHasMessages; }
 133
 134     // only one sink is active at each moment
 135         // flush the active target if any
 136     static void FlushActive()
 137     {
 138         if ( !ms_suspendCount )
 139         {
 140             wxLog *log = GetActiveTarget();
 141             if ( log && log->HasPendingMessages() )
 142                 log->Flush();
 143         }
 144     }
 145         // get current log target, will call wxApp::CreateLogTarget() to
 146         // create one if none exists
 147     static wxLog *GetActiveTarget();
 148         // change log target, pLogger may be NULL
 149     static wxLog *SetActiveTarget(wxLog *pLogger);
 150
 151         // suspend the message flushing of the main target until the next call
 152         // to Resume() - this is mainly for internal use (to prevent wxYield()
 153         // from flashing the messages)
 154     static void Suspend() { ms_suspendCount++; }
 155         // must be called for each Suspend()!
 156     static void Resume() { ms_suspendCount--; }
 157
 158     // functions controlling the default wxLog behaviour
 159         // verbose mode is activated by standard command-line '-verbose'
 160         // option
 161     void SetVerbose(bool bVerbose = TRUE) { m_bVerbose = bVerbose; }
 162         // should GetActiveTarget() try to create a new log object if the
 163         // current is NULL?
 164     static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 165
 166         // trace mask (see wxTraceXXX constants for details)
 167     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
 168         // add string trace mask
 169     static void AddTraceMask(const wxString& str) { ms_aTraceMasks.Add(str); }
 170         // add string trace mask
 171     static void RemoveTraceMask(const wxString& str);
 172
 173         // sets the timestamp string: this is used as strftime() format string
 174         // for the log targets which add time stamps to the messages - set it
 175         // to NULL to disable time stamping completely.
 176     static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
 177
 178     // accessors
 179         // gets the verbose status
 180     bool GetVerbose() const { return m_bVerbose; }
 181         // get trace mask
 182     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
 183         // is this trace mask in the list?
 184     static bool IsAllowedTraceMask(const wxChar *mask)
 185         { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
 186
 187         // get the current timestamp format string (may be NULL)
 188     static const wxChar *GetTimestamp() { return ms_timestamp; }
 189
 190     // helpers
 191         // put the time stamp into the string if ms_timestamp != NULL (don't
 192         // change it otherwise)
 193     static void TimeStamp(wxString *str);
 194
 195     // make dtor virtual for all derived classes
 196     virtual ~wxLog() { }
 197
 198 protected:
 199     bool m_bHasMessages; // any messages in the queue?
 200     bool m_bVerbose;     // FALSE => ignore LogInfo messages
 201
 202     // the logging functions that can be overriden
 203         // default DoLog() prepends the time stamp and a prefix corresponding
 204         // to the message to szString and then passes it to DoLogString()
 205     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 206         // default DoLogString does nothing but is not pure virtual because if
 207         // you override DoLog() you might not need it at all
 208     virtual void DoLogString(const wxChar *szString, time_t t);
 209
 210 private:
 211     // static variables
 212     // ----------------
 213
 214     static wxLog      *ms_pLogger;      // currently active log sink
 215     static bool        ms_doLog;        // FALSE => all logging disabled
 216     static bool        ms_bAutoCreate;  // create new log targets on demand?
 217
 218     static size_t      ms_suspendCount; // if positive, logs are not flushed
 219
 220     // format string for strftime(), if NULL, time stamping log messages is
 221     // disabled
 222     static const wxChar *ms_timestamp;
 223
 224     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
 225     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
 226 };
 227
 228 // ----------------------------------------------------------------------------
 229 // "trivial" derivations of wxLog
 230 // ----------------------------------------------------------------------------
 231
 232 // log everything to a "FILE *", stderr by default
 233 class WXDLLEXPORT wxLogStderr : public wxLog
 234 {
 235 public:
 236     // redirect log output to a FILE
 237     wxLogStderr(FILE *fp = (FILE *) NULL);
 238
 239 private:
 240     // implement sink function
 241     virtual void DoLogString(const wxChar *szString, time_t t);
 242
 243     FILE *m_fp;
 244 };
 245
 246 #if wxUSE_STD_IOSTREAM
 247 // log everything to an "ostream", cerr by default
 248 class WXDLLEXPORT wxLogStream : public wxLog
 249 {
 250 public:
 251     // redirect log output to an ostream
 252     wxLogStream(ostream *ostr = (ostream *) NULL);
 253
 254 protected:
 255     // implement sink function
 256     virtual void DoLogString(const wxChar *szString, time_t t);
 257
 258     // using ptr here to avoid including <iostream.h> from this file
 259     ostream *m_ostr;
 260 };
 261 #endif
 262
 263 // the following log targets are only compiled in if the we're compiling the
 264 // GUI part (andnot just the base one) of the library, they're implemented in
 265 // src/generic/logg.cpp *and not src/common/log.cpp unlike all the rest)
 266
 267 #if wxUSE_GUI
 268
 269 // log everything to a text window (GUI only of course)
 270 class WXDLLEXPORT wxLogTextCtrl : public wxLog
 271 {
 272 public:
 273     wxLogTextCtrl(wxTextCtrl *pTextCtrl);
 274
 275 private:
 276     // implement sink function
 277     virtual void DoLogString(const wxChar *szString, time_t t);
 278
 279     // the control we use
 280     wxTextCtrl *m_pTextCtrl;
 281 };
 282
 283 // ----------------------------------------------------------------------------
 284 // GUI log target, the default one for wxWindows programs
 285 // ----------------------------------------------------------------------------
 286 class WXDLLEXPORT wxLogGui : public wxLog
 287 {
 288 public:
 289     // ctor
 290     wxLogGui();
 291
 292     // show all messages that were logged since the last Flush()
 293     virtual void Flush();
 294
 295 protected:
 296     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 297
 298     // empty everything
 299     void Clear();
 300
 301     wxArrayString m_aMessages;      // the log message texts
 302     wxArrayInt    m_aSeverity;      // one of wxLOG_XXX values
 303     wxArrayLong   m_aTimes;         // the time of each message
 304     bool          m_bErrors,        // do we have any errors?
 305                   m_bWarnings;      // any warnings?
 306 };
 307
 308 // ----------------------------------------------------------------------------
 309 // (background) log window: this class forwards all log messages to the log
 310 // target which was active when it was instantiated, but also collects them
 311 // to the log window. This window has it's own menu which allows the user to
 312 // close it, clear the log contents or save it to the file.
 313 // ----------------------------------------------------------------------------
 314 class WXDLLEXPORT wxLogWindow : public wxLog
 315 {
 316 public:
 317     wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
 318             const wxChar *szTitle,      // the title of the frame
 319             bool bShow = TRUE,        // show window immediately?
 320             bool bPassToOld = TRUE);  // pass log messages to the old target?
 321     ~wxLogWindow();
 322
 323     // window operations
 324         // show/hide the log window
 325     void Show(bool bShow = TRUE);
 326         // retrieve the pointer to the frame
 327     wxFrame *GetFrame() const;
 328
 329     // accessors
 330         // the previous log target (may be NULL)
 331     wxLog *GetOldLog() const { return m_pOldLog; }
 332         // are we passing the messages to the previous log target?
 333     bool IsPassingMessages() const { return m_bPassMessages; }
 334
 335     // we can pass the messages to the previous log target (we're in this mode by
 336     // default: we collect all messages in the window, but also let the default
 337     // processing take place)
 338     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 339
 340     // base class virtuals
 341         // we don't need it ourselves, but we pass it to the previous logger
 342     virtual void Flush();
 343
 344     // overridables
 345         // called immediately after the log frame creation allowing for
 346         // any extra initializations
 347     virtual void OnFrameCreate(wxFrame *frame);
 348         // called if the user closes the window interactively, will not be
 349         // called if it is destroyed for another reason (such as when program
 350         // exits) - return TRUE from here to allow the frame to close, FALSE
 351         // to prevent this from happening
 352     virtual bool OnFrameClose(wxFrame *frame);
 353         // called right before the log frame is going to be deleted: will
 354         // always be called unlike OnFrameClose()
 355     virtual void OnFrameDelete(wxFrame *frame);
 356
 357 protected:
 358     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 359     virtual void DoLogString(const wxChar *szString, time_t t);
 360
 361 private:
 362     bool        m_bPassMessages;  // pass messages to m_pOldLog?
 363     wxLog      *m_pOldLog;        // previous log target
 364     wxLogFrame *m_pLogFrame;      // the log frame
 365 };
 366
 367 #endif // wxUSE_GUI
 368
 369 // ----------------------------------------------------------------------------
 370 // /dev/null log target: suppress logging until this object goes out of scope
 371 // ----------------------------------------------------------------------------
 372
 373 // example of usage:
 374 /*
 375    void Foo() {
 376    wxFile file;
 377
 378 // wxFile.Open() normally complains if file can't be opened, we don't want it
 379 wxLogNull logNo;
 380 if ( !file.Open("bar") )
 381 ... process error ourselves ...
 382
 383 // ~wxLogNull called, old log sink restored
 384 }
 385  */
 386 class WXDLLEXPORT wxLogNull
 387 {
 388 public:
 389     wxLogNull() { m_flagOld = wxLog::EnableLogging(FALSE); }
 390     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld);   }
 391
 392 private:
 393     bool m_flagOld; // the previous value of the wxLog::ms_doLog
 394 };
 395
 396 // ============================================================================
 397 // global functions
 398 // ============================================================================
 399
 400 // ----------------------------------------------------------------------------
 401 // Log functions should be used by application instead of stdio, iostream &c
 402 // for log messages for easy redirection
 403 // ----------------------------------------------------------------------------
 404
 405 // are we in 'verbose' mode?
 406 // (note that it's often handy to change this var manually from the
 407 //  debugger, thus enabling/disabling verbose reporting for some
 408 //  parts of the program only)
 409 WXDLLEXPORT_DATA(extern bool) g_bVerbose;
 410
 411 // ----------------------------------------------------------------------------
 412 // get error code/error message from system in a portable way
 413 // ----------------------------------------------------------------------------
 414
 415 // return the last system error code
 416 WXDLLEXPORT unsigned long wxSysErrorCode();
 417 // return the error message for given (or last if 0) error code
 418 WXDLLEXPORT const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 419
 420 // define wxLog<level>
 421 // -------------------
 422
 423 #define DECLARE_LOG_FUNCTION(level)                                 \
 424 extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...)
 425 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 426 extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 427
 428 #else // !wxUSE_LOG
 429
 430 // log functions do nothing at all
 431 #define DECLARE_LOG_FUNCTION(level)                                 \
 432 inline void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) {}
 433 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 434 inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}
 435
 436 #endif // wxUSE_LOG/!wxUSE_LOG
 437
 438 // a generic function for all levels (level is passes as parameter)
 439 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
 440
 441 // one function per each level
 442 DECLARE_LOG_FUNCTION(FatalError);
 443 DECLARE_LOG_FUNCTION(Error);
 444 DECLARE_LOG_FUNCTION(Warning);
 445 DECLARE_LOG_FUNCTION(Message);
 446 DECLARE_LOG_FUNCTION(Info);
 447 DECLARE_LOG_FUNCTION(Verbose);
 448
 449 // this function sends the log message to the status line of the top level
 450 // application frame, if any
 451 DECLARE_LOG_FUNCTION(Status);
 452
 453 // this one is the same as previous except that it allows to explicitly
 454 // specify the frame to which the output should go
 455 DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
 456
 457 // additional one: as wxLogError, but also logs last system call error code
 458 // and the corresponding error message if available
 459 DECLARE_LOG_FUNCTION(SysError);
 460
 461 // and another one which also takes the error code (for those broken APIs
 462 // that don't set the errno (like registry APIs in Win32))
 463 DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 464
 465 // debug functions do nothing in release mode
 466 #ifdef  __WXDEBUG__
 467     DECLARE_LOG_FUNCTION(Debug);
 468
 469     // first king of LogTrace is uncoditional: it doesn't check the level,
 470     DECLARE_LOG_FUNCTION(Trace);
 471
 472     // this second version will only log the message if the mask had been
 473     // added to the list of masks with AddTraceMask()
 474     DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);
 475
 476     // the last one does nothing if all of level bits are not set
 477     // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
 478     // string identifiers
 479     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
 480 #else   //!debug
 481     // these functions do nothing in release builds
 482     inline void wxLogDebug(const wxChar *, ...) { }
 483     inline void wxLogTrace(const wxChar *, ...) { }
 484     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
 485     inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
 486 #endif // debug/!debug
 487
 488 // ----------------------------------------------------------------------------
 489 // debug only logging functions: use them with API name and error code
 490 // ----------------------------------------------------------------------------
 491
 492 #ifndef __TFILE__
 493     #define __XFILE__(x) Tx)
 494     #define __TFILE__ __XFILE__(__FILE__)
 495 #endif
 496
 497 #ifdef __WXDEBUG__
 498     // make life easier for people using VC++ IDE: clicking on the message
 499     // will take us immediately to the place of the failed API
 500 #ifdef __VISUALC__
 501     #define wxLogApiError(api, rc)                                            \
 502         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
 503                    __TFILE__, __LINE__, api,                              \
 504                    rc, wxSysErrorMsg(rc))
 505 #else // !VC++
 506     #define wxLogApiError(api, rc)                                            \
 507         wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
 508                       "error 0x%08lx (%s)."),                                 \
 509                    __TFILE__, __LINE__, api,                              \
 510                    rc, wxSysErrorMsg(rc))
 511 #endif // VC++/!VC++
 512
 513     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 514
 515 #else   //!debug
 516     inline void wxLogApiError(const wxChar *, long) { }
 517     inline void wxLogLastError(const wxChar *) { }
 518 #endif  //debug/!debug
 519
 520 #endif  // _WX_LOG_H_