make wxSetEnv compatible with ANSI and Unicode, deprecate passing NULL to it in favou...

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 85c09841d180569e26316ae3a0f3a6387e29784f..a28d31300c2dbd7d6ec3f85df68ce7dcecf7ba6f 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -133,7 +133,7 @@ public:
 
     // 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
 
@@ -181,6 +181,9 @@ public:
     // 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)
@@ -208,7 +211,7 @@ public:
     // 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; }
+    static void SetTimestamp(const wxString& ts) { ms_timestamp = ts; }
 
 
     // accessors
@@ -220,13 +223,13 @@ public:
     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)
-    static const wxChar *GetTimestamp() { return ms_timestamp; }
+    static const wxString& GetTimestamp() { return ms_timestamp; }
 
 
     // helpers
@@ -252,11 +255,31 @@ protected:
 
     // 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
-    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
 
     // log a line containing the number of times the previous message was
     // repeated
@@ -286,7 +309,7 @@ private:
 
     // 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
@@ -310,8 +333,8 @@ public:
     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);
 
 private:
     wxString m_str;
@@ -329,7 +352,7 @@ public:
 
 protected:
     // implement sink function
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
 
     FILE *m_fp;
 
@@ -347,7 +370,7 @@ public:
 
 protected:
     // implement sink function
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
 
     // using ptr here to avoid including <iostream.h> from this file
     wxSTD ostream *m_ostr;
@@ -418,7 +441,7 @@ public:
 
 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);
 
 private:
     // the current log target
@@ -473,9 +496,12 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 
 #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,                                \
-                               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)
@@ -485,23 +511,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)                              \
-        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)            \
-    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,                                \
-                               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,               \
@@ -512,15 +546,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) \
-        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*),              \
-                                   wxDoLog##level)                          \
-        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
                                    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
@@ -544,7 +581,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),             \
-                               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&)) \
@@ -554,8 +591,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),                       \
-                               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
@@ -665,10 +702,16 @@ DECLARE_LOG_FUNCTION2(SysError, unsigned long, lErrCode);
         #define wxLogTrace(mask, fmt, ...) wxLogNop()
     #else // !HAVE_VARIADIC_MACROS
         //inline void wxLogDebug(const wxString& fmt, ...) {}
-        WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug)
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug, 1, (const wxString&))
         //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
         //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
-        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace)
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (wxTraceMask, const wxString&))
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wxString&, const wxString&))
+        #ifdef __WATCOMC__
+        // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const char*, const char*))
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wchar_t*, const wchar_t*))
+        #endif
     #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
 #endif // debug/!debug
 
@@ -691,13 +734,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)."),       \
-                   __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)."),                                \
-                   __TFILE__, __LINE__, api,                                  \
+                   __FILE__, __LINE__, api,                                   \
                    (long)rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++