Comment-only update

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

diff --git a/include/wx/msgout.h b/include/wx/msgout.h
index 56b11a6244e3136b2e822200b74f19b10297969f..63b39b92c2e15ae58f71cd04204e893df4ad895f 100644 (file)
--- a/include/wx/msgout.h
+++ b/include/wx/msgout.h
@@ -4,7 +4,6 @@
 // Author:      Mattia Barbon
 // Modified by:
 // Created:     17.07.02
-// RCS-ID:      $Id$
 // Copyright:   (c) Mattia Barbon
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
@@ -51,6 +50,10 @@ public:
                                 (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:
     // NB: this is pure virtual so that it can be implemented in dllexported
     //     wxMessagOutput class
@@ -60,14 +63,12 @@ protected:
 #if wxUSE_UNICODE_UTF8
     virtual void DoPrintfUtf8(const char *format, ...) = 0;
 #endif
-
-    // called by DoPrintf() to output formatted string
-    virtual void Output(const wxString& str) = 0;
 };
 
 #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
 
@@ -90,71 +91,82 @@ protected:
 #if wxUSE_UNICODE_UTF8
     virtual void DoPrintfUtf8(const char *format, ...);
 #endif
-    virtual void Output(const wxString& str) = 0;
 
 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) { }
 
-protected:
     virtual void Output(const wxString& str);
+
+protected:
+    // 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 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 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 Output(const wxString& str);
 };
 
@@ -167,9 +179,7 @@ class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 public:
     wxMessageOutputLog() { }
 
-protected:
     virtual void Output(const wxString& str);
 };
 
-#endif
-    // _WX_MSGOUT_H_
+#endif // _WX_MSGOUT_H_