mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2024-12-28 07:06:02 +01:00
105 lines
2.8 KiB
C
105 lines
2.8 KiB
C
/* See LICENSE file for license and copyright information */
|
|
|
|
#ifndef PLUGIN_H
|
|
#define PLUGIN_H
|
|
|
|
#include <girara/types.h>
|
|
#include <gmodule.h>
|
|
|
|
#include "types.h"
|
|
#include "plugin-api.h"
|
|
#include "version.h"
|
|
#include "zathura.h"
|
|
|
|
#define PLUGIN_REGISTER_FUNCTION "zathura_plugin_register"
|
|
#define PLUGIN_API_VERSION_FUNCTION "zathura_plugin_api_version"
|
|
#define PLUGIN_ABI_VERSION_FUNCTION "zathura_plugin_abi_version"
|
|
#define PLUGIN_VERSION_MAJOR_FUNCTION "zathura_plugin_version_major"
|
|
#define PLUGIN_VERSION_MINOR_FUNCTION "zathura_plugin_version_minor"
|
|
#define PLUGIN_VERSION_REVISION_FUNCTION "zathura_plugin_version_revision"
|
|
|
|
typedef struct zathura_plugin_version_s {
|
|
unsigned int major; /**< Major */
|
|
unsigned int minor; /**< Minor */
|
|
unsigned int rev; /**< Revision */
|
|
} zathura_plugin_version_t;
|
|
|
|
/**
|
|
* Creates a new instance of the plugin manager
|
|
*
|
|
* @return A plugin manager object or NULL if an error occured
|
|
*/
|
|
zathura_plugin_manager_t* zathura_plugin_manager_new();
|
|
|
|
/**
|
|
* Frees the plugin manager
|
|
*
|
|
* @param plugin_manager
|
|
*/
|
|
void zathura_plugin_manager_free(zathura_plugin_manager_t* plugin_manager);
|
|
|
|
/**
|
|
* Adds a plugin directory to the plugin manager
|
|
*
|
|
* @param plugin_manager The plugin manager
|
|
* @param dir Path to a directory with plugins
|
|
*/
|
|
void zathura_plugin_manager_add_dir(zathura_plugin_manager_t* plugin_manager, const char* dir);
|
|
|
|
/**
|
|
* Loads all plugins available in the previously given directories
|
|
*
|
|
* @param plugin_manager The plugin manager
|
|
*/
|
|
void zathura_plugin_manager_load(zathura_plugin_manager_t* plugin_manager);
|
|
|
|
/**
|
|
* Returns the (if available) associated plugin
|
|
*
|
|
* @param plugin_manager The plugin manager
|
|
* @param type The document type
|
|
* @return The plugin or NULL if no matching plugin is available
|
|
*/
|
|
zathura_plugin_t* zathura_plugin_manager_get_plugin(zathura_plugin_manager_t* plugin_manager, const char* type);
|
|
|
|
/**
|
|
* Returns a list with the plugin objects
|
|
*
|
|
* @param plugin_manager The plugin manager
|
|
* @return List of plugins or NULL
|
|
*/
|
|
girara_list_t* zathura_plugin_manager_get_plugins(zathura_plugin_manager_t* plugin_manager);
|
|
|
|
/**
|
|
* Returns the plugin functions
|
|
*
|
|
* @param plugin The plugin
|
|
* @return The plugin functions
|
|
*/
|
|
zathura_plugin_functions_t* zathura_plugin_get_functions(zathura_plugin_t* plugin);
|
|
|
|
/**
|
|
* Returns the name of the plugin
|
|
*
|
|
* @param plugin The plugin
|
|
* @return The name of the plugin or NULL
|
|
*/
|
|
char* zathura_plugin_get_name(zathura_plugin_t* plugin);
|
|
|
|
/**
|
|
* Returns the path to the plugin
|
|
*
|
|
* @param plugin The plugin
|
|
* @return The path of the plugin or NULL
|
|
*/
|
|
char* zathura_plugin_get_path(zathura_plugin_t* plugin);
|
|
|
|
/**
|
|
* Returns the version information of the plugin
|
|
*
|
|
* @param plugin The plugin
|
|
* @return The version information of the plugin
|
|
*/
|
|
zathura_plugin_version_t zathura_plugin_get_version(zathura_plugin_t* plugin);
|
|
|
|
#endif // PLUGIN_H
|