1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
3 * Copyright (C) 2000-2003 Marco Pesenti Gritti
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <glib-object.h>
30 #include "ev-document-info.h"
32 #include "ev-render-context.h"
36 #define EV_TYPE_DOCUMENT (ev_document_get_type ())
37 #define EV_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
38 #define EV_DOCUMENT_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentIface))
39 #define EV_IS_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
40 #define EV_IS_DOCUMENT_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
41 #define EV_DOCUMENT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT, EvDocumentIface))
43 typedef struct _EvDocument EvDocument;
44 typedef struct _EvDocumentIface EvDocumentIface;
45 typedef struct _EvPageCache EvPageCache;
46 typedef struct _EvPageCacheClass EvPageCacheClass;
48 #define EV_DOCUMENT_ERROR ev_document_error_quark ()
49 #define EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())
50 #define EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())
54 EV_DOCUMENT_ERROR_INVALID,
55 EV_DOCUMENT_ERROR_ENCRYPTED
70 struct _EvDocumentIface
72 GTypeInterface base_iface;
75 gboolean (* load) (EvDocument *document,
78 gboolean (* save) (EvDocument *document,
81 int (* get_n_pages) (EvDocument *document);
82 EvPage * (* get_page) (EvDocument *document,
84 void (* get_page_size) (EvDocument *document,
88 char * (* get_page_label) (EvDocument *document,
90 gboolean (* has_attachments) (EvDocument *document);
91 GList * (* get_attachments) (EvDocument *document);
92 cairo_surface_t * (* render) (EvDocument *document,
94 EvDocumentInfo * (* get_info) (EvDocument *document);
97 GType ev_document_get_type (void) G_GNUC_CONST;
98 GQuark ev_document_error_quark (void);
101 GMutex *ev_document_get_doc_mutex (void);
102 void ev_document_doc_mutex_lock (void);
103 void ev_document_doc_mutex_unlock (void);
104 gboolean ev_document_doc_mutex_trylock(void);
106 /* FontConfig mutex */
107 GMutex *ev_document_get_fc_mutex (void);
108 void ev_document_fc_mutex_lock (void);
109 void ev_document_fc_mutex_unlock (void);
110 gboolean ev_document_fc_mutex_trylock (void);
112 EvDocumentInfo *ev_document_get_info (EvDocument *document);
113 gboolean ev_document_load (EvDocument *document,
116 gboolean ev_document_save (EvDocument *document,
119 int ev_document_get_n_pages (EvDocument *document);
120 EvPage *ev_document_get_page (EvDocument *document,
122 void ev_document_get_page_size (EvDocument *document,
126 char *ev_document_get_page_label (EvDocument *document,
128 gboolean ev_document_has_attachments (EvDocument *document);
129 GList *ev_document_get_attachments (EvDocument *document);
130 cairo_surface_t *ev_document_render (EvDocument *document,
131 EvRenderContext *rc);
133 gint ev_rect_cmp (EvRectangle *a,
136 /* convenience macro to ease interface addition in the CODE
137 * section of EV_BACKEND_REGISTER_WITH_CODE (this macro relies on
138 * the g_define_type_id present within EV_BACKEND_REGISTER_WITH_CODE()).
140 * EV_BACKEND_REGISTER_WITH_CODE (PdfDocument, pdf_document,
141 * EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
142 * pdf_document_document_thumbnails_iface_init));
144 #define EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
145 const GInterfaceInfo g_implement_interface_info = { \
146 (GInterfaceInitFunc) iface_init, NULL, NULL \
148 g_type_module_add_interface (module, \
151 &g_implement_interface_info); \
155 * Utility macro used to register backends
157 * use: EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)
159 #define EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE) \
161 static GType g_define_type_id = 0; \
164 backend_name##_get_type (void) \
166 return g_define_type_id; \
169 static void backend_name##_init (BackendName *self); \
170 static void backend_name##_class_init (BackendName##Class *klass); \
171 static gpointer backend_name##_parent_class = NULL; \
172 static void backend_name##_class_intern_init (gpointer klass) \
174 backend_name##_parent_class = g_type_class_peek_parent (klass); \
175 backend_name##_class_init ((BackendName##Class *) klass); \
178 G_MODULE_EXPORT GType \
179 register_evince_backend (GTypeModule *module) \
181 static const GTypeInfo our_info = { \
182 sizeof (BackendName##Class), \
183 NULL, /* base_init */ \
184 NULL, /* base_finalize */ \
185 (GClassInitFunc) backend_name##_class_intern_init, \
187 NULL, /* class_data */ \
188 sizeof (BackendName), \
189 0, /* n_preallocs */ \
190 (GInstanceInitFunc) backend_name##_init \
193 /* Initialise the i18n stuff */ \
194 bindtextdomain (GETTEXT_PACKAGE, GNOMELOCALEDIR); \
195 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); \
197 g_define_type_id = g_type_module_register_type (module, \
203 EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT, \
204 backend_name##_document_iface_init); \
208 return g_define_type_id; \
212 * Utility macro used to register backend
214 * use: EV_BACKEND_REGISTER(BackendName, backend_name)
216 #define EV_BACKEND_REGISTER(BackendName, backend_name) \
217 EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)
221 #endif /* EV_DOCUMENT_H */