#include <glib-object.h>
#include <glib.h>
#include <gio/gio.h>
#include <gdk/gdk.h>
#include <cairo.h>
#include "ev-document-info.h"
#include "ev-page.h"
#include "ev-render-context.h"

Include dependency graph for ev-document.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_EvPoint

struct	_EvDocumentBackendInfo

struct	_EvDocument

struct	_EvDocumentClass

struct	_EvRectangle

struct	_EvMapping

struct	_EvSourceLink

Macros
#define	EV_TYPE_DOCUMENT (ev_document_get_type ())

#define	EV_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))

#define	EV_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentClass))

#define	EV_IS_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))

#define	EV_IS_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))

#define	EV_DOCUMENT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), EV_TYPE_DOCUMENT, EvDocumentClass))

#define	EV_DOCUMENT_ERROR ev_document_error_quark ()

#define	EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())

#define	EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())

#define	EV_TYPE_RECTANGLE (ev_rectangle_get_type ())

#define	EV_TYPE_SOURCE_LINK (ev_source_link_get_type ())

#define	EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)

#define	EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)

#define	EV_BACKEND_REGISTER(BackendName, backend_name) EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)

Typedefs
typedef struct _EvDocument	EvDocument

typedef struct _EvDocumentClass	EvDocumentClass

typedef struct _EvDocumentPrivate	EvDocumentPrivate

typedef struct _EvPoint	EvPoint

typedef struct _EvRectangle	EvRectangle

typedef struct _EvMapping	EvMapping

typedef struct _EvSourceLink	EvSourceLink

typedef struct _EvDocumentBackendInfo	EvDocumentBackendInfo

Enumerations
enum	EvDocumentLoadFlags { EV_DOCUMENT_LOAD_FLAG_NONE = 0, EV_DOCUMENT_LOAD_FLAG_NO_CACHE }

enum	EvDocumentError { EV_DOCUMENT_ERROR_INVALID, EV_DOCUMENT_ERROR_ENCRYPTED }

Functions
GType	ev_document_get_type (void) G_GNUC_CONST

GQuark	ev_document_error_quark (void)

GMutex *	ev_document_get_doc_mutex (void)

void	ev_document_doc_mutex_lock (void)

void	ev_document_doc_mutex_unlock (void)

gboolean	ev_document_doc_mutex_trylock (void)

GMutex *	ev_document_get_fc_mutex (void)

void	ev_document_fc_mutex_lock (void)

void	ev_document_fc_mutex_unlock (void)

gboolean	ev_document_fc_mutex_trylock (void)

EvDocumentInfo *	ev_document_get_info (EvDocument *document)

gboolean	ev_document_get_backend_info (EvDocument document, EvDocumentBackendInfo info)

gboolean	ev_document_load (EvDocument document, const char uri, GError **error)

gboolean	ev_document_load_full (EvDocument document, const char uri, EvDocumentLoadFlags flags, GError **error)

gboolean	ev_document_load_stream (EvDocument document, GInputStream stream, EvDocumentLoadFlags flags, GCancellable cancellable, GError *error)

gboolean	ev_document_load_gfile (EvDocument document, GFile file, EvDocumentLoadFlags flags, GCancellable cancellable, GError *error)

gboolean	ev_document_save (EvDocument document, const char uri, GError **error)

gint	ev_document_get_n_pages (EvDocument *document)

EvPage *	ev_document_get_page (EvDocument *document, gint index)

void	ev_document_get_page_size (EvDocument document, gint page_index, double width, double *height)

gchar *	ev_document_get_page_label (EvDocument *document, gint page_index)

cairo_surface_t *	ev_document_render (EvDocument document, EvRenderContext rc)

GdkPixbuf *	ev_document_get_thumbnail (EvDocument document, EvRenderContext rc)

cairo_surface_t *	ev_document_get_thumbnail_surface (EvDocument document, EvRenderContext rc)

guint64	ev_document_get_size (EvDocument *document)

const gchar *	ev_document_get_uri (EvDocument *document)

const gchar *	ev_document_get_title (EvDocument *document)

gboolean	ev_document_is_page_size_uniform (EvDocument *document)

void	ev_document_get_max_page_size (EvDocument document, gdouble width, gdouble *height)

