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;
69 typedef struct _EvDocumentBackendInfo EvDocumentBackendInfo;
70 struct _EvDocumentBackendInfo
80 EvDocumentPrivate *priv;
83 struct _EvDocumentClass
85 GObjectClass base_class;
88 gboolean (* load) (EvDocument *document,
91 gboolean (* save) (EvDocument *document,
94 gint (* get_n_pages) (EvDocument *document);
95 EvPage * (* get_page) (EvDocument *document,
97 void (* get_page_size) (EvDocument *document,
101 gchar * (* get_page_label) (EvDocument *document,
103 cairo_surface_t * (* render) (EvDocument *document,
104 EvRenderContext *rc);
105 EvDocumentInfo * (* get_info) (EvDocument *document);
106 gboolean (* get_backend_info)(EvDocument *document,
107 EvDocumentBackendInfo *info);
110 GType ev_document_get_type (void) G_GNUC_CONST;
111 GQuark ev_document_error_quark (void);
114 GMutex *ev_document_get_doc_mutex (void);
115 void ev_document_doc_mutex_lock (void);
116 void ev_document_doc_mutex_unlock (void);
117 gboolean ev_document_doc_mutex_trylock (void);
119 /* FontConfig mutex */
120 GMutex *ev_document_get_fc_mutex (void);
121 void ev_document_fc_mutex_lock (void);
122 void ev_document_fc_mutex_unlock (void);
123 gboolean ev_document_fc_mutex_trylock (void);
125 EvDocumentInfo *ev_document_get_info (EvDocument *document);
126 gboolean ev_document_get_backend_info (EvDocument *document,
127 EvDocumentBackendInfo *info);
128 gboolean ev_document_load (EvDocument *document,
131 gboolean ev_document_save (EvDocument *document,
134 gint ev_document_get_n_pages (EvDocument *document);
135 EvPage *ev_document_get_page (EvDocument *document,
137 void ev_document_get_page_size (EvDocument *document,
141 gchar *ev_document_get_page_label (EvDocument *document,
143 cairo_surface_t *ev_document_render (EvDocument *document,
144 EvRenderContext *rc);
145 const gchar *ev_document_get_uri (EvDocument *document);
146 const gchar *ev_document_get_title (EvDocument *document);
147 gboolean ev_document_is_page_size_uniform (EvDocument *document);
148 void ev_document_get_max_page_size (EvDocument *document,
151 gboolean ev_document_check_dimensions (EvDocument *document);
152 gint ev_document_get_max_label_len (EvDocument *document);
153 gboolean ev_document_has_text_page_labels (EvDocument *document);
154 gboolean ev_document_find_page_by_label (EvDocument *document,
155 const gchar *page_label,
158 gint ev_rect_cmp (EvRectangle *a,
161 #define EV_TYPE_RECTANGLE (ev_rectangle_get_type ())
170 GType ev_rectangle_get_type (void) G_GNUC_CONST;
171 EvRectangle *ev_rectangle_new (void);
172 EvRectangle *ev_rectangle_copy (EvRectangle *ev_rect);
173 void ev_rectangle_free (EvRectangle *ev_rect);
175 /* convenience macro to ease interface addition in the CODE
176 * section of EV_BACKEND_REGISTER_WITH_CODE (this macro relies on
177 * the g_define_type_id present within EV_BACKEND_REGISTER_WITH_CODE()).
179 * EV_BACKEND_REGISTER_WITH_CODE (PdfDocument, pdf_document,
180 * EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
181 * pdf_document_document_thumbnails_iface_init));
183 #define EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
184 const GInterfaceInfo g_implement_interface_info = { \
185 (GInterfaceInitFunc) iface_init, NULL, NULL \
187 g_type_module_add_interface (module, \
190 &g_implement_interface_info); \
194 * Utility macro used to register backends
196 * use: EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)
198 #define EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE) \
200 static GType g_define_type_id = 0; \
203 backend_name##_get_type (void) \
205 return g_define_type_id; \
208 static void backend_name##_init (BackendName *self); \
209 static void backend_name##_class_init (BackendName##Class *klass); \
210 static gpointer backend_name##_parent_class = NULL; \
211 static void backend_name##_class_intern_init (gpointer klass) \
213 backend_name##_parent_class = g_type_class_peek_parent (klass); \
214 backend_name##_class_init ((BackendName##Class *) klass); \
217 G_MODULE_EXPORT GType \
218 register_evince_backend (GTypeModule *module) \
220 const GTypeInfo our_info = { \
221 sizeof (BackendName##Class), \
222 NULL, /* base_init */ \
223 NULL, /* base_finalize */ \
224 (GClassInitFunc) backend_name##_class_intern_init, \
226 NULL, /* class_data */ \
227 sizeof (BackendName), \
228 0, /* n_preallocs */ \
229 (GInstanceInitFunc) backend_name##_init \
232 /* Initialise the i18n stuff */ \
233 bindtextdomain (GETTEXT_PACKAGE, GNOMELOCALEDIR); \
234 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); \
236 g_define_type_id = g_type_module_register_type (module, \
244 return g_define_type_id; \
248 * Utility macro used to register backend
250 * use: EV_BACKEND_REGISTER(BackendName, backend_name)
252 #define EV_BACKEND_REGISTER(BackendName, backend_name) \
253 EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)
256 * A convenience macro for boxed type implementations, which defines a
257 * type_name_get_type() function registering the boxed type.
259 #define EV_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) \
261 type_name##_get_type (void) \
263 static volatile gsize g_define_type_id__volatile = 0; \
264 if (g_once_init_enter (&g_define_type_id__volatile)) { \
265 GType g_define_type_id = \
266 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
267 (GBoxedCopyFunc) copy_func, \
268 (GBoxedFreeFunc) free_func); \
269 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
271 return g_define_type_id__volatile; \
274 /* A convenience macro for GTypeInterface definitions, which declares
275 * a default vtable initialization function and defines a *_get_type()
278 * The macro expects the interface initialization function to have the
279 * name <literal>t_n ## _default_init</literal>, and the interface
280 * structure to have the name <literal>TN ## Interface</literal>.
282 #define EV_DEFINE_INTERFACE(TypeName, type_name, TYPE_PREREQ) \
283 static void type_name##_class_init (TypeName##Iface *klass); \
286 type_name##_get_type (void) \
288 static volatile gsize g_define_type_id__volatile = 0; \
289 if (g_once_init_enter (&g_define_type_id__volatile)) { \
290 GType g_define_type_id = \
291 g_type_register_static_simple (G_TYPE_INTERFACE, \
292 g_intern_static_string (#TypeName), \
293 sizeof (TypeName##Iface), \
294 (GClassInitFunc)type_name##_class_init, \
296 (GInstanceInitFunc)NULL, \
299 g_type_interface_add_prerequisite (g_define_type_id, TYPE_PREREQ); \
300 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
302 return g_define_type_id__volatile; \
306 * A convenience macro for boxed type implementations, which defines a
307 * type_name_get_type() function registering the boxed type.
309 #define EV_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) \
311 type_name##_get_type (void) \
313 static volatile gsize g_define_type_id__volatile = 0; \
314 if (g_once_init_enter (&g_define_type_id__volatile)) { \
315 GType g_define_type_id = \
316 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
317 (GBoxedCopyFunc) copy_func, \
318 (GBoxedFreeFunc) free_func); \
319 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
321 return g_define_type_id__volatile; \
326 #endif /* EV_DOCUMENT_H */