wxUSE_SOCKETS added to setup(0).h; Cygwin corrections; doc tweaks

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 50918b2c021d9f566bbeb3e2828b5e1a57a7b601..db595e7664c1c59cf1c46ca4ffebfc4f15277209 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -9,8 +9,8 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

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

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


@@ -52,10 +52,19 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------

-class wxTextCtrl;
-class wxLogFrame;
-class wxFrame;
-class ostream;
+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>
+#   if defined(__VISUALC__) || defined(__MWERKS__)
+        using namespace std;
+#   endif
+#endif

 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages


@@ -67,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


@@ -83,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


@@ -136,6 +157,7 @@ private:
   // static variables
   // ----------------
   static wxLog      *ms_pLogger;      // currently active log sink
   // 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
 };


@@ -149,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


@@ -158,12 +180,13 @@ private:
   FILE *m_fp;
 };
 
   FILE *m_fp;
 };
 

+#if wxUSE_STD_IOSTREAM

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

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

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


@@ -172,7 +195,11 @@ protected:
   // @@ 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
   ostream *m_ostr;
 };

+#endif
+
+#ifndef wxUSE_NOGUI

 
 

+#if wxUSE_STD_IOSTREAM

 // log everything to a text window (GUI only of course)
 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 // log everything to a text window (GUI only of course)
 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {


@@ -181,6 +208,7 @@ public:
   wxLogTextCtrl(wxTextCtrl *pTextCtrl);
  ~wxLogTextCtrl();
 };
   wxLogTextCtrl(wxTextCtrl *pTextCtrl);
  ~wxLogTextCtrl();
 };

+#endif

 
 // ----------------------------------------------------------------------------
 // GUI log target, the default one for wxWindows programs
 
 // ----------------------------------------------------------------------------
 // GUI log target, the default one for wxWindows programs


@@ -254,6 +282,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
 // ----------------------------------------------------------------------------


@@ -274,12 +304,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

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


@@ -349,17 +378,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


@@ -376,4 +402,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_