mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2024-12-28 22:35:59 +01:00
148 lines
4 KiB
C
148 lines
4 KiB
C
/* SPDX-License-Identifier: Zlib */
|
|
|
|
#ifndef UTILS_H
|
|
#define UTILS_H
|
|
|
|
#include <stdbool.h>
|
|
#include <gtk/gtk.h>
|
|
#include <girara/types.h>
|
|
|
|
#include "document.h"
|
|
|
|
#define LENGTH(x) (sizeof(x)/sizeof((x)[0]))
|
|
|
|
typedef struct page_offset_s
|
|
{
|
|
int x;
|
|
int y;
|
|
} page_offset_t;
|
|
|
|
/**
|
|
* This function checks if the file has a valid extension. A extension is
|
|
* evaluated as valid if it matches a supported filetype.
|
|
*
|
|
* @param zathura Zathura object
|
|
* @param path The path to the file
|
|
* @return true if the extension is valid, otherwise false
|
|
*/
|
|
bool file_valid_extension(zathura_t* zathura, const char* path);
|
|
|
|
/**
|
|
* Generates the document index based upon the list retrieved from the document
|
|
* object.
|
|
*
|
|
* @param model The tree model
|
|
* @param parent The tree iterator parent
|
|
* @param tree The Tree iterator
|
|
*/
|
|
void document_index_build(GtkTreeModel* model, GtkTreeIter* parent, girara_tree_node_t* tree);
|
|
|
|
/**
|
|
* Rotate a rectangle by 0, 90, 180 or 270 degree
|
|
*
|
|
* @param rectangle the rectangle to rotate
|
|
* @param degree rotation degree
|
|
* @param height the height of the enclosing rectangle
|
|
* @param width the width of the enclosing rectangle
|
|
* @return the rotated rectangle
|
|
*/
|
|
zathura_rectangle_t rotate_rectangle(zathura_rectangle_t rectangle, unsigned int degree, double height, double width);
|
|
|
|
/**
|
|
* Calculates the new coordinates based on the rotation and scale level of the
|
|
* document for the given rectangle
|
|
*
|
|
* @param page Page where the rectangle should be
|
|
* @param rectangle The rectangle
|
|
* @return New rectangle
|
|
*/
|
|
zathura_rectangle_t recalc_rectangle(zathura_page_t* page, zathura_rectangle_t rectangle);
|
|
|
|
/**
|
|
* Returns the page widget of the page
|
|
*
|
|
* @param zathura The zathura instance
|
|
* @param page The page object
|
|
* @return The page widget of the page
|
|
* @return NULL if an error occurred
|
|
*/
|
|
GtkWidget* zathura_page_get_widget(zathura_t* zathura, zathura_page_t* page);
|
|
|
|
/**
|
|
* Set if the search results should be drawn or not
|
|
*
|
|
* @param zathura Zathura instance
|
|
* @param value true if they should be drawn, otherwise false
|
|
*/
|
|
void document_draw_search_results(zathura_t* zathura, bool value);
|
|
|
|
/**
|
|
* Create zathura version string
|
|
*
|
|
* @param zathura The zathura instance
|
|
* @param markup Enable markup
|
|
* @return Version string
|
|
*/
|
|
char* zathura_get_version_string(zathura_t* zathura, bool markup);
|
|
|
|
/**
|
|
* Get a pointer to the GdkAtom of the current clipboard.
|
|
*
|
|
* @param zathura The zathura instance
|
|
*
|
|
* @return A pointer to a GdkAtom object correspoinding to the current
|
|
* clipboard, or NULL.
|
|
*/
|
|
GdkAtom* get_selection(zathura_t* zathura);
|
|
|
|
/**
|
|
* Returns the valid zoom value which needs to lie in the interval of zoom_min
|
|
* and zoom_max specified in the girara session
|
|
*
|
|
* @param[in] session The session
|
|
* @param[in] zoom The proposed zoom value
|
|
*
|
|
* @return The corrected zoom value
|
|
*/
|
|
double zathura_correct_zoom_value(girara_session_t* session, const double
|
|
zoom);
|
|
|
|
/**
|
|
* Extracts the column the first page should be rendered in from the specified
|
|
* list of settings corresponding to the specified pages per row
|
|
*
|
|
* @param[in] first_page_column_list The settings list
|
|
* @param[in] pages_per_row The current pages per row
|
|
*
|
|
* @return The column the first page should be rendered in
|
|
*/
|
|
unsigned int find_first_page_column(const char* first_page_column_list,
|
|
const unsigned int pages_per_row);
|
|
|
|
/**
|
|
* Parse color string and print warning if color cannot be parsed.
|
|
*
|
|
* @param[out] color The color
|
|
* @param[in] str Color string
|
|
*
|
|
* @return True if color string can be parsed, false otherwise.
|
|
*/
|
|
bool parse_color(GdkRGBA* color, const char* str);
|
|
|
|
/**
|
|
* Check if zathura is running under the Linux subsystem on Windows.
|
|
*
|
|
* @return true if running under WSL, false otherwise
|
|
*/
|
|
bool running_under_wsl(void);
|
|
|
|
/**
|
|
* Flatten list of overlapping rectangles.
|
|
*
|
|
* @param[in] rectangles A list of rectangles
|
|
*
|
|
* @return List of rectangles
|
|
*/
|
|
girara_list_t* flatten_rectangles(girara_list_t* rectangles);
|
|
|
|
#endif // UTILS_H
|