better-looking icons

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 63665e86916d60cd3743db4ce1da711860cc5742..c000ac1274f64c0c2a57f0952982b2465ed462e3 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -16,6 +16,30 @@
     #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
 
 #include "wx/dynarray.h"
 #include <time.h>   // for time_t
 
 #include "wx/dynarray.h"


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


@@ -127,6 +132,13 @@ 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()
+    {
+        wxLog *log = GetActiveTarget();
+        if ( log )
+            log->Flush();
+    }

         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
     static wxLog *GetActiveTarget();
         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
     static wxLog *GetActiveTarget();


@@ -148,6 +160,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; }


@@ -157,6 +174,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() { }
 


@@ -180,6 +205,10 @@ 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?
 

+    // 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
 };


@@ -219,18 +248,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


@@ -309,7 +345,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


@@ -347,6 +383,21 @@ private:
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 

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


@@ -355,34 +406,44 @@ extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...)
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 

-    // a generic function for all levels (level is passes as parameter)
-    DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
+#else // !wxUSE_LOG
+
+// log functions do nothing at all
+#define DECLARE_LOG_FUNCTION(level)                                 \
+inline void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) {}
+#define DECLARE_LOG_FUNCTION2(level, arg1)                          \
+inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}
+
+#endif // wxUSE_LOG/!wxUSE_LOG

 
 

-    // one function per each level
-    DECLARE_LOG_FUNCTION(FatalError);
-    DECLARE_LOG_FUNCTION(Error);
-    DECLARE_LOG_FUNCTION(Warning);
-    DECLARE_LOG_FUNCTION(Message);
-    DECLARE_LOG_FUNCTION(Info);
-    DECLARE_LOG_FUNCTION(Verbose);
+// a generic function for all levels (level is passes as parameter)
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);

 
 

-    // this function sends the log message to the status line of the top level
-    // application frame, if any
-    DECLARE_LOG_FUNCTION(Status);
+// one function per each level
+DECLARE_LOG_FUNCTION(FatalError);
+DECLARE_LOG_FUNCTION(Error);
+DECLARE_LOG_FUNCTION(Warning);
+DECLARE_LOG_FUNCTION(Message);
+DECLARE_LOG_FUNCTION(Info);
+DECLARE_LOG_FUNCTION(Verbose);

 
 

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

 
 

-    // additional one: as wxLogError, but also logs last system call error code
-    // and the corresponding error message if available
-    DECLARE_LOG_FUNCTION(SysError);
+// 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);

 
 

-    // and another one which also takes the error code (for those broken APIs
-    // that don't set the errno (like registry APIs in Win32))
-    DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
+// additional one: as wxLogError, but also logs last system call error code
+// and the corresponding error message if available
+DECLARE_LOG_FUNCTION(SysError);

 
 

-    // debug functions do nothing in release mode
+// and another one which also takes the error code (for those broken APIs
+// that don't set the errno (like registry APIs in Win32))
+DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
+
+// debug functions do nothing in release mode

 #ifdef  __WXDEBUG__
     DECLARE_LOG_FUNCTION(Debug);
 
 #ifdef  __WXDEBUG__
     DECLARE_LOG_FUNCTION(Debug);
 


@@ -403,39 +464,35 @@ extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
     inline void wxLogTrace(const wxChar *, ...) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, ...) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }

-#endif
+#endif // debug/!debug

 
 

-
-    // 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
-    // ----------------------------------------------------------------------------
-
-    // 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);
-
-    // ----------------------------------------------------------------------------
-    // debug only logging functions: use them with API name and error code
-    // ----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// debug only logging functions: use them with API name and error code
+// ----------------------------------------------------------------------------

 
 #ifndef __TFILE__
 
 #ifndef __TFILE__

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

 #endif
 
 #endif
 

-#ifdef  __WXDEBUG__
-#define wxLogApiError(api, rc)                                              \
-    wxLogDebug(_T("At %s(%d) '%s' failed with error %lx (%s)."),  \
-            __TFILE__, __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,                                    \
+                   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,                                    \
+                   rc, wxSysErrorMsg(rc))
+#endif // VC++/!VC++
+
+    #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
+

 #else   //!debug
     inline void wxLogApiError(const wxChar *, long) { }
     inline void wxLogLastError(const wxChar *) { }
 #else   //!debug
     inline void wxLogApiError(const wxChar *, long) { }
     inline void wxLogLastError(const wxChar *) { }