set eol-style

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

diff --git a/include/wx/log.h b/include/wx/log.h
index c9f16abf15e241481aa4074695d92d7f669174df..41a4b86faeabb6038f3a6d152308237d5ee23ee1 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -70,10 +70,10 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 
 #if wxUSE_GUI
 // ----------------------------------------------------------------------------
 
 #if wxUSE_GUI

-    class WXDLLIMPEXP_CORE wxTextCtrl;
-    class WXDLLIMPEXP_CORE wxLogFrame;
-    class WXDLLIMPEXP_CORE wxFrame;
-    class WXDLLIMPEXP_CORE wxWindow;
+    class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+    class WXDLLIMPEXP_FWD_CORE wxLogFrame;
+    class WXDLLIMPEXP_FWD_CORE wxFrame;
+    class WXDLLIMPEXP_FWD_CORE wxWindow;

 #endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 #endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------


@@ -133,7 +133,7 @@ public:
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes

-    static void OnLog(wxLogLevel level, const wxChar *szString, time_t t);
+    static void OnLog(wxLogLevel level, const wxString& szString, time_t t);

 
     // message buffering
 
 
     // message buffering
 


@@ -181,6 +181,9 @@ public:
     // current is NULL?
     static void DontCreateOnDemand();
 
     // current is NULL?
     static void DontCreateOnDemand();
 

+    // Make GetActiveTarget() create a new log object again.
+    static void DoCreateOnDemand();
+

     // log the count of repeating messages instead of logging the messages
     // multiple times
     static void SetRepetitionCounting(bool bRepetCounting = true)
     // log the count of repeating messages instead of logging the messages
     // multiple times
     static void SetRepetitionCounting(bool bRepetCounting = true)


@@ -205,10 +208,13 @@ public:
     // get string trace masks
     static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 
     // get string trace masks
     static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 

-    // 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; }
+    // sets the time stamp string format: this is used as strftime() format
+    // string for the log targets which add time stamps to the messages; set
+    // it to empty string to disable time stamping completely.
+    static void SetTimestamp(const wxString& ts) { ms_timestamp = ts; }
+
+    // disable time stamping of log messages
+    static void DisableTimestamp() { SetTimestamp(wxEmptyString); }

 
 
     // accessors
 
 
     // accessors


@@ -220,13 +226,13 @@ public:
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
 
     // is this trace mask in the list?
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
 
     // is this trace mask in the list?

-    static bool IsAllowedTraceMask(const wxChar *mask);
+    static bool IsAllowedTraceMask(const wxString& mask);

 
     // return the current loglevel limit
     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 
     // get the current timestamp format string (may be NULL)
 
     // return the current loglevel limit
     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 
     // get the current timestamp format string (may be NULL)

-    static const wxChar *GetTimestamp() { return ms_timestamp; }
+    static const wxString& GetTimestamp() { return ms_timestamp; }

 
 
     // helpers
 
 
     // helpers


@@ -252,11 +258,48 @@ protected:
 
     // default DoLog() prepends the time stamp and a prefix corresponding
     // to the message to szString and then passes it to DoLogString()
 
     // default DoLog() prepends the time stamp and a prefix corresponding
     // to the message to szString and then passes it to DoLogString()

-    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+#if WXWIN_COMPATIBILITY_2_8
+    // these shouldn't be used by new code
+    wxDEPRECATED_BUT_USED_INTERNALLY(
+        virtual void DoLog(wxLogLevel level, const char *szString, time_t t)
+    );
+
+    wxDEPRECATED_BUT_USED_INTERNALLY(
+        virtual void DoLog(wxLogLevel level, const wchar_t *wzString, time_t t)
+    );
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    void LogString(const wxString& szString, time_t t)
+        { DoLogString(szString, t); }

 
     // default DoLogString does nothing but is not pure virtual because if
     // you override DoLog() you might not need it at all
 
     // 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 wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+#if WXWIN_COMPATIBILITY_2_8
