]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/log.cpp
don't use implicit wxString->char*/wchar_t* conversion, it will not be available...
[wxWidgets.git] / src / common / log.cpp
index 0687124fe8ab11a65d9140f9316ad257e40d5e92..113d20215896a924690dd199d8e363647a66a855 100644 (file)
 // ----------------------------------------------------------------------------
 
 // generic log function
-void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
+void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {
-        wxLog::OnLog(level, wxString::FormatV(szFormat, argptr), time(NULL));
+        wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
     }
 }
 
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogGeneric(level, szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogGeneric(level, format, argptr);
     va_end(argptr);
 }
+#endif // wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogGeneric(level, format, argptr);
+    va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
+
+#if !wxUSE_UTF8_LOCALE_ONLY
+    #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)                         \
+      void wxDoLog##level##Wchar(const wxChar *format, ...)             \
+      {                                                                 \
+        va_list argptr;                                                 \
+        va_start(argptr, format);                                       \
+        wxVLog##level(format, argptr);                                  \
+        va_end(argptr);                                                 \
+      }
+#else
+    #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)
+#endif
+
+#if wxUSE_UNICODE_UTF8
+    #define IMPLEMENT_LOG_FUNCTION_UTF8(level)                          \
+      void wxDoLog##level##Utf8(const char *format, ...)                \
+      {                                                                 \
+        va_list argptr;                                                 \
+        va_start(argptr, format);                                       \
+        wxVLog##level(format, argptr);                                  \
+        va_end(argptr);                                                 \
+      }
+#else
+    #define IMPLEMENT_LOG_FUNCTION_UTF8(level)
+#endif
 
 #define IMPLEMENT_LOG_FUNCTION(level)                               \
-  void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
+  void wxVLog##level(const wxString& format, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \
       wxLog::OnLog(wxLOG_##level,                                   \
-                   wxString::FormatV(szFormat, argptr), time(NULL));\
+                   wxString::FormatV(format, argptr), time(NULL));  \
     }                                                               \
   }                                                                 \
-                                                                    \
-  void wxLog##level(const wxChar *szFormat, ...)                    \
-  {                                                                 \
-    va_list argptr;                                                 \
-    va_start(argptr, szFormat);                                     \
-    wxVLog##level(szFormat, argptr);                                \
-    va_end(argptr);                                                 \
-  }
+  IMPLEMENT_LOG_FUNCTION_WCHAR(level)                               \
+  IMPLEMENT_LOG_FUNCTION_UTF8(level)
 
 IMPLEMENT_LOG_FUNCTION(Error)
 IMPLEMENT_LOG_FUNCTION(Warning)
@@ -134,9 +166,9 @@ void wxSafeShowMessage(const wxString& title, const wxString& text)
 
 // fatal errors can't be suppressed nor handled by the custom log target and
 // always terminate the program
-void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
+void wxVLogFatalError(const wxString& format, va_list argptr)
 {
-    wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(szFormat, argptr));
+    wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(format, argptr));
 
 #ifdef __WXWINCE__
     ExitThread(3);
@@ -145,90 +177,197 @@ void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
 #endif
 }
 
-void wxLogFatalError(const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogFatalErrorWchar(const wxChar *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogFatalError(szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogFatalError(format, argptr);
 
     // some compilers warn about unreachable code and it shouldn't matter
     // for the others anyhow...
     //va_end(argptr);
 }
+#endif // wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void wxDoLogFatalErrorUtf8(const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogFatalError(format, argptr);
+
+    // some compilers warn about unreachable code and it shouldn't matter
+    // for the others anyhow...
+    //va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
 
 // same as info, but only if 'verbose' mode is on
-void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
+void wxVLogVerbose(const wxString& format, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {
         if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
             wxLog::OnLog(wxLOG_Info,
-                         wxString::FormatV(szFormat, argptr), time(NULL));
+                         wxString::FormatV(format, argptr), time(NULL));
         }
     }
 }
 
