{#
# 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: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
#}
{% set class = '{0}Module'.format(module.module_name|upperfirst) %}
{% set qml_name = (module|qml_type).split('.')[-1]|upperfirst %}
{% include 'common/generated_comment.cpp.tpl' %}
{% import 'common/qtivi_macros.j2' as ivi %}

#include "{{class|lower}}.h"
#include "{{class|lower}}factory.h"
{% for interface in module.interfaces %}
#include "{{interface|lower}}.h"
{% endfor %}
#include <QtIviCore/QIviPendingReply>
#include <QQmlEngine>
#include <QDebug>
#include <QDataStream>

QT_BEGIN_NAMESPACE

/*! \internal */
QObject* {{class|lower}}_singletontype_provider(QQmlEngine*, QJSEngine*)
{
    return new {{class}}Factory();
}

/*!
    \class {{class}}
    \inmodule {{module}}

    \brief The {{class}} class holds all the enums defined in the {{module}} module.
*/
{% for enum in module.enums %}
/*!
    \enum {{class}}::{{enum}}
    {{ ivi.format_comments(enum.comment) }}

{%  for member in enum.members %}
    \value {{member}}
    {{ ivi.format_comments(member.comment) }}
{%  endfor %}
*/
{% endfor %}
{{class}}::{{class}}(QObject *parent)
    : QObject(parent)
{
}

{% for enum in module.enums %}
/*! \internal */
{%   if enum.is_flag %}
{{class}}::{{enum|flag_type}} {{class}}::to{{enum|flag_type}}(quint32 v, bool *ok)
{
    if (ok)
        *ok = true;

    return {{class}}::{{enum|flag_type}}(v);
}
{%   else %}
{{class}}::{{enum}} {{class}}::to{{enum}}(quint32 v, bool *ok)
{
    if (ok)
        *ok = true;
    switch (v) {
{% for member in enum.members %}
    case {{member.value}}: return {{member.name}};
{% endfor %}
    default:
        if (ok)
            *ok = false;
        return {{enum.members|first}};
    }
}
{%   endif %}

{% endfor %}
/*! \internal */
void {{class}}::registerTypes()
{
    static bool once = false;
    if (once)
        return;
    once = true;

{% for import in module.imports %}
{# All imports are provided including their imported version e.g. "Common 1.0". Because we need
   to access the Module type, we first need to split the version and then search for the name.
   See https://github.com/Pelagicore/qface/issues/87
#}
{%   set name = import.split(' ')[0] %}
{%   for mod in system.modules %}
{%     if mod.name == name %}
    {{mod.module_name|upperfirst}}Module::registerTypes();
{%     endif %}
{%   endfor %}
{% endfor %}

{% for enum in module.enums %}
    qRegisterMetaType<{{class}}::{{enum|flag_type}}>();
    qIviRegisterPendingReplyType<{{class}}::{{enum|flag_type}}>();
{%   if enum.is_flag %}
    //Workaround for https://bugreports.qt.io/browse/QTBUG-75676
    if (!QMetaType::hasRegisteredConverterFunction<{{class}}::{{enum|flag_type}}, int>())
        QMetaType::registerConverter<{{class}}::{{enum|flag_type}}, int>();
{%   endif %}
{% endfor %}
{% for struct in module.structs %}
    qRegisterMetaType<{{struct}}>();
    qIviRegisterPendingReplyType<{{struct}}>();
{% endfor %}
}

/*! \internal */
void {{class}}::registerQmlTypes(const QString& uri, int majorVersion, int minorVersion)
{
    qmlRegisterSingletonType<{{class}}>(uri.toLatin1(), majorVersion, minorVersion,
                                        "{{qml_name}}",
                                        {{class|lower}}_singletontype_provider);
{% for interface in module.interfaces %}
    {{interface}}::registerQmlTypes(uri, majorVersion, minorVersion);
{% endfor %}
}
{% for enum in module.enums %}

QDataStream &operator<<(QDataStream &out, {{class}}::{{enum|flag_type}} var)
{
    out << quint32(var);
    return out;
}

QDataStream &operator>>(QDataStream &in, {{class}}::{{enum|flag_type}} &var)
{
    bool ok;
    quint32 val;
    in >> val;
    var = {{class}}::to{{enum|flag_type}}(val, &ok);
    if (!ok)
        qWarning() << "Received an invalid enum value for type {{class}}::{{enum|flag_type}}, value =" << var;
    return in;
}
{% endfor %}

QT_END_NAMESPACE