aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/ivigenerator/templates/server_qtro_simulator/adapter.cpp.tpl
blob: e5e1d6b659d1706b0f115a09f564d7e081b791db (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
{#
# Copyright (C) 2019 Luxoft Sweden AB
# 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
#}
{% import 'common/qtivi_macros.j2' as ivi %}
{% include "common/generated_comment.cpp.tpl" %}
{% set class = '{0}QtRoAdapter'.format(interface) %}
{% set interface_zoned = interface.tags.config and interface.tags.config.zoned %}
#include "{{interface|lower}}adapter.h"

#include <QIviPagingModelAddressWrapper>

Q_LOGGING_CATEGORY(qLcRO{{interface}}, "{{module|qml_type|lower}}.{{interface|lower}}backend.remoteobjects", QtInfoMsg)

/*
* A simple QtRO Adapter which is derived from the repc generated *Source class
* Every setter/getter and signal is simply forwarded to the original backend
* Every operation is adapted to use the special PendingResult class as a return value
* to inform the client that the return value is not yet ready. Once the QIviPendingReply is ready
* the value is send with the pendingResultAvailable value
*/

{{class}}::{{class}}({{interface}}Backend *parent)
    : {{class}}(QStringLiteral("{{interface.qualified_name}}"), parent)
{
}

{{class}}::{{class}}(const QString &remoteObjectsLookupName, {{interface}}Backend *parent)
    : {{interface}}Source(parent)
    , m_remoteObjectsLookupName(remoteObjectsLookupName)
    , m_backend(parent)
    , m_helper(this, qLcRO{{interface}}())
{
{% for property in interface.properties %}
{%   if not property.type.is_model %}
    connect(m_backend, &{{interface}}Backend::{{property.name}}Changed, this, &{{class}}::{{property.name}}Changed);
{%   endif %}
{% endfor %}
{% for signal in interface.signals %}
    connect(m_backend, &{{interface}}Backend::{{signal}}, this, &{{class}}::{{signal}});
{% endfor %}
}

QString {{class}}::remoteObjectsLookupName() const
{
    return m_remoteObjectsLookupName;
}

void {{class}}::enableRemoting(QRemoteObjectHostBase *node)
{
    node->enableRemoting<{{interface}}AddressWrapper>(this);
{% set vars = { 'models': False } %}
{% for property in interface.properties %}
{%   if property.type.is_model %}
{%     if vars.update({ 'models': True}) %}{% endif %}
    auto {{property|lowerfirst}}Adapter = new QIviPagingModelQtRoAdapter(QStringLiteral("{{interface.qualified_name}}.{{property}}"), m_backend->{{property|getter_name}}());
    node->enableRemoting<QIviPagingModelAddressWrapper>({{property|lowerfirst}}Adapter);
    m_modelAdapters.insert(node, {{property|lowerfirst}}Adapter);
{%   endif %}
{% endfor %}
{% if vars.models and interface_zoned %}
    // When this is called the backend should already been initialized
    const QStringList zones = m_backend->availableZones();
    for (const QString &zone : zones) {
{%   for property in interface.properties %}
{%     if property.type.is_model %}
        auto {{property|lowerfirst}}Adapter = new QIviPagingModelQtRoAdapter(QStringLiteral("{{interface.qualified_name}}.{{property}}.") + zone, m_backend->zoneAt(zone)->{{property|getter_name}}());
        node->enableRemoting<QIviPagingModelAddressWrapper>({{property|lowerfirst}}Adapter);
        m_modelAdapters.insert(node, {{property|lowerfirst}}Adapter);
{%     endif %}
{%   endfor %}
    }
{% endif %}
}

void {{class}}::disableRemoting(QRemoteObjectHostBase *node)
{
    node->disableRemoting(this);
    const auto adapterList = m_modelAdapters.values(node);
    for (QIviPagingModelQtRoAdapter *adapter : adapterList) {
        node->disableRemoting(adapter);
        delete adapter;
    }
    m_modelAdapters.remove(node);
}

{% if interface_zoned %}
QStringList {{class}}::availableZones()
{
    return m_backend->availableZones();
}
{% endif %}

{% for property in interface.properties %}
{%   if not property.type.is_model %}
{%     if interface_zoned %}
{{property|return_type}} {{class}}::{{property|getter_name}}(const QString &zone)
{
{%       if property.type.is_var %}
    return m_helper.toRemoteObjectVariant(m_backend->{{property|getter_name}}(zone));
{%       else %}
    return m_backend->{{property|getter_name}}(zone);
{%       endif %}
}
{%     else %}
{{property|return_type}} {{class}}::{{property}}() const
{
{%       if property.type.is_var %}
    return m_helper.toRemoteObjectVariant(m_backend->{{property|getter_name}}());
{%       else %}
    return m_backend->{{property|getter_name}}();
{%       endif %}
}
{%     endif %}
{%   endif %}
{% endfor %}

{% for property in interface.properties %}
{%   if not property.readonly and not property.const and not property.type.is_model %}
{%     if interface_zoned %}
{{ivi.prop_setter(property, class, zoned = true)}}
{%     else %}
{%       set type = property|return_type %}
{#       //repc doesn't generate proper const ref setters #}
void {{class}}::{{property|setter_name}}({{type}} {{property}})
{%     endif %}
{
{%     set parameters = property.name %}
{%     if interface_zoned %}
{%       set parameters = parameters + ', zone' %}
{%     endif%}
    m_backend->{{property|setter_name}}({{parameters}});
}

{%   endif %}
{% endfor %}

{% for operation in interface.operations %}
QVariant {{class}}::{{operation}}({{ivi.join_params(operation, zoned = interface_zoned)}})
{
{%   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%}
    QIviPendingReplyBase pendingReply = m_backend->{{operation}}({{function_parameters}});
    qCDebug(qLcRO{{interface}}) << Q_FUNC_INFO;
    return m_helper.fromPendingReply(pendingReply);
}
{% endfor %}