void	ev_document_get_min_page_size (EvDocument document, gdouble width, gdouble *height)

gboolean	ev_document_check_dimensions (EvDocument *document)

gint	ev_document_get_max_label_len (EvDocument *document)

gboolean	ev_document_has_text_page_labels (EvDocument *document)

gboolean	ev_document_find_page_by_label (EvDocument document, const gchar page_label, gint *page_index)

gboolean	ev_document_has_synctex (EvDocument *document)

EvSourceLink *	ev_document_synctex_backward_search (EvDocument *document, gint page_index, gfloat x, gfloat y)

EvMapping *	ev_document_synctex_forward_search (EvDocument document, EvSourceLink source_link)

gint	ev_rect_cmp (EvRectangle a, EvRectangle b)

GType	ev_rectangle_get_type (void) G_GNUC_CONST

EvRectangle *	ev_rectangle_new (void)

EvRectangle *	ev_rectangle_copy (EvRectangle *ev_rect)

void	ev_rectangle_free (EvRectangle *ev_rect)

GType	ev_source_link_get_type (void) G_GNUC_CONST

EvSourceLink *	ev_source_link_new (const gchar *filename, gint line, gint col)

EvSourceLink *	ev_source_link_copy (EvSourceLink *link)

void	ev_source_link_free (EvSourceLink *link)

Macro Definition Documentation

#define EV_BACKEND_IMPLEMENT_INTERFACE	(	TYPE_IFACE,
		iface_init
	)

Value:

{                \
    const GInterfaceInfo g_implement_interface_info = {                     \
        (GInterfaceInitFunc) iface_init, NULL, NULL                     \
    };                                                                      \
    g_type_module_add_interface (module,                                    \
                     g_define_type_id,                          \
                     TYPE_IFACE,                                \
                     &g_implement_interface_info);              \
}

Definition at line 262 of file ev-document.h.

#define EV_BACKEND_REGISTER	(	BackendName,
		backend_name
	)	EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)

Definition at line 331 of file ev-document.h.

#define EV_BACKEND_REGISTER_WITH_CODE	(	BackendName,
		backend_name,
		CODE
	)

Definition at line 277 of file ev-document.h.

#define EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())

Definition at line 54 of file ev-document.h.

#define EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())

Definition at line 55 of file ev-document.h.

#define EV_DOCUMENT ( o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))

Definition at line 43 of file ev-document.h.

#define EV_DOCUMENT_CLASS ( k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentClass))

Definition at line 44 of file ev-document.h.

#define EV_DOCUMENT_ERROR ev_document_error_quark ()

Definition at line 53 of file ev-document.h.

#define EV_DOCUMENT_GET_CLASS ( inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), EV_TYPE_DOCUMENT, EvDocumentClass))

Definition at line 47 of file ev-document.h.

#define EV_IS_DOCUMENT ( o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))

Definition at line 45 of file ev-document.h.

#define EV_IS_DOCUMENT_CLASS ( k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))

Definition at line 46 of file ev-document.h.

#define EV_TYPE_DOCUMENT (ev_document_get_type ())

Definition at line 42 of file ev-document.h.

#define EV_TYPE_RECTANGLE (ev_rectangle_get_type ())

Definition at line 220 of file ev-document.h.

#define EV_TYPE_SOURCE_LINK (ev_source_link_get_type ())

Definition at line 239 of file ev-document.h.

Typedef Documentation

typedef struct _EvDocument EvDocument

Definition at line 49 of file ev-document.h.

typedef struct _EvDocumentBackendInfo EvDocumentBackendInfo

Definition at line 72 of file ev-document.h.

typedef struct _EvDocumentClass EvDocumentClass

Definition at line 50 of file ev-document.h.

typedef struct _EvDocumentPrivate EvDocumentPrivate

Definition at line 51 of file ev-document.h.

typedef struct _EvMapping EvMapping

Definition at line 70 of file ev-document.h.

typedef struct _EvPoint EvPoint

Definition at line 68 of file ev-document.h.

typedef struct _EvRectangle EvRectangle

Definition at line 69 of file ev-document.h.

typedef struct _EvSourceLink EvSourceLink

Definition at line 71 of file ev-document.h.

