Unicode compilation fix.

[wxWidgets.git] / include / wx / log.h

diff --git a/include/wx/log.h b/include/wx/log.h
index 074adb078f6f0e405f6ecf5a86881553482d7a80..f4b5163c2bd897661a4f93e65f7df4b2ff603453 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        log.h
+// Name:        wx/log.h

 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -12,10 +12,40 @@
 #ifndef   _WX_LOG_H_
 #define   _WX_LOG_H_
 
 #ifndef   _WX_LOG_H_
 #define   _WX_LOG_H_
 

-#ifdef    __GNUG__
-#pragma interface "log.h"
+#if defined(__GNUG__) && !defined(__APPLE__)
+    #pragma interface "log.h"

 #endif
 
 #endif
 

+#include "wx/setup.h"
+#include "wx/string.h"
+
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxTextCtrl;
+class WXDLLEXPORT wxLogFrame;
+class WXDLLEXPORT wxFrame;
+
+// ----------------------------------------------------------------------------
+// types
+// ----------------------------------------------------------------------------
+
+typedef unsigned long wxTraceMask;
+typedef unsigned long wxLogLevel;
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LOG
+
+#ifndef __WXWINCE__
+#include <time.h>   // for time_t
+#endif
+
+#include "wx/dynarray.h"
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -23,18 +53,34 @@
 // different standard log levels (you may also define your own)
 enum
 {
 // different standard log levels (you may also define your own)
 enum
 {

-  wxLOG_FatalError, // program can't continue, abort immediately
-  wxLOG_Error,      // a serious error, user must be informed about it
-  wxLOG_Warning,    // user is normally informed about it but may be ignored
-  wxLOG_Message,    // normal message (i.e. normal output of a non GUI app)
-  wxLOG_Info,       // informational message (a.k.a. 'Verbose')
-  wxLOG_Status,     // informational: might go to the status line of GUI app
-  wxLOG_Debug,      // never shown to the user, disabled in release mode
-  wxLOG_Trace,      // trace messages are also only enabled in debug mode
-  wxLOG_Progress,   // used for progress indicator (not yet)
-  wxLOG_User = 100  // user defined levels start here
+    wxLOG_FatalError, // program can't continue, abort immediately
+    wxLOG_Error,      // a serious error, user must be informed about it
+    wxLOG_Warning,    // user is normally informed about it but may be ignored
+    wxLOG_Message,    // normal message (i.e. normal output of a non GUI app)
+    wxLOG_Info,       // informational message (a.k.a. 'Verbose')
+    wxLOG_Status,     // informational: might go to the status line of GUI app
+    wxLOG_Debug,      // never shown to the user, disabled in release mode
+    wxLOG_Trace,      // trace messages are also only enabled in debug mode
+    wxLOG_Progress,   // used for progress indicator (not yet)
+    wxLOG_User = 100  // user defined levels start here

 };
 
 };
 

+// symbolic trace masks - wxLogTrace("foo", "some trace message...") will be
+// discarded unless the string "foo" has been added to the list of allowed
+// ones with AddTraceMask()
+
+#define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
+#define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
+#define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
+#define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
+
+#ifdef  __WXMSW__
+    #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
+#endif
+
+// the trace masks have been superceded by symbolic trace constants, they're
+// for compatibility only andwill be removed soon - do NOT use them
+

 // meaning of different bits of the trace mask (which allows selectively
 // enable/disable some trace messages)
 #define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
 // meaning of different bits of the trace mask (which allows selectively
 // enable/disable some trace messages)
 #define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)


@@ -43,123 +89,152 @@ enum
 #define wxTraceRefCount 0x0008  // trace various ref counting operations
 
 #ifdef  __WXMSW__
 #define wxTraceRefCount 0x0008  // trace various ref counting operations
 
 #ifdef  __WXMSW__

-  #define wxTraceOleCalls 0x0100  // OLE interface calls
+    #define wxTraceOleCalls 0x0100  // OLE interface calls

 #endif
 
 #endif
 

