ModuleManager.h
Go to the documentation of this file.
1 // -*- C++ -*-
20 #ifndef RTC_MODULEMANAGER_H
21 #define RTC_MODULEMANAGER_H
22 
23 // STL includes
24 #include <string>
25 #include <vector>
26 #include <map>
27 
28 // ACE includes
29 #include <coil/DynamicLib.h>
30 
31 // RTC includes
32 #include <rtm/Manager.h>
33 #include <coil/Properties.h>
34 #include <rtm/ObjectManager.h>
35 
36 
37 #define CONFIG_EXT "manager.modules.config_ext"
38 #define CONFIG_PATH "manager.modules.config_path"
39 #define DETECT_MOD "manager.modules.detect_loadable"
40 #define MOD_LOADPTH "manager.modules.load_path"
41 #define INITFUNC_SFX "manager.modules.init_func_suffix"
42 #define INITFUNC_PFX "manager.modules.init_func_prefix"
43 #define ALLOW_ABSPATH "manager.modules.abs_path_allowed"
44 #define ALLOW_URL "manager.modules.download_allowed"
45 #define MOD_DWNDIR "manager.modules.download_dir"
46 #define MOD_DELMOD "manager.modules.download_cleanup"
47 #define MOD_PRELOAD "manager.modules.preload"
48 
49 #ifdef WIN32
50 #pragma warning( disable : 4290 )
51 #endif
52 
53 namespace RTC
54 {
75  {
76  typedef std::vector<coil::Properties> vProperties;
77  public:
100 
112  ~ModuleManager(void);
113 
121  struct Error
122  {
123  Error(const std::string& _reason)
124  : reason(_reason) {}
125  std::string reason;
126  };
127 
136  struct NotFound
137  {
138  NotFound(const std::string& _name)
139  : name(_name) {}
140  std::string name;
141  };
142 
152  : public NotFound
153  {
154  FileNotFound(const std::string& _name)
155  : NotFound(_name) {}
156  };
157 
167  : public NotFound
168  {
169  ModuleNotFound(const std::string& _name)
170  : NotFound(_name) {}
171  };
172 
182  : public NotFound
183  {
184  SymbolNotFound(const std::string& _name)
185  : NotFound(_name) {}
186  };
187 
197  : public Error
198  {
199  NotAllowedOperation(const std::string& _reason)
200  : Error(_reason) {}
201  };
202 
212  : public Error
213  {
214  InvalidArguments(const std::string& _reason)
215  : Error(_reason) {}
216  };
217 
227  : public Error
228  {
229  InvalidOperation(const std::string& _reason)
230  : Error(_reason) {}
231  };
232  typedef void (*ModuleInitFunc)(Manager*);
233 
279  std::string load(const std::string& file_name);
280 
308  std::string load(const std::string& file_name,
309  const std::string& init_func);
310 
328  void unload(const std::string& file_name);
329 
343  void unloadAll();
344 
352  void* symbol(const std::string& file_name, const std::string& func_name)
354 
372  void setLoadpath(const std::vector<std::string>& load_path);
373 
391  inline std::vector<std::string> getLoadPath()
392  {
393  return m_loadPath;
394  }
395 
413  void addLoadpath(const std::vector<std::string>& load_path);
414 
432  std::vector<coil::Properties> getLoadedModules();
433 
452  std::vector<coil::Properties> getLoadableModules();
453 
467  inline void allowAbsolutePath()
468  {
469  m_absoluteAllowed = true;
470  }
471 
485  inline void disallowAbsolutePath()
486  {
487  m_absoluteAllowed = false;
488  }
489 
507  inline void allowModuleDownload()
508  {
509  m_downloadAllowed = true;
510  }
511 
526  {
527  m_downloadAllowed = false;
528  }
529 
553  std::string findFile(const std::string& fname,
554  const std::vector<std::string>& load_path);
555 
577  bool fileExist(const std::string& filename);
578 
600  std::string getInitFuncName(const std::string& file_path);
601 
602  protected:
610  void removeInvalidModules();
611 
619  void getModuleList(const std::string& lang, coil::vstring& modules);
620 
628  void addNewFile(const std::string& fpath, coil::vstring& modules);
629 
637  void getModuleProfiles(const std::string& lang,
638  const coil::vstring& modules, vProperties& modprops);
639 
648 
656  struct DLLEntity
657  {
660  };
661 
662  typedef std::vector<std::string> StringVector;
663  typedef StringVector::iterator StringVectorItr;
664  typedef StringVector::const_iterator StringVectorConstItr;
665 
666  typedef std::vector<DLLEntity> DllMap;
667  typedef DllMap::iterator DllMapItr;
668  typedef DllMap::const_iterator DllMapConstItr;
669 
670 
679 
687  class DllPred
688  {
689  std::string m_filepath;
690  public:
691  DllPred(const char* filepath) : m_filepath(filepath) {}
692  DllPred(const DLLEntity* dll) : m_filepath(dll->properties["file_path"]) {}
693  bool operator()(DLLEntity* dllentity)
694  {
695  return m_filepath == dllentity->properties.getProperty("file_path");
696  }
697  };
706 
714  StringVector m_loadPath;
722  StringVector m_configPath;
739 
747  std::string m_initFuncSuffix;
748 
756  std::string m_initFuncPrefix;
757 
766  {
767  public:
770  {
771  dll->dll.close();
772  delete dll;
773  }
774  };
775 
776  vProperties m_modprofs;
777 
778  }; // class ModuleManager
779 }; // namespace RTC
780 
781 #ifdef WIN32
782 #pragma warning( default : 4290 )
783 #endif
784 
785 #endif // RTC_MODULEMANAGER_H
void * symbol(const std::string &file_name, const std::string &func_name)
Refer to the symbol of the module.
void(* ModuleInitFunc)(Manager *)
Structure for exception handling of unimplemented part and specified module missing.
std::vector< coil::Properties > vProperties
Definition: ModuleManager.h:76
std::string getInitFuncName(const std::string &file_path)
Create initialization function symbol.
NotAllowedOperation(const std::string &_reason)
bool m_absoluteAllowed
Flag of absolute path when specify module for the load.
void operator()(DLLEntity *dll)
NotFound(const std::string &_name)
RT-Component.
Structure for exception handling when file open is failed.
void addLoadpath(const std::vector< std::string > &load_path)
Add the module load path.
coil::Properties & m_properties
Module Manager properties.
Module list that has already loaded.
Error(const std::string &_reason)
~ModuleManager(void)
Destructor.
std::vector< coil::Properties > getLoadableModules()
Get the loadable module list.
InvalidArguments(const std::string &_reason)
ObjectManager< const char *, DLLEntity, DllPred > m_modules
Module list that has already loaded.
void setLoadpath(const std::vector< std::string > &load_path)
Set the module load path.
void disallowAbsolutePath()
Disallow absolute path when specify module path.
Manager class.
Definition: Manager.h:80
ModuleNotFound(const std::string &_name)
Structure for exception handling when specified symbol cannot be found.
std::string load(const std::string &file_name)
Load the module.
void allowAbsolutePath()
Allow absolute path when specify module path.
DllMap::const_iterator DllMapConstItr
Module unloading functor.
std::vector< coil::Properties > getLoadedModules()
Get the module list that has been loaded.
void disallowModuleDownload()
Disallow URL when specify module path.
RTComponent manager class.
InvalidOperation(const std::string &_reason)
bool m_downloadAllowed
Flag of URL when specify module for the load.
Structure for exception handling when specified operation is invalid.
DynamicLib class.
std::vector< std::string > vstring
Definition: stringutil.h:37
StringVector m_loadPath
Module load path list.
Logger rtclog
Logger stream.
StringVector m_configPath
Configuration path list.
Structure for exception handling when specified argument is invalid.
bool fileExist(const std::string &filename)
Check whether the file exists.
void addNewFile(const std::string &fpath, coil::vstring &modules)
Adding file path not existing cache.
Class for managing objects.
StringVector::iterator StringVectorItr
Structure for exception handling when specified module cannot be found.
void removeInvalidModules()
Removing incalid module profiles.
std::vector< std::string > StringVector
DllPred(const char *filepath)
prop
Organization::get_organization_property ();.
vProperties m_modprofs
std::vector< std::string > getLoadPath()
Get the module load path.
bool operator()(DLLEntity *dllentity)
Class represents a set of properties.
Definition: Properties.h:101
void unloadAll()
Unload all modules.
Structure for exception handling when specified file cannot be found.
StringVector::const_iterator StringVectorConstItr
Structure for DLL management.
void unload(const std::string &file_name)
Unload the module.
virtual int close(void)
Unload of the Dynamic link library.
void allowModuleDownload()
Allow URL when specify module path.
ModuleManager(coil::Properties &prop)
Constructor.
DllPred(const DLLEntity *dll)
void getModuleProfiles(const std::string &lang, const coil::vstring &modules, vProperties &modprops)
Getting module properties from given language and file list.
std::vector< DLLEntity > DllMap
std::string findFile(const std::string &fname, const std::vector< std::string > &load_path)
Search the file from the LoadPath.
DllMap::iterator DllMapItr
void getModuleList(const std::string &lang, coil::vstring &modules)
Getting loadable file list on the loadpath for given language.
std::string m_initFuncSuffix
Initial execution function suffix.
Structure for exception handling when specified operation cannot be allowed.
std::string m_initFuncPrefix
Initial execution function prefix.
FileNotFound(const std::string &_name)
const std::string & getProperty(const std::string &key) const
Search for the property with the specified key in this property.
Definition: Properties.cpp:156
SymbolNotFound(const std::string &_name)


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Jun 6 2019 19:25:58