---

IgModule.h

Go to the documentation of this file.

#ifndef IGUANA_FRAMEWORK_IG_PLUGIN_H
# define IGUANA_FRAMEWORK_IG_PLUGIN_H

//<<<<<< INCLUDES                                                       >>>>>>

# include "Iguana/Framework/interface/config.h"
# include "Iguana/Framework/interface/IgPluginInfo.h"
# include "Iguana/Framework/interface/IgModuleDescriptor.h"
# include "classlib/iobase/Filename.h"
# include "classlib/utils/SharedLibrary.h"
# include <string>
# include <list>

//<<<<<< PUBLIC DEFINES                                                 >>>>>>
//<<<<<< PUBLIC CONSTANTS                                               >>>>>>
//<<<<<< PUBLIC TYPES                                                   >>>>>>

class IgModule;
class IgModuleDef;
class IgModuleCache;
class IgModuleDescriptor;
class IgPluginManager;

extern "C" { typedef IgModuleDef *(*IgModuleEntry) (void); }

extern "C" { typedef void (*IgModuleCapEntry) (const char **&names, int &n); }

//<<<<<< PUBLIC VARIABLES                                               >>>>>>
//<<<<<< PUBLIC FUNCTIONS                                               >>>>>>
//<<<<<< CLASS DECLARATIONS                                             >>>>>>

class IgModule
{
    typedef std::list<IgPluginInfo *>   InfoList;
public:
    typedef InfoList::const_iterator    InfoIterator;

    IgModule (IgPluginManager *manager,
              const lat::Filename &libraryName,
              const std::string &time,
              const std::string &flag);
    virtual ~IgModule (void);

    // module management interface
    IgPluginManager *   manager (void) const;
    const lat::Filename &libraryName (void) const;
    unsigned            time (void) const;
    bool                bad (void) const;
    void                bad (bool value);

    virtual void        load (void);
    virtual void        unload (void);
    virtual void        attach (void);
    virtual void        detach (void);
    virtual void        query (void);

    virtual bool        attached (void);

    // program built-in module (= program itself)
    static IgModule *   builtin (void);

    // info access
    InfoIterator        beginInfos (void) const;
    InfoIterator        endInfos (void) const;
    void                addInfo (IgPluginInfo *info, bool cache);
    void                detachInfo (IgPluginInfo *info);
    IgModuleDescriptor *cacheRoot (void) const;

protected:
    friend class IgModuleCache;
    void                makeCache (void);
    void                clearCache (void);
    virtual void        restore (IgModuleDescriptor *info);
    virtual void        cache (IgModuleDescriptor *to) const;

    virtual bool        checkEntryPoints (void) const;
    IgModuleEntry       moduleEntryPoint (void);
    IgModuleCapEntry    capabilityEntryPoint (void);

    lat::SharedLibrary *library (void) const;
    bool                loaded (void) const;

    static const char * tag (void);

private:
    IgPluginManager     *m_manager;
    lat::Filename       m_libraryName;
    mutable lat::SharedLibrary *m_library;
    IgModuleDescriptor  *m_cache;

    unsigned            m_time;         //< Registration file time stamp
    bool                m_bad;          //< Flag to mark if the file was bad
    bool                m_attached;     //< Set when library has been attached.
    IgModuleDef         *m_definition;  //< My definition proxy.
    InfoList            m_infos;        //< Info items for this module.
    static const char   s_modEntryPoint [];//< Name of the normal library entry point.
    static const char   s_capEntryPoint [];//< Name of the capability library entry point.
    static const char   s_tag [];

    // undefined semantics
    IgModule (const IgModule &);
    IgModule &operator= (const IgModule &);
};

//<<<<<< INLINE PUBLIC FUNCTIONS                                        >>>>>>
//<<<<<< INLINE MEMBER FUNCTIONS                                        >>>>>>

inline const char *
IgModule::tag (void)
{ return s_tag; }

inline unsigned
IgModule::time (void) const
{ return m_time; }

#endif // IGUANA_FRAMEWORK_IG_PLUGIN_H

---