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 7a3fd73d9e1fd71016fdc480bff4ceed29b85499..db595e7664c1c59cf1c46ca4ffebfc4f15277209 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -9,72 +9,128 @@
 // 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"

-#endif  //GNU C++
+#endif
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// 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
+};
+
+// meaning of different bits of the trace mask (which allows selectively
+// enable/disable some trace messages)
+#define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
+#define wxTraceMessages 0x0002  // trace window messages/X callbacks
+#define wxTraceResAlloc 0x0004  // trace GDI resource allocation
+#define wxTraceRefCount 0x0008  // trace various ref counting operations
+
+#ifdef  __WXMSW__
+  #define wxTraceOleCalls 0x0100  // OLE interface calls
+#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>
+#   if defined(__VISUALC__) || defined(__MWERKS__)
+        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

-//
-// ## would ne nice to add a time stamp to log messages

 // ----------------------------------------------------------------------------
 class WXDLLEXPORT wxLog
 {
 public:
 // ----------------------------------------------------------------------------
 class WXDLLEXPORT wxLog
 {
 public:

-  enum Level
-  {
-    FatalError, // program can't continue, abort immediately
-    Error,      // a serious error, user must be informed about it
-    Warning,    // warning: user is normally informed about but may ignore it
-    Message,    // normal message (i.e. normal output of a non GUI app)
-    Info,       // informational message (a.k.a. 'Verbose')
-    Status,     // informational: might go to the status line of GUI app
-    Debug,      // never shown to the user, disabled in release mode
-    Trace,      // trace messages are also only enabled in debug mode
-    Progress,   // used for progress indicator (not yet)
-    User1,      // user defined levels (use with wxLogGeneric(wxLog::User1,...)
-    User2,      //
-    User3,      //
-  };
-

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

-  static void OnLog(Level level, const char *szString)
-    { if ( ms_pLogger != 0 ) ms_pLogger->DoLog(level, szString); }
+  static void OnLog(wxLogLevel level, const char *szString)
+  {
+    if ( IsEnabled() ) {
+      wxLog *pLogger = GetActiveTarget();
+      if ( pLogger )
+        pLogger->DoLog(level, szString);
+    }
+  }

 
   // 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();
 
   // 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 Flush() only if this function returns true
+    // 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
   bool HasPendingMessages() const { return m_bHasMessages; }
 
   // only one sink is active at each moment

-    // get current log target
+    // get current log target, will call wxApp::CreateLogTarget() to create one
+    // 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
     // verbose mode is activated by standard command-line '-verbose' option
   static wxLog *SetActiveTarget(wxLog *pLogger);
 
   // 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; }
+  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.
     // sets the format for timestamp prepended by wxLog::DoLog(): it's
     // passed to strftime() function, see it's documentation for details.

-    // the string is not copied!
-  static void SetTimeStampFormat(const char *szTimeFormat)
-    { ms_szTimeFormat = szTimeFormat; }
+    // 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
 
   // accessors
     // gets the verbose status

-  static bool GetVerbose() { return ms_bVerbose; }
+  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() { }
 
   // make dtor virtual for all derived classes
   virtual ~wxLog() { }


@@ -82,22 +138,28 @@ public:
 protected:
   bool m_bHasMessages;
 
 protected:
   bool m_bHasMessages;
 

-  // static variables
-  // ----------------
-  static bool        ms_bVerbose;     // FALSE => ignore LogInfo messages
-  static const char *ms_szTimeFormat; // format for strftime()
+  bool          m_bVerbose;     // FALSE => ignore LogInfo messages
+  const char   *m_szTimeFormat; // format for strftime()

 
 

-private:

   // 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()
   // 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(Level level, const char *szString);
+  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);
     // 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);

-  
-  static wxLog *ms_pLogger;       // currently active log sink
-  static bool   ms_bInitialized;  // any log targets created?
+
+  // 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
+  static bool        ms_doLog;        // FALSE => all logging disabled
+  static bool        ms_bAutoCreate;  // automatically create new log targets?
+  static wxTraceMask ms_ulTraceMask;  // controls wxLogTrace behaviour

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


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


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


@@ -132,8 +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
 {


@@ -142,7 +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


@@ -157,12 +223,67 @@ public:
   virtual void Flush();
 
 protected:
   virtual void Flush();
 
 protected:

-  virtual void DoLog(Level level, const char *szString);
+  virtual void DoLog(wxLogLevel level, const char *szString);

 
   wxArrayString m_aMessages;
   bool          m_bErrors;
 };
 
 
   wxArrayString m_aMessages;
   bool          m_bErrors;
 };
 

