addInManager.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

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

    itom 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 Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef ADDINMANAGER_H
#define ADDINMANAGER_H

#include "addInMgrDefines.h"

#include "../common/addInInterface.h"
#include "../DataObject/dataobj.h"
#ifdef USEPCL
#define ITOM_POINTCLOUDLIBRARY 1
#else
#define ITOM_POINTCLOUDLIBRARY 0
#endif
#if ITOM_POINTCLOUDLIBRARY > 0
    #include "../PointCloud/pclStructures.h"
#endif

#include <qobject.h>
#include <qscopedpointer.h>

//#include "algoInterfaceValidator.h"



#if !defined(Q_MOC_RUN) || defined(ADDINMGR_DLL) //only moc this file in itomCommonQtLib but not in other libraries or executables linking against this itomCommonQtLib

namespace ito
{
    // forward declaration for private AddInManager functions, declared and implemented
    // in addInManagerPrivate.cpp
    class AddInManagerPrivate; 

    class PlugInModel; //forward declaration
    class AlgoInterfaceValidator; //forward declaration

    class ADDINMGR_EXPORT AddInManager : public QObject
    {
        Q_OBJECT

        public:
            static AddInManager* createInstance(QString itomSettingsFile, void **apiFuncsGraph, QObject *mainWindow = NULL, QObject *mainApplication = NULL);

            static RetVal closeInstance();

            static AddInManager* instance() { return staticInstance; }

            const RetVal scanAddInDir(const QString &path, const int checkQCoreApp = 1);

            const QList<QObject *> * getDataIOList(void) const;

            const QList<QObject *> * getActList(void)    const;

            const QList<QObject *> * getAlgList(void)    const;

            const QHash<QString, ito::AddInAlgo::FilterDef *> * getFilterList(void) const;

            const QHash<QString, ito::AddInAlgo::AlgoWidgetDef *> * getAlgoWidgetList(void) const;

            const ito::FilterParams* getHashedFilterParams(ito::AddInAlgo::t_filterParam filterParam) const;

            const QList<struct PluginLoadStatus> getPluginLoadStatus() const;

            const AlgoInterfaceValidator * getAlgoInterfaceValidator(void) const;

            const ito::AddInAlgo::AlgoWidgetDef * getAlgoWidgetDef( QString algoWidgetName, QString algoPluginName = QString() );

            PlugInModel * getPluginModel(void);

            const RetVal reloadAddIn(const QString &name);

            int getTotalNumAddIns(void) const;

            void * getAddInPtr(const int itemNum);

            int getItemIndexInList(const void *item);

            void updateModel(void);

            const RetVal getInitParams(const QString &name, const int pluginType, int *pluginNum, QVector<ito::Param> *&paramsMand, QVector<ito::Param> *&paramsOpt);

            const RetVal getAboutInfo(const QString &name, QString &versionString);

            const RetVal getPluginInfo(const QString &name, int &pluginType, int &pluginNum, int &version, QString &typeString, QString &author, QString &description, QString &detaildescription, QString &license, QString &about);

            const RetVal incRef(ito::AddInBase *plugin);

            const RetVal decRef(ito::AddInBase **plugin);

            const RetVal setTimeOuts(const int initClose, const int general);

            const RetVal setMainWindow(QObject *mainWindow);

            bool isPluginInstanceDead(const ito::AddInBase *plugin) const;

            const QList<ito::AddInAlgo::FilterDef *> getFilterByInterface(ito::AddInAlgo::tAlgoInterface iface, const QString tag = QString::Null()) const;

            const QList<ito::AddInAlgo::FilterDef *> getFiltersByCategory(ito::AddInAlgo::tAlgoCategory cat) const;

            const QList<ito::AddInAlgo::FilterDef *> getFilterByInterfaceAndCategory(ito::AddInAlgo::tAlgoInterface iface, ito::AddInAlgo::tAlgoCategory cat, const QString tag = QString::Null()) const;

            void **getItomApiFuncsPtr(void);

        private:
            AddInManager(QString itomSettingsFile, void **apiFuncsGraph, QObject *mainWindow = NULL, QObject *mainApplication = NULL);

            ~AddInManager(void);

            static AddInManager *staticInstance; 
            QScopedPointer<AddInManagerPrivate> d_ptr; 
            Q_DECLARE_PRIVATE(AddInManager);
            Q_DISABLE_COPY(AddInManager);

        signals:
            void splashLoadMessage(const QString &message);

        public slots:
            ito::RetVal showConfigDialog(ito::AddInBase *addin, ItomSharedSemaphore *waitCond = NULL);

            ito::RetVal showDockWidget(ito::AddInBase *addin, int visible, ItomSharedSemaphore *waitCond = NULL);

            ito::RetVal initAddIn(const int pluginNum, const QString &name, ito::AddInDataIO **addIn, QVector<ito::ParamBase> *paramsMand, QVector<ito::ParamBase> *paramsOpt, bool autoLoadPluginParams, ItomSharedSemaphore *aimWait = NULL);

            ito::RetVal initAddIn(const int pluginNum, const QString &name, ito::AddInActuator **addIn, QVector<ito::ParamBase> *paramsMand, QVector<ito::ParamBase> *paramsOpt, bool autoLoadPluginParams, ItomSharedSemaphore *aimWait = NULL);

            ito::RetVal initAddIn(const int pluginNum, const QString &name, ito::AddInAlgo **addIn, QVector<ito::ParamBase> *paramsMand, QVector<ito::ParamBase> *paramsOpt, bool autoLoadPluginParams, ItomSharedSemaphore *aimWait = NULL);

            ito::RetVal closeAddIn(ito::AddInBase *addIn, ItomSharedSemaphore *aimWait = NULL);

            ito::RetVal interruptAllActuatorInstances(ItomSharedSemaphore *aimWait = NULL);
    };
} //namespace ito   
#endif // #if !defined(Q_MOC_RUN) || defined(ADDINMGR_DLL) 
#endif // #if ADDINMANAGER_H