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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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;
73 EvDocumentPrivate *priv;
76 struct _EvDocumentClass
78 GObjectClass base_class;
81 gboolean (* load) (EvDocument *document,
84 gboolean (* save) (EvDocument *document,
87 gint (* get_n_pages) (EvDocument *document);
88 EvPage * (* get_page) (EvDocument *document,
90 void (* get_page_size) (EvDocument *document,
94 gchar * (* get_page_label) (EvDocument *document,
96 cairo_surface_t * (* render) (EvDocument *document,
98 EvDocumentInfo * (* get_info) (EvDocument *document);
101 GType ev_document_get_type (void) G_GNUC_CONST;
102 GQuark ev_document_error_quark (void);
105 GMutex *ev_document_get_doc_mutex (void);
106 void ev_document_doc_mutex_lock (void);
107 void ev_document_doc_mutex_unlock (void);
108 gboolean ev_document_doc_mutex_trylock (void);
110 /* FontConfig mutex */
111 GMutex *ev_document_get_fc_mutex (void);
112 void ev_document_fc_mutex_lock (void);
113 void ev_document_fc_mutex_unlock (void);
114 gboolean ev_document_fc_mutex_trylock (void);
116 EvDocumentInfo *ev_document_get_info (EvDocument *document);
117 gboolean ev_document_load (EvDocument *document,
120 gboolean ev_document_save (EvDocument *document,
123 gint ev_document_get_n_pages (EvDocument *document);
124 EvPage *ev_document_get_page (EvDocument *document,
126 void ev_document_get_page_size (EvDocument *document,
130 gchar *ev_document_get_page_label (EvDocument *document,
132 cairo_surface_t *ev_document_render (EvDocument *document,
133 EvRenderContext *rc);
134 const gchar *ev_document_get_uri (EvDocument *document);
135 const gchar *ev_document_get_title (EvDocument *document);
136 gboolean ev_document_is_page_size_uniform (EvDocument *document);
137 void ev_document_get_max_page_size (EvDocument *document,
140 gboolean ev_document_check_dimensions (EvDocument *document);
141 gint ev_document_get_max_label_len (EvDocument *document);
142 gboolean ev_document_has_text_page_labels (EvDocument *document);
143 gboolean ev_document_find_page_by_label (EvDocument *document,
144 const gchar *page_label,
147 gint ev_rect_cmp (EvRectangle *a,
150 #define EV_TYPE_RECTANGLE (ev_rectangle_get_type ())
159 GType ev_rectangle_get_type (void) G_GNUC_CONST;
160 EvRectangle *ev_rectangle_new (void);
161 EvRectangle *ev_rectangle_copy (EvRectangle *ev_rect);
162 void ev_rectangle_free (EvRectangle *ev_rect);
164 /* convenience macro to ease interface addition in the CODE
165 * section of EV_BACKEND_REGISTER_WITH_CODE (this macro relies on
166 * the g_define_type_id present within EV_BACKEND_REGISTER_WITH_CODE()).
168 * EV_BACKEND_REGISTER_WITH_CODE (PdfDocument, pdf_document,
169 * EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
170 * pdf_document_document_thumbnails_iface_init));
172 #define EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
173 const GInterfaceInfo g_implement_interface_info = { \
174 (GInterfaceInitFunc) iface_init, NULL, NULL \
176 g_type_module_add_interface (module, \
179 &g_implement_interface_info); \
183 * Utility macro used to register backends
185 * use: EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)
187 #define EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE) \
189 static GType g_define_type_id = 0; \
192 backend_name##_get_type (void) \
194 return g_define_type_id; \
197 static void backend_name##_init (BackendName *self); \
198 static void backend_name##_class_init (BackendName##Class *klass); \
199 static gpointer backend_name##_parent_class = NULL; \
200 static void backend_name##_class_intern_init (gpointer klass) \
202 backend_name##_parent_class = g_type_class_peek_parent (klass); \
203 backend_name##_class_init ((BackendName##Class *) klass); \
206 G_MODULE_EXPORT GType \
207 register_evince_backend (GTypeModule *module) \
209 const GTypeInfo our_info = { \
210 sizeof (BackendName##Class), \
211 NULL, /* base_init */ \
212 NULL, /* base_finalize */ \
213 (GClassInitFunc) backend_name##_class_intern_init, \
215 NULL, /* class_data */ \
216 sizeof (BackendName), \
217 0, /* n_preallocs */ \
218 (GInstanceInitFunc) backend_name##_init \
221 /* Initialise the i18n stuff */ \
222 bindtextdomain (GETTEXT_PACKAGE, GNOMELOCALEDIR); \
223 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); \
225 g_define_type_id = g_type_module_register_type (module, \
233 return g_define_type_id; \
237 * Utility macro used to register backend
239 * use: EV_BACKEND_REGISTER(BackendName, backend_name)
241 #define EV_BACKEND_REGISTER(BackendName, backend_name) \
242 EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)
245 * A convenience macro for boxed type implementations, which defines a
246 * type_name_get_type() function registering the boxed type.
248 #define EV_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) \
250 type_name##_get_type (void) \
252 static volatile gsize g_define_type_id__volatile = 0; \
253 if (g_once_init_enter (&g_define_type_id__volatile)) { \
254 GType g_define_type_id = \
255 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
256 (GBoxedCopyFunc) copy_func, \
257 (GBoxedFreeFunc) free_func); \
258 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
260 return g_define_type_id__volatile; \
263 /* A convenience macro for GTypeInterface definitions, which declares
264 * a default vtable initialization function and defines a *_get_type()
267 * The macro expects the interface initialization function to have the
268 * name <literal>t_n ## _default_init</literal>, and the interface
269 * structure to have the name <literal>TN ## Interface</literal>.
271 #define EV_DEFINE_INTERFACE(TypeName, type_name, TYPE_PREREQ) \
272 static void type_name##_class_init (TypeName##Iface *klass); \
275 type_name##_get_type (void) \
277 static volatile gsize g_define_type_id__volatile = 0; \
278 if (g_once_init_enter (&g_define_type_id__volatile)) { \
279 GType g_define_type_id = \
280 g_type_register_static_simple (G_TYPE_INTERFACE, \
281 g_intern_static_string (#TypeName), \
282 sizeof (TypeName##Iface), \
283 (GClassInitFunc)type_name##_class_init, \
285 (GInstanceInitFunc)NULL, \
288 g_type_interface_add_prerequisite (g_define_type_id, TYPE_PREREQ); \
289 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
291 return g_define_type_id__volatile; \
295 * A convenience macro for boxed type implementations, which defines a
296 * type_name_get_type() function registering the boxed type.
298 #define EV_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) \
300 type_name##_get_type (void) \
302 static volatile gsize g_define_type_id__volatile = 0; \
303 if (g_once_init_enter (&g_define_type_id__volatile)) { \
304 GType g_define_type_id = \
305 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
306 (GBoxedCopyFunc) copy_func, \
307 (GBoxedFreeFunc) free_func); \
308 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
310 return g_define_type_id__volatile; \
315 #endif /* EV_DOCUMENT_H */