+// ----------------------------------------------------------------------------
+// (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.
+// ----------------------------------------------------------------------------
+class WXDLLEXPORT wxLogWindow : public wxLog
+{
+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; }
+
+  // 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; }
+
+  // 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);
+
+private:
+  bool        m_bPassMessages;  // pass messages to m_pOldLog?
+  wxLog      *m_pOldLog;        // previous log target
+  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
 // ----------------------------------------------------------------------------


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

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


@@ -203,16 +323,13 @@ private:
 // define wxLog<level>
 // -------------------
 
 // define wxLog<level>
 // -------------------
 

-// NB: all these functions take `wxTString' and not
-//     `const wxTString&' because according to C++ standard
-//     the first argument to a vararg function can not be
-//     an array, function or reference :-(
-
-// the most generic log function
-void WXDLLEXPORT wxLogGeneric(wxLog::Level level, wxTString strFormat, ...);
-

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

-        extern void WXDLLEXPORT wxLog##level(wxTString strFormat, ...)
+        extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...)
+#define DECLARE_LOG_FUNCTION2(level, arg1)                          \
+        extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...)
+
+// a generic function for all levels (level is passes as parameter)
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);

 
 // one function per each level
 DECLARE_LOG_FUNCTION(FatalError);
 
 // one function per each level
 DECLARE_LOG_FUNCTION(FatalError);


@@ -220,24 +337,40 @@ 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);
 
 // and another one which also takes the error code (for those broken APIs
 // that don't set the errno (like registry APIs in Win32))
 // additional one: as wxLogError, but also logs last system call error code
 // and the corresponding error message if available
 DECLARE_LOG_FUNCTION(SysError);
 
 // and another one which also takes the error code (for those broken APIs
 // that don't set the errno (like registry APIs in Win32))

-void WXDLLEXPORT wxLogSysError(long lErrCode, wxTString strFormat, ...);
+DECLARE_LOG_FUNCTION2(SysError, long lErrCode);

 
 

-// debug functions don't translate their arguments
-#undef  DECLARE_LOG_FUNCTION
-#define DECLARE_LOG_FUNCTION(level)                                 \
-        extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...)
+// 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);
-DECLARE_LOG_FUNCTION(Trace);

 
 // are we in 'verbose' mode?
 // (note that it's often handy to change this var manually from the
 
 // are we in 'verbose' mode?
 // (note that it's often handy to change this var manually from the


@@ -245,31 +378,28 @@ DECLARE_LOG_FUNCTION(Trace);
 //  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
 // ----------------------------------------------------------------------------
 

-#ifdef  __DEBUG__
+#ifdef  __WXDEBUG__

   #define wxLogApiError(api, rc)                                              \
                     wxLogDebug("At %s(%d) '%s' failed with error %lx (%s).",  \
                                __FILE__, __LINE__, api,                       \
                                rc, wxSysErrorMsg(rc))
   #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, ::GetLastError())
+  #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())

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

-  #define wxLogApiError(api, rc)
-  #define wxLogLastError(api)
+  inline void wxLogApiError(const char *, long) { }
+  inline void wxLogLastError(const char *) { }

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

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