ComponentLoader.hpp

Go to the documentation of this file.

/***************************************************************************
  tag: Peter Soetens Thu Feb 1 16:30:11 2007 +0000 ComponentLoader.hpp

                        ComponentLoader.hpp -  description
                           -------------------
    begin                : Thu Feb 1 2007
    copyright            : (C) 2007 Peter Soetens
    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     *
 *   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_COMPONENTLOADER_HPP_
#define ORO_COMPONENTLOADER_HPP_

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

namespace RTT {
        class ComponentLoader
        {
            class LoadedLib{
            public:
                LoadedLib(std::string n, std::string short_name, void* h)
                : filename(n), shortname(short_name), handle(h)
                {
                }
                std::string filename;
                std::string shortname;

                void* handle;

                std::vector<std::string> components_type;
            };

            struct ComponentData {
                ComponentData()
                    : instance(0), type("")
                {}
                RTT::TaskContext* instance;
                std::string type;
            };

            typedef std::map<std::string, ComponentData> CompList;

            CompList comps;


            std::vector< LoadedLib > loadedLibs;

            std::vector< std::string > loadedPackages;

            std::string component_path;

            bool loadInProcess(std::string filename, std::string shortname, bool log_error );

            bool reloadInProcess(std::string filename, std::string shortname);

            bool isCompatibleComponent(std::string const& filepath);

            bool importInstalledPackage(std::string const& package, std::string const& path_list);
        public:
            typedef boost::shared_ptr<ComponentLoader> shared_ptr;
            static boost::shared_ptr<ComponentLoader> Instance();

            static void Release();

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

            bool isImported(std::string type_name);

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

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

            bool reloadLibrary(std::string const& filepath);

            RTT::TaskContext* loadComponent(std::string const& name, std::string const& type);

            bool unloadComponent( RTT::TaskContext* tc );

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

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

            std::string getComponentPath() const;

            void setComponentPath( std::string const& newpath );

            const FactoryMap& getFactories() const;

            void addFactory( std::string const& name, ComponentLoaderSignature factory );
        };
}


#endif /* ORO_COMPONENTLOADER_HPP_ */