StelModuleMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2006 Fabien Chereau
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELMODULEMGR_HPP_
#define _STELMODULEMGR_HPP_

#include <QObject>
#include <QMap>
#include <QList>
#include "StelModule.hpp"
#include "StelPluginInterface.hpp"

#define GETSTELMODULE( m ) (( m *)StelApp::getInstance().getModuleMgr().getModule( #m ))

class StelModuleMgr : public QObject
{
    Q_OBJECT

public:
    StelModuleMgr();
    ~StelModuleMgr();

    void update();

    void registerModule(StelModule* m, bool generateCallingLists=false);

    void unloadModule(const QString& moduleID, bool alsoDelete=true);

    StelModule* loadPlugin(const QString& moduleID);

    QObjectList loadExtensions(const QString& moduleID);

    void unloadAllPlugins();

    void setPluginLoadAtStartup(const QString& key, bool b);

    StelModule* getModule(const QString& moduleID, bool noWarning=false);

    QList<StelModule*> getAllModules() {return modules.values();}

    const QList<StelModule*>& getCallOrders(StelModule::StelModuleActionName action)
    {
        return callOrders[action];
    }

    struct PluginDescriptor
    {
        PluginDescriptor() : loadAtStartup(false), loaded(false), pluginInterface(Q_NULLPTR) {;}
        StelPluginInfo info;
        bool loadAtStartup;
        bool loaded;

    private:
        friend class StelModuleMgr;
        StelPluginInterface* pluginInterface;
    };

    QList<PluginDescriptor> getPluginsList();

    QObjectList getExtensionList() { return extensions; }
signals:
    void extensionsAdded(QObjectList newExtensions);

private:
    void generateCallingLists();

    QMap<QString, StelModule*> modules;

    QObjectList extensions;

    QMap<StelModule::StelModuleActionName, QList<StelModule*> > callOrders;

    bool callingListsToRegenerate;

    QMap<QString, StelModuleMgr::PluginDescriptor> pluginDescriptorList;
    bool pluginDescriptorListLoaded;
};

#endif // _STELMODULEMGR_HPP_