summaryrefslogtreecommitdiffstats
path: root/src/interfaceframework/qifserviceinterface.h
blob: a6c39789a3acd94e636089dbaa0db51f803cdc8c (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
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QIFSERVICEINTERFACE_H
#define QIFSERVICEINTERFACE_H

#include <QtInterfaceFramework/qiffeatureinterface.h>
#include <QtInterfaceFramework/qtifglobal.h>

#include <QtCore/QtPlugin>

QT_BEGIN_NAMESPACE

template <class T> T qif_interface_cast(QObject *backend)
{
    T inst = qobject_cast<T>(backend);
    static bool showOnce = true;
    if (!inst && showOnce) {
        typedef typename std::remove_cv<typename std::remove_pointer<T>::type>::type ObjType;
        qCritical("Casting the backend to the interface %s failed.\n"
                  "Either the backend pointer is not of the correct type or casting failed because "
                  "debug and release libraries were mixed.", ObjType::staticMetaObject.className());
        showOnce = false;
    }
    return inst;
}

class Q_QTINTERFACEFRAMEWORK_EXPORT QIfServiceInterface
{
public:
    virtual ~QIfServiceInterface();

    virtual QString id() const;
    virtual QStringList interfaces() const = 0;
    virtual QIfFeatureInterface *interfaceInstance(const QString &interfaceName) const = 0;

    virtual QString configurationId() const;
    virtual void updateServiceSettings(const QVariantMap &settings);

    template <class T> T interfaceInstance(const QString &interfaceName) const {
        T inst = qif_interface_cast<T>(interfaceInstance(interfaceName));
        return inst;
    }
};

#define QIfServiceInterface_iid "org.qt-project.interfaceframework.QIfServiceInterface/1.0"
Q_DECLARE_INTERFACE(QIfServiceInterface, QIfServiceInterface_iid)

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QIfServiceInterface*)

#endif // QIFSERVICEINTERFACE_H