Enumeration Type Documentation

enum EvDocumentError

Enumerator
EV_DOCUMENT_ERROR_INVALID
EV_DOCUMENT_ERROR_ENCRYPTED

Definition at line 62 of file ev-document.h.

 {
         EV_DOCUMENT_ERROR_INVALID,
         EV_DOCUMENT_ERROR_ENCRYPTED
 } EvDocumentError;

enum EvDocumentLoadFlags

Enumerator
EV_DOCUMENT_LOAD_FLAG_NONE
EV_DOCUMENT_LOAD_FLAG_NO_CACHE

Definition at line 57 of file ev-document.h.

                {
         EV_DOCUMENT_LOAD_FLAG_NONE = 0,
         EV_DOCUMENT_LOAD_FLAG_NO_CACHE
 } EvDocumentLoadFlags;

Function Documentation

gboolean ev_document_check_dimensions ( EvDocument * document)

Definition at line 920 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     return (document->priv->max_width > 0 && document->priv->max_height > 0);
 }

Here is the caller graph for this function:

void ev_document_doc_mutex_lock ( void )

Definition at line 158 of file ev-document.c.

 {
     g_mutex_lock (&ev_doc_mutex);
 }

Here is the caller graph for this function:

gboolean ev_document_doc_mutex_trylock ( void )

Definition at line 170 of file ev-document.c.

 {
     return g_mutex_trylock (&ev_doc_mutex);
 }

Here is the caller graph for this function:

void ev_document_doc_mutex_unlock ( void )

Definition at line 164 of file ev-document.c.

 {
     g_mutex_unlock (&ev_doc_mutex);
 }

Here is the caller graph for this function:

GQuark ev_document_error_quark ( void )

Definition at line 82 of file ev-document.c.

 {
   static GQuark q = 0;
   if (q == 0)
     q = g_quark_from_static_string ("ev-document-error-quark");
 
   return q;
 }

void ev_document_fc_mutex_lock ( void )

Definition at line 176 of file ev-document.c.

 {
     g_mutex_lock (&ev_fc_mutex);
 }

Here is the caller graph for this function:

gboolean ev_document_fc_mutex_trylock ( void )

Definition at line 188 of file ev-document.c.

 {
     return g_mutex_trylock (&ev_fc_mutex);
 }

Here is the caller graph for this function:

void ev_document_fc_mutex_unlock ( void )

Definition at line 182 of file ev-document.c.

 {
     g_mutex_unlock (&ev_fc_mutex);
 }

Here is the caller graph for this function:

gboolean ev_document_find_page_by_label	(	EvDocument *	document,
		const gchar *	page_label,
		gint *	page_index
	)

Definition at line 970 of file ev-document.c.

 {
     gint i, page;
     glong value;
     gchar *endptr = NULL;
     EvDocumentPrivate *priv = document->priv;
 
     g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
     g_return_val_if_fail (page_label != NULL, FALSE);
     g_return_val_if_fail (page_index != NULL, FALSE);
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
         /* First, look for a literal label match */
     for (i = 0; priv->page_labels && i < priv->n_pages; i ++) {
         if (priv->page_labels[i] != NULL &&
             ! strcmp (page_label, priv->page_labels[i])) {
             *page_index = i;
             return TRUE;
         }
     }
 
     /* Second, look for a match with case insensitively */
     for (i = 0; priv->page_labels && i < priv->n_pages; i++) {
         if (priv->page_labels[i] != NULL &&
             ! strcasecmp (page_label, priv->page_labels[i])) {
             *page_index = i;
             return TRUE;
         }
     }
 
     /* Next, parse the label, and see if the number fits */
     value = strtol (page_label, &endptr, 10);
     if (endptr[0] == '\0') {
         /* Page number is an integer */
         page = MIN (G_MAXINT, value);
 
         /* convert from a page label to a page offset */
         page --;
         if (page >= 0 && page < priv->n_pages) {
             *page_index = page;
             return TRUE;
         }
     }
 
     return FALSE;
 }

Here is the caller graph for this function:

gboolean ev_document_get_backend_info	(	EvDocument *	document,
		EvDocumentBackendInfo *	info
	)

