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 // Copyright:   (c) Mattia Barbon
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_MSGOUT_H_
  12 #define _WX_MSGOUT_H_
  13
  14 // ----------------------------------------------------------------------------
  15 // headers
  16 // ----------------------------------------------------------------------------
  17
  18 #include "wx/defs.h"
  19 #include "wx/chartype.h"
  20 #include "wx/strvararg.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // wxMessageOutput is a class abstracting formatted output target, i.e.
  24 // something you can printf() to
  25 // ----------------------------------------------------------------------------
  26
  27 // NB: VC6 has a bug that causes linker errors if you have template methods
  28 //     in a class using __declspec(dllimport). The solution is to split such
  29 //     class into two classes, one that contains the template methods and does
  30 //     *not* use WXDLLIMPEXP_BASE and another class that contains the rest
  31 //     (with DLL linkage).
  32 class wxMessageOutputBase
  33 {
  34 public:
  35     virtual ~wxMessageOutputBase() { }
  36
  37     // show a message to the user
  38     // void Printf(const wxString& format, ...) = 0;
  39     WX_DEFINE_VARARG_FUNC_VOID(Printf, 1, (const wxFormatString&),
  40                                DoPrintfWchar, DoPrintfUtf8)
  41 #ifdef __WATCOMC__
  42     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
  43     WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxString&),
  44                                 (wxFormatString(f1)));
  45     WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxCStrData&),
  46                                 (wxFormatString(f1)));
  47     WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const char*),
  48                                 (wxFormatString(f1)));
  49     WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wchar_t*),
  50                                 (wxFormatString(f1)));
  51 #endif
  52
  53     // called by DoPrintf() to output formatted string but can also be called
  54     // directly if no formatting is needed
  55     virtual void Output(const wxString& str) = 0;
  56
  57 protected:
  58     // NB: this is pure virtual so that it can be implemented in dllexported
  59     //     wxMessagOutput class
  60 #if !wxUSE_UTF8_LOCALE_ONLY
  61     virtual void DoPrintfWchar(const wxChar *format, ...) = 0;
  62 #endif
  63 #if wxUSE_UNICODE_UTF8
  64     virtual void DoPrintfUtf8(const char *format, ...) = 0;
  65 #endif
  66 };
  67
  68 #ifdef __VISUALC__
  69     // "non dll-interface class 'wxStringPrintfMixin' used as base interface
  70     // for dll-interface class 'wxString'" -- this is OK in our case
  71     #pragma warning (push)
  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 (pop)
 101 #endif
 102
 103 // ----------------------------------------------------------------------------
 104 // implementation which sends output to stderr or specified file
 105 // ----------------------------------------------------------------------------
 106
 107 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
 108 {
 109 public:
 110     wxMessageOutputStderr(FILE *fp = stderr) : m_fp(fp) { }
 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     FILE *m_fp;
 120 };
 121
 122 // ----------------------------------------------------------------------------
 123 // implementation showing the message to the user in "best" possible way:
 124 // uses stderr or message box if available according to the flag given to ctor.
 125 // ----------------------------------------------------------------------------
 126
 127 enum wxMessageOutputFlags
 128 {
 129     wxMSGOUT_PREFER_STDERR = 0, // use stderr if available (this is the default)
 130     wxMSGOUT_PREFER_MSGBOX = 1  // always use message box if available
 131 };
 132
 133 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutputStderr
 134 {
 135 public:
 136     wxMessageOutputBest(wxMessageOutputFlags flags = wxMSGOUT_PREFER_STDERR)
 137         : m_flags(flags) { }
 138
 139     virtual void Output(const wxString& str);
 140
 141 private:
 142     wxMessageOutputFlags m_flags;
 143 };
 144
 145 // ----------------------------------------------------------------------------
 146 // implementation which shows output in a message box
 147 // ----------------------------------------------------------------------------
 148
 149 #if wxUSE_GUI && wxUSE_MSGDLG
 150
 151 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 152 {
 153 public:
 154     wxMessageOutputMessageBox() { }
 155
 156     virtual void Output(const wxString& str);
 157 };
 158
 159 #endif // wxUSE_GUI && wxUSE_MSGDLG
 160
 161 // ----------------------------------------------------------------------------
 162 // implementation using the native way of outputting debug messages
 163 // ----------------------------------------------------------------------------
 164
 165 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutputStderr
 166 {
 167 public:
 168     wxMessageOutputDebug() { }
 169
 170     virtual void Output(const wxString& str);
 171 };
 172
 173 // ----------------------------------------------------------------------------
 174 // implementation using wxLog (mainly for backwards compatibility)
 175 // ----------------------------------------------------------------------------
 176
 177 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 178 {
 179 public:
 180     wxMessageOutputLog() { }
 181
 182     virtual void Output(const wxString& str);
 183 };
 184
 185 #endif // _WX_MSGOUT_H_