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 protected:
  55     // NB: this is pure virtual so that it can be implemented in dllexported
  56     //     wxMessagOutput class
  57 #if !wxUSE_UTF8_LOCALE_ONLY
  58     virtual void DoPrintfWchar(const wxChar *format, ...) = 0;
  59 #endif
  60 #if wxUSE_UNICODE_UTF8
  61     virtual void DoPrintfUtf8(const char *format, ...) = 0;
  62 #endif
  63
  64     // called by DoPrintf() to output formatted string
  65     virtual void Output(const wxString& str) = 0;
  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 (disable:4275)
  72 #endif
  73
  74 class WXDLLIMPEXP_BASE wxMessageOutput : public wxMessageOutputBase
  75 {
  76 public:
  77     virtual ~wxMessageOutput() { }
  78
  79     // gets the current wxMessageOutput object (may be NULL during
  80     // initialization or shutdown)
  81     static wxMessageOutput* Get();
  82
  83     // sets the global wxMessageOutput instance; returns the previous one
  84     static wxMessageOutput* Set(wxMessageOutput* msgout);
  85
  86 protected:
  87 #if !wxUSE_UTF8_LOCALE_ONLY
  88     virtual void DoPrintfWchar(const wxChar *format, ...);
  89 #endif
  90 #if wxUSE_UNICODE_UTF8
  91     virtual void DoPrintfUtf8(const char *format, ...);
  92 #endif
  93     virtual void Output(const wxString& str) = 0;
  94
  95 private:
  96     static wxMessageOutput* ms_msgOut;
  97 };
  98
  99 #ifdef __VISUALC__
 100     #pragma warning (default:4275)
 101 #endif
 102
 103 // ----------------------------------------------------------------------------
 104 // implementation showing the message to the user in "best" possible way: uses
 105 // native message box if available (currently only under Windows) and stderr
 106 // otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
 107 // ----------------------------------------------------------------------------
 108
 109 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
 110 {
 111 public:
 112     wxMessageOutputBest() { }
 113
 114 protected:
 115     virtual void Output(const wxString& str);
 116 };
 117
 118 // ----------------------------------------------------------------------------
 119 // implementation which sends output to stderr
 120 // ----------------------------------------------------------------------------
 121
 122 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
 123 {
 124 public:
 125     wxMessageOutputStderr() { }
 126
 127 protected:
 128     virtual void Output(const wxString& str);
 129 };
 130
 131 // ----------------------------------------------------------------------------
 132 // implementation which shows output in a message box
 133 // ----------------------------------------------------------------------------
 134
 135 #if wxUSE_GUI && wxUSE_MSGDLG
 136
 137 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 138 {
 139 public:
 140     wxMessageOutputMessageBox() { }
 141
 142 protected:
 143     virtual void Output(const wxString& str);
 144 };
 145
 146 #endif // wxUSE_GUI && wxUSE_MSGDLG
 147
 148 // ----------------------------------------------------------------------------
 149 // implementation using the native way of outputting debug messages
 150 // ----------------------------------------------------------------------------
 151
 152 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
 153 {
 154 public:
 155     wxMessageOutputDebug() { }
 156
 157 protected:
 158     virtual void Output(const wxString& str);
 159 };
 160
 161 // ----------------------------------------------------------------------------
 162 // implementation using wxLog (mainly for backwards compatibility)
 163 // ----------------------------------------------------------------------------
 164
 165 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 166 {
 167 public:
 168     wxMessageOutputLog() { }
 169
 170 protected:
 171     virtual void Output(const wxString& str);
 172 };
 173
 174 #endif
 175     // _WX_MSGOUT_H_