PluginInterface.h

Go to the documentation of this file.

// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003 T. Zachary Laine

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1
   of the License, or (at your option) any later version.
   
   This library 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
   Lesser General Public License for more details.
    
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@hotmail.com */

#ifndef _GG_PluginInterface_h_
#define _GG_PluginInterface_h_

#include <GG/GUI.h>

#if defined(__APPLE__) && defined(__MACH__)
# include "../libltdl/ltdl.h"
#else
# include <GG/ltdl.h>
#endif

#include <string>


namespace boost { namespace archive {
    class xml_oarchive;
    class xml_iarchive;
} }

namespace GG {

class GG_API PluginInterface
{
private:
    struct ConvertibleToBoolDummy {int _;};

public:
    typedef const char*                     (*PluginNameFn)();
    typedef const char*                     (*DefaultFontNameFn)();
    typedef int                             (*DefaultFontSizeFn)();
    typedef boost::shared_ptr<StyleFactory> (*GetStyleFactoryFn)();

    typedef GUI::SaveWndFn                  SaveWndFn;
    typedef GUI::LoadWndFn                  LoadWndFn;
 
    PluginInterface(); 

    PluginInterface(const std::string& lib_name);

    ~PluginInterface(); 

 

    operator int ConvertibleToBoolDummy::* () const;
 

    bool Load(const std::string& lib_name);

    PluginNameFn                PluginName;             
    DefaultFontNameFn           DefaultFontName;        
    DefaultFontSizeFn           DefaultFontSize;        
    GetStyleFactoryFn           GetStyleFactory;        
    SaveWndFn                   SaveWnd;                
    LoadWndFn                   LoadWnd;                

    template <class T>
    void LoadWndT(T*& wnd, const std::string& name, boost::archive::xml_iarchive& ar);

private:
    lt_dlhandle m_handle;
    boost::archive::xml_oarchive* m_out_archive;
    boost::archive::xml_iarchive* m_in_archive;
};

class GG_API PluginManager
{
public: 

    boost::shared_ptr<PluginInterface> GetPlugin(const std::string& name);

    void FreePlugin(const std::string& name);

    static void InitDynamicLoader();

    static void AddSearchDirectory(const std::string& dir);

    static void CleanupDynamicLoader();

private:
    PluginManager();

    std::map<std::string, boost::shared_ptr<PluginInterface> > m_plugins;

    static bool s_lt_dl_initialized;

    friend GG_API PluginManager& GetPluginManager();
};

GG_API PluginManager& GetPluginManager();

// template implementations
template <class T>
void PluginInterface::LoadWndT(T*& wnd, const std::string& name, boost::archive::xml_iarchive& ar)
{
    Wnd* wnd_as_base = wnd;
    LoadWnd(wnd_as_base, name, ar);
    wnd = dynamic_cast<T*>(wnd_as_base);
    assert(wnd);
}

} // namespace GG

#endif // _GG_PluginInterface_h_

---