ivigenerator: Autogenerate the qmltypes files for code-completion

If the generated QML code is used inside QML without using a
plugin (e.g. in our examples), QtCreator cannot provide a code-
completion for the QML types and also marks the import as an
unknown module.
To fix this we now generate a qmltypes files as part of the
frontend module. This file can be used to provide code-completion
information to QtCreator without the need to have a plugin.

Fixes: AUTOSUITE-743
Change-Id: Ic40a1aa48a0db3a3f504daede139032d52d8b782
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>

2 files changed, 141 insertions, 0 deletions

diff --git a/src/tools/ivigenerator/templates_frontend/plugins.qmltypes.tpl b/src/tools/ivigenerator/templates_frontend/plugins.qmltypes.tpl
new file mode 100644
index 0000000..7984d6b
--- /dev/null
+++ b/src/tools/ivigenerator/templates_frontend/plugins.qmltypes.tpl
@@ -0,0 +1,140 @@
+{#
+# 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 'qtivi_macros.j2' as ivi %}
+{% set module_qml_name = (module|qml_type).split('.')[-1]|upperfirst %}
+
+import QtQuick.tooling 1.2
+
+// This file describes the plugin-supplied types contained in the library.
+// It is used for QML tooling purposes only.
+//
+// This file was auto-generated with the QtIvi ivigenerator
+
+Module {
+    dependencies: ["QtIvi 1.0"]
+{% for interface in module.interfaces %}
+{% set class = '{0}'.format(interface) %}
+{% if interface.tags.config.zoned %}
+{%   set base_class = 'QIviAbstractZonedFeature' %}
+{% else %}
+{%   set base_class = 'QIviAbstractFeature' %}
+{% endif %}
+    Component {
+        name: "{{class}}"
+        prototype: "{{base_class}}"
+        exports: ["{{module|qml_type}}/{{interface|qml_type}} 1.0"]
+        exportMetaObjectRevisions: [0]
+{%   for property in interface.properties %}
+{%     if property.readonly or property.const or property.type.is_model %}
+{%       set readonly = 'true' %}
+{%     else %}
+{%       set readonly = 'false' %}
+{%     endif %}
+        Property { name: "{{property}}"; type: "{{property|qml_info_type}}"; isReadonly: {{readonly}} {% if property.type.is_model %}; isPointer: true {% endif %} }
+{%   endfor %}
+{%   for property in interface.properties %}
+        Signal {
+            name: "{{property}}Changed"
+            Parameter { name: "{{property}}"; type: "{{property|qml_info_type}}" }
+        }
+{%   endfor %}
+{%   for signal in interface.signals %}
+        Signal {
+            name: "{{signal}}"
+{%     for parameter in signal.parameters %}
+            Parameter { name: "{{parameter}}"; type: "{{parameter|qml_info_type}}" }
+{%     endfor %}
+        }
+{%   endfor %}
+{%   for operation in interface.operations %}
+        Method {
+            name: "{{operation}}"
+{# TODO: Once QtCreator can also provide the completion for return types we need to reevaluate this #}
+            type: "QIviPendingReply<{{operation|return_type}}>"
+{%     for parameter in operation.parameters %}
+            Parameter { name: "{{parameter}}"; type: "{{parameter|qml_info_type}}" }
+{%     endfor %}
+        }
+{%   endfor %}
+{%   for property in interface.properties %}
+{%     if not (property.readonly or property.const or property.type.is_model) %}
+        Method {
+            name: "{{property|setter_name}}"
+            Parameter { name: "{{property}}"; type: "{{property|qml_info_type}}" }
+        }
+{%     endif %}
+{%   endfor %}
+    }
+{% endfor %}
+
+    Component {
+        name: "{{module.module_name|upperfirst}}Module"
+        prototype: "QObject"
+        exports: ["{{module|qml_type}}/{{module_qml_name}} 1.0"]
+        isCreatable: false
+        isSingleton: true
+        exportMetaObjectRevisions: [0]
+{% for enum in module.enums %}
+        Enum {
+            name: "{{enum|flag_type}}"
+            values: {
+{%   for member in enum.members %}
+                "{{member.name}}": {{member.value}}{% if not loop.last %},{% endif %}
+
+{%   endfor %}
+            }
+        }
+{% endfor %}
+{% for struct in module.structs %}
+        Method {
+            name: "{{struct|lowerfirst}}"
+            type: "{{struct}}"
+{%   for fields in struct.fields %}
+            Parameter { name: "{{fields}}"; type: "{{fields|qml_info_type}}" }
+{%   endfor %}
+        }
+{% endfor %}
+{% for struct in module.structs %}
+        Method {
+            name: "{{struct|lowerfirst}}"
+            type: "{{struct}}"
+        }
+{% endfor %}
+    }
+}
diff --git a/src/tools/ivigenerator/templates_frontend/qmldir.tpl b/src/tools/ivigenerator/templates_frontend/qmldir.tpl
new file mode 100644
index 0000000..4ed2cd6
--- /dev/null
+++ b/src/tools/ivigenerator/templates_frontend/qmldir.tpl
@@ -0,0 +1 @@
+typeinfo plugins.qmltypes