projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Don't assume size_t is either int- or long-sized.
[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 #if defined(HAVE_TYPE_TRAITS)
26 #include <type_traits>
27 #elif defined(HAVE_TR1_TYPE_TRAITS)
28 #ifdef __VISUALC__
29 #include <type_traits>
30 #else
31 #include <tr1/type_traits>
32 #endif
33 #endif
34
35 class WXDLLIMPEXP_FWD_BASE wxCStrData;
36 class WXDLLIMPEXP_FWD_BASE wxString;
37
38 // ----------------------------------------------------------------------------
39 // WX_DEFINE_VARARG_FUNC* macros
40 // ----------------------------------------------------------------------------
41
42 // This macro is used to implement type-safe wrappers for variadic functions
43 // that accept strings as arguments. This makes it possible to pass char*,
44 // wchar_t* or even wxString (as opposed to having to use wxString::c_str())
45 // to e.g. wxPrintf().
46 //
47 // This is done by defining a set of N template function taking 1..N arguments
48 // (currently, N is set to 30 in this header). These functions are just thin
49 // wrappers around another variadic function ('impl' or 'implUtf8' arguments,
50 // see below) and the only thing the wrapper does is that it normalizes the
51 // arguments passed in so that they are of the type expected by variadic
52 // functions taking string arguments, i.e., char* or wchar_t*, depending on the
53 // build:
54 // * char* in the current locale's charset in ANSI build
55 // * char* with UTF-8 encoding if wxUSE_UNICODE_UTF8 and the app is running
56 // under an UTF-8 locale
57 // * wchar_t* if wxUSE_UNICODE_WCHAR or if wxUSE_UNICODE_UTF8 and the current
58 // locale is not UTF-8
59 //
60 // Note that wxFormatString *must* be used for the format parameter of these
61 // functions, otherwise the implementation won't work correctly. Furthermore,
62 // it must be passed by value, not reference, because it's modified by the
63 // vararg templates internally.
64 //
65 // Parameters:
66 // [ there are examples in square brackets showing values of the parameters
67 // for the wxFprintf() wrapper for fprintf() function with the following
68 // prototype:
69 // int wxFprintf(FILE *stream, const wxString& format, ...); ]
70 //
71 // rettype Functions' return type [int]
72 // name Name of the function [fprintf]
73 // numfixed The number of leading "fixed" (i.e., not variadic)
74 // arguments of the function (e.g. "stream" and "format"
75 // arguments of fprintf()); their type is _not_ converted
76 // using wxArgNormalizer<T>, unlike the rest of
77 // the function's arguments [2]
78 // fixed List of types of the leading "fixed" arguments, in
79 // parenthesis [(FILE*,const wxString&)]
80 // impl Name of the variadic function that implements 'name' for
81 // the native strings representation (wchar_t* if
82 // wxUSE_UNICODE_WCHAR or wxUSE_UNICODE_UTF8 when running under
83 // non-UTF8 locale, char* in ANSI build) [wxCrt_Fprintf]
84 // implUtf8 Like 'impl', but for the UTF-8 char* version to be used
85 // if wxUSE_UNICODE_UTF8 and running under UTF-8 locale
86 // (ignored otherwise) [fprintf]
87 //
88 #define WX_DEFINE_VARARG_FUNC(rettype, name, numfixed, fixed, impl, implUtf8) \
89 _WX_VARARG_DEFINE_FUNC_N0(rettype, name, impl, implUtf8, numfixed, fixed) \
90 WX_DEFINE_VARARG_FUNC_SANS_N0(rettype, name, numfixed, fixed, impl, implUtf8)
91
92 // ditto, but without the version with 0 template/vararg arguments
93 #define WX_DEFINE_VARARG_FUNC_SANS_N0(rettype, name, \
94 numfixed, fixed, impl, implUtf8) \
95 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
96 _WX_VARARG_DEFINE_FUNC, \
97 rettype, name, impl, implUtf8, numfixed, fixed)
98
99 // Like WX_DEFINE_VARARG_FUNC, but for variadic functions that don't return
100 // a value.
101 #define WX_DEFINE_VARARG_FUNC_VOID(name, numfixed, fixed, impl, implUtf8) \
102 _WX_VARARG_DEFINE_FUNC_VOID_N0(name, impl, implUtf8, numfixed, fixed) \
103 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
104 _WX_VARARG_DEFINE_FUNC_VOID, \
105 void, name, impl, implUtf8, numfixed, fixed)
106
107 // Like WX_DEFINE_VARARG_FUNC_VOID, but instead of wrapping an implementation
108 // function, does nothing in defined functions' bodies.
109 //
110 // Used to implement wxLogXXX functions if wxUSE_LOG=0.
111 #define WX_DEFINE_VARARG_FUNC_NOP(name, numfixed, fixed) \
112 _WX_VARARG_DEFINE_FUNC_NOP_N0(name, numfixed, fixed) \
113 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
114 _WX_VARARG_DEFINE_FUNC_NOP, \
115 void, name, dummy, dummy, numfixed, fixed)
116
117 // Like WX_DEFINE_VARARG_FUNC_CTOR, but for defining template constructors
118 #define WX_DEFINE_VARARG_FUNC_CTOR(name, numfixed, fixed, impl, implUtf8) \
119 _WX_VARARG_DEFINE_FUNC_CTOR_N0(name, impl, implUtf8, numfixed, fixed) \
120 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
121 _WX_VARARG_DEFINE_FUNC_CTOR, \
122 void, name, impl, implUtf8, numfixed, fixed)
123
124
125 // ----------------------------------------------------------------------------
126 // wxFormatString
127 // ----------------------------------------------------------------------------
128
129 // This class must be used for format string argument of the functions
130 // defined using WX_DEFINE_VARARG_FUNC_* macros. It converts the string to
131 // char* or wchar_t* for passing to implementation function efficiently (i.e.
132 // without keeping the converted string in memory for longer than necessary,
133 // like c_str()). It also converts format string to the correct form that
134 // accounts for string changes done by wxArgNormalizer<>
135 //
136 // Note that this class can _only_ be used for function arguments!
137 class WXDLLIMPEXP_BASE wxFormatString
138 {
139 public:
140 wxFormatString(const char *str)
141 : m_char(wxScopedCharBuffer::CreateNonOwned(str)), m_str(NULL), m_cstr(NULL) {}
142 wxFormatString(const wchar_t *str)
143 : m_wchar(wxScopedWCharBuffer::CreateNonOwned(str)), m_str(NULL), m_cstr(NULL) {}
144 wxFormatString(const wxString& str)
145 : m_str(&str), m_cstr(NULL) {}
146 wxFormatString(const wxCStrData& str)
147 : m_str(NULL), m_cstr(&str) {}
148 wxFormatString(const wxScopedCharBuffer& str)
149 : m_char(str), m_str(NULL), m_cstr(NULL) {}
150 wxFormatString(const wxScopedWCharBuffer& str)
151 : m_wchar(str), m_str(NULL), m_cstr(NULL) {}
152
153 // Possible argument types. These are or-combinable for wxASSERT_ARG_TYPE
154 // convenience.
155 enum ArgumentType
156 {
157 Arg_Char = 0x0001, // character as char %c
158 Arg_Pointer = 0x0002, // %p
159 Arg_String = 0x0004, // any form of string
160
161 Arg_Int = 0x0008,
162 #if SIZEOF_INT == SIZEOF_LONG
163 Arg_LongInt = Arg_Int,
164 #else
165 Arg_LongInt = 0x0010,
166 #endif
167 #if defined(SIZEOF_LONG_LONG) && SIZEOF_LONG_LONG == SIZEOF_LONG
168 Arg_LongLongInt = Arg_LongInt,
169 #elif defined(wxLongLong_t)
170 Arg_LongLongInt = 0x0020,
171 #endif
172
173 Arg_Double = 0x0040,
174 Arg_LongDouble = 0x0080,
175
176 #if defined(wxSIZE_T_IS_UINT)
177 Arg_Size_t = Arg_Int,
178 #elif defined(wxSIZE_T_IS_ULONG)
179 Arg_Size_t = Arg_LongInt,
180 #elif defined(SIZEOF_LONG_LONG) && SIZEOF_SIZE_T == SIZEOF_LONG_LONG
181 Arg_Size_t = Arg_LongLongInt,
182 #else
183 Arg_Size_t = 0x0100,
184 #endif
185
186 Arg_IntPtr = 0x0200, // %n -- store # of chars written
187 Arg_ShortIntPtr = 0x0400,
188 Arg_LongIntPtr = 0x0800,
189
190 Arg_Unknown = 0x8000 // unrecognized specifier (likely error)
191 };
192
193 // returns the type of format specifier for n-th variadic argument (this is
194 // not necessarily n-th format specifier if positional specifiers are used);
195 // called by wxArgNormalizer<> specializations to get information about
196 // n-th variadic argument desired representation
197 ArgumentType GetArgumentType(unsigned n) const;
198
199 // returns the value passed to ctor, only converted to wxString, similarly
200 // to other InputAsXXX() methods
201 wxString InputAsString() const;
202
203 #if !wxUSE_UNICODE_WCHAR
204 operator const char*() const
205 { return const_cast<wxFormatString*>(this)->AsChar(); }
206 private:
207 // InputAsChar() returns the value passed to ctor, only converted
208 // to char, while AsChar() takes the the string returned by InputAsChar()
209 // and does format string conversion on it as well (and similarly for
210 // ..AsWChar() below)
211 const char* InputAsChar();
212 const char* AsChar();
213 wxScopedCharBuffer m_convertedChar;
214 #endif // !wxUSE_UNICODE_WCHAR
215
216 #if wxUSE_UNICODE && !wxUSE_UTF8_LOCALE_ONLY
217 public:
218 operator const wchar_t*() const
219 { return const_cast<wxFormatString*>(this)->AsWChar(); }
220 private:
221 const wchar_t* InputAsWChar();
222 const wchar_t* AsWChar();
223 wxScopedWCharBuffer m_convertedWChar;
224 #endif // wxUSE_UNICODE && !wxUSE_UTF8_LOCALE_ONLY
225
226 private:
227 wxScopedCharBuffer m_char;
228 wxScopedWCharBuffer m_wchar;
229
230 // NB: we can use a pointer here, because wxFormatString is only used
231 // as function argument, so it has shorter life than the string
232 // passed to the ctor
233 const wxString * const m_str;
234 const wxCStrData * const m_cstr;
235
236 wxDECLARE_NO_ASSIGN_CLASS(wxFormatString);
237 };
238
239 // these two helper classes are used to find wxFormatString argument among fixed
240 // arguments passed to a vararg template
241 struct wxFormatStringArgument
242 {
243 wxFormatStringArgument(const wxFormatString *s = NULL) : m_str(s) {}
244 const wxFormatString *m_str;
245
246 // overriding this operator allows us to reuse _WX_VARARG_JOIN macro
247 wxFormatStringArgument operator,(const wxFormatStringArgument& a) const
248 {
249 wxASSERT_MSG( m_str == NULL || a.m_str == NULL,
250 "can't have two format strings in vararg function" );
251 return wxFormatStringArgument(m_str ? m_str : a.m_str);
252 }
253
254 operator const wxFormatString*() const { return m_str; }
255 };
256
257 template<typename T>
258 struct wxFormatStringArgumentFinder
259 {
260 static wxFormatStringArgument find(T)
261 {
262 // by default, arguments are not format strings, so return "not found"
263 return wxFormatStringArgument();
264 }
265 };
266
267 template<>
268 struct wxFormatStringArgumentFinder<const wxFormatString&>
269 {
270 static wxFormatStringArgument find(const wxFormatString& arg)
271 { return wxFormatStringArgument(&arg); }
272 };
273
274 template<>
275 struct wxFormatStringArgumentFinder<wxFormatString>
276 : public wxFormatStringArgumentFinder<const wxFormatString&> {};
277
278 // avoid passing big objects by value to wxFormatStringArgumentFinder::find()
279 // (and especially wx[W]CharBuffer with its auto_ptr<> style semantics!):
280 template<>
281 struct wxFormatStringArgumentFinder<wxString>
282 : public wxFormatStringArgumentFinder<const wxString&> {};
283
284 template<>
285 struct wxFormatStringArgumentFinder<wxScopedCharBuffer>
286 : public wxFormatStringArgumentFinder<const wxScopedCharBuffer&> {};
287
288 template<>
289 struct wxFormatStringArgumentFinder<wxScopedWCharBuffer>
290 : public wxFormatStringArgumentFinder<const wxScopedWCharBuffer&> {};
291
292 template<>
293 struct wxFormatStringArgumentFinder<wxCharBuffer>
294 : public wxFormatStringArgumentFinder<const wxCharBuffer&> {};
295
296 template<>
297 struct wxFormatStringArgumentFinder<wxWCharBuffer>
298 : public wxFormatStringArgumentFinder<const wxWCharBuffer&> {};
299
300
301 // ----------------------------------------------------------------------------
302 // wxArgNormalizer*<T> converters
303 // ----------------------------------------------------------------------------
304
305 #if wxDEBUG_LEVEL
306 // Check that the format specifier for index-th argument in 'fmt' has
307 // the correct type (one of wxFormatString::Arg_XXX or-combination in
308 // 'expected_mask').
309 #define wxASSERT_ARG_TYPE(fmt, index, expected_mask) \
310 do \
311 { \
312 if ( !fmt ) \
313 break; \
314 const int argtype = fmt->GetArgumentType(index); \
315 wxASSERT_MSG( (argtype & (expected_mask)) == argtype, \
316 "format specifier doesn't match argument type" ); \
317 } while ( wxFalse )
318 #else
319 #define wxASSERT_ARG_TYPE(fmt, index, expected_mask)
320 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
321
322
323 #if defined(HAVE_TYPE_TRAITS) || defined(HAVE_TR1_TYPE_TRAITS)
324
325 // Note: this type is misnamed, so that the error message is easier to
326 // understand (no error happens for enums, because the IsEnum=true case is
327 // specialized).
328 template<bool IsEnum>
329 struct wxFormatStringSpecifierNonPodType {};
330
331 template<>
332 struct wxFormatStringSpecifierNonPodType<true>
333 {
334 enum { value = wxFormatString::Arg_Int };
335 };
336
337 template<typename T>
338 struct wxFormatStringSpecifier
339 {
340 #ifdef HAVE_TYPE_TRAITS
341 typedef std::is_enum<T> is_enum;
342 #elif defined HAVE_TR1_TYPE_TRAITS
343 typedef std::tr1::is_enum<T> is_enum;
344 #endif
345 enum { value = wxFormatStringSpecifierNonPodType<is_enum::value>::value };
346 };
347
348 #else // !HAVE_(TR1_)TYPE_TRAITS
349
350 template<typename T>
351 struct wxFormatStringSpecifier
352 {
353 // We can't detect enums without is_enum, so the only thing we can
354 // do is to accept unknown types. However, the only acceptable unknown
355 // types still are enums, which are promoted to ints, so return Arg_Int
356 // here. This will at least catch passing of non-POD types through ... at
357 // runtime.
358 //
359 // Furthermore, if the compiler doesn't have partial template
360 // specialization, we didn't cover pointers either.
361 #ifdef HAVE_PARTIAL_SPECIALIZATION
362 enum { value = wxFormatString::Arg_Int };
363 #else
364 enum { value = wxFormatString::Arg_Int | wxFormatString::Arg_Pointer };
365 #endif
366 };
367
368 #endif // HAVE_TR1_TYPE_TRAITS/!HAVE_TR1_TYPE_TRAITS
369
370
371 #ifdef HAVE_PARTIAL_SPECIALIZATION
372 template<typename T>
373 struct wxFormatStringSpecifier<T*>
374 {
375 enum { value = wxFormatString::Arg_Pointer };
376 };
377
378 template<typename T>
379 struct wxFormatStringSpecifier<const T*>
380 {
381 enum { value = wxFormatString::Arg_Pointer };
382 };
383 #endif // !HAVE_PARTIAL_SPECIALIZATION
384
385
386 #define wxFORMAT_STRING_SPECIFIER(T, arg) \
387 template<> struct wxFormatStringSpecifier<T> \
388 { \
389 enum { value = arg }; \
390 };
391
392 wxFORMAT_STRING_SPECIFIER(bool, wxFormatString::Arg_Int)
393 wxFORMAT_STRING_SPECIFIER(int, wxFormatString::Arg_Int)
394 wxFORMAT_STRING_SPECIFIER(unsigned int, wxFormatString::Arg_Int)
395 wxFORMAT_STRING_SPECIFIER(short int, wxFormatString::Arg_Int)
396 wxFORMAT_STRING_SPECIFIER(short unsigned int, wxFormatString::Arg_Int)
397 wxFORMAT_STRING_SPECIFIER(long int, wxFormatString::Arg_LongInt)
398 wxFORMAT_STRING_SPECIFIER(long unsigned int, wxFormatString::Arg_LongInt)
399 #ifdef wxLongLong_t
400 wxFORMAT_STRING_SPECIFIER(wxLongLong_t, wxFormatString::Arg_LongLongInt)
401 wxFORMAT_STRING_SPECIFIER(wxULongLong_t, wxFormatString::Arg_LongLongInt)
402 #endif
403 wxFORMAT_STRING_SPECIFIER(float, wxFormatString::Arg_Double)
404 wxFORMAT_STRING_SPECIFIER(double, wxFormatString::Arg_Double)
405 wxFORMAT_STRING_SPECIFIER(long double, wxFormatString::Arg_LongDouble)
406
407 #if wxWCHAR_T_IS_REAL_TYPE
408 wxFORMAT_STRING_SPECIFIER(wchar_t, wxFormatString::Arg_Char | wxFormatString::Arg_Int)
409 #endif
410
411 wxFORMAT_STRING_SPECIFIER(char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
412 wxFORMAT_STRING_SPECIFIER(unsigned char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
413 wxFORMAT_STRING_SPECIFIER(signed char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
414 wxFORMAT_STRING_SPECIFIER(const char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
415 wxFORMAT_STRING_SPECIFIER(const unsigned char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
416 wxFORMAT_STRING_SPECIFIER(const signed char*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
417 wxFORMAT_STRING_SPECIFIER(wchar_t*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
418 wxFORMAT_STRING_SPECIFIER(const wchar_t*, wxFormatString::Arg_String | wxFormatString::Arg_Pointer)
419
420 wxFORMAT_STRING_SPECIFIER(int*, wxFormatString::Arg_IntPtr | wxFormatString::Arg_Pointer)
421 wxFORMAT_STRING_SPECIFIER(short int*, wxFormatString::Arg_ShortIntPtr | wxFormatString::Arg_Pointer)
422 wxFORMAT_STRING_SPECIFIER(long int*, wxFormatString::Arg_LongIntPtr | wxFormatString::Arg_Pointer)
423
424 #undef wxFORMAT_STRING_SPECIFIER
425
426
427 // Converts an argument passed to wxPrint etc. into standard form expected,
428 // by wxXXX functions, e.g. all strings (wxString, char*, wchar_t*) are
429 // converted into wchar_t* or char* depending on the build.
430 template<typename T>
431 struct wxArgNormalizer
432 {
433 // Ctor. 'value' is the value passed as variadic argument, 'fmt' is pointer
434 // to printf-like format string or NULL if the variadic function doesn't
435 // use format string and 'index' is index of 'value' in variadic arguments
436 // list (starting at 1)
437 wxArgNormalizer(T value,
438 const wxFormatString *fmt, unsigned index)
439 : m_value(value)
440 {
441 wxASSERT_ARG_TYPE( fmt, index, wxFormatStringSpecifier<T>::value );
442 }
443
444 // Returns the value in a form that can be safely passed to real vararg
445 // functions. In case of strings, this is char* in ANSI build and wchar_t*
446 // in Unicode build.
447 T get() const { return m_value; }
448
449 T m_value;
450 };
451
452 // normalizer for passing arguments to functions working with wchar_t* (and
453 // until ANSI build is removed, char* in ANSI build as well - FIXME-UTF8)
454 // string representation
455 #if !wxUSE_UTF8_LOCALE_ONLY
456 template<typename T>
457 struct wxArgNormalizerWchar : public wxArgNormalizer<T>
458 {
459 wxArgNormalizerWchar(T value,
460 const wxFormatString *fmt, unsigned index)
461 : wxArgNormalizer<T>(value, fmt, index) {}
462 };
463 #endif // !wxUSE_UTF8_LOCALE_ONLY
464
465 // normalizer for passing arguments to functions working with UTF-8 encoded
466 // char* strings
467 #if wxUSE_UNICODE_UTF8
468 template<typename T>
469 struct wxArgNormalizerUtf8 : public wxArgNormalizer<T>
470 {
471 wxArgNormalizerUtf8(T value,
472 const wxFormatString *fmt, unsigned index)
473 : wxArgNormalizer<T>(value, fmt, index) {}
474 };
475
476 #define wxArgNormalizerNative wxArgNormalizerUtf8
477 #else // wxUSE_UNICODE_WCHAR
478 #define wxArgNormalizerNative wxArgNormalizerWchar
479 #endif // wxUSE_UNICODE_UTF8 // wxUSE_UNICODE_UTF8
480
481
482
483 // special cases for converting strings:
484
485
486 // base class for wxArgNormalizer<T> specializations that need to do conversion;
487 // CharType is either wxStringCharType or wchar_t in UTF-8 build when wrapping
488 // widechar CRT function
489 template<typename CharType>
490 struct wxArgNormalizerWithBuffer
491 {
492 typedef wxScopedCharTypeBuffer<CharType> CharBuffer;
493
494 wxArgNormalizerWithBuffer() {}
495 wxArgNormalizerWithBuffer(const CharBuffer& buf,
496 const wxFormatString *fmt,
497 unsigned index)
498 : m_value(buf)
499 {
500 wxASSERT_ARG_TYPE( fmt, index,
501 wxFormatString::Arg_String | wxFormatString::Arg_Pointer );
502 }
503
504 const CharType *get() const { return m_value; }
505
506 CharBuffer m_value;
507 };
508
509 // string objects:
510 template<>
511 struct WXDLLIMPEXP_BASE wxArgNormalizerNative<const wxString&>
512 {
513 wxArgNormalizerNative(const wxString& s,
514 const wxFormatString *fmt,
515 unsigned index)
516 : m_value(s)
517 {
518 wxASSERT_ARG_TYPE( fmt, index, wxFormatString::Arg_String );
519 }
520
521 const wxStringCharType *get() const;
522
523 const wxString& m_value;
524 };
525
526 // c_str() values:
527 template<>
528 struct WXDLLIMPEXP_BASE wxArgNormalizerNative<const wxCStrData&>
529 {
530 wxArgNormalizerNative(const wxCStrData& value,
531 const wxFormatString *fmt,
532 unsigned index)
533 : m_value(value)
534 {
535 wxASSERT_ARG_TYPE( fmt, index,
536 wxFormatString::Arg_String | wxFormatString::Arg_Pointer );
537 }
538
539 const wxStringCharType *get() const;
540
541 const wxCStrData& m_value;
542 };
543
544 // wxString/wxCStrData conversion to wchar_t* value
545 #if wxUSE_UNICODE_UTF8 && !wxUSE_UTF8_LOCALE_ONLY
546 template<>
547 struct WXDLLIMPEXP_BASE wxArgNormalizerWchar<const wxString&>
548 : public wxArgNormalizerWithBuffer<wchar_t>
549 {
550 wxArgNormalizerWchar(const wxString& s,
551 const wxFormatString *fmt, unsigned index);
552 };
553
554 template<>
555 struct WXDLLIMPEXP_BASE wxArgNormalizerWchar<const wxCStrData&>
556 : public wxArgNormalizerWithBuffer<wchar_t>
557 {
558 wxArgNormalizerWchar(const wxCStrData& s,
559 const wxFormatString *fmt, unsigned index);
560 };
561 #endif // wxUSE_UNICODE_UTF8 && !wxUSE_UTF8_LOCALE_ONLY
562
563
564 // C string pointers of the wrong type (wchar_t* for ANSI or UTF8 build,
565 // char* for wchar_t Unicode build or UTF8):
566 #if wxUSE_UNICODE_WCHAR
567
568 template<>
569 struct wxArgNormalizerWchar<const char*>
570 : public wxArgNormalizerWithBuffer<wchar_t>
571 {
572 wxArgNormalizerWchar(const char* s,
573 const wxFormatString *fmt, unsigned index)
574 : wxArgNormalizerWithBuffer<wchar_t>(wxConvLibc.cMB2WC(s), fmt, index) {}
575 };
576
577 #elif wxUSE_UNICODE_UTF8
578
579 template<>
580 struct wxArgNormalizerUtf8<const wchar_t*>
581 : public wxArgNormalizerWithBuffer<char>
582 {
583 wxArgNormalizerUtf8(const wchar_t* s,
584 const wxFormatString *fmt, unsigned index)
585 : wxArgNormalizerWithBuffer<char>(wxConvUTF8.cWC2MB(s), fmt, index) {}
586 };
587
588 template<>
589 struct wxArgNormalizerUtf8<const char*>
590 : public wxArgNormalizerWithBuffer<char>
591 {
592 wxArgNormalizerUtf8(const char* s,
593 const wxFormatString *fmt,
594 unsigned index)
595 {
596 wxASSERT_ARG_TYPE( fmt, index,
597 wxFormatString::Arg_String | wxFormatString::Arg_Pointer );
598
599 if ( wxLocaleIsUtf8 )
600 {
601 m_value = wxScopedCharBuffer::CreateNonOwned(s);
602 }
603 else
604 {
605 // convert to widechar string first:
606 wxScopedWCharBuffer buf(wxConvLibc.cMB2WC(s));
607
608 // then to UTF-8:
609 if ( buf )
610 m_value = wxConvUTF8.cWC2MB(buf);
611 }
612 }
613 };
614
615 // UTF-8 build needs conversion to wchar_t* too:
616 #if !wxUSE_UTF8_LOCALE_ONLY
617 template<>
618 struct wxArgNormalizerWchar<const char*>
619 : public wxArgNormalizerWithBuffer<wchar_t>
620 {
621 wxArgNormalizerWchar(const char* s,
622 const wxFormatString *fmt, unsigned index)
623 : wxArgNormalizerWithBuffer<wchar_t>(wxConvLibc.cMB2WC(s), fmt, index) {}
624 };
625 #endif // !wxUSE_UTF8_LOCALE_ONLY
626
627 #else // ANSI - FIXME-UTF8
628
629 template<>
630 struct wxArgNormalizerWchar<const wchar_t*>
631 : public wxArgNormalizerWithBuffer<char>
632 {
633 wxArgNormalizerWchar(const wchar_t* s,
634 const wxFormatString *fmt, unsigned index)
635 : wxArgNormalizerWithBuffer<char>(wxConvLibc.cWC2MB(s), fmt, index) {}
636 };
637
638 #endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8/ANSI
639
640
641 // this macro is used to implement specialization that are exactly same as
642 // some other specialization, i.e. to "forward" the implementation (e.g. for
643 // T=wxString and T=const wxString&). Note that the ctor takes BaseT argument,
644 // not T!
645 #if wxUSE_UNICODE_UTF8
646 #if wxUSE_UTF8_LOCALE_ONLY
647 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
648 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerUtf8, T, BaseT)
649 #else // possibly non-UTF8 locales
650 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
651 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerWchar, T, BaseT); \
652 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerUtf8, T, BaseT)
653 #endif
654 #else // wxUSE_UNICODE_WCHAR
655 #define WX_ARG_NORMALIZER_FORWARD(T, BaseT) \
656 _WX_ARG_NORMALIZER_FORWARD_IMPL(wxArgNormalizerWchar, T, BaseT)
657 #endif // wxUSE_UNICODE_UTF8/wxUSE_UNICODE_WCHAR
658
659 #define _WX_ARG_NORMALIZER_FORWARD_IMPL(Normalizer, T, BaseT) \
660 template<> \
661 struct Normalizer<T> : public Normalizer<BaseT> \
662 { \
663 Normalizer(BaseT value, \
664 const wxFormatString *fmt, unsigned index) \
665 : Normalizer<BaseT>(value, fmt, index) {} \
666 }
667
668 // non-reference versions of specializations for string objects
669 WX_ARG_NORMALIZER_FORWARD(wxString, const wxString&);
670 WX_ARG_NORMALIZER_FORWARD(wxCStrData, const wxCStrData&);
671
672 // versions for passing non-const pointers:
673 WX_ARG_NORMALIZER_FORWARD(char*, const char*);
674 WX_ARG_NORMALIZER_FORWARD(wchar_t*, const wchar_t*);
675
676 // versions for passing wx[W]CharBuffer:
677 WX_ARG_NORMALIZER_FORWARD(wxScopedCharBuffer, const char*);
678 WX_ARG_NORMALIZER_FORWARD(const wxScopedCharBuffer&, const char*);
679 WX_ARG_NORMALIZER_FORWARD(wxScopedWCharBuffer, const wchar_t*);
680 WX_ARG_NORMALIZER_FORWARD(const wxScopedWCharBuffer&, const wchar_t*);
681 WX_ARG_NORMALIZER_FORWARD(wxCharBuffer, const char*);
682 WX_ARG_NORMALIZER_FORWARD(const wxCharBuffer&, const char*);
683 WX_ARG_NORMALIZER_FORWARD(wxWCharBuffer, const wchar_t*);
684 WX_ARG_NORMALIZER_FORWARD(const wxWCharBuffer&, const wchar_t*);
685
686 // versions for std::[w]string:
687 #if wxUSE_STD_STRING
688
689 #include "wx/stringimpl.h"
690
691 #if !wxUSE_UTF8_LOCALE_ONLY
692 template<>
693 struct wxArgNormalizerWchar<const std::string&>
694 : public wxArgNormalizerWchar<const char*>
695 {
696 wxArgNormalizerWchar(const std::string& s,
697 const wxFormatString *fmt, unsigned index)
698 : wxArgNormalizerWchar<const char*>(s.c_str(), fmt, index) {}
699 };
700
701 template<>
702 struct wxArgNormalizerWchar<const wxStdWideString&>
703 : public wxArgNormalizerWchar<const wchar_t*>
704 {
705 wxArgNormalizerWchar(const wxStdWideString& s,
706 const wxFormatString *fmt, unsigned index)
707 : wxArgNormalizerWchar<const wchar_t*>(s.c_str(), fmt, index) {}
708 };
709 #endif // !wxUSE_UTF8_LOCALE_ONLY
710
711 #if wxUSE_UNICODE_UTF8
712 template<>
713 struct wxArgNormalizerUtf8<const std::string&>
714 : public wxArgNormalizerUtf8<const char*>
715 {
716 wxArgNormalizerUtf8(const std::string& s,
717 const wxFormatString *fmt, unsigned index)
718 : wxArgNormalizerUtf8<const char*>(s.c_str(), fmt, index) {}
719 };
720
721 template<>
722 struct wxArgNormalizerUtf8<const wxStdWideString&>
723 : public wxArgNormalizerUtf8<const wchar_t*>
724 {
725 wxArgNormalizerUtf8(const wxStdWideString& s,
726 const wxFormatString *fmt, unsigned index)
727 : wxArgNormalizerUtf8<const wchar_t*>(s.c_str(), fmt, index) {}
728 };
729 #endif // wxUSE_UNICODE_UTF8
730
731 WX_ARG_NORMALIZER_FORWARD(std::string, const std::string&);
732 WX_ARG_NORMALIZER_FORWARD(wxStdWideString, const wxStdWideString&);
733
734 #endif // wxUSE_STD_STRING
735
736
737 // versions for wxUniChar, wxUniCharRef:
738 // (this is same for UTF-8 and Wchar builds, we just convert to wchar_t)
739 template<>
740 struct wxArgNormalizer<const wxUniChar&> : public wxArgNormalizer<wchar_t>
741 {
742 wxArgNormalizer(const wxUniChar& s,
743 const wxFormatString *fmt, unsigned index)
744 : wxArgNormalizer<wchar_t>(s.GetValue(), fmt, index) {}
745 };
746
747 // for wchar_t, default handler does the right thing
748
749 // char has to be treated differently in Unicode builds: a char argument may
750 // be used either for a character value (which should be converted into
751 // wxUniChar) or as an integer value (which should be left as-is). We take
752 // advantage of the fact that both char and wchar_t are converted into int
753 // in variadic arguments here.
754 #if wxUSE_UNICODE
755 template<typename T>
756 struct wxArgNormalizerNarrowChar
757 {
758 wxArgNormalizerNarrowChar(T value,
759 const wxFormatString *fmt, unsigned index)
760 {
761 wxASSERT_ARG_TYPE( fmt, index,
762 wxFormatString::Arg_Char | wxFormatString::Arg_Int );
763
764 // FIXME-UTF8: which one is better default in absence of fmt string
765 // (i.e. when used like e.g. Foo("foo", "bar", 'c', NULL)?
766 if ( !fmt || fmt->GetArgumentType(index) == wxFormatString::Arg_Char )
767 m_value = wx_truncate_cast(T, wxUniChar(value).GetValue());
768 else
769 m_value = value;
770 }
771
772 int get() const { return m_value; }
773
774 T m_value;
775 };
776
777 template<>
778 struct wxArgNormalizer<char> : public wxArgNormalizerNarrowChar<char>
779 {
780 wxArgNormalizer(char value,
781 const wxFormatString *fmt, unsigned index)
782 : wxArgNormalizerNarrowChar<char>(value, fmt, index) {}
783 };
784
785 template<>
786 struct wxArgNormalizer<unsigned char>
787 : public wxArgNormalizerNarrowChar<unsigned char>
788 {
789 wxArgNormalizer(unsigned char value,
790 const wxFormatString *fmt, unsigned index)
791 : wxArgNormalizerNarrowChar<unsigned char>(value, fmt, index) {}
792 };
793
794 template<>
795 struct wxArgNormalizer<signed char>
796 : public wxArgNormalizerNarrowChar<signed char>
797 {
798 wxArgNormalizer(signed char value,
799 const wxFormatString *fmt, unsigned index)
800 : wxArgNormalizerNarrowChar<signed char>(value, fmt, index) {}
801 };
802
803 #endif // wxUSE_UNICODE
804
805 // convert references:
806 WX_ARG_NORMALIZER_FORWARD(wxUniChar, const wxUniChar&);
807 WX_ARG_NORMALIZER_FORWARD(const wxUniCharRef&, const wxUniChar&);
808 WX_ARG_NORMALIZER_FORWARD(wxUniCharRef, const wxUniChar&);
809 WX_ARG_NORMALIZER_FORWARD(const wchar_t&, wchar_t);
810
811 WX_ARG_NORMALIZER_FORWARD(const char&, char);
812 WX_ARG_NORMALIZER_FORWARD(const unsigned char&, unsigned char);
813 WX_ARG_NORMALIZER_FORWARD(const signed char&, signed char);
814
815
816 #undef WX_ARG_NORMALIZER_FORWARD
817 #undef _WX_ARG_NORMALIZER_FORWARD_IMPL
818
819 #undef wxASSERT_ARG_TYPE
820
821 // ----------------------------------------------------------------------------
822 // WX_VA_ARG_STRING
823 // ----------------------------------------------------------------------------
824
825 // Replacement for va_arg() for use with strings in functions that accept
826 // strings normalized by wxArgNormalizer<T>:
827
828 struct WXDLLIMPEXP_BASE wxArgNormalizedString
829 {
830 wxArgNormalizedString(const void* ptr) : m_ptr(ptr) {}
831
832 // returns true if non-NULL string was passed in
833 bool IsValid() const { return m_ptr != NULL; }
834 operator bool() const { return IsValid(); }
835
836 // extracts the string, returns empty string if NULL was passed in
837 wxString GetString() const;
838 operator wxString() const;
839
840 private:
841 const void *m_ptr;
842 };
843
844 #define WX_VA_ARG_STRING(ap) wxArgNormalizedString(va_arg(ap, const void*))
845
846 // ----------------------------------------------------------------------------
847 // implementation of the WX_DEFINE_VARARG_* macros
848 // ----------------------------------------------------------------------------
849
850 // NB: The vararg emulation code is limited to 30 variadic and 4 fixed
851 // arguments at the moment.
852 // If you need more variadic arguments, you need to
853 // 1) increase the value of _WX_VARARG_MAX_ARGS
854 // 2) add _WX_VARARG_JOIN_* and _WX_VARARG_ITER_* up to the new
855 // _WX_VARARG_MAX_ARGS value to the lists below
856 // If you need more fixed arguments, you need to
857 // 1) increase the value of _WX_VARARG_MAX_FIXED_ARGS
858 // 2) add _WX_VARARG_FIXED_EXPAND_* and _WX_VARARG_FIXED_UNUSED_EXPAND_*
859 // macros below
860 #define _WX_VARARG_MAX_ARGS 30
861 #define _WX_VARARG_MAX_FIXED_ARGS 4
862
863 #define _WX_VARARG_JOIN_1(m) m(1)
864 #define _WX_VARARG_JOIN_2(m) _WX_VARARG_JOIN_1(m), m(2)
865 #define _WX_VARARG_JOIN_3(m) _WX_VARARG_JOIN_2(m), m(3)
866 #define _WX_VARARG_JOIN_4(m) _WX_VARARG_JOIN_3(m), m(4)
867 #define _WX_VARARG_JOIN_5(m) _WX_VARARG_JOIN_4(m), m(5)
868 #define _WX_VARARG_JOIN_6(m) _WX_VARARG_JOIN_5(m), m(6)
869 #define _WX_VARARG_JOIN_7(m) _WX_VARARG_JOIN_6(m), m(7)
870 #define _WX_VARARG_JOIN_8(m) _WX_VARARG_JOIN_7(m), m(8)
871 #define _WX_VARARG_JOIN_9(m) _WX_VARARG_JOIN_8(m), m(9)
872 #define _WX_VARARG_JOIN_10(m) _WX_VARARG_JOIN_9(m), m(10)
873 #define _WX_VARARG_JOIN_11(m) _WX_VARARG_JOIN_10(m), m(11)
874 #define _WX_VARARG_JOIN_12(m) _WX_VARARG_JOIN_11(m), m(12)
875 #define _WX_VARARG_JOIN_13(m) _WX_VARARG_JOIN_12(m), m(13)
876 #define _WX_VARARG_JOIN_14(m) _WX_VARARG_JOIN_13(m), m(14)
877 #define _WX_VARARG_JOIN_15(m) _WX_VARARG_JOIN_14(m), m(15)
878 #define _WX_VARARG_JOIN_16(m) _WX_VARARG_JOIN_15(m), m(16)
879 #define _WX_VARARG_JOIN_17(m) _WX_VARARG_JOIN_16(m), m(17)
880 #define _WX_VARARG_JOIN_18(m) _WX_VARARG_JOIN_17(m), m(18)
881 #define _WX_VARARG_JOIN_19(m) _WX_VARARG_JOIN_18(m), m(19)
882 #define _WX_VARARG_JOIN_20(m) _WX_VARARG_JOIN_19(m), m(20)
883 #define _WX_VARARG_JOIN_21(m) _WX_VARARG_JOIN_20(m), m(21)
884 #define _WX_VARARG_JOIN_22(m) _WX_VARARG_JOIN_21(m), m(22)
885 #define _WX_VARARG_JOIN_23(m) _WX_VARARG_JOIN_22(m), m(23)
886 #define _WX_VARARG_JOIN_24(m) _WX_VARARG_JOIN_23(m), m(24)
887 #define _WX_VARARG_JOIN_25(m) _WX_VARARG_JOIN_24(m), m(25)
888 #define _WX_VARARG_JOIN_26(m) _WX_VARARG_JOIN_25(m), m(26)
889 #define _WX_VARARG_JOIN_27(m) _WX_VARARG_JOIN_26(m), m(27)
890 #define _WX_VARARG_JOIN_28(m) _WX_VARARG_JOIN_27(m), m(28)
891 #define _WX_VARARG_JOIN_29(m) _WX_VARARG_JOIN_28(m), m(29)
892 #define _WX_VARARG_JOIN_30(m) _WX_VARARG_JOIN_29(m), m(30)
893
894 #define _WX_VARARG_ITER_1(m,a,b,c,d,e,f) m(1,a,b,c,d,e,f)
895 #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)
896 #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)
897 #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)
898 #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)
899 #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)
900 #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)
901 #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)
902 #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)
903 #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)
904 #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)
905 #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)
906 #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)
907 #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)
908 #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)
909 #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)
910 #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)
911 #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)
912 #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)
913 #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)
914 #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)
915 #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)
916 #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)
917 #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)
918 #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)
919 #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)
920 #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)
921 #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)
922 #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)
923 #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)
924
925
926 #define _WX_VARARG_FIXED_EXPAND_1(t1) \
927 t1 f1
928 #define _WX_VARARG_FIXED_EXPAND_2(t1,t2) \
929 t1 f1, t2 f2
930 #define _WX_VARARG_FIXED_EXPAND_3(t1,t2,t3) \
931 t1 f1, t2 f2, t3 f3
932 #define _WX_VARARG_FIXED_EXPAND_4(t1,t2,t3,t4) \
933 t1 f1, t2 f2, t3 f3, t4 f4
934
935 #define _WX_VARARG_FIXED_UNUSED_EXPAND_1(t1) \
936 t1 WXUNUSED(f1)
937 #define _WX_VARARG_FIXED_UNUSED_EXPAND_2(t1,t2) \
938 t1 WXUNUSED(f1), t2 WXUNUSED(f2)
939 #define _WX_VARARG_FIXED_UNUSED_EXPAND_3(t1,t2,t3) \
940 t1 WXUNUSED(f1), t2 WXUNUSED(f2), t3 WXUNUSED(f3)
941 #define _WX_VARARG_FIXED_UNUSED_EXPAND_4(t1,t2,t3,t4) \
942 t1 WXUNUSED(f1), t2 WXUNUSED(f2), t3 WXUNUSED(f3), t4 WXUNUSED(f4)
943
944 #define _WX_VARARG_FIXED_TYPEDEFS_1(t1) \
945 typedef t1 TF1
946 #define _WX_VARARG_FIXED_TYPEDEFS_2(t1,t2) \
947 _WX_VARARG_FIXED_TYPEDEFS_1(t1); typedef t2 TF2
948 #define _WX_VARARG_FIXED_TYPEDEFS_3(t1,t2,t3) \
949 _WX_VARARG_FIXED_TYPEDEFS_2(t1,t2); typedef t3 TF3
950 #define _WX_VARARG_FIXED_TYPEDEFS_4(t1,t2,t3,t4) \
951 _WX_VARARG_FIXED_TYPEDEFS_3(t1,t2,t3); typedef t4 TF4
952
953 // This macro expands N-items tuple of fixed arguments types into part of
954 // function's declaration. For example,
955 // "_WX_VARARG_FIXED_EXPAND(3, (int, char*, int))" expands into
956 // "int f1, char* f2, int f3".
957 #define _WX_VARARG_FIXED_EXPAND(N, args) \
958 _WX_VARARG_FIXED_EXPAND_IMPL(N, args)
959 #define _WX_VARARG_FIXED_EXPAND_IMPL(N, args) \
960 _WX_VARARG_FIXED_EXPAND_##N args
961
962 // Ditto for unused arguments
963 #define _WX_VARARG_FIXED_UNUSED_EXPAND(N, args) \
964 _WX_VARARG_FIXED_UNUSED_EXPAND_IMPL(N, args)
965 #define _WX_VARARG_FIXED_UNUSED_EXPAND_IMPL(N, args) \
966 _WX_VARARG_FIXED_UNUSED_EXPAND_##N args
967
968 // Declarates typedefs for fixed arguments types; i-th fixed argument types
969 // will have TFi typedef.
970 #define _WX_VARARG_FIXED_TYPEDEFS(N, args) \
971 _WX_VARARG_FIXED_TYPEDEFS_IMPL(N, args)
972 #define _WX_VARARG_FIXED_TYPEDEFS_IMPL(N, args) \
973 _WX_VARARG_FIXED_TYPEDEFS_##N args
974
975
976 // This macro calls another macro 'm' passed as second argument 'N' times,
977 // with its only argument set to 1..N, and concatenates the results using
978 // comma as separator.
979 //
980 // An example:
981 // #define foo(i) x##i
982 // // this expands to "x1,x2,x3,x4"
983 // _WX_VARARG_JOIN(4, foo)
984 //
985 //
986 // N must not be greater than _WX_VARARG_MAX_ARGS (=30).
987 #define _WX_VARARG_JOIN(N, m) _WX_VARARG_JOIN_IMPL(N, m)
988 #define _WX_VARARG_JOIN_IMPL(N, m) _WX_VARARG_JOIN_##N(m)
989
990
991 // This macro calls another macro 'm' passed as second argument 'N' times, with
992 // its first argument set to 1..N and the remaining arguments set to 'a', 'b',
993 // 'c', 'd', 'e' and 'f'. The results are separated with whitespace in the
994 // expansion.
995 //
996 // An example:
997 // // this macro expands to:
998 // // foo(1,a,b,c,d,e,f)
999 // // foo(2,a,b,c,d,e,f)
1000 // // foo(3,a,b,c,d,e,f)
1001 // _WX_VARARG_ITER(3, foo, a, b, c, d, e, f)
1002 //
1003 // N must not be greater than _WX_VARARG_MAX_ARGS (=30).
1004 #define _WX_VARARG_ITER(N,m,a,b,c,d,e,f) \
1005 _WX_VARARG_ITER_IMPL(N,m,a,b,c,d,e,f)
1006 #define _WX_VARARG_ITER_IMPL(N,m,a,b,c,d,e,f) \
1007 _WX_VARARG_ITER_##N(m,a,b,c,d,e,f)
1008
1009 // Generates code snippet for i-th "variadic" argument in vararg function's
1010 // prototype:
1011 #define _WX_VARARG_ARG(i) T##i a##i
1012
1013 // Like _WX_VARARG_ARG_UNUSED, but outputs argument's type with WXUNUSED:
1014 #define _WX_VARARG_ARG_UNUSED(i) T##i WXUNUSED(a##i)
1015
1016 // Generates code snippet for i-th type in vararg function's template<...>:
1017 #define _WX_VARARG_TEMPL(i) typename T##i
1018
1019 // Generates code snippet for passing i-th argument of vararg function
1020 // wrapper to its implementation, normalizing it in the process:
1021 #define _WX_VARARG_PASS_WCHAR(i) \
1022 wxArgNormalizerWchar<T##i>(a##i, fmt, i).get()
1023 #define _WX_VARARG_PASS_UTF8(i) \
1024 wxArgNormalizerUtf8<T##i>(a##i, fmt, i).get()
1025
1026
1027 // And the same for fixed arguments, _not_ normalizing it:
1028 #define _WX_VARARG_PASS_FIXED(i) f##i
1029
1030 #define _WX_VARARG_FIND_FMT(i) \
1031 (wxFormatStringArgumentFinder<TF##i>::find(f##i))
1032
1033 #define _WX_VARARG_FORMAT_STRING(numfixed, fixed) \
1034 _WX_VARARG_FIXED_TYPEDEFS(numfixed, fixed); \
1035 const wxFormatString *fmt = \
1036 (_WX_VARARG_JOIN(numfixed, _WX_VARARG_FIND_FMT))
1037
1038 #if wxUSE_UNICODE_UTF8
1039 #define _WX_VARARG_DO_CALL_UTF8(return_kw, impl, implUtf8, N, numfixed) \
1040 return_kw implUtf8(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED), \
1041 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_UTF8))
1042 #define _WX_VARARG_DO_CALL0_UTF8(return_kw, impl, implUtf8, numfixed) \
1043 return_kw implUtf8(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED))
1044 #endif // wxUSE_UNICODE_UTF8
1045
1046 #define _WX_VARARG_DO_CALL_WCHAR(return_kw, impl, implUtf8, N, numfixed) \
1047 return_kw impl(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED), \
1048 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WCHAR))
1049 #define _WX_VARARG_DO_CALL0_WCHAR(return_kw, impl, implUtf8, numfixed) \
1050 return_kw impl(_WX_VARARG_JOIN(numfixed, _WX_VARARG_PASS_FIXED))
1051
1052 #if wxUSE_UNICODE_UTF8
1053 #if wxUSE_UTF8_LOCALE_ONLY
1054 #define _WX_VARARG_DO_CALL _WX_VARARG_DO_CALL_UTF8
1055 #define _WX_VARARG_DO_CALL0 _WX_VARARG_DO_CALL0_UTF8
1056 #else // possibly non-UTF8 locales
1057 #define _WX_VARARG_DO_CALL(return_kw, impl, implUtf8, N, numfixed) \
1058 if ( wxLocaleIsUtf8 ) \
1059 _WX_VARARG_DO_CALL_UTF8(return_kw, impl, implUtf8, N, numfixed);\
1060 else \
1061 _WX_VARARG_DO_CALL_WCHAR(return_kw, impl, implUtf8, N, numfixed)
1062
1063 #define _WX_VARARG_DO_CALL0(return_kw, impl, implUtf8, numfixed) \
1064 if ( wxLocaleIsUtf8 ) \
1065 _WX_VARARG_DO_CALL0_UTF8(return_kw, impl, implUtf8, numfixed); \
1066 else \
1067 _WX_VARARG_DO_CALL0_WCHAR(return_kw, impl, implUtf8, numfixed)
1068 #endif // wxUSE_UTF8_LOCALE_ONLY or not
1069 #else // wxUSE_UNICODE_WCHAR or ANSI
1070 #define _WX_VARARG_DO_CALL _WX_VARARG_DO_CALL_WCHAR
1071 #define _WX_VARARG_DO_CALL0 _WX_VARARG_DO_CALL0_WCHAR
1072 #endif // wxUSE_UNICODE_UTF8 / wxUSE_UNICODE_WCHAR
1073
1074
1075 // Macro to be used with _WX_VARARG_ITER in the implementation of
1076 // WX_DEFINE_VARARG_FUNC (see its documentation for the meaning of arguments)
1077 #define _WX_VARARG_DEFINE_FUNC(N, rettype, name, \
1078 impl, implUtf8, numfixed, fixed) \
1079 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1080 rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
1081 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
1082 { \
1083 _WX_VARARG_FORMAT_STRING(numfixed, fixed); \
1084 _WX_VARARG_DO_CALL(return, impl, implUtf8, N, numfixed); \
1085 }
1086
1087 #define _WX_VARARG_DEFINE_FUNC_N0(rettype, name, \
1088 impl, implUtf8, numfixed, fixed) \
1089 inline rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
1090 { \
1091 _WX_VARARG_DO_CALL0(return, impl, implUtf8, numfixed); \
1092 }
1093
1094 // Macro to be used with _WX_VARARG_ITER in the implementation of
1095 // WX_DEFINE_VARARG_FUNC_VOID (see its documentation for the meaning of
1096 // arguments; rettype is ignored and is used only to satisfy _WX_VARARG_ITER's
1097 // requirements).
1098 #define _WX_VARARG_DEFINE_FUNC_VOID(N, rettype, name, \
1099 impl, implUtf8, numfixed, fixed) \
1100 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1101 void name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
1102 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
1103 { \
1104 _WX_VARARG_FORMAT_STRING(numfixed, fixed); \
1105 _WX_VARARG_DO_CALL(wxEMPTY_PARAMETER_VALUE, \
1106 impl, implUtf8, N, numfixed); \
1107 }
1108
1109 #define _WX_VARARG_DEFINE_FUNC_VOID_N0(name, impl, implUtf8, numfixed, fixed) \
1110 inline void name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
1111 { \
1112 _WX_VARARG_DO_CALL0(wxEMPTY_PARAMETER_VALUE, \
1113 impl, implUtf8, numfixed); \
1114 }
1115
1116 // Macro to be used with _WX_VARARG_ITER in the implementation of
1117 // WX_DEFINE_VARARG_FUNC_CTOR (see its documentation for the meaning of
1118 // arguments; rettype is ignored and is used only to satisfy _WX_VARARG_ITER's
1119 // requirements).
1120 #define _WX_VARARG_DEFINE_FUNC_CTOR(N, rettype, name, \
1121 impl, implUtf8, numfixed, fixed) \
1122 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1123 name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
1124 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
1125 { \
1126 _WX_VARARG_FORMAT_STRING(numfixed, fixed); \
1127 _WX_VARARG_DO_CALL(wxEMPTY_PARAMETER_VALUE, \
1128 impl, implUtf8, N, numfixed); \
1129 }
1130
1131 #define _WX_VARARG_DEFINE_FUNC_CTOR_N0(name, impl, implUtf8, numfixed, fixed) \
1132 inline name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed)) \
1133 { \
1134 _WX_VARARG_DO_CALL0(wxEMPTY_PARAMETER_VALUE, \
1135 impl, implUtf8, numfixed); \
1136 }
1137
1138 // Macro to be used with _WX_VARARG_ITER in the implementation of
1139 // WX_DEFINE_VARARG_FUNC_NOP, i.e. empty stub for a disabled vararg function.
1140 // The rettype and impl arguments are ignored.
1141 #define _WX_VARARG_DEFINE_FUNC_NOP(N, rettype, name, \
1142 impl, implUtf8, numfixed, fixed) \
1143 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1144 void name(_WX_VARARG_FIXED_UNUSED_EXPAND(numfixed, fixed), \
1145 _WX_VARARG_JOIN(N, _WX_VARARG_ARG_UNUSED)) \
1146 {}
1147
1148 #define _WX_VARARG_DEFINE_FUNC_NOP_N0(name, numfixed, fixed) \
1149 inline void name(_WX_VARARG_FIXED_UNUSED_EXPAND(numfixed, fixed)) \
1150 {}
1151
1152
1153 // ----------------------------------------------------------------------------
1154 // workaround for OpenWatcom bug #351
1155 // ----------------------------------------------------------------------------
1156
1157 #ifdef __WATCOMC__
1158 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
1159
1160 // This macro can be used to forward a 'vararg' template to another one with
1161 // different fixed arguments types. Parameters are same as for
1162 // WX_DEFINE_VARARG_FUNC (rettype=void can be used here), 'convfixed' is how
1163 // to convert fixed arguments. For example, this is typical code for dealing
1164 // with different forms of format string:
1165 //
1166 // WX_DEFINE_VARARG_FUNC_VOID(Printf, 1, (const wxFormatString&),
1167 // DoPrintfWchar, DoPrintfUtf8)
1168 // #ifdef __WATCOMC__
1169 // WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const wxString&),
1170 // (wxFormatString(f1)))
1171 // WX_VARARG_WATCOM_WORKAROUND(void, Printf, 1, (const char*),
1172 // (wxFormatString(f1)))
1173 // ...
1174 #define WX_VARARG_WATCOM_WORKAROUND(rettype, name, numfixed, fixed, convfixed)\
1175 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
1176 _WX_VARARG_WATCOM_WORKAROUND, \
1177 rettype, name, convfixed, dummy, numfixed, fixed)
1178
1179 #define WX_VARARG_WATCOM_WORKAROUND_CTOR(name, numfixed, fixed, convfixed) \
1180 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
1181 _WX_VARARG_WATCOM_WORKAROUND_CTOR, \
1182 dummy, name, convfixed, dummy, numfixed, fixed)
1183
1184 #define _WX_VARARG_WATCOM_UNPACK_1(a1) a1
1185 #define _WX_VARARG_WATCOM_UNPACK_2(a1, a2) a1, a2
1186 #define _WX_VARARG_WATCOM_UNPACK_3(a1, a2, a3) a1, a2, a3
1187 #define _WX_VARARG_WATCOM_UNPACK_4(a1, a2, a3, a4) a1, a2, a3, a4
1188 #define _WX_VARARG_WATCOM_UNPACK(N, convfixed) \
1189 _WX_VARARG_WATCOM_UNPACK_##N convfixed
1190
1191 #define _WX_VARARG_PASS_WATCOM(i) a##i
1192
1193 #define _WX_VARARG_WATCOM_WORKAROUND(N, rettype, name, \
1194 convfixed, dummy, numfixed, fixed) \
1195 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1196 rettype name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
1197 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
1198 { \
1199 return name(_WX_VARARG_WATCOM_UNPACK(numfixed, convfixed), \
1200 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WATCOM)); \
1201 }
1202
1203 #define _WX_VARARG_WATCOM_WORKAROUND_CTOR(N, dummy1, name, \
1204 convfixed, dummy2, numfixed, fixed) \
1205 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
1206 name(_WX_VARARG_FIXED_EXPAND(numfixed, fixed), \
1207 _WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
1208 { \
1209 name(_WX_VARARG_WATCOM_UNPACK(numfixed, convfixed), \
1210 _WX_VARARG_JOIN(N, _WX_VARARG_PASS_WATCOM)); \
1211 }
1212
1213 #endif // __WATCOMC__
1214
1215 #endif // _WX_STRVARARG_H_
wxWidgets (Impactor)