Corrected memory.cpp checkpoint bug; added Tex2RTF

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

diff --git a/include/wx/log.h b/include/wx/log.h
index c4550d25fd2b8a6f6188d610b4fe3a28e285a738..32c9b1f0e8905acaa2a204c32f8dd3737f4b3aee 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -9,15 +9,13 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef   __LOGH__
-#define   __LOGH__
+#ifndef   _WX_LOG_H_
+#define   _WX_LOG_H_

 
 #ifdef    __GNUG__
 #pragma interface "log.h"
 #endif
 
 
 #ifdef    __GNUG__
 #pragma interface "log.h"
 #endif
 

-#include "wx/intl.h"
-

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


@@ -51,6 +49,23 @@ enum
 typedef unsigned long wxTraceMask;
 typedef unsigned long wxLogLevel;
 
 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
+

 // ----------------------------------------------------------------------------
 // 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


@@ -61,9 +76,22 @@ public:
   // ctor
   wxLog();
 
   // 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)
   // sink function
   static void OnLog(wxLogLevel level, const char *szString)

-    { if ( ms_pLogger != 0 ) ms_pLogger->DoLog(level, szString); }
+  {
+    if ( IsEnabled() ) {
+      wxLog *pLogger = GetActiveTarget();
+      if ( pLogger )
+        pLogger->DoLog(level, szString);
+    }
+  }

 
   // message buffering
     // flush shows all messages if they're not logged immediately
 
   // message buffering
     // flush shows all messages if they're not logged immediately


@@ -77,10 +105,9 @@ public:
 
   // only one sink is active at each moment
     // get current log target, will call wxApp::CreateLogTarget() to create one
 
   // only one sink is active at each moment
     // get current log target, will call wxApp::CreateLogTarget() to create one

-    // if 
+    // if none exists

   static wxLog *GetActiveTarget();
   static wxLog *GetActiveTarget();

-    // change log target, pLogger = NULL disables logging,
-    // returns the previous log target
+    // change log target, pLogger may be NULL

   static wxLog *SetActiveTarget(wxLog *pLogger);
 
   // functions controlling the default wxLog behaviour
   static wxLog *SetActiveTarget(wxLog *pLogger);
 
   // functions controlling the default wxLog behaviour


@@ -122,10 +149,15 @@ protected:
     // you override DoLog() you might not need it at all
   virtual void DoLogString(const char *szString);
 
     // you override DoLog() you might not need it at all
   virtual void DoLogString(const char *szString);
 

+  // helpers
+    // put the time stamp in the current format into the string
+  wxString TimeStamp() const;
+

 private:
   // static variables
   // ----------------
   static wxLog      *ms_pLogger;      // currently active log sink
 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 bool        ms_bAutoCreate;  // automatically create new log targets?
   static wxTraceMask ms_ulTraceMask;  // controls wxLogTrace behaviour
 };


@@ -139,7 +171,7 @@ class WXDLLEXPORT wxLogStderr : public wxLog
 {
 public:
   // redirect log output to a FILE
 {
 public:
   // redirect log output to a FILE

-  wxLogStderr(FILE *fp = NULL);
+  wxLogStderr(FILE *fp = (FILE *) NULL);

 
 private:
   // implement sink function
 
 private:
   // implement sink function


@@ -153,7 +185,7 @@ class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
   // redirect log output to an ostream
 {
 public:
   // redirect log output to an ostream

-  wxLogStream(ostream *ostr = NULL);
+  wxLogStream(ostream *ostr = (ostream *) NULL);

 
 protected:
   // implement sink function
 
 protected:
   // implement sink function


@@ -163,8 +195,9 @@ protected:
   ostream *m_ostr;
 };
 
   ostream *m_ostr;
 };
 

+#ifndef wxUSE_NOGUI
+

 // log everything to a text window (GUI only of course)
 // log everything to a text window (GUI only of course)

-class wxTextCtrl;

 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 public:
 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 public:


@@ -198,12 +231,11 @@ protected:
 // 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.
 // ----------------------------------------------------------------------------
 // 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.
 // ----------------------------------------------------------------------------

-class wxLogFrame;
-class wxFrame;

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

-  wxLogWindow(const char *szTitle,      // the title of the frame
+  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();
               bool bShow = TRUE,        // show window immediately?
               bool bPassToOld = TRUE);  // pass log messages to the old target?
   ~wxLogWindow();


@@ -211,7 +243,7 @@ public:
   // window operations
     // show/hide the log window
   void Show(bool bShow = TRUE);
   // window operations
     // show/hide the log window
   void Show(bool bShow = TRUE);

-    // get the frame pointer (you shouldn't close it!)
+    // retrieve the pointer to the frame

   wxFrame *GetFrame() const;
 
   // accessors
   wxFrame *GetFrame() const;
 
   // accessors


@@ -225,6 +257,17 @@ public:
   // processing take place)
   void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
   // processing take place)
   void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 

+  // base class virtuals
+    // we don't need it ourselves, but we pass it to the previous logger
+  virtual void Flush();
+
+  // 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);
+

 protected:
   virtual void DoLog(wxLogLevel level, const char *szString);
   virtual void DoLogString(const char *szString);
 protected:
   virtual void DoLog(wxLogLevel level, const char *szString);
   virtual void DoLogString(const char *szString);


@@ -235,6 +278,8 @@ private:
   wxLogFrame *m_pLogFrame;      // the log frame
 };
 
   wxLogFrame *m_pLogFrame;      // the log frame
 };
 

