diff --git a/hcore/include/senseApis/senseApiLib.h b/hcore/include/senseApis/senseApiLib.h new file mode 100644 index 0000000..83bd646 --- /dev/null +++ b/hcore/include/senseApis/senseApiLib.h @@ -0,0 +1,73 @@ +#ifndef SENSE_API_PROVIDER_DESC_H +#define SENSE_API_PROVIDER_DESC_H + +#include +#include +#include +#include +#include +#include + +namespace hk { +namespace sense_api { + +/* C++ version of the C struct above, which Harikoff uses to manage the + * lib and connect implexors to it. + */ +class SenseApiDesc +{ +public: + class ExportedImplexorApiDesc + { + public: + const std::string name; + }; + +public: + SenseApiDesc(const CSenseApiDesc& cDesc) + : cDescriptor(cDesc), name(cDesc.name) + {} + + std::reference_wrapper cDescriptor; + std::string name; + // These options affect the sense api lib's behaviour globally. + std::vector options; + // These are the implexors whose APIs this lib exports. + std::vector exportedImplexorApis; +}; + +class SenseApiLib +{ +public: + typedef const CSenseApiDesc *(SenseApiDescGetterFn)(void); + +public: + SenseApiLib(const std::string& path) + : libraryPath(path), handle(nullptr, &dlclose) + {} + +public: + std::string libraryPath; + std::unique_ptr handle; + + /** + * @brief Every sense API lib is required to provide a function that returns + * a CSenseApiDesc struct. This struct states which API the lib uses to + * connect Harikoff to the sense provider it supports. + * + * This getter function should be visible to dlsym() so that Harikoff can + * find it in the lib after loading it, and call it. + */ + SenseApiDescGetterFn *getSenseApiDescriptor; + + /** + * @brief Harikoff will call the `getSenseApiDescriptor` getter function and + * use the data it provides in order to fill out this descriptor. + */ + std::unique_ptr apiDescriptor; +}; + +} // namespace sense_api +} // namespace hk + +#endif // SENSE_API_PROVIDER_DESC_H diff --git a/hcore/include/senseApis/senseApiManager.h b/hcore/include/senseApis/senseApiManager.h index 304947a..47e98f2 100644 --- a/hcore/include/senseApis/senseApiManager.h +++ b/hcore/include/senseApis/senseApiManager.h @@ -7,63 +7,35 @@ #include #include #include +#include -struct SenseApiInstance { - int a; - - bool operator==(const SenseApiInstance& other) const { - return a == other.a; - } -}; - -class SenseApiLib { -public: - std::string libraryPath; - std::unique_ptr handle; - - SenseApiLib(const std::string& path) - : libraryPath(path), handle(nullptr, &dlclose) {} -}; +namespace hk { +namespace sense_api { class SenseApiManager { public: static SenseApiManager& getInstance() { - static SenseApiManager instance - { -#ifdef CONFIG_SENSEAPI_FOO - "builtinApi1", -#endif -#ifdef CONFIG_SENSEAPI_BAR - "builtinApi2", -#endif - // X11 XCB is always built-in. - "x11-xcb" - }; - + static SenseApiManager instance; return instance; } - void registerSenseApi(const SenseApiInstance& apiInstance); - void unregisterSenseApi(const SenseApiInstance& apiInstance); - SenseApiLib& loadSenseApiLib(const std::string& libraryPath); std::optional> getSenseApiLib( const std::string& libraryPath); void unloadSenseApiLib(const std::string& libraryPath); private: - SenseApiManager() = delete; - SenseApiManager(std::initializer_list builtinApis) - : builtinSenseApis(builtinApis) {} + SenseApiManager() = default; ~SenseApiManager() = default; SenseApiManager(const SenseApiManager&) = delete; SenseApiManager& operator=(const SenseApiManager&) = delete; - std::vector> senseApiInstances; std::vector> senseApiLibs; - const std::vector builtinSenseApis; }; +} // namespace sense_api +} // namespace hk + #endif // SENSE_API_MANAGER_H diff --git a/hcore/senseApis/senseApiManager.cpp b/hcore/senseApis/senseApiManager.cpp index 91fe7c3..c8c9f23 100644 --- a/hcore/senseApis/senseApiManager.cpp +++ b/hcore/senseApis/senseApiManager.cpp @@ -1,11 +1,11 @@ -#include #include #include #include #include +#include -std::vector> senseApiLibs; -std::vector> senseApiInstances; +namespace hk { +namespace sense_api { SenseApiLib& SenseApiManager::loadSenseApiLib(const std::string& libraryPath) { @@ -29,8 +29,8 @@ SenseApiLib& SenseApiManager::loadSenseApiLib(const std::string& libraryPath) return *senseApiLibs.back(); } -std::optional> SenseApiManager::getSenseApiLib( - const std::string& libraryPath) +std::optional> +SenseApiManager::getSenseApiLib(const std::string& libraryPath) { auto it = std::find_if(senseApiLibs.begin(), senseApiLibs.end(), [&libPath = libraryPath](const std::unique_ptr& lib) { @@ -60,39 +60,5 @@ void SenseApiManager::unloadSenseApiLib(const std::string& libraryPath) << libraryPath << '\n'; } -void SenseApiManager::registerSenseApi(const SenseApiInstance& apiInstance) -{ - auto it = std::find_if( - senseApiInstances.begin(), senseApiInstances.end(), - [&apiInstance](const std::unique_ptr& instance) { - return const_cast(*instance) == apiInstance; - } - ); - - if (it != senseApiInstances.end()) - { - std::cerr << std::string(__func__) - + ": Sense API Instance already registered.\n"; - return; - } - - senseApiInstances.push_back(std::make_unique(apiInstance)); -} - -void SenseApiManager::unregisterSenseApi(const SenseApiInstance& apiInstance) -{ - auto it = std::find_if( - senseApiInstances.begin(), senseApiInstances.end(), - [&apiInstance](const std::unique_ptr& instance) { - return const_cast(*instance) == apiInstance; - } - ); - - if (it == senseApiInstances.end()) - { - std::cerr << std::string(__func__) + ": Sense API Instance not found.\n"; - return; - } - - senseApiInstances.erase(it); -} +} // namespace sense_api +} // namespace hk diff --git a/include/user/senseApiDesc.h b/include/user/senseApiDesc.h new file mode 100644 index 0000000..84c543f --- /dev/null +++ b/include/user/senseApiDesc.h @@ -0,0 +1,24 @@ +#ifndef __USER_SENSE_API_LIB_H__ +#define __USER_SENSE_API_LIB_H__ + +#define HK_SENSE_API_DESC_GETTER_FN_NAME "getSenseApiDescriptor" + +/* Exported by all sense API Libraries to tell Harikoff what API the lib uses + * to connect to providers; and also to state which implexor APIs it exports. + */ +struct CExportedImplexorApiDesc +{ + const char *name; +}; + +struct CSenseApiDesc +{ + /* Shortname that identifies the API used by this lib to talk to the sense + * provider. + */ + const char *name; + // These are the implexors whose APIs this lib exports. + CExportedImplexorApiDesc *exportedImplexorApis; +}; + +#endif // __USER_SENSE_API_LIB_H__