-void wxLogVerbose(const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogVerboseWchar(const wxChar *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogVerbose(format, argptr);
+    va_end(argptr);
+}
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void wxDoLogVerboseUtf8(const char *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogVerbose(szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogVerbose(format, argptr);
     va_end(argptr);
 }
+#endif // wxUSE_UNICODE_UTF8
 
 // debug functions
 #ifdef __WXDEBUG__
+
+#if !wxUSE_UTF8_LOCALE_ONLY
+    #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                   \
+      void wxDoLog##level##Wchar(const wxChar *format, ...)             \
+      {                                                                 \
+        va_list argptr;                                                 \
+        va_start(argptr, format);                                       \
+        wxVLog##level(format, argptr);                                  \
+        va_end(argptr);                                                 \
+      }
+#else
+    #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)
+#endif
+
+#if wxUSE_UNICODE_UTF8
+    #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)                    \
+      void wxDoLog##level##Utf8(const char *format, ...)                \
+      {                                                                 \
+        va_list argptr;                                                 \
+        va_start(argptr, format);                                       \
+        wxVLog##level(format, argptr);                                  \
+        va_end(argptr);                                                 \
+      }
+#else
+    #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
+#endif
+
 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                         \
-  void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
+  void wxVLog##level(const wxString& format, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \
       wxLog::OnLog(wxLOG_##level,                                   \
-                   wxString::FormatV(szFormat, argptr), time(NULL));\
+                   wxString::FormatV(format, argptr), time(NULL));  \
     }                                                               \
   }                                                                 \
-                                                                    \
-  void wxLog##level(const wxChar *szFormat, ...)                    \
-  {                                                                 \
-    va_list argptr;                                                 \
-    va_start(argptr, szFormat);                                     \
-    wxVLog##level(szFormat, argptr);                                \
-    va_end(argptr);                                                 \
-  }
+  IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                         \
+  IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
+
 
-  void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
+  void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
   {
     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
       wxString msg;
-      msg << _T("(") << mask << _T(") ") << wxString::FormatV(szFormat, argptr);
-          
+      msg << _T("(") << mask << _T(") ") << wxString::FormatV(format, argptr);
+
       wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
     }
   }
 
-  void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+  void wxDoLogTraceWchar(const wxString& mask, const wxChar *format, ...)
   {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogTrace(mask, szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
     va_end(argptr);
   }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
 
-  void wxVLogTrace(wxTraceMask mask, const wxChar *szFormat, va_list argptr)
+#if wxUSE_UNICODE_UTF8
+  void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...)
+  {
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
+    va_end(argptr);
+  }
+#endif // wxUSE_UNICODE_UTF8
+
+  void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
   {
     // we check that all of mask bits are set in the current mask, so
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
     if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
-      wxLog::OnLog(wxLOG_Trace, wxString::FormatV(szFormat, argptr), time(NULL));
+      wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
     }
   }
 
-  void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+  void wxDoLogTraceWchar(wxTraceMask mask, const wxChar *format, ...)
   {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogTrace(mask, szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
     va_end(argptr);
   }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+  void wxDoLogTraceUtf8(wxTraceMask mask, const char *format, ...)
+  {
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
+    va_end(argptr);
+  }
+#endif // wxUSE_UNICODE_UTF8
+
+#ifdef __WATCOMC__
+  // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+  void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
+  {
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
+    va_end(argptr);
+  }
+
+  void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
+  {
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
+    va_end(argptr);
+  }
+
+  void wxDoLogTraceWchar(const wchar_t *mask, const wxChar *format, ...)
+  {
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(mask, format, argptr);
+    va_end(argptr);
+  }
+
+  void wxVLogTrace(int mask, const wxString& format, va_list argptr)
+    { wxVLogTrace((wxTraceMask)mask, format, argptr); }
+  void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
+    { wxVLogTrace(wxString(mask), format, argptr); }
+  void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
+    { wxVLogTrace(wxString(mask), format, argptr); }
+#endif // __WATCOMC__
 
 #else // release
   #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
@@ -246,36 +385,74 @@ static inline wxString wxLogSysErrorHelper(long err)
     return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
 }
 
-void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
+void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr)
 {
-    wxVLogSysError(wxSysErrorCode(), szFormat, argptr);
+    wxVLogSysError(wxSysErrorCode(), format, argptr);
 }
 
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogSysError(szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogSysError(format, argptr);
     va_end(argptr);
 }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
 
-void WXDLLEXPORT wxVLogSysError(long err, const wxChar *fmt, va_list argptr)
+#if wxUSE_UNICODE_UTF8
+void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogSysError(format, argptr);
+    va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
+
+void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {
         wxLog::OnLog(wxLOG_Error,
-                     wxString::FormatV(fmt, argptr) + wxLogSysErrorHelper(err),
+                     wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
                      time(NULL));
     }
 }
 
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogSysError(lErrCode, format, argptr);
+    va_end(argptr);
+}
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void WXDLLEXPORT wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogSysError(lErrCode, format, argptr);
+    va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
+
+#ifdef __WATCOMC__
+// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+void WXDLLEXPORT wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogSysError(lErrCode, szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogSysError(lErrCode, format, argptr);
     va_end(argptr);
 }
 