+#endif // wxUSE_NOGUI
+

 // ----------------------------------------------------------------------------
 // /dev/null log target: suppress logging until this object goes out of scope
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // /dev/null log target: suppress logging until this object goes out of scope
 // ----------------------------------------------------------------------------


@@ -255,12 +300,11 @@ void Foo() {
 class WXDLLEXPORT wxLogNull
 {
 public:
 class WXDLLEXPORT wxLogNull
 {
 public:

-  // ctor saves old log target, dtor restores it
-  wxLogNull() { m_pPrevLogger = wxLog::SetActiveTarget(NULL); }
- ~wxLogNull() { (void)wxLog::SetActiveTarget(m_pPrevLogger);  }
+  wxLogNull() { m_flagOld = wxLog::EnableLogging(FALSE); }
+ ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld);   }

 
 private:
 
 private:

-  wxLog *m_pPrevLogger; // old log target
+  bool m_flagOld; // the previous value of the wxLog::ms_doLog

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -289,9 +333,16 @@ DECLARE_LOG_FUNCTION(Error);
 DECLARE_LOG_FUNCTION(Warning);
 DECLARE_LOG_FUNCTION(Message);
 DECLARE_LOG_FUNCTION(Info);
 DECLARE_LOG_FUNCTION(Warning);
 DECLARE_LOG_FUNCTION(Message);
 DECLARE_LOG_FUNCTION(Info);

-DECLARE_LOG_FUNCTION(Status);

 DECLARE_LOG_FUNCTION(Verbose);
 
 DECLARE_LOG_FUNCTION(Verbose);
 

+// this function sends the log message to the status line of the top level
+// application frame, if any
+DECLARE_LOG_FUNCTION(Status);
+
+// 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);
+

 // additional one: as wxLogError, but also logs last system call error code
 // and the corresponding error message if available
 DECLARE_LOG_FUNCTION(SysError);
 // additional one: as wxLogError, but also logs last system call error code
 // and the corresponding error message if available
 DECLARE_LOG_FUNCTION(SysError);


@@ -323,17 +374,14 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 //  parts of the program only)
 WXDLLEXPORT_DATA(extern bool) g_bVerbose;
 
 //  parts of the program only)
 WXDLLEXPORT_DATA(extern bool) g_bVerbose;
 

-// fwd decl to avoid including iostream.h here
-class ostream;
-

 // ----------------------------------------------------------------------------
 // get error code/error message from system in a portable way
 // ----------------------------------------------------------------------------
 
 // return the last system error code
 // ----------------------------------------------------------------------------
 // get error code/error message from system in a portable way
 // ----------------------------------------------------------------------------
 
 // return the last system error code

-unsigned long WXDLLEXPORT wxSysErrorCode();
+WXDLLEXPORT unsigned long wxSysErrorCode();

 // return the error message for given (or last if 0) error code
 // return the error message for given (or last if 0) error code

-const char* WXDLLEXPORT wxSysErrorMsg(unsigned long nErrCode = 0);
+WXDLLEXPORT const char* wxSysErrorMsg(unsigned long nErrCode = 0);

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


@@ -350,4 +398,4 @@ const char* WXDLLEXPORT wxSysErrorMsg(unsigned long nErrCode = 0);
   inline void wxLogLastError(const char *) { }
 #endif  //debug/!debug
 
   inline void wxLogLastError(const char *) { }
 #endif  //debug/!debug
 

-#endif  //__LOGH__
+#endif  // _WX_LOG_H_