zathura/document.h

/* See LICENSE file for license and copyright information */

#ifndef DOCUMENT_H
#define DOCUMENT_H

#include <gtk/gtk.h>
#include <stdbool.h>

#include <girara-datastructures.h>

#define PLUGIN_DIR "/usr/lib/zathura"
#define PLUGIN_REGISTER_FUNCTION "plugin_register"

typedef struct zathura_list_s zathura_list_t;
typedef struct zathura_document_s zathura_document_t;

typedef bool (*zathura_document_open_t)(zathura_document_t* document);

/**
 * Document plugin structure
 */
typedef struct zathura_document_plugin_s
{
  char* file_extension; /**> File extension */
  zathura_document_open_t open_function; /**> Document open function */
  void* handle; /**> DLL handle */
  struct zathura_document_plugin_s *next; /**> Next plugin */ // TODO: Use list_t
} zathura_document_plugin_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*);

/**
 * Structure for a list
 */
struct zathura_list_s
{
  void* data; /**> Data value */
  struct zathura_list_s* next; /**> Next element in the list */
};

/**
 * Rectangle structure
 */
typedef struct zathura_rectangle_s
{
  double x1; /**> X coordinate of point 1 */
  double y1; /**> Y coordinate of point 1 */
  double x2; /**> X coordinate of point 2 */
  double y2; /**> Y coordinate of point 2 */
} zathura_rectangle_t;

/**
 * Possible link types
 */
typedef enum zathura_link_type_e
{
  ZATHURA_LINK_TO_PAGE, /**> Links to a page */
  ZATHURA_LINK_EXTERNAL, /**> Links to an external source */
} zathura_link_type_t;

/**
 * Link
 */
typedef struct zathura_link_s
{
  zathura_rectangle_t position; /**> Position of the link */
  zathura_link_type_t type; /**> Link type */
  union
  {
    unsigned int page_number; /**> Page number */
    char* value; /**> Value */
  } target;
} zathura_link_t;

/**
 * Index element
 */
typedef struct zathura_index_element_s
{
  char* title; /**> Title of the element */
  zathura_link_type_t type; /**> Type */
  union
  {
    unsigned int page_number; /**> Page number */
    char* uri; /**> Uri */
  } target;
} zathura_index_element_t;

/**
 * Form type
 */
typedef enum zathura_form_type_e
{
  ZATHURA_FORM_CHECKBOX, /**> Checkbox */
  ZATHURA_FORM_TEXTFIELD /**> Textfield */
} zathura_form_type_t;

/**
 * Form element
 */
typedef struct zathura_form_s
{
  zathura_rectangle_t position; /**> Position */
  zathura_form_type_t type; /**> Type */
} zathura_form_t;

/**
 * Page
 */
typedef struct zathura_page_s
{
  double height; /**> Page height */
  double width; /**> Page width */
  double offset; /**> Page offset */
  unsigned int number; /**> Page number */
  zathura_document_t* document; /**> Document */
  void* data; /**> Custom data */
  bool rendered; /**> Page has been rendered */
  GStaticMutex lock; /**> Lock */
} zathura_page_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 */
  int rotate; /**> Rotation */
  void* data; /**> Custom data */

  struct
  {
    /**
     * Frees the document
     *
     * @param document The document
     */
    bool (*document_free)(zathura_document_t* document);

    /**
     * Generates the document index
     *
     * @param document The document
     * @return NULL if an error occured or no index exists
     */
    girara_tree_node_t* (*document_index_generate)(zathura_document_t* document);

    /**
     * Save the document
     *
     * @param document The document
     * @param path The new path
     * @return true if no error occured
     */
    bool (*document_save_as)(zathura_document_t* document, const char* path);

    /**
     * Get list of attachments
     *
     * @param document The document
     * @return NULL if an error occured, otherwise the attachment list
     */
    zathura_list_t* (*document_attachments_get)(zathura_document_t* document);

    /**
     * Gets the page object
     *
     * @param document The document
     * @param page_id Number of the page
     * @return The page object or NULL, if an error occured
     */
    zathura_page_t* (*page_get)(zathura_document_t* document, unsigned int page_id);

    /**
     * Search text
     *
     * @param page The page
     * @param text Search item
     * @return List of results
     */
    zathura_list_t* (*page_search_text)(zathura_page_t* page, const char* text);

    /**
     * Get links on a page
     *
     * @param page
     * @return List of links
     */
    zathura_list_t* (*page_links_get)(zathura_page_t* page);

    /**
     * Get form fields
     *
     * @param page
     * @return List of form fields
     */
    zathura_list_t* (*page_form_fields_get)(zathura_page_t* page);

    /**
     * Renders the page
     *
     * @param page
     * @return Rendered page
     */
    GtkWidget* (*page_render)(zathura_page_t* page);

    /**
     * Free page
     *
     * @param page
     * @return true if no error occured, otherwise false
     */
    bool (*page_free)(zathura_page_t* page);
  } functions;

  /**
   * Document pages
   */
  zathura_page_t** pages;
};

