]> git.saurik.com Git - wxWidgets.git/blame - include/wx/strvararg.h
remove wxWINT_T_IS_TYPEDEF as it seems wint_t is always a typedef (although it can...
[wxWidgets.git] / include / wx / strvararg.h
CommitLineData
c9f78968
VS
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
e3f6cbd9 19#include "wx/chartype.h"
c9f78968
VS
20
21class WXDLLIMPEXP_BASE wxCStrData;
22class WXDLLIMPEXP_BASE wxString;
23class WXDLLIMPEXP_BASE wxCharBuffer;
24class WXDLLIMPEXP_BASE wxWCharBuffer;
25
26
27// ----------------------------------------------------------------------------
28// WX_DEFINE_VARARG_FUNC* macros
29// ----------------------------------------------------------------------------
30
31// This macro is used to implement type-safe wrappers for variadic functions
32// that accept strings as arguments. This makes it possible to pass char*,
33// wchar_t* or even wxString (as opposed to having to use wxString::c_str())
34// to e.g. wxPrintf().
35//
36// This is done by defining a set of N template function taking 1..N arguments
37// (currently, N is set to 30 in this header). These functions are just thin
38// wrappers around another variadic function (@a impl) and the only thing
39// the wrapper does is that it normalizes the arguments passed in so that
40// they are of the type expected by variadic functions taking string
41// arguments, i.e., char* or wchar_t*, depending on the build:
42// * char* in the current locale's charset in ANSI build
43// * whchar_t* in the Unicode build
44//
45// Parameters:
46// rettype Functions' return type.
47// name Name of the function.
48// impl Name of the variadic function that implements 'name'.
49#define WX_DEFINE_VARARG_FUNC(rettype, name, impl) \
50 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
51 _WX_VARARG_DEFINE_FUNC, \
52 rettype, name, impl)
53
54// Like WX_DEFINE_VARARG_FUNC, but for variadic functions that don't return
55// a value.
56#define WX_DEFINE_VARARG_FUNC_VOID(name, impl) \
57 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
58 _WX_VARARG_DEFINE_FUNC_VOID, \
59 void, name, impl)
60
61// Like WX_DEFINE_VARARG_FUNC_VOID, but instead of wrapping an implementation
62// function, does nothing in defined functions' bodies.
63//
64// Used to implement wxLogXXX functions if wxUSE_LOG=0.
65#define WX_DEFINE_VARARG_FUNC_NOP(name) \
66 _WX_VARARG_ITER(_WX_VARARG_MAX_ARGS, \
67 _WX_VARARG_DEFINE_FUNC_NOP, \
68 void, name, dummy)
69
70// ----------------------------------------------------------------------------
71// implementation
72// ----------------------------------------------------------------------------
73
74// Converts an argument passed to wxPrint etc. into standard form expected,
75// by wxXXX functions, e.g. all strings (wxString, char*, wchar_t*) are
76// converted into wchar_t* or char* depending on the build.
77template<typename T>
78struct wxArgNormalizer
79{
80 wxArgNormalizer(const T& value) : m_value(value) {}
81
82 // Returns the value in a form that can be safely passed to real vararg
83 // functions. In case of strings, this is char* in ANSI build and wchar_t*
84 // in Unicode build.
85 const T& get() const { return m_value; }
86
87 const T& m_value;
88};
89
90// special cases for converting strings:
91
e3f6cbd9 92// FIXME-UTF8: move this to chartype.h!
c9f78968
VS
93#if wxUSE_UNICODE
94 /* for now, all Unicode builds are wchar_t* based: */
95 #define wxUSE_UNICODE_WCHAR 1
96#else
97 #define wxUSE_UNICODE_WCHAR 0
98#endif
99
e3f6cbd9 100// FIXME-UTF8: include wx/chartype.h and use wxChar after headers split
c9f78968
VS
101// FIXME-UTF8: this will be char* in UTF-8 build and wchar_t* on Windows
102#if wxUSE_UNICODE_WCHAR
103 typedef wchar_t wxArgNativeCharType;
104#else
105 typedef char wxArgNativeCharType;
106#endif
107
108template<>
109struct WXDLLIMPEXP_BASE wxArgNormalizer<const wxCStrData&>
110{
111 wxArgNormalizer(const wxCStrData& value) : m_value(value) {}
112 const wxArgNativeCharType *get() const;
113
114 const wxCStrData& m_value;
115};
116
117template<>
118struct wxArgNormalizer<wxCStrData> : public wxArgNormalizer<const wxCStrData&>
119{
120 wxArgNormalizer(const wxCStrData& value)
121 : wxArgNormalizer<const wxCStrData&>(value) {}
122};
123
124template<>
125struct WXDLLIMPEXP_BASE wxArgNormalizer<const wxString&>
126{
127 wxArgNormalizer(const wxString& value) : m_value(value) {}
128 const wxArgNativeCharType *get() const;
129
130 const wxString& m_value;
131};
132
133template<>
134struct wxArgNormalizer<wxString> : public wxArgNormalizer<const wxString&>
135{
136 wxArgNormalizer(const wxString& value)
137 : wxArgNormalizer<const wxString&>(value) {}
138};
139
140#if wxUSE_UNICODE_WCHAR
141
142template<>
143struct WXDLLIMPEXP_BASE wxArgNormalizer<const char*>
144{
145 wxArgNormalizer(const char *value);
146 ~wxArgNormalizer();
147 const wchar_t *get() const;
148
149 wxWCharBuffer *m_value;
150};
151
152template<>
153struct wxArgNormalizer<char*> : public wxArgNormalizer<const char*>
154{
155 wxArgNormalizer(char *value)
156 : wxArgNormalizer<const char*>(value) {}
157};
158
159#elif wxUSE_WCHAR_T // !wxUSE_UNICODE_WCHAR && wxUSE_WCHAR_T
160
161template<>
162struct WXDLLIMPEXP_BASE wxArgNormalizer<const wchar_t*>
163{
164 wxArgNormalizer(const wchar_t *value);
165 ~wxArgNormalizer();
166 const char *get() const;
167
168 wxCharBuffer *m_value;
169};
170
171template<>
172struct wxArgNormalizer<wchar_t*> : public wxArgNormalizer<const wchar_t*>
173{
174 wxArgNormalizer(wchar_t *value)
175 : wxArgNormalizer<const wchar_t*>(value) {}
176};
177
178#endif // wxUSE_UNICODE_WCHAR / !wxUSE_UNICODE_WCHAR && wxUSE_WCHAR_T
179
180// NB: The vararg emulation code is limited to 30 arguments at the moment.
181// If you need more, you need to
182// 1) increase the value of _WX_VARARG_MAX_ARGS
183// 2) add _WX_VARARG_JOIN_* and _WX_VARARG_ITER_* up to the new
184// _WX_VARARG_MAX_ARGS value to the lists below
185#define _WX_VARARG_MAX_ARGS 30
186
187#define _WX_VARARG_JOIN_1(m) m(1)
188#define _WX_VARARG_JOIN_2(m) _WX_VARARG_JOIN_1(m), m(2)
189#define _WX_VARARG_JOIN_3(m) _WX_VARARG_JOIN_2(m), m(3)
190#define _WX_VARARG_JOIN_4(m) _WX_VARARG_JOIN_3(m), m(4)
191#define _WX_VARARG_JOIN_5(m) _WX_VARARG_JOIN_4(m), m(5)
192#define _WX_VARARG_JOIN_6(m) _WX_VARARG_JOIN_5(m), m(6)
193#define _WX_VARARG_JOIN_7(m) _WX_VARARG_JOIN_6(m), m(7)
194#define _WX_VARARG_JOIN_8(m) _WX_VARARG_JOIN_7(m), m(8)
195#define _WX_VARARG_JOIN_9(m) _WX_VARARG_JOIN_8(m), m(9)
196#define _WX_VARARG_JOIN_10(m) _WX_VARARG_JOIN_9(m), m(10)
197#define _WX_VARARG_JOIN_11(m) _WX_VARARG_JOIN_10(m), m(11)
198#define _WX_VARARG_JOIN_12(m) _WX_VARARG_JOIN_11(m), m(12)
199#define _WX_VARARG_JOIN_13(m) _WX_VARARG_JOIN_12(m), m(13)
200#define _WX_VARARG_JOIN_14(m) _WX_VARARG_JOIN_13(m), m(14)
201#define _WX_VARARG_JOIN_15(m) _WX_VARARG_JOIN_14(m), m(15)
202#define _WX_VARARG_JOIN_16(m) _WX_VARARG_JOIN_15(m), m(16)
203#define _WX_VARARG_JOIN_17(m) _WX_VARARG_JOIN_16(m), m(17)
204#define _WX_VARARG_JOIN_18(m) _WX_VARARG_JOIN_17(m), m(18)
205#define _WX_VARARG_JOIN_19(m) _WX_VARARG_JOIN_18(m), m(19)
206#define _WX_VARARG_JOIN_20(m) _WX_VARARG_JOIN_19(m), m(20)
207#define _WX_VARARG_JOIN_21(m) _WX_VARARG_JOIN_20(m), m(21)
208#define _WX_VARARG_JOIN_22(m) _WX_VARARG_JOIN_21(m), m(22)
209#define _WX_VARARG_JOIN_23(m) _WX_VARARG_JOIN_22(m), m(23)
210#define _WX_VARARG_JOIN_24(m) _WX_VARARG_JOIN_23(m), m(24)
211#define _WX_VARARG_JOIN_25(m) _WX_VARARG_JOIN_24(m), m(25)
212#define _WX_VARARG_JOIN_26(m) _WX_VARARG_JOIN_25(m), m(26)
213#define _WX_VARARG_JOIN_27(m) _WX_VARARG_JOIN_26(m), m(27)
214#define _WX_VARARG_JOIN_28(m) _WX_VARARG_JOIN_27(m), m(28)
215#define _WX_VARARG_JOIN_29(m) _WX_VARARG_JOIN_28(m), m(29)
216#define _WX_VARARG_JOIN_30(m) _WX_VARARG_JOIN_29(m), m(30)
217
218#define _WX_VARARG_ITER_1(m,a,b,c) m(1,a,b,c)
219#define _WX_VARARG_ITER_2(m,a,b,c) _WX_VARARG_ITER_1(m,a,b,c) m(2,a,b,c)
220#define _WX_VARARG_ITER_3(m,a,b,c) _WX_VARARG_ITER_2(m,a,b,c) m(3,a,b,c)
221#define _WX_VARARG_ITER_4(m,a,b,c) _WX_VARARG_ITER_3(m,a,b,c) m(4,a,b,c)
222#define _WX_VARARG_ITER_5(m,a,b,c) _WX_VARARG_ITER_4(m,a,b,c) m(5,a,b,c)
223#define _WX_VARARG_ITER_6(m,a,b,c) _WX_VARARG_ITER_5(m,a,b,c) m(6,a,b,c)
224#define _WX_VARARG_ITER_7(m,a,b,c) _WX_VARARG_ITER_6(m,a,b,c) m(7,a,b,c)
225#define _WX_VARARG_ITER_8(m,a,b,c) _WX_VARARG_ITER_7(m,a,b,c) m(8,a,b,c)
226#define _WX_VARARG_ITER_9(m,a,b,c) _WX_VARARG_ITER_8(m,a,b,c) m(9,a,b,c)
227#define _WX_VARARG_ITER_10(m,a,b,c) _WX_VARARG_ITER_9(m,a,b,c) m(10,a,b,c)
228#define _WX_VARARG_ITER_11(m,a,b,c) _WX_VARARG_ITER_10(m,a,b,c) m(11,a,b,c)
229#define _WX_VARARG_ITER_12(m,a,b,c) _WX_VARARG_ITER_11(m,a,b,c) m(12,a,b,c)
230#define _WX_VARARG_ITER_13(m,a,b,c) _WX_VARARG_ITER_12(m,a,b,c) m(13,a,b,c)
231#define _WX_VARARG_ITER_14(m,a,b,c) _WX_VARARG_ITER_13(m,a,b,c) m(14,a,b,c)
232#define _WX_VARARG_ITER_15(m,a,b,c) _WX_VARARG_ITER_14(m,a,b,c) m(15,a,b,c)
233#define _WX_VARARG_ITER_16(m,a,b,c) _WX_VARARG_ITER_15(m,a,b,c) m(16,a,b,c)
234#define _WX_VARARG_ITER_17(m,a,b,c) _WX_VARARG_ITER_16(m,a,b,c) m(17,a,b,c)
235#define _WX_VARARG_ITER_18(m,a,b,c) _WX_VARARG_ITER_17(m,a,b,c) m(18,a,b,c)
236#define _WX_VARARG_ITER_19(m,a,b,c) _WX_VARARG_ITER_18(m,a,b,c) m(19,a,b,c)
237#define _WX_VARARG_ITER_20(m,a,b,c) _WX_VARARG_ITER_19(m,a,b,c) m(20,a,b,c)
238#define _WX_VARARG_ITER_21(m,a,b,c) _WX_VARARG_ITER_20(m,a,b,c) m(21,a,b,c)
239#define _WX_VARARG_ITER_22(m,a,b,c) _WX_VARARG_ITER_21(m,a,b,c) m(22,a,b,c)
240#define _WX_VARARG_ITER_23(m,a,b,c) _WX_VARARG_ITER_22(m,a,b,c) m(23,a,b,c)
241#define _WX_VARARG_ITER_24(m,a,b,c) _WX_VARARG_ITER_23(m,a,b,c) m(24,a,b,c)
242#define _WX_VARARG_ITER_25(m,a,b,c) _WX_VARARG_ITER_24(m,a,b,c) m(25,a,b,c)
243#define _WX_VARARG_ITER_26(m,a,b,c) _WX_VARARG_ITER_25(m,a,b,c) m(26,a,b,c)
244#define _WX_VARARG_ITER_27(m,a,b,c) _WX_VARARG_ITER_26(m,a,b,c) m(27,a,b,c)
245#define _WX_VARARG_ITER_28(m,a,b,c) _WX_VARARG_ITER_27(m,a,b,c) m(28,a,b,c)
246#define _WX_VARARG_ITER_29(m,a,b,c) _WX_VARARG_ITER_28(m,a,b,c) m(29,a,b,c)
247#define _WX_VARARG_ITER_30(m,a,b,c) _WX_VARARG_ITER_29(m,a,b,c) m(30,a,b,c)
248
249// This macro calls another macro 'm' passed as second argument 'N' times,
250// with its only argument set to 1..N, and concatenates the results using
251// comma as separator.
252//
253// An example:
254// #define foo(i) x##i
255// // this expands to "x1,x2,x3,x4"
256// _WX_VARARG_JOIN(4, foo)
257//
258//
259// N must not be greater than _WX_VARARG_MAX_ARGS (=30).
260#define _WX_VARARG_JOIN(N, m) _WX_VARARG_JOIN_IMPL(N, m)
261#define _WX_VARARG_JOIN_IMPL(N, m) _WX_VARARG_JOIN_##N(m)
262
263// This macro calls another macro 'm' passed as second argument 'N' times, with
264// its first argument set to 1..N and the remaining arguments set to 'a', 'b'
265// and 'c'. The results are separated with whitespace in the expansion.
266//
267// An example:
268// // this macro expands to:
269// // foo(1,a,b,c)
270// // foo(2,a,b,c)
271// // foo(3,a,b,c)
272// _WX_VARARG_ITER(3, foo, a, b, c)
273//
274// N must not be greater than _WX_VARARG_MAX_ARGS (=30).
275#define _WX_VARARG_ITER(N, m,a,b,c) _WX_VARARG_ITER_IMPL(N, m, a, b, c)
276#define _WX_VARARG_ITER_IMPL(N, m,a,b,c) _WX_VARARG_ITER_##N(m, a, b, c)
277
278// Generates code snippet for i-th argument in vararg function's prototype.
279#define _WX_VARARG_ARG(i) T##i a##i
280
281// Like _WX_VARARG_ARG_UNUSED, but outputs argument's type with WXUNUSED.
282#define _WX_VARARG_ARG_UNUSED(i) T##i WXUNUSED(a##i)
283
284// Generates code snippet for i-th type in vararg function's template<...>.
285#define _WX_VARARG_TEMPL(i) typename T##i
286
287// Generates code snippet for passing i-th argument of vararg function
288// wrapper to its implementation, normalizing it in the process
289#define _WX_VARARG_PASS(i) wxArgNormalizer<T##i>(a##i).get()
290
291
292// Macro to be used with _WX_VARARG_ITER in the implementation of
293// WX_DEFINE_VARARG_FUNC (see its documentation for the meaning of arguments)
294#define _WX_VARARG_DEFINE_FUNC(N, rettype, name, impl) \
295 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
296 rettype name(_WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
297 { \
298 return impl(_WX_VARARG_JOIN(N, _WX_VARARG_PASS)); \
299 }
300
301// Macro to be used with _WX_VARARG_ITER in the implementation of
302// WX_DEFINE_VARARG_FUNC_VOID (see its documentation for the meaning of
303// arguments; rettype is ignored and is used only to satisfy _WX_VARARG_ITER's
304// requirements).
305#define _WX_VARARG_DEFINE_FUNC_VOID(N, rettype, name, impl) \
306 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
307 void name(_WX_VARARG_JOIN(N, _WX_VARARG_ARG)) \
308 { \
309 impl(_WX_VARARG_JOIN(N, _WX_VARARG_PASS)); \
310 }
311
312// Macro to be used with _WX_VARARG_ITER in the implementation of
313// WX_DEFINE_VARARG_FUNC_NOP, i.e. empty stub for a disabled vararg function.
314// The rettype and impl arguments are ignored.
315#define _WX_VARARG_DEFINE_FUNC_NOP(N, rettype, name, impl) \
316 template<_WX_VARARG_JOIN(N, _WX_VARARG_TEMPL)> \
317 void name(_WX_VARARG_JOIN(N, _WX_VARARG_ARG_UNUSED)) {}
318
319
320#endif // _WX_STRVARARG_H_