-typedef unsigned long wxTraceMask;
-typedef unsigned long wxLogLevel;
-
-// ----------------------------------------------------------------------------
-// forward declarations
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxLogFrame;
-class WXDLLEXPORT wxFrame;
-
-#if wxUSE_IOSTREAMH
-// N.B. BC++ doesn't have istream.h, ostream.h
-#  include <iostream.h>
-#else
-#  include <ostream>
-#  ifdef _MSC_VER
-      using namespace std;
-#  endif
-#endif
+#include "wx/ioswrap.h"

 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
 // normally, only a single instance of this class exists but it's not enforced
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
 // normally, only a single instance of this class exists but it's not enforced
 // ----------------------------------------------------------------------------

+

 class WXDLLEXPORT wxLog
 {
 public:
 class WXDLLEXPORT wxLog
 {
 public:

-  // ctor
-  wxLog();
-
-  // these functions allow to completely disable all log messages
-    // is logging disabled now?
-  static bool IsEnabled() { return ms_doLog; }
-    // change the flag state, return the previous one
-  static bool EnableLogging(bool doIt = TRUE)
-    { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
-
-  // sink function
-  static void OnLog(wxLogLevel level, const char *szString)
-  {
-    if ( IsEnabled() ) {
-      wxLog *pLogger = GetActiveTarget();
-      if ( pLogger )
-        pLogger->DoLog(level, szString);
+    // ctor
+    wxLog();
+
+    // Internal buffer.
+        // Allow replacement of the fixed size static buffer with
+        // a user allocated one.  Pass in NULL to restore the
+        // built in static buffer.
+    static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
+
+    // these functions allow to completely disable all log messages
+        // is logging disabled now?
+    static bool IsEnabled() { return ms_doLog; }
+        // change the flag state, return the previous one
+    static bool EnableLogging(bool doIt = TRUE)
+        { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
+
+    // static sink function - see DoLog() for function to overload in the
+    // derived classes
+    static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
+    {
+        if ( IsEnabled() ) {
+            wxLog *pLogger = GetActiveTarget();
+            if ( pLogger )
+                pLogger->DoLog(level, szString, t);
+        }
+    }
+
+    // message buffering
+        // flush shows all messages if they're not logged immediately (FILE
+        // and iostream logs don't need it, but wxGuiLog does to avoid showing
+        // 17 modal dialogs one after another)
+    virtual void Flush();
+        // call to Flush() may be optimized: call it only if this function
+        // returns true (although Flush() also returns immediately if there is
+        // no messages, this functions is more efficient because inline)
+    bool HasPendingMessages() const { return m_bHasMessages; }
+
+    // only one sink is active at each moment
+        // flush the active target if any
+    static void FlushActive()
+    {
+        if ( !ms_suspendCount )
+        {
+            wxLog *log = GetActiveTarget();
+            if ( log && log->HasPendingMessages() )
+                log->Flush();
+        }

     }
     }

-  }
-
-  // message buffering
-    // flush shows all messages if they're not logged immediately
-    // (FILE and iostream logs don't need it, but wxGuiLog does to avoid
-    //  showing 17 modal dialogs one after another)
-  virtual void Flush();
-    // call to Flush() may be optimized: call it only if this function
-    // returns true (although Flush() also returns immediately if there
-    // is no messages, this functions is more efficient because inline)
-  bool HasPendingMessages() const { return m_bHasMessages; }
-
-  // only one sink is active at each moment
-    // get current log target, will call wxApp::CreateLogTarget() to create one
-    // if none exists
-  static wxLog *GetActiveTarget();
-    // change log target, pLogger may be NULL
-  static wxLog *SetActiveTarget(wxLog *pLogger);
-
-  // functions controlling the default wxLog behaviour
-    // verbose mode is activated by standard command-line '-verbose' option
-  void SetVerbose(bool bVerbose = TRUE) { m_bVerbose = bVerbose; }
-    // sets the format for timestamp prepended by wxLog::DoLog(): it's
-    // passed to strftime() function, see it's documentation for details.
-    // no time stamp at all if szTF is NULL or empty
-    // NB: the string is not copied, so it's lifetime must be long enough!
-  void SetTimeStampFormat(const char *szTF) { m_szTimeFormat = szTF; }
-    // trace mask (see wxTraceXXX constants for details)
-  static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
-    // should GetActiveTarget() try to create a new log object if the current
-    // is NULL?
-  static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
-
-  // accessors
-    // gets the verbose status
-  bool GetVerbose() const { return m_bVerbose; }
-    // get current time format
-  const char *GetTimeStampFormat() const { return m_szTimeFormat; }
-    // get trace mask
-  static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
-
-  // make dtor virtual for all derived classes
-  virtual ~wxLog() { }
+        // get current log target, will call wxApp::CreateLogTarget() to
+        // create one if none exists
+    static wxLog *GetActiveTarget();
+        // change log target, pLogger may be NULL
+    static wxLog *SetActiveTarget(wxLog *pLogger);
+
+        // suspend the message flushing of the main target until the next call
+        // to Resume() - this is mainly for internal use (to prevent wxYield()
+        // from flashing the messages)
+    static void Suspend() { ms_suspendCount++; }
+        // must be called for each Suspend()!
+    static void Resume() { ms_suspendCount--; }
+
+    // functions controlling the default wxLog behaviour
+        // verbose mode is activated by standard command-line '-verbose'
+        // option
+    static void SetVerbose(bool bVerbose = TRUE) { ms_bVerbose = bVerbose; }
+        // should GetActiveTarget() try to create a new log object if the
+        // current is NULL?
+    static void DontCreateOnDemand();
+
+        // trace mask (see wxTraceXXX constants for details)
+    static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
+        // add string trace mask
+    static void AddTraceMask(const wxString& str) { ms_aTraceMasks.Add(str); }
+        // add string trace mask
+    static void RemoveTraceMask(const wxString& str);
+        // remove all string trace masks
+    static void ClearTraceMasks();
+       // get string trace masks
+    static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
+
+        // sets the timestamp string: this is used as strftime() format string
+        // for the log targets which add time stamps to the messages - set it
+        // to NULL to disable time stamping completely.
+    static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
+
+    // accessors
+        // gets the verbose status
+    static bool GetVerbose() { return ms_bVerbose; }
+        // get trace mask
+    static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
+        // is this trace mask in the list?
+    static bool IsAllowedTraceMask(const wxChar *mask)
+        { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
+
+        // get the current timestamp format string (may be NULL)
+    static const wxChar *GetTimestamp() { return ms_timestamp; }
+
+    // helpers
+        // put the time stamp into the string if ms_timestamp != NULL (don't
+        // change it otherwise)
+    static void TimeStamp(wxString *str);
+
+    // make dtor virtual for all derived classes
+    virtual ~wxLog() { }

 
 protected:
 
 protected:

-  bool m_bHasMessages;
+    bool m_bHasMessages; // any messages in the queue?

 
 

-  bool          m_bVerbose;     // FALSE => ignore LogInfo messages
-  const char   *m_szTimeFormat; // format for strftime()
+    // the logging functions that can be overriden
+        // default DoLog() prepends the time stamp and a prefix corresponding
+        // to the message to szString and then passes it to DoLogString()
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+        // default DoLogString does nothing but is not pure virtual because if
+        // you override DoLog() you might not need it at all
+    virtual void DoLogString(const wxChar *szString, time_t t);

 
 

-  // the logging functions that can be overriden
-    // default DoLog() prepends the time stamp and a prefix corresponding
-    // to the message to szString and then passes it to DoLogString()
-  virtual void DoLog(wxLogLevel level, const char *szString);
-    // default DoLogString does nothing but is not pure virtual because if
-    // you override DoLog() you might not need it at all
-  virtual void DoLogString(const char *szString);
+private:
+    // static variables
+    // ----------------

 
 

-  // helpers
-    // put the time stamp in the current format into the string
-  wxString TimeStamp() const;
+    static wxLog      *ms_pLogger;      // currently active log sink
+    static bool        ms_doLog;        // FALSE => all logging disabled
+    static bool        ms_bAutoCreate;  // create new log targets on demand?
+    static bool        ms_bVerbose;     // FALSE => ignore LogInfo messages

 
 

-private:
-  // static variables
-  // ----------------
-  static wxLog      *ms_pLogger;      // currently active log sink
-  static bool        ms_doLog;        // FALSE => all logging disabled
-  static bool        ms_bAutoCreate;  // automatically create new log targets?
-  static wxTraceMask ms_ulTraceMask;  // controls wxLogTrace behaviour
+    static size_t      ms_suspendCount; // if positive, logs are not flushed
+
+    // format string for strftime(), if NULL, time stamping log messages is
+    // disabled
+    static const wxChar *ms_timestamp;
+
+    static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
+    static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -169,148 +244,227 @@ private:
 // log everything to a "FILE *", stderr by default
 class WXDLLEXPORT wxLogStderr : public wxLog
 {
 // log everything to a "FILE *", stderr by default
 class WXDLLEXPORT wxLogStderr : public wxLog
 {

+    DECLARE_NO_COPY_CLASS(wxLogStderr)
+

 public:
 public:

-  // redirect log output to a FILE
-  wxLogStderr(FILE *fp = (FILE *) NULL);
+    // redirect log output to a FILE
+    wxLogStderr(FILE *fp = (FILE *) NULL);

 
 

-private:
-  // implement sink function
-  virtual void DoLogString(const char *szString);
+protected:
+    // implement sink function
+    virtual void DoLogString(const wxChar *szString, time_t t);

 
 

-  FILE *m_fp;
+    FILE *m_fp;

 };
 
 };
 

-#ifdef wxUSE_STD_IOSTREAM
+#if wxUSE_STD_IOSTREAM
+

 // log everything to an "ostream", cerr by default
 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
 // log everything to an "ostream", cerr by default
 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:

-  // redirect log output to an ostream
-  wxLogStream(ostream *ostr = (ostream *) NULL);
+    // redirect log output to an ostream
+    wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);

 
 protected:
 
 protected:

-  // implement sink function
-  virtual void DoLogString(const char *szString);
+    // implement sink function
+    virtual void DoLogString(const wxChar *szString, time_t t);

 
 

-  // @@ using ptr here to avoid including <iostream.h> from this file
-  ostream *m_ostr;
+    // using ptr here to avoid including <iostream.h> from this file
+    wxSTD ostream *m_ostr;

 };
 };

-#endif

 
 

-#ifndef wxUSE_NOGUI
+#endif // wxUSE_STD_IOSTREAM

 
 

-#ifdef wxUSE_STD_IOSTREAM
-// log everything to a text window (GUI only of course)
-class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
+// ----------------------------------------------------------------------------
+// /dev/null log target: suppress logging until this object goes out of scope
+// ----------------------------------------------------------------------------
+
+// example of usage:
+/*
+    void Foo()
+    {
+        wxFile file;
+
+        // wxFile.Open() normally complains if file can't be opened, we don't
+        // want it
+        wxLogNull logNo;
+
+        if ( !file.Open("bar") )
+            ... process error ourselves ...
+
+        // ~wxLogNull called, old log sink restored
+    }
+ */
+class WXDLLEXPORT wxLogNull

 {
 public:
 {
 public:

-  // we just create an ostream from wxTextCtrl and use it in base class
-  wxLogTextCtrl(wxTextCtrl *pTextCtrl);
- ~wxLogTextCtrl();
+    wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { }
+    ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
+
+private:
+    bool m_flagOld; // the previous value of the wxLog::ms_doLog

 };
 };

-#endif

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// GUI log target, the default one for wxWindows programs
+// chaining log target: installs itself as a log target and passes all
+// messages to the real log target given to it in the ctor but also forwards
+// them to the previously active one
+//
+// note that you don't have to call SetActiveTarget() with this class, it
+// does it itself in its ctor

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxLogGui : public wxLog
+
+class WXDLLEXPORT wxLogChain : public wxLog

 {
 public:
 {
 public:

-  // ctor
-  wxLogGui();
+    wxLogChain(wxLog *logger);
+    virtual ~wxLogChain();
+
+    // change the new log target
+    void SetLog(wxLog *logger);
+
+    // this can be used to temporarily disable (and then reenable) passing
+    // messages to the old logger (by default we do pass them)
+    void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
+
+    // are we passing the messages to the previous log target?
+    bool IsPassingMessages() const { return m_bPassMessages; }
+
+    // return the previous log target (may be NULL)
+    wxLog *GetOldLog() const { return m_logOld; }

 
 

-  // show all messages that were logged since the last Flush()
-  virtual void Flush();
+    // override base class version to flush the old logger as well
+    virtual void Flush();

 
 protected:
 
 protected:

-  virtual void DoLog(wxLogLevel level, const char *szString);
+    // pass the chain to the old logger if needed
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);

 
 

-  wxArrayString m_aMessages;
-  bool          m_bErrors;
+private:
+    // the current log target
+    wxLog *m_logNew;
+
+    // the previous log target
+    wxLog *m_logOld;
+
+    // do we pass the messages to the old logger?
+    bool m_bPassMessages;
+};
+
+// a chain log target which uses itself as the new logger
+class WXDLLEXPORT wxLogPassThrough : public wxLogChain
+{
+public:
+    wxLogPassThrough();

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// (background) log window: this class forwards all log messages to the log
-// target which was active when it was instantiated, but also collects them
-// to the log window. This window has it's own menu which allows the user to
-// close it, clear the log contents or save it to the file.
+// the following log targets are only compiled in if the we're compiling the
+// GUI part (andnot just the base one) of the library, they're implemented in
+// src/generic/logg.cpp *and not src/common/log.cpp unlike all the rest)

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxLogWindow : public wxLog
+
+#if wxUSE_GUI
+
+#if wxUSE_TEXTCTRL
+
+// log everything to a text window (GUI only of course)
+class WXDLLEXPORT wxLogTextCtrl : public wxLog

 {
 public:
 {
 public:

-  wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
-              const char *szTitle,      // the title of the frame
-              bool bShow = TRUE,        // show window immediately?
-              bool bPassToOld = TRUE);  // pass log messages to the old target?
-  ~wxLogWindow();
-
-  // window operations
-    // show/hide the log window
-  void Show(bool bShow = TRUE);
-    // retrieve the pointer to the frame
-  wxFrame *GetFrame() const;
-
-  // accessors
-    // the previous log target (may be NULL)
-  wxLog *GetOldLog() const { return m_pOldLog; }
-    // are we passing the messages to the previous log target?
-  bool IsPassingMessages() const { return m_bPassMessages; }
+    wxLogTextCtrl(wxTextCtrl *pTextCtrl);

 
 

-  // we can pass the messages to the previous log target (we're in this mode by
-  // default: we collect all messages in the window, but also let the default
-  // processing take place)
-  void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
+private:
+    // implement sink function
+    virtual void DoLogString(const wxChar *szString, time_t t);

 
 

-  // base class virtuals
-    // we don't need it ourselves, but we pass it to the previous logger
-  virtual void Flush();
+    // the control we use
+    wxTextCtrl *m_pTextCtrl;
+};

 
 

-  // overridables
-    // called immediately after the log frame creation allowing for
-    // any extra initializations
-  virtual void OnFrameCreate(wxFrame *frame);
-    // called right before the log frame is going to be deleted
-  virtual void OnFrameDelete(wxFrame *frame);
+#endif // wxUSE_TEXTCTRL
+
+// ----------------------------------------------------------------------------
+// GUI log target, the default one for wxWindows programs
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LOGGUI
+
+class WXDLLEXPORT wxLogGui : public wxLog
+{
+public:
+    // ctor
+    wxLogGui();
+
+    // show all messages that were logged since the last Flush()
+    virtual void Flush();

 
 protected:
 
 protected:

-  virtual void DoLog(wxLogLevel level, const char *szString);
-  virtual void DoLogString(const char *szString);
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);

 
 

-private:
-  bool        m_bPassMessages;  // pass messages to m_pOldLog?
-  wxLog      *m_pOldLog;        // previous log target
-  wxLogFrame *m_pLogFrame;      // the log frame
+    // empty everything
+    void Clear();
+
+    wxArrayString m_aMessages;      // the log message texts
+    wxArrayInt    m_aSeverity;      // one of wxLOG_XXX values
+    wxArrayLong   m_aTimes;         // the time of each message
+    bool          m_bErrors,        // do we have any errors?
+                  m_bWarnings;      // any warnings?

 };
 
 };
 

-#endif // wxUSE_NOGUI
+#endif // wxUSE_LOGGUI

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// /dev/null log target: suppress logging until this object goes out of scope
+// (background) log window: this class forwards all log messages to the log
+// target which was active when it was instantiated, but also collects them
+// to the log window. This window has it's own menu which allows the user to
+// close it, clear the log contents or save it to the file.

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// example of usage:
-/*
-void Foo() {
-  wxFile file;
+#if wxUSE_LOGWINDOW

 
 

-  // wxFile.Open() normally complains if file can't be opened, we don't want it
-  wxLogNull logNo;
-  if ( !file.Open("bar") )
-    ... process error ourselves ...
-
-  // ~wxLogNull called, old log sink restored
-}
-*/
-class WXDLLEXPORT wxLogNull
+class WXDLLEXPORT wxLogWindow : public wxLogPassThrough

 {
 public:
 {
 public:

-  wxLogNull() { m_flagOld = wxLog::EnableLogging(FALSE); }
- ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld);   }
+    wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
+                const wxChar *szTitle,    // the title of the frame
+                bool bShow = TRUE,        // show window immediately?
+                bool bPassToOld = TRUE);  // pass messages to the old target?
+
+    ~wxLogWindow();
+
+    // window operations
+        // show/hide the log window
+    void Show(bool bShow = TRUE);
+        // retrieve the pointer to the frame
+    wxFrame *GetFrame() const;
+
+    // overridables
+        // called immediately after the log frame creation allowing for
+        // any extra initializations
+    virtual void OnFrameCreate(wxFrame *frame);
+        // called if the user closes the window interactively, will not be
+        // called if it is destroyed for another reason (such as when program
+        // exits) - return TRUE from here to allow the frame to close, FALSE
+        // to prevent this from happening
+    virtual bool OnFrameClose(wxFrame *frame);
+        // called right before the log frame is going to be deleted: will
+        // always be called unlike OnFrameClose()
+    virtual void OnFrameDelete(wxFrame *frame);
+
+protected:
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxChar *szString, time_t t);

 
 private:
 
 private:

