/* See LICENSE file for license and copyright information */ #ifndef DOCUMENT_H #define DOCUMENT_H #include #include #include #include #include "zathura.h" #include "version.h" #include "types.h" #define PLUGIN_REGISTER_FUNCTION "plugin_register" #define PLUGIN_API_VERSION_FUNCTION "plugin_api_version" #define PLUGIN_ABI_VERSION_FUNCTION "plugin_abi_version" /** * Register a plugin. * * @param plugin_name the name of the plugin * @param major the plugin's major version * @param minor the plugin's minor version * @param rev the plugin's revision * @param plugin_open_function the plugin's open function * @param mimetypes a char array of mime types supported by the plugin */ #define PLUGIN_REGISTER(plugin_name, major, minor, rev, plugin_open_function, mimetypes) \ unsigned int plugin_version_major() { return major; } \ unsigned int plugin_version_minor() { return minor; } \ unsigned int plugin_version_revision() { return rev; } \ unsigned int plugin_api_version() { return ZATHURA_API_VERSION; } \ unsigned int plugin_abi_version() { return ZATHURA_ABI_VERSION; } \ \ void plugin_register(zathura_document_plugin_t* plugin) \ { \ if (plugin == NULL) { \ return; \ } \ plugin->open_function = (plugin_open_function); \ static const char* mime_types[] = mimetypes; \ for (size_t s = 0; s != sizeof(mime_types) / sizeof(const char*); ++s) { \ girara_list_append(plugin->content_types, g_content_type_from_mime_type(mime_types[s])); \ } \ } \ #define PLUGIN_MIMETYPES(...) __VA_ARGS__ /** * Error types for plugins */ typedef enum zathura_plugin_error_e { ZATHURA_PLUGIN_ERROR_OK, /**< No error occured */ ZATHURA_PLUGIN_ERROR_UNKNOWN, /**< An unknown error occured */ ZATHURA_PLUGIN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ ZATHURA_PLUGIN_ERROR_NOT_IMPLEMENTED, /**< The called function has not been implemented */ ZATHURA_PLUGIN_ERROR_INVALID_ARGUMENTS, /**< Invalid arguments have been passed */ ZATHURA_PLUGIN_ERROR_INVALID_PASSWORD /**< The provided password is invalid */ } zathura_plugin_error_t; /** * Document open function * * @param document The document * @return true if no error occured otherwise false */ typedef zathura_plugin_error_t (*zathura_document_open_t)(zathura_document_t* document); /** * Document plugin structure */ typedef struct zathura_document_plugin_s { girara_list_t* content_types; /**< List of supported content types */ zathura_document_open_t open_function; /**< Document open function */ void* handle; /**< DLL handle */ } zathura_document_plugin_t; /** * Plugin mapping */ typedef struct zathura_type_plugin_mapping_s { const gchar* type; /**< Plugin type */ zathura_document_plugin_t* plugin; /**< Mapped plugin */ } zathura_type_plugin_mapping_t; /** * Meta data entries */ typedef enum zathura_document_meta_e { ZATHURA_DOCUMENT_TITLE, /**< Title of the document */ ZATHURA_DOCUMENT_AUTHOR, /**< Author of the document */ ZATHURA_DOCUMENT_SUBJECT, /**< Subject of the document */ ZATHURA_DOCUMENT_KEYWORDS, /**< Keywords of the document */ ZATHURA_DOCUMENT_CREATOR, /**< Creator of the document */ ZATHURA_DOCUMENT_PRODUCER, /**< Producer of the document */ ZATHURA_DOCUMENT_CREATION_DATE, /**< Creation data */ ZATHURA_DOCUMENT_MODIFICATION_DATE /**< Modification data */ } zathura_document_meta_t; typedef struct zathura_password_dialog_info_s { char* path; /**< Path to the file */ zathura_t* zathura; /**< Zathura session */ } zathura_password_dialog_info_t; /** * Function prototype that is called to register a document plugin * * @param The document plugin */ typedef void (*zathura_plugin_register_service_t)(zathura_document_plugin_t*); /** * Function prototype that is called to get the plugin's API version. * * @return plugin's API version */ typedef unsigned int (*zathura_plugin_api_version_t)(); /** * Function prototype that is called to get the ABI version the plugin is built * against. * * @return plugin's ABI version */ typedef unsigned int (*zathura_plugin_abi_version_t)(); /** * Document */ struct zathura_document_s { char* file_path; /**< File path of the document */ const char* password; /**< Password of the document */ unsigned int current_page_number; /**< Current page number */ unsigned int number_of_pages; /**< Number of pages */ double scale; /**< Scale value */ unsigned int rotate; /**< Rotation */ void* data; /**< Custom data */ zathura_t* zathura; /** Zathura object */ int adjust_mode; /**< Adjust mode (best-fit, width) */ unsigned int page_offset; /**< Page offset */ struct { /** * Frees the document */ zathura_plugin_error_t (*document_free)(zathura_document_t* document); /** * Generates the document index */ girara_tree_node_t* (*document_index_generate)(zathura_document_t* document, zathura_plugin_error_t* error); /** * Save the document */ zathura_plugin_error_t (*document_save_as)(zathura_document_t* document, const char* path); /** * Get list of attachments */ girara_list_t* (*document_attachments_get)(zathura_document_t* document, zathura_plugin_error_t* error); /** * Save attachment to a file */ zathura_plugin_error_t (*document_attachment_save)(zathura_document_t* document, const char* attachment, const char* file); /** * Get document information */ char* (*document_meta_get)(zathura_document_t* document, zathura_document_meta_t info, zathura_plugin_error_t* error); /** * Gets the page object */ zathura_plugin_error_t (*page_init)(zathura_page_t* page); /** * Free page */ zathura_plugin_error_t (*page_clear)(zathura_page_t* page); /** * Search text */ girara_list_t* (*page_search_text)(zathura_page_t* page, const char* text, zathura_plugin_error_t* error); /** * Get links on a page */ girara_list_t* (*page_links_get)(zathura_page_t* page, zathura_plugin_error_t* error); /** * Get form fields */ girara_list_t* (*page_form_fields_get)(zathura_page_t* page, zathura_plugin_error_t* error); /** * Get list of images */ girara_list_t* (*page_images_get)(zathura_page_t* page, zathura_plugin_error_t* error); /** * Get the image */ cairo_surface_t* (*page_image_get_cairo)(zathura_page_t* page, zathura_image_t* image, zathura_plugin_error_t* error); /** * Get text for selection */ char* (*page_get_text)(zathura_page_t* page, zathura_rectangle_t rectangle, zathura_plugin_error_t* error); /** * Renders the page */ zathura_image_buffer_t* (*page_render)(zathura_page_t* page, zathura_plugin_error_t* error); /** * Renders the page */ zathura_plugin_error_t (*page_render_cairo)(zathura_page_t* page, cairo_t* cairo, bool printing); } functions; /** * Document pages */ zathura_page_t** pages; }; /** * Load all document plugins * * @param zathura the zathura session */ void zathura_document_plugins_load(zathura_t* zathura); /** * Free a document plugin * * @param plugin The plugin */ void zathura_document_plugin_free(zathura_document_plugin_t* plugin); /** * Open the document * * @param zathura Zathura object * @param path Path to the document * @param password Password of the document or NULL * @return The document object */ zathura_document_t* zathura_document_open(zathura_t* zathura, const char* path, const char* password); /** * Free the document * * @param document * @return ZATHURA_PLUGIN_ERROR_OK when no error occured, otherwise see * zathura_plugin_error_t */ zathura_plugin_error_t zathura_document_free(zathura_document_t* document); /** * Save the document * * @param document The document object * @param path Path for the saved file * @return ZATHURA_PLUGIN_ERROR_OK when no error occured, otherwise see * zathura_plugin_error_t */ zathura_plugin_error_t zathura_document_save_as(zathura_document_t* document, const char* path); /** * Generate the document index * * @param document The document object * @param error Set to an error value (see \ref zathura_plugin_error_t) if an * error occured * @return Generated index */ girara_tree_node_t* zathura_document_index_generate(zathura_document_t* document, zathura_plugin_error_t* error); /** * Get list of attachments * * @param document The document object * @param error Set to an error value (see \ref zathura_plugin_error_t) if an * error occured * @return List of attachments */ girara_list_t* zathura_document_attachments_get(zathura_document_t* document, zathura_plugin_error_t* error); /** * Save document attachment * * @param document The document objects * @param attachment name of the attachment * @param file the target filename * @return ZATHURA_PLUGIN_ERROR_OK when no error occured, otherwise see * zathura_plugin_error_t */ zathura_plugin_error_t zathura_document_attachment_save(zathura_document_t* document, const char* attachment, const char* file); /** * Returns a string of the requested information * * @param document The zathura document * @param meta The information field * @param error Set to an error value (see \ref zathura_plugin_error_t) if an * error occured * @return String or NULL if information could not be retreived */ char* zathura_document_meta_get(zathura_document_t* document, zathura_document_meta_t meta, zathura_plugin_error_t* error); /** * Add type -> plugin mapping * @param zathura zathura instance * @param type content type * @param plugin plugin instance * @return true on success, false if another plugin is already registered for * that type */ bool zathura_type_plugin_mapping_new(zathura_t* zathura, const gchar* type, zathura_document_plugin_t* plugin); /** * Free type -> plugin mapping * @param mapping To be freed */ void zathura_type_plugin_mapping_free(zathura_type_plugin_mapping_t* mapping); #endif // DOCUMENT_H