1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxMessageOutput class. Shows a message to the user
4 // Author: Mattia Barbon
8 // Copyright: (c) Mattia Barbon
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
20 #include "wx/chartype.h"
21 #include "wx/strvararg.h"
23 // ----------------------------------------------------------------------------
24 // wxMessageOutput is a class abstracting formatted output target, i.e.
25 // something you can printf() to
26 // ----------------------------------------------------------------------------
28 // NB: VC6 has a bug that causes linker errors if you have template methods
29 // in a class using __declspec(dllimport). The solution is to split such
30 // class into two classes, one that contains the template methods and does
31 // *not* use WXDLLIMPEXP_BASE and another class that contains the rest
32 // (with DLL linkage).
33 class wxMessageOutputBase
36 virtual ~wxMessageOutputBase() { }
38 // show a message to the user
39 // void Printf(const wxString& format, ...) = 0;
40 WX_DEFINE_VARARG_FUNC_VOID(Printf
, 1, (const wxFormatString
&),
41 DoPrintfWchar
, DoPrintfUtf8
)
43 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
44 WX_VARARG_WATCOM_WORKAROUND(void, Printf
, 1, (const wxString
&),
45 (wxFormatString(f1
)));
46 WX_VARARG_WATCOM_WORKAROUND(void, Printf
, 1, (const wxCStrData
&),
47 (wxFormatString(f1
)));
48 WX_VARARG_WATCOM_WORKAROUND(void, Printf
, 1, (const char*),
49 (wxFormatString(f1
)));
50 WX_VARARG_WATCOM_WORKAROUND(void, Printf
, 1, (const wchar_t*),
51 (wxFormatString(f1
)));
54 // called by DoPrintf() to output formatted string but can also be called
55 // directly if no formatting is needed
56 virtual void Output(const wxString
& str
) = 0;
59 // NB: this is pure virtual so that it can be implemented in dllexported
60 // wxMessagOutput class
61 #if !wxUSE_UTF8_LOCALE_ONLY
62 virtual void DoPrintfWchar(const wxChar
*format
, ...) = 0;
64 #if wxUSE_UNICODE_UTF8
65 virtual void DoPrintfUtf8(const char *format
, ...) = 0;
70 // "non dll-interface class 'wxStringPrintfMixin' used as base interface
71 // for dll-interface class 'wxString'" -- this is OK in our case
72 #pragma warning (push)
73 #pragma warning (disable:4275)
76 class WXDLLIMPEXP_BASE wxMessageOutput
: public wxMessageOutputBase
79 virtual ~wxMessageOutput() { }
81 // gets the current wxMessageOutput object (may be NULL during
82 // initialization or shutdown)
83 static wxMessageOutput
* Get();
85 // sets the global wxMessageOutput instance; returns the previous one
86 static wxMessageOutput
* Set(wxMessageOutput
* msgout
);
89 #if !wxUSE_UTF8_LOCALE_ONLY
90 virtual void DoPrintfWchar(const wxChar
*format
, ...);
92 #if wxUSE_UNICODE_UTF8
93 virtual void DoPrintfUtf8(const char *format
, ...);
97 static wxMessageOutput
* ms_msgOut
;
101 #pragma warning (pop)
104 // ----------------------------------------------------------------------------
105 // implementation which sends output to stderr
106 // ----------------------------------------------------------------------------
108 class WXDLLIMPEXP_BASE wxMessageOutputStderr
: public wxMessageOutput
111 wxMessageOutputStderr() { }
113 virtual void Output(const wxString
& str
);
116 // return the string with "\n" appended if it doesn't already terminate
117 // with it (in which case it's returned unchanged)
118 wxString
AppendLineFeedIfNeeded(const wxString
& str
);
121 // ----------------------------------------------------------------------------
122 // implementation showing the message to the user in "best" possible way:
123 // uses stderr or message box if available according to the flag given to ctor.
124 // ----------------------------------------------------------------------------
126 enum wxMessageOutputFlags
128 wxMSGOUT_PREFER_STDERR
= 0, // use stderr if available (this is the default)
129 wxMSGOUT_PREFER_MSGBOX
= 1 // always use message box if available
132 class WXDLLIMPEXP_BASE wxMessageOutputBest
: public wxMessageOutputStderr
135 wxMessageOutputBest(wxMessageOutputFlags flags
= wxMSGOUT_PREFER_STDERR
)
138 virtual void Output(const wxString
& str
);
141 wxMessageOutputFlags m_flags
;
144 // ----------------------------------------------------------------------------
145 // implementation which shows output in a message box
146 // ----------------------------------------------------------------------------
148 #if wxUSE_GUI && wxUSE_MSGDLG
150 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox
: public wxMessageOutput
153 wxMessageOutputMessageBox() { }
155 virtual void Output(const wxString
& str
);
158 #endif // wxUSE_GUI && wxUSE_MSGDLG
160 // ----------------------------------------------------------------------------
161 // implementation using the native way of outputting debug messages
162 // ----------------------------------------------------------------------------
164 class WXDLLIMPEXP_BASE wxMessageOutputDebug
: public wxMessageOutputStderr
167 wxMessageOutputDebug() { }
169 virtual void Output(const wxString
& str
);
172 // ----------------------------------------------------------------------------
173 // implementation using wxLog (mainly for backwards compatibility)
174 // ----------------------------------------------------------------------------
176 class WXDLLIMPEXP_BASE wxMessageOutputLog
: public wxMessageOutput
179 wxMessageOutputLog() { }
181 virtual void Output(const wxString
& str
);
184 #endif // _WX_MSGOUT_H_