Definition at line 771 of file ev-document.c.

 {
     EvDocumentClass *klass;
 
     g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 
     klass = EV_DOCUMENT_GET_CLASS (document);
     if (klass->get_backend_info == NULL)
         return FALSE;
 
     return klass->get_backend_info (document, info);
 }

GMutex* ev_document_get_doc_mutex ( void )

GMutex* ev_document_get_fc_mutex ( void )

EvDocumentInfo* ev_document_get_info ( EvDocument * document)

Definition at line 763 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 
     return document->priv->info;
 }

Here is the caller graph for this function:

gint ev_document_get_max_label_len ( EvDocument * document)

Definition at line 942 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), -1);
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     return document->priv->max_label;
 }

Here is the caller graph for this function:

void ev_document_get_max_page_size	(	EvDocument *	document,
		gdouble *	width,
		gdouble *	height
	)

Definition at line 882 of file ev-document.c.

 {
     g_return_if_fail (EV_IS_DOCUMENT (document));
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     if (width)
         *width = document->priv->max_width;
     if (height)
         *height = document->priv->max_height;
 }

Here is the caller graph for this function:

void ev_document_get_min_page_size	(	EvDocument *	document,
		gdouble *	width,
		gdouble *	height
	)

Definition at line 901 of file ev-document.c.

 {
     g_return_if_fail (EV_IS_DOCUMENT (document));
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     if (width)
         *width = document->priv->min_width;
     if (height)
         *height = document->priv->min_height;
 }

Here is the caller graph for this function:

gint ev_document_get_n_pages ( EvDocument * document)

Definition at line 661 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
 
     return document->priv->n_pages;
 }

EvPage* ev_document_get_page	(	EvDocument *	document,
		gint	index
	)

ev_document_get_page: : a EvDocument : index of page

Returns: (transfer full): Newly created EvPage for the given index.

Definition at line 505 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 
     return klass->get_page (document, index);
 }

Here is the caller graph for this function:

gchar* ev_document_get_page_label	(	EvDocument *	document,
		gint	page_index
	)

Definition at line 730 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
     g_return_val_if_fail (page_index >= 0 || page_index < document->priv->n_pages, NULL);
 
     if (!document->priv->cache_loaded) {
         EvPage *page;
         gchar *page_label;
 
         g_mutex_lock (&ev_doc_mutex);
         page = ev_document_get_page (document, page_index);
         page_label = _ev_document_get_page_label (document, page);
         g_object_unref (page);
         g_mutex_unlock (&ev_doc_mutex);
 
         return page_label ? page_label : g_strdup_printf ("%d", page_index + 1);
     }
 
     return (document->priv->page_labels && document->priv->page_labels[page_index]) ?
         g_strdup (document->priv->page_labels[page_index]) :
         g_strdup_printf ("%d", page_index + 1);
 }

Here is the caller graph for this function:

void ev_document_get_page_size	(	EvDocument *	document,
		gint	page_index,
		double *	width,
		double *	height
	)

ev_document_get_page_size: : a EvDocument : index of page : (out) (allow-none): return location for the width of the page, or NULL : (out) (allow-none): return location for the height of the page, or NULL

Definition at line 687 of file ev-document.c.

 {
     EvDocumentPrivate *priv;
 
     g_return_if_fail (EV_IS_DOCUMENT (document));
     g_return_if_fail (page_index >= 0 || page_index < document->priv->n_pages);
 
     priv = document->priv;
 
     if (priv->cache_loaded) {
         if (width)
             *width = priv->uniform ?
                 priv->uniform_width :
                 priv->page_sizes[page_index].width;
         if (height)
             *height = priv->uniform ?
                 priv->uniform_height :
                 priv->page_sizes[page_index].height;
     } else {
         EvPage *page;
 
         g_mutex_lock (&ev_doc_mutex);
         page = ev_document_get_page (document, page_index);
         _ev_document_get_page_size (document, page, width, height);
         g_object_unref (page);
         g_mutex_unlock (&ev_doc_mutex);
     }
 }

Here is the caller graph for this function:

guint64 ev_document_get_size ( EvDocument * document)

Definition at line 934 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
 
     return document->priv->file_size;
 }

Here is the caller graph for this function:

