libview/ev-jobs.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2008 Carlos Garcia Campos <carlosgc@gnome.org>
   4  *  Copyright (C) 2005 Red Hat, Inc
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  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.
  19  */
  20
  21 #if !defined (__EV_EVINCE_VIEW_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  22 #error "Only <evince-view.h> can be included directly."
  23 #endif
  24
  25 #ifndef __EV_JOBS_H__
  26 #define __EV_JOBS_H__
  27
  28 #include <gio/gio.h>
  29 #include <gtk/gtk.h>
  30
  31 #include <evince-document.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _EvJob EvJob;
  36 typedef struct _EvJobClass EvJobClass;
  37
  38 typedef struct _EvJobRender EvJobRender;
  39 typedef struct _EvJobRenderClass EvJobRenderClass;
  40
  41 typedef struct _EvJobThumbnail EvJobThumbnail;
  42 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
  43
  44 typedef struct _EvJobLinks EvJobLinks;
  45 typedef struct _EvJobLinksClass EvJobLinksClass;
  46
  47 typedef struct _EvJobAttachments EvJobAttachments;
  48 typedef struct _EvJobAttachmentsClass EvJobAttachmentsClass;
  49
  50 typedef struct _EvJobFonts EvJobFonts;
  51 typedef struct _EvJobFontsClass EvJobFontsClass;
  52
  53 typedef struct _EvJobLoad EvJobLoad;
  54 typedef struct _EvJobLoadClass EvJobLoadClass;
  55
  56 typedef struct _EvJobSave EvJobSave;
  57 typedef struct _EvJobSaveClass EvJobSaveClass;
  58
  59 typedef struct _EvJobFind EvJobFind;
  60 typedef struct _EvJobFindClass EvJobFindClass;
  61
  62 typedef struct _EvJobLayers EvJobLayers;
  63 typedef struct _EvJobLayersClass EvJobLayersClass;
  64
  65 typedef struct _EvJobExport EvJobExport;
  66 typedef struct _EvJobExportClass EvJobExportClass;
  67
  68 #define EV_TYPE_JOB                          (ev_job_get_type())
  69 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  70 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  71 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  72 #define EV_JOB_GET_CLASS(object)             (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
  73
  74 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  75 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  76 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  77 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  78
  79 #define EV_TYPE_JOB_ATTACHMENTS              (ev_job_attachments_get_type())
  80 #define EV_JOB_ATTACHMENTS(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
  81 #define EV_JOB_ATTACHMENTS_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
  82 #define EV_IS_JOB_ATTACHMENTS(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
  83
  84 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  85 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  86 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  87 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  88
  89 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  90 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  91 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  92 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  93
  94 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  95 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  96 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  97 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  98
  99 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
 100 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
 101 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
 102 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
 103
 104 #define EV_TYPE_JOB_SAVE                     (ev_job_save_get_type())
 105 #define EV_JOB_SAVE(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
 106 #define EV_JOB_SAVE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
 107 #define EV_IS_JOB_SAVE(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
 108
 109 #define EV_TYPE_JOB_FIND                     (ev_job_find_get_type())
 110 #define EV_JOB_FIND(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FIND, EvJobFind))
 111 #define EV_JOB_FIND_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FIND, EvJobFindClass))
 112 #define EV_IS_JOB_FIND(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FIND))
 113
 114 #define EV_TYPE_JOB_LAYERS                   (ev_job_layers_get_type())
 115 #define EV_JOB_LAYERS(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LAYERS, EvJobLayers))
 116 #define EV_JOB_LAYERS_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LAYERS, EvJobLayersClass))
 117 #define EV_IS_JOB_LAYERS(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LAYERS))
 118
 119 #define EV_TYPE_JOB_EXPORT                    (ev_job_export_get_type())
 120 #define EV_JOB_EXPORT(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_EXPORT, EvJobExport))
 121 #define EV_JOB_EXPORT_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_EXPORT, EvJobExportClass))
 122 #define EV_IS_JOB_EXPORT(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_EXPORT))
 123
 124 typedef enum {
 125         EV_JOB_RUN_THREAD,
 126         EV_JOB_RUN_MAIN_LOOP
 127 } EvJobRunMode;
 128
 129 struct _EvJob
 130 {
 131         GObject parent;
 132
 133         EvDocument *document;
 134
 135         EvJobRunMode run_mode;
 136
 137         guint cancelled : 1;
 138         guint finished : 1;
 139         guint failed : 1;
 140
 141         GError *error;
 142         GCancellable *cancellable;
 143
 144         guint idle_finished_id;
 145         guint idle_cancelled_id;
 146 };
 147
 148 struct _EvJobClass
 149 {
 150         GObjectClass parent_class;
 151
 152         gboolean (*run)         (EvJob *job);
 153
 154         /* Signals */
 155         void     (* cancelled)  (EvJob *job);
 156         void     (* finished)   (EvJob *job);
 157 };
 158
 159 struct _EvJobLinks
 160 {
 161         EvJob parent;
 162
 163         GtkTreeModel *model;
 164 };
 165
 166 struct _EvJobLinksClass
 167 {
 168         EvJobClass parent_class;
 169 };
 170
 171 struct _EvJobAttachments
 172 {
 173         EvJob parent;
 174
 175         GList *attachments;
 176 };
 177
 178 struct _EvJobAttachmentsClass
 179 {
 180         EvJobClass parent_class;
 181 };
 182
 183 typedef enum {
 184         EV_RENDER_INCLUDE_NONE      = 0,
 185         EV_RENDER_INCLUDE_LINKS     = 1 << 0,
 186         EV_RENDER_INCLUDE_TEXT      = 1 << 1,
 187         EV_RENDER_INCLUDE_SELECTION = 1 << 2,
 188         EV_RENDER_INCLUDE_IMAGES    = 1 << 3,
 189         EV_RENDER_INCLUDE_FORMS     = 1 << 4,
 190         EV_RENDER_INCLUDE_ANNOTS    = 1 << 5,
 191         EV_RENDER_INCLUDE_ALL       = (1 << 6) - 1
 192 } EvRenderFlags;
 193
 194 struct _EvJobRender
 195 {
 196         EvJob parent;
 197
 198         gint page;
 199         gint rotation;
 200         gdouble scale;
 201
 202         EvPage *ev_page;
 203         gboolean page_ready;
 204         gint target_width;
 205         gint target_height;
 206         cairo_surface_t *surface;
 207
 208         GList *link_mapping;
 209         GdkRegion *text_mapping;
 210         GList *image_mapping;
 211         GList *form_field_mapping;
 212         GList *annots_mapping;
 213
 214         cairo_surface_t *selection;
 215         GdkRegion *selection_region;
 216         EvRectangle selection_points;
 217         EvSelectionStyle selection_style;
 218         GdkColor base;
 219         GdkColor text;
 220
 221         EvRenderFlags flags;
 222 };
 223
 224 struct _EvJobRenderClass
 225 {
 226         EvJobClass parent_class;
 227
 228         void    (* page_ready) (EvJobRender *job);
 229 };
 230
 231 struct _EvJobThumbnail
 232 {
 233         EvJob parent;
 234
 235         gint page;
 236         gint rotation;
 237         gdouble scale;
 238
 239         GdkPixbuf *thumbnail;
 240 };
 241
 242 struct _EvJobThumbnailClass
 243 {
 244         EvJobClass parent_class;
 245 };
 246
 247 struct _EvJobFonts
 248 {
 249         EvJob parent;
 250         gboolean scan_completed;
 251 };
 252
 253 struct _EvJobFontsClass
 254 {
 255         EvJobClass parent_class;
 256
 257         /* Signals */
 258         void (* updated)  (EvJobFonts *job,
 259                            gdouble     progress);
 260 };
 261
 262 struct _EvJobLoad
 263 {
 264         EvJob parent;
 265
 266         gchar *uri;
 267         gchar *password;
 268 };
 269
 270 struct _EvJobLoadClass
 271 {
 272         EvJobClass parent_class;
 273 };
 274
 275 struct _EvJobSave
 276 {
 277         EvJob parent;
 278
 279         gchar *uri;
 280         gchar *document_uri;
 281 };
 282
 283 struct _EvJobSaveClass
 284 {
 285         EvJobClass parent_class;
 286 };
 287
 288 struct _EvJobFind
 289 {
 290         EvJob parent;
 291
 292         gint start_page;
 293         gint current_page;
 294         gint n_pages;
 295         GList **pages;
 296         gchar *text;
 297         gboolean case_sensitive;
 298         gboolean has_results;
 299 };
 300
 301 struct _EvJobFindClass
 302 {
 303         EvJobClass parent_class;
 304
 305         /* Signals */
 306         void (* updated)  (EvJobFind *job,
 307                            gint       page);
 308 };
 309
 310 struct _EvJobLayers
 311 {
 312         EvJob parent;
 313
 314         GtkTreeModel *model;
 315 };
 316
 317 struct _EvJobLayersClass
 318 {
 319         EvJobClass parent_class;
 320 };
 321
 322 struct _EvJobExport
 323 {
 324         EvJob parent;
 325
 326         gint page;
 327         EvRenderContext *rc;
 328 };
 329
 330 struct _EvJobExportClass
 331 {
 332         EvJobClass parent_class;
 333 };
 334
 335 /* Base job class */
 336 GType           ev_job_get_type           (void) G_GNUC_CONST;
 337 gboolean        ev_job_run                (EvJob          *job);
 338 void            ev_job_cancel             (EvJob          *job);
 339 void            ev_job_failed             (EvJob          *job,
 340                                            GQuark          domain,
 341                                            gint            code,
 342                                            const gchar    *format,
 343                                            ...);
 344 void            ev_job_failed_from_error  (EvJob          *job,
 345                                            GError         *error);
 346 void            ev_job_succeeded          (EvJob          *job);
 347 gboolean        ev_job_is_cancelled       (EvJob          *job);
 348 gboolean        ev_job_is_finished        (EvJob          *job);
 349 gboolean        ev_job_is_failed          (EvJob          *job);
 350 EvJobRunMode    ev_job_get_run_mode       (EvJob          *job);
 351 void            ev_job_set_run_mode       (EvJob          *job,
 352                                            EvJobRunMode    run_mode);
 353
 354 /* EvJobLinks */
 355 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 356 EvJob          *ev_job_links_new          (EvDocument     *document);
 357
 358 /* EvJobAttachments */
 359 GType           ev_job_attachments_get_type (void) G_GNUC_CONST;
 360 EvJob          *ev_job_attachments_new      (EvDocument     *document);
 361
 362 /* EvJobRender */
 363 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 364 EvJob          *ev_job_render_new         (EvDocument      *document,
 365                                            gint             page,
 366                                            gint             rotation,
 367                                            gdouble          scale,
 368                                            gint             width,
 369                                            gint             height,
 370                                            EvRenderFlags    flags);
 371 void     ev_job_render_set_selection_info (EvJobRender     *job,
 372                                            EvRectangle     *selection_points,
 373                                            EvSelectionStyle selection_style,
 374                                            GdkColor        *text,
 375                                            GdkColor        *base);
 376 /* EvJobThumbnail */
 377 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 378 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 379                                            gint             page,
 380                                            gint             rotation,
 381                                            gdouble          scale);
 382 /* EvJobFonts */
 383 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 384 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 385
 386 /* EvJobLoad */
 387 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 388 EvJob          *ev_job_load_new           (const gchar     *uri);
 389 void            ev_job_load_set_uri       (EvJobLoad       *load,
 390                                            const gchar     *uri);
 391 void            ev_job_load_set_password  (EvJobLoad       *job,
 392                                            const gchar     *password);
 393
 394 /* EvJobSave */
 395 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 396 EvJob          *ev_job_save_new           (EvDocument      *document,
 397                                            const gchar     *uri,
 398                                            const gchar     *document_uri);
 399 /* EvJobFind */
 400 GType           ev_job_find_get_type      (void) G_GNUC_CONST;
 401 EvJob          *ev_job_find_new           (EvDocument      *document,
 402                                            gint             start_page,
 403                                            gint             n_pages,
 404                                            const gchar     *text,
 405                                            gboolean         case_sensitive);
 406 gint            ev_job_find_get_n_results (EvJobFind       *job,
 407                                            gint             pages);
 408 gdouble         ev_job_find_get_progress  (EvJobFind       *job);
 409 gboolean        ev_job_find_has_results   (EvJobFind       *job);
 410 GList         **ev_job_find_get_results   (EvJobFind       *job);
 411
 412 /* EvJobLayers */
 413 GType           ev_job_layers_get_type    (void) G_GNUC_CONST;
 414 EvJob          *ev_job_layers_new         (EvDocument     *document);
 415
 416 /* EvJobExport */
 417 GType           ev_job_export_get_type    (void) G_GNUC_CONST;
 418 EvJob          *ev_job_export_new         (EvDocument     *document);
 419 void            ev_job_export_set_page    (EvJobExport    *job,
 420                                            gint            page);
 421
 422 G_END_DECLS
 423
 424 #endif /* __EV_JOBS_H__ */