-  bool m_flagOld; // the previous value of the wxLog::ms_doLog
+    wxLogFrame *m_pLogFrame;      // the log frame

 };
 
 };
 

+#endif // wxUSE_LOGWINDOW
+
+#endif // wxUSE_GUI
+

 // ============================================================================
 // global functions
 // ============================================================================
 // ============================================================================
 // global functions
 // ============================================================================


@@ -320,13 +474,44 @@ private:
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 

+// ----------------------------------------------------------------------------
+// get error code/error message from system in a portable way
+// ----------------------------------------------------------------------------
+
+// return the last system error code
+WXDLLEXPORT unsigned long wxSysErrorCode();
+
+// return the error message for given (or last if 0) error code
+WXDLLEXPORT const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
+
+// ----------------------------------------------------------------------------

 // define wxLog<level>
 // define wxLog<level>

-// -------------------
+// ----------------------------------------------------------------------------
+
+#define DECLARE_LOG_FUNCTION(level)                                 \
+extern void WXDLLEXPORT wxVLog##level(const wxChar *szFormat,       \
+                                      va_list argptr);              \
+extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat,        \
+                                     ...) ATTRIBUTE_PRINTF_1
+#define DECLARE_LOG_FUNCTION2(level, arg1)                          \
+extern void WXDLLEXPORT wxVLog##level(arg1, const wxChar *szFormat, \
+                                      va_list argptr);              \
+extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat,  \
+                                     ...) ATTRIBUTE_PRINTF_2
+
+#else // !wxUSE_LOG

 
 

