/
lqtutils_prop.h
414 lines (341 loc) · 18.6 KB
/
lqtutils_prop.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/**
* MIT License
*
* Copyright (c) 2020 Luca Carlon
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
**/
#ifndef LQTUTILS_PROP_H
#define LQTUTILS_PROP_H
#include <QObject>
// Define LQTUTILS_OMIT_ARG_FROM_SIGNAL to omit the argument from the change notification
// signals.
#ifdef LQTUTILS_OMIT_ARG_FROM_SIGNAL
#define LQTUTILS_EMIT_SIGNAL(name)
#define LQTUTILS_DECLARE_SIGNAL(type, name)
#else
#define LQTUTILS_EMIT_SIGNAL(name) name
#define LQTUTILS_DECLARE_SIGNAL(type, name) type name
#endif
// The EXPAND macro here is only needed for MSVC:
// https://stackoverflow.com/questions/5134523/msvc-doesnt-expand-va-args-correctly
#define EXPAND( x ) x
#define L_PROP_GET_MACRO(_1, _2, _3, _4, NAME,...) NAME
// QObject
// =======
#define L_RW_PROP(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP4, L_RW_PROP3, L_RW_PROP2)(__VA_ARGS__) )
#define L_RW_PROP_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP4_AS, L_RW_PROP3_AS, L_RW_PROP2_AS, L_RW_PROP1_AS)(__VA_ARGS__) )
#define L_RW_PROP_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP4_CS, L_RW_PROP3_CS, L_RW_PROP2_CS)(__VA_ARGS__) )
#define L_RO_PROP(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP4, L_RO_PROP3, L_RO_PROP2)(__VA_ARGS__) )
#define L_RO_PROP_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP4_AS, L_RO_PROP3_AS, L_RO_PROP2_AS, L_RO_PROP1_AS)(__VA_ARGS__) )
#define L_RO_PROP_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP4_CS, L_RO_PROP3_CS, L_RO_PROP2_CS)(__VA_ARGS__) )
// References
#define L_RW_PROP_REF(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP_REF4, L_RW_PROP_REF3, L_RW_PROP_REF2)(__VA_ARGS__) )
#define L_RW_PROP_REF_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP_REF4_AS, L_RW_PROP_REF3_AS, L_RW_PROP_REF2_AS, L_RW_PROP_REF1_AS)(__VA_ARGS__) )
#define L_RW_PROP_REF_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_PROP_REF4_CS, L_RW_PROP_REF3_CS, L_RW_PROP_REF2_CS)(__VA_ARGS__) )
#define L_RO_PROP_REF(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP_REF4, L_RO_PROP_REF3, L_RO_PROP_REF2)(__VA_ARGS__) )
#define L_RO_PROP_REF_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP_REF4_AS, L_RO_PROP_REF3_AS, L_RO_PROP_REF2_AS, L_RO_PROP_REF1_AS)(__VA_ARGS__) )
#define L_RO_PROP_REF_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_PROP_REF4_CS, L_RO_PROP_REF3_CS, L_RO_PROP_REF2_CS)(__VA_ARGS__) )
// A read-write prop both in C++ and in QML
// ========================================
#define _INT_DECL_L_RW_PROP(type, name, setter) \
public: \
type name() const { return m_##name ; } \
Q_SIGNALS: \
void name##Changed(LQTUTILS_DECLARE_SIGNAL(type, name)); \
private: \
Q_PROPERTY(type name READ name WRITE setter NOTIFY name##Changed)
#define L_RW_PROP_(type, name, setter) \
_INT_DECL_L_RW_PROP(type, name, setter) \
public Q_SLOTS: \
void setter(type name) { \
if (m_##name == name) return; \
m_##name = name; \
emit name##Changed(LQTUTILS_EMIT_SIGNAL(name)); \
} \
private:
#define L_RW_PROP4(type, name, setter, def) \
L_RW_PROP_(type, name, setter) \
type m_##name = def;
#define L_RW_PROP3(type, name, setter) \
L_RW_PROP_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RW_PROP_AS_(type, name) L_RW_PROP_(type, name, set_##name)
#define L_RW_PROP3_AS(type, name, def) \
L_RW_PROP_AS_(type, name) \
type m_##name = def;
#define L_RW_PROP2_AS(type, name) \
L_RW_PROP_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RW_PROP_CS_(type, name) \
_INT_DECL_L_RW_PROP(type, name, set_##name)
#define L_RW_PROP3_CS(type, name, def) \
L_RW_PROP_CS_(type, name) \
type m_##name = def;
#define L_RW_PROP2_CS(type, name) \
L_RW_PROP_CS_(type, name) \
type m_##name;
// A read-write prop from C++, but read-only from QML
// ==================================================
#define _INT_DECL_L_RO_PROP(type, name, setter) \
public: \
type name() const { return m_##name ; } \
Q_SIGNALS: \
void name##Changed(LQTUTILS_DECLARE_SIGNAL(type, name)); \
private: \
Q_PROPERTY(type name READ name NOTIFY name##Changed) \
#define L_RO_PROP_(type, name, setter) \
_INT_DECL_L_RO_PROP(type, name, set_##name) \
public: \
void setter(type name) { \
if (m_##name == name) return; \
m_##name = name; \
emit name##Changed(LQTUTILS_EMIT_SIGNAL(name)); \
} \
private:
#define L_RO_PROP4(type, name, setter, def) \
L_RO_PROP_(type, name, setter) \
type m_##name = def;
#define L_RO_PROP3(type, name, setter) \
L_RO_PROP_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RO_PROP_AS_(type, name) L_RO_PROP_(type, name, set_##name)
#define L_RO_PROP3_AS(type, name, def) \
L_RO_PROP_AS_(type, name) \
type m_##name = def;
#define L_RO_PROP2_AS(type, name) \
L_RO_PROP_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RO_PROP_CS_(type, name) \
_INT_DECL_L_RO_PROP(type, name, set_##name)
#define L_RO_PROP3_CS(type, name, def) \
L_RO_PROP_CS_(type, name) \
type m_##name = def;
#define L_RO_PROP2_CS(type, name) \
L_RO_PROP_CS_(type, name) \
type m_##name;
// For references
// ==============
// A read-write prop both in C++ and in QML
// ========================================
#define _INT_DECL_L_RW_PROP_REF(type, name, setter) \
public: \
type& name() { return m_##name ; } \
Q_SIGNALS: \
void name##Changed(LQTUTILS_DECLARE_SIGNAL(type, name)); \
private: \
Q_PROPERTY(type name READ name WRITE setter NOTIFY name##Changed)
#define L_RW_PROP_REF_(type, name, setter) \
_INT_DECL_L_RW_PROP_REF(type, name, setter) \
public Q_SLOTS: \
void setter(type name) { \
if (m_##name == name) return; \
m_##name = name; \
emit name##Changed(LQTUTILS_EMIT_SIGNAL(name)); \
} \
private:
#define L_RW_PROP_REF4(type, name, setter, def) \
L_RW_PROP_REF_(type, name, setter) \
type m_##name = def;
#define L_RW_PROP_REF3(type, name, setter) \
L_RW_PROP_REF_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RW_PROP_REF_AS_(type, name) L_RW_PROP_REF_(type, name, set_##name)
#define L_RW_PROP_REF3_AS(type, name, def) \
L_RW_PROP_REF_AS_(type, name) \
type m_##name = def;
#define L_RW_PROP_REF2_AS(type, name) \
L_RW_PROP_REF_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RW_PROP_REF_CS_(type, name) \
_INT_DECL_L_RW_PROP_REF(type, name, set_##name)
#define L_RW_PROP_REF3_CS(type, name, def) \
L_RW_PROP_REF_CS_(type, name) \
type m_##name = def;
#define L_RW_PROP_REF2_CS(type, name) \
L_RW_PROP_REF_CS_(type, name) \
type m_##name;
// A read-write prop from C++, but read-only from QML
// ==================================================
#define _INT_DECL_L_RO_PROP_REF(type, name, setter) \
public: \
type& name() { return m_##name ; } \
Q_SIGNALS: \
void name##Changed(LQTUTILS_DECLARE_SIGNAL(type, name)); \
private: \
Q_PROPERTY(type name READ name NOTIFY name##Changed)
#define L_RO_PROP_REF_(type, name, setter) \
_INT_DECL_L_RO_PROP_REF(type, name, setter) \
public Q_SLOTS: \
void setter(type name) { \
if (m_##name == name) return; \
m_##name = name; \
emit name##Changed(LQTUTILS_EMIT_SIGNAL(name)); \
} \
private:
#define L_RO_PROP_REF4(type, name, setter, def) \
L_RO_PROP_REF_(type, name, setter) \
type m_##name = def;
#define L_RO_PROP_REF3(type, name, setter) \
L_RO_PROP_REF_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RO_PROP_REF_AS_(type, name) L_RO_PROP_REF_(type, name, set_##name)
#define L_RO_PROP_REF3_AS(type, name, def) \
L_RO_PROP_REF_AS_(type, name) \
type m_##name = def;
#define L_RO_PROP_REF2_AS(type, name) \
L_RO_PROP_REF_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RO_PROP_REF_CS_(type, name) \
_INT_DECL_L_RO_PROP_REF(type, name, set_##name) \
#define L_RO_PROP_REF3_CS(type, name, def) \
L_RO_PROP_REF_CS_(type, name) \
type m_##name = def;
#define L_RO_PROP_REF2_CS(type, name) \
L_RO_PROP_REF_CS_(type, name) \
type m_##name;
// Convenience macros to speed up a QObject subclass.
#define L_BEGIN_CLASS(name) \
class name : public QObject \
{ \
Q_OBJECT \
public: \
Q_INVOKABLE name(QObject* parent = nullptr) : \
QObject(parent) {} \
private:
#define L_END_CLASS };
// Gadget
// ======
#define L_RW_GPROP(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_GPROP4, L_RW_GPROP3, L_RW_GPROP2)(__VA_ARGS__) )
#define L_RW_GPROP_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_GPROP4_AS, L_RW_GPROP3_AS, L_RW_GPROP2_AS, L_RW_GPROP1_AS)(__VA_ARGS__) )
#define L_RW_GPROP_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RW_GPROP4_CS, L_RW_GPROP3_CS, L_RW_GPROP2_CS)(__VA_ARGS__) )
#define L_RO_GPROP(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_GPROP4, L_RO_GPROP3, L_RO_GPROP2)(__VA_ARGS__) )
#define L_RO_GPROP_AS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_GPROP4_AS, L_RO_GPROP3_AS, L_RO_GPROP2_AS, L_RO_GPROP1_AS)(__VA_ARGS__) )
#define L_RO_GPROP_CS(...) \
EXPAND( L_PROP_GET_MACRO(__VA_ARGS__, L_RO_GPROP4_CS, L_RO_GPROP3_CS, L_RO_GPROP2_CS)(__VA_ARGS__) )
#define _INT_DECL_GADGET_PROP_GETTER(type, name) \
public: \
type name() const { return m_##name ; }
// A read-write prop both in C++ and in QML
// ========================================
#define L_RW_GPROP_(type, name, setter) \
_INT_DECL_GADGET_PROP_GETTER(type, name) \
private: \
Q_PROPERTY(type name READ name WRITE setter) \
public: \
void setter(type name) { \
m_##name = name; \
} \
private:
#define L_RW_GPROP4(type, name, setter, def) \
L_RW_GPROP_(type, name, setter) \
type m_##name = def;
#define L_RW_GPROP3(type, name, setter) \
L_RW_GPROP_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RW_GPROP_AS_(type, name) L_RW_GPROP_(type, name, set_##name)
#define L_RW_GPROP3_AS(type, name, def) \
L_RW_GPROP_AS_(type, name) \
type m_##name = def;
#define L_RW_GPROP2_AS(type, name) \
L_RW_GPROP_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RW_GPROP_CS_(type, name) \
_INT_DECL_GADGET_PROP_GETTER(type, name) \
private: \
Q_PROPERTY(type name READ name)
#define L_RW_GPROP3_CS(type, name, def) \
L_RW_GPROP_CS_(type, name) \
type m_##name = def;
#define L_RW_GPROP2_CS(type, name) \
L_RW_GPROP_CS_(type, name) \
type m_##name;
// A read-write prop from C++, but read-only from QML
// ==================================================
#define L_RO_GPROP_(type, name, setter) \
_INT_DECL_GADGET_PROP_GETTER(type, name) \
private: \
Q_PROPERTY(type name READ name) \
public: \
void setter(type name) { \
m_##name = name; \
} \
private:
#define L_RO_GPROP4(type, name, setter, def) \
L_RO_GPROP_(type, name, setter) \
type m_##name = def;
#define L_RO_GPROP3(type, name, setter) \
L_RO_GPROP_(type, name, setter) \
type m_##name;
// Autosetter
#define L_RO_GPROP_AS_(type, name) L_RO_GPROP_(type, name, set_##name)
#define L_RO_GPROP3_AS(type, name, def) \
L_RO_GPROP_AS_(type, name) \
type m_##name = def;
#define L_RO_GPROP2_AS(type, name) \
L_RO_GPROP_AS_(type, name) \
type m_##name;
// Custom setter
#define L_RO_GPROP_CS_(type, name) \
_INT_DECL_GADGET_PROP_GETTER(type, name) \
private: \
Q_PROPERTY(type name READ name)
#define L_RO_GPROP3_CS(type, name, def) \
L_RO_GPROP_CS_(type, name) \
type m_##name = def;
#define L_RO_GPROP2_CS(type, name) \
L_RO_GPROP_CS_(type, name) \
type m_##name;
// Convenience macros to speed up a gadget subclass.
#define L_BEGIN_GADGET(name) \
class name \
{ \
Q_GADGET \
public: \
Q_INVOKABLE name() {} \
private:
#define L_END_GADGET };
#endif // LQTUTILS_PROP_H