GdkPixbuf* ev_document_get_thumbnail	(	EvDocument *	document,
		EvRenderContext *	rc
	)

ev_document_get_thumbnail: : an EvDocument : an EvRenderContext

Returns: (transfer full): a #GdkPixbuf

Definition at line 817 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 
     if (klass->get_thumbnail)
         return klass->get_thumbnail (document, rc);
 
     return _ev_document_get_thumbnail (document, rc);
 }

Here is the caller graph for this function:

cairo_surface_t* ev_document_get_thumbnail_surface	(	EvDocument *	document,
		EvRenderContext *	rc
	)

ev_document_get_thumbnail_surface: : an EvDocument : an EvRenderContext

Returns: (transfer full): a #cairo_surface_t

Since: 3.14

Definition at line 838 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 
     if (klass->get_thumbnail_surface)
         return klass->get_thumbnail_surface (document, rc);
 
     return ev_document_render (document, rc);
 }

Here is the caller graph for this function:

const gchar* ev_document_get_title ( EvDocument * document)

Definition at line 859 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 
     return (document->priv->info->fields_mask & EV_DOCUMENT_INFO_TITLE) ?
         document->priv->info->title : NULL;
 }

Here is the caller graph for this function:

GType ev_document_get_type ( void )

const gchar* ev_document_get_uri ( EvDocument * document)

Definition at line 851 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 
     return document->priv->uri;
 }

Here is the caller graph for this function:

gboolean ev_document_has_synctex ( EvDocument * document)

Definition at line 522 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 
     return document->priv->synctex_scanner != NULL;
 }

Here is the caller graph for this function:

gboolean ev_document_has_text_page_labels ( EvDocument * document)

Definition at line 956 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     return document->priv->page_labels != NULL;
 }

Here is the caller graph for this function:

gboolean ev_document_is_page_size_uniform ( EvDocument * document)

Definition at line 868 of file ev-document.c.

 {
     g_return_val_if_fail (EV_IS_DOCUMENT (document), TRUE);
 
     if (!document->priv->cache_loaded) {
         g_mutex_lock (&ev_doc_mutex);
         ev_document_setup_cache (document);
         g_mutex_unlock (&ev_doc_mutex);
     }
 
     return document->priv->uniform;
 }

Here is the caller graph for this function:

gboolean ev_document_load	(	EvDocument *	document,
		const char *	uri,
		GError **	error
	)

ev_document_load: : a EvDocument : the document's URI : a #GError location to store an error, or NULL

Loads from .

On failure, FALSE is returned and is filled in. If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned. If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID is returned. Other errors are possible too, depending on the backend used to load the document and the URI, e.g. #GIOError, #GFileError, and #GConvertError.

Returns: TRUE on success, or FALSE on failure.

Definition at line 369 of file ev-document.c.

 {
     return ev_document_load_full (document, uri,
                       EV_DOCUMENT_LOAD_FLAG_NONE, error);
 }

Here is the caller graph for this function:

gboolean ev_document_load_full	(	EvDocument *	document,
		const char *	uri,
		EvDocumentLoadFlags	flags,
		GError **	error
	)

ev_document_load_full: : a EvDocument : the document's URI : flags from EvDocumentLoadFlags : a #GError location to store an error, or NULL

Loads from .

On failure, FALSE is returned and is filled in. If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned. If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID is returned. Other errors are possible too, depending on the backend used to load the document and the URI, e.g. #GIOError, #GFileError, and #GConvertError.

Returns: TRUE on success, or FALSE on failure.

Definition at line 315 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
     gboolean retval;
     GError *err = NULL;
 
     retval = klass->load (document, uri, &err);
     if (!retval) {
         if (err) {
             g_propagate_error (error, err);
         } else {
             g_warning ("%s::EvDocument::load returned FALSE but did not fill in @error; fix the backend!\n",
                    G_OBJECT_TYPE_NAME (document));
 
             /* So upper layers don't crash */
             g_set_error_literal (error,
                          EV_DOCUMENT_ERROR,
                          EV_DOCUMENT_ERROR_INVALID,
                          "Internal error in backend");
         }
     } else {
         document->priv->info = _ev_document_get_info (document);
         document->priv->n_pages = _ev_document_get_n_pages (document);
         if (!(flags & EV_DOCUMENT_LOAD_FLAG_NO_CACHE))
             ev_document_setup_cache (document);
         document->priv->uri = g_strdup (uri);
         document->priv->file_size = _ev_document_get_size (uri);
         ev_document_initialize_synctex (document, uri);
         }
 
     return retval;
 }

