Removed old wxGLCanvas stuff; moved wxTreeLayout to wxWindows; corrected some doc...

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 3798dec97c1fa267ad0402e0b9a54112511d7cba..f5138cf988e40d91f0fbc23a7dbd9e1761c6ca81 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -16,6 +16,28 @@
     #pragma interface "log.h"
 #endif
 
     #pragma interface "log.h"
 #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
 
 #include <time.h>   // for time_t
 #if wxUSE_LOG
 
 #include <time.h>   // for time_t


@@ -45,13 +67,13 @@ enum
 // discarded unless the string "foo" has been added to the list of allowed
 // ones with AddTraceMask()
 
 // discarded unless the string "foo" has been added to the list of allowed
 // ones with AddTraceMask()
 

-#define wxTRACE_MemAlloc "memalloc" // trace memory allocation (new/delete)
-#define wxTRACE_Messages "messages" // trace window messages/X callbacks
-#define wxTRACE_ResAlloc "resalloc" // trace GDI resource allocation
-#define wxTRACE_RefCount "refcount" // trace various ref counting operations
+#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__
 
 #ifdef  __WXMSW__

-    #define wxTRACE_OleCalls "ole"  // OLE interface calls
+    #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls

 #endif
 
 // the trace masks have been superceded by symbolic trace constants, they're
 #endif
 
 // the trace masks have been superceded by symbolic trace constants, they're


@@ -68,26 +90,7 @@ enum
     #define wxTraceOleCalls 0x0100  // OLE interface calls
 #endif
 
     #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
+#include "wx/ioswrap.h"

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


@@ -129,12 +132,29 @@ public:
     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

+        // flush the active target if any
+    static void FlushActive()
+    {
+        if ( !ms_suspendCount )
+        {
+            wxLog *log = GetActiveTarget();
+            if ( log && log->HasPendingMessages() )
+                log->Flush();
+        }
+    }

         // 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);
 
         // 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
     // functions controlling the default wxLog behaviour
         // verbose mode is activated by standard command-line '-verbose'
         // option


@@ -150,6 +170,11 @@ public:
         // add string trace mask
     static void RemoveTraceMask(const wxString& str);
 
         // add string trace mask
     static void RemoveTraceMask(const wxString& str);
 

+        // 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
     bool GetVerbose() const { return m_bVerbose; }
     // accessors
         // gets the verbose status
     bool GetVerbose() const { return m_bVerbose; }


@@ -159,6 +184,14 @@ public:
     static bool IsAllowedTraceMask(const wxChar *mask)
         { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
 
     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() { }
 
     // make dtor virtual for all derived classes
     virtual ~wxLog() { }
 


@@ -182,6 +215,12 @@ private:
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 

+    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
 };
     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
 };


@@ -221,18 +260,25 @@ protected:
 };
 #endif
 
 };
 #endif
 

-#ifndef wxUSE_NOGUI
+// 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)
+
+#if wxUSE_GUI

 
 

-#if wxUSE_STD_IOSTREAM

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

-class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
+class WXDLLEXPORT wxLogTextCtrl : public wxLog

 {
 public:
 {
 public:

-    // we just create an ostream from wxTextCtrl and use it in base class

     wxLogTextCtrl(wxTextCtrl *pTextCtrl);
     wxLogTextCtrl(wxTextCtrl *pTextCtrl);

-    ~wxLogTextCtrl();
+
+private:
+    // implement sink function
+    virtual void DoLogString(const wxChar *szString, time_t t);
+
+    // the control we use
+    wxTextCtrl *m_pTextCtrl;

 };
 };

-#endif

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


@@ -252,8 +298,9 @@ protected:
     // empty everything
     void Clear();
 
     // empty everything
     void Clear();
 

-    wxArrayString m_aMessages;
-    wxArrayLong   m_aTimes;
+    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?
 };
     bool          m_bErrors,        // do we have any errors?
                   m_bWarnings;      // any warnings?
 };


@@ -311,7 +358,7 @@ private:
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 

-#endif // wxUSE_NOGUI
+#endif // wxUSE_GUI

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


@@ -376,10 +423,9 @@ extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                 \
 
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                 \

-inline void WXDLLEXPORT wxLog##level(const wxChar * WXUNUSED(szFormat), ...) {}
+inline void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) {}

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

-inline void WXDLLEXPORT wxLog##level(WXUNUSED(arg1),                \
-                                     const wxChar *WXUNUSED(szFormat), ...) {}
+inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}

 
 #endif // wxUSE_LOG/!wxUSE_LOG
 
 
 #endif // wxUSE_LOG/!wxUSE_LOG
 


@@ -438,23 +484,23 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 // ----------------------------------------------------------------------------
 
 #ifndef __TFILE__
 // ----------------------------------------------------------------------------
 
 #ifndef __TFILE__

-    #define __XFILE__(x) _T(x)
+    #define __XFILE__(x) Tx)

     #define __TFILE__ __XFILE__(__FILE__)
 #endif
 
     #define __TFILE__ __XFILE__(__FILE__)
 #endif
 

-#if __WXDEBUG__
+#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__
     // 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(_T("%s(%d): '%s' failed with error 0x%08lx (%s)."),          \
-                   __TFILE__, __LINE__, api,                                    \
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
+                   __TFILE__, __LINE__, _T(api),                              \

                    rc, wxSysErrorMsg(rc))
 #else // !VC++
                    rc, wxSysErrorMsg(rc))
 #else // !VC++

-    #define wxLogApiError(api, rc)                                              \
-        wxLogDebug(_T("In file %s at line %d: '%s' failed with "                \
-                      "error 0x%08lx (%s)."),                                   \
-                   __TFILE__, __LINE__, api,                                    \
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
+                      "error 0x%08lx (%s)."),                                 \
+                   __TFILE__, __LINE__, _T(api),                              \

                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++
 
                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++