+    // these shouldn't be used by new code
+    virtual void DoLogString(const char *WXUNUSED(szString),
+                             time_t WXUNUSED(t)) {}
+    virtual void DoLogString(const wchar_t *WXUNUSED(szString),
+                             time_t WXUNUSED(t)) {}
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    // this macro should be used in the derived classes to avoid warnings about
+    // hiding the other DoLog() overloads when overriding DoLog(wxString) --
+    // but don't use it with MSVC which doesn't give this warning but does give
+    // warning when a deprecated function is overridden
+#if WXWIN_COMPATIBILITY_2_8 && !defined(__VISUALC__)
+    #define wxSUPPRESS_DOLOG_HIDE_WARNING()                                   \
+        virtual void DoLog(wxLogLevel, const char *, time_t) { }              \
+        virtual void DoLog(wxLogLevel, const wchar_t *, time_t) { }
+
+    #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()                             \
+        virtual void DoLogString(const char *, time_t) { }                    \
+        virtual void DoLogString(const wchar_t *, time_t) { }
+#else
+    #define wxSUPPRESS_DOLOG_HIDE_WARNING()
+    #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
+#endif

 
     // log a line containing the number of times the previous message was
     // repeated
 
     // log a line containing the number of times the previous message was
     // repeated


@@ -286,7 +329,7 @@ private:
 
     // format string for strftime(), if NULL, time stamping log messages is
     // disabled
 
     // format string for strftime(), if NULL, time stamping log messages is
     // disabled

-    static const wxChar *ms_timestamp;
+    static wxString    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


@@ -310,8 +353,11 @@ public:
     virtual void Flush();
 
 protected:
     virtual void Flush();
 
 protected:

-    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOG_HIDE_WARNING()
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()

 
 private:
     wxString m_str;
 
 private:
     wxString m_str;


@@ -329,7 +375,9 @@ public:
 
 protected:
     // implement sink function
 
 protected:
     // implement sink function

-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()

 
     FILE *m_fp;
 
 
     FILE *m_fp;
 


@@ -347,7 +395,9 @@ public:
 
 protected:
     // implement sink function
 
 protected:
     // implement sink function

-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()

 
     // using ptr here to avoid including <iostream.h> from this file
     wxSTD ostream *m_ostr;
 
     // using ptr here to avoid including <iostream.h> from this file
     wxSTD ostream *m_ostr;


@@ -416,9 +466,14 @@ public:
     // override base class version to flush the old logger as well
     virtual void Flush();
 
     // override base class version to flush the old logger as well
     virtual void Flush();
 

+    // call to avoid destroying the old log target
+    void DetachOldLog() { m_logOld = NULL; }
+

 protected:
     // pass the chain to the old logger if needed
 protected:
     // pass the chain to the old logger if needed

-    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOG_HIDE_WARNING()

 
 private:
     // the current log target
 
 private:
     // the current log target


@@ -434,13 +489,28 @@ private:
 };
 
 // a chain log target which uses itself as the new logger
 };
 
 // a chain log target which uses itself as the new logger

-class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain
+
+#define wxLogPassThrough wxLogInterposer
+
+class WXDLLIMPEXP_BASE wxLogInterposer : public wxLogChain

 {
 public:
 {
 public:

-    wxLogPassThrough();
+    wxLogInterposer();

 
 private:
 
 private:

-    DECLARE_NO_COPY_CLASS(wxLogPassThrough)
+    DECLARE_NO_COPY_CLASS(wxLogInterposer)
+};
+
+// a temporary interposer which doesn't destroy the old log target
+// (calls DetachOldLog)
+
+class WXDLLIMPEXP_BASE wxLogInterposerTemp : public wxLogChain
+{
+public:
+    wxLogInterposerTemp();
+
+private:
+    DECLARE_NO_COPY_CLASS(wxLogInterposerTemp)

 };
 
 #if wxUSE_GUI
 };
 
 #if wxUSE_GUI


@@ -473,9 +543,12 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 
 #define DECLARE_LOG_FUNCTION(level)                                         \
     extern void WXDLLIMPEXP_BASE                                            \
 
 #define DECLARE_LOG_FUNCTION(level)                                         \
     extern void WXDLLIMPEXP_BASE                                            \

-    wxDoLog##level(const wxString& format, ...);                            \
+    wxDoLog##level##Wchar(const wxChar *format, ...);                       \
+    extern void WXDLLIMPEXP_BASE                                            \
+    wxDoLog##level##Utf8(const char *format, ...);                          \

     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \

-                               1, (const wxString&), wxDoLog##level)        \
+                               1, (const wxFormatString&),                  \
+                               wxDoLog##level##Wchar, wxDoLog##level##Utf8) \

     DECLARE_LOG_FUNCTION_WATCOM(level)                                      \
     extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format,      \
                                                va_list argptr)
     DECLARE_LOG_FUNCTION_WATCOM(level)                                      \
     extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format,      \
                                                va_list argptr)


@@ -485,23 +558,31 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
     // something too big for Borland C++ to handle
     #define DECLARE_LOG_FUNCTION_WATCOM(level)                              \
     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
     // something too big for Borland C++ to handle
     #define DECLARE_LOG_FUNCTION_WATCOM(level)                              \