Here is the caller graph for this function:

gboolean ev_document_load_gfile	(	EvDocument *	document,
		GFile *	file,
		EvDocumentLoadFlags	flags,
		GCancellable *	cancellable,
		GError **	error
	)

Definition at line 441 of file ev-document.c.

 {
         EvDocumentClass *klass;
 
         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
         g_return_val_if_fail (G_IS_FILE (file), FALSE);
         g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
         g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 
         klass = EV_DOCUMENT_GET_CLASS (document);
         if (!klass->load_gfile) {
                 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
                                      "Backend does not support loading from GFile");
                 return FALSE;
         }
 
         if (!klass->load_gfile (document, file, flags, cancellable, error))
                 return FALSE;
 
     document->priv->info = _ev_document_get_info (document);
     document->priv->n_pages = _ev_document_get_n_pages (document);
 
         if (!(flags & EV_DOCUMENT_LOAD_FLAG_NO_CACHE))
                 ev_document_setup_cache (document);
 
     document->priv->uri = g_file_get_uri (file);
     document->priv->file_size = _ev_document_get_size_gfile (file);
     ev_document_initialize_synctex (document, document->priv->uri);
 
         return TRUE;
 }

Here is the caller graph for this function:

gboolean ev_document_load_stream	(	EvDocument *	document,
		GInputStream *	stream,
		EvDocumentLoadFlags	flags,
		GCancellable *	cancellable,
		GError **	error
	)

ev_document_load_stream: : a EvDocument : a #GInputStream : flags from EvDocumentLoadFlags : (allow-none): a #GCancellable, or NULL : (allow-none): a #GError location to store an error, or NULL

Synchronously loads the document from . See ev_document_load() for more information.

Returns: TRUE if loading succeeded, or FALSE on error with filled in

Since: 3.6

Definition at line 393 of file ev-document.c.

 {
         EvDocumentClass *klass;
 
         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
         g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
         g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
         g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 
         klass = EV_DOCUMENT_GET_CLASS (document);
         if (!klass->load_stream) {
                 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
                                      "Backend does not support loading from stream");
                 return FALSE;
         }
 
         if (!klass->load_stream (document, stream, flags, cancellable, error))
                 return FALSE;
 
     document->priv->info = _ev_document_get_info (document);
     document->priv->n_pages = _ev_document_get_n_pages (document);
 
         if (!(flags & EV_DOCUMENT_LOAD_FLAG_NO_CACHE))
                 ev_document_setup_cache (document);
 
         return TRUE;
 }

Here is the caller graph for this function:

cairo_surface_t* ev_document_render	(	EvDocument *	document,
		EvRenderContext *	rc
	)

Definition at line 785 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 
     return klass->render (document, rc);
 }

Here is the caller graph for this function:

gboolean ev_document_save	(	EvDocument *	document,
		const char *	uri,
		GError **	error
	)

ev_document_save: : a EvDocument : the target URI : a #GError location to store an error, or NULL

Saves to .

Returns: TRUE on success, or FALSE on error with filled in

Definition at line 488 of file ev-document.c.

 {
     EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 
     return klass->save (document, uri, error);
 }

Here is the caller graph for this function:

EvSourceLink* ev_document_synctex_backward_search	(	EvDocument *	document,
		gint	page_index,
		gfloat	x,
		gfloat	y
	)

Definition at line 545 of file ev-document.c.

 {
         EvSourceLink *result = NULL;
         synctex_scanner_t scanner;
 
         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 
         scanner = document->priv->synctex_scanner;
         if (!scanner)
                 return NULL;
 
         if (synctex_edit_query (scanner, page_index + 1, x, y) > 0) {
                 synctex_node_t node;
 
                 /* We assume that a backward search returns either zero or one result_node */
                 node = synctex_next_result (scanner);
                 if (node != NULL) {
             const gchar *filename;
 
             filename = synctex_scanner_get_name (scanner, synctex_node_tag (node));
             
             if (filename) {
                 result = ev_source_link_new (filename,
                                  synctex_node_line (node),
                                  synctex_node_column (node));
             }
                 }
         }
 
         return result;
 }