+// log functions do nothing at all

 #define DECLARE_LOG_FUNCTION(level)                                 \
 #define DECLARE_LOG_FUNCTION(level)                                 \

-        extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...)
+inline void WXDLLEXPORT wxVLog##level(const wxChar *szFormat,       \
+                                     va_list argptr) {}             \
+inline void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) {}

 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \

-        extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...)
+inline void WXDLLEXPORT wxVLog##level(arg1, const wxChar *szFormat, \
+                                     va_list argptr) {}             \
+inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}
+
+#endif // wxUSE_LOG/!wxUSE_LOG

 
 // a generic function for all levels (level is passes as parameter)
 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
 
 // a generic function for all levels (level is passes as parameter)
 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);


@@ -343,7 +528,7 @@ DECLARE_LOG_FUNCTION(Verbose);
 // application frame, if any
 DECLARE_LOG_FUNCTION(Status);
 
 // application frame, if any
 DECLARE_LOG_FUNCTION(Status);
 

-// this one is the same as previous except that it allows to explicitly 
+// this one is the same as previous except that it allows to explicitly

 // specify the frame to which the output should go
 DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
 
 // specify the frame to which the output should go
 DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
 


@@ -357,49 +542,62 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 
 // debug functions do nothing in release mode
 #ifdef  __WXDEBUG__
 
 // debug functions do nothing in release mode
 #ifdef  __WXDEBUG__