+void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
+    { wxVLogSysError((long)err, format, argptr); }
+#endif // __WATCOMC__
+
 // ----------------------------------------------------------------------------
 // wxLog class implementation
 // ----------------------------------------------------------------------------
@@ -298,7 +475,7 @@ unsigned wxLog::DoLogNumberOfRepeats()
 #endif
         ms_prevCounter = 0;
         ms_prevString.clear();
-        pLogger->DoLog(ms_prevLevel, msg.c_str(), ms_prevTimeStamp);
+        pLogger->DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
     }
     return retval;
 }
@@ -314,7 +491,7 @@ wxLog::~wxLog()
 }
 
 /* static */
-void wxLog::OnLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     if ( IsEnabled() && ms_logLevel >= level )
     {
@@ -398,6 +575,11 @@ void wxLog::DontCreateOnDemand()
     ClearTraceMasks();
 }
 
+void wxLog::DoCreateOnDemand()
+{
+    ms_bAutoCreate = true;
+}
+
 void wxLog::RemoveTraceMask(const wxString& str)
 {
     int index = ms_aTraceMasks.Index(str);
@@ -429,12 +611,19 @@ void wxLog::TimeStamp(wxString *str)
 #endif // wxUSE_DATETIME
 }
 
-void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
+#if WXWIN_COMPATIBILITY_2_8
+    // DoLog() signature changed since 2.8, so we call the old versions here
+    // so that existing custom log classes still work:
+    DoLog(level, (const char*)szString.mb_str(), t);
+    DoLog(level, (const wchar_t*)szString.wc_str(), t);
+#endif
+
     switch ( level ) {
         case wxLOG_FatalError:
-            DoLogString(wxString(_("Fatal error: ")) + szString, t);
-            DoLogString(_("Program aborted."), t);
+            LogString(_("Fatal error: ") + szString, t);
+            LogString(_("Program aborted."), t);
             Flush();
 #ifdef __WXWINCE__
             ExitThread(3);
@@ -444,11 +633,11 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
             break;
 
         case wxLOG_Error:
-            DoLogString(wxString(_("Error: ")) + szString, t);
+            LogString(_("Error: ") + szString, t);
             break;
 
         case wxLOG_Warning:
-            DoLogString(wxString(_("Warning: ")) + szString, t);
+            LogString(_("Warning: ") + szString, t);
             break;
 
         case wxLOG_Info:
@@ -456,7 +645,7 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
         case wxLOG_Message:
         case wxLOG_Status:
         default:    // log unknown log levels too
-                DoLogString(szString, t);
+                LogString(szString, t);
             break;
 
         case wxLOG_Trace:
@@ -466,16 +655,26 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
                 wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
                                                     : wxT("Debug: ");
                 msg << szString;
-                DoLogString(msg, t);
+                LogString(msg, t);
             }
 #endif // Debug
             break;
     }
 }
 
-void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
+void wxLog::DoLogString(const wxString& szString, time_t t)
 {
+#if WXWIN_COMPATIBILITY_2_8
+    // DoLogString() signature changed since 2.8, so we call the old versions
+    // here so that existing custom log classes still work; unfortunately this
+    // also means that we can't have the wxFAIL_MSG below in compat mode
+    DoLogString((const char*)szString.mb_str(), t);
+    DoLogString((const wchar_t*)szString.wc_str(), t);
+#else
     wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
+    wxUnusedVar(szString);
+    wxUnusedVar(t);
+#endif
 }
 
 void wxLog::Flush()
@@ -483,7 +682,7 @@ void wxLog::Flush()
     // nothing to do here
 }
 
-/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *mask)
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
 {
     for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
                                   en = ms_aTraceMasks.end();
@@ -507,7 +706,7 @@ void wxLogBuffer::Flush()
     }
 }
 
-void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     switch ( level )
     {
@@ -532,7 +731,7 @@ void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
     }
 }
 
-void wxLogBuffer::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     m_str << szString << _T("\n");
 }
@@ -549,7 +748,7 @@ wxLogStderr::wxLogStderr(FILE *fp)
         m_fp = fp;
 }
 
-void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     wxString str;
     TimeStamp(&str);
@@ -588,11 +787,11 @@ wxLogStream::wxLogStream(wxSTD ostream *ostr)
         m_ostr = ostr;
 }
 
-void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
-    wxString str;
-    TimeStamp(&str);
-    (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
+    wxString stamp;
+    TimeStamp(&stamp);
+    (*m_ostr) << stamp << szString << wxSTD endl;
 }
 #endif // wxUSE_STD_IOSTREAM
 
@@ -634,7 +833,7 @@ void wxLogChain::Flush()
         m_logNew->Flush();
 }
 
-void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     // let the previous logger show it
     if ( m_logOld && IsPassingMessages() )