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