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
|
{#
#############################################################################
##
## Copyright (C) 2021 The Qt Company Ltd.
## Copyright (C) 2019 Luxoft Sweden AB
## Copyright (C) 2018 Pelagicore AG
## Contact: https://www.qt.io/licensing/
##
## This file is part of the QtIvi module of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:GPL-EXCEPT$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3 as published by the Free Software
## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################
#}
{# these macros can be used to generate content for QtIvi code. The macros
# provide snippets that are commonly found in multiple templates and are not
# too template specific.
# Function macros do not generate the whole body of the function, but just
# the header line, so remember to add potential virtuals, overrides,
# semicolons etc. yourself!
#}
{# join operation parameters, with type and name, into a comma separated list,
# optionally including the zone.
#}
{% macro join_params(operation, zoned = false, default_values = false) %}
{% if default_values %}
{% set params = operation.parameters|map('parameter_type_default')|join(', ') %}
{% else %}
{% set params = operation.parameters|map('parameter_type')|join(', ') %}
{% endif %}
{% if zoned %}
{% if params|length %}
{% set params = params + ', const QString &zone' %}
{% else %}
{% set params = 'const QString &zone' %}
{% endif %}
{% endif %}
{{params}}
{%- endmacro %}
{# function header for a custom slot. pass the class parameter in order to add
# the scope:: -specifier. use zoned to add the zone-specifier
#}
{% macro operation(operation, class = '', zoned = false) %}
{% if class|count %}
{% set scope = class+'::' %}
{% else %}
{% set scope = '' %}
{% endif %}
{% if operation.const %}
{% set const = ' const' %}
{% else%}
{% set const = '' %}
{% endif %}
QIviPendingReply<{{operation|return_type}}> {{scope}}{{operation}}({{join_params(operation, zoned)}}){{const}}
{%- endmacro %}
{# property declaration, Q_PROPERTY(...) #}
{% macro property(property, notify = true) %}
{% if property.readonly or property.const or property.type.is_model %}
{% set write = '' %}
{% else %}
{% set write = ' WRITE ' + property|setter_name %}
{% endif %}
{% if notify %}
{% set _notify = ' NOTIFY ' + property.name + 'Changed' %}
{% else %}
{% set _notify = ''%}
{% endif %}
Q_PROPERTY({{property|return_type}} {{property}} READ {{property|getter_name}}{{write}}{{_notify}})
{%- endmacro %}
{# function header for a property setter: setProperty(...)
# pass the class parameter in order to add the scope:: -specifier.
# use zoned to add the zone-specifier
#}
{% macro prop_setter(property, class = '', zoned = false, model_interface = false, default_zone = false) %}
{% if class|count %}
{% set scope = class+'::' %}
{% else %}
{% set scope = '' %}
{% endif %}
{% if zoned %}
{% if default_zone %}
{% set zone = ', const QString &zone = QString()' %}
{% else %}
{% set zone = ', const QString &zone' %}
{% endif %}
{% else %}
{% set zone = '' %}
{% endif %}
{% if property.type.is_model and model_interface %}
{% set type = 'QIviPagingModelInterface *'+property.name %}
{% else %}
{% set type = property|parameter_type %}
{% endif %}
void {{scope}}{{property|setter_name}}({{type}}{{zone}})
{%- endmacro %}
{# function header for a property getter.
# pass the class parameter in order to add the scope:: -specifier.
#}
{% macro prop_getter(property, class = '', model_interface = false) %}
{% if class|count %}
{% set scope = class+'::' %}
{% else %}
{% set scope = '' %}
{% endif %}
{% if property.type.is_model and model_interface %}
{% set type = 'QIviPagingModelInterface *' %}
{% else %}
{% set type = property|return_type %}
{% endif %}
{{type}} {{scope}}{{property|getter_name}}() const
{%- endmacro %}
{# helper macro for defining a property notifier and a corresponding callback.
# This is an internal function and not intended to be used inside a template.
#}
{% macro _prop_notify(property, class, zoned, prefix, model_interface, default_values = false) %}
{% if prefix|count %}
{% set prop = prefix + property|upperfirst %}
{% else %}
{% set prop = property %}
{% endif %}
{% if class|count %}
{% set scope = class+'::' %}
{% else %}
{% set scope = '' %}
{% endif %}
{% if zoned %}
{% if default_values %}
{% set zone = ', const QString &zone=QString()' %}
{% else %}
{% set zone = ', const QString &zone' %}
{% endif %}
{% else %}
{% set zone = '' %}
{% endif %}
{% if property.type.is_model and model_interface %}
{% set type = 'QIviPagingModelInterface *'+property.name %}
{% set default_value = type + '=nullptr'%}
{% else %}
{% set type = property|parameter_type %}
{% set default_value = property|parameter_type_default %}
{% endif %}
{% if default_values %}
{% set type = default_value %}
{% endif %}
void {{scope}}{{prop}}Changed({{type}}{{zone}})
{%- endmacro %}
{# signal declaration for property notifier.
# pass the class parameter in order to add the scope:: -specifier.
# use zoned to add the zone-specifier
#}
{% macro prop_notify(property, class = '', zoned = false, model_interface = false, default_values = false) %}
{{_prop_notify(property, class, zoned, '', model_interface, default_values)}}
{%- endmacro %}
{# callback slot declaration for property notifier.
# pass the class parameter in order to add the scope:: -specifier.
# use zoned to add the zone-specifier
#}
{% macro on_prop_changed(property, class = '', zoned = false, model_interface = false) %}
{{_prop_notify(property, class, zoned, 'on', model_interface)}}
{%- endmacro %}
{# helper macro for defining a signal and a corresponding callback.
# This is an internal function and not intended to be used inside a template.
#}
{% macro _signal(signal, class, zoned, prefix, default_values = false) %}
{% if prefix|count %}
{% set sig = prefix + signal|upperfirst %}
{% else %}
{% set sig = signal %}
{% endif %}
{% if class|count %}
{% set scope = class+'::' %}
{% else %}
{% set scope = '' %}
{% endif %}
void {{scope}}{{sig}}({{join_params(signal, zoned, default_values)}})
{%- endmacro %}
{# custom signal declaration
# pass the class parameter in order to add the scope:: -specifier.
# use zoned to add the zone-specifier
#}
{% macro signal(signal, class = '', zoned = false) %}
{{_signal(signal, class, zoned, '')}}
{%- endmacro %}
{# custom signal callback declaration
# pass the class parameter in order to add the scope:: -specifier.
# use zoned to add the zone-specifier
#}
{% macro on_signal(signal, class = '', zoned = false) %}
{{_signal(signal, class, zoned, 'on')}}
{%- endmacro %}
{% macro format_comments(comments) -%}
{{comments|comment_text|join('\n ')}}
{% endmacro -%}
|
