rve_pluginloader: loader.h Source File

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2009, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef RVE_PLUGINLOADER_LOADER_H
00031 #define RVE_PLUGINLOADER_LOADER_H
00032 
00033 #include <list>
00034 
00035 #include <boost/shared_ptr.hpp>
00036 
00037 namespace rve_pluginloader
00038 {
00039 
00040 void init();
00041 void shutdown();
00042 
00043 class Plugin;
00044 typedef boost::shared_ptr<Plugin> PluginPtr;
00045 typedef std::list<PluginPtr> L_Plugin;
00046 
00047 void loadDescriptions(const std::string& registry_package);
00048 void loadAllPlugins(const std::string& registry_package);
00049 PluginPtr loadPlugin(const std::string& description_file);
00050 PluginPtr loadDescription(const std::string& description_file);
00051 
00052 PluginPtr getPlugin(const std::string& description_file);
00053 PluginPtr getPluginByPackage(const std::string& package);
00054 const L_Plugin& getPlugins();
00055 
00056 PluginPtr getPluginForClass(const std::string& base_class, const std::string& derived_class);
00057 
00058 void* create(const std::string& base_class, const std::string& derived_class);
00059 
00060 template<typename T>
00061 T* create(const std::string& base_class, const std::string& derived_class)
00062 {
00063   T* t = static_cast<T*>(create(base_class, derived_class));
00064   return t;
00065 }
00066 
00067 boost::shared_ptr<void> createShared(const std::string& base_class, const std::string& derived_class);
00068 
00069 template<typename T>
00070 boost::shared_ptr<T> createShared(const std::string& base_class, const std::string& derived_class)
00071 {
00072   return boost::static_pointer_cast<T>(createShared(base_class, derived_class));
00073 }
00074 
00075 void destroy(void* mem);
00076 
00077 }
00078 
00079 #endif // RVE_PLUGINLOADER_LOADER_H