PluginLoader.hpp

/***************************************************************************
  tag: The SourceWorks  Tue Sep 7 00:55:18 CEST 2010  PluginLoader.hpp

                        PluginLoader.hpp -  description
                           -------------------
    begin                : Tue September 07 2010
    copyright            : (C) 2010 The SourceWorks
    email                : peter@thesourceworks.com

 ***************************************************************************
 *   This library 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;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   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 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                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_PLUGINLOADER_HPP_
#define ORO_PLUGINLOADER_HPP_

#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>

#include "../rtt-fwd.hpp"
#include "../rtt-config.h"
#include "../os/Mutex.hpp"

namespace RTT {
    namespace plugin {
        class RTT_API PluginLoader
        {
            class LoadedLib{
            public:
                LoadedLib(std::string n, std::string short_name, void* h)
                : filename(n), shortname(short_name), handle(h), loadPlugin(0), is_typekit(false), is_service(false)
                {
                }
                std::string filename;
                std::string shortname;
                std::string plugname;
                void* handle;
                bool (*loadPlugin)(RTT::TaskContext*);
                RTT::ServicePtr (*createService)(void);
                bool is_typekit, is_service;
            };

            std::vector< LoadedLib > loadedLibs;

            std::string plugin_path;

            mutable os::Mutex listlock;

            bool loadInProcess(std::string filename, std::string shortname, std::string kind, bool log_error );
            bool loadPluginInternal( std::string const& name, std::string const& path_list, std::string const& subdir, std::string const& kind );
            bool loadPluginsInternal( std::string const& path_list, std::string const& subdir, std::string const& kind );
            bool isLoadedInternal(std::string name);
            bool isCompatiblePlugin(std::string const& filepath);

        public:
            PluginLoader();
            ~PluginLoader();

            typedef boost::shared_ptr<PluginLoader> shared_ptr;
            static boost::shared_ptr<PluginLoader> Instance();

            static void Release();

            bool loadLibrary(std::string const& path);

            bool loadTypekits(std::string const& path_list);

            bool loadTypekit(std::string const& name, std::string const& path_list);

            bool loadPlugins(std::string const& path_list);

            bool isLoaded(std::string name);

            bool loadPlugin(std::string const& name, std::string const& path_list);

            bool loadService(std::string const& servicename, TaskContext* tc);

            std::vector<std::string> listServices() const;

            std::vector<std::string> listPlugins() const;

            std::vector<std::string> listTypekits() const;

            std::string getPluginPath() const;

            void setPluginPath( std::string const& newpath );
        };
    }
}


#endif /* ORO_PLUGINLOADER_HPP_ */