anymodule.hpp File Reference

#include <string>
#include <map>
#include <vector>
#include <qi/log.hpp>
#include <qi/anyobject.hpp>
#include <qi/anyvalue.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <boost/shared_ptr.hpp>
#include <qi/type/objecttypebuilder.hpp>
#include <qi/type/dynamicobjectbuilder.hpp>

Go to the source code of this file.

Classes
struct	qi::ModuleInfo
class	qi::AnyModule
class	qi::ModuleBuilder

Namespaces
	qi
	Deprecated in 2.5. Use int8_t from <cstdint>.

Macros
#define	QI_REGISTER_MODULE(modname, fun)
#define	QI_REGISTER_MODULE_EMBEDDED(name, fun)   static bool BOOST_PP_CAT(_register_module, __COUNTER__) = ::qi::registerCppEmbeddedModule(name, fun);
#define	QI_REGISTER_MODULE_FACTORY(factoryType, fun)   static bool BOOST_PP_CAT(_register_module_factory, __COUNTER__) = ::qi::registerModuleFactory(factoryType, fun)
#define	QI_REGISTER_MODULE_FACTORY_PLUGIN(factoryType, fun)

Typedefs
using	qi::ModuleFactoryFunctor = boost::function< AnyModule(const qi::ModuleInfo &)>

Functions
bool	qi::registerCppEmbeddedModule (const std::string &moduleName, boost::function< void(ModuleBuilder *)> fun)
std::vector< ModuleInfo >	qi::listModules ()
AnyModule	qi::import (const std::string &name)
AnyModule	qi::import (const ModuleInfo &name)
	QI_TYPE_STRUCT (qi::ModuleInfo, name, type, path)
bool	qi::registerModuleFactory (const std::string &name, ModuleFactoryFunctor fun)

Macro Definition Documentation

#define QI_REGISTER_MODULE	(		modname,
			fun
	)

Value:

extern "C" QI_EXPORT_API void qi_module_init(::qi::ModuleBuilder *mb) {  \
    if (modname != mb->moduleName()) {                                     \
      qiLogCategory("qi.module");                                          \
      qiLogError() << "module name do not match: '"                        \
                   << modname << "' vs '" << mb->moduleName() << "'";      \
      return;                                                              \
    }                                                                      \
    (*fun)(mb);                                                            \
  }

register a normal module, a function will be exported to allow the module loader to init the module

Definition at line 122 of file anymodule.hpp.

#define QI_REGISTER_MODULE_EMBEDDED	(		name,
			fun
	)		static bool BOOST_PP_CAT(_register_module, __COUNTER__) = ::qi::registerCppEmbeddedModule(name, fun);

register an embedded module. (the library do not have to be loaded)

Definition at line 135 of file anymodule.hpp.

#define QI_REGISTER_MODULE_FACTORY	(		factoryType,
			fun
	)		static bool BOOST_PP_CAT(_register_module_factory, __COUNTER__) = ::qi::registerModuleFactory(factoryType, fun)

Register a Module Factory. Module factory are by language, the default one is for C++ and provided by libqi. A python one is provided by libqi-python as a plugin.

Definition at line 158 of file anymodule.hpp.

#define QI_REGISTER_MODULE_FACTORY_PLUGIN	(		factoryType,
			fun
	)

Value:

extern "C" QI_EXPORT_API void module_factory_plugin() {     \
    ::qi::registerModuleFactory(factoryType, fun);            \
  }

Register a Module Factory as a plugins.

Definition at line 163 of file anymodule.hpp.

Function Documentation

QI_TYPE_STRUCT	(	qi::ModuleInfo	,
		name	,
		type	,
		path
	)