-  DECLARE_LOG_FUNCTION(Debug);
-
-  // first king of LogTrace is uncoditional: it doesn't check the level,
-  // while the second one does nothing if all of level bits are not set
-  // in wxLog::GetActive()->GetTraceMask().
-  DECLARE_LOG_FUNCTION(Trace);
-  DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
-#else   //!debug
-  // these functions do nothing
-  inline void wxLogDebug(const char *, ...) { }
-  inline void wxLogTrace(const char *, ...) { }
-  inline void wxLogTrace(wxTraceMask, const char *, ...) { }
-#endif
+    DECLARE_LOG_FUNCTION(Debug);

 
 

+    // first kind of LogTrace is unconditional: it doesn't check the level,
+    DECLARE_LOG_FUNCTION(Trace);

 
 

-// are we in 'verbose' mode?
-// (note that it's often handy to change this var manually from the
-//  debugger, thus enabling/disabling verbose reporting for some
-//  parts of the program only)
-WXDLLEXPORT_DATA(extern bool) g_bVerbose;
-
-// ----------------------------------------------------------------------------
-// get error code/error message from system in a portable way
-// ----------------------------------------------------------------------------
+    // this second version will only log the message if the mask had been
+    // added to the list of masks with AddTraceMask()
+    DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);

 
 

