libdocument/ev-document.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2000-2003 Marco Pesenti Gritti
   4  *
   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)
   8  *  any later version.
   9  *
  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.
  14  *
  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.
  18  *
  19  *  $Id$
  20  */
  21
  22 #ifndef EV_DOCUMENT_H
  23 #define EV_DOCUMENT_H
  24
  25 #include <glib-object.h>
  26 #include <glib.h>
  27 #include <gdk/gdk.h>
  28 #include <cairo.h>
  29
  30 #include "ev-document-info.h"
  31 #include "ev-page.h"
  32 #include "ev-render-context.h"
  33
  34 G_BEGIN_DECLS
  35
  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))
  42
  43 typedef struct _EvDocument        EvDocument;
  44 typedef struct _EvDocumentIface   EvDocumentIface;
  45 typedef struct _EvPageCache       EvPageCache;
  46 typedef struct _EvPageCacheClass  EvPageCacheClass;
  47
  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 ())
  51
  52 typedef enum
  53 {
  54         EV_DOCUMENT_ERROR_INVALID,
  55         EV_DOCUMENT_ERROR_ENCRYPTED
  56 } EvDocumentError;
  57
  58 typedef struct {
  59         double x;
  60         double y;
  61 } EvPoint;
  62
  63 typedef struct {
  64         double x1;
  65         double y1;
  66         double x2;
  67         double y2;
  68 } EvRectangle;
  69
  70 struct _EvDocumentIface
  71 {
  72         GTypeInterface base_iface;
  73
  74         /* Methods  */
  75         gboolean          (* load)            (EvDocument      *document,
  76                                                const char      *uri,
  77                                                GError         **error);
  78         gboolean          (* save)            (EvDocument      *document,
  79                                                const char      *uri,
  80                                                GError         **error);
  81         int               (* get_n_pages)     (EvDocument      *document);
  82         EvPage          * (* get_page)        (EvDocument      *document,
  83                                                gint             index);
  84         void              (* get_page_size)   (EvDocument      *document,
  85                                                EvPage          *page,
  86                                                double          *width,
  87                                                double          *height);
  88         char            * (* get_page_label)  (EvDocument      *document,
  89                                                EvPage          *page);
  90         gboolean          (* has_attachments) (EvDocument      *document);
  91         GList           * (* get_attachments) (EvDocument      *document);
  92         cairo_surface_t * (* render)          (EvDocument      *document,
  93                                                EvRenderContext *rc);
  94         EvDocumentInfo *  (* get_info)        (EvDocument      *document);
  95 };
  96
  97 GType            ev_document_get_type         (void) G_GNUC_CONST;
  98 GQuark           ev_document_error_quark      (void);
  99
 100 /* Document mutex */
 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
 105 /* FontConfig mutex */
 106 GMutex          *ev_document_get_fc_mutex     (void);
 107 void             ev_document_fc_mutex_lock    (void);
 108 void             ev_document_fc_mutex_unlock  (void);
 109
 110 EvDocumentInfo  *ev_document_get_info         (EvDocument      *document);
 111 gboolean         ev_document_load             (EvDocument      *document,
 112                                                const char      *uri,
 113                                                GError         **error);
 114 gboolean         ev_document_save             (EvDocument      *document,
 115                                                const char      *uri,
 116                                                GError         **error);
 117 int              ev_document_get_n_pages      (EvDocument      *document);
 118 EvPage          *ev_document_get_page         (EvDocument      *document,
 119                                                gint             index);
 120 void             ev_document_get_page_size    (EvDocument      *document,
 121                                                EvPage          *page,
 122                                                double          *width,
 123                                                double          *height);
 124 char            *ev_document_get_page_label   (EvDocument      *document,
 125                                                EvPage          *page);
 126 gboolean         ev_document_has_attachments  (EvDocument      *document);
 127 GList           *ev_document_get_attachments  (EvDocument      *document);
 128 cairo_surface_t *ev_document_render           (EvDocument      *document,
 129                                                EvRenderContext *rc);
 130
 131 gint            ev_rect_cmp                   (EvRectangle     *a,
 132                                                EvRectangle     *b);
 133
 134 /* convenience macro to ease interface addition in the CODE
 135  * section of EV_BACKEND_REGISTER_WITH_CODE (this macro relies on
 136  * the g_define_type_id present within EV_BACKEND_REGISTER_WITH_CODE()).
 137  * usage example:
 138  * EV_BACKEND_REGISTER_WITH_CODE (PdfDocument, pdf_document,
 139  *                          EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
 140  *                                                 pdf_document_document_thumbnails_iface_init));
 141  */
 142 #define EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) {                \
 143         const GInterfaceInfo g_implement_interface_info = {                     \
 144                 (GInterfaceInitFunc) iface_init, NULL, NULL                     \
 145         };                                                                      \
 146         g_type_module_add_interface (module,                                    \
 147                                      g_define_type_id,                          \
 148                                      TYPE_IFACE,                                \
 149                                      &g_implement_interface_info);              \
 150 }
 151
 152 /*
 153  * Utility macro used to register backends
 154  *
 155  * use: EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)
 156  */
 157 #define EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)          \
 158                                                                                 \
 159 static GType g_define_type_id = 0;                                              \
 160                                                                                 \
 161 GType                                                                           \
 162 backend_name##_get_type (void)                                                  \
 163 {                                                                               \
 164         return g_define_type_id;                                                \
 165 }                                                                               \
 166                                                                                 \
 167 static void     backend_name##_init              (BackendName        *self);    \
 168 static void     backend_name##_class_init        (BackendName##Class *klass);   \
 169 static gpointer backend_name##_parent_class = NULL;                             \
 170 static void     backend_name##_class_intern_init (gpointer klass)               \
 171 {                                                                               \
 172         backend_name##_parent_class = g_type_class_peek_parent (klass);         \
 173         backend_name##_class_init ((BackendName##Class *) klass);               \
 174 }                                                                               \
 175                                                                                 \
 176 G_MODULE_EXPORT GType                                                           \
 177 register_evince_backend (GTypeModule *module)                                   \
 178 {                                                                               \
 179         static const GTypeInfo our_info = {                                     \
 180                 sizeof (BackendName##Class),                                    \
 181                 NULL, /* base_init */                                           \
 182                 NULL, /* base_finalize */                                       \
 183                 (GClassInitFunc) backend_name##_class_intern_init,              \
 184                 NULL,                                                           \
 185                 NULL, /* class_data */                                          \
 186                 sizeof (BackendName),                                           \
 187                 0, /* n_preallocs */                                            \
 188                 (GInstanceInitFunc) backend_name##_init                         \
 189         };                                                                      \
 190                                                                                 \
 191         /* Initialise the i18n stuff */                                         \
 192         bindtextdomain (GETTEXT_PACKAGE, GNOMELOCALEDIR);                       \
 193         bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");                     \
 194                                                                                 \
 195         g_define_type_id = g_type_module_register_type (module,                 \
 196                                             G_TYPE_OBJECT,                      \
 197                                             #BackendName,                       \
 198                                             &our_info,                          \
 199                                            (GTypeFlags)0);                      \
 200                                                                                 \
 201         EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT,                       \
 202                                backend_name##_document_iface_init);             \
 203                                                                                 \
 204         CODE                                                                    \
 205                                                                                 \
 206         return g_define_type_id;                                                \
 207 }
 208
 209 /*
 210  * Utility macro used to register backend
 211  *
 212  * use: EV_BACKEND_REGISTER(BackendName, backend_name)
 213  */
 214 #define EV_BACKEND_REGISTER(BackendName, backend_name)                  \
 215         EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, ;)
 216
 217 G_END_DECLS
 218
 219 #endif /* EV_DOCUMENT_H */