Add OSX prefix, and be clear that this is OS X only API to avoid any expectation...

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

diff --git a/include/wx/msgout.h b/include/wx/msgout.h
old mode 100755 (executable)
new mode 100644 (file)
index 0445407..225df86
--- a/include/wx/msgout.h
+++ b/include/wx/msgout.h
@@ -36,16 +36,40 @@ public:
     virtual ~wxMessageOutputBase() { }
 
     // show a message to the user
-    // void Printf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
-    WX_DEFINE_VARARG_FUNC_VOID(Printf, DoPrintf)
+    // void Printf(const wxString& format, ...) = 0;
+    WX_DEFINE_VARARG_FUNC_VOID(Printf, 1, (const wxFormatString&),
+                               DoPrintfWchar, DoPrintfUtf8)
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+    WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxString&),
+                                (wxFormatString(f1)));
+    WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxCStrData&),
+                                (wxFormatString(f1)));
+    WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const char*),
+                                (wxFormatString(f1)));
+    WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wchar_t*),
+                                (wxFormatString(f1)));
+#endif
+
+    // called by DoPrintf() to output formatted string but can also be called
+    // directly if no formatting is needed
+    virtual void Output(const wxString& str) = 0;
 
 protected:
-    virtual void DoPrintf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
+    // NB: this is pure virtual so that it can be implemented in dllexported
+    //     wxMessagOutput class
+#if !wxUSE_UTF8_LOCALE_ONLY
+    virtual void DoPrintfWchar(const wxChar *format, ...) = 0;
+#endif
+#if wxUSE_UNICODE_UTF8
+    virtual void DoPrintfUtf8(const char *format, ...) = 0;
+#endif
 };
 
 #ifdef __VISUALC__
     // "non dll-interface class 'wxStringPrintfMixin' used as base interface
     // for dll-interface class 'wxString'" -- this is OK in our case
+    #pragma warning (push)
     #pragma warning (disable:4275)
 #endif
 
@@ -61,70 +85,90 @@ public:
     // sets the global wxMessageOutput instance; returns the previous one
     static wxMessageOutput* Set(wxMessageOutput* msgout);
 
+protected:
+#if !wxUSE_UTF8_LOCALE_ONLY
+    virtual void DoPrintfWchar(const wxChar *format, ...);
+#endif
+#if wxUSE_UNICODE_UTF8
+    virtual void DoPrintfUtf8(const char *format, ...);
+#endif
+
 private:
     static wxMessageOutput* ms_msgOut;
 };
 
 #ifdef __VISUALC__
-    #pragma warning (default:4275)
+    #pragma warning (pop)
 #endif
 
 // ----------------------------------------------------------------------------
-// implementation showing the message to the user in "best" possible way: uses
-// native message box if available (currently only under Windows) and stderr
-// otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
+// implementation which sends output to stderr or specified file
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
+class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
 {
 public:
-    wxMessageOutputBest() { }
+    wxMessageOutputStderr(FILE *fp = stderr) : m_fp(fp) { }
+
+    virtual void Output(const wxString& str);
 
 protected:
-    virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
+    // return the string with "\n" appended if it doesn't already terminate
+    // with it (in which case it's returned unchanged)
+    wxString AppendLineFeedIfNeeded(const wxString& str);
+
+    FILE *m_fp;
 };
 
 // ----------------------------------------------------------------------------
-// implementation which sends output to stderr
+// implementation showing the message to the user in "best" possible way:
+// uses stderr or message box if available according to the flag given to ctor.
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
+enum wxMessageOutputFlags
+{
+    wxMSGOUT_PREFER_STDERR = 0, // use stderr if available (this is the default)
+    wxMSGOUT_PREFER_MSGBOX = 1  // always use message box if available
+};
+
+class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutputStderr
 {
 public:
-    wxMessageOutputStderr() { }
+    wxMessageOutputBest(wxMessageOutputFlags flags = wxMSGOUT_PREFER_STDERR)
+        : m_flags(flags) { }
 
-protected:
-    virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
+    virtual void Output(const wxString& str);
+
+private:
+    wxMessageOutputFlags m_flags;
 };
 
 // ----------------------------------------------------------------------------
 // implementation which shows output in a message box
 // ----------------------------------------------------------------------------
 
-#if wxUSE_GUI
+#if wxUSE_GUI && wxUSE_MSGDLG
 
 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 {
 public:
     wxMessageOutputMessageBox() { }
 
-protected:
-    virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
+    virtual void Output(const wxString& str);
 };
 
-#endif // wxUSE_GUI
+#endif // wxUSE_GUI && wxUSE_MSGDLG
 
 // ----------------------------------------------------------------------------
 // implementation using the native way of outputting debug messages
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
+class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutputStderr
 {
 public:
     wxMessageOutputDebug() { }
 
-protected:
-    virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
+    virtual void Output(const wxString& str);
 };
 
 // ----------------------------------------------------------------------------
@@ -136,9 +180,7 @@ class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 public:
     wxMessageOutputLog() { }
 
-protected:
-    virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
+    virtual void Output(const wxString& str);
 };
 
-#endif
-    // _WX_MSGOUT_H_
+#endif // _WX_MSGOUT_H_