-// return the last system error code
-WXDLLEXPORT unsigned long wxSysErrorCode();
-// return the error message for given (or last if 0) error code
-WXDLLEXPORT const char* wxSysErrorMsg(unsigned long nErrCode = 0);
+    // the last one does nothing if all of level bits are not set
+    // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
+    // string identifiers
+    DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
+#else   //!debug
+    // these functions do nothing in release builds
+    inline void wxVLogDebug(const wxChar *, va_list) { }
+    inline void wxLogDebug(const wxChar *, ...) { }
+    inline void wxVLogTrace(const wxChar *, va_list) { }
+    inline void wxLogTrace(const wxChar *, ...) { }
+    inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
+    inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
+    inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
+    inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
+#endif // debug/!debug
+
+// wxLogFatalError helper: show the (fatal) error to the user in a safe way,
+// i.e. without using wxMessageBox() for example because it could crash
+void WXDLLEXPORT wxSafeShowMessage(const wxString& title, const wxString& text);

 
 // ----------------------------------------------------------------------------
 // debug only logging functions: use them with API name and error code
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // debug only logging functions: use them with API name and error code
 // ----------------------------------------------------------------------------
 

-#ifdef  __WXDEBUG__
-  #define wxLogApiError(api, rc)                                              \
-                    wxLogDebug("At %s(%d) '%s' failed with error %lx (%s).",  \
-                               __FILE__, __LINE__, api,                       \
-                               rc, wxSysErrorMsg(rc))
-  #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
+#ifdef __WXDEBUG__
+    // make life easier for people using VC++ IDE: clicking on the message
+    // will take us immediately to the place of the failed API
+#ifdef __VISUALC__
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
+                   __TFILE__, __LINE__, api,                                  \
+                   (long)rc, wxSysErrorMsg(rc))
+#else // !VC++
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
+                       "error 0x%08lx (%s)."),                                \
+                   __TFILE__, __LINE__, api,                                  \
+                   (long)rc, wxSysErrorMsg(rc))
+#endif // VC++/!VC++
+
+    #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
+

 #else   //!debug
 #else   //!debug

-  inline void wxLogApiError(const char *, long) { }
-  inline void wxLogLastError(const char *) { }
+    inline void wxLogApiError(const wxChar *, long) { }
+    inline void wxLogLastError(const wxChar *) { }

 #endif  //debug/!debug
 
 #endif  // _WX_LOG_H_
 #endif  //debug/!debug
 
 #endif  // _WX_LOG_H_

+
+// vi:sts=4:sw=4:et