include/plugin.h

Go to the documentation of this file.

/*
 Copyright (C) 2011 Georgia Institute of Technology, University of Utah, Weill Cornell Medical College

 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 PLUGIN_H
#define PLUGIN_H

#include <list>
#include <mutex.h>
#include <settings.h>
#include <string>
#include <qobject.h>

#include <sys/types.h>


namespace Plugin {

    class Object;

    class Manager : public QObject {

        Q_OBJECT

        friend class Object;

    public:

        static Manager *getInstance(void);

        Object *load(const std::string &library);
        void unload(Object *object);
        void unloadAll(void);

        void foreachPlugin(void (*callback)(Plugin::Object *,void *),void *param);

    public slots:

        void customEvent(QCustomEvent *);

    private:

        /*****************************************************************
         * The constructor, destructor, and assignment operator are made *
         *   private to control instantiation of the class.              *
         *****************************************************************/

        Manager(void) : mutex(Mutex::RECURSIVE) {};
        ~Manager(void) {};
        Manager(const Manager &) {};
        Manager &operator=(const Manager &) { return *getInstance(); };

        static Manager *instance;

        void insertPlugin(Object *);
        void removePlugin(Object *);

        static const QEvent::Type CloseEvent = QEvent::User;

        Mutex mutex;
        std::list<Object *> pluginList;

    }; // class Manager

    class Object : public virtual Settings::Object {

        friend class Manager;

    public:

        Object(void);
        virtual ~Object(void);

        std::string getLibrary(void) const;

        void unload(void);

    private:

        static const u_int32_t MAGIC_NUMBER = 0xCA24CB3F;

        u_int32_t magic_number;
        std::string library;
        void *handle;

    }; // class Object

}; // namespace Plugin

#endif // PLUGIN_H