kservice.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <[email protected]>
   Copyright     1999-2006  David Faure <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KSERVICE_H
#define KSERVICE_H

#include "kserviceaction.h"
#include <QStringList>
#include <QVariant>
#include <KPluginFactory>
#include <KPluginLoader>
#include <ksycocaentry.h>
#include <QCoreApplication>

class KServiceType;
class QDataStream;
class KDesktopFile;
class QWidget;

class KServicePrivate;

class KSERVICE_EXPORT KService : public KSycocaEntry
{
public:
    typedef QExplicitlySharedDataPointer<KService> Ptr;
    typedef QList<Ptr> List;

    KService(const QString &name, const QString &exec, const QString &icon);

    explicit KService(const QString &fullpath);

    explicit KService(const KDesktopFile *config, const QString &entryPath = QString());

    KService(const KService &other);

    virtual ~KService();

    bool isApplication() const;

    QString exec() const;
    QString library() const;

    QString icon() const;
    bool terminal() const;

    QString terminalOptions() const;
    bool runOnDiscreteGpu() const;
    bool substituteUid() const;
    QString username() const;

    QString desktopEntryName() const;

    QString menuId() const;

    QString storageId() const;

    enum DBusStartupType { DBusNone = 0, DBusUnique, DBusMulti };

    DBusStartupType dbusStartupType() const;

#if KSERVICE_ENABLE_DEPRECATED_SINCE(5, 63)

    KSERVICE_DEPRECATED_VERSION(5, 63, "Use KService::workingDirectory()")
    QString path() const;
#endif

    QString workingDirectory() const;

    QString comment() const;

    QString genericName() const;

    QString untranslatedGenericName() const;

    QStringList keywords() const;

    QStringList categories() const;

    QStringList mimeTypes() const;

    QStringList serviceTypes() const;

    bool hasServiceType(const QString &serviceTypePtr) const;

    bool hasMimeType(const QString &mimeType) const;

#if KSERVICE_ENABLE_DEPRECATED_SINCE(5, 67)

    KSERVICE_DEPRECATED_VERSION(5, 67, "No known use case")
    bool allowAsDefault() const;
#endif

    QList<KServiceAction> actions() const;

    bool allowMultipleFiles() const;

    int initialPreference() const;

    bool noDisplay() const;

#if KSERVICE_ENABLE_DEPRECATED_SINCE(5, 0)

    KSERVICE_DEPRECATED_VERSION(5, 0, "Use KService::showInCurrentDesktop()")
    bool showInKDE() const { return showInCurrentDesktop(); }
#endif

    bool showInCurrentDesktop() const;

    bool showOnCurrentPlatform() const;

    QString parentApp() const;

    QString pluginKeyword() const;

    QString docPath() const;

    QVariant property(const QString &_name, QVariant::Type t) const;

    using KSycocaEntry::property;

    QString locateLocal() const;

    void setMenuId(const QString &menuId);
    void setTerminal(bool b);
    void setTerminalOptions(const QString &options);

    void setExec(const QString &exec);

    static Ptr serviceByDesktopPath(const QString &_path);

    static Ptr serviceByDesktopName(const QString &_name);

    static Ptr serviceByMenuId(const QString &_menuId);

    static Ptr serviceByStorageId(const QString &_storageId);

    static List allServices();

    static QString newServicePath(bool showInMenu, const QString &suggestedName,
                                  QString *menuId = nullptr,
                                  const QStringList *reservedMenuIds = nullptr);

    template <class T>
    T *createInstance(QObject *parent = nullptr,
                      const QVariantList &args = QVariantList(), QString *error = nullptr) const
    {
        return createInstance<T>(nullptr, parent, args, error);
    }

    template <class T>
    T *createInstance(QWidget *parentWidget, QObject *parent,
                      const QVariantList &args = QVariantList(), QString *error = nullptr) const
    {
        KPluginLoader pluginLoader(*this);
        KPluginFactory *factory = pluginLoader.factory();
        if (factory) {
            QVariantList argsWithMetaData = args;
            argsWithMetaData << pluginLoader.metaData().toVariantMap();
            T *o = factory->template create<T>(parentWidget, parent, pluginKeyword(), argsWithMetaData);
            if (!o && error)
                *error = QCoreApplication::translate("", "The service '%1' does not provide an interface '%2' with keyword '%3'")
                         .arg(name(), QString::fromLatin1(T::staticMetaObject.className()), pluginKeyword());
            return o;
        } else if (error) {
            *error = pluginLoader.errorString();
            pluginLoader.unload();
        }
        return nullptr;
    }

    operator KPluginName() const;

private:
    friend class KBuildServiceFactory;

    struct ServiceTypeAndPreference {
        ServiceTypeAndPreference()
            : preference(-1), serviceType() {}
        ServiceTypeAndPreference(int pref, const QString &servType)
            : preference(pref), serviceType(servType) {}
        int preference;
        QString serviceType; // or mimetype
    };
    QVector<ServiceTypeAndPreference> &_k_accessServiceTypes();

    friend QDataStream &operator>>(QDataStream &, ServiceTypeAndPreference &);
    friend QDataStream &operator<<(QDataStream &, const ServiceTypeAndPreference &);

    Q_DECLARE_PRIVATE(KService)

    friend class KServiceFactory;

    KService(QDataStream &str, int offset);
};
#endif