include/wx/msgout.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msgout.h
   3 // Purpose:     wxMessageOutput class. Shows a message to the user
   4 // Author:      Mattia Barbon
   5 // Modified by:
   6 // Created:     17.07.02
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Mattia Barbon
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSGOUT_H_
  13 #define _WX_MSGOUT_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20 #include "wx/chartype.h"
  21 #include "wx/strvararg.h"
  22
  23 // ----------------------------------------------------------------------------
  24 // wxMessageOutput is a class abstracting formatted output target, i.e.
  25 // something you can printf() to
  26 // ----------------------------------------------------------------------------
  27
  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
  34 {
  35 public:
  36     virtual ~wxMessageOutputBase() { }
  37
  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)
  42 #ifdef __WATCOMC__
  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)));
  52 #endif
  53
  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;
  57
  58 protected:
  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;
  63 #endif
  64 #if wxUSE_UNICODE_UTF8
  65     virtual void DoPrintfUtf8(const char *format, ...) = 0;
  66 #endif
  67 };
  68
  69 #ifdef __VISUALC__
  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 (disable:4275)
  73 #endif
  74
  75 class WXDLLIMPEXP_BASE wxMessageOutput : public wxMessageOutputBase
  76 {
  77 public:
  78     virtual ~wxMessageOutput() { }
  79
  80     // gets the current wxMessageOutput object (may be NULL during
  81     // initialization or shutdown)
  82     static wxMessageOutput* Get();
  83
  84     // sets the global wxMessageOutput instance; returns the previous one
  85     static wxMessageOutput* Set(wxMessageOutput* msgout);
  86
  87 protected:
  88 #if !wxUSE_UTF8_LOCALE_ONLY
  89     virtual void DoPrintfWchar(const wxChar *format, ...);
  90 #endif
  91 #if wxUSE_UNICODE_UTF8
  92     virtual void DoPrintfUtf8(const char *format, ...);
  93 #endif
  94
  95 private:
  96     static wxMessageOutput* ms_msgOut;
  97 };
  98
  99 #ifdef __VISUALC__
 100     #pragma warning (default:4275)
 101 #endif
 102
 103 // ----------------------------------------------------------------------------
 104 // implementation which sends output to stderr
 105 // ----------------------------------------------------------------------------
 106
 107 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
 108 {
 109 public:
 110     wxMessageOutputStderr() { }
 111
 112     virtual void Output(const wxString& str);
 113
 114 protected:
 115     // return the string with "\n" appended if it doesn't already terminate
 116     // with it (in which case it's returned unchanged)
 117     wxString AppendLineFeedIfNeeded(const wxString& str);
 118 };
 119
 120 // ----------------------------------------------------------------------------
 121 // implementation showing the message to the user in "best" possible way:
 122 // uses stderr or message box if available according to the flag given to ctor.
 123 // ----------------------------------------------------------------------------
 124
 125 enum wxMessageOutputFlags
 126 {
 127     wxMSGOUT_PREFER_STDERR = 0, // use stderr if available (this is the default)
 128     wxMSGOUT_PREFER_MSGBOX = 1  // always use message box if available
 129 };
 130
 131 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutputStderr
 132 {
 133 public:
 134     wxMessageOutputBest(wxMessageOutputFlags flags = wxMSGOUT_PREFER_STDERR)
 135         : m_flags(flags) { }
 136
 137     virtual void Output(const wxString& str);
 138
 139 private:
 140     wxMessageOutputFlags m_flags;
 141 };
 142
 143 // ----------------------------------------------------------------------------
 144 // implementation which shows output in a message box
 145 // ----------------------------------------------------------------------------
 146
 147 #if wxUSE_GUI && wxUSE_MSGDLG
 148
 149 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 150 {
 151 public:
 152     wxMessageOutputMessageBox() { }
 153
 154     virtual void Output(const wxString& str);
 155 };
 156
 157 #endif // wxUSE_GUI && wxUSE_MSGDLG
 158
 159 // ----------------------------------------------------------------------------
 160 // implementation using the native way of outputting debug messages
 161 // ----------------------------------------------------------------------------
 162
 163 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutputStderr
 164 {
 165 public:
 166     wxMessageOutputDebug() { }
 167
 168     virtual void Output(const wxString& str);
 169 };
 170
 171 // ----------------------------------------------------------------------------
 172 // implementation using wxLog (mainly for backwards compatibility)
 173 // ----------------------------------------------------------------------------
 174
 175 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 176 {
 177 public:
 178     wxMessageOutputLog() { }
 179
 180     virtual void Output(const wxString& str);
 181 };
 182
 183 #endif // _WX_MSGOUT_H_