-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
-                                   1, (const char*), wxDoLog##level)        \
-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
-                                   1, (const wchar_t*), wxDoLog##level)     \
-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
-                                   1, (const wxCStrData&), wxDoLog##level)
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wxString&),                    \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wxCStrData&),                  \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const char*),                        \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wchar_t*),                     \
+                                   (wxFormatString(f1)))

 #else
     #define DECLARE_LOG_FUNCTION_WATCOM(level)
 #endif
 
 
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
 #else
     #define DECLARE_LOG_FUNCTION_WATCOM(level)
 #endif
 
 
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \

-    extern void expdecl wxDoLog##level(argclass arg,                        \
-                                       const wxString& format, ...);        \
+    extern void expdecl wxDoLog##level##Wchar(argclass arg,                 \
+                                              const wxChar *format, ...);   \
+    extern void expdecl wxDoLog##level##Utf8(argclass arg,                  \
+                                             const char *format, ...);      \

     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
     WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \

-                               2, (argclass, const wxString&),              \
-                               wxDoLog##level)                              \
+                               2, (argclass, const wxFormatString&),        \
+                               wxDoLog##level##Wchar, wxDoLog##level##Utf8) \

     DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)         \
     extern void expdecl wxVLog##level(argclass arg,                         \
                                       const wxString& format,               \
     DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)         \
     extern void expdecl wxVLog##level(argclass arg,                         \
                                       const wxString& format,               \


@@ -512,15 +593,18 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
     // something too big for Borland C++ to handle
     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
     // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
     // something too big for Borland C++ to handle
     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \

-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const wxString&),          \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const wxCStrData&),        \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \

                                    2, (argclass, const char*),              \
                                    2, (argclass, const char*),              \

-                                   wxDoLog##level)                          \
-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \

                                    2, (argclass, const wchar_t*),           \
                                    2, (argclass, const wchar_t*),           \

-                                   wxDoLog##level)                          \
-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
-                                   2, (argclass, const wxCStrData&),        \
-                                   wxDoLog##level)
+                                   (f1, wxFormatString(f2)))

 #else
     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
 #endif
 #else
     #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
 #endif


@@ -544,7 +628,7 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&))     \
     )                                                                       \
     inline void wxVLog##level(const wxString& WXUNUSED(format),             \
         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&))     \
     )                                                                       \
     inline void wxVLog##level(const wxString& WXUNUSED(format),             \

-                               va_list WXUNUSED(argptr)) { }                \
+                              va_list WXUNUSED(argptr)) { }                 \

 
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
 
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
     WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \


@@ -554,8 +638,8 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
     )                                                                       \
     inline void wxVLog##level(argclass WXUNUSED(arg),                       \
         WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
     )                                                                       \
     inline void wxVLog##level(argclass WXUNUSED(arg),                       \

-                               const wxString& WXUNUSED(format),            \
-                               va_list WXUNUSED(argptr)) {}
+                              const wxString& WXUNUSED(format),             \
+                              va_list WXUNUSED(argptr)) {}

 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull


@@ -600,7 +684,7 @@ DECLARE_LOG_FUNCTION(Status);
 
 #if wxUSE_GUI
     // this one is the same as previous except that it allows to explicitly
 
 #if wxUSE_GUI
     // this one is the same as previous except that it allows to explicitly

-    class WXDLLEXPORT wxFrame;
+    class WXDLLIMPEXP_FWD_CORE wxFrame;

     // specify the frame to which the output should go
     DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
 #endif // wxUSE_GUI
     // specify the frame to which the output should go
     DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
 #endif // wxUSE_GUI


@@ -697,13 +781,13 @@ wxSafeShowMessage(const wxString& title, const wxString& text);
 #ifdef __VISUALC__
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
 #ifdef __VISUALC__
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \

-                   __TFILE__, __LINE__, api,                                  \
+                   __FILE__, __LINE__, api,                                   \

                    (long)rc, wxSysErrorMsg(rc))
 #else // !VC++
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("In file %s at line %d: '%s' failed with ")            \
                    wxT("error 0x%08lx (%s)."),                                \
                    (long)rc, wxSysErrorMsg(rc))
 #else // !VC++
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("In file %s at line %d: '%s' failed with ")            \
                    wxT("error 0x%08lx (%s)."),                                \

-                   __TFILE__, __LINE__, api,                                  \
+                   __FILE__, __LINE__, api,                                   \

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