Changeset 5488:cd3f4f76a154 in roaraudio for include/libroar/plugincontainer.h

Timestamp:

05/04/12 13:12:31 (12 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

Improved plugincontainer (pr1).

File:

• include/libroar/plugincontainer.h (modified) (2 diffs)

include/libroar/plugincontainer.h

@@ -41 +41 @@
 struct roar_plugincontainer;
 
+struct roar_plugincontainer_callbacks {
+ /* prefree() is called before the container is freed.
+  */
+ int (*prefree)(struct roar_plugincontainer * cont, void ** userdata);
+
+ /* freeuserdata() is called when the userdata needs to be freed.
+  * This is the case then the container is freed.
+  * It is not called when the current userdata is NULL.
+  * If not set or userdata is still non-NULL after this call the userdata
+  * is freed using roar_mm_free().
+  */
+ int (*freeuserdata)(struct roar_plugincontainer * cont, void ** userdata);
+
+ /* freecontext() is called when the context needs to be freed.
+  * It is not called when the current context is NULL.
+  * If not set or context is still non-NULL after this call the context
+  * is freed using roar_mm_free().
+  */
+ int (*freecontext)(struct roar_plugincontainer * cont, void ** context);
+
+ /* preload() and postload() are called before and after a plugin is loaded.
+  */
+ int (*preload) (struct roar_plugincontainer * cont, void ** context,
+                 const char * name, int flags, struct roar_dl_librarypara * para);
+ int (*postload)(struct roar_plugincontainer * cont, void ** context, struct roar_dl_lhandle * lhandle,
+                 const char * name, int flags, struct roar_dl_librarypara * para);
+
+ /* preunload() and postunload() are called before and after a plugin is unloaded.
+  * Those functions are also called if the plugin was loaded but ra_init was not yet done or failed.
+  */
+ int (*preunload) (struct roar_plugincontainer * cont, void ** context, struct roar_dl_lhandle * lhandle);
+ int (*postunload)(struct roar_plugincontainer * cont, void ** context);
+
+ /* prera_init() and postra_init() are called before and after a plugin is ra_init-ed.
+  * This is also true if the plugin is ra_init-ed while being loaded.
+  * Note the limits of roar_plugincontainer_ra_init() if this is used
+  * with roar_plugincontainer_ra_init().
+  * postra_init() is also called in case the ra_init failed.
+  */
+ int (*prera_init) (struct roar_plugincontainer * cont, void ** context, struct roar_dl_lhandle * lhandle,
+                    struct roar_dl_librarypara * para);
+ int (*postra_init)(struct roar_plugincontainer * cont, void ** context, struct roar_dl_lhandle * lhandle,
+                    struct roar_dl_librarypara * para);
+};
+
+struct roar_plugincontainer_plugininfo {
+ /* The name of the plugin.
+  */
+ const char * libname;
+ /* The roardl's library handle.
+  */
+ struct roar_dl_lhandle * handle;
+ /* The number of librarys/plugins depending on this plugin.
+  */
+ size_t rdepends;
+ /* A pointer to the current user context.
+  */
+ void ** context;
+};
+
 /* Create a new plugin container.
  * Takes a default parameter set.
@@ -58 +118 @@
 int roar_plugincontainer_unref(struct roar_plugincontainer * cont);
 
-/* Get a lhandle by name of the loaded plugin
+/* Set callbacks.
+ */
+int roar_plugincontainer_set_callbacks(struct roar_plugincontainer * cont,
+                                       const struct roar_plugincontainer_callbacks * callbacks);
+
+/* Set container's userdata.
+ */
+int roar_plugincontainer_set_userdata(struct roar_plugincontainer * cont, void * userdata);
+
+/* Get container's userdata.
+ */
+void * roar_plugincontainer_get_userdata(struct roar_plugincontainer * cont);
+
+/* Get a lhandle by name of the loaded plugin.
  */
 struct roar_dl_lhandle * roar_plugincontainer_get_lhandle_by_name (struct roar_plugincontainer * cont,
                                                                    const char * name);
+
+/* Get infos about current state of plugin.
+ */
+struct roar_plugincontainer_plugininfo roar_plugincontainer_get_info_by_name (struct roar_plugincontainer * cont,
+                                                                              const char * name);
 
 // plugin loading and unloading: