]> git.saurik.com Git - wxWidgets.git/blob - include/wx/strvararg.h
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
don't use implicit wxString->char*/wchar_t* conversion, it will not be available...
[wxWidgets.git] / include / wx / strvararg.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/strvararg.h
3 // Purpose: macros for implementing type-safe vararg passing of strings
4 // Author: Vaclav Slavik
5 // Created: 2007-02-19
6 // RCS-ID: $Id$
7 // Copyright: (c) 2007 REA Elektronik GmbH
8 // Licence: wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
10
11 #ifndef _WX_STRVARARG_H_
12 #define _WX_STRVARARG_H_
13
14 #include "wx/platform.h"
15 #if wxONLY_WATCOM_EARLIER_THAN(1,4)
16 #error "OpenWatcom version >= 1.4 is required to compile this code"
17 #endif
18
19 #include "wx/cpp.h"
20 #include "wx/chartype.h"
21 #include "wx/strconv.h"
22 #include "wx/buffer.h"
23 #include "wx/unichar.h"
24
25 class WXDLLIMPEXP_BASE wxCStrData;
26 class WXDLLIMPEXP_BASE wxString;
27
28 // ----------------------------------------------------------------------------
29 // WX_DEFINE_VARARG_FUNC* macros
30 // ----------------------------------------------------------------------------
31
32 // This macro is used to implement type-safe wrappers for variadic functions
33 // that accept strings as arguments. This makes it possible to pass char*,
34 // wchar_t* or even wxString (as opposed to having to use wxString::c_str())
35 // to e.g. wxPrintf().
36 //
37 // This is done by defining a set of N template function taking 1..N arguments
38 // (currently, N is set to 30 in this header). These functions are just thin
39 // wrappers around another variadic function ('impl' or 'implUtf8' arguments,
40 // see below) and the only thing the wrapper does is that it normalizes the
41 // arguments passed in so that they are of the type expected by variadic
42 // functions taking string arguments, i.e., char* or wchar_t*, depending on the
43 // build:
44 // * char* in the current locale's charset in ANSI build
45 // * char* with UTF-8 encoding if wxUSE_UNICODE_UTF8 and the app is running
46 // under an UTF-8 locale
47 // * wchar_t* if wxUSE_UNICODE_WCHAR or if wxUSE_UNICODE_UTF8 and the current
48 // locale is not UTF-8
49 //
50 // Parameters:
51 // [ there are examples in square brackets showing values of the parameters
52 // for the wxFprintf() wrapper for fprintf() function with the following
53 // prototype:
54 // int wxFprintf(FILE *stream, const wxString& format, ...); ]
55 //
56 // rettype Functions' return type [int]
57 // name Name of the function [fprintf]
58 // numfixed The number of leading "fixed" (i.e., not variadic)
59 // arguments of the function (e.g. "stream" and "format"
60 // arguments of fprintf()); their type is _not_ converted
61 // using wxArgNormalizer<T>, unlike the rest of
62 // the function's arguments [2]
63 // fixed List of types of the leading "fixed" arguments, in
64 // parenthesis [(FILE*,const wxString&)]
65 // impl Name of the variadic function that implements 'name' for
66 // the native strings representation (wchar_t* if
67 // wxUSE_UNICODE_WCHAR or wxUSE_UNICODE_UTF8 when running under
68 // non-UTF8 locale, char* in ANSI build) [wxCrt_Fprintf]
69 // implUtf8 Like 'impl', but for the UTF-8 char* version to be used
70 // if wxUSE_UNICODE_UTF8 and running under UTF-8 locale
71 // (ignored otherwise) [fprintf]
72 //
73 #define WX_DEFINE_VARARG_FUNC(rettype, name, numfixed, fixed, impl, implUtf8) \
74 _WX_VARARG_DEFINE_FUNC_N0(rettype, name, impl, implUtf8, numfixed, fixed) \
75 WX_DEFINE_VARARG_FUNC_SANS_N0(rettype, name, numfixed, fixed, impl, implUtf8)
76
77 // ditto, but without the version with 0 template/vararg arguments
78 #define WX_DEFINE_VARARG_FUNC_SANS_N0(rettype, name, \
79 numfixed, fixed, impl, implUtf8) \
80 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
81 _WX_VARARG_DEFINE_FUNC, \
82 rettype, name, impl, implUtf8, numfixed, fixed)
83
84 // Like WX_DEFINE_VARARG_FUNC, but for variadic functions that don't return
85 // a value.
86 #define WX_DEFINE_VARARG_FUNC_VOID(name, numfixed, fixed, impl, implUtf8) \
87 _WX_VARARG_DEFINE_FUNC_VOID_N0(name, impl, implUtf8, numfixed, fixed) \
88 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
89 _WX_VARARG_DEFINE_FUNC_VOID, \
90 void, name, impl, implUtf8, numfixed, fixed)
91
92 // Like WX_DEFINE_VARARG_FUNC_VOID, but instead of wrapping an implementation
93 // function, does nothing in defined functions' bodies.
94 //
95 // Used to implement wxLogXXX functions if wxUSE_LOG=0.
96 #define WX_DEFINE_VARARG_FUNC_NOP(name, numfixed, fixed) \
97 _WX_VARARG_DEFINE_FUNC_NOP_N0(name, numfixed, fixed) \
98 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
99 _WX_VARARG_DEFINE_FUNC_NOP, \
100 void, name, dummy, dummy, numfixed, fixed)
101
102 // Like WX_DEFINE_VARARG_FUNC_CTOR, but for defining template constructors
103 #define WX_DEFINE_VARARG_FUNC_CTOR(name, numfixed, fixed, impl, implUtf8) \
104 _WX_VARARG_DEFINE_FUNC_CTOR_N0(name, impl, implUtf8, numfixed, fixed) \
105 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
106 _WX_VARARG_DEFINE_FUNC_CTOR, \
107 void, name, impl, implUtf8, numfixed, fixed)
108
109
110 // ----------------------------------------------------------------------------
111 // wxFormatString
112 // ----------------------------------------------------------------------------
113
114 // This class should be used for format string argument of the functions
115 // defined using WX_DEFINE_VARARG_FUNC_* macros. It converts the string to
116 // char* or wchar_t* for passing to implementation function efficiently (i.e.
117 // without keeping the converted string in memory for longer than necessary,
118 // like c_str())
119 //
120 // Note that this class can _only_ be used for function arguments!
121 class WXDLLIMPEXP_BASE wxFormatString
122 {
123 public:
124 wxFormatString(const char *str)
125 : m_char(wxCharBuffer::CreateNonOwned(str)), m_str(NULL), m_cstr(NULL) {}
126 wxFormatString(const wchar_t *str)
127 : m_wchar(wxWCharBuffer::CreateNonOwned(str)), m_str(NULL), m_cstr(NULL) {}
128 wxFormatString(const wxString& str)
129 : m_str(&str), m_cstr(NULL) {}
130 wxFormatString(const wxCStrData& str)
131 : m_str(NULL), m_cstr(&str) {}
132 wxFormatString(const wxCharBuffer& str)
133 : m_char(str), m_str(NULL), m_cstr(NULL) {}
134 wxFormatString(const wxWCharBuffer& str)
135 : m_wchar(str), m_str(NULL), m_cstr(NULL) {}
136
137 #if !wxUSE_UNICODE_WCHAR
138 operator const char*() const
139 { return wx_const_cast(wxFormatString*, this)->AsChar(); }
140 private:
141 const char* AsChar();
142 #endif // !wxUSE_UNICODE_WCHAR
143
144 #if wxUSE_UNICODE && !wxUSE_UTF8_LOCALE_ONLY
145 public:
146 operator const wchar_t*() const
147 { return wx_const_cast(wxFormatString*, this)->AsWChar(); }
148 private:
149 const wchar_t* AsWChar();
150 #endif // wxUSE_UNICODE && !wxUSE_UTF8_LOCALE_ONLY
151
152 private:
153 wxCharBuffer m_char;
154 wxWCharBuffer m_wchar;
155 // NB: we can use a pointer here, because wxFormatString is only used
156 // as function argument, so it has shorter life than the string
157 // passed to the ctor
158 const wxString * const m_str;
159 const wxCStrData * const m_cstr;
160
161 DECLARE_NO_COPY_CLASS(wxFormatString)
162 };
163
164 // ----------------------------------------------------------------------------
165 // wxArgNormalizer*<T> converters
166 // ----------------------------------------------------------------------------
167
168 // Converts an argument passed to wxPrint etc. into standard form expected,
169 // by wxXXX functions, e.g. all strings (wxString, char*, wchar_t*) are
170 // converted into wchar_t* or char* depending on the build.
171 template<typename T>
172 struct wxArgNormalizer
173 {
174 wxArgNormalizer(const T& value) : m_value(value) {}
175
176 // Returns the value in a form that can be safely passed to real vararg
177 // functions. In case of strings, this is char* in ANSI build and wchar_t*
178 // in Unicode build.
179 T get() const { return m_value; }
180
181 T m_value;
182 };
183
184 // normalizer for passing arguments to functions working with wchar_t* (and
185 // until ANSI build is removed, char* in ANSI build as well - FIXME-UTF8)
186 // string representation
187 #if !wxUSE_UTF8_LOCALE_ONLY
188 template<typename T>
189 struct wxArgNormalizerWchar : public wxArgNormalizer<T>
190 {
191 wxArgNormalizerWchar(const T& value) : wxArgNormalizer<T>(value) {}
192 };
193 #endif // !wxUSE_UTF8_LOCALE_ONLY
194
195 // normalizer for passing arguments to functions working with UTF-8 encoded
196 // char* strings
197 #if wxUSE_UNICODE_UTF8
198 template<typename T>
199 struct wxArgNormalizerUtf8 : public wxArgNormalizer<T>
200 {
201 wxArgNormalizerUtf8(const T& value) : wxArgNormalizer<T>(value) {}
202 };
203
204 #define wxArgNormalizerNative wxArgNormalizerUtf8
205 #else // wxUSE_UNICODE_WCHAR
206 #define wxArgNormalizerNative wxArgNormalizerWchar
207 #endif // wxUSE_UNICODE_UTF8 // wxUSE_UNICODE_UTF8
208
209
210
211 // special cases for converting strings:
212
213
214 // base class for wxArgNormalizer<T> specializations that need to do conversion;
215 // CharType is either wxStringCharType or wchar_t in UTF-8 build when wrapping
216 // widechar CRT function
217 template<typename CharType>
218 struct wxArgNormalizerWithBuffer
219 {
220 typedef wxCharTypeBuffer<CharType> CharBuffer;
221
222 wxArgNormalizerWithBuffer() {}
223 wxArgNormalizerWithBuffer(const CharBuffer& buf) : m_value(buf) {}
224
225 const CharType *get() const { return m_value; }
226
227 CharBuffer m_value;
228 };
229
230 // string objects:
231 template<>
232 struct WXDLLIMPEXP_BASE wxArgNormalizerNative<const wxString&>
233 {
234 wxArgNormalizerNative(const wxString& s) : m_value(s) {}
235 const wxStringCharType *get() const;
236
237 const wxString& m_value;
238 };
239
240 // c_str() values:
241 template<>
242 struct WXDLLIMPEXP_BASE wxArgNormalizerNative<const wxCStrData&>
243 {
244 wxArgNormalizerNative(const wxCStrData& value) : m_value(value) {}
245 const wxStringCharType *get() const;
246
247 const wxCStrData& m_value;
248 };
249
250 // wxString/wxCStrData conversion to wchar_t* value
251 #if wxUSE_UNICODE_UTF8 && !wxUSE_UTF8_LOCALE_ONLY
252 template<>
253 struct WXDLLIMPEXP_BASE wxArgNormalizerWchar<const wxString&>
254 : public wxArgNormalizerWithBuffer<wchar_t>
255 {
256 wxArgNormalizerWchar(const wxString& s);
257 };
258
259 template<>
260 struct WXDLLIMPEXP_BASE wxArgNormalizerWchar<const wxCStrData&>
261 : public wxArgNormalizerWithBuffer<wchar_t>
262 {
263 wxArgNormalizerWchar(const wxCStrData& s);
264 };
265 #endif // wxUSE_UNICODE_UTF8 && !wxUSE_UTF8_LOCALE_ONLY
266
267
268 // C string pointers of the wrong type (wchar_t* for ANSI or UTF8 build,
269 // char* for wchar_t Unicode build or UTF8):
270 #if wxUSE_UNICODE_WCHAR
271
272 template<>
273 struct wxArgNormalizerWchar<const char*>
274 : public wxArgNormalizerWithBuffer<wchar_t>
275 {
276 wxArgNormalizerWchar(const char* s)
277 : wxArgNormalizerWithBuffer<wchar_t>(wxConvLibc.cMB2WC(s)) {}
278 };
279
280 #elif wxUSE_UNICODE_UTF8
281
282 template<>
283 struct wxArgNormalizerUtf8<const wchar_t*>
284 : public wxArgNormalizerWithBuffer<char>
285 {
286 wxArgNormalizerUtf8(const wchar_t* s)
287 : wxArgNormalizerWithBuffer<char>(wxConvUTF8.cWC2MB(s)) {}
288 };
289
290 template<>
291 struct wxArgNormalizerUtf8<const char*>
292 : public wxArgNormalizerWithBuffer<char>
293 {
294 wxArgNormalizerUtf8(const char* s)
295 {
296 if ( wxLocaleIsUtf8 )
297 {
298 m_value = wxCharBuffer::CreateNonOwned(s);
299 }
300 else
301 {
302 // convert to widechar string first:
303 wxWCharBuffer buf(wxConvLibc.cMB2WC(s));
304
305 // then to UTF-8:
306 if ( buf )
307 m_value = wxConvUTF8.cWC2MB(buf);
308 }
309 }
310 };
311
312 // UTF-8 build needs conversion to wchar_t* too:
313 #if !wxUSE_UTF8_LOCALE_ONLY
314 template<>
315 struct wxArgNormalizerWchar<const char*>
316 : public wxArgNormalizerWithBuffer<wchar_t>
317 {
318 wxArgNormalizerWchar(const char* s)
319 : wxArgNormalizerWithBuffer<wchar_t>(wxConvLibc.cMB2WC(s)) {}
320 };
321 #endif // !wxUSE_UTF8_LOCALE_ONLY
322
323 #else // ANSI - FIXME-UTF8
324
325 template<>
326 struct wxArgNormalizerWchar<const wchar_t*>
327 : public wxArgNormalizerWithBuffer<char>
328 {
329 wxArgNormalizerWchar(const wchar_t* s)
330 : wxArgNormalizerWithBuffer<char>(wxConvLibc.cWC2MB(s)) {}
331 };
332
333 #endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8/ANSI
334
335
336 // this macro is used to implement specialization that are exactly same as
337 // some other specialization, i.e. to "forward" the implementation (e.g. for
338 // T=wxString and T=const wxString&). Note that the ctor takes BaseT argument,
339 // not T!
340 #if wxUSE_UNICODE_UTF8
341 #if wxUSE_UTF8_LOCALE_ONLY
342 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
343 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerUtf8, T, BaseT)
344 #else // possibly non-UTF8 locales
345 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
346 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerWchar, T, BaseT); \
347 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerUtf8, T, BaseT)
348 #endif
349 #else // wxUSE_UNICODE_WCHAR
350 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
351 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerWchar, T, BaseT)
352 #endif // wxUSE_UNICODE_UTF8/wxUSE_UNICODE_WCHAR
353
354 #define _WX_ARG_NORMALIZER_FORWARD_IMPL(Normalizer, T, BaseT) \
355 template<> \
356 struct Normalizer<T> : public Normalizer<BaseT> \
357 { \
358 Normalizer(BaseT value) : Normalizer<BaseT>(value) {} \
359 }
360
361 // non-reference versions of specializations for string objects
362 WX_ARG_NORMALIZER_FORWARD(wxString, const wxString&);
363 WX_ARG_NORMALIZER_FORWARD(wxCStrData, const wxCStrData&);
364
365 // versions for passing non-const pointers:
366 WX_ARG_NORMALIZER_FORWARD(char*, const char*);
367 WX_ARG_NORMALIZER_FORWARD(wchar_t*, const wchar_t*);
368
369 // versions for passing wx[W]CharBuffer:
370 WX_ARG_NORMALIZER_FORWARD(wxCharBuffer, const char*);
371 WX_ARG_NORMALIZER_FORWARD(const wxCharBuffer&, const char*);
372 WX_ARG_NORMALIZER_FORWARD(wxWCharBuffer, const wchar_t*);
373 WX_ARG_NORMALIZER_FORWARD(const wxWCharBuffer&, const wchar_t*);
374
375 // versions for std::[w]string:
376 #if wxUSE_STD_STRING
377
378 #include "wx/stringimpl.h"
379
380 #if !wxUSE_UTF8_LOCALE_ONLY
381 template<>
382 struct wxArgNormalizerWchar<const std::string&>
383 : public wxArgNormalizerWchar<const char*>
384 {
385 wxArgNormalizerWchar(const std::string& s)
386 : wxArgNormalizerWchar<const char*>(s.c_str()) {}
387 };
388
389 template<>
390 struct wxArgNormalizerWchar<const wxStdWideString&>
391 : public wxArgNormalizerWchar<const wchar_t*>
392 {
393 wxArgNormalizerWchar(const wxStdWideString& s)
394 : wxArgNormalizerWchar<const wchar_t*>(s.c_str()) {}
395 };
396 #endif // !wxUSE_UTF8_LOCALE_ONLY
397
398 #if wxUSE_UNICODE_UTF8
399 template<>
400 struct wxArgNormalizerUtf8<const std::string&>
401 : public wxArgNormalizerUtf8<const char*>
402 {
403 wxArgNormalizerUtf8(const std::string& s)
404 : wxArgNormalizerUtf8<const char*>(s.c_str()) {}
405 };
406
407 template<>
408 struct wxArgNormalizerUtf8<const wxStdWideString&>
409 : public wxArgNormalizerUtf8<const wchar_t*>
410 {
411 wxArgNormalizerUtf8(const wxStdWideString& s)
412 : wxArgNormalizerUtf8<const wchar_t*>(s.c_str()) {}
413 };
414 #endif // wxUSE_UNICODE_UTF8
415
416 WX_ARG_NORMALIZER_FORWARD(std::string, const std::string&);
417 WX_ARG_NORMALIZER_FORWARD(wxStdWideString, const wxStdWideString&);
418
419 #endif // wxUSE_STD_STRING
420
421
422 // versions for wxUniChar, wxUniCharRef:
423
424 #if !wxUSE_UTF8_LOCALE_ONLY
425 template<>
426 struct wxArgNormalizerWchar<const wxUniChar&>
427 : public wxArgNormalizerWchar<wxChar/*FIXME-UTF8: should be wchar_t after ANSI removal*/>
428 {
429 wxArgNormalizerWchar(const wxUniChar& s)
430 : wxArgNormalizerWchar<wxChar>((wxChar)s) {}
431 };
432 #endif // !wxUSE_UTF8_LOCALE_ONLY
433
434 #if wxUSE_UNICODE_UTF8
435 template<>
436 struct wxArgNormalizerUtf8<const wxUniChar&>
437 : public wxArgNormalizerUtf8<char>
438 {
439 wxArgNormalizerUtf8(const wxUniChar& s)
440 // FIXME-UTF8: this is lossy, we need to convert to string, but that
441 // requires format string update
442 : wxArgNormalizerUtf8<char>((const char)s) {}
443 };
444 #endif // wxUSE_UNICODE_UTF8
445
446 WX_ARG_NORMALIZER_FORWARD(wxUniChar, const wxUniChar&);
447 WX_ARG_NORMALIZER_FORWARD(const wxUniCharRef&, const wxUniChar&);
448 WX_ARG_NORMALIZER_FORWARD(wxUniCharRef, const wxUniChar&);
449
450
451 #undef WX_ARG_NORMALIZER_FORWARD
452 #undef _WX_ARG_NORMALIZER_FORWARD_IMPL
453
454 // ----------------------------------------------------------------------------
455 // WX_VA_ARG_STRING
456 // ----------------------------------------------------------------------------
457
458 // Replacement for va_arg() for use with strings in functions that accept
459 // strings normalized by wxArgNormalizer<T>:
460
461 struct WXDLLIMPEXP_BASE wxArgNormalizedString
462 {
463 wxArgNormalizedString(const void* ptr) : m_ptr(ptr) {}
464
465 // returns true if non-NULL string was passed in
466 bool IsValid() const { return m_ptr != NULL; }
467 operator bool() const { return IsValid(); }
468
469 // extracts the string, returns empty string if NULL was passed in
470 wxString GetString() const;
471 operator wxString() const;
472
473 private:
474 const void *m_ptr;
475 };
476
477 #define WX_VA_ARG_STRING(ap) wxArgNormalizedString(va_arg(ap, const void*))
478
479 // ----------------------------------------------------------------------------
480 // implementation of the WX_DEFINE_VARARG_* macros
481 // ----------------------------------------------------------------------------
482
483 // NB: The vararg emulation code is limited to 30 variadic and 4 fixed
484 // arguments at the moment.
485 // If you need more variadic arguments, you need to
486 // 1) increase the value of _WX_VARARG_MAX_ARGS
487 // 2) add _WX_VARARG_JOIN_* and _WX_VARARG_ITER_* up to the new
488 // _WX_VARARG_MAX_ARGS value to the lists below
489 // If you need more fixed arguments, you need to
490 // 1) increase the value of _WX_VARARG_MAX_FIXED_ARGS
491 // 2) add _WX_VARARG_FIXED_EXPAND_* and _WX_VARARG_FIXED_UNUSED_EXPAND_*
492 // macros below
493 #define _WX_VARARG_MAX_ARGS 30
494 #define _WX_VARARG_MAX_FIXED_ARGS 4
495
496 #define _WX_VARARG_JOIN_1(m) m(1)
497 #define _WX_VARARG_JOIN_2(m) _WX_VARARG_JOIN_1(m), m(2)
498 #define _WX_VARARG_JOIN_3(m) _WX_VARARG_JOIN_2(m), m(3)
499 #define _WX_VARARG_JOIN_4(m) _WX_VARARG_JOIN_3(m), m(4)
500 #define _WX_VARARG_JOIN_5(m) _WX_VARARG_JOIN_4(m), m(5)
501 #define _WX_VARARG_JOIN_6(m) _WX_VARARG_JOIN_5(m), m(6)
502 #define _WX_VARARG_JOIN_7(m) _WX_VARARG_JOIN_6(m), m(7)
503 #define _WX_VARARG_JOIN_8(m) _WX_VARARG_JOIN_7(m), m(8)
504 #define _WX_VARARG_JOIN_9(m) _WX_VARARG_JOIN_8(m), m(9)
505 #define _WX_VARARG_JOIN_10(m) _WX_VARARG_JOIN_9(m), m(10)
506 #define _WX_VARARG_JOIN_11(m) _WX_VARARG_JOIN_10(m), m(11)
507 #define _WX_VARARG_JOIN_12(m) _WX_VARARG_JOIN_11(m), m(12)
508 #define _WX_VARARG_JOIN_13(m) _WX_VARARG_JOIN_12(m), m(13)
509 #define _WX_VARARG_JOIN_14(m) _WX_VARARG_JOIN_13(m), m(14)
510 #define _WX_VARARG_JOIN_15(m) _WX_VARARG_JOIN_14(m), m(15)
511 #define _WX_VARARG_JOIN_16(m) _WX_VARARG_JOIN_15(m), m(16)
512 #define _WX_VARARG_JOIN_17(m) _WX_VARARG_JOIN_16(m), m(17)
513 #define _WX_VARARG_JOIN_18(m) _WX_VARARG_JOIN_17(m), m(18)
514 #define _WX_VARARG_JOIN_19(m) _WX_VARARG_JOIN_18(m), m(19)
515 #define _WX_VARARG_JOIN_20(m) _WX_VARARG_JOIN_19(m), m(20)
516 #define _WX_VARARG_JOIN_21(m) _WX_VARARG_JOIN_20(m), m(21)
517 #define _WX_VARARG_JOIN_22(m) _WX_VARARG_JOIN_21(m), m(22)
518 #define _WX_VARARG_JOIN_23(m) _WX_VARARG_JOIN_22(m), m(23)
519 #define _WX_VARARG_JOIN_24(m) _WX_VARARG_JOIN_23(m), m(24)
520 #define _WX_VARARG_JOIN_25(m) _WX_VARARG_JOIN_24(m), m(25)
521 #define _WX_VARARG_JOIN_26(m) _WX_VARARG_JOIN_25(m), m(26)
522 #define _WX_VARARG_JOIN_27(m) _WX_VARARG_JOIN_26(m), m(27)
523 #define _WX_VARARG_JOIN_28(m) _WX_VARARG_JOIN_27(m), m(28)
524 #define _WX_VARARG_JOIN_29(m) _WX_VARARG_JOIN_28(m), m(29)
525 #define _WX_VARARG_JOIN_30(m) _WX_VARARG_JOIN_29(m), m(30)
526
527 #define _WX_VARARG_ITER_1(m,a,b,c,d,e,f) m(1,a,b,c,d,e,f)
528 #define _WX_VARARG_ITER_2(m,a,b,c,d,e,f) _WX_VARARG_ITER_1(m,a,b,c,d,e,f) m(2,a,b,c,d,e,f)
529 #define _WX_VARARG_ITER_3(m,a,b,c,d,e,f) _WX_VARARG_ITER_2(m,a,b,c,d,e,f) m(3,a,b,c,d,e,f)
530 #define _WX_VARARG_ITER_4(m,a,b,c,d,e,f) _WX_VARARG_ITER_3(m,a,b,c,d,e,f) m(4,a,b,c,d,e,f)
531 #define _WX_VARARG_ITER_5(m,a,b,c,d,e,f) _WX_VARARG_ITER_4(m,a,b,c,d,e,f) m(5,a,b,c,d,e,f)
532 #define _WX_VARARG_ITER_6(m,a,b,c,d,e,f) _WX_VARARG_ITER_5(m,a,b,c,d,e,f) m(6,a,b,c,d,e,f)
533 #define _WX_VARARG_ITER_7(m,a,b,c,d,e,f) _WX_VARARG_ITER_6(m,a,b,c,d,e,f) m(7,a,b,c,d,e,f)
534 #define _WX_VARARG_ITER_8(m,a,b,c,d,e,f) _WX_VARARG_ITER_7(m,a,b,c,d,e,f) m(8,a,b,c,d,e,f)
535 #define _WX_VARARG_ITER_9(m,a,b,c,d,e,f) _WX_VARARG_ITER_8(m,a,b,c,d,e,f) m(9,a,b,c,d,e,f)
536 #define _WX_VARARG_ITER_10(m,a,b,c,d,e,f) _WX_VARARG_ITER_9(m,a,b,c,d,e,f) m(10,a,b,c,d,e,f)
537 #define _WX_VARARG_ITER_11(m,a,b,c,d,e,f) _WX_VARARG_ITER_10(m,a,b,c,d,e,f) m(11,a,b,c,d,e,f)
538 #define _WX_VARARG_ITER_12(m,a,b,c,d,e,f) _WX_VARARG_ITER_11(m,a,b,c,d,e,f) m(12,a,b,c,d,e,f)
539 #define _WX_VARARG_ITER_13(m,a,b,c,d,e,f) _WX_VARARG_ITER_12(m,a,b,c,d,e,f) m(13,a,b,c,d,e,f)
540 #define _WX_VARARG_ITER_14(m,a,b,c,d,e,f) _WX_VARARG_ITER_13(m,a,b,c,d,e,f) m(14,a,b,c,d,e,f)
541 #define _WX_VARARG_ITER_15(m,a,b,c,d,e,f) _WX_VARARG_ITER_14(m,a,b,c,d,e,f) m(15,a,b,c,d,e,f)
542 #define _WX_VARARG_ITER_16(m,a,b,c,d,e,f) _WX_VARARG_ITER_15(m,a,b,c,d,e,f) m(16,a,b,c,d,e,f)
543 #define _WX_VARARG_ITER_17(m,a,b,c,d,e,f) _WX_VARARG_ITER_16(m,a,b,c,d,e,f) m(17,a,b,c,d,e,f)
544 #define _WX_VARARG_ITER_18(m,a,b,c,d,e,f) _WX_VARARG_ITER_17(m,a,b,c,d,e,f) m(18,a,b,c,d,e,f)
545 #define _WX_VARARG_ITER_19(m,a,b,c,d,e,f) _WX_VARARG_ITER_18(m,a,b,c,d,e,f) m(19,a,b,c,d,e,f)
546 #define _WX_VARARG_ITER_20(m,a,b,c,d,e,f) _WX_VARARG_ITER_19(m,a,b,c,d,e,f) m(20,a,b,c,d,e,f)
547 #define _WX_VARARG_ITER_21(m,a,b,c,d,e,f) _WX_VARARG_ITER_20(m,a,b,c,d,e,f) m(21,a,b,c,d,e,f)
548 #define _WX_VARARG_ITER_22(m,a,b,c,d,e,f) _WX_VARARG_ITER_21(m,a,b,c,d,e,f) m(22,a,b,c,d,e,f)
549 #define _WX_VARARG_ITER_23(m,a,b,c,d,e,f) _WX_VARARG_ITER_22(m,a,b,c,d,e,f) m(23,a,b,c,d,e,f)
550 #define _WX_VARARG_ITER_24(m,a,b,c,d,e,f) _WX_VARARG_ITER_23(m,a,b,c,d,e,f) m(24,a,b,c,d,e,f)
551 #define _WX_VARARG_ITER_25(m,a,b,c,d,e,f) _WX_VARARG_ITER_24(m,a,b,c,d,e,f) m(25,a,b,c,d,e,f)
552 #define _WX_VARARG_ITER_26(m,a,b,c,d,e,f) _WX_VARARG_ITER_25(m,a,b,c,d,e,f) m(26,a,b,c,d,e,f)
553 #define _WX_VARARG_ITER_27(m,a,b,c,d,e,f) _WX_VARARG_ITER_26(m,a,b,c,d,e,f) m(27,a,b,c,d,e,f)
554 #define _WX_VARARG_ITER_28(m,a,b,c,d,e,f) _WX_VARARG_ITER_27(m,a,b,c,d,e,f) m(28,a,b,c,d,e,f)
555 #define _WX_VARARG_ITER_29(m,a,b,c,d,e,f) _WX_VARARG_ITER_28(m,a,b,c,d,e,f) m(29,a,b,c,d,e,f)
556 #define _WX_VARARG_ITER_30(m,a,b,c,d,e,f) _WX_VARARG_ITER_29(m,a,b,c,d,e,f) m(30,a,b,c,d,e,f)
557
558
559 #define _WX_VARARG_FIXED_EXPAND_1(t1) \
560 t1 f1
561 #define _WX_VARARG_FIXED_EXPAND_2(t1,t2) \
562 t1 f1, t2 f2
563 #define _WX_VARARG_FIXED_EXPAND_3(t1,t2,t3) \
564 t1 f1, t2 f2, t3 f3
565 #define _WX_VARARG_FIXED_EXPAND_4(t1,t2,t3,t4) \
566 t1 f1, t2 f2, t3 f3, t4 f4
567
568 #define _WX_VARARG_FIXED_UNUSED_EXPAND_1(t1) \
569 t1 WXUNUSED(f1)
570 #define _WX_VARARG_FIXED_UNUSED_EXPAND_2(t1,t2) \
571 t1 WXUNUSED(f1), t2 WXUNUSED(f2)
572 #define _WX_VARARG_FIXED_UNUSED_EXPAND_3(t1,t2,t3) \
573 t1 WXUNUSED(f1), t2 WXUNUSED(f2), t3 WXUNUSED(f3)
574 #define _WX_VARARG_FIXED_UNUSED_EXPAND_4(t1,t2,t3,t4) \
575 t1 WXUNUSED(f1), t2 WXUNUSED(f2), t3 WXUNUSED(f3), t4 WXUNUSED(f4)
576
577
578 // This macro expands N-items tuple of fixed arguments types into part of
579 // function's declaration. For example,
580 // "_WX_VARARG_FIXED_EXPAND(3, (int, char*, int))" expands into
581 // "int f1, char* f2, int f3".
582 #define _WX_VARARG_FIXED_EXPAND(N, args) \
583 _WX_VARARG_FIXED_EXPAND_IMPL(N, args)
584 #define _WX_VARARG_FIXED_EXPAND_IMPL(N, args) \
585 _WX_VARARG_FIXED_EXPAND_##N args
586
587 // Ditto for unused arguments
588 #define _WX_VARARG_FIXED_UNUSED_EXPAND(N, args) \
589 _WX_VARARG_FIXED_UNUSED_EXPAND_IMPL(N, args)
590 #define _WX_VARARG_FIXED_UNUSED_EXPAND_IMPL(N, args) \
591 _WX_VARARG_FIXED_UNUSED_EXPAND_##N args
592
593
594 // This macro calls another macro 'm' passed as second argument 'N' times,
595 // with its only argument set to 1..N, and concatenates the results using
596 // comma as separator.
597 //
598 // An example:
599 // #define foo(i) x##i
600 // // this expands to "x1,x2,x3,x4"
601 // _WX_VARARG_JOIN(4, foo)
602 //
603 //
604 // N must not be greater than _WX_VARARG_MAX_ARGS (=30).
605 #define _WX_VARARG_JOIN(N, m) _WX_VARARG_JOIN_IMPL(N, m)
606 #define _WX_VARARG_JOIN_IMPL(N, m) _WX_VARARG_JOIN_##N(m)
607
608
609 // This macro calls another macro 'm' passed as second argument 'N' times, with
610 // its first argument set to 1..N and the remaining arguments set to 'a', 'b',
611 // 'c', 'd', 'e' and 'f'. The results are separated with whitespace in the
612 // expansion.
613 //
614 // An example:
615 // // this macro expands to:
616 // // foo(1,a,b,c,d,e,f)
617 // // foo(2,a,b,c,d,e,f)
618 // // foo(3,a,b,c,d,e,f)
619 // _WX_VARARG_ITER(3, foo, a, b, c, d, e, f)
620 //
621 // N must not be greater than _WX_VARARG_MAX_ARGS (=30).
622 #define _WX_VARARG_ITER(N,m,a,b,c,d,e,f) \
623 _WX_VARARG_ITER_IMPL(N,m,a,b,c,d,e,f)
624 #define _WX_VARARG_ITER_IMPL(N,m,a,b,c,d,e,f) \
625 _WX_VARARG_ITER_##N(m,a,b,c,d,e,f)
626
627 // Generates code snippet for i-th "variadic" argument in vararg function's
628 // prototype:
629 #define _WX_VARARG_ARG(i) T##i a##i
630
631 // Like _WX_VARARG_ARG_UNUSED, but outputs argument's type with WXUNUSED:
632 #define _WX_VARARG_ARG_UNUSED(i) T##i WXUNUSED(a##i)
633
634 // Generates code snippet for i-th type in vararg function's template<...>:
635 #define _WX_VARARG_TEMPL(i) typename T##i
636
637 // Generates code snippet for passing i-th argument of vararg function
638 // wrapper to its implementation, normalizing it in the process:
639 #define _WX_VARARG_PASS_WCHAR(i) wxArgNormalizerWchar<T##i>(a##i).get()
640 #define _WX_VARARG_PASS_UTF8(i) wxArgNormalizerUtf8<T##i>(a##i).get()
641
642
643 // And the same for fixed arguments, _not_ normalizing it:
644 // FIXME-UTF8: this works, but uses wxString's implicit conversion to wxChar*
645 // for the 'format' argument (which is const wxString&) _if_ the
646 // implementation function has C sting argument; we need to
647 // have wxFixedArgNormalizer<T> here that will pass everything
648 // as-is except for wxString (for which wx_str() would be used),
649 // but OTOH, we don't want to do that if the implementation takes
650 // wxString argument
651 #define _WX_VARARG_PASS_FIXED(i) f##i
652
653 #if wxUSE_UNICODE_UTF8
654 #define _WX_VARARG_DO_CALL_UTF8(return_kw, impl, implUtf8, N, numfixed) \
655 return_kw implUtf8(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED), \
656 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_UTF8))
657 #define _WX_VARARG_DO_CALL0_UTF8(return_kw, impl, implUtf8, numfixed) \
658 return_kw implUtf8(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED))
659 #endif // wxUSE_UNICODE_UTF8
660
661 #define _WX_VARARG_DO_CALL_WCHAR(return_kw, impl, implUtf8, N, numfixed) \
662 return_kw impl(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED), \
663 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WCHAR))
664 #define _WX_VARARG_DO_CALL0_WCHAR(return_kw, impl, implUtf8, numfixed) \
665 return_kw impl(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED))
666
667 #if wxUSE_UNICODE_UTF8
668 #if wxUSE_UTF8_LOCALE_ONLY
669 #define _WX_VARARG_DO_CALL _WX_VARARG_DO_CALL_UTF8
670 #define _WX_VARARG_DO_CALL0 _WX_VARARG_DO_CALL0_UTF8
671 #else // possibly non-UTF8 locales
672 #define _WX_VARARG_DO_CALL(return_kw, impl, implUtf8, N, numfixed) \
673 if ( wxLocaleIsUtf8 ) \
674 _WX_VARARG_DO_CALL_UTF8(return_kw, impl, implUtf8, N, numfixed);\
675 else \
676 _WX_VARARG_DO_CALL_WCHAR(return_kw, impl, implUtf8, N, numfixed)
677
678 #define _WX_VARARG_DO_CALL0(return_kw, impl, implUtf8, numfixed) \
679 if ( wxLocaleIsUtf8 ) \
680 _WX_VARARG_DO_CALL0_UTF8(return_kw, impl, implUtf8, numfixed); \
681 else \
682 _WX_VARARG_DO_CALL0_WCHAR(return_kw, impl, implUtf8, numfixed)
683 #endif // wxUSE_UTF8_LOCALE_ONLY or not
684 #else // wxUSE_UNICODE_WCHAR or ANSI
685 #define _WX_VARARG_DO_CALL _WX_VARARG_DO_CALL_WCHAR
686 #define _WX_VARARG_DO_CALL0 _WX_VARARG_DO_CALL0_WCHAR
687 #endif // wxUSE_UNICODE_UTF8 / wxUSE_UNICODE_WCHAR
688
689
690 // Macro to be used with _WX_VARARG_ITER in the implementation of
691 // WX_DEFINE_VARARG_FUNC (see its documentation for the meaning of arguments)
692 #define _WX_VARARG_DEFINE_FUNC(N, rettype, name, \
693 impl, implUtf8, numfixed, fixed) \
694 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
695 rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
696 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
697 { \
698 _WX_VARARG_DO_CALL(return, impl, implUtf8, N, numfixed); \
699 }
700
701 #define _WX_VARARG_DEFINE_FUNC_N0(rettype, name, \
702 impl, implUtf8, numfixed, fixed) \
703 inline rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
704 { \
705 _WX_VARARG_DO_CALL0(return, impl, implUtf8, numfixed); \
706 }
707
708 // Macro to be used with _WX_VARARG_ITER in the implementation of
709 // WX_DEFINE_VARARG_FUNC_VOID (see its documentation for the meaning of
710 // arguments; rettype is ignored and is used only to satisfy _WX_VARARG_ITER's
711 // requirements).
712 #define _WX_VARARG_DEFINE_FUNC_VOID(N, rettype, name, \
713 impl, implUtf8, numfixed, fixed) \
714 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
715 void name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
716 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
717 { \
718 _WX_VARARG_DO_CALL(wxEMPTY_PARAMETER_VALUE, \
719 impl, implUtf8, N, numfixed); \
720 }
721
722 #define _WX_VARARG_DEFINE_FUNC_VOID_N0(name, impl, implUtf8, numfixed, fixed) \
723 inline void name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
724 { \
725 _WX_VARARG_DO_CALL0(wxEMPTY_PARAMETER_VALUE, \
726 impl, implUtf8, numfixed); \
727 }
728
729 // Macro to be used with _WX_VARARG_ITER in the implementation of
730 // WX_DEFINE_VARARG_FUNC_CTOR (see its documentation for the meaning of
731 // arguments; rettype is ignored and is used only to satisfy _WX_VARARG_ITER's
732 // requirements).
733 #define _WX_VARARG_DEFINE_FUNC_CTOR(N, rettype, name, \
734 impl, implUtf8, numfixed, fixed) \
735 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
736 name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
737 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
738 { \
739 _WX_VARARG_DO_CALL(wxEMPTY_PARAMETER_VALUE, \
740 impl, implUtf8, N, numfixed); \
741 }
742
743 #define _WX_VARARG_DEFINE_FUNC_CTOR_N0(name, impl, implUtf8, numfixed, fixed) \
744 inline name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
745 { \
746 _WX_VARARG_DO_CALL0(wxEMPTY_PARAMETER_VALUE, \
747 impl, implUtf8, numfixed); \
748 }
749
750 // Macro to be used with _WX_VARARG_ITER in the implementation of
751 // WX_DEFINE_VARARG_FUNC_NOP, i.e. empty stub for a disabled vararg function.
752 // The rettype and impl arguments are ignored.
753 #define _WX_VARARG_DEFINE_FUNC_NOP(N, rettype, name, \
754 impl, implUtf8, numfixed, fixed) \
755 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
756 void name(_WX_VARARG_FIXED_UNUSED_EXPAND(numfixed, fixed), \
757 _WX_VARARG_JOIN(N, _WX_VARARG_ARG_UNUSED)) \
758 {}
759
760 #define _WX_VARARG_DEFINE_FUNC_NOP_N0(name, numfixed, fixed) \
761 inline void name(_WX_VARARG_FIXED_UNUSED_EXPAND(numfixed, fixed)) \
762 {}
763
764
765 // ----------------------------------------------------------------------------
766 // workaround for OpenWatcom bug #351
767 // ----------------------------------------------------------------------------
768
769 #ifdef __WATCOMC__
770 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
771
772 // This macro can be used to forward a 'vararg' template to another one with
773 // different fixed arguments types. Parameters are same as for
774 // WX_DEFINE_VARARG_FUNC (rettype=void can be used here), 'convfixed' is how
775 // to convert fixed arguments. For example, this is typical code for dealing
776 // with different forms of format string:
777 //
778 // WX_DEFINE_VARARG_FUNC_VOID(Printf, 1, (const wxFormatString&),
779 // DoPrintfWchar, DoPrintfUtf8)
780 // #ifdef __WATCOMC__
781 // WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxString&),
782 // (wxFormatString(f1)))
783 // WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const char*),
784 // (wxFormatString(f1)))
785 // ...
786 #define WX_VARARG_WATCOM_WORKAROUND(rettype, name, numfixed, fixed, convfixed)\
787 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
788 _WX_VARARG_WATCOM_WORKAROUND, \
789 rettype, name, convfixed, dummy, numfixed, fixed)
790
791 #define WX_VARARG_WATCOM_WORKAROUND_CTOR(name, numfixed, fixed, convfixed) \
792 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
793 _WX_VARARG_WATCOM_WORKAROUND_CTOR, \
794 dummy, name, convfixed, dummy, numfixed, fixed)
795
796 #define _WX_VARARG_WATCOM_UNPACK_1(a1) a1
797 #define _WX_VARARG_WATCOM_UNPACK_2(a1, a2) a1, a2
798 #define _WX_VARARG_WATCOM_UNPACK_3(a1, a2, a3) a1, a2, a3
799 #define _WX_VARARG_WATCOM_UNPACK_4(a1, a2, a3, a4) a1, a2, a3, a4
800 #define _WX_VARARG_WATCOM_UNPACK(N, convfixed) \
801 _WX_VARARG_WATCOM_UNPACK_##N convfixed
802
803 #define _WX_VARARG_WATCOM_WORKAROUND(N, rettype, name, \
804 convfixed, dummy, numfixed, fixed) \
805 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
806 rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
807 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
808 { \
809 return name(_WX_VARARG_WATCOM_UNPACK(numfixed, convfixed), \
810 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WCHAR)); \
811 }
812
813 #define _WX_VARARG_WATCOM_WORKAROUND_CTOR(N, dummy1, name, \
814 convfixed, dummy2, numfixed, fixed) \
815 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
816 name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
817 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
818 { \
819 name(_WX_VARARG_WATCOM_UNPACK(numfixed, convfixed), \
820 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WCHAR)); \
821 }
822
823 #endif // __WATCOMC__
824
825 #endif // _WX_STRVARARG_H_
wxWidgets (Impactor)