summaryrefslogtreecommitdiff
path: root/src/tools/ivigenerator/templates_backend_simulator/backend.cpp.tpl
blob: 090dd4669f372f742abf122f0be97da041fef3dd (plain)
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
{#
# Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
# 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:LGPL-QTAS$
# Commercial License Usage
# Licensees holding valid commercial Qt Automotive Suite 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 Lesser General Public License Usage
# Alternatively, this file may be used under the terms of the GNU Lesser
# General Public License version 3 as published by the Free Software
# Foundation and appearing in the file LICENSE.LGPL3 included in the
# packaging of this file. Please review the following information to
# ensure the GNU Lesser General Public License version 3 requirements
# will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 2.0 or (at your option) the GNU General
# Public license version 3 or any later version approved by the KDE Free
# Qt Foundation. The licenses are as published by the Free Software
# Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
# 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-2.0.html and
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# $QT_END_LICENSE$
#
# SPDX-License-Identifier: LGPL-3.0
#}
{% include "generated_comment.cpp.tpl" %}
{% import 'utils.tpl' as utils %}
{% set class = '{0}Backend'.format(interface) %}
{% set interface_zoned = interface.tags.config and interface.tags.config.zoned %}
#include "{{class|lower}}.h"

{% for property in interface.properties %}
{% if property.type.is_model %}
#include "{{property|model_type|lower}}.h"
{% endif %}
{% endfor %}

#include <QDebug>

{% if 'simulator' in features %}
#include <QtSimulator>
{% endif %}

QT_BEGIN_NAMESPACE

/*!
   \class {{class}}
   \inmodule {{module}}
{{ utils.format_comments(interface.comment) }}
*/
{{class}}::{{class}}(QObject *parent)
    : {{class}}Interface(parent)
{% for property in interface.properties %}
{%   if not property.tags.config_simulator or not property.tags.config_simulator.zoned %}
    , m_{{ property }}({{property|default_value}})
{%   endif %}
{% endfor %}
{% if 'simulator' in features %}
    , mWorker(nullptr)
{% endif %}
{

    {{module.module_name|upperfirst}}Module::registerTypes();
{% set zones = interface.tags.config_simulator.zones if interface.tags.config_simulator else {} %}
{% for zone_name, zone_id in zones.items() %}
    ZoneBackend {{zone_name}}Zone;
{%   for property in interface.properties %}
{%     if property.tags.config_simulator and property.tags.config_simulator.zoned %}
    {{zone_name}}Zone.{{property}} = {{property|default_value(zone_name)}};
{%     endif %}
{%   endfor %}
    m_zoneMap.insert("{{zone_id}}", {{zone_name}}Zone);
{% endfor %}
}

{{class}}::~{{class}}()
{
}

{% if interface_zoned %}
/*!
    \fn QStringList {{class}}::availableZones() const

    Returns a list of supported zone names. This is called from the client
    after having connected.

    The returned names must be valid QML property names, i.e. \c {[a-z_][A-Za-z0-9_]*}.

    \sa {Providing Available Zones}
*/
QStringList {{class}}::availableZones() const
{
{%   if interface.tags.config_simulator and interface.tags.config_simulator.zoned %}
    return m_zoneMap.keys();
{%   else %}
    return QStringList();
{%   endif%}
}
{% endif %}

/*!
    \fn void {{class}}::initialize()

    Initializes the backend and informs about its current state by
    emitting signals with the current status (property values).

*/
void {{class}}::initialize()
{
{% for property in interface.properties %}
{%   if not interface_zoned  %}
    emit {{property}}Changed(m_{{property}});
{%   elif not property.tags.config_simulator or not property.tags.config_simulator.zoned%}
    emit {{property}}Changed(m_{{property}}, QString());
{%   endif %}
{% endfor %}

{% if interface.tags.config.zoned %}
    const auto zones = availableZones();
    for (const QString &zone : zones) {
{%   for property in interface.properties %}
{%     if property.tags.config_simulator and property.tags.config_simulator.zoned %}
        emit {{property}}Changed(m_zoneMap[zone].{{property}}, zone);
{%     endif %}
{%   endfor %}
    }
{% endif %}

{% if 'simulator' in features %}
    mConnection = new QSimulatorConnection("{{interface}}", QVersionNumber(1, 0, 0));
    mConnection->addPeerInfo("versionInfo", "1.0.0");
    mConnection->addPeerInfo("name", "{{class}}");
    QString hostname = QSimulatorConnection::simulatorHostName(false);
    if (hostname.isEmpty()) {
        qWarning() << "SIMULATOR_HOSTNAME environment variable not set! Disabling the QtSimulator connection";
        return;
    }
    qWarning() << "Connecting to QtSimulator Device:" << hostname;
    mWorker = mConnection->connectToHost(hostname, 0xbeef+3);
    if (!mWorker) {
        qWarning() << "Couldn't connect to QtSimulator Device:" << hostname;
        return;
    }

    mWorker->addReceiver(this);
{% endif %}
    emit initializationDone();
}

{% for property in interface.properties %}
{%   if not property.readonly and not property.const %}
/*!
    \fn virtual void {{class}}::set{{property|upperfirst}}({{ property|parameter_type }}{% if interface_zoned %}, const QString &zone){%endif%})

{{ utils.format_comments(property.comment) }}
*/
{%   if interface_zoned %}
void {{class}}::set{{property|upperfirst}}({{ property|parameter_type }}, const QString &zone)
{%   else %}
void {{class}}::set{{property|upperfirst}}({{ property|parameter_type }})
{%   endif %}
{
{%   if property.tags.config_simulator and property.tags.config_simulator.unsupported %}
    Q_UNUSED({{ property }});
{%     if interface_zoned %}
    Q_UNUSED(zone);
{%     endif %}
    qWarning() << "SIMULATION Setting {{ property | upperfirst }} is not supported!";

{%   else %}
{%     set zoned = property.tags.config_simulator and property.tags.config_simulator.zoned %}
{%     if zoned and interface_zoned %}
    if (!m_zoneMap.contains(zone))
        return;

    if (m_zoneMap[zone].{{property}} == {{property}})
        return;
{% include "backend_range.cpp.tpl" %}
    qWarning() << "SIMULATION {{ property | upperfirst }} for Zone" << zone << "changed to" << {{property}};

    m_zoneMap[zone].{{property}} = {{property}};
    emit {{ property }}Changed({{property}}, zone);

{%       if 'simulator' in features %}
    if (mWorker)
        mWorker->call("{{property|setter_name}}", {{property}}, zone);
{%       endif %}
{%     else %}
    if ({% if interface_zoned %}!zone.isEmpty() || {%endif%}m_{{ property }} == {{property}})
        return;
{% include "backend_range.cpp.tpl" %}
    qWarning() << "SIMULATION {{ property | upperfirst }} changed to" << {{property}};

    m_{{property}} = {{property}};
    emit {{property}}Changed(m_{{property}}{% if interface_zoned%}, QString(){% endif %});
{%       if 'simulator' in features %}
    if (mWorker)
        mWorker->call("{{property|setter_name}}", {{property}}{% if interface_zoned%}, QString(){% endif %});
{%       endif %}
{%     endif %}
{%   endif %}
}

{% endif %}
{% endfor %}

{% for operation in interface.operations %}
{%   set operation_parameters = operation.parameters|map('parameter_type')|join(', ') %}
{%   if interface_zoned %}
{%     if operation.parameters|length %}
{%       set operation_parameters = operation_parameters + ', ' %}
{%     endif %}
{%     set operation_parameters = operation_parameters + 'const QString &zone' %}
{%   endif%}
/*!
    \fn virtual void {{class}}::{{operation}}({{operation_parameters}})

{{ utils.format_comments(operation.comment) }}
*/
{{operation|return_type}} {{class}}::{{operation}}({{operation_parameters}}){%if operation.const %} const{% endif %}

{
{% for operation_parameter in operation.parameters %}
    Q_UNUSED({{operation_parameter.name}});
{% endfor %}
{% if interface_zoned %}
    Q_UNUSED(zone);
{% endif %}
{%   set function_parameters = operation.parameters|join(', ') %}
{%   if interface_zoned %}
{%     if operation.parameters|length %}
{%       set function_parameters = function_parameters + ', ' %}
{%     endif %}
{%     set function_parameters = function_parameters + 'zone' %}
{%   endif%}

{% if 'simulator' in features %}
    if (mWorker)
        mWorker->call("{{operation}}" {% if function_parameters is not equalto "" %}, {{function_parameters}} {% endif %});
{% endif %}

    qWarning() << "Not implemented!";
    return {{operation|default_value}};
}

{% endfor %}

QT_END_NAMESPACE