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