plugins.h

Go to the documentation of this file.

#pragma once
/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          Aug 2003
 Contents:      Plugins


 For making your own plugins, no need to include this file. Use odplugin.h.
________________________________________________________________________

-*/

#include "basicmod.h"
#include "sharedlibs.h"
#include "bufstringset.h"


extern "C" {

#include "pluginbase.h"

/* C Access. C++ should use PluginManager! */

void LoadAutoPlugins(int inittype);
int LoadPlugin(const char* libnm);

}

mExpClass(Basic) PluginManager
{
public:

    mGlobal(Basic) friend PluginManager& PIM();

    static PluginManager&       getInstance();

    void                        loadAuto(bool late);
    bool                        load(const char* libnm);

    struct Data
    {
        enum AutoSource         { None, UserDir, AppDir, Both };
        static bool             isUserDir( AutoSource src )
                                { return src != AppDir && src != None; }

                                Data( const char* nm )
                                    : name_(nm)
                                    , info_(0)
                                    , autosource_(None)
                                    , autotype_(PI_AUTO_INIT_NONE)
                                    , isloaded_( false )
                                    , sla_(0)   {}
                                ~Data()         { delete sla_; }

        BufferString            name_;
        const PluginInfo*       info_;
        AutoSource              autosource_;
        int                     autotype_;
        SharedLibAccess*        sla_;
        bool                    isloaded_;
    };

    ObjectSet<Data>&    getData()               { return data_; }
    Data*               findData( const char* nm ) { return fndData( nm ); }
    const Data*         findData( const char* nm ) const {return fndData( nm );}
    const Data*         findDataWithDispName(const char*) const;

    bool                isPresent(const char*) const;
    const char*         userName(const char*) const;
    static const char*  moduleName(const char*);
    const char*         getFileName(const Data&) const;

    const char*         getAutoDir( bool usr ) const
                        { return usr ? userlibdir_ : applibdir_; }

    static const char*  sKeyDontLoad() { return "dTect.Dont load plugins"; }
    void                getNotLoadedByUser(BufferStringSet&) const;

    void                loadSurveyRelatedTools();

private:

                                PluginManager();

    ObjectSet<Data>             data_;

    BufferString                userdir_;
    BufferString                appdir_;
    BufferString                userlibdir_;
    BufferString                applibdir_;

    Data*                       fndData(const char*) const;
    void                        getDefDirs();
    void                        getALOEntries(const char*,bool);
    void                        openALOEntries();
    void                        mkALOList();
};

mGlobal(Basic) PluginManager& PIM();