Here is the caller graph for this function:

EvMapping* ev_document_synctex_forward_search	(	EvDocument *	document,
		EvSourceLink *	link
	)

ev_document_synctex_forward_search: : a EvDocument : a EvSourceLink

Peforms a Synctex forward search to obtain the area in the document corresponding to the position

Returns: An EvMapping with the page number and area corresponfing to the given line in the source file. It must be free with g_free when done

Definition at line 592 of file ev-document.c.

 {
         EvMapping        *result = NULL;
         synctex_scanner_t scanner;
 
         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 
         scanner = document->priv->synctex_scanner;
         if (!scanner)
                 return NULL;
 
         if (synctex_display_query (scanner, link->filename, link->line, link->col) > 0) {
                 synctex_node_t node;
                 gint           page;
 
                 if ((node = synctex_next_result (scanner))) {
                         result = g_new (EvMapping, 1);
 
                         page = synctex_node_page (node) - 1;
                         result->data = GINT_TO_POINTER (page);
 
                         result->area.x1 = synctex_node_box_visible_h (node);
                         result->area.y1 = synctex_node_box_visible_v (node) -
                                 synctex_node_box_visible_height (node);
                         result->area.x2 = synctex_node_box_visible_width (node) + result->area.x1;
                         result->area.y2 = synctex_node_box_visible_depth (node) +
                                 synctex_node_box_visible_height (node) + result->area.y1;
                 }
         }
 
         return result;
 }

Here is the caller graph for this function:

gint ev_rect_cmp	(	EvRectangle *	a,
		EvRectangle *	b
	)

Definition at line 1213 of file ev-document.c.

 {
     if (a == b)
         return 0;
     if (a == NULL || b == NULL)
         return 1;
 
     return ! ((ABS (a->x1 - b->x1) < EPSILON) &&
           (ABS (a->y1 - b->y1) < EPSILON) &&
           (ABS (a->x2 - b->x2) < EPSILON) &&
           (ABS (a->y2 - b->y2) < EPSILON));
 }

Here is the caller graph for this function:

EvRectangle* ev_rectangle_copy ( EvRectangle * ev_rect)

Definition at line 1191 of file ev-document.c.

 {
     EvRectangle *new_rectangle;
 
     g_return_val_if_fail (rectangle != NULL, NULL);
 
     new_rectangle = g_new (EvRectangle, 1);
     *new_rectangle = *rectangle;
 
     return new_rectangle;
 }

Here is the caller graph for this function:

void ev_rectangle_free ( EvRectangle * ev_rect)

Definition at line 1204 of file ev-document.c.

 {
     g_free (rectangle);
 }

Here is the caller graph for this function:

GType ev_rectangle_get_type ( void )

EvRectangle* ev_rectangle_new ( void )

Definition at line 1185 of file ev-document.c.

 {
     return g_new0 (EvRectangle, 1);
 }

Here is the caller graph for this function:

EvSourceLink* ev_source_link_copy ( EvSourceLink * link)

Definition at line 1042 of file ev-document.c.

 {
     EvSourceLink *copy;
 
     g_return_val_if_fail (link != NULL, NULL);
 
     copy = g_slice_new (EvSourceLink);
 
     *copy = *link;
     copy->filename = g_strdup (link->filename);
 
     return copy;
 }

void ev_source_link_free ( EvSourceLink * link)

Definition at line 1057 of file ev-document.c.

 {
     if (link == NULL)
         return;
 
     g_free (link->filename);
     g_slice_free (EvSourceLink, link);
 }

Here is the caller graph for this function:

GType ev_source_link_get_type ( void )

EvSourceLink* ev_source_link_new	(	const gchar *	filename,
		gint	line,
		gint	col
	)

Definition at line 1028 of file ev-document.c.

 {
     EvSourceLink *link = g_slice_new (EvSourceLink);
 
     link->filename = g_strdup (filename);
     link->line = line;
     link->col = col;
 
     return link;
 }

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation