kpmcore/src/backend/corebackendmanager.h

/*************************************************************************
 *  Copyright (C) 2010 by Volker Lanz <vl@fidra.de>                      *
 *  Copyright (C) 2018 by Andrius Štikonas <andrius@stikonas.eu>         *
 *                                                                       *
 *  This program is free software; you can redistribute it and/or        *
 *  modify it under the terms of the GNU General Public License as       *
 *  published by the Free Software Foundation; either version 3 of       *
 *  the License, or (at your option) any later version.                  *
 *                                                                       *
 *  This program 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 General Public License for more details.                         *
 *                                                                       *
 *  You should have received a copy of the GNU General Public License    *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.*
 *************************************************************************/

#ifndef KPMCORE_COREBACKENDMANAGER_H
#define KPMCORE_COREBACKENDMANAGER_H

#include "util/libpartitionmanagerexport.h"

#include <memory>

#include <QVector>

class QString;
class QStringList;
class KPluginMetaData;
class CoreBackend;
struct CoreBackendManagerPrivate;

/**
  * The backend manager class.
  *
  * This is basically a singleton class to give the application access to the currently
  * selected backend and also to manage the available backend plugins.
  * @author Volker Lanz <vl@fidra.de>
  */
class LIBKPMCORE_EXPORT CoreBackendManager
{
    CoreBackendManager();
    ~CoreBackendManager();

public:
    /**
      * @return pointer to ourselves
      */
    static CoreBackendManager* self();

    /**
      * @return the name of the default backend plugin
      */
    static QString defaultBackendName() {
        return QStringLiteral("pmsfdiskbackendplugin");
    }

    /**
      * @return a list of available backend plugins
      */
    QVector<KPluginMetaData> list() const;

    /**
       * Loads the given backend plugin into the application.
       * @param name the name of the plugin to load
       * @return true on success
       */
    bool load(const QString& name);

    /**
      * Unload the current plugin.
      */
    void unload();

    /**
      * @return a pointer to the currently loaded backend
      */
    CoreBackend* backend();

private:
    std::unique_ptr<CoreBackendManagerPrivate> d;
};

#endif