plugin_manager.h 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. #pragma once
  2. #include <flipper_application/flipper_application.h>
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. /**
  7. * @brief Object that manages plugins for an application
  8. * Implements mass loading of plugins and provides access to their descriptors
  9. */
  10. typedef struct PluginManager PluginManager;
  11. typedef enum {
  12. PluginManagerErrorNone = 0,
  13. PluginManagerErrorLoaderError,
  14. PluginManagerErrorApplicationIdMismatch,
  15. PluginManagerErrorAPIVersionMismatch,
  16. } PluginManagerError;
  17. /**
  18. * @brief Allocates new PluginManager
  19. * @param application_id Application ID filter - only plugins with matching ID will be loaded
  20. * @param api_version Application API version filter - only plugins with matching API version
  21. * @param api_interface Application API interface - used to resolve plugins' API imports
  22. * If plugin uses private application's API, use CompoundApiInterface
  23. * @return new PluginManager instance
  24. */
  25. PluginManager* plugin_manager_alloc(
  26. const char* application_id,
  27. uint32_t api_version,
  28. const ElfApiInterface* api_interface);
  29. /**
  30. * @brief Frees PluginManager
  31. * @param manager PluginManager instance
  32. */
  33. void plugin_manager_free(PluginManager* manager);
  34. /**
  35. * @brief Loads single plugin by full path
  36. * @param manager PluginManager instance
  37. * @param path Path to plugin
  38. * @return Error code
  39. */
  40. PluginManagerError plugin_manager_load_single(PluginManager* manager, const char* path);
  41. /**
  42. * @brief Loads all plugins from specified directory
  43. * @param manager PluginManager instance
  44. * @param path Path to directory
  45. * @return Error code
  46. */
  47. PluginManagerError plugin_manager_load_all(PluginManager* manager, const char* path);
  48. /**
  49. * @brief Returns number of loaded plugins
  50. * @param manager PluginManager instance
  51. * @return Number of loaded plugins
  52. */
  53. uint32_t plugin_manager_get_count(PluginManager* manager);
  54. /**
  55. * @brief Returns plugin descriptor by index
  56. * @param manager PluginManager instance
  57. * @param index Plugin index
  58. * @return Plugin descriptor
  59. */
  60. const FlipperAppPluginDescriptor* plugin_manager_get(PluginManager* manager, uint32_t index);
  61. /**
  62. * @brief Returns plugin entry point by index
  63. * @param manager PluginManager instance
  64. * @param index Plugin index
  65. * @return Plugin entry point
  66. */
  67. const void* plugin_manager_get_ep(PluginManager* manager, uint32_t index);
  68. #ifdef __cplusplus
  69. }
  70. #endif