/**
 * Load all document plugins
 */
void zathura_document_plugins_load(void);

/**
 * Free all document plugins
 */
void zathura_document_plugins_free(void);

/**
 * Register document plugin
 */
bool zathura_document_plugin_register(zathura_document_plugin_t* new_plugin, void* handle);

/**
 * Open the document
 *
 * @param path Path to the document
 * @param password Password of the document or NULL
 * @return The document object
 */
zathura_document_t* zathura_document_open(const char* path, const char* password);

/**
 * Free the document
 *
 * @param document
 * @return true if no error occured, otherwise false
 */
bool zathura_document_free(zathura_document_t* document);

/**
 * Save the document
 *
 * @param document The document object
 * @param path Path for the saved file
 * @return true if no error occured, otherwise false
 */
bool zathura_document_save_as(zathura_document_t* document, const char* path);

/**
 * Generate the document index
 *
 * @param document The document object
 * @return Generated index
 */

girara_tree_node_t* zathura_document_index_generate(zathura_document_t* document);

/**
 * Get list of attachments
 *
 * @param document The document object
 * @return List of attachments
 */
zathura_list_t* zathura_document_attachments_get(zathura_document_t* document);

/**
 * Free document attachments
 *
 * @param list list of document attachments
 * @return
 */
bool zathura_document_attachments_free(zathura_list_t* list);

/**
 * Get the page object
 *
 * @param document The document
 * @param page_id Page number
 * @return Page object or NULL if an error occured
 */
zathura_page_t* zathura_page_get(zathura_document_t* document, unsigned int page_id);

/**
 * Frees the page object
 *
 * @param page The page object
 * @return true if no error occured, otherwise false
 */
bool zathura_page_free(zathura_page_t* page);

/**
 * Search page
 *
 * @param page The page object
 * @param text Search item
 * @return List of results
 */
zathura_list_t* zathura_page_search_text(zathura_page_t* page, const char* text);

/**
 * Get page links
 *
 * @param page The page object
 * @return List of links
 */
zathura_list_t* zathura_page_links_get(zathura_page_t* page);

/**
 * Free page links
 *
 * @param list List of links
 * @return true if no error occured, otherwise false
 */
bool zathura_page_links_free(zathura_list_t* list);

/**
 * Get list of form fields
 *
 * @param page The page object
 * @return List of form fields
 */
zathura_list_t* zathura_page_form_fields_get(zathura_page_t* page);

/**
 * Free list of form fields
 *
 * @param list List of form fields
 * @return true if no error occured, otherwise false
 */
bool zathura_page_form_fields_free(zathura_list_t* list);

/**
 * Render page
 *
 * @param page The page object
 * @return Rendered page
 */
GtkWidget* zathura_page_render(zathura_page_t* page);

/**
 * Create new index element
 *
 * @param title Title of the index element
 * @return Index element
 */
zathura_index_element_t* zathura_index_element_new(const char* title);

/**
 * Free index element
 *
 * @param index The index element
 */
void zathura_index_element_free(zathura_index_element_t* index);

#endif // DOCUMENT_H