1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
3 * Copyright (C) 2009 Carlos Garcia Campos
4 * Copyright (C) 2000-2003 Marco Pesenti Gritti
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
24 #error "Only <evince-document.h> can be included directly."
30 #include <glib-object.h>
35 #include "ev-document-info.h"
37 #include "ev-render-context.h"
41 #define EV_TYPE_DOCUMENT (ev_document_get_type ())
42 #define EV_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
43 #define EV_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentClass))
44 #define EV_IS_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
45 #define EV_IS_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
46 #define EV_DOCUMENT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), EV_TYPE_DOCUMENT, EvDocumentClass))
48 typedef struct _EvDocument EvDocument;
49 typedef struct _EvDocumentClass EvDocumentClass;
50 typedef struct _EvDocumentPrivate EvDocumentPrivate;
52 #define EV_DOCUMENT_ERROR ev_document_error_quark ()
53 #define EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())
54 #define EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())
58 EV_DOCUMENT_ERROR_INVALID,
59 EV_DOCUMENT_ERROR_ENCRYPTED
67 typedef struct _EvRectangle EvRectangle;
68 typedef struct _EvMapping EvMapping;
70 typedef struct _EvDocumentBackendInfo EvDocumentBackendInfo;
71 struct _EvDocumentBackendInfo
78 const gchar *filename;
87 EvDocumentPrivate *priv;
90 struct _EvDocumentClass
92 GObjectClass base_class;
95 gboolean (* load) (EvDocument *document,
98 gboolean (* save) (EvDocument *document,
101 gint (* get_n_pages) (EvDocument *document);
102 EvPage * (* get_page) (EvDocument *document,
104 void (* get_page_size) (EvDocument *document,
108 gchar * (* get_page_label) (EvDocument *document,
110 cairo_surface_t * (* render) (EvDocument *document,
111 EvRenderContext *rc);
112 EvDocumentInfo * (* get_info) (EvDocument *document);
113 gboolean (* get_backend_info)(EvDocument *document,
114 EvDocumentBackendInfo *info);
115 gboolean (* support_synctex) (EvDocument *document);
118 GType ev_document_get_type (void) G_GNUC_CONST;
119 GQuark ev_document_error_quark (void);
122 GMutex *ev_document_get_doc_mutex (void);
123 void ev_document_doc_mutex_lock (void);
124 void ev_document_doc_mutex_unlock (void);
125 gboolean ev_document_doc_mutex_trylock (void);
127 /* FontConfig mutex */
128 GMutex *ev_document_get_fc_mutex (void);
129 void ev_document_fc_mutex_lock (void);
130 void ev_document_fc_mutex_unlock (void);
131 gboolean ev_document_fc_mutex_trylock (void);
133 EvDocumentInfo *ev_document_get_info (EvDocument *document);
134 gboolean ev_document_get_backend_info (EvDocument *document,
135 EvDocumentBackendInfo *info);
136 gboolean ev_document_load (EvDocument *document,
139 gboolean ev_document_save (EvDocument *document,
142 gint ev_document_get_n_pages (EvDocument *document);
143 EvPage *ev_document_get_page (EvDocument *document,
145 void ev_document_get_page_size (EvDocument *document,
149 gchar *ev_document_get_page_label (EvDocument *document,
151 cairo_surface_t *ev_document_render (EvDocument *document,
152 EvRenderContext *rc);
153 const gchar *ev_document_get_uri (EvDocument *document);
154 const gchar *ev_document_get_title (EvDocument *document);
155 gboolean ev_document_is_page_size_uniform (EvDocument *document);
156 void ev_document_get_max_page_size (EvDocument *document,
159 void ev_document_get_min_page_size (EvDocument *document,
162 gboolean ev_document_check_dimensions (EvDocument *document);
163 gint ev_document_get_max_label_len (EvDocument *document);
164 gboolean ev_document_has_text_page_labels (EvDocument *document);
165 gboolean ev_document_find_page_by_label (EvDocument *document,
166 const gchar *page_label,
168 gboolean ev_document_has_synctex (EvDocument *document);
170 EvSourceLink *ev_document_synctex_backward_search
171 (EvDocument *document,
176 EvMapping *ev_document_synctex_forward_search
177 (EvDocument *document,
178 EvSourceLink *source_link);
180 gint ev_rect_cmp (EvRectangle *a,
183 #define EV_TYPE_RECTANGLE (ev_rectangle_get_type ())
192 GType ev_rectangle_get_type (void) G_GNUC_CONST;
193 EvRectangle *ev_rectangle_new (void);
194 EvRectangle *ev_rectangle_copy (EvRectangle *ev_rect);
195 void ev_rectangle_free (EvRectangle *ev_rect);
202 /* convenience macro to ease interface addition in the CODE
203 * section of EV_BACKEND_REGISTER_WITH_CODE (this macro relies on
204 * the g_define_type_id present within EV_BACKEND_REGISTER_WITH_CODE()).
206 * EV_BACKEND_REGISTER_WITH_CODE (PdfDocument, pdf_document,
207 * EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
208 * pdf_document_document_thumbnails_iface_init));
210 #define EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
211 const GInterfaceInfo g_implement_interface_info = { \
212 (GInterfaceInitFunc) iface_init, NULL, NULL \
214 g_type_module_add_interface (module, \
217 &g_implement_interface_info); \
221 * Utility macro used to register backends
223 * use: EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)
225 #define EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE) \
227 static GType g_define_type_id = 0; \
230 backend_name##_get_type (void) \
232 return g_define_type_id; \
235 static void backend_name##_init (BackendName *self); \
236 static void backend_name##_class_init (BackendName##Class *klass); \
237 static gpointer backend_name##_parent_class = NULL; \
238 static void backend_name##_class_intern_init (gpointer klass) \
240 backend_name##_parent_class = g_type_class_peek_parent (klass); \
241 backend_name##_class_init ((BackendName##Class *) klass); \
244 G_MODULE_EXPORT GType \
245 register_evince_backend (GTypeModule *module) \
247 const GTypeInfo our_info = { \
248 sizeof (BackendName##Class), \
249 NULL, /* base_init */ \
250 NULL, /* base_finalize */ \
251 (GClassInitFunc) backend_name##_class_intern_init, \
253 NULL, /* class_data */ \
254 sizeof (BackendName), \
255 0, /* n_preallocs */ \
256 (GInstanceInitFunc) backend_name##_init \
259 /* Initialise the i18n stuff */ \
260 bindtextdomain (GETTEXT_PACKAGE, GNOMELOCALEDIR); \
261 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); \
263 g_define_type_id = g_type_module_register_type (module, \
271 return g_define_type_id; \
275 * Utility macro used to register backend
277 * use: EV_BACKEND_REGISTER(BackendName, backend_name)
279 #define EV_BACKEND_REGISTER(BackendName, backend_name) \
280 EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)
283 * A convenience macro for boxed type implementations, which defines a
284 * type_name_get_type() function registering the boxed type.
286 #define EV_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) \
288 type_name##_get_type (void) \
290 static volatile gsize g_define_type_id__volatile = 0; \
291 if (g_once_init_enter (&g_define_type_id__volatile)) { \
292 GType g_define_type_id = \
293 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
294 (GBoxedCopyFunc) copy_func, \
295 (GBoxedFreeFunc) free_func); \
296 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
298 return g_define_type_id__volatile; \
303 #endif /